Priority One

---

{"class":["gateway"],"properties":{"name":"Amazon Gateway","provider":"Amazon Web Services","slug":"aws-api-gateway","rating":1,"license":"Proprietary","status":"Pending Review","researchDate":"2021-10","description":"Amazon is one of the first cloud providers to offer an Gateway. The gateway supports a few different options: HTTP, REST, and WebSockets. Integrations with other AWS services are abundant.","platformCapabilities":["Gateway","Portal","Monitoring","Threat Protection","Analytics","Documentation","SDK"],"gatewayCapabilities":["Custom Code Execution","Mediation","Traffic Management","OpenAPI Integration","OpenAPI Import","OpenAPI Export","Versioning","Mocking"],"customCodeSupport":["Lambda"],"upstreamProtocols":["HTTP/1.1","WebSockets"],"downstreamProtocols":["HTTP/1.1","WebSockets"],"deliveryModels":["SaaS"],"policies":[{"category":"Security","capabilities":["Lambda authorizers","JWT authorizers","AWS IAM roles and policies","CORS","Mutual TLS","WAF"]},{"category":"Traffic Management","capabilities":["Cache Lookup","Cache Invalidation","Throttling"]},{"category":"Mediation","capabilities":["Request Transformation","Response Transformation","OpenAPI Validation"]},{"category":"Extensions","capabilities":["AWS Lambda integrations","HTTP integrations","AWS service integrations","Private integrations"]}]},"links":[{"rel":["urn:gateway:product"],"title":"Product","href":"https://aws.amazon.com/api-gateway/"},{"rel":["urn:gateway:docs"],"title":"Documentation","href":"https://aws.amazon.com/api-gateway/resources/"},{"rel":["urn:gateway:logo"],"title":"Logo","href":"/images/gateways/amazon-api-gateway.webp"},{"rel":["urn:gateway:screenshot"],"title":"Screenshot","href":"https://kinlane-productions2.s3.amazonaws.com/api-gateways/amazon-api-gateway.png"},{"rel":["urn:gateway:collection"],"title":"Collection","href":"https://www.postman.com/api-evangelist/workspace/aws-api-gateway/documentation/35240-73e404a5-9067-413e-855b-66ee60d211aa?entity=&branch=&version="}]}

Amazon Gateway

Amazon is one of the first cloud providers to offer an Gateway. The gateway supports a few different options: HTTP, REST, and WebSockets. Integrations with other AWS services are abundant.

Platform Capabilities

These are the wider capabilities beyond the gateway they offer.

• Gateway
• Portal
• Monitoring
• Threat Protection
• Analytics
• Documentation
• SDK

Gateway Capabilities

These are the capabilities the gateway supports.

• Custom Code Execution
• Mediation
• Traffic Management
• OpenAPI Integration
• OpenAPI Import
• OpenAPI Export
• Versioning
• Mocking

Upstream Protocols

The different protocols they support upstream.

• HTTP/1.1
• WebSockets

Downtream Protocols

The different protocols they support downstream.

• HTTP/1.1
• WebSockets

Custom Code

If they offer plugin, extension, and custom coding options.

• Lambda

Delivery Models

These are they ways you can deliver this solution.

• SaaS

Policies

These are the policies available across the gateway capabilities.

Security

• Lambda authorizers
• JWT authorizers
• AWS IAM roles and policies
• CORS
• Mutual TLS
• WAF

Traffic Management

• Cache Lookup
• Cache Invalidation
• Throttling

Mediation

• Request Transformation
• Response Transformation
• OpenAPI Validation

Extensions

• AWS Lambda integrations
• HTTP integrations
• AWS service integrations
• Private integrations

API Resources

AmazonApiGatewayV2 OpenAPI	{"openapi":"3.0.0","info":{"version":"2018-11-29","x-release":"v4","title":"AmazonApiGatewayV2","description":"Amazon API Gateway V2","x-logo":{"url":"https://api.apis.guru/v2/cache/logo/https_twitter.com_awscloud_profile_image.png","backgroundColor":"#FFFFFF"},"termsOfService":"https://aws.amazon.com/service-terms/","contact":{"name":"Mike Ralphson","email":"mike.ralphson@gmail.com","url":"https://github.com/mermade/aws2openapi","x-twitter":"PermittedSoc"},"license":{"name":"Apache 2.0 License","url":"http://www.apache.org/licenses/"},"x-providerName":"amazonaws.com","x-serviceName":"apigatewayv2","x-aws-signingName":"apigateway","x-origin":[{"contentType":"application/json","url":"https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/apigatewayv2-2018-11-29.normal.json","converter":{"url":"https://github.com/mermade/aws2openapi","version":"1.0.0"},"x-apisguru-driver":"external"}],"x-apiClientRegistration":{"url":"https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct"},"x-apisguru-categories":["cloud"],"x-preferred":true},"externalDocs":{"description":"Amazon Web Services documentation","url":"https://docs.aws.amazon.com/apigateway/"},"servers":[{"url":"http://apigateway.{region}.amazonaws.com","variables":{"region":{"description":"The AWS region","enum":["us-east-1","us-east-2","us-west-1","us-west-2","us-gov-west-1","us-gov-east-1","ca-central-1","eu-north-1","eu-west-1","eu-west-2","eu-west-3","eu-central-1","eu-south-1","af-south-1","ap-northeast-1","ap-northeast-2","ap-northeast-3","ap-southeast-1","ap-southeast-2","ap-east-1","ap-south-1","sa-east-1","me-south-1"],"default":"us-east-1"}},"description":"The AmazonApiGatewayV2 multi-region endpoint"},{"url":"https://apigateway.{region}.amazonaws.com","variables":{"region":{"description":"The AWS region","enum":["us-east-1","us-east-2","us-west-1","us-west-2","us-gov-west-1","us-gov-east-1","ca-central-1","eu-north-1","eu-west-1","eu-west-2","eu-west-3","eu-central-1","eu-south-1","af-south-1","ap-northeast-1","ap-northeast-2","ap-northeast-3","ap-southeast-1","ap-southeast-2","ap-east-1","ap-south-1","sa-east-1","me-south-1"],"default":"us-east-1"}},"description":"The AmazonApiGatewayV2 multi-region endpoint"},{"url":"http://apigateway.{region}.amazonaws.com.cn","variables":{"region":{"description":"The AWS region","enum":["cn-north-1","cn-northwest-1"],"default":"cn-north-1"}},"description":"The AmazonApiGatewayV2 endpoint for China (Beijing) and China (Ningxia)"},{"url":"https://apigateway.{region}.amazonaws.com.cn","variables":{"region":{"description":"The AWS region","enum":["cn-north-1","cn-northwest-1"],"default":"cn-north-1"}},"description":"The AmazonApiGatewayV2 endpoint for China (Beijing) and China (Ningxia)"}],"x-hasEquivalentPaths":true,"paths":{"/v2/apis":{"post":{"operationId":"CreateApi","description":"Creates an Api resource.","responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateApiResponse"}}}},"480":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"481":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}},"482":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"483":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}}},"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["name","protocolType"],"properties":{"apiKeySelectionExpression":{"description":"An expression used to extract information at runtime. See <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions\">Selection Expressions</a> for more information.","type":"string"},"corsConfiguration":{"description":"Represents a CORS configuration. Supported only for HTTP APIs. See <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-cors.html\">Configuring CORS</a> for more information.","type":"object","properties":{"AllowCredentials":{"allOf":[{"$ref":"#/components/schemas/__boolean"},{"xml":{"name":"allowCredentials"},"description":"Specifies whether credentials are included in the CORS request. Supported only for HTTP APIs."}]},"AllowHeaders":{"allOf":[{"$ref":"#/components/schemas/CorsHeaderList"},{"xml":{"name":"allowHeaders"},"description":"Represents a collection of allowed headers. Supported only for HTTP APIs."}]},"AllowMethods":{"allOf":[{"$ref":"#/components/schemas/CorsMethodList"},{"xml":{"name":"allowMethods"},"description":"Represents a collection of allowed HTTP methods. Supported only for HTTP APIs."}]},"AllowOrigins":{"allOf":[{"$ref":"#/components/schemas/CorsOriginList"},{"xml":{"name":"allowOrigins"},"description":"Represents a collection of allowed origins. Supported only for HTTP APIs."}]},"ExposeHeaders":{"allOf":[{"$ref":"#/components/schemas/CorsHeaderList"},{"xml":{"name":"exposeHeaders"},"description":"Represents a collection of exposed headers. Supported only for HTTP APIs."}]},"MaxAge":{"allOf":[{"$ref":"#/components/schemas/IntegerWithLengthBetweenMinus1And86400"},{"xml":{"name":"maxAge"},"description":"The number of seconds that the browser should cache preflight request results. Supported only for HTTP APIs."}]}}},"credentialsArn":{"description":"Represents an Amazon Resource Name (ARN).","type":"string"},"description":{"description":"A string with a length between [0-1024].","type":"string"},"disableSchemaValidation":{"description":"Avoid validating models when creating a deployment. Supported only for WebSocket APIs.","type":"boolean"},"disableExecuteApiEndpoint":{"description":"Specifies whether clients can invoke your API by using the default execute-api endpoint. By default, clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint.","type":"boolean"},"name":{"description":"A string with a length between [1-128].","type":"string"},"protocolType":{"description":"Represents a protocol type.","type":"string","enum":["WEBSOCKET","HTTP"]},"routeKey":{"description":"After evaluating a selection expression, the result is compared against one or more selection keys to find a matching key. See <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions\">Selection Expressions</a> for a list of expressions and each expression's associated selection key type.","type":"string"},"routeSelectionExpression":{"description":"An expression used to extract information at runtime. See <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions\">Selection Expressions</a> for more information.","type":"string"},"tags":{"description":"Represents a collection of tags associated with the resource.","type":"object","additionalProperties":{"$ref":"#/components/schemas/StringWithLengthBetween1And1600"}},"target":{"description":"A string representation of a URI with a length between [1-2048].","type":"string"},"version":{"description":"A string with a length between [1-64].","type":"string"}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}],"get":{"operationId":"GetApis","description":"Gets a collection of Api resources.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetApisResponse"}}}},"480":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"481":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}},"482":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}}},"parameters":[{"name":"maxResults","in":"query","required":false,"description":"The maximum number of elements to be returned for this resource.","schema":{"type":"string"}},{"name":"nextToken","in":"query","required":false,"description":"The next page of elements from this collection. Not valid for the last element of the collection.","schema":{"type":"string"}}]},"put":{"operationId":"ImportApi","description":"Imports an API.","responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImportApiResponse"}}}},"480":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"481":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}},"482":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"483":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}}},"parameters":[{"name":"basepath","in":"query","required":false,"description":"Specifies how to interpret the base path of the API during import. Valid values are ignore, prepend, and split. The default value is ignore. To learn more, see <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-import-api-basePath.html\">Set the OpenAPI basePath Property</a>. Supported only for HTTP APIs.","schema":{"type":"string"}},{"name":"failOnWarnings","in":"query","required":false,"description":"Specifies whether to rollback the API creation when a warning is encountered. By default, API creation continues if a warning is encountered.","schema":{"type":"boolean"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"description":"The OpenAPI definition. Supported only for HTTP APIs.","type":"string"}}}}}}}},"/v2/domainnames/{domainName}/apimappings":{"post":{"operationId":"CreateApiMapping","description":"Creates an API mapping.","responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateApiMappingResponse"}}}},"480":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"481":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}},"482":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"483":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}}},"parameters":[{"name":"domainName","in":"path","required":true,"description":"The domain name.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["apiId","stage"],"properties":{"apiId":{"description":"The identifier.","type":"string"},"apiMappingKey":{"description":"After evaluating a selection expression, the result is compared against one or more selection keys to find a matching key. See <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions\">Selection Expressions</a> for a list of expressions and each expression's associated selection key type.","type":"string"},"stage":{"description":"A string with a length between [1-128].","type":"string"}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}],"get":{"operationId":"GetApiMappings","description":"Gets API mappings.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetApiMappingsResponse"}}}},"480":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"481":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}},"482":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}}},"parameters":[{"name":"domainName","in":"path","required":true,"description":"The domain name.","schema":{"type":"string"}},{"name":"maxResults","in":"query","required":false,"description":"The maximum number of elements to be returned for this resource.","schema":{"type":"string"}},{"name":"nextToken","in":"query","required":false,"description":"The next page of elements from this collection. Not valid for the last element of the collection.","schema":{"type":"string"}}]}},"/v2/apis/{apiId}/authorizers":{"post":{"operationId":"CreateAuthorizer","description":"Creates an Authorizer for an API.","responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAuthorizerResponse"}}}},"480":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"481":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}},"482":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"483":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}}},"parameters":[{"name":"apiId","in":"path","required":true,"description":"The API identifier.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["authorizerType","identitySource","name"],"properties":{"authorizerCredentialsArn":{"description":"Represents an Amazon Resource Name (ARN).","type":"string"},"authorizerPayloadFormatVersion":{"description":"A string with a length between [1-64].","type":"string"},"authorizerResultTtlInSeconds":{"description":"An integer with a value between [0-3600].","type":"integer","minimum":0,"maximum":3600},"authorizerType":{"description":"The authorizer type. Specify REQUEST for a Lambda function using incoming request parameters. Specify JWT to use JSON Web Tokens (supported only for HTTP APIs).","type":"string","enum":["REQUEST","JWT"]},"authorizerUri":{"description":"A string representation of a URI with a length between [1-2048].","type":"string"},"enableSimpleResponses":{"description":"Specifies whether a Lambda authorizer returns a response in a simple format. By default, a Lambda authorizer must return an IAM policy. If enabled, the Lambda authorizer can return a boolean value instead of an IAM policy. Supported only for HTTP APIs. To learn more, see <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html\">Working with AWS Lambda authorizers for HTTP APIs</a>","type":"boolean"},"identitySource":{"description":"The identity source for which authorization is requested. For the REQUEST authorizer, this is required when authorization caching is enabled. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an Auth header, a Name query string parameter are defined as identity sources, this value is $method.request.header.Auth, $method.request.querystring.Name. These parameters will be used to derive the authorization caching key and to perform runtime validation of the REQUEST authorizer by verifying all of the identity-related request parameters are present, not null and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function, otherwise, it returns a 401 Unauthorized response without calling the Lambda function. The valid value is a string of comma-separated mapping expressions of the specified request parameters. When the authorization caching is not enabled, this property is optional.","type":"array","items":{"$ref":"#/components/schemas/__string"}},"identityValidationExpression":{"description":"A string with a length between [0-1024].","type":"string"},"jwtConfiguration":{"description":"Represents the configuration of a JWT authorizer. Required for the JWT authorizer type. Supported only for HTTP APIs.","type":"object","properties":{"Audience":{"allOf":[{"$ref":"#/components/schemas/__listOf__string"},{"xml":{"name":"audience"},"description":"A list of the intended recipients of the JWT. A valid JWT must provide an aud that matches at least one entry in this list. See <a href=\"https://tools.ietf.org/html/rfc7519#section-4.1.3\">RFC 7519</a>. Supported only for HTTP APIs."}]},"Issuer":{"allOf":[{"$ref":"#/components/schemas/UriWithLengthBetween1And2048"},{"xml":{"name":"issuer"},"description":"The base domain of the identity provider that issues JSON Web Tokens. For example, an Amazon Cognito user pool has the following format: https://cognito-idp.<replaceable>{region}</replaceable>.amazonaws.com/<replaceable>{userPoolId}</replaceable>\n . Required for the JWT authorizer type. Supported only for HTTP APIs."}]}}},"name":{"description":"A string with a length between [1-128].","type":"string"}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}],"get":{"operationId":"GetAuthorizers","description":"Gets the Authorizers for an API.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetAuthorizersResponse"}}}},"480":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"481":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}},"482":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}}},"parameters":[{"name":"apiId","in":"path","required":true,"description":"The API identifier.","schema":{"type":"string"}},{"name":"maxResults","in":"query","required":false,"description":"The maximum number of elements to be returned for this resource.","schema":{"type":"string"}},{"name":"nextToken","in":"query","required":false,"description":"The next page of elements from this collection. Not valid for the last element of the collection.","schema":{"type":"string"}}]}},"/v2/apis/{apiId}/deployments":{"post":{"operationId":"CreateDeployment","description":"Creates a Deployment for an API.","responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateDeploymentResponse"}}}},"480":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"481":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}},"482":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"483":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}}},"parameters":[{"name":"apiId","in":"path","required":true,"description":"The API identifier.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"description":{"description":"A string with a length between [0-1024].","type":"string"},"stageName":{"description":"A string with a length between [1-128].","type":"string"}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}],"get":{"operationId":"GetDeployments","description":"Gets the Deployments for an API.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetDeploymentsResponse"}}}},"480":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"481":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}},"482":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}}},"parameters":[{"name":"apiId","in":"path","required":true,"description":"The API identifier.","schema":{"type":"string"}},{"name":"maxResults","in":"query","required":false,"description":"The maximum number of elements to be returned for this resource.","schema":{"type":"string"}},{"name":"nextToken","in":"query","required":false,"description":"The next page of elements from this collection. Not valid for the last element of the collection.","schema":{"type":"string"}}]}},"/v2/domainnames":{"post":{"operationId":"CreateDomainName","description":"Creates a domain name.","responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateDomainNameResponse"}}}},"480":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"481":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}},"482":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"483":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}},"484":{"description":"AccessDeniedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedException"}}}}},"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["domainName"],"properties":{"domainName":{"description":"A string with a length between [1-512].","type":"string"},"domainNameConfigurations":{"description":"The domain name configurations.","type":"array","items":{"$ref":"#/components/schemas/DomainNameConfiguration"}},"mutualTlsAuthentication":{"description":"The mutual TLS authentication configuration for a custom domain name.","type":"object","properties":{"TruststoreUri":{"allOf":[{"$ref":"#/components/schemas/UriWithLengthBetween1And2048"},{"xml":{"name":"truststoreUri"},"description":"An Amazon S3 URL that specifies the truststore for mutual TLS authentication, for example, s3://<replaceable>bucket-name</replaceable>/<replaceable>key-name</replaceable>. The truststore can contain certificates from public or private certificate authorities. To update the truststore, upload a new version to S3, and then update your custom domain name to use the new version. To update the truststore, you must have permissions to access the S3 object."}]},"TruststoreVersion":{"allOf":[{"$ref":"#/components/schemas/StringWithLengthBetween1And64"},{"xml":{"name":"truststoreVersion"},"description":"The version of the S3 object that contains your truststore. To specify a version, you must have versioning enabled for the S3 bucket."}]}}},"tags":{"description":"Represents a collection of tags associated with the resource.","type":"object","additionalProperties":{"$ref":"#/components/schemas/StringWithLengthBetween1And1600"}}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}],"get":{"operationId":"GetDomainNames","description":"Gets the domain names for an AWS account.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetDomainNamesResponse"}}}},"480":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"481":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}},"482":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}}},"parameters":[{"name":"maxResults","in":"query","required":false,"description":"The maximum number of elements to be returned for this resource.","schema":{"type":"string"}},{"name":"nextToken","in":"query","required":false,"description":"The next page of elements from this collection. Not valid for the last element of the collection.","schema":{"type":"string"}}]}},"/v2/apis/{apiId}/integrations":{"post":{"operationId":"CreateIntegration","description":"Creates an Integration.","responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateIntegrationResult"}}}},"480":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"481":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}},"482":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"483":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}}},"parameters":[{"name":"apiId","in":"path","required":true,"description":"The API identifier.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["integrationType"],"properties":{"connectionId":{"description":"A string with a length between [1-1024].","type":"string"},"connectionType":{"description":"Represents a connection type.","type":"string","enum":["INTERNET","VPC_LINK"]},"contentHandlingStrategy":{"description":"Specifies how to handle response payload content type conversions. Supported only for WebSocket APIs.","type":"string","enum":["CONVERT_TO_BINARY","CONVERT_TO_TEXT"]},"credentialsArn":{"description":"Represents an Amazon Resource Name (ARN).","type":"string"},"description":{"description":"A string with a length between [0-1024].","type":"string"},"integrationMethod":{"description":"A string with a length between [1-64].","type":"string"},"integrationSubtype":{"description":"A string with a length between [1-128].","type":"string"},"integrationType":{"description":"Represents an API method integration type.","type":"string","enum":["AWS","HTTP","MOCK","HTTP_PROXY","AWS_PROXY"]},"integrationUri":{"description":"A string representation of a URI with a length between [1-2048].","type":"string"},"passthroughBehavior":{"description":"Represents passthrough behavior for an integration response. Supported only for WebSocket APIs.","type":"string","enum":["WHEN_NO_MATCH","NEVER","WHEN_NO_TEMPLATES"]},"payloadFormatVersion":{"description":"A string with a length between [1-64].","type":"string"},"requestParameters":{"description":"<p>For WebSocket APIs, a key-value map specifying request parameters that are passed from the method request to the backend. The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the backend. The method request parameter value must match the pattern of method.request.<replaceable>{location}</replaceable>.<replaceable>{name}</replaceable>\n , where \n <replaceable>{location}</replaceable>\n is querystring, path, or header; and \n <replaceable>{name}</replaceable>\n must be a valid and unique method request parameter name.</p> <p>For HTTP API integrations with a specified integrationSubtype, request parameters are a key-value map specifying parameters that are passed to AWS_PROXY integrations. You can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-aws-services.html\">Working with AWS service integrations for HTTP APIs</a>.</p> <p>For HTTP API integrations without a specified integrationSubtype request parameters are a key-value map specifying how to transform HTTP requests before sending them to the backend. The key should follow the pattern <action>:<header|querystring|path>.<location> where action can be append, overwrite or remove. For values, you can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-parameter-mapping.html\">Transforming API requests and responses</a>.</p>","type":"object","additionalProperties":{"$ref":"#/components/schemas/StringWithLengthBetween1And512"}},"requestTemplates":{"description":"A mapping of identifier keys to templates. The value is an actual template script. The key is typically a SelectionKey which is chosen based on evaluating a selection expression.","type":"object","additionalProperties":{"$ref":"#/components/schemas/StringWithLengthBetween0And32K"}},"responseParameters":{"description":"Supported only for HTTP APIs. You use response parameters to transform the HTTP response from a backend integration before returning the response to clients.","type":"object","additionalProperties":{"$ref":"#/components/schemas/IntegrationParameters"}},"templateSelectionExpression":{"description":"An expression used to extract information at runtime. See <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions\">Selection Expressions</a> for more information.","type":"string"},"timeoutInMillis":{"description":"An integer with a value between [50-30000].","type":"integer","minimum":50,"maximum":30000},"tlsConfig":{"description":"The TLS configuration for a private integration. If you specify a TLS configuration, private integration traffic uses the HTTPS protocol. Supported only for HTTP APIs.","type":"object","properties":{"ServerNameToVerify":{"allOf":[{"$ref":"#/components/schemas/StringWithLengthBetween1And512"},{"xml":{"name":"serverNameToVerify"},"description":"If you specify a server name, API Gateway uses it to verify the hostname on the integration's certificate. The server name is also included in the TLS handshake to support Server Name Indication (SNI) or virtual hosting."}]}}}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}],"get":{"operationId":"GetIntegrations","description":"Gets the Integrations for an API.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetIntegrationsResponse"}}}},"480":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"481":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}},"482":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}}},"parameters":[{"name":"apiId","in":"path","required":true,"description":"The API identifier.","schema":{"type":"string"}},{"name":"maxResults","in":"query","required":false,"description":"The maximum number of elements to be returned for this resource.","schema":{"type":"string"}},{"name":"nextToken","in":"query","required":false,"description":"The next page of elements from this collection. Not valid for the last element of the collection.","schema":{"type":"string"}}]}},"/v2/apis/{apiId}/integrations/{integrationId}/integrationresponses":{"post":{"operationId":"CreateIntegrationResponse","description":"Creates an IntegrationResponses.","responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateIntegrationResponseResponse"}}}},"480":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"481":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}},"482":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"483":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}}},"parameters":[{"name":"apiId","in":"path","required":true,"description":"The API identifier.","schema":{"type":"string"}},{"name":"integrationId","in":"path","required":true,"description":"The integration ID.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["integrationResponseKey"],"properties":{"contentHandlingStrategy":{"description":"Specifies how to handle response payload content type conversions. Supported only for WebSocket APIs.","type":"string","enum":["CONVERT_TO_BINARY","CONVERT_TO_TEXT"]},"integrationResponseKey":{"description":"After evaluating a selection expression, the result is compared against one or more selection keys to find a matching key. See <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions\">Selection Expressions</a> for a list of expressions and each expression's associated selection key type.","type":"string"},"responseParameters":{"description":"<p>For WebSocket APIs, a key-value map specifying request parameters that are passed from the method request to the backend. The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the backend. The method request parameter value must match the pattern of method.request.<replaceable>{location}</replaceable>.<replaceable>{name}</replaceable>\n , where \n <replaceable>{location}</replaceable>\n is querystring, path, or header; and \n <replaceable>{name}</replaceable>\n must be a valid and unique method request parameter name.</p> <p>For HTTP API integrations with a specified integrationSubtype, request parameters are a key-value map specifying parameters that are passed to AWS_PROXY integrations. You can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-aws-services.html\">Working with AWS service integrations for HTTP APIs</a>.</p> <p>For HTTP API integrations without a specified integrationSubtype request parameters are a key-value map specifying how to transform HTTP requests before sending them to the backend. The key should follow the pattern <action>:<header|querystring|path>.<location> where action can be append, overwrite or remove. For values, you can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-parameter-mapping.html\">Transforming API requests and responses</a>.</p>","type":"object","additionalProperties":{"$ref":"#/components/schemas/StringWithLengthBetween1And512"}},"responseTemplates":{"description":"A mapping of identifier keys to templates. The value is an actual template script. The key is typically a SelectionKey which is chosen based on evaluating a selection expression.","type":"object","additionalProperties":{"$ref":"#/components/schemas/StringWithLengthBetween0And32K"}},"templateSelectionExpression":{"description":"An expression used to extract information at runtime. See <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions\">Selection Expressions</a> for more information.","type":"string"}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}],"get":{"operationId":"GetIntegrationResponses","description":"Gets the IntegrationResponses for an Integration.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetIntegrationResponsesResponse"}}}},"480":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"481":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}},"482":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}}},"parameters":[{"name":"apiId","in":"path","required":true,"description":"The API identifier.","schema":{"type":"string"}},{"name":"integrationId","in":"path","required":true,"description":"The integration ID.","schema":{"type":"string"}},{"name":"maxResults","in":"query","required":false,"description":"The maximum number of elements to be returned for this resource.","schema":{"type":"string"}},{"name":"nextToken","in":"query","required":false,"description":"The next page of elements from this collection. Not valid for the last element of the collection.","schema":{"type":"string"}}]}},"/v2/apis/{apiId}/models":{"post":{"operationId":"CreateModel","description":"Creates a Model for an API.","responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateModelResponse"}}}},"480":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"481":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}},"482":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"483":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}}},"parameters":[{"name":"apiId","in":"path","required":true,"description":"The API identifier.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["name","schema"],"properties":{"contentType":{"description":"A string with a length between [1-256].","type":"string"},"description":{"description":"A string with a length between [0-1024].","type":"string"},"name":{"description":"A string with a length between [1-128].","type":"string"},"schema":{"description":"A string with a length between [0-32768].","type":"string"}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}],"get":{"operationId":"GetModels","description":"Gets the Models for an API.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetModelsResponse"}}}},"480":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"481":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}},"482":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}}},"parameters":[{"name":"apiId","in":"path","required":true,"description":"The API identifier.","schema":{"type":"string"}},{"name":"maxResults","in":"query","required":false,"description":"The maximum number of elements to be returned for this resource.","schema":{"type":"string"}},{"name":"nextToken","in":"query","required":false,"description":"The next page of elements from this collection. Not valid for the last element of the collection.","schema":{"type":"string"}}]}},"/v2/apis/{apiId}/routes":{"post":{"operationId":"CreateRoute","description":"Creates a Route for an API.","responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateRouteResult"}}}},"480":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"481":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}},"482":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"483":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}}},"parameters":[{"name":"apiId","in":"path","required":true,"description":"The API identifier.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["routeKey"],"properties":{"apiKeyRequired":{"description":"Specifies whether an API key is required for the route. Supported only for WebSocket APIs.","type":"boolean"},"authorizationScopes":{"description":"A list of authorization scopes configured on a route. The scopes are used with a JWT authorizer to authorize the method invocation. The authorization works by matching the route scopes against the scopes parsed from the access token in the incoming request. The method invocation is authorized if any route scope matches a claimed scope in the access token. Otherwise, the invocation is not authorized. When the route scope is configured, the client must provide an access token instead of an identity token for authorization purposes.","type":"array","items":{"$ref":"#/components/schemas/StringWithLengthBetween1And64"}},"authorizationType":{"description":"The authorization type. For WebSocket APIs, valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer. For HTTP APIs, valid values are NONE for open access, JWT for using JSON Web Tokens, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer.","type":"string","enum":["NONE","AWS_IAM","CUSTOM","JWT"]},"authorizerId":{"description":"The identifier.","type":"string"},"modelSelectionExpression":{"description":"An expression used to extract information at runtime. See <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions\">Selection Expressions</a> for more information.","type":"string"},"operationName":{"description":"A string with a length between [1-64].","type":"string"},"requestModels":{"description":"The route models.","type":"object","additionalProperties":{"$ref":"#/components/schemas/StringWithLengthBetween1And128"}},"requestParameters":{"description":"The route parameters.","type":"object","additionalProperties":{"$ref":"#/components/schemas/ParameterConstraints"}},"routeKey":{"description":"After evaluating a selection expression, the result is compared against one or more selection keys to find a matching key. See <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions\">Selection Expressions</a> for a list of expressions and each expression's associated selection key type.","type":"string"},"routeResponseSelectionExpression":{"description":"An expression used to extract information at runtime. See <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions\">Selection Expressions</a> for more information.","type":"string"},"target":{"description":"A string with a length between [1-128].","type":"string"}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}],"get":{"operationId":"GetRoutes","description":"Gets the Routes for an API.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetRoutesResponse"}}}},"480":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"481":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}},"482":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}}},"parameters":[{"name":"apiId","in":"path","required":true,"description":"The API identifier.","schema":{"type":"string"}},{"name":"maxResults","in":"query","required":false,"description":"The maximum number of elements to be returned for this resource.","schema":{"type":"string"}},{"name":"nextToken","in":"query","required":false,"description":"The next page of elements from this collection. Not valid for the last element of the collection.","schema":{"type":"string"}}]}},"/v2/apis/{apiId}/routes/{routeId}/routeresponses":{"post":{"operationId":"CreateRouteResponse","description":"Creates a RouteResponse for a Route.","responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateRouteResponseResponse"}}}},"480":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"481":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}},"482":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"483":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}}},"parameters":[{"name":"apiId","in":"path","required":true,"description":"The API identifier.","schema":{"type":"string"}},{"name":"routeId","in":"path","required":true,"description":"The route ID.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["routeResponseKey"],"properties":{"modelSelectionExpression":{"description":"An expression used to extract information at runtime. See <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions\">Selection Expressions</a> for more information.","type":"string"},"responseModels":{"description":"The route models.","type":"object","additionalProperties":{"$ref":"#/components/schemas/StringWithLengthBetween1And128"}},"responseParameters":{"description":"The route parameters.","type":"object","additionalProperties":{"$ref":"#/components/schemas/ParameterConstraints"}},"routeResponseKey":{"description":"After evaluating a selection expression, the result is compared against one or more selection keys to find a matching key. See <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions\">Selection Expressions</a> for a list of expressions and each expression's associated selection key type.","type":"string"}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}],"get":{"operationId":"GetRouteResponses","description":"Gets the RouteResponses for a Route.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetRouteResponsesResponse"}}}},"480":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"481":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}},"482":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}}},"parameters":[{"name":"apiId","in":"path","required":true,"description":"The API identifier.","schema":{"type":"string"}},{"name":"maxResults","in":"query","required":false,"description":"The maximum number of elements to be returned for this resource.","schema":{"type":"string"}},{"name":"nextToken","in":"query","required":false,"description":"The next page of elements from this collection. Not valid for the last element of the collection.","schema":{"type":"string"}},{"name":"routeId","in":"path","required":true,"description":"The route ID.","schema":{"type":"string"}}]}},"/v2/apis/{apiId}/stages":{"post":{"operationId":"CreateStage","description":"Creates a Stage for an API.","responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateStageResponse"}}}},"480":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"481":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}},"482":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"483":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}}},"parameters":[{"name":"apiId","in":"path","required":true,"description":"The API identifier.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["stageName"],"properties":{"accessLogSettings":{"description":"Settings for logging access in a stage.","type":"object","properties":{"DestinationArn":{"allOf":[{"$ref":"#/components/schemas/Arn"},{"xml":{"name":"destinationArn"},"description":"The ARN of the CloudWatch Logs log group to receive access logs."}]},"Format":{"allOf":[{"$ref":"#/components/schemas/StringWithLengthBetween1And1024"},{"xml":{"name":"format"},"description":"A single line format of the access logs of data, as specified by selected $context variables. The format must include at least $context.requestId."}]}}},"autoDeploy":{"description":"Specifies whether updates to an API automatically trigger a new deployment. The default value is false.","type":"boolean"},"clientCertificateId":{"description":"The identifier.","type":"string"},"defaultRouteSettings":{"description":"Represents a collection of route settings.","type":"object","properties":{"DataTraceEnabled":{"allOf":[{"$ref":"#/components/schemas/__boolean"},{"xml":{"name":"dataTraceEnabled"},"description":"Specifies whether (true) or not (false) data trace logging is enabled for this route. This property affects the log entries pushed to Amazon CloudWatch Logs. Supported only for WebSocket APIs."}]},"DetailedMetricsEnabled":{"allOf":[{"$ref":"#/components/schemas/__boolean"},{"xml":{"name":"detailedMetricsEnabled"},"description":"Specifies whether detailed metrics are enabled."}]},"LoggingLevel":{"allOf":[{"$ref":"#/components/schemas/LoggingLevel"},{"xml":{"name":"loggingLevel"},"description":"Specifies the logging level for this route: INFO, ERROR, or OFF. This property affects the log entries pushed to Amazon CloudWatch Logs. Supported only for WebSocket APIs."}]},"ThrottlingBurstLimit":{"allOf":[{"$ref":"#/components/schemas/__integer"},{"xml":{"name":"throttlingBurstLimit"},"description":"Specifies the throttling burst limit."}]},"ThrottlingRateLimit":{"allOf":[{"$ref":"#/components/schemas/__double"},{"xml":{"name":"throttlingRateLimit"},"description":"Specifies the throttling rate limit."}]}}},"deploymentId":{"description":"The identifier.","type":"string"},"description":{"description":"A string with a length between [0-1024].","type":"string"},"routeSettings":{"description":"The route settings map.","type":"object","additionalProperties":{"$ref":"#/components/schemas/RouteSettings"}},"stageName":{"description":"A string with a length between [1-128].","type":"string"},"stageVariables":{"description":"The stage variable map.","type":"object","additionalProperties":{"$ref":"#/components/schemas/StringWithLengthBetween0And2048"}},"tags":{"description":"Represents a collection of tags associated with the resource.","type":"object","additionalProperties":{"$ref":"#/components/schemas/StringWithLengthBetween1And1600"}}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}],"get":{"operationId":"GetStages","description":"Gets the Stages for an API.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetStagesResponse"}}}},"480":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"481":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}},"482":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}}},"parameters":[{"name":"apiId","in":"path","required":true,"description":"The API identifier.","schema":{"type":"string"}},{"name":"maxResults","in":"query","required":false,"description":"The maximum number of elements to be returned for this resource.","schema":{"type":"string"}},{"name":"nextToken","in":"query","required":false,"description":"The next page of elements from this collection. Not valid for the last element of the collection.","schema":{"type":"string"}}]}},"/v2/vpclinks":{"post":{"operationId":"CreateVpcLink","description":"Creates a VPC link.","responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateVpcLinkResponse"}}}},"480":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"481":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}}},"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["name","subnetIds"],"properties":{"name":{"description":"A string with a length between [1-128].","type":"string"},"securityGroupIds":{"description":"A list of security group IDs for the VPC link.","type":"array","items":{"$ref":"#/components/schemas/__string"}},"subnetIds":{"description":"A list of subnet IDs to include in the VPC link.","type":"array","items":{"$ref":"#/components/schemas/__string"}},"tags":{"description":"Represents a collection of tags associated with the resource.","type":"object","additionalProperties":{"$ref":"#/components/schemas/StringWithLengthBetween1And1600"}}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}],"get":{"operationId":"GetVpcLinks","description":"Gets a collection of VPC links.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetVpcLinksResponse"}}}},"480":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"481":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}}},"parameters":[{"name":"maxResults","in":"query","required":false,"description":"The maximum number of elements to be returned for this resource.","schema":{"type":"string"}},{"name":"nextToken","in":"query","required":false,"description":"The next page of elements from this collection. Not valid for the last element of the collection.","schema":{"type":"string"}}]}},"/v2/apis/{apiId}/stages/{stageName}/accesslogsettings":{"delete":{"operationId":"DeleteAccessLogSettings","description":"Deletes the AccessLogSettings for a Stage. To disable access logging for a Stage, delete its AccessLogSettings.","responses":{"204":{"description":"Success"},"480":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"481":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}}},"parameters":[{"name":"apiId","in":"path","required":true,"description":"The API identifier.","schema":{"type":"string"}},{"name":"stageName","in":"path","required":true,"description":"The stage name. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters.","schema":{"type":"string"}}]},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/v2/apis/{apiId}":{"delete":{"operationId":"DeleteApi","description":"Deletes an Api resource.","responses":{"204":{"description":"Success"},"480":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"481":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}}},"parameters":[{"name":"apiId","in":"path","required":true,"description":"The API identifier.","schema":{"type":"string"}}]},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}],"get":{"operationId":"GetApi","description":"Gets an Api resource.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetApiResponse"}}}},"480":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"481":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}}},"parameters":[{"name":"apiId","in":"path","required":true,"description":"The API identifier.","schema":{"type":"string"}}]},"put":{"operationId":"ReimportApi","description":"Puts an Api resource.","responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReimportApiResponse"}}}},"480":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"481":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}},"482":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"483":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}}},"parameters":[{"name":"apiId","in":"path","required":true,"description":"The API identifier.","schema":{"type":"string"}},{"name":"basepath","in":"query","required":false,"description":"Specifies how to interpret the base path of the API during import. Valid values are ignore, prepend, and split. The default value is ignore. To learn more, see <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-import-api-basePath.html\">Set the OpenAPI basePath Property</a>. Supported only for HTTP APIs.","schema":{"type":"string"}},{"name":"failOnWarnings","in":"query","required":false,"description":"Specifies whether to rollback the API creation when a warning is encountered. By default, API creation continues if a warning is encountered.","schema":{"type":"boolean"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"description":"The OpenAPI definition. Supported only for HTTP APIs.","type":"string"}}}}}}},"patch":{"operationId":"UpdateApi","description":"Updates an Api resource.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateApiResponse"}}}},"480":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"481":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}},"482":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"483":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}}},"parameters":[{"name":"apiId","in":"path","required":true,"description":"The API identifier.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"apiKeySelectionExpression":{"description":"An expression used to extract information at runtime. See <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions\">Selection Expressions</a> for more information.","type":"string"},"corsConfiguration":{"description":"Represents a CORS configuration. Supported only for HTTP APIs. See <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-cors.html\">Configuring CORS</a> for more information.","type":"object","properties":{"AllowCredentials":{"allOf":[{"$ref":"#/components/schemas/__boolean"},{"xml":{"name":"allowCredentials"},"description":"Specifies whether credentials are included in the CORS request. Supported only for HTTP APIs."}]},"AllowHeaders":{"allOf":[{"$ref":"#/components/schemas/CorsHeaderList"},{"xml":{"name":"allowHeaders"},"description":"Represents a collection of allowed headers. Supported only for HTTP APIs."}]},"AllowMethods":{"allOf":[{"$ref":"#/components/schemas/CorsMethodList"},{"xml":{"name":"allowMethods"},"description":"Represents a collection of allowed HTTP methods. Supported only for HTTP APIs."}]},"AllowOrigins":{"allOf":[{"$ref":"#/components/schemas/CorsOriginList"},{"xml":{"name":"allowOrigins"},"description":"Represents a collection of allowed origins. Supported only for HTTP APIs."}]},"ExposeHeaders":{"allOf":[{"$ref":"#/components/schemas/CorsHeaderList"},{"xml":{"name":"exposeHeaders"},"description":"Represents a collection of exposed headers. Supported only for HTTP APIs."}]},"MaxAge":{"allOf":[{"$ref":"#/components/schemas/IntegerWithLengthBetweenMinus1And86400"},{"xml":{"name":"maxAge"},"description":"The number of seconds that the browser should cache preflight request results. Supported only for HTTP APIs."}]}}},"credentialsArn":{"description":"Represents an Amazon Resource Name (ARN).","type":"string"},"description":{"description":"A string with a length between [0-1024].","type":"string"},"disableSchemaValidation":{"description":"Avoid validating models when creating a deployment. Supported only for WebSocket APIs.","type":"boolean"},"disableExecuteApiEndpoint":{"description":"Specifies whether clients can invoke your API by using the default execute-api endpoint. By default, clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint.","type":"boolean"},"name":{"description":"A string with a length between [1-128].","type":"string"},"routeKey":{"description":"After evaluating a selection expression, the result is compared against one or more selection keys to find a matching key. See <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions\">Selection Expressions</a> for a list of expressions and each expression's associated selection key type.","type":"string"},"routeSelectionExpression":{"description":"An expression used to extract information at runtime. See <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions\">Selection Expressions</a> for more information.","type":"string"},"target":{"description":"A string representation of a URI with a length between [1-2048].","type":"string"},"version":{"description":"A string with a length between [1-64].","type":"string"}}}}}}}},"/v2/domainnames/{domainName}/apimappings/{apiMappingId}":{"delete":{"operationId":"DeleteApiMapping","description":"Deletes an API mapping.","responses":{"204":{"description":"Success"},"480":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"481":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}},"482":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}}},"parameters":[{"name":"apiMappingId","in":"path","required":true,"description":"The API mapping identifier.","schema":{"type":"string"}},{"name":"domainName","in":"path","required":true,"description":"The domain name.","schema":{"type":"string"}}]},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}],"get":{"operationId":"GetApiMapping","description":"Gets an API mapping.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetApiMappingResponse"}}}},"480":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"481":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}},"482":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}}},"parameters":[{"name":"apiMappingId","in":"path","required":true,"description":"The API mapping identifier.","schema":{"type":"string"}},{"name":"domainName","in":"path","required":true,"description":"The domain name.","schema":{"type":"string"}}]},"patch":{"operationId":"UpdateApiMapping","description":"The API mapping.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateApiMappingResponse"}}}},"480":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"481":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}},"482":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"483":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}}},"parameters":[{"name":"apiMappingId","in":"path","required":true,"description":"The API mapping identifier.","schema":{"type":"string"}},{"name":"domainName","in":"path","required":true,"description":"The domain name.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["apiId"],"properties":{"apiId":{"description":"The identifier.","type":"string"},"apiMappingKey":{"description":"After evaluating a selection expression, the result is compared against one or more selection keys to find a matching key. See <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions\">Selection Expressions</a> for a list of expressions and each expression's associated selection key type.","type":"string"},"stage":{"description":"A string with a length between [1-128].","type":"string"}}}}}}}},"/v2/apis/{apiId}/authorizers/{authorizerId}":{"delete":{"operationId":"DeleteAuthorizer","description":"Deletes an Authorizer.","responses":{"204":{"description":"Success"},"480":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"481":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}}},"parameters":[{"name":"apiId","in":"path","required":true,"description":"The API identifier.","schema":{"type":"string"}},{"name":"authorizerId","in":"path","required":true,"description":"The authorizer identifier.","schema":{"type":"string"}}]},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}],"get":{"operationId":"GetAuthorizer","description":"Gets an Authorizer.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetAuthorizerResponse"}}}},"480":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"481":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}}},"parameters":[{"name":"apiId","in":"path","required":true,"description":"The API identifier.","schema":{"type":"string"}},{"name":"authorizerId","in":"path","required":true,"description":"The authorizer identifier.","schema":{"type":"string"}}]},"patch":{"operationId":"UpdateAuthorizer","description":"Updates an Authorizer.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateAuthorizerResponse"}}}},"480":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"481":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}},"482":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"483":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}}},"parameters":[{"name":"apiId","in":"path","required":true,"description":"The API identifier.","schema":{"type":"string"}},{"name":"authorizerId","in":"path","required":true,"description":"The authorizer identifier.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"authorizerCredentialsArn":{"description":"Represents an Amazon Resource Name (ARN).","type":"string"},"authorizerPayloadFormatVersion":{"description":"A string with a length between [1-64].","type":"string"},"authorizerResultTtlInSeconds":{"description":"An integer with a value between [0-3600].","type":"integer","minimum":0,"maximum":3600},"authorizerType":{"description":"The authorizer type. Specify REQUEST for a Lambda function using incoming request parameters. Specify JWT to use JSON Web Tokens (supported only for HTTP APIs).","type":"string","enum":["REQUEST","JWT"]},"authorizerUri":{"description":"A string representation of a URI with a length between [1-2048].","type":"string"},"enableSimpleResponses":{"description":"Specifies whether a Lambda authorizer returns a response in a simple format. By default, a Lambda authorizer must return an IAM policy. If enabled, the Lambda authorizer can return a boolean value instead of an IAM policy. Supported only for HTTP APIs. To learn more, see <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html\">Working with AWS Lambda authorizers for HTTP APIs</a>","type":"boolean"},"identitySource":{"description":"The identity source for which authorization is requested. For the REQUEST authorizer, this is required when authorization caching is enabled. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an Auth header, a Name query string parameter are defined as identity sources, this value is $method.request.header.Auth, $method.request.querystring.Name. These parameters will be used to derive the authorization caching key and to perform runtime validation of the REQUEST authorizer by verifying all of the identity-related request parameters are present, not null and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function, otherwise, it returns a 401 Unauthorized response without calling the Lambda function. The valid value is a string of comma-separated mapping expressions of the specified request parameters. When the authorization caching is not enabled, this property is optional.","type":"array","items":{"$ref":"#/components/schemas/__string"}},"identityValidationExpression":{"description":"A string with a length between [0-1024].","type":"string"},"jwtConfiguration":{"description":"Represents the configuration of a JWT authorizer. Required for the JWT authorizer type. Supported only for HTTP APIs.","type":"object","properties":{"Audience":{"allOf":[{"$ref":"#/components/schemas/__listOf__string"},{"xml":{"name":"audience"},"description":"A list of the intended recipients of the JWT. A valid JWT must provide an aud that matches at least one entry in this list. See <a href=\"https://tools.ietf.org/html/rfc7519#section-4.1.3\">RFC 7519</a>. Supported only for HTTP APIs."}]},"Issuer":{"allOf":[{"$ref":"#/components/schemas/UriWithLengthBetween1And2048"},{"xml":{"name":"issuer"},"description":"The base domain of the identity provider that issues JSON Web Tokens. For example, an Amazon Cognito user pool has the following format: https://cognito-idp.<replaceable>{region}</replaceable>.amazonaws.com/<replaceable>{userPoolId}</replaceable>\n . Required for the JWT authorizer type. Supported only for HTTP APIs."}]}}},"name":{"description":"A string with a length between [1-128].","type":"string"}}}}}}}},"/v2/apis/{apiId}/cors":{"delete":{"operationId":"DeleteCorsConfiguration","description":"Deletes a CORS configuration.","responses":{"204":{"description":"Success"},"480":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"481":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}}},"parameters":[{"name":"apiId","in":"path","required":true,"description":"The API identifier.","schema":{"type":"string"}}]},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/v2/apis/{apiId}/deployments/{deploymentId}":{"delete":{"operationId":"DeleteDeployment","description":"Deletes a Deployment.","responses":{"204":{"description":"Success"},"480":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"481":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}}},"parameters":[{"name":"apiId","in":"path","required":true,"description":"The API identifier.","schema":{"type":"string"}},{"name":"deploymentId","in":"path","required":true,"description":"The deployment ID.","schema":{"type":"string"}}]},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}],"get":{"operationId":"GetDeployment","description":"Gets a Deployment.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetDeploymentResponse"}}}},"480":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"481":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}}},"parameters":[{"name":"apiId","in":"path","required":true,"description":"The API identifier.","schema":{"type":"string"}},{"name":"deploymentId","in":"path","required":true,"description":"The deployment ID.","schema":{"type":"string"}}]},"patch":{"operationId":"UpdateDeployment","description":"Updates a Deployment.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateDeploymentResponse"}}}},"480":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"481":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}},"482":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"483":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}}},"parameters":[{"name":"apiId","in":"path","required":true,"description":"The API identifier.","schema":{"type":"string"}},{"name":"deploymentId","in":"path","required":true,"description":"The deployment ID.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"description":{"description":"A string with a length between [0-1024].","type":"string"}}}}}}}},"/v2/domainnames/{domainName}":{"delete":{"operationId":"DeleteDomainName","description":"Deletes a domain name.","responses":{"204":{"description":"Success"},"480":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"481":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}}},"parameters":[{"name":"domainName","in":"path","required":true,"description":"The domain name.","schema":{"type":"string"}}]},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}],"get":{"operationId":"GetDomainName","description":"Gets a domain name.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetDomainNameResponse"}}}},"480":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"481":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}}},"parameters":[{"name":"domainName","in":"path","required":true,"description":"The domain name.","schema":{"type":"string"}}]},"patch":{"operationId":"UpdateDomainName","description":"Updates a domain name.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateDomainNameResponse"}}}},"480":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"481":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}},"482":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"483":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}}},"parameters":[{"name":"domainName","in":"path","required":true,"description":"The domain name.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"domainNameConfigurations":{"description":"The domain name configurations.","type":"array","items":{"$ref":"#/components/schemas/DomainNameConfiguration"}},"mutualTlsAuthentication":{"description":"The mutual TLS authentication configuration for a custom domain name.","type":"object","properties":{"TruststoreUri":{"allOf":[{"$ref":"#/components/schemas/UriWithLengthBetween1And2048"},{"xml":{"name":"truststoreUri"},"description":"An Amazon S3 URL that specifies the truststore for mutual TLS authentication, for example, s3://<replaceable>bucket-name</replaceable>/<replaceable>key-name</replaceable>. The truststore can contain certificates from public or private certificate authorities. To update the truststore, upload a new version to S3, and then update your custom domain name to use the new version. To update the truststore, you must have permissions to access the S3 object."}]},"TruststoreVersion":{"allOf":[{"$ref":"#/components/schemas/StringWithLengthBetween1And64"},{"xml":{"name":"truststoreVersion"},"description":"The version of the S3 object that contains your truststore. To specify a version, you must have versioning enabled for the S3 bucket."}]}}}}}}}}}},"/v2/apis/{apiId}/integrations/{integrationId}":{"delete":{"operationId":"DeleteIntegration","description":"Deletes an Integration.","responses":{"204":{"description":"Success"},"480":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"481":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}}},"parameters":[{"name":"apiId","in":"path","required":true,"description":"The API identifier.","schema":{"type":"string"}},{"name":"integrationId","in":"path","required":true,"description":"The integration ID.","schema":{"type":"string"}}]},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}],"get":{"operationId":"GetIntegration","description":"Gets an Integration.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetIntegrationResult"}}}},"480":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"481":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}}},"parameters":[{"name":"apiId","in":"path","required":true,"description":"The API identifier.","schema":{"type":"string"}},{"name":"integrationId","in":"path","required":true,"description":"The integration ID.","schema":{"type":"string"}}]},"patch":{"operationId":"UpdateIntegration","description":"Updates an Integration.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateIntegrationResult"}}}},"480":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"481":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}},"482":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"483":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}}},"parameters":[{"name":"apiId","in":"path","required":true,"description":"The API identifier.","schema":{"type":"string"}},{"name":"integrationId","in":"path","required":true,"description":"The integration ID.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"connectionId":{"description":"A string with a length between [1-1024].","type":"string"},"connectionType":{"description":"Represents a connection type.","type":"string","enum":["INTERNET","VPC_LINK"]},"contentHandlingStrategy":{"description":"Specifies how to handle response payload content type conversions. Supported only for WebSocket APIs.","type":"string","enum":["CONVERT_TO_BINARY","CONVERT_TO_TEXT"]},"credentialsArn":{"description":"Represents an Amazon Resource Name (ARN).","type":"string"},"description":{"description":"A string with a length between [0-1024].","type":"string"},"integrationMethod":{"description":"A string with a length between [1-64].","type":"string"},"integrationSubtype":{"description":"A string with a length between [1-128].","type":"string"},"integrationType":{"description":"Represents an API method integration type.","type":"string","enum":["AWS","HTTP","MOCK","HTTP_PROXY","AWS_PROXY"]},"integrationUri":{"description":"A string representation of a URI with a length between [1-2048].","type":"string"},"passthroughBehavior":{"description":"Represents passthrough behavior for an integration response. Supported only for WebSocket APIs.","type":"string","enum":["WHEN_NO_MATCH","NEVER","WHEN_NO_TEMPLATES"]},"payloadFormatVersion":{"description":"A string with a length between [1-64].","type":"string"},"requestParameters":{"description":"<p>For WebSocket APIs, a key-value map specifying request parameters that are passed from the method request to the backend. The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the backend. The method request parameter value must match the pattern of method.request.<replaceable>{location}</replaceable>.<replaceable>{name}</replaceable>\n , where \n <replaceable>{location}</replaceable>\n is querystring, path, or header; and \n <replaceable>{name}</replaceable>\n must be a valid and unique method request parameter name.</p> <p>For HTTP API integrations with a specified integrationSubtype, request parameters are a key-value map specifying parameters that are passed to AWS_PROXY integrations. You can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-aws-services.html\">Working with AWS service integrations for HTTP APIs</a>.</p> <p>For HTTP API integrations without a specified integrationSubtype request parameters are a key-value map specifying how to transform HTTP requests before sending them to the backend. The key should follow the pattern <action>:<header|querystring|path>.<location> where action can be append, overwrite or remove. For values, you can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-parameter-mapping.html\">Transforming API requests and responses</a>.</p>","type":"object","additionalProperties":{"$ref":"#/components/schemas/StringWithLengthBetween1And512"}},"requestTemplates":{"description":"A mapping of identifier keys to templates. The value is an actual template script. The key is typically a SelectionKey which is chosen based on evaluating a selection expression.","type":"object","additionalProperties":{"$ref":"#/components/schemas/StringWithLengthBetween0And32K"}},"responseParameters":{"description":"Supported only for HTTP APIs. You use response parameters to transform the HTTP response from a backend integration before returning the response to clients.","type":"object","additionalProperties":{"$ref":"#/components/schemas/IntegrationParameters"}},"templateSelectionExpression":{"description":"An expression used to extract information at runtime. See <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions\">Selection Expressions</a> for more information.","type":"string"},"timeoutInMillis":{"description":"An integer with a value between [50-30000].","type":"integer","minimum":50,"maximum":30000},"tlsConfig":{"description":"The TLS configuration for a private integration. If you specify a TLS configuration, private integration traffic uses the HTTPS protocol. Supported only for HTTP APIs.","type":"object","properties":{"ServerNameToVerify":{"allOf":[{"$ref":"#/components/schemas/StringWithLengthBetween1And512"},{"xml":{"name":"serverNameToVerify"},"description":"If you specify a server name, API Gateway uses it to verify the hostname on the integration's certificate. The server name is also included in the TLS handshake to support Server Name Indication (SNI) or virtual hosting."}]}}}}}}}}}},"/v2/apis/{apiId}/integrations/{integrationId}/integrationresponses/{integrationResponseId}":{"delete":{"operationId":"DeleteIntegrationResponse","description":"Deletes an IntegrationResponses.","responses":{"204":{"description":"Success"},"480":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"481":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}}},"parameters":[{"name":"apiId","in":"path","required":true,"description":"The API identifier.","schema":{"type":"string"}},{"name":"integrationId","in":"path","required":true,"description":"The integration ID.","schema":{"type":"string"}},{"name":"integrationResponseId","in":"path","required":true,"description":"The integration response ID.","schema":{"type":"string"}}]},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}],"get":{"operationId":"GetIntegrationResponse","description":"Gets an IntegrationResponses.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetIntegrationResponseResponse"}}}},"480":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"481":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}}},"parameters":[{"name":"apiId","in":"path","required":true,"description":"The API identifier.","schema":{"type":"string"}},{"name":"integrationId","in":"path","required":true,"description":"The integration ID.","schema":{"type":"string"}},{"name":"integrationResponseId","in":"path","required":true,"description":"The integration response ID.","schema":{"type":"string"}}]},"patch":{"operationId":"UpdateIntegrationResponse","description":"Updates an IntegrationResponses.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateIntegrationResponseResponse"}}}},"480":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"481":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}},"482":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"483":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}}},"parameters":[{"name":"apiId","in":"path","required":true,"description":"The API identifier.","schema":{"type":"string"}},{"name":"integrationId","in":"path","required":true,"description":"The integration ID.","schema":{"type":"string"}},{"name":"integrationResponseId","in":"path","required":true,"description":"The integration response ID.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"contentHandlingStrategy":{"description":"Specifies how to handle response payload content type conversions. Supported only for WebSocket APIs.","type":"string","enum":["CONVERT_TO_BINARY","CONVERT_TO_TEXT"]},"integrationResponseKey":{"description":"After evaluating a selection expression, the result is compared against one or more selection keys to find a matching key. See <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions\">Selection Expressions</a> for a list of expressions and each expression's associated selection key type.","type":"string"},"responseParameters":{"description":"<p>For WebSocket APIs, a key-value map specifying request parameters that are passed from the method request to the backend. The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the backend. The method request parameter value must match the pattern of method.request.<replaceable>{location}</replaceable>.<replaceable>{name}</replaceable>\n , where \n <replaceable>{location}</replaceable>\n is querystring, path, or header; and \n <replaceable>{name}</replaceable>\n must be a valid and unique method request parameter name.</p> <p>For HTTP API integrations with a specified integrationSubtype, request parameters are a key-value map specifying parameters that are passed to AWS_PROXY integrations. You can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-aws-services.html\">Working with AWS service integrations for HTTP APIs</a>.</p> <p>For HTTP API integrations without a specified integrationSubtype request parameters are a key-value map specifying how to transform HTTP requests before sending them to the backend. The key should follow the pattern <action>:<header|querystring|path>.<location> where action can be append, overwrite or remove. For values, you can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-parameter-mapping.html\">Transforming API requests and responses</a>.</p>","type":"object","additionalProperties":{"$ref":"#/components/schemas/StringWithLengthBetween1And512"}},"responseTemplates":{"description":"A mapping of identifier keys to templates. The value is an actual template script. The key is typically a SelectionKey which is chosen based on evaluating a selection expression.","type":"object","additionalProperties":{"$ref":"#/components/schemas/StringWithLengthBetween0And32K"}},"templateSelectionExpression":{"description":"An expression used to extract information at runtime. See <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions\">Selection Expressions</a> for more information.","type":"string"}}}}}}}},"/v2/apis/{apiId}/models/{modelId}":{"delete":{"operationId":"DeleteModel","description":"Deletes a Model.","responses":{"204":{"description":"Success"},"480":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"481":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}}},"parameters":[{"name":"apiId","in":"path","required":true,"description":"The API identifier.","schema":{"type":"string"}},{"name":"modelId","in":"path","required":true,"description":"The model ID.","schema":{"type":"string"}}]},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}],"get":{"operationId":"GetModel","description":"Gets a Model.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetModelResponse"}}}},"480":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"481":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}}},"parameters":[{"name":"apiId","in":"path","required":true,"description":"The API identifier.","schema":{"type":"string"}},{"name":"modelId","in":"path","required":true,"description":"The model ID.","schema":{"type":"string"}}]},"patch":{"operationId":"UpdateModel","description":"Updates a Model.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateModelResponse"}}}},"480":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"481":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}},"482":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"483":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}}},"parameters":[{"name":"apiId","in":"path","required":true,"description":"The API identifier.","schema":{"type":"string"}},{"name":"modelId","in":"path","required":true,"description":"The model ID.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"contentType":{"description":"A string with a length between [1-256].","type":"string"},"description":{"description":"A string with a length between [0-1024].","type":"string"},"name":{"description":"A string with a length between [1-128].","type":"string"},"schema":{"description":"A string with a length between [0-32768].","type":"string"}}}}}}}},"/v2/apis/{apiId}/routes/{routeId}":{"delete":{"operationId":"DeleteRoute","description":"Deletes a Route.","responses":{"204":{"description":"Success"},"480":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"481":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}}},"parameters":[{"name":"apiId","in":"path","required":true,"description":"The API identifier.","schema":{"type":"string"}},{"name":"routeId","in":"path","required":true,"description":"The route ID.","schema":{"type":"string"}}]},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}],"get":{"operationId":"GetRoute","description":"Gets a Route.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetRouteResult"}}}},"480":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"481":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}}},"parameters":[{"name":"apiId","in":"path","required":true,"description":"The API identifier.","schema":{"type":"string"}},{"name":"routeId","in":"path","required":true,"description":"The route ID.","schema":{"type":"string"}}]},"patch":{"operationId":"UpdateRoute","description":"Updates a Route.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateRouteResult"}}}},"480":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"481":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}},"482":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"483":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}}},"parameters":[{"name":"apiId","in":"path","required":true,"description":"The API identifier.","schema":{"type":"string"}},{"name":"routeId","in":"path","required":true,"description":"The route ID.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"apiKeyRequired":{"description":"Specifies whether an API key is required for the route. Supported only for WebSocket APIs.","type":"boolean"},"authorizationScopes":{"description":"A list of authorization scopes configured on a route. The scopes are used with a JWT authorizer to authorize the method invocation. The authorization works by matching the route scopes against the scopes parsed from the access token in the incoming request. The method invocation is authorized if any route scope matches a claimed scope in the access token. Otherwise, the invocation is not authorized. When the route scope is configured, the client must provide an access token instead of an identity token for authorization purposes.","type":"array","items":{"$ref":"#/components/schemas/StringWithLengthBetween1And64"}},"authorizationType":{"description":"The authorization type. For WebSocket APIs, valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer. For HTTP APIs, valid values are NONE for open access, JWT for using JSON Web Tokens, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer.","type":"string","enum":["NONE","AWS_IAM","CUSTOM","JWT"]},"authorizerId":{"description":"The identifier.","type":"string"},"modelSelectionExpression":{"description":"An expression used to extract information at runtime. See <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions\">Selection Expressions</a> for more information.","type":"string"},"operationName":{"description":"A string with a length between [1-64].","type":"string"},"requestModels":{"description":"The route models.","type":"object","additionalProperties":{"$ref":"#/components/schemas/StringWithLengthBetween1And128"}},"requestParameters":{"description":"The route parameters.","type":"object","additionalProperties":{"$ref":"#/components/schemas/ParameterConstraints"}},"routeKey":{"description":"After evaluating a selection expression, the result is compared against one or more selection keys to find a matching key. See <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions\">Selection Expressions</a> for a list of expressions and each expression's associated selection key type.","type":"string"},"routeResponseSelectionExpression":{"description":"An expression used to extract information at runtime. See <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions\">Selection Expressions</a> for more information.","type":"string"},"target":{"description":"A string with a length between [1-128].","type":"string"}}}}}}}},"/v2/apis/{apiId}/routes/{routeId}/requestparameters/{requestParameterKey}":{"delete":{"operationId":"DeleteRouteRequestParameter","description":"Deletes a route request parameter.","responses":{"204":{"description":"Success"},"480":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"481":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}}},"parameters":[{"name":"apiId","in":"path","required":true,"description":"The API identifier.","schema":{"type":"string"}},{"name":"requestParameterKey","in":"path","required":true,"description":"The route request parameter key.","schema":{"type":"string"}},{"name":"routeId","in":"path","required":true,"description":"The route ID.","schema":{"type":"string"}}]},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/v2/apis/{apiId}/routes/{routeId}/routeresponses/{routeResponseId}":{"delete":{"operationId":"DeleteRouteResponse","description":"Deletes a RouteResponse.","responses":{"204":{"description":"Success"},"480":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"481":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}}},"parameters":[{"name":"apiId","in":"path","required":true,"description":"The API identifier.","schema":{"type":"string"}},{"name":"routeId","in":"path","required":true,"description":"The route ID.","schema":{"type":"string"}},{"name":"routeResponseId","in":"path","required":true,"description":"The route response ID.","schema":{"type":"string"}}]},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}],"get":{"operationId":"GetRouteResponse","description":"Gets a RouteResponse.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetRouteResponseResponse"}}}},"480":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"481":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}}},"parameters":[{"name":"apiId","in":"path","required":true,"description":"The API identifier.","schema":{"type":"string"}},{"name":"routeId","in":"path","required":true,"description":"The route ID.","schema":{"type":"string"}},{"name":"routeResponseId","in":"path","required":true,"description":"The route response ID.","schema":{"type":"string"}}]},"patch":{"operationId":"UpdateRouteResponse","description":"Updates a RouteResponse.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateRouteResponseResponse"}}}},"480":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"481":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}},"482":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"483":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}}},"parameters":[{"name":"apiId","in":"path","required":true,"description":"The API identifier.","schema":{"type":"string"}},{"name":"routeId","in":"path","required":true,"description":"The route ID.","schema":{"type":"string"}},{"name":"routeResponseId","in":"path","required":true,"description":"The route response ID.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"modelSelectionExpression":{"description":"An expression used to extract information at runtime. See <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions\">Selection Expressions</a> for more information.","type":"string"},"responseModels":{"description":"The route models.","type":"object","additionalProperties":{"$ref":"#/components/schemas/StringWithLengthBetween1And128"}},"responseParameters":{"description":"The route parameters.","type":"object","additionalProperties":{"$ref":"#/components/schemas/ParameterConstraints"}},"routeResponseKey":{"description":"After evaluating a selection expression, the result is compared against one or more selection keys to find a matching key. See <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions\">Selection Expressions</a> for a list of expressions and each expression's associated selection key type.","type":"string"}}}}}}}},"/v2/apis/{apiId}/stages/{stageName}/routesettings/{routeKey}":{"delete":{"operationId":"DeleteRouteSettings","description":"Deletes the RouteSettings for a stage.","responses":{"204":{"description":"Success"},"480":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"481":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}}},"parameters":[{"name":"apiId","in":"path","required":true,"description":"The API identifier.","schema":{"type":"string"}},{"name":"routeKey","in":"path","required":true,"description":"The route key.","schema":{"type":"string"}},{"name":"stageName","in":"path","required":true,"description":"The stage name. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters.","schema":{"type":"string"}}]},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/v2/apis/{apiId}/stages/{stageName}":{"delete":{"operationId":"DeleteStage","description":"Deletes a Stage.","responses":{"204":{"description":"Success"},"480":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"481":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}}},"parameters":[{"name":"apiId","in":"path","required":true,"description":"The API identifier.","schema":{"type":"string"}},{"name":"stageName","in":"path","required":true,"description":"The stage name. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters.","schema":{"type":"string"}}]},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}],"get":{"operationId":"GetStage","description":"Gets a Stage.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetStageResponse"}}}},"480":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"481":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}}},"parameters":[{"name":"apiId","in":"path","required":true,"description":"The API identifier.","schema":{"type":"string"}},{"name":"stageName","in":"path","required":true,"description":"The stage name. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters.","schema":{"type":"string"}}]},"patch":{"operationId":"UpdateStage","description":"Updates a Stage.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateStageResponse"}}}},"480":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"481":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}},"482":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"483":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}}},"parameters":[{"name":"apiId","in":"path","required":true,"description":"The API identifier.","schema":{"type":"string"}},{"name":"stageName","in":"path","required":true,"description":"The stage name. Stage names can contain only alphanumeric characters, hyphens, and underscores, or be $default. Maximum length is 128 characters.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"accessLogSettings":{"description":"Settings for logging access in a stage.","type":"object","properties":{"DestinationArn":{"allOf":[{"$ref":"#/components/schemas/Arn"},{"xml":{"name":"destinationArn"},"description":"The ARN of the CloudWatch Logs log group to receive access logs."}]},"Format":{"allOf":[{"$ref":"#/components/schemas/StringWithLengthBetween1And1024"},{"xml":{"name":"format"},"description":"A single line format of the access logs of data, as specified by selected $context variables. The format must include at least $context.requestId."}]}}},"autoDeploy":{"description":"Specifies whether updates to an API automatically trigger a new deployment. The default value is false.","type":"boolean"},"clientCertificateId":{"description":"The identifier.","type":"string"},"defaultRouteSettings":{"description":"Represents a collection of route settings.","type":"object","properties":{"DataTraceEnabled":{"allOf":[{"$ref":"#/components/schemas/__boolean"},{"xml":{"name":"dataTraceEnabled"},"description":"Specifies whether (true) or not (false) data trace logging is enabled for this route. This property affects the log entries pushed to Amazon CloudWatch Logs. Supported only for WebSocket APIs."}]},"DetailedMetricsEnabled":{"allOf":[{"$ref":"#/components/schemas/__boolean"},{"xml":{"name":"detailedMetricsEnabled"},"description":"Specifies whether detailed metrics are enabled."}]},"LoggingLevel":{"allOf":[{"$ref":"#/components/schemas/LoggingLevel"},{"xml":{"name":"loggingLevel"},"description":"Specifies the logging level for this route: INFO, ERROR, or OFF. This property affects the log entries pushed to Amazon CloudWatch Logs. Supported only for WebSocket APIs."}]},"ThrottlingBurstLimit":{"allOf":[{"$ref":"#/components/schemas/__integer"},{"xml":{"name":"throttlingBurstLimit"},"description":"Specifies the throttling burst limit."}]},"ThrottlingRateLimit":{"allOf":[{"$ref":"#/components/schemas/__double"},{"xml":{"name":"throttlingRateLimit"},"description":"Specifies the throttling rate limit."}]}}},"deploymentId":{"description":"The identifier.","type":"string"},"description":{"description":"A string with a length between [0-1024].","type":"string"},"routeSettings":{"description":"The route settings map.","type":"object","additionalProperties":{"$ref":"#/components/schemas/RouteSettings"}},"stageVariables":{"description":"The stage variable map.","type":"object","additionalProperties":{"$ref":"#/components/schemas/StringWithLengthBetween0And2048"}}}}}}}}},"/v2/vpclinks/{vpcLinkId}":{"delete":{"operationId":"DeleteVpcLink","description":"Deletes a VPC link.","responses":{"202":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteVpcLinkResponse"}}}},"480":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"481":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}}},"parameters":[{"name":"vpcLinkId","in":"path","required":true,"description":"The ID of the VPC link.","schema":{"type":"string"}}]},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}],"get":{"operationId":"GetVpcLink","description":"Gets a VPC link.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetVpcLinkResponse"}}}},"480":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"481":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}}},"parameters":[{"name":"vpcLinkId","in":"path","required":true,"description":"The ID of the VPC link.","schema":{"type":"string"}}]},"patch":{"operationId":"UpdateVpcLink","description":"Updates a VPC link.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateVpcLinkResponse"}}}},"480":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"481":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}},"482":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}}},"parameters":[{"name":"vpcLinkId","in":"path","required":true,"description":"The ID of the VPC link.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"description":"A string with a length between [1-128].","type":"string"}}}}}}}},"/v2/apis/{apiId}/exports/{specification}#outputType":{"get":{"operationId":"ExportApi","description":"","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExportApiResponse"}}}},"480":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"481":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}},"482":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}}},"parameters":[{"name":"apiId","in":"path","required":true,"description":"The API identifier.","schema":{"type":"string"}},{"name":"exportVersion","in":"query","required":false,"description":"The version of the API Gateway export algorithm. API Gateway uses the latest version by default. Currently, the only supported version is 1.0.","schema":{"type":"string"}},{"name":"includeExtensions","in":"query","required":false,"description":"Specifies whether to include <a href=\"https://docs.aws.amazon.com//apigateway/latest/developerguide/api-gateway-swagger-extensions.html\">API Gateway extensions</a> in the exported API definition. API Gateway extensions are included by default.","schema":{"type":"boolean"}},{"name":"outputType","in":"query","required":true,"description":"The output type of the exported definition file. Valid values are JSON and YAML.","schema":{"type":"string"}},{"name":"specification","in":"path","required":true,"description":"The version of the API specification to use. OAS30, for OpenAPI 3.0, is the only supported value.","schema":{"type":"string"}},{"name":"stageName","in":"query","required":false,"description":"The name of the API stage to export. If you don't specify this property, a representation of the latest API configuration is exported.","schema":{"type":"string"}}]},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/v2/apis/{apiId}/stages/{stageName}/cache/authorizers":{"delete":{"operationId":"ResetAuthorizersCache","description":"Resets all authorizer cache entries on a stage. Supported only for HTTP APIs.","responses":{"204":{"description":"Success"},"480":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"481":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}}},"parameters":[{"name":"apiId","in":"path","required":true,"description":"The API identifier.","schema":{"type":"string"}},{"name":"stageName","in":"path","required":true,"description":"The stage name. Stage names can contain only alphanumeric characters, hyphens, and underscores, or be $default. Maximum length is 128 characters.","schema":{"type":"string"}}]},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/v2/apis/{apiId}/models/{modelId}/template":{"get":{"operationId":"GetModelTemplate","description":"Gets a model template.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetModelTemplateResponse"}}}},"480":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"481":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}}},"parameters":[{"name":"apiId","in":"path","required":true,"description":"The API identifier.","schema":{"type":"string"}},{"name":"modelId","in":"path","required":true,"description":"The model ID.","schema":{"type":"string"}}]},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/v2/tags/{resource-arn}":{"get":{"operationId":"GetTags","description":"Gets a collection of Tag resources.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetTagsResponse"}}}},"480":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"481":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}},"482":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"483":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}}},"parameters":[{"name":"resource-arn","in":"path","required":true,"description":"The resource ARN for the tag.","schema":{"type":"string"}}]},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}],"post":{"operationId":"TagResource","description":"Creates a new Tag resource to represent a tag.","responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TagResourceResponse"}}}},"480":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"481":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}},"482":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"483":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}}},"parameters":[{"name":"resource-arn","in":"path","required":true,"description":"The resource ARN for the tag.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"tags":{"description":"Represents a collection of tags associated with the resource.","type":"object","additionalProperties":{"$ref":"#/components/schemas/StringWithLengthBetween1And1600"}}}}}}}}},"/v2/tags/{resource-arn}#tagKeys":{"delete":{"operationId":"UntagResource","description":"Deletes a Tag.","responses":{"204":{"description":"Success"},"480":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"481":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}},"482":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"483":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}}},"parameters":[{"name":"resource-arn","in":"path","required":true,"description":"The resource ARN for the tag.","schema":{"type":"string"}},{"name":"tagKeys","in":"query","required":true,"description":"The Tag keys to delete","schema":{"type":"array","items":{"$ref":"#/components/schemas/__string"}}}]},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]}},"components":{"parameters":{"X-Amz-Content-Sha256":{"name":"X-Amz-Content-Sha256","in":"header","schema":{"type":"string"},"required":false},"X-Amz-Date":{"name":"X-Amz-Date","in":"header","schema":{"type":"string"},"required":false},"X-Amz-Algorithm":{"name":"X-Amz-Algorithm","in":"header","schema":{"type":"string"},"required":false},"X-Amz-Credential":{"name":"X-Amz-Credential","in":"header","schema":{"type":"string"},"required":false},"X-Amz-Security-Token":{"name":"X-Amz-Security-Token","in":"header","schema":{"type":"string"},"required":false},"X-Amz-Signature":{"name":"X-Amz-Signature","in":"header","schema":{"type":"string"},"required":false},"X-Amz-SignedHeaders":{"name":"X-Amz-SignedHeaders","in":"header","schema":{"type":"string"},"required":false}},"securitySchemes":{"hmac":{"type":"apiKey","name":"Authorization","in":"header","description":"Amazon Signature authorization v4","x-amazon-apigateway-authtype":"awsSigv4"}},"schemas":{"CreateApiResponse":{"type":"object","properties":{"ApiEndpoint":{"allOf":[{"$ref":"#/components/schemas/__string"},{"xml":{"name":"apiEndpoint"},"description":"The URI of the API, of the form {api-id}.execute-api.{region}.amazonaws.com. The stage name is typically appended to this URI to form a complete path to a deployed API stage."}]},"ApiGatewayManaged":{"allOf":[{"$ref":"#/components/schemas/__boolean"},{"xml":{"name":"apiGatewayManaged"},"description":"Specifies whether an API is managed by API Gateway. You can't update or delete a managed API by using API Gateway. A managed API can be deleted only through the tooling or service that created it."}]},"ApiId":{"allOf":[{"$ref":"#/components/schemas/Id"},{"xml":{"name":"apiId"},"description":"The API ID."}]},"ApiKeySelectionExpression":{"allOf":[{"$ref":"#/components/schemas/SelectionExpression"},{"xml":{"name":"apiKeySelectionExpression"},"description":"An API key selection expression. Supported only for WebSocket APIs. See <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions\">API Key Selection Expressions</a>."}]},"CorsConfiguration":{"allOf":[{"$ref":"#/components/schemas/Cors"},{"xml":{"name":"corsConfiguration"},"description":"A CORS configuration. Supported only for HTTP APIs."}]},"CreatedDate":{"allOf":[{"$ref":"#/components/schemas/__timestampIso8601"},{"xml":{"name":"createdDate"},"description":"The timestamp when the API was created."}]},"Description":{"allOf":[{"$ref":"#/components/schemas/StringWithLengthBetween0And1024"},{"xml":{"name":"description"},"description":"The description of the API."}]},"DisableSchemaValidation":{"allOf":[{"$ref":"#/components/schemas/__boolean"},{"xml":{"name":"disableSchemaValidation"},"description":"Avoid validating models when creating a deployment. Supported only for WebSocket APIs."}]},"DisableExecuteApiEndpoint":{"allOf":[{"$ref":"#/components/schemas/__boolean"},{"xml":{"name":"disableExecuteApiEndpoint"},"description":"Specifies whether clients can invoke your API by using the default execute-api endpoint. By default, clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint."}]},"ImportInfo":{"allOf":[{"$ref":"#/components/schemas/__listOf__string"},{"xml":{"name":"importInfo"},"description":"The validation information during API import. This may include particular properties of your OpenAPI definition which are ignored during import. Supported only for HTTP APIs."}]},"Name":{"allOf":[{"$ref":"#/components/schemas/StringWithLengthBetween1And128"},{"xml":{"name":"name"},"description":"The name of the API."}]},"ProtocolType":{"allOf":[{"$ref":"#/components/schemas/ProtocolType"},{"xml":{"name":"protocolType"},"description":"The API protocol."}]},"RouteSelectionExpression":{"allOf":[{"$ref":"#/components/schemas/SelectionExpression"},{"xml":{"name":"routeSelectionExpression"},"description":"The route selection expression for the API. For HTTP APIs, the routeSelectionExpression must be ${request.method} ${request.path}. If not provided, this will be the default for HTTP APIs. This property is required for WebSocket APIs."}]},"Tags":{"allOf":[{"$ref":"#/components/schemas/Tags"},{"xml":{"name":"tags"},"description":"A collection of tags associated with the API."}]},"Version":{"allOf":[{"$ref":"#/components/schemas/StringWithLengthBetween1And64"},{"xml":{"name":"version"},"description":"A version identifier for the API."}]},"Warnings":{"allOf":[{"$ref":"#/components/schemas/__listOf__string"},{"xml":{"name":"warnings"},"description":"The warning messages reported when failonwarnings is turned on during API import."}]}}},"__boolean":{"type":"boolean"},"CorsHeaderList":{"type":"array","description":"Represents a collection of allowed headers. Supported only for HTTP APIs.","items":{"$ref":"#/components/schemas/__string"}},"CorsMethodList":{"type":"array","description":"Represents a collection of methods. Supported only for HTTP APIs.","items":{"$ref":"#/components/schemas/StringWithLengthBetween1And64"}},"CorsOriginList":{"type":"array","description":"Represents a collection of origins. Supported only for HTTP APIs.","items":{"$ref":"#/components/schemas/__string"}},"IntegerWithLengthBetweenMinus1And86400":{"type":"integer","description":"An integer with a value between -1 and 86400. Supported only for HTTP APIs.","minimum":-1,"maximum":86400},"StringWithLengthBetween1And1600":{"type":"string","description":"A string with a length between [0-1600]."},"NotFoundException":{},"TooManyRequestsException":{},"BadRequestException":{},"ConflictException":{},"CreateApiMappingResponse":{"type":"object","properties":{"ApiId":{"allOf":[{"$ref":"#/components/schemas/Id"},{"xml":{"name":"apiId"},"description":"The API identifier."}]},"ApiMappingId":{"allOf":[{"$ref":"#/components/schemas/Id"},{"xml":{"name":"apiMappingId"},"description":"The API mapping identifier."}]},"ApiMappingKey":{"allOf":[{"$ref":"#/components/schemas/SelectionKey"},{"xml":{"name":"apiMappingKey"},"description":"The API mapping key."}]},"Stage":{"allOf":[{"$ref":"#/components/schemas/StringWithLengthBetween1And128"},{"xml":{"name":"stage"},"description":"The API stage."}]}}},"CreateAuthorizerResponse":{"type":"object","properties":{"AuthorizerCredentialsArn":{"allOf":[{"$ref":"#/components/schemas/Arn"},{"xml":{"name":"authorizerCredentialsArn"},"description":"Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, don't specify this parameter. Supported only for REQUEST authorizers."}]},"AuthorizerId":{"allOf":[{"$ref":"#/components/schemas/Id"},{"xml":{"name":"authorizerId"},"description":"The authorizer identifier."}]},"AuthorizerPayloadFormatVersion":{"allOf":[{"$ref":"#/components/schemas/StringWithLengthBetween1And64"},{"xml":{"name":"authorizerPayloadFormatVersion"},"description":"Specifies the format of the payload sent to an HTTP API Lambda authorizer. Required for HTTP API Lambda authorizers. Supported values are 1.0 and 2.0. To learn more, see <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html\">Working with AWS Lambda authorizers for HTTP APIs</a>."}]},"AuthorizerResultTtlInSeconds":{"allOf":[{"$ref":"#/components/schemas/IntegerWithLengthBetween0And3600"},{"xml":{"name":"authorizerResultTtlInSeconds"},"description":"The time to live (TTL) for cached authorizer results, in seconds. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway caches authorizer responses. The maximum value is 3600, or 1 hour. Supported only for HTTP API Lambda authorizers."}]},"AuthorizerType":{"allOf":[{"$ref":"#/components/schemas/AuthorizerType"},{"xml":{"name":"authorizerType"},"description":"The authorizer type. Specify REQUEST for a Lambda function using incoming request parameters. Specify JWT to use JSON Web Tokens (supported only for HTTP APIs)."}]},"AuthorizerUri":{"allOf":[{"$ref":"#/components/schemas/UriWithLengthBetween1And2048"},{"xml":{"name":"authorizerUri"},"description":"The authorizer's Uniform Resource Identifier (URI). For REQUEST authorizers, this must be a well-formed Lambda function URI, for example, arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:<replaceable>{account_id}</replaceable>:function:<replaceable>{lambda_function_name}</replaceable>/invocations. In general, the URI has this form: arn:aws:apigateway:<replaceable>{region}</replaceable>:lambda:path/<replaceable>{service_api}</replaceable>\n , where <replaceable></replaceable>{region} is the same as the region hosting the Lambda function, path indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial /. For Lambda functions, this is usually of the form /2015-03-31/functions/[FunctionARN]/invocations. Supported only for REQUEST authorizers."}]},"EnableSimpleResponses":{"allOf":[{"$ref":"#/components/schemas/__boolean"},{"xml":{"name":"enableSimpleResponses"},"description":"Specifies whether a Lambda authorizer returns a response in a simple format. If enabled, the Lambda authorizer can return a boolean value instead of an IAM policy. Supported only for HTTP APIs. To learn more, see <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html\">Working with AWS Lambda authorizers for HTTP APIs</a>"}]},"IdentitySource":{"allOf":[{"$ref":"#/components/schemas/IdentitySourceList"},{"xml":{"name":"identitySource"},"description":"<p>The identity source for which authorization is requested.</p> <p>For a REQUEST authorizer, this is optional. The value is a set of one or more mapping expressions of the specified request parameters. The identity source can be headers, query string parameters, stage variables, and context parameters. For example, if an Auth header and a Name query string parameter are defined as identity sources, this value is route.request.header.Auth, route.request.querystring.Name for WebSocket APIs. For HTTP APIs, use selection expressions prefixed with $, for example, $request.header.Auth, $request.querystring.Name. These parameters are used to perform runtime validation for Lambda-based authorizers by verifying all of the identity-related request parameters are present in the request, not null, and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function. Otherwise, it returns a 401 Unauthorized response without calling the Lambda function. For HTTP APIs, identity sources are also used as the cache key when caching is enabled. To learn more, see <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html\">Working with AWS Lambda authorizers for HTTP APIs</a>.</p> <p>For JWT, a single entry that specifies where to extract the JSON Web Token (JWT) from inbound requests. Currently only header-based and query parameter-based selections are supported, for example $request.header.Authorization.</p>"}]},"IdentityValidationExpression":{"allOf":[{"$ref":"#/components/schemas/StringWithLengthBetween0And1024"},{"xml":{"name":"identityValidationExpression"},"description":"The validation expression does not apply to the REQUEST authorizer."}]},"JwtConfiguration":{"allOf":[{"$ref":"#/components/schemas/JWTConfiguration"},{"xml":{"name":"jwtConfiguration"},"description":"Represents the configuration of a JWT authorizer. Required for the JWT authorizer type. Supported only for HTTP APIs."}]},"Name":{"allOf":[{"$ref":"#/components/schemas/StringWithLengthBetween1And128"},{"xml":{"name":"name"},"description":"The name of the authorizer."}]}}},"__string":{"type":"string"},"__listOf__string":{"type":"array","items":{"$ref":"#/components/schemas/__string"}},"UriWithLengthBetween1And2048":{"type":"string","description":"A string representation of a URI with a length between [1-2048]."},"CreateDeploymentResponse":{"type":"object","properties":{"AutoDeployed":{"allOf":[{"$ref":"#/components/schemas/__boolean"},{"xml":{"name":"autoDeployed"},"description":"Specifies whether a deployment was automatically released."}]},"CreatedDate":{"allOf":[{"$ref":"#/components/schemas/__timestampIso8601"},{"xml":{"name":"createdDate"},"description":"The date and time when the Deployment resource was created."}]},"DeploymentId":{"allOf":[{"$ref":"#/components/schemas/Id"},{"xml":{"name":"deploymentId"},"description":"The identifier for the deployment."}]},"DeploymentStatus":{"allOf":[{"$ref":"#/components/schemas/DeploymentStatus"},{"xml":{"name":"deploymentStatus"},"description":"The status of the deployment: PENDING, FAILED, or SUCCEEDED."}]},"DeploymentStatusMessage":{"allOf":[{"$ref":"#/components/schemas/__string"},{"xml":{"name":"deploymentStatusMessage"},"description":"May contain additional feedback on the status of an API deployment."}]},"Description":{"allOf":[{"$ref":"#/components/schemas/StringWithLengthBetween0And1024"},{"xml":{"name":"description"},"description":"The description for the deployment."}]}}},"CreateDomainNameResponse":{"type":"object","properties":{"ApiMappingSelectionExpression":{"allOf":[{"$ref":"#/components/schemas/SelectionExpression"},{"xml":{"name":"apiMappingSelectionExpression"},"description":"The API mapping selection expression."}]},"DomainName":{"allOf":[{"$ref":"#/components/schemas/StringWithLengthBetween1And512"},{"xml":{"name":"domainName"},"description":"The name of the DomainName resource."}]},"DomainNameConfigurations":{"allOf":[{"$ref":"#/components/schemas/DomainNameConfigurations"},{"xml":{"name":"domainNameConfigurations"},"description":"The domain name configurations."}]},"MutualTlsAuthentication":{"allOf":[{"$ref":"#/components/schemas/MutualTlsAuthentication"},{"xml":{"name":"mutualTlsAuthentication"},"description":"The mutual TLS authentication configuration for a custom domain name."}]},"Tags":{"allOf":[{"$ref":"#/components/schemas/Tags"},{"xml":{"name":"tags"},"description":"The collection of tags associated with a domain name."}]}}},"DomainNameConfiguration":{"type":"object","properties":{"ApiGatewayDomainName":{"allOf":[{"$ref":"#/components/schemas/__string"},{"xml":{"name":"apiGatewayDomainName"},"description":"A domain name for the API."}]},"CertificateArn":{"allOf":[{"$ref":"#/components/schemas/Arn"},{"xml":{"name":"certificateArn"},"description":"An AWS-managed certificate that will be used by the edge-optimized endpoint for this domain name. AWS Certificate Manager is the only supported source."}]},"CertificateName":{"allOf":[{"$ref":"#/components/schemas/StringWithLengthBetween1And128"},{"xml":{"name":"certificateName"},"description":"The user-friendly name of the certificate that will be used by the edge-optimized endpoint for this domain name."}]},"CertificateUploadDate":{"allOf":[{"$ref":"#/components/schemas/__timestampIso8601"},{"xml":{"name":"certificateUploadDate"},"description":"The timestamp when the certificate that was used by edge-optimized endpoint for this domain name was uploaded."}]},"DomainNameStatus":{"allOf":[{"$ref":"#/components/schemas/DomainNameStatus"},{"xml":{"name":"domainNameStatus"},"description":"The status of the domain name migration. The valid values are AVAILABLE, UPDATING, PENDING_CERTIFICATE_REIMPORT, and PENDING_OWNERSHIP_VERIFICATION. If the status is UPDATING, the domain cannot be modified further until the existing operation is complete. If it is AVAILABLE, the domain can be updated."}]},"DomainNameStatusMessage":{"allOf":[{"$ref":"#/components/schemas/__string"},{"xml":{"name":"domainNameStatusMessage"},"description":"An optional text message containing detailed information about status of the domain name migration."}]},"EndpointType":{"allOf":[{"$ref":"#/components/schemas/EndpointType"},{"xml":{"name":"endpointType"},"description":"The endpoint type."}]},"HostedZoneId":{"allOf":[{"$ref":"#/components/schemas/__string"},{"xml":{"name":"hostedZoneId"},"description":"The Amazon Route 53 Hosted Zone ID of the endpoint."}]},"SecurityPolicy":{"allOf":[{"$ref":"#/components/schemas/SecurityPolicy"},{"xml":{"name":"securityPolicy"},"description":"The Transport Layer Security (TLS) version of the security policy for this domain name. The valid values are TLS_1_0 and TLS_1_2."}]},"OwnershipVerificationCertificateArn":{"allOf":[{"$ref":"#/components/schemas/Arn"},{"xml":{"name":"ownershipVerificationCertificateArn"},"description":"The ARN of the public certificate issued by ACM to validate ownership of your custom domain. Only required when configuring mutual TLS and using an ACM imported or private CA certificate ARN as the regionalCertificateArn"}]}},"description":"The domain name configuration."},"StringWithLengthBetween1And64":{"type":"string","description":"A string with a length between [1-64]."},"AccessDeniedException":{},"CreateIntegrationResult":{"type":"object","properties":{"ApiGatewayManaged":{"allOf":[{"$ref":"#/components/schemas/__boolean"},{"xml":{"name":"apiGatewayManaged"},"description":"Specifies whether an integration is managed by API Gateway. If you created an API using using quick create, the resulting integration is managed by API Gateway. You can update a managed integration, but you can't delete it."}]},"ConnectionId":{"allOf":[{"$ref":"#/components/schemas/StringWithLengthBetween1And1024"},{"xml":{"name":"connectionId"},"description":"The ID of the VPC link for a private integration. Supported only for HTTP APIs."}]},"ConnectionType":{"allOf":[{"$ref":"#/components/schemas/ConnectionType"},{"xml":{"name":"connectionType"},"description":"The type of the network connection to the integration endpoint. Specify INTERNET for connections through the public routable internet or VPC_LINK for private connections between API Gateway and resources in a VPC. The default value is INTERNET."}]},"ContentHandlingStrategy":{"allOf":[{"$ref":"#/components/schemas/ContentHandlingStrategy"},{"xml":{"name":"contentHandlingStrategy"},"description":"<p>Supported only for WebSocket APIs. Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:</p> <p>CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.</p> <p>CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.</p> <p>If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.</p>"}]},"CredentialsArn":{"allOf":[{"$ref":"#/components/schemas/Arn"},{"xml":{"name":"credentialsArn"},"description":"Specifies the credentials required for the integration, if any. For AWS integrations, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify the string arn:aws:iam::*:user/*. To use resource-based permissions on supported AWS services, specify null."}]},"Description":{"allOf":[{"$ref":"#/components/schemas/StringWithLengthBetween0And1024"},{"xml":{"name":"description"},"description":"Represents the description of an integration."}]},"IntegrationId":{"allOf":[{"$ref":"#/components/schemas/Id"},{"xml":{"name":"integrationId"},"description":"Represents the identifier of an integration."}]},"IntegrationMethod":{"allOf":[{"$ref":"#/components/schemas/StringWithLengthBetween1And64"},{"xml":{"name":"integrationMethod"},"description":"Specifies the integration's HTTP method type."}]},"IntegrationResponseSelectionExpression":{"allOf":[{"$ref":"#/components/schemas/SelectionExpression"},{"xml":{"name":"integrationResponseSelectionExpression"},"description":"The integration response selection expression for the integration. Supported only for WebSocket APIs. See <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-integration-response-selection-expressions\">Integration Response Selection Expressions</a>."}]},"IntegrationSubtype":{"allOf":[{"$ref":"#/components/schemas/StringWithLengthBetween1And128"},{"xml":{"name":"integrationSubtype"},"description":"Supported only for HTTP API AWS_PROXY integrations. Specifies the AWS service action to invoke. To learn more, see <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-aws-services-reference.html\">Integration subtype reference</a>."}]},"IntegrationType":{"allOf":[{"$ref":"#/components/schemas/IntegrationType"},{"xml":{"name":"integrationType"},"description":"<p>The integration type of an integration. One of the following:</p> <p>AWS: for integrating the route or method request with an AWS service action, including the Lambda function-invoking action. With the Lambda function-invoking action, this is referred to as the Lambda custom integration. With any other AWS service action, this is known as AWS integration. Supported only for WebSocket APIs.</p> <p>AWS_PROXY: for integrating the route or method request with a Lambda function or other AWS service action. This integration is also referred to as a Lambda proxy integration.</p> <p>HTTP: for integrating the route or method request with an HTTP endpoint. This integration is also referred to as the HTTP custom integration. Supported only for WebSocket APIs.</p> <p>HTTP_PROXY: for integrating the route or method request with an HTTP endpoint, with the client request passed through as-is. This is also referred to as HTTP proxy integration.</p> <p>MOCK: for integrating the route or method request with API Gateway as a \"loopback\" endpoint without invoking any backend. Supported only for WebSocket APIs.</p>"}]},"IntegrationUri":{"allOf":[{"$ref":"#/components/schemas/UriWithLengthBetween1And2048"},{"xml":{"name":"integrationUri"},"description":"<p>For a Lambda integration, specify the URI of a Lambda function.</p> <p>For an HTTP integration, specify a fully-qualified URL.</p> <p>For an HTTP API private integration, specify the ARN of an Application Load Balancer listener, Network Load Balancer listener, or AWS Cloud Map service. If you specify the ARN of an AWS Cloud Map service, API Gateway uses DiscoverInstances to identify resources. You can use query parameters to target specific resources. To learn more, see <a href=\"https://docs.aws.amazon.com/cloud-map/latest/api/API_DiscoverInstances.html\">DiscoverInstances</a>. For private integrations, all resources must be owned by the same AWS account.</p>"}]},"PassthroughBehavior":{"allOf":[{"$ref":"#/components/schemas/PassthroughBehavior"},{"xml":{"name":"passthroughBehavior"},"description":"<p>Specifies the pass-through behavior for incoming requests based on the Content-Type header in the request, and the available mapping templates specified as the requestTemplates property on the Integration resource. There are three valid values: WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and NEVER. Supported only for WebSocket APIs.</p> <p>WHEN_NO_MATCH passes the request body for unmapped content types through to the integration backend without transformation.</p> <p>NEVER rejects unmapped content types with an HTTP 415 Unsupported Media Type response.</p> <p>WHEN_NO_TEMPLATES allows pass-through when the integration has no content types mapped to templates. However, if there is at least one content type defined, unmapped content types will be rejected with the same HTTP 415 Unsupported Media Type response.</p>"}]},"PayloadFormatVersion":{"allOf":[{"$ref":"#/components/schemas/StringWithLengthBetween1And64"},{"xml":{"name":"payloadFormatVersion"},"description":"Specifies the format of the payload sent to an integration. Required for HTTP APIs."}]},"RequestParameters":{"allOf":[{"$ref":"#/components/schemas/IntegrationParameters"},{"xml":{"name":"requestParameters"},"description":"<p>For WebSocket APIs, a key-value map specifying request parameters that are passed from the method request to the backend. The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the backend. The method request parameter value must match the pattern of method.request.<replaceable>{location}</replaceable>.<replaceable>{name}</replaceable>\n , where \n <replaceable>{location}</replaceable>\n is querystring, path, or header; and \n <replaceable>{name}</replaceable>\n must be a valid and unique method request parameter name.</p> <p>For HTTP API integrations with a specified integrationSubtype, request parameters are a key-value map specifying parameters that are passed to AWS_PROXY integrations. You can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-aws-services.html\">Working with AWS service integrations for HTTP APIs</a>.</p> <p>For HTTP API itegrations, without a specified integrationSubtype request parameters are a key-value map specifying how to transform HTTP requests before sending them to backend integrations. The key should follow the pattern <action>:<header|querystring|path>.<location>. The action can be append, overwrite or remove. For values, you can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-parameter-mapping.html\">Transforming API requests and responses</a>.</p>"}]},"RequestTemplates":{"allOf":[{"$ref":"#/components/schemas/TemplateMap"},{"xml":{"name":"requestTemplates"},"description":"Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value. Supported only for WebSocket APIs."}]},"ResponseParameters":{"allOf":[{"$ref":"#/components/schemas/ResponseParameters"},{"xml":{"name":"responseParameters"},"description":"Supported only for HTTP APIs. You use response parameters to transform the HTTP response from a backend integration before returning the response to clients. Specify a key-value map from a selection key to response parameters. The selection key must be a valid HTTP status code within the range of 200-599. Response parameters are a key-value map. The key must match pattern <action>:<header>.<location> or overwrite.statuscode. The action can be append, overwrite or remove. The value can be a static value, or map to response data, stage variables, or context variables that are evaluated at runtime. To learn more, see <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-parameter-mapping.html\">Transforming API requests and responses</a>."}]},"TemplateSelectionExpression":{"allOf":[{"$ref":"#/components/schemas/SelectionExpression"},{"xml":{"name":"templateSelectionExpression"},"description":"The template selection expression for the integration. Supported only for WebSocket APIs."}]},"TimeoutInMillis":{"allOf":[{"$ref":"#/components/schemas/IntegerWithLengthBetween50And30000"},{"xml":{"name":"timeoutInMillis"},"description":"Custom timeout between 50 and 29,000 milliseconds for WebSocket APIs and between 50 and 30,000 milliseconds for HTTP APIs. The default timeout is 29 seconds for WebSocket APIs and 30 seconds for HTTP APIs."}]},"TlsConfig":{"allOf":[{"$ref":"#/components/schemas/TlsConfig"},{"xml":{"name":"tlsConfig"},"description":"The TLS configuration for a private integration. If you specify a TLS configuration, private integration traffic uses the HTTPS protocol. Supported only for HTTP APIs."}]}}},"StringWithLengthBetween1And512":{"type":"string","description":"A string with a length between [1-512]."},"StringWithLengthBetween0And32K":{"type":"string","description":"A string with a length between [0-32768]."},"IntegrationParameters":{"type":"object","description":"<p>For WebSocket APIs, a key-value map specifying request parameters that are passed from the method request to the backend. The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the backend. The method request parameter value must match the pattern of method.request.<replaceable>{location}</replaceable>.<replaceable>{name}</replaceable>\n , where \n <replaceable>{location}</replaceable>\n is querystring, path, or header; and \n <replaceable>{name}</replaceable>\n must be a valid and unique method request parameter name.</p> <p>For HTTP API integrations with a specified integrationSubtype, request parameters are a key-value map specifying parameters that are passed to AWS_PROXY integrations. You can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-aws-services.html\">Working with AWS service integrations for HTTP APIs</a>.</p> <p>For HTTP API integrations without a specified integrationSubtype request parameters are a key-value map specifying how to transform HTTP requests before sending them to the backend. The key should follow the pattern <action>:<header|querystring|path>.<location> where action can be append, overwrite or remove. For values, you can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-parameter-mapping.html\">Transforming API requests and responses</a>.</p>","additionalProperties":{"$ref":"#/components/schemas/StringWithLengthBetween1And512"}},"CreateIntegrationResponseResponse":{"type":"object","properties":{"ContentHandlingStrategy":{"allOf":[{"$ref":"#/components/schemas/ContentHandlingStrategy"},{"xml":{"name":"contentHandlingStrategy"},"description":"<p>Supported only for WebSocket APIs. Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:</p> <p>CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.</p> <p>CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.</p> <p>If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.</p>"}]},"IntegrationResponseId":{"allOf":[{"$ref":"#/components/schemas/Id"},{"xml":{"name":"integrationResponseId"},"description":"The integration response ID."}]},"IntegrationResponseKey":{"allOf":[{"$ref":"#/components/schemas/SelectionKey"},{"xml":{"name":"integrationResponseKey"},"description":"The integration response key."}]},"ResponseParameters":{"allOf":[{"$ref":"#/components/schemas/IntegrationParameters"},{"xml":{"name":"responseParameters"},"description":"A key-value map specifying response parameters that are passed to the method response from the backend. The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of method.response.header.{name}, where name is a valid and unique header name. The mapped non-static value must match the pattern of integration.response.header.{name} or integration.response.body.{JSON-expression}, where name is a valid and unique response header name and JSON-expression is a valid JSON expression without the $ prefix."}]},"ResponseTemplates":{"allOf":[{"$ref":"#/components/schemas/TemplateMap"},{"xml":{"name":"responseTemplates"},"description":"The collection of response templates for the integration response as a string-to-string map of key-value pairs. Response templates are represented as a key/value map, with a content-type as the key and a template as the value."}]},"TemplateSelectionExpression":{"allOf":[{"$ref":"#/components/schemas/SelectionExpression"},{"xml":{"name":"templateSelectionExpression"},"description":"The template selection expressions for the integration response."}]}}},"CreateModelResponse":{"type":"object","properties":{"ContentType":{"allOf":[{"$ref":"#/components/schemas/StringWithLengthBetween1And256"},{"xml":{"name":"contentType"},"description":"The content-type for the model, for example, \"application/json\"."}]},"Description":{"allOf":[{"$ref":"#/components/schemas/StringWithLengthBetween0And1024"},{"xml":{"name":"description"},"description":"The description of the model."}]},"ModelId":{"allOf":[{"$ref":"#/components/schemas/Id"},{"xml":{"name":"modelId"},"description":"The model identifier."}]},"Name":{"allOf":[{"$ref":"#/components/schemas/StringWithLengthBetween1And128"},{"xml":{"name":"name"},"description":"The name of the model. Must be alphanumeric."}]},"Schema":{"allOf":[{"$ref":"#/components/schemas/StringWithLengthBetween0And32K"},{"xml":{"name":"schema"},"description":"The schema for the model. For application/json models, this should be JSON schema draft 4 model."}]}}},"CreateRouteResult":{"type":"object","properties":{"ApiGatewayManaged":{"allOf":[{"$ref":"#/components/schemas/__boolean"},{"xml":{"name":"apiGatewayManaged"},"description":"Specifies whether a route is managed by API Gateway. If you created an API using quick create, the $default route is managed by API Gateway. You can't modify the $default route key."}]},"ApiKeyRequired":{"allOf":[{"$ref":"#/components/schemas/__boolean"},{"xml":{"name":"apiKeyRequired"},"description":"Specifies whether an API key is required for this route. Supported only for WebSocket APIs."}]},"AuthorizationScopes":{"allOf":[{"$ref":"#/components/schemas/AuthorizationScopes"},{"xml":{"name":"authorizationScopes"},"description":"A list of authorization scopes configured on a route. The scopes are used with a JWT authorizer to authorize the method invocation. The authorization works by matching the route scopes against the scopes parsed from the access token in the incoming request. The method invocation is authorized if any route scope matches a claimed scope in the access token. Otherwise, the invocation is not authorized. When the route scope is configured, the client must provide an access token instead of an identity token for authorization purposes."}]},"AuthorizationType":{"allOf":[{"$ref":"#/components/schemas/AuthorizationType"},{"xml":{"name":"authorizationType"},"description":"The authorization type for the route. For WebSocket APIs, valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer For HTTP APIs, valid values are NONE for open access, JWT for using JSON Web Tokens, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer."}]},"AuthorizerId":{"allOf":[{"$ref":"#/components/schemas/Id"},{"xml":{"name":"authorizerId"},"description":"The identifier of the Authorizer resource to be associated with this route. The authorizer identifier is generated by API Gateway when you created the authorizer."}]},"ModelSelectionExpression":{"allOf":[{"$ref":"#/components/schemas/SelectionExpression"},{"xml":{"name":"modelSelectionExpression"},"description":"The model selection expression for the route. Supported only for WebSocket APIs."}]},"OperationName":{"allOf":[{"$ref":"#/components/schemas/StringWithLengthBetween1And64"},{"xml":{"name":"operationName"},"description":"The operation name for the route."}]},"RequestModels":{"allOf":[{"$ref":"#/components/schemas/RouteModels"},{"xml":{"name":"requestModels"},"description":"The request models for the route. Supported only for WebSocket APIs."}]},"RequestParameters":{"allOf":[{"$ref":"#/components/schemas/RouteParameters"},{"xml":{"name":"requestParameters"},"description":"The request parameters for the route. Supported only for WebSocket APIs."}]},"RouteId":{"allOf":[{"$ref":"#/components/schemas/Id"},{"xml":{"name":"routeId"},"description":"The route ID."}]},"RouteKey":{"allOf":[{"$ref":"#/components/schemas/SelectionKey"},{"xml":{"name":"routeKey"},"description":"The route key for the route."}]},"RouteResponseSelectionExpression":{"allOf":[{"$ref":"#/components/schemas/SelectionExpression"},{"xml":{"name":"routeResponseSelectionExpression"},"description":"The route response selection expression for the route. Supported only for WebSocket APIs."}]},"Target":{"allOf":[{"$ref":"#/components/schemas/StringWithLengthBetween1And128"},{"xml":{"name":"target"},"description":"The target for the route."}]}}},"StringWithLengthBetween1And128":{"type":"string","description":"A string with a length between [1-128]."},"ParameterConstraints":{"type":"object","properties":{"Required":{"allOf":[{"$ref":"#/components/schemas/__boolean"},{"xml":{"name":"required"},"description":"Whether or not the parameter is required."}]}},"description":"Validation constraints imposed on parameters of a request (path, query string, headers)."},"CreateRouteResponseResponse":{"type":"object","properties":{"ModelSelectionExpression":{"allOf":[{"$ref":"#/components/schemas/SelectionExpression"},{"xml":{"name":"modelSelectionExpression"},"description":"Represents the model selection expression of a route response. Supported only for WebSocket APIs."}]},"ResponseModels":{"allOf":[{"$ref":"#/components/schemas/RouteModels"},{"xml":{"name":"responseModels"},"description":"Represents the response models of a route response."}]},"ResponseParameters":{"allOf":[{"$ref":"#/components/schemas/RouteParameters"},{"xml":{"name":"responseParameters"},"description":"Represents the response parameters of a route response."}]},"RouteResponseId":{"allOf":[{"$ref":"#/components/schemas/Id"},{"xml":{"name":"routeResponseId"},"description":"Represents the identifier of a route response."}]},"RouteResponseKey":{"allOf":[{"$ref":"#/components/schemas/SelectionKey"},{"xml":{"name":"routeResponseKey"},"description":"Represents the route response key of a route response."}]}}},"CreateStageResponse":{"type":"object","properties":{"AccessLogSettings":{"allOf":[{"$ref":"#/components/schemas/AccessLogSettings"},{"xml":{"name":"accessLogSettings"},"description":"Settings for logging access in this stage."}]},"ApiGatewayManaged":{"allOf":[{"$ref":"#/components/schemas/__boolean"},{"xml":{"name":"apiGatewayManaged"},"description":"Specifies whether a stage is managed by API Gateway. If you created an API using quick create, the $default stage is managed by API Gateway. You can't modify the $default stage."}]},"AutoDeploy":{"allOf":[{"$ref":"#/components/schemas/__boolean"},{"xml":{"name":"autoDeploy"},"description":"Specifies whether updates to an API automatically trigger a new deployment. The default value is false."}]},"ClientCertificateId":{"allOf":[{"$ref":"#/components/schemas/Id"},{"xml":{"name":"clientCertificateId"},"description":"The identifier of a client certificate for a Stage. Supported only for WebSocket APIs."}]},"CreatedDate":{"allOf":[{"$ref":"#/components/schemas/__timestampIso8601"},{"xml":{"name":"createdDate"},"description":"The timestamp when the stage was created."}]},"DefaultRouteSettings":{"allOf":[{"$ref":"#/components/schemas/RouteSettings"},{"xml":{"name":"defaultRouteSettings"},"description":"Default route settings for the stage."}]},"DeploymentId":{"allOf":[{"$ref":"#/components/schemas/Id"},{"xml":{"name":"deploymentId"},"description":"The identifier of the Deployment that the Stage is associated with. Can't be updated if autoDeploy is enabled."}]},"Description":{"allOf":[{"$ref":"#/components/schemas/StringWithLengthBetween0And1024"},{"xml":{"name":"description"},"description":"The description of the stage."}]},"LastDeploymentStatusMessage":{"allOf":[{"$ref":"#/components/schemas/__string"},{"xml":{"name":"lastDeploymentStatusMessage"},"description":"Describes the status of the last deployment of a stage. Supported only for stages with autoDeploy enabled."}]},"LastUpdatedDate":{"allOf":[{"$ref":"#/components/schemas/__timestampIso8601"},{"xml":{"name":"lastUpdatedDate"},"description":"The timestamp when the stage was last updated."}]},"RouteSettings":{"allOf":[{"$ref":"#/components/schemas/RouteSettingsMap"},{"xml":{"name":"routeSettings"},"description":"Route settings for the stage, by routeKey."}]},"StageName":{"allOf":[{"$ref":"#/components/schemas/StringWithLengthBetween1And128"},{"xml":{"name":"stageName"},"description":"The name of the stage."}]},"StageVariables":{"allOf":[{"$ref":"#/components/schemas/StageVariablesMap"},{"xml":{"name":"stageVariables"},"description":"A map that defines the stage variables for a stage resource. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+."}]},"Tags":{"allOf":[{"$ref":"#/components/schemas/Tags"},{"xml":{"name":"tags"},"description":"The collection of tags. Each tag element is associated with a given resource."}]}}},"Arn":{"type":"string","description":"Represents an Amazon Resource Name (ARN)."},"StringWithLengthBetween1And1024":{"type":"string","description":"A string with a length between [1-1024]."},"LoggingLevel":{"type":"string","enum":["ERROR","INFO",false],"description":"The logging level."},"__integer":{"type":"integer"},"__double":{"type":"number","format":"double"},"RouteSettings":{"type":"object","properties":{"DataTraceEnabled":{"allOf":[{"$ref":"#/components/schemas/__boolean"},{"xml":{"name":"dataTraceEnabled"},"description":"Specifies whether (true) or not (false) data trace logging is enabled for this route. This property affects the log entries pushed to Amazon CloudWatch Logs. Supported only for WebSocket APIs."}]},"DetailedMetricsEnabled":{"allOf":[{"$ref":"#/components/schemas/__boolean"},{"xml":{"name":"detailedMetricsEnabled"},"description":"Specifies whether detailed metrics are enabled."}]},"LoggingLevel":{"allOf":[{"$ref":"#/components/schemas/LoggingLevel"},{"xml":{"name":"loggingLevel"},"description":"Specifies the logging level for this route: INFO, ERROR, or OFF. This property affects the log entries pushed to Amazon CloudWatch Logs. Supported only for WebSocket APIs."}]},"ThrottlingBurstLimit":{"allOf":[{"$ref":"#/components/schemas/__integer"},{"xml":{"name":"throttlingBurstLimit"},"description":"Specifies the throttling burst limit."}]},"ThrottlingRateLimit":{"allOf":[{"$ref":"#/components/schemas/__double"},{"xml":{"name":"throttlingRateLimit"},"description":"Specifies the throttling rate limit."}]}},"description":"Represents a collection of route settings."},"StringWithLengthBetween0And2048":{"type":"string","description":"A string with a length between [0-2048]."},"CreateVpcLinkResponse":{"type":"object","properties":{"CreatedDate":{"allOf":[{"$ref":"#/components/schemas/__timestampIso8601"},{"xml":{"name":"createdDate"},"description":"The timestamp when the VPC link was created."}]},"Name":{"allOf":[{"$ref":"#/components/schemas/StringWithLengthBetween1And128"},{"xml":{"name":"name"},"description":"The name of the VPC link."}]},"SecurityGroupIds":{"allOf":[{"$ref":"#/components/schemas/SecurityGroupIdList"},{"xml":{"name":"securityGroupIds"},"description":"A list of security group IDs for the VPC link."}]},"SubnetIds":{"allOf":[{"$ref":"#/components/schemas/SubnetIdList"},{"xml":{"name":"subnetIds"},"description":"A list of subnet IDs to include in the VPC link."}]},"Tags":{"allOf":[{"$ref":"#/components/schemas/Tags"},{"xml":{"name":"tags"},"description":"Tags for the VPC link."}]},"VpcLinkId":{"allOf":[{"$ref":"#/components/schemas/Id"},{"xml":{"name":"vpcLinkId"},"description":"The ID of the VPC link."}]},"VpcLinkStatus":{"allOf":[{"$ref":"#/components/schemas/VpcLinkStatus"},{"xml":{"name":"vpcLinkStatus"},"description":"The status of the VPC link."}]},"VpcLinkStatusMessage":{"allOf":[{"$ref":"#/components/schemas/StringWithLengthBetween0And1024"},{"xml":{"name":"vpcLinkStatusMessage"},"description":"A message summarizing the cause of the status of the VPC link."}]},"VpcLinkVersion":{"allOf":[{"$ref":"#/components/schemas/VpcLinkVersion"},{"xml":{"name":"vpcLinkVersion"},"description":"The version of the VPC link."}]}}},"DeleteVpcLinkResponse":{"type":"object","properties":{}},"ExportApiResponse":{"type":"object","properties":{"body":{"$ref":"#/components/schemas/ExportedApi"}}},"GetApiResponse":{"type":"object","properties":{"ApiEndpoint":{"allOf":[{"$ref":"#/components/schemas/__string"},{"xml":{"name":"apiEndpoint"},"description":"The URI of the API, of the form {api-id}.execute-api.{region}.amazonaws.com. The stage name is typically appended to this URI to form a complete path to a deployed API stage."}]},"ApiGatewayManaged":{"allOf":[{"$ref":"#/components/schemas/__boolean"},{"xml":{"name":"apiGatewayManaged"},"description":"Specifies whether an API is managed by API Gateway. You can't update or delete a managed API by using API Gateway. A managed API can be deleted only through the tooling or service that created it."}]},"ApiId":{"allOf":[{"$ref":"#/components/schemas/Id"},{"xml":{"name":"apiId"},"description":"The API ID."}]},"ApiKeySelectionExpression":{"allOf":[{"$ref":"#/components/schemas/SelectionExpression"},{"xml":{"name":"apiKeySelectionExpression"},"description":"An API key selection expression. Supported only for WebSocket APIs. See <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions\">API Key Selection Expressions</a>."}]},"CorsConfiguration":{"allOf":[{"$ref":"#/components/schemas/Cors"},{"xml":{"name":"corsConfiguration"},"description":"A CORS configuration. Supported only for HTTP APIs."}]},"CreatedDate":{"allOf":[{"$ref":"#/components/schemas/__timestampIso8601"},{"xml":{"name":"createdDate"},"description":"The timestamp when the API was created."}]},"Description":{"allOf":[{"$ref":"#/components/schemas/StringWithLengthBetween0And1024"},{"xml":{"name":"description"},"description":"The description of the API."}]},"DisableSchemaValidation":{"allOf":[{"$ref":"#/components/schemas/__boolean"},{"xml":{"name":"disableSchemaValidation"},"description":"Avoid validating models when creating a deployment. Supported only for WebSocket APIs."}]},"DisableExecuteApiEndpoint":{"allOf":[{"$ref":"#/components/schemas/__boolean"},{"xml":{"name":"disableExecuteApiEndpoint"},"description":"Specifies whether clients can invoke your API by using the default execute-api endpoint. By default, clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint."}]},"ImportInfo":{"allOf":[{"$ref":"#/components/schemas/__listOf__string"},{"xml":{"name":"importInfo"},"description":"The validation information during API import. This may include particular properties of your OpenAPI definition which are ignored during import. Supported only for HTTP APIs."}]},"Name":{"allOf":[{"$ref":"#/components/schemas/StringWithLengthBetween1And128"},{"xml":{"name":"name"},"description":"The name of the API."}]},"ProtocolType":{"allOf":[{"$ref":"#/components/schemas/ProtocolType"},{"xml":{"name":"protocolType"},"description":"The API protocol."}]},"RouteSelectionExpression":{"allOf":[{"$ref":"#/components/schemas/SelectionExpression"},{"xml":{"name":"routeSelectionExpression"},"description":"The route selection expression for the API. For HTTP APIs, the routeSelectionExpression must be ${request.method} ${request.path}. If not provided, this will be the default for HTTP APIs. This property is required for WebSocket APIs."}]},"Tags":{"allOf":[{"$ref":"#/components/schemas/Tags"},{"xml":{"name":"tags"},"description":"A collection of tags associated with the API."}]},"Version":{"allOf":[{"$ref":"#/components/schemas/StringWithLengthBetween1And64"},{"xml":{"name":"version"},"description":"A version identifier for the API."}]},"Warnings":{"allOf":[{"$ref":"#/components/schemas/__listOf__string"},{"xml":{"name":"warnings"},"description":"The warning messages reported when failonwarnings is turned on during API import."}]}}},"GetApiMappingResponse":{"type":"object","properties":{"ApiId":{"allOf":[{"$ref":"#/components/schemas/Id"},{"xml":{"name":"apiId"},"description":"The API identifier."}]},"ApiMappingId":{"allOf":[{"$ref":"#/components/schemas/Id"},{"xml":{"name":"apiMappingId"},"description":"The API mapping identifier."}]},"ApiMappingKey":{"allOf":[{"$ref":"#/components/schemas/SelectionKey"},{"xml":{"name":"apiMappingKey"},"description":"The API mapping key."}]},"Stage":{"allOf":[{"$ref":"#/components/schemas/StringWithLengthBetween1And128"},{"xml":{"name":"stage"},"description":"The API stage."}]}}},"GetApiMappingsResponse":{"type":"object","properties":{"Items":{"allOf":[{"$ref":"#/components/schemas/__listOfApiMapping"},{"xml":{"name":"items"},"description":"The elements from this collection."}]},"NextToken":{"allOf":[{"$ref":"#/components/schemas/NextToken"},{"xml":{"name":"nextToken"},"description":"The next page of elements from this collection. Not valid for the last element of the collection."}]}}},"GetApisResponse":{"type":"object","properties":{"Items":{"allOf":[{"$ref":"#/components/schemas/__listOfApi"},{"xml":{"name":"items"},"description":"The elements from this collection."}]},"NextToken":{"allOf":[{"$ref":"#/components/schemas/NextToken"},{"xml":{"name":"nextToken"},"description":"The next page of elements from this collection. Not valid for the last element of the collection."}]}}},"GetAuthorizerResponse":{"type":"object","properties":{"AuthorizerCredentialsArn":{"allOf":[{"$ref":"#/components/schemas/Arn"},{"xml":{"name":"authorizerCredentialsArn"},"description":"Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, don't specify this parameter. Supported only for REQUEST authorizers."}]},"AuthorizerId":{"allOf":[{"$ref":"#/components/schemas/Id"},{"xml":{"name":"authorizerId"},"description":"The authorizer identifier."}]},"AuthorizerPayloadFormatVersion":{"allOf":[{"$ref":"#/components/schemas/StringWithLengthBetween1And64"},{"xml":{"name":"authorizerPayloadFormatVersion"},"description":"Specifies the format of the payload sent to an HTTP API Lambda authorizer. Required for HTTP API Lambda authorizers. Supported values are 1.0 and 2.0. To learn more, see <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html\">Working with AWS Lambda authorizers for HTTP APIs</a>."}]},"AuthorizerResultTtlInSeconds":{"allOf":[{"$ref":"#/components/schemas/IntegerWithLengthBetween0And3600"},{"xml":{"name":"authorizerResultTtlInSeconds"},"description":"The time to live (TTL) for cached authorizer results, in seconds. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway caches authorizer responses. The maximum value is 3600, or 1 hour. Supported only for HTTP API Lambda authorizers."}]},"AuthorizerType":{"allOf":[{"$ref":"#/components/schemas/AuthorizerType"},{"xml":{"name":"authorizerType"},"description":"The authorizer type. Specify REQUEST for a Lambda function using incoming request parameters. Specify JWT to use JSON Web Tokens (supported only for HTTP APIs)."}]},"AuthorizerUri":{"allOf":[{"$ref":"#/components/schemas/UriWithLengthBetween1And2048"},{"xml":{"name":"authorizerUri"},"description":"The authorizer's Uniform Resource Identifier (URI). For REQUEST authorizers, this must be a well-formed Lambda function URI, for example, arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:<replaceable>{account_id}</replaceable>:function:<replaceable>{lambda_function_name}</replaceable>/invocations. In general, the URI has this form: arn:aws:apigateway:<replaceable>{region}</replaceable>:lambda:path/<replaceable>{service_api}</replaceable>\n , where <replaceable></replaceable>{region} is the same as the region hosting the Lambda function, path indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial /. For Lambda functions, this is usually of the form /2015-03-31/functions/[FunctionARN]/invocations. Supported only for REQUEST authorizers."}]},"EnableSimpleResponses":{"allOf":[{"$ref":"#/components/schemas/__boolean"},{"xml":{"name":"enableSimpleResponses"},"description":"Specifies whether a Lambda authorizer returns a response in a simple format. If enabled, the Lambda authorizer can return a boolean value instead of an IAM policy. Supported only for HTTP APIs. To learn more, see <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html\">Working with AWS Lambda authorizers for HTTP APIs</a>"}]},"IdentitySource":{"allOf":[{"$ref":"#/components/schemas/IdentitySourceList"},{"xml":{"name":"identitySource"},"description":"<p>The identity source for which authorization is requested.</p> <p>For a REQUEST authorizer, this is optional. The value is a set of one or more mapping expressions of the specified request parameters. The identity source can be headers, query string parameters, stage variables, and context parameters. For example, if an Auth header and a Name query string parameter are defined as identity sources, this value is route.request.header.Auth, route.request.querystring.Name for WebSocket APIs. For HTTP APIs, use selection expressions prefixed with $, for example, $request.header.Auth, $request.querystring.Name. These parameters are used to perform runtime validation for Lambda-based authorizers by verifying all of the identity-related request parameters are present in the request, not null, and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function. Otherwise, it returns a 401 Unauthorized response without calling the Lambda function. For HTTP APIs, identity sources are also used as the cache key when caching is enabled. To learn more, see <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html\">Working with AWS Lambda authorizers for HTTP APIs</a>.</p> <p>For JWT, a single entry that specifies where to extract the JSON Web Token (JWT) from inbound requests. Currently only header-based and query parameter-based selections are supported, for example $request.header.Authorization.</p>"}]},"IdentityValidationExpression":{"allOf":[{"$ref":"#/components/schemas/StringWithLengthBetween0And1024"},{"xml":{"name":"identityValidationExpression"},"description":"The validation expression does not apply to the REQUEST authorizer."}]},"JwtConfiguration":{"allOf":[{"$ref":"#/components/schemas/JWTConfiguration"},{"xml":{"name":"jwtConfiguration"},"description":"Represents the configuration of a JWT authorizer. Required for the JWT authorizer type. Supported only for HTTP APIs."}]},"Name":{"allOf":[{"$ref":"#/components/schemas/StringWithLengthBetween1And128"},{"xml":{"name":"name"},"description":"The name of the authorizer."}]}}},"GetAuthorizersResponse":{"type":"object","properties":{"Items":{"allOf":[{"$ref":"#/components/schemas/__listOfAuthorizer"},{"xml":{"name":"items"},"description":"The elements from this collection."}]},"NextToken":{"allOf":[{"$ref":"#/components/schemas/NextToken"},{"xml":{"name":"nextToken"},"description":"The next page of elements from this collection. Not valid for the last element of the collection."}]}}},"GetDeploymentResponse":{"type":"object","properties":{"AutoDeployed":{"allOf":[{"$ref":"#/components/schemas/__boolean"},{"xml":{"name":"autoDeployed"},"description":"Specifies whether a deployment was automatically released."}]},"CreatedDate":{"allOf":[{"$ref":"#/components/schemas/__timestampIso8601"},{"xml":{"name":"createdDate"},"description":"The date and time when the Deployment resource was created."}]},"DeploymentId":{"allOf":[{"$ref":"#/components/schemas/Id"},{"xml":{"name":"deploymentId"},"description":"The identifier for the deployment."}]},"DeploymentStatus":{"allOf":[{"$ref":"#/components/schemas/DeploymentStatus"},{"xml":{"name":"deploymentStatus"},"description":"The status of the deployment: PENDING, FAILED, or SUCCEEDED."}]},"DeploymentStatusMessage":{"allOf":[{"$ref":"#/components/schemas/__string"},{"xml":{"name":"deploymentStatusMessage"},"description":"May contain additional feedback on the status of an API deployment."}]},"Description":{"allOf":[{"$ref":"#/components/schemas/StringWithLengthBetween0And1024"},{"xml":{"name":"description"},"description":"The description for the deployment."}]}}},"GetDeploymentsResponse":{"type":"object","properties":{"Items":{"allOf":[{"$ref":"#/components/schemas/__listOfDeployment"},{"xml":{"name":"items"},"description":"The elements from this collection."}]},"NextToken":{"allOf":[{"$ref":"#/components/schemas/NextToken"},{"xml":{"name":"nextToken"},"description":"The next page of elements from this collection. Not valid for the last element of the collection."}]}}},"GetDomainNameResponse":{"type":"object","properties":{"ApiMappingSelectionExpression":{"allOf":[{"$ref":"#/components/schemas/SelectionExpression"},{"xml":{"name":"apiMappingSelectionExpression"},"description":"The API mapping selection expression."}]},"DomainName":{"allOf":[{"$ref":"#/components/schemas/StringWithLengthBetween1And512"},{"xml":{"name":"domainName"},"description":"The name of the DomainName resource."}]},"DomainNameConfigurations":{"allOf":[{"$ref":"#/components/schemas/DomainNameConfigurations"},{"xml":{"name":"domainNameConfigurations"},"description":"The domain name configurations."}]},"MutualTlsAuthentication":{"allOf":[{"$ref":"#/components/schemas/MutualTlsAuthentication"},{"xml":{"name":"mutualTlsAuthentication"},"description":"The mutual TLS authentication configuration for a custom domain name."}]},"Tags":{"allOf":[{"$ref":"#/components/schemas/Tags"},{"xml":{"name":"tags"},"description":"The collection of tags associated with a domain name."}]}}},"GetDomainNamesResponse":{"type":"object","properties":{"Items":{"allOf":[{"$ref":"#/components/schemas/__listOfDomainName"},{"xml":{"name":"items"},"description":"The elements from this collection."}]},"NextToken":{"allOf":[{"$ref":"#/components/schemas/NextToken"},{"xml":{"name":"nextToken"},"description":"The next page of elements from this collection. Not valid for the last element of the collection."}]}}},"GetIntegrationResult":{"type":"object","properties":{"ApiGatewayManaged":{"allOf":[{"$ref":"#/components/schemas/__boolean"},{"xml":{"name":"apiGatewayManaged"},"description":"Specifies whether an integration is managed by API Gateway. If you created an API using using quick create, the resulting integration is managed by API Gateway. You can update a managed integration, but you can't delete it."}]},"ConnectionId":{"allOf":[{"$ref":"#/components/schemas/StringWithLengthBetween1And1024"},{"xml":{"name":"connectionId"},"description":"The ID of the VPC link for a private integration. Supported only for HTTP APIs."}]},"ConnectionType":{"allOf":[{"$ref":"#/components/schemas/ConnectionType"},{"xml":{"name":"connectionType"},"description":"The type of the network connection to the integration endpoint. Specify INTERNET for connections through the public routable internet or VPC_LINK for private connections between API Gateway and resources in a VPC. The default value is INTERNET."}]},"ContentHandlingStrategy":{"allOf":[{"$ref":"#/components/schemas/ContentHandlingStrategy"},{"xml":{"name":"contentHandlingStrategy"},"description":"<p>Supported only for WebSocket APIs. Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:</p> <p>CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.</p> <p>CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.</p> <p>If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.</p>"}]},"CredentialsArn":{"allOf":[{"$ref":"#/components/schemas/Arn"},{"xml":{"name":"credentialsArn"},"description":"Specifies the credentials required for the integration, if any. For AWS integrations, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify the string arn:aws:iam::*:user/*. To use resource-based permissions on supported AWS services, specify null."}]},"Description":{"allOf":[{"$ref":"#/components/schemas/StringWithLengthBetween0And1024"},{"xml":{"name":"description"},"description":"Represents the description of an integration."}]},"IntegrationId":{"allOf":[{"$ref":"#/components/schemas/Id"},{"xml":{"name":"integrationId"},"description":"Represents the identifier of an integration."}]},"IntegrationMethod":{"allOf":[{"$ref":"#/components/schemas/StringWithLengthBetween1And64"},{"xml":{"name":"integrationMethod"},"description":"Specifies the integration's HTTP method type."}]},"IntegrationResponseSelectionExpression":{"allOf":[{"$ref":"#/components/schemas/SelectionExpression"},{"xml":{"name":"integrationResponseSelectionExpression"},"description":"The integration response selection expression for the integration. Supported only for WebSocket APIs. See <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-integration-response-selection-expressions\">Integration Response Selection Expressions</a>."}]},"IntegrationSubtype":{"allOf":[{"$ref":"#/components/schemas/StringWithLengthBetween1And128"},{"xml":{"name":"integrationSubtype"},"description":"Supported only for HTTP API AWS_PROXY integrations. Specifies the AWS service action to invoke. To learn more, see <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-aws-services-reference.html\">Integration subtype reference</a>."}]},"IntegrationType":{"allOf":[{"$ref":"#/components/schemas/IntegrationType"},{"xml":{"name":"integrationType"},"description":"<p>The integration type of an integration. One of the following:</p> <p>AWS: for integrating the route or method request with an AWS service action, including the Lambda function-invoking action. With the Lambda function-invoking action, this is referred to as the Lambda custom integration. With any other AWS service action, this is known as AWS integration. Supported only for WebSocket APIs.</p> <p>AWS_PROXY: for integrating the route or method request with a Lambda function or other AWS service action. This integration is also referred to as a Lambda proxy integration.</p> <p>HTTP: for integrating the route or method request with an HTTP endpoint. This integration is also referred to as the HTTP custom integration. Supported only for WebSocket APIs.</p> <p>HTTP_PROXY: for integrating the route or method request with an HTTP endpoint, with the client request passed through as-is. This is also referred to as HTTP proxy integration.</p> <p>MOCK: for integrating the route or method request with API Gateway as a \"loopback\" endpoint without invoking any backend. Supported only for WebSocket APIs.</p>"}]},"IntegrationUri":{"allOf":[{"$ref":"#/components/schemas/UriWithLengthBetween1And2048"},{"xml":{"name":"integrationUri"},"description":"<p>For a Lambda integration, specify the URI of a Lambda function.</p> <p>For an HTTP integration, specify a fully-qualified URL.</p> <p>For an HTTP API private integration, specify the ARN of an Application Load Balancer listener, Network Load Balancer listener, or AWS Cloud Map service. If you specify the ARN of an AWS Cloud Map service, API Gateway uses DiscoverInstances to identify resources. You can use query parameters to target specific resources. To learn more, see <a href=\"https://docs.aws.amazon.com/cloud-map/latest/api/API_DiscoverInstances.html\">DiscoverInstances</a>. For private integrations, all resources must be owned by the same AWS account.</p>"}]},"PassthroughBehavior":{"allOf":[{"$ref":"#/components/schemas/PassthroughBehavior"},{"xml":{"name":"passthroughBehavior"},"description":"<p>Specifies the pass-through behavior for incoming requests based on the Content-Type header in the request, and the available mapping templates specified as the requestTemplates property on the Integration resource. There are three valid values: WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and NEVER. Supported only for WebSocket APIs.</p> <p>WHEN_NO_MATCH passes the request body for unmapped content types through to the integration backend without transformation.</p> <p>NEVER rejects unmapped content types with an HTTP 415 Unsupported Media Type response.</p> <p>WHEN_NO_TEMPLATES allows pass-through when the integration has no content types mapped to templates. However, if there is at least one content type defined, unmapped content types will be rejected with the same HTTP 415 Unsupported Media Type response.</p>"}]},"PayloadFormatVersion":{"allOf":[{"$ref":"#/components/schemas/StringWithLengthBetween1And64"},{"xml":{"name":"payloadFormatVersion"},"description":"Specifies the format of the payload sent to an integration. Required for HTTP APIs."}]},"RequestParameters":{"allOf":[{"$ref":"#/components/schemas/IntegrationParameters"},{"xml":{"name":"requestParameters"},"description":"<p>For WebSocket APIs, a key-value map specifying request parameters that are passed from the method request to the backend. The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the backend. The method request parameter value must match the pattern of method.request.<replaceable>{location}</replaceable>.<replaceable>{name}</replaceable>\n , where \n <replaceable>{location}</replaceable>\n is querystring, path, or header; and \n <replaceable>{name}</replaceable>\n must be a valid and unique method request parameter name.</p> <p>For HTTP API integrations with a specified integrationSubtype, request parameters are a key-value map specifying parameters that are passed to AWS_PROXY integrations. You can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-aws-services.html\">Working with AWS service integrations for HTTP APIs</a>.</p> <p>For HTTP API itegrations, without a specified integrationSubtype request parameters are a key-value map specifying how to transform HTTP requests before sending them to backend integrations. The key should follow the pattern <action>:<header|querystring|path>.<location>. The action can be append, overwrite or remove. For values, you can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-parameter-mapping.html\">Transforming API requests and responses</a>.</p>"}]},"RequestTemplates":{"allOf":[{"$ref":"#/components/schemas/TemplateMap"},{"xml":{"name":"requestTemplates"},"description":"Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value. Supported only for WebSocket APIs."}]},"ResponseParameters":{"allOf":[{"$ref":"#/components/schemas/ResponseParameters"},{"xml":{"name":"responseParameters"},"description":"Supported only for HTTP APIs. You use response parameters to transform the HTTP response from a backend integration before returning the response to clients. Specify a key-value map from a selection key to response parameters. The selection key must be a valid HTTP status code within the range of 200-599. Response parameters are a key-value map. The key must match pattern <action>:<header>.<location> or overwrite.statuscode. The action can be append, overwrite or remove. The value can be a static value, or map to response data, stage variables, or context variables that are evaluated at runtime. To learn more, see <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-parameter-mapping.html\">Transforming API requests and responses</a>."}]},"TemplateSelectionExpression":{"allOf":[{"$ref":"#/components/schemas/SelectionExpression"},{"xml":{"name":"templateSelectionExpression"},"description":"The template selection expression for the integration. Supported only for WebSocket APIs."}]},"TimeoutInMillis":{"allOf":[{"$ref":"#/components/schemas/IntegerWithLengthBetween50And30000"},{"xml":{"name":"timeoutInMillis"},"description":"Custom timeout between 50 and 29,000 milliseconds for WebSocket APIs and between 50 and 30,000 milliseconds for HTTP APIs. The default timeout is 29 seconds for WebSocket APIs and 30 seconds for HTTP APIs."}]},"TlsConfig":{"allOf":[{"$ref":"#/components/schemas/TlsConfig"},{"xml":{"name":"tlsConfig"},"description":"The TLS configuration for a private integration. If you specify a TLS configuration, private integration traffic uses the HTTPS protocol. Supported only for HTTP APIs."}]}}},"GetIntegrationResponseResponse":{"type":"object","properties":{"ContentHandlingStrategy":{"allOf":[{"$ref":"#/components/schemas/ContentHandlingStrategy"},{"xml":{"name":"contentHandlingStrategy"},"description":"<p>Supported only for WebSocket APIs. Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:</p> <p>CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.</p> <p>CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.</p> <p>If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.</p>"}]},"IntegrationResponseId":{"allOf":[{"$ref":"#/components/schemas/Id"},{"xml":{"name":"integrationResponseId"},"description":"The integration response ID."}]},"IntegrationResponseKey":{"allOf":[{"$ref":"#/components/schemas/SelectionKey"},{"xml":{"name":"integrationResponseKey"},"description":"The integration response key."}]},"ResponseParameters":{"allOf":[{"$ref":"#/components/schemas/IntegrationParameters"},{"xml":{"name":"responseParameters"},"description":"A key-value map specifying response parameters that are passed to the method response from the backend. The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of method.response.header.{name}, where name is a valid and unique header name. The mapped non-static value must match the pattern of integration.response.header.{name} or integration.response.body.{JSON-expression}, where name is a valid and unique response header name and JSON-expression is a valid JSON expression without the $ prefix."}]},"ResponseTemplates":{"allOf":[{"$ref":"#/components/schemas/TemplateMap"},{"xml":{"name":"responseTemplates"},"description":"The collection of response templates for the integration response as a string-to-string map of key-value pairs. Response templates are represented as a key/value map, with a content-type as the key and a template as the value."}]},"TemplateSelectionExpression":{"allOf":[{"$ref":"#/components/schemas/SelectionExpression"},{"xml":{"name":"templateSelectionExpression"},"description":"The template selection expressions for the integration response."}]}}},"GetIntegrationResponsesResponse":{"type":"object","properties":{"Items":{"allOf":[{"$ref":"#/components/schemas/__listOfIntegrationResponse"},{"xml":{"name":"items"},"description":"The elements from this collection."}]},"NextToken":{"allOf":[{"$ref":"#/components/schemas/NextToken"},{"xml":{"name":"nextToken"},"description":"The next page of elements from this collection. Not valid for the last element of the collection."}]}}},"GetIntegrationsResponse":{"type":"object","properties":{"Items":{"allOf":[{"$ref":"#/components/schemas/__listOfIntegration"},{"xml":{"name":"items"},"description":"The elements from this collection."}]},"NextToken":{"allOf":[{"$ref":"#/components/schemas/NextToken"},{"xml":{"name":"nextToken"},"description":"The next page of elements from this collection. Not valid for the last element of the collection."}]}}},"GetModelResponse":{"type":"object","properties":{"ContentType":{"allOf":[{"$ref":"#/components/schemas/StringWithLengthBetween1And256"},{"xml":{"name":"contentType"},"description":"The content-type for the model, for example, \"application/json\"."}]},"Description":{"allOf":[{"$ref":"#/components/schemas/StringWithLengthBetween0And1024"},{"xml":{"name":"description"},"description":"The description of the model."}]},"ModelId":{"allOf":[{"$ref":"#/components/schemas/Id"},{"xml":{"name":"modelId"},"description":"The model identifier."}]},"Name":{"allOf":[{"$ref":"#/components/schemas/StringWithLengthBetween1And128"},{"xml":{"name":"name"},"description":"The name of the model. Must be alphanumeric."}]},"Schema":{"allOf":[{"$ref":"#/components/schemas/StringWithLengthBetween0And32K"},{"xml":{"name":"schema"},"description":"The schema for the model. For application/json models, this should be JSON schema draft 4 model."}]}}},"GetModelTemplateResponse":{"type":"object","properties":{"Value":{"allOf":[{"$ref":"#/components/schemas/__string"},{"xml":{"name":"value"},"description":"The template value."}]}}},"GetModelsResponse":{"type":"object","properties":{"Items":{"allOf":[{"$ref":"#/components/schemas/__listOfModel"},{"xml":{"name":"items"},"description":"The elements from this collection."}]},"NextToken":{"allOf":[{"$ref":"#/components/schemas/NextToken"},{"xml":{"name":"nextToken"},"description":"The next page of elements from this collection. Not valid for the last element of the collection."}]}}},"GetRouteResult":{"type":"object","properties":{"ApiGatewayManaged":{"allOf":[{"$ref":"#/components/schemas/__boolean"},{"xml":{"name":"apiGatewayManaged"},"description":"Specifies whether a route is managed by API Gateway. If you created an API using quick create, the $default route is managed by API Gateway. You can't modify the $default route key."}]},"ApiKeyRequired":{"allOf":[{"$ref":"#/components/schemas/__boolean"},{"xml":{"name":"apiKeyRequired"},"description":"Specifies whether an API key is required for this route. Supported only for WebSocket APIs."}]},"AuthorizationScopes":{"allOf":[{"$ref":"#/components/schemas/AuthorizationScopes"},{"xml":{"name":"authorizationScopes"},"description":"A list of authorization scopes configured on a route. The scopes are used with a JWT authorizer to authorize the method invocation. The authorization works by matching the route scopes against the scopes parsed from the access token in the incoming request. The method invocation is authorized if any route scope matches a claimed scope in the access token. Otherwise, the invocation is not authorized. When the route scope is configured, the client must provide an access token instead of an identity token for authorization purposes."}]},"AuthorizationType":{"allOf":[{"$ref":"#/components/schemas/AuthorizationType"},{"xml":{"name":"authorizationType"},"description":"The authorization type for the route. For WebSocket APIs, valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer For HTTP APIs, valid values are NONE for open access, JWT for using JSON Web Tokens, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer."}]},"AuthorizerId":{"allOf":[{"$ref":"#/components/schemas/Id"},{"xml":{"name":"authorizerId"},"description":"The identifier of the Authorizer resource to be associated with this route. The authorizer identifier is generated by API Gateway when you created the authorizer."}]},"ModelSelectionExpression":{"allOf":[{"$ref":"#/components/schemas/SelectionExpression"},{"xml":{"name":"modelSelectionExpression"},"description":"The model selection expression for the route. Supported only for WebSocket APIs."}]},"OperationName":{"allOf":[{"$ref":"#/components/schemas/StringWithLengthBetween1And64"},{"xml":{"name":"operationName"},"description":"The operation name for the route."}]},"RequestModels":{"allOf":[{"$ref":"#/components/schemas/RouteModels"},{"xml":{"name":"requestModels"},"description":"The request models for the route. Supported only for WebSocket APIs."}]},"RequestParameters":{"allOf":[{"$ref":"#/components/schemas/RouteParameters"},{"xml":{"name":"requestParameters"},"description":"The request parameters for the route. Supported only for WebSocket APIs."}]},"RouteId":{"allOf":[{"$ref":"#/components/schemas/Id"},{"xml":{"name":"routeId"},"description":"The route ID."}]},"RouteKey":{"allOf":[{"$ref":"#/components/schemas/SelectionKey"},{"xml":{"name":"routeKey"},"description":"The route key for the route."}]},"RouteResponseSelectionExpression":{"allOf":[{"$ref":"#/components/schemas/SelectionExpression"},{"xml":{"name":"routeResponseSelectionExpression"},"description":"The route response selection expression for the route. Supported only for WebSocket APIs."}]},"Target":{"allOf":[{"$ref":"#/components/schemas/StringWithLengthBetween1And128"},{"xml":{"name":"target"},"description":"The target for the route."}]}}},"GetRouteResponseResponse":{"type":"object","properties":{"ModelSelectionExpression":{"allOf":[{"$ref":"#/components/schemas/SelectionExpression"},{"xml":{"name":"modelSelectionExpression"},"description":"Represents the model selection expression of a route response. Supported only for WebSocket APIs."}]},"ResponseModels":{"allOf":[{"$ref":"#/components/schemas/RouteModels"},{"xml":{"name":"responseModels"},"description":"Represents the response models of a route response."}]},"ResponseParameters":{"allOf":[{"$ref":"#/components/schemas/RouteParameters"},{"xml":{"name":"responseParameters"},"description":"Represents the response parameters of a route response."}]},"RouteResponseId":{"allOf":[{"$ref":"#/components/schemas/Id"},{"xml":{"name":"routeResponseId"},"description":"Represents the identifier of a route response."}]},"RouteResponseKey":{"allOf":[{"$ref":"#/components/schemas/SelectionKey"},{"xml":{"name":"routeResponseKey"},"description":"Represents the route response key of a route response."}]}}},"GetRouteResponsesResponse":{"type":"object","properties":{"Items":{"allOf":[{"$ref":"#/components/schemas/__listOfRouteResponse"},{"xml":{"name":"items"},"description":"The elements from this collection."}]},"NextToken":{"allOf":[{"$ref":"#/components/schemas/NextToken"},{"xml":{"name":"nextToken"},"description":"The next page of elements from this collection. Not valid for the last element of the collection."}]}}},"GetRoutesResponse":{"type":"object","properties":{"Items":{"allOf":[{"$ref":"#/components/schemas/__listOfRoute"},{"xml":{"name":"items"},"description":"The elements from this collection."}]},"NextToken":{"allOf":[{"$ref":"#/components/schemas/NextToken"},{"xml":{"name":"nextToken"},"description":"The next page of elements from this collection. Not valid for the last element of the collection."}]}}},"GetStageResponse":{"type":"object","properties":{"AccessLogSettings":{"allOf":[{"$ref":"#/components/schemas/AccessLogSettings"},{"xml":{"name":"accessLogSettings"},"description":"Settings for logging access in this stage."}]},"ApiGatewayManaged":{"allOf":[{"$ref":"#/components/schemas/__boolean"},{"xml":{"name":"apiGatewayManaged"},"description":"Specifies whether a stage is managed by API Gateway. If you created an API using quick create, the $default stage is managed by API Gateway. You can't modify the $default stage."}]},"AutoDeploy":{"allOf":[{"$ref":"#/components/schemas/__boolean"},{"xml":{"name":"autoDeploy"},"description":"Specifies whether updates to an API automatically trigger a new deployment. The default value is false."}]},"ClientCertificateId":{"allOf":[{"$ref":"#/components/schemas/Id"},{"xml":{"name":"clientCertificateId"},"description":"The identifier of a client certificate for a Stage. Supported only for WebSocket APIs."}]},"CreatedDate":{"allOf":[{"$ref":"#/components/schemas/__timestampIso8601"},{"xml":{"name":"createdDate"},"description":"The timestamp when the stage was created."}]},"DefaultRouteSettings":{"allOf":[{"$ref":"#/components/schemas/RouteSettings"},{"xml":{"name":"defaultRouteSettings"},"description":"Default route settings for the stage."}]},"DeploymentId":{"allOf":[{"$ref":"#/components/schemas/Id"},{"xml":{"name":"deploymentId"},"description":"The identifier of the Deployment that the Stage is associated with. Can't be updated if autoDeploy is enabled."}]},"Description":{"allOf":[{"$ref":"#/components/schemas/StringWithLengthBetween0And1024"},{"xml":{"name":"description"},"description":"The description of the stage."}]},"LastDeploymentStatusMessage":{"allOf":[{"$ref":"#/components/schemas/__string"},{"xml":{"name":"lastDeploymentStatusMessage"},"description":"Describes the status of the last deployment of a stage. Supported only for stages with autoDeploy enabled."}]},"LastUpdatedDate":{"allOf":[{"$ref":"#/components/schemas/__timestampIso8601"},{"xml":{"name":"lastUpdatedDate"},"description":"The timestamp when the stage was last updated."}]},"RouteSettings":{"allOf":[{"$ref":"#/components/schemas/RouteSettingsMap"},{"xml":{"name":"routeSettings"},"description":"Route settings for the stage, by routeKey."}]},"StageName":{"allOf":[{"$ref":"#/components/schemas/StringWithLengthBetween1And128"},{"xml":{"name":"stageName"},"description":"The name of the stage."}]},"StageVariables":{"allOf":[{"$ref":"#/components/schemas/StageVariablesMap"},{"xml":{"name":"stageVariables"},"description":"A map that defines the stage variables for a stage resource. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+."}]},"Tags":{"allOf":[{"$ref":"#/components/schemas/Tags"},{"xml":{"name":"tags"},"description":"The collection of tags. Each tag element is associated with a given resource."}]}}},"GetStagesResponse":{"type":"object","properties":{"Items":{"allOf":[{"$ref":"#/components/schemas/__listOfStage"},{"xml":{"name":"items"},"description":"The elements from this collection."}]},"NextToken":{"allOf":[{"$ref":"#/components/schemas/NextToken"},{"xml":{"name":"nextToken"},"description":"The next page of elements from this collection. Not valid for the last element of the collection."}]}}},"GetTagsResponse":{"type":"object","properties":{"Tags":{"allOf":[{"$ref":"#/components/schemas/Tags"},{"xml":{"name":"tags"}}]}}},"GetVpcLinkResponse":{"type":"object","properties":{"CreatedDate":{"allOf":[{"$ref":"#/components/schemas/__timestampIso8601"},{"xml":{"name":"createdDate"},"description":"The timestamp when the VPC link was created."}]},"Name":{"allOf":[{"$ref":"#/components/schemas/StringWithLengthBetween1And128"},{"xml":{"name":"name"},"description":"The name of the VPC link."}]},"SecurityGroupIds":{"allOf":[{"$ref":"#/components/schemas/SecurityGroupIdList"},{"xml":{"name":"securityGroupIds"},"description":"A list of security group IDs for the VPC link."}]},"SubnetIds":{"allOf":[{"$ref":"#/components/schemas/SubnetIdList"},{"xml":{"name":"subnetIds"},"description":"A list of subnet IDs to include in the VPC link."}]},"Tags":{"allOf":[{"$ref":"#/components/schemas/Tags"},{"xml":{"name":"tags"},"description":"Tags for the VPC link."}]},"VpcLinkId":{"allOf":[{"$ref":"#/components/schemas/Id"},{"xml":{"name":"vpcLinkId"},"description":"The ID of the VPC link."}]},"VpcLinkStatus":{"allOf":[{"$ref":"#/components/schemas/VpcLinkStatus"},{"xml":{"name":"vpcLinkStatus"},"description":"The status of the VPC link."}]},"VpcLinkStatusMessage":{"allOf":[{"$ref":"#/components/schemas/StringWithLengthBetween0And1024"},{"xml":{"name":"vpcLinkStatusMessage"},"description":"A message summarizing the cause of the status of the VPC link."}]},"VpcLinkVersion":{"allOf":[{"$ref":"#/components/schemas/VpcLinkVersion"},{"xml":{"name":"vpcLinkVersion"},"description":"The version of the VPC link."}]}}},"GetVpcLinksResponse":{"type":"object","properties":{"Items":{"allOf":[{"$ref":"#/components/schemas/__listOfVpcLink"},{"xml":{"name":"items"},"description":"A collection of VPC links."}]},"NextToken":{"allOf":[{"$ref":"#/components/schemas/NextToken"},{"xml":{"name":"nextToken"},"description":"The next page of elements from this collection. Not valid for the last element of the collection."}]}}},"ImportApiResponse":{"type":"object","properties":{"ApiEndpoint":{"allOf":[{"$ref":"#/components/schemas/__string"},{"xml":{"name":"apiEndpoint"},"description":"The URI of the API, of the form {api-id}.execute-api.{region}.amazonaws.com. The stage name is typically appended to this URI to form a complete path to a deployed API stage."}]},"ApiGatewayManaged":{"allOf":[{"$ref":"#/components/schemas/__boolean"},{"xml":{"name":"apiGatewayManaged"},"description":"Specifies whether an API is managed by API Gateway. You can't update or delete a managed API by using API Gateway. A managed API can be deleted only through the tooling or service that created it."}]},"ApiId":{"allOf":[{"$ref":"#/components/schemas/Id"},{"xml":{"name":"apiId"},"description":"The API ID."}]},"ApiKeySelectionExpression":{"allOf":[{"$ref":"#/components/schemas/SelectionExpression"},{"xml":{"name":"apiKeySelectionExpression"},"description":"An API key selection expression. Supported only for WebSocket APIs. See <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions\">API Key Selection Expressions</a>."}]},"CorsConfiguration":{"allOf":[{"$ref":"#/components/schemas/Cors"},{"xml":{"name":"corsConfiguration"},"description":"A CORS configuration. Supported only for HTTP APIs."}]},"CreatedDate":{"allOf":[{"$ref":"#/components/schemas/__timestampIso8601"},{"xml":{"name":"createdDate"},"description":"The timestamp when the API was created."}]},"Description":{"allOf":[{"$ref":"#/components/schemas/StringWithLengthBetween0And1024"},{"xml":{"name":"description"},"description":"The description of the API."}]},"DisableSchemaValidation":{"allOf":[{"$ref":"#/components/schemas/__boolean"},{"xml":{"name":"disableSchemaValidation"},"description":"Avoid validating models when creating a deployment. Supported only for WebSocket APIs."}]},"DisableExecuteApiEndpoint":{"allOf":[{"$ref":"#/components/schemas/__boolean"},{"xml":{"name":"disableExecuteApiEndpoint"},"description":"Specifies whether clients can invoke your API by using the default execute-api endpoint. By default, clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint."}]},"ImportInfo":{"allOf":[{"$ref":"#/components/schemas/__listOf__string"},{"xml":{"name":"importInfo"},"description":"The validation information during API import. This may include particular properties of your OpenAPI definition which are ignored during import. Supported only for HTTP APIs."}]},"Name":{"allOf":[{"$ref":"#/components/schemas/StringWithLengthBetween1And128"},{"xml":{"name":"name"},"description":"The name of the API."}]},"ProtocolType":{"allOf":[{"$ref":"#/components/schemas/ProtocolType"},{"xml":{"name":"protocolType"},"description":"The API protocol."}]},"RouteSelectionExpression":{"allOf":[{"$ref":"#/components/schemas/SelectionExpression"},{"xml":{"name":"routeSelectionExpression"},"description":"The route selection expression for the API. For HTTP APIs, the routeSelectionExpression must be ${request.method} ${request.path}. If not provided, this will be the default for HTTP APIs. This property is required for WebSocket APIs."}]},"Tags":{"allOf":[{"$ref":"#/components/schemas/Tags"},{"xml":{"name":"tags"},"description":"A collection of tags associated with the API."}]},"Version":{"allOf":[{"$ref":"#/components/schemas/StringWithLengthBetween1And64"},{"xml":{"name":"version"},"description":"A version identifier for the API."}]},"Warnings":{"allOf":[{"$ref":"#/components/schemas/__listOf__string"},{"xml":{"name":"warnings"},"description":"The warning messages reported when failonwarnings is turned on during API import."}]}}},"ReimportApiResponse":{"type":"object","properties":{"ApiEndpoint":{"allOf":[{"$ref":"#/components/schemas/__string"},{"xml":{"name":"apiEndpoint"},"description":"The URI of the API, of the form {api-id}.execute-api.{region}.amazonaws.com. The stage name is typically appended to this URI to form a complete path to a deployed API stage."}]},"ApiGatewayManaged":{"allOf":[{"$ref":"#/components/schemas/__boolean"},{"xml":{"name":"apiGatewayManaged"},"description":"Specifies whether an API is managed by API Gateway. You can't update or delete a managed API by using API Gateway. A managed API can be deleted only through the tooling or service that created it."}]},"ApiId":{"allOf":[{"$ref":"#/components/schemas/Id"},{"xml":{"name":"apiId"},"description":"The API ID."}]},"ApiKeySelectionExpression":{"allOf":[{"$ref":"#/components/schemas/SelectionExpression"},{"xml":{"name":"apiKeySelectionExpression"},"description":"An API key selection expression. Supported only for WebSocket APIs. See <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions\">API Key Selection Expressions</a>."}]},"CorsConfiguration":{"allOf":[{"$ref":"#/components/schemas/Cors"},{"xml":{"name":"corsConfiguration"},"description":"A CORS configuration. Supported only for HTTP APIs."}]},"CreatedDate":{"allOf":[{"$ref":"#/components/schemas/__timestampIso8601"},{"xml":{"name":"createdDate"},"description":"The timestamp when the API was created."}]},"Description":{"allOf":[{"$ref":"#/components/schemas/StringWithLengthBetween0And1024"},{"xml":{"name":"description"},"description":"The description of the API."}]},"DisableSchemaValidation":{"allOf":[{"$ref":"#/components/schemas/__boolean"},{"xml":{"name":"disableSchemaValidation"},"description":"Avoid validating models when creating a deployment. Supported only for WebSocket APIs."}]},"DisableExecuteApiEndpoint":{"allOf":[{"$ref":"#/components/schemas/__boolean"},{"xml":{"name":"disableExecuteApiEndpoint"},"description":"Specifies whether clients can invoke your API by using the default execute-api endpoint. By default, clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint."}]},"ImportInfo":{"allOf":[{"$ref":"#/components/schemas/__listOf__string"},{"xml":{"name":"importInfo"},"description":"The validation information during API import. This may include particular properties of your OpenAPI definition which are ignored during import. Supported only for HTTP APIs."}]},"Name":{"allOf":[{"$ref":"#/components/schemas/StringWithLengthBetween1And128"},{"xml":{"name":"name"},"description":"The name of the API."}]},"ProtocolType":{"allOf":[{"$ref":"#/components/schemas/ProtocolType"},{"xml":{"name":"protocolType"},"description":"The API protocol."}]},"RouteSelectionExpression":{"allOf":[{"$ref":"#/components/schemas/SelectionExpression"},{"xml":{"name":"routeSelectionExpression"},"description":"The route selection expression for the API. For HTTP APIs, the routeSelectionExpression must be ${request.method} ${request.path}. If not provided, this will be the default for HTTP APIs. This property is required for WebSocket APIs."}]},"Tags":{"allOf":[{"$ref":"#/components/schemas/Tags"},{"xml":{"name":"tags"},"description":"A collection of tags associated with the API."}]},"Version":{"allOf":[{"$ref":"#/components/schemas/StringWithLengthBetween1And64"},{"xml":{"name":"version"},"description":"A version identifier for the API."}]},"Warnings":{"allOf":[{"$ref":"#/components/schemas/__listOf__string"},{"xml":{"name":"warnings"},"description":"The warning messages reported when failonwarnings is turned on during API import."}]}}},"TagResourceResponse":{"type":"object","properties":{}},"UpdateApiResponse":{"type":"object","properties":{"ApiEndpoint":{"allOf":[{"$ref":"#/components/schemas/__string"},{"xml":{"name":"apiEndpoint"},"description":"The URI of the API, of the form {api-id}.execute-api.{region}.amazonaws.com. The stage name is typically appended to this URI to form a complete path to a deployed API stage."}]},"ApiGatewayManaged":{"allOf":[{"$ref":"#/components/schemas/__boolean"},{"xml":{"name":"apiGatewayManaged"},"description":"Specifies whether an API is managed by API Gateway. You can't update or delete a managed API by using API Gateway. A managed API can be deleted only through the tooling or service that created it."}]},"ApiId":{"allOf":[{"$ref":"#/components/schemas/Id"},{"xml":{"name":"apiId"},"description":"The API ID."}]},"ApiKeySelectionExpression":{"allOf":[{"$ref":"#/components/schemas/SelectionExpression"},{"xml":{"name":"apiKeySelectionExpression"},"description":"An API key selection expression. Supported only for WebSocket APIs. See <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions\">API Key Selection Expressions</a>."}]},"CorsConfiguration":{"allOf":[{"$ref":"#/components/schemas/Cors"},{"xml":{"name":"corsConfiguration"},"description":"A CORS configuration. Supported only for HTTP APIs."}]},"CreatedDate":{"allOf":[{"$ref":"#/components/schemas/__timestampIso8601"},{"xml":{"name":"createdDate"},"description":"The timestamp when the API was created."}]},"Description":{"allOf":[{"$ref":"#/components/schemas/StringWithLengthBetween0And1024"},{"xml":{"name":"description"},"description":"The description of the API."}]},"DisableSchemaValidation":{"allOf":[{"$ref":"#/components/schemas/__boolean"},{"xml":{"name":"disableSchemaValidation"},"description":"Avoid validating models when creating a deployment. Supported only for WebSocket APIs."}]},"DisableExecuteApiEndpoint":{"allOf":[{"$ref":"#/components/schemas/__boolean"},{"xml":{"name":"disableExecuteApiEndpoint"},"description":"Specifies whether clients can invoke your API by using the default execute-api endpoint. By default, clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint."}]},"ImportInfo":{"allOf":[{"$ref":"#/components/schemas/__listOf__string"},{"xml":{"name":"importInfo"},"description":"The validation information during API import. This may include particular properties of your OpenAPI definition which are ignored during import. Supported only for HTTP APIs."}]},"Name":{"allOf":[{"$ref":"#/components/schemas/StringWithLengthBetween1And128"},{"xml":{"name":"name"},"description":"The name of the API."}]},"ProtocolType":{"allOf":[{"$ref":"#/components/schemas/ProtocolType"},{"xml":{"name":"protocolType"},"description":"The API protocol."}]},"RouteSelectionExpression":{"allOf":[{"$ref":"#/components/schemas/SelectionExpression"},{"xml":{"name":"routeSelectionExpression"},"description":"The route selection expression for the API. For HTTP APIs, the routeSelectionExpression must be ${request.method} ${request.path}. If not provided, this will be the default for HTTP APIs. This property is required for WebSocket APIs."}]},"Tags":{"allOf":[{"$ref":"#/components/schemas/Tags"},{"xml":{"name":"tags"},"description":"A collection of tags associated with the API."}]},"Version":{"allOf":[{"$ref":"#/components/schemas/StringWithLengthBetween1And64"},{"xml":{"name":"version"},"description":"A version identifier for the API."}]},"Warnings":{"allOf":[{"$ref":"#/components/schemas/__listOf__string"},{"xml":{"name":"warnings"},"description":"The warning messages reported when failonwarnings is turned on during API import."}]}}},"UpdateApiMappingResponse":{"type":"object","properties":{"ApiId":{"allOf":[{"$ref":"#/components/schemas/Id"},{"xml":{"name":"apiId"},"description":"The API identifier."}]},"ApiMappingId":{"allOf":[{"$ref":"#/components/schemas/Id"},{"xml":{"name":"apiMappingId"},"description":"The API mapping identifier."}]},"ApiMappingKey":{"allOf":[{"$ref":"#/components/schemas/SelectionKey"},{"xml":{"name":"apiMappingKey"},"description":"The API mapping key."}]},"Stage":{"allOf":[{"$ref":"#/components/schemas/StringWithLengthBetween1And128"},{"xml":{"name":"stage"},"description":"The API stage."}]}}},"UpdateAuthorizerResponse":{"type":"object","properties":{"AuthorizerCredentialsArn":{"allOf":[{"$ref":"#/components/schemas/Arn"},{"xml":{"name":"authorizerCredentialsArn"},"description":"Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, don't specify this parameter. Supported only for REQUEST authorizers."}]},"AuthorizerId":{"allOf":[{"$ref":"#/components/schemas/Id"},{"xml":{"name":"authorizerId"},"description":"The authorizer identifier."}]},"AuthorizerPayloadFormatVersion":{"allOf":[{"$ref":"#/components/schemas/StringWithLengthBetween1And64"},{"xml":{"name":"authorizerPayloadFormatVersion"},"description":"Specifies the format of the payload sent to an HTTP API Lambda authorizer. Required for HTTP API Lambda authorizers. Supported values are 1.0 and 2.0. To learn more, see <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html\">Working with AWS Lambda authorizers for HTTP APIs</a>."}]},"AuthorizerResultTtlInSeconds":{"allOf":[{"$ref":"#/components/schemas/IntegerWithLengthBetween0And3600"},{"xml":{"name":"authorizerResultTtlInSeconds"},"description":"The time to live (TTL) for cached authorizer results, in seconds. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway caches authorizer responses. The maximum value is 3600, or 1 hour. Supported only for HTTP API Lambda authorizers."}]},"AuthorizerType":{"allOf":[{"$ref":"#/components/schemas/AuthorizerType"},{"xml":{"name":"authorizerType"},"description":"The authorizer type. Specify REQUEST for a Lambda function using incoming request parameters. Specify JWT to use JSON Web Tokens (supported only for HTTP APIs)."}]},"AuthorizerUri":{"allOf":[{"$ref":"#/components/schemas/UriWithLengthBetween1And2048"},{"xml":{"name":"authorizerUri"},"description":"The authorizer's Uniform Resource Identifier (URI). For REQUEST authorizers, this must be a well-formed Lambda function URI, for example, arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:<replaceable>{account_id}</replaceable>:function:<replaceable>{lambda_function_name}</replaceable>/invocations. In general, the URI has this form: arn:aws:apigateway:<replaceable>{region}</replaceable>:lambda:path/<replaceable>{service_api}</replaceable>\n , where <replaceable></replaceable>{region} is the same as the region hosting the Lambda function, path indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial /. For Lambda functions, this is usually of the form /2015-03-31/functions/[FunctionARN]/invocations. Supported only for REQUEST authorizers."}]},"EnableSimpleResponses":{"allOf":[{"$ref":"#/components/schemas/__boolean"},{"xml":{"name":"enableSimpleResponses"},"description":"Specifies whether a Lambda authorizer returns a response in a simple format. If enabled, the Lambda authorizer can return a boolean value instead of an IAM policy. Supported only for HTTP APIs. To learn more, see <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html\">Working with AWS Lambda authorizers for HTTP APIs</a>"}]},"IdentitySource":{"allOf":[{"$ref":"#/components/schemas/IdentitySourceList"},{"xml":{"name":"identitySource"},"description":"<p>The identity source for which authorization is requested.</p> <p>For a REQUEST authorizer, this is optional. The value is a set of one or more mapping expressions of the specified request parameters. The identity source can be headers, query string parameters, stage variables, and context parameters. For example, if an Auth header and a Name query string parameter are defined as identity sources, this value is route.request.header.Auth, route.request.querystring.Name for WebSocket APIs. For HTTP APIs, use selection expressions prefixed with $, for example, $request.header.Auth, $request.querystring.Name. These parameters are used to perform runtime validation for Lambda-based authorizers by verifying all of the identity-related request parameters are present in the request, not null, and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function. Otherwise, it returns a 401 Unauthorized response without calling the Lambda function. For HTTP APIs, identity sources are also used as the cache key when caching is enabled. To learn more, see <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html\">Working with AWS Lambda authorizers for HTTP APIs</a>.</p> <p>For JWT, a single entry that specifies where to extract the JSON Web Token (JWT) from inbound requests. Currently only header-based and query parameter-based selections are supported, for example $request.header.Authorization.</p>"}]},"IdentityValidationExpression":{"allOf":[{"$ref":"#/components/schemas/StringWithLengthBetween0And1024"},{"xml":{"name":"identityValidationExpression"},"description":"The validation expression does not apply to the REQUEST authorizer."}]},"JwtConfiguration":{"allOf":[{"$ref":"#/components/schemas/JWTConfiguration"},{"xml":{"name":"jwtConfiguration"},"description":"Represents the configuration of a JWT authorizer. Required for the JWT authorizer type. Supported only for HTTP APIs."}]},"Name":{"allOf":[{"$ref":"#/components/schemas/StringWithLengthBetween1And128"},{"xml":{"name":"name"},"description":"The name of the authorizer."}]}}},"UpdateDeploymentResponse":{"type":"object","properties":{"AutoDeployed":{"allOf":[{"$ref":"#/components/schemas/__boolean"},{"xml":{"name":"autoDeployed"},"description":"Specifies whether a deployment was automatically released."}]},"CreatedDate":{"allOf":[{"$ref":"#/components/schemas/__timestampIso8601"},{"xml":{"name":"createdDate"},"description":"The date and time when the Deployment resource was created."}]},"DeploymentId":{"allOf":[{"$ref":"#/components/schemas/Id"},{"xml":{"name":"deploymentId"},"description":"The identifier for the deployment."}]},"DeploymentStatus":{"allOf":[{"$ref":"#/components/schemas/DeploymentStatus"},{"xml":{"name":"deploymentStatus"},"description":"The status of the deployment: PENDING, FAILED, or SUCCEEDED."}]},"DeploymentStatusMessage":{"allOf":[{"$ref":"#/components/schemas/__string"},{"xml":{"name":"deploymentStatusMessage"},"description":"May contain additional feedback on the status of an API deployment."}]},"Description":{"allOf":[{"$ref":"#/components/schemas/StringWithLengthBetween0And1024"},{"xml":{"name":"description"},"description":"The description for the deployment."}]}}},"UpdateDomainNameResponse":{"type":"object","properties":{"ApiMappingSelectionExpression":{"allOf":[{"$ref":"#/components/schemas/SelectionExpression"},{"xml":{"name":"apiMappingSelectionExpression"},"description":"The API mapping selection expression."}]},"DomainName":{"allOf":[{"$ref":"#/components/schemas/StringWithLengthBetween1And512"},{"xml":{"name":"domainName"},"description":"The name of the DomainName resource."}]},"DomainNameConfigurations":{"allOf":[{"$ref":"#/components/schemas/DomainNameConfigurations"},{"xml":{"name":"domainNameConfigurations"},"description":"The domain name configurations."}]},"MutualTlsAuthentication":{"allOf":[{"$ref":"#/components/schemas/MutualTlsAuthentication"},{"xml":{"name":"mutualTlsAuthentication"},"description":"The mutual TLS authentication configuration for a custom domain name."}]},"Tags":{"allOf":[{"$ref":"#/components/schemas/Tags"},{"xml":{"name":"tags"},"description":"The collection of tags associated with a domain name."}]}}},"UpdateIntegrationResult":{"type":"object","properties":{"ApiGatewayManaged":{"allOf":[{"$ref":"#/components/schemas/__boolean"},{"xml":{"name":"apiGatewayManaged"},"description":"Specifies whether an integration is managed by API Gateway. If you created an API using using quick create, the resulting integration is managed by API Gateway. You can update a managed integration, but you can't delete it."}]},"ConnectionId":{"allOf":[{"$ref":"#/components/schemas/StringWithLengthBetween1And1024"},{"xml":{"name":"connectionId"},"description":"The ID of the VPC link for a private integration. Supported only for HTTP APIs."}]},"ConnectionType":{"allOf":[{"$ref":"#/components/schemas/ConnectionType"},{"xml":{"name":"connectionType"},"description":"The type of the network connection to the integration endpoint. Specify INTERNET for connections through the public routable internet or VPC_LINK for private connections between API Gateway and resources in a VPC. The default value is INTERNET."}]},"ContentHandlingStrategy":{"allOf":[{"$ref":"#/components/schemas/ContentHandlingStrategy"},{"xml":{"name":"contentHandlingStrategy"},"description":"<p>Supported only for WebSocket APIs. Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:</p> <p>CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.</p> <p>CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.</p> <p>If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.</p>"}]},"CredentialsArn":{"allOf":[{"$ref":"#/components/schemas/Arn"},{"xml":{"name":"credentialsArn"},"description":"Specifies the credentials required for the integration, if any. For AWS integrations, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify the string arn:aws:iam::*:user/*. To use resource-based permissions on supported AWS services, specify null."}]},"Description":{"allOf":[{"$ref":"#/components/schemas/StringWithLengthBetween0And1024"},{"xml":{"name":"description"},"description":"Represents the description of an integration."}]},"IntegrationId":{"allOf":[{"$ref":"#/components/schemas/Id"},{"xml":{"name":"integrationId"},"description":"Represents the identifier of an integration."}]},"IntegrationMethod":{"allOf":[{"$ref":"#/components/schemas/StringWithLengthBetween1And64"},{"xml":{"name":"integrationMethod"},"description":"Specifies the integration's HTTP method type."}]},"IntegrationResponseSelectionExpression":{"allOf":[{"$ref":"#/components/schemas/SelectionExpression"},{"xml":{"name":"integrationResponseSelectionExpression"},"description":"The integration response selection expression for the integration. Supported only for WebSocket APIs. See <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-integration-response-selection-expressions\">Integration Response Selection Expressions</a>."}]},"IntegrationSubtype":{"allOf":[{"$ref":"#/components/schemas/StringWithLengthBetween1And128"},{"xml":{"name":"integrationSubtype"},"description":"Supported only for HTTP API AWS_PROXY integrations. Specifies the AWS service action to invoke. To learn more, see <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-aws-services-reference.html\">Integration subtype reference</a>."}]},"IntegrationType":{"allOf":[{"$ref":"#/components/schemas/IntegrationType"},{"xml":{"name":"integrationType"},"description":"<p>The integration type of an integration. One of the following:</p> <p>AWS: for integrating the route or method request with an AWS service action, including the Lambda function-invoking action. With the Lambda function-invoking action, this is referred to as the Lambda custom integration. With any other AWS service action, this is known as AWS integration. Supported only for WebSocket APIs.</p> <p>AWS_PROXY: for integrating the route or method request with a Lambda function or other AWS service action. This integration is also referred to as a Lambda proxy integration.</p> <p>HTTP: for integrating the route or method request with an HTTP endpoint. This integration is also referred to as the HTTP custom integration. Supported only for WebSocket APIs.</p> <p>HTTP_PROXY: for integrating the route or method request with an HTTP endpoint, with the client request passed through as-is. This is also referred to as HTTP proxy integration.</p> <p>MOCK: for integrating the route or method request with API Gateway as a \"loopback\" endpoint without invoking any backend. Supported only for WebSocket APIs.</p>"}]},"IntegrationUri":{"allOf":[{"$ref":"#/components/schemas/UriWithLengthBetween1And2048"},{"xml":{"name":"integrationUri"},"description":"<p>For a Lambda integration, specify the URI of a Lambda function.</p> <p>For an HTTP integration, specify a fully-qualified URL.</p> <p>For an HTTP API private integration, specify the ARN of an Application Load Balancer listener, Network Load Balancer listener, or AWS Cloud Map service. If you specify the ARN of an AWS Cloud Map service, API Gateway uses DiscoverInstances to identify resources. You can use query parameters to target specific resources. To learn more, see <a href=\"https://docs.aws.amazon.com/cloud-map/latest/api/API_DiscoverInstances.html\">DiscoverInstances</a>. For private integrations, all resources must be owned by the same AWS account.</p>"}]},"PassthroughBehavior":{"allOf":[{"$ref":"#/components/schemas/PassthroughBehavior"},{"xml":{"name":"passthroughBehavior"},"description":"<p>Specifies the pass-through behavior for incoming requests based on the Content-Type header in the request, and the available mapping templates specified as the requestTemplates property on the Integration resource. There are three valid values: WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and NEVER. Supported only for WebSocket APIs.</p> <p>WHEN_NO_MATCH passes the request body for unmapped content types through to the integration backend without transformation.</p> <p>NEVER rejects unmapped content types with an HTTP 415 Unsupported Media Type response.</p> <p>WHEN_NO_TEMPLATES allows pass-through when the integration has no content types mapped to templates. However, if there is at least one content type defined, unmapped content types will be rejected with the same HTTP 415 Unsupported Media Type response.</p>"}]},"PayloadFormatVersion":{"allOf":[{"$ref":"#/components/schemas/StringWithLengthBetween1And64"},{"xml":{"name":"payloadFormatVersion"},"description":"Specifies the format of the payload sent to an integration. Required for HTTP APIs."}]},"RequestParameters":{"allOf":[{"$ref":"#/components/schemas/IntegrationParameters"},{"xml":{"name":"requestParameters"},"description":"<p>For WebSocket APIs, a key-value map specifying request parameters that are passed from the method request to the backend. The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the backend. The method request parameter value must match the pattern of method.request.<replaceable>{location}</replaceable>.<replaceable>{name}</replaceable>\n , where \n <replaceable>{location}</replaceable>\n is querystring, path, or header; and \n <replaceable>{name}</replaceable>\n must be a valid and unique method request parameter name.</p> <p>For HTTP API integrations with a specified integrationSubtype, request parameters are a key-value map specifying parameters that are passed to AWS_PROXY integrations. You can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-aws-services.html\">Working with AWS service integrations for HTTP APIs</a>.</p> <p>For HTTP API itegrations, without a specified integrationSubtype request parameters are a key-value map specifying how to transform HTTP requests before sending them to backend integrations. The key should follow the pattern <action>:<header|querystring|path>.<location>. The action can be append, overwrite or remove. For values, you can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-parameter-mapping.html\">Transforming API requests and responses</a>.</p>"}]},"RequestTemplates":{"allOf":[{"$ref":"#/components/schemas/TemplateMap"},{"xml":{"name":"requestTemplates"},"description":"Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value. Supported only for WebSocket APIs."}]},"ResponseParameters":{"allOf":[{"$ref":"#/components/schemas/ResponseParameters"},{"xml":{"name":"responseParameters"},"description":"Supported only for HTTP APIs. You use response parameters to transform the HTTP response from a backend integration before returning the response to clients. Specify a key-value map from a selection key to response parameters. The selection key must be a valid HTTP status code within the range of 200-599. Response parameters are a key-value map. The key must match pattern <action>:<header>.<location> or overwrite.statuscode. The action can be append, overwrite or remove. The value can be a static value, or map to response data, stage variables, or context variables that are evaluated at runtime. To learn more, see <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-parameter-mapping.html\">Transforming API requests and responses</a>."}]},"TemplateSelectionExpression":{"allOf":[{"$ref":"#/components/schemas/SelectionExpression"},{"xml":{"name":"templateSelectionExpression"},"description":"The template selection expression for the integration. Supported only for WebSocket APIs."}]},"TimeoutInMillis":{"allOf":[{"$ref":"#/components/schemas/IntegerWithLengthBetween50And30000"},{"xml":{"name":"timeoutInMillis"},"description":"Custom timeout between 50 and 29,000 milliseconds for WebSocket APIs and between 50 and 30,000 milliseconds for HTTP APIs. The default timeout is 29 seconds for WebSocket APIs and 30 seconds for HTTP APIs."}]},"TlsConfig":{"allOf":[{"$ref":"#/components/schemas/TlsConfig"},{"xml":{"name":"tlsConfig"},"description":"The TLS configuration for a private integration. If you specify a TLS configuration, private integration traffic uses the HTTPS protocol. Supported only for HTTP APIs."}]}}},"UpdateIntegrationResponseResponse":{"type":"object","properties":{"ContentHandlingStrategy":{"allOf":[{"$ref":"#/components/schemas/ContentHandlingStrategy"},{"xml":{"name":"contentHandlingStrategy"},"description":"<p>Supported only for WebSocket APIs. Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:</p> <p>CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.</p> <p>CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.</p> <p>If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.</p>"}]},"IntegrationResponseId":{"allOf":[{"$ref":"#/components/schemas/Id"},{"xml":{"name":"integrationResponseId"},"description":"The integration response ID."}]},"IntegrationResponseKey":{"allOf":[{"$ref":"#/components/schemas/SelectionKey"},{"xml":{"name":"integrationResponseKey"},"description":"The integration response key."}]},"ResponseParameters":{"allOf":[{"$ref":"#/components/schemas/IntegrationParameters"},{"xml":{"name":"responseParameters"},"description":"A key-value map specifying response parameters that are passed to the method response from the backend. The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of method.response.header.{name}, where name is a valid and unique header name. The mapped non-static value must match the pattern of integration.response.header.{name} or integration.response.body.{JSON-expression}, where name is a valid and unique response header name and JSON-expression is a valid JSON expression without the $ prefix."}]},"ResponseTemplates":{"allOf":[{"$ref":"#/components/schemas/TemplateMap"},{"xml":{"name":"responseTemplates"},"description":"The collection of response templates for the integration response as a string-to-string map of key-value pairs. Response templates are represented as a key/value map, with a content-type as the key and a template as the value."}]},"TemplateSelectionExpression":{"allOf":[{"$ref":"#/components/schemas/SelectionExpression"},{"xml":{"name":"templateSelectionExpression"},"description":"The template selection expressions for the integration response."}]}}},"UpdateModelResponse":{"type":"object","properties":{"ContentType":{"allOf":[{"$ref":"#/components/schemas/StringWithLengthBetween1And256"},{"xml":{"name":"contentType"},"description":"The content-type for the model, for example, \"application/json\"."}]},"Description":{"allOf":[{"$ref":"#/components/schemas/StringWithLengthBetween0And1024"},{"xml":{"name":"description"},"description":"The description of the model."}]},"ModelId":{"allOf":[{"$ref":"#/components/schemas/Id"},{"xml":{"name":"modelId"},"description":"The model identifier."}]},"Name":{"allOf":[{"$ref":"#/components/schemas/StringWithLengthBetween1And128"},{"xml":{"name":"name"},"description":"The name of the model. Must be alphanumeric."}]},"Schema":{"allOf":[{"$ref":"#/components/schemas/StringWithLengthBetween0And32K"},{"xml":{"name":"schema"},"description":"The schema for the model. For application/json models, this should be JSON schema draft 4 model."}]}}},"UpdateRouteResult":{"type":"object","properties":{"ApiGatewayManaged":{"allOf":[{"$ref":"#/components/schemas/__boolean"},{"xml":{"name":"apiGatewayManaged"},"description":"Specifies whether a route is managed by API Gateway. If you created an API using quick create, the $default route is managed by API Gateway. You can't modify the $default route key."}]},"ApiKeyRequired":{"allOf":[{"$ref":"#/components/schemas/__boolean"},{"xml":{"name":"apiKeyRequired"},"description":"Specifies whether an API key is required for this route. Supported only for WebSocket APIs."}]},"AuthorizationScopes":{"allOf":[{"$ref":"#/components/schemas/AuthorizationScopes"},{"xml":{"name":"authorizationScopes"},"description":"A list of authorization scopes configured on a route. The scopes are used with a JWT authorizer to authorize the method invocation. The authorization works by matching the route scopes against the scopes parsed from the access token in the incoming request. The method invocation is authorized if any route scope matches a claimed scope in the access token. Otherwise, the invocation is not authorized. When the route scope is configured, the client must provide an access token instead of an identity token for authorization purposes."}]},"AuthorizationType":{"allOf":[{"$ref":"#/components/schemas/AuthorizationType"},{"xml":{"name":"authorizationType"},"description":"The authorization type for the route. For WebSocket APIs, valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer For HTTP APIs, valid values are NONE for open access, JWT for using JSON Web Tokens, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer."}]},"AuthorizerId":{"allOf":[{"$ref":"#/components/schemas/Id"},{"xml":{"name":"authorizerId"},"description":"The identifier of the Authorizer resource to be associated with this route. The authorizer identifier is generated by API Gateway when you created the authorizer."}]},"ModelSelectionExpression":{"allOf":[{"$ref":"#/components/schemas/SelectionExpression"},{"xml":{"name":"modelSelectionExpression"},"description":"The model selection expression for the route. Supported only for WebSocket APIs."}]},"OperationName":{"allOf":[{"$ref":"#/components/schemas/StringWithLengthBetween1And64"},{"xml":{"name":"operationName"},"description":"The operation name for the route."}]},"RequestModels":{"allOf":[{"$ref":"#/components/schemas/RouteModels"},{"xml":{"name":"requestModels"},"description":"The request models for the route. Supported only for WebSocket APIs."}]},"RequestParameters":{"allOf":[{"$ref":"#/components/schemas/RouteParameters"},{"xml":{"name":"requestParameters"},"description":"The request parameters for the route. Supported only for WebSocket APIs."}]},"RouteId":{"allOf":[{"$ref":"#/components/schemas/Id"},{"xml":{"name":"routeId"},"description":"The route ID."}]},"RouteKey":{"allOf":[{"$ref":"#/components/schemas/SelectionKey"},{"xml":{"name":"routeKey"},"description":"The route key for the route."}]},"RouteResponseSelectionExpression":{"allOf":[{"$ref":"#/components/schemas/SelectionExpression"},{"xml":{"name":"routeResponseSelectionExpression"},"description":"The route response selection expression for the route. Supported only for WebSocket APIs."}]},"Target":{"allOf":[{"$ref":"#/components/schemas/StringWithLengthBetween1And128"},{"xml":{"name":"target"},"description":"The target for the route."}]}}},"UpdateRouteResponseResponse":{"type":"object","properties":{"ModelSelectionExpression":{"allOf":[{"$ref":"#/components/schemas/SelectionExpression"},{"xml":{"name":"modelSelectionExpression"},"description":"Represents the model selection expression of a route response. Supported only for WebSocket APIs."}]},"ResponseModels":{"allOf":[{"$ref":"#/components/schemas/RouteModels"},{"xml":{"name":"responseModels"},"description":"Represents the response models of a route response."}]},"ResponseParameters":{"allOf":[{"$ref":"#/components/schemas/RouteParameters"},{"xml":{"name":"responseParameters"},"description":"Represents the response parameters of a route response."}]},"RouteResponseId":{"allOf":[{"$ref":"#/components/schemas/Id"},{"xml":{"name":"routeResponseId"},"description":"Represents the identifier of a route response."}]},"RouteResponseKey":{"allOf":[{"$ref":"#/components/schemas/SelectionKey"},{"xml":{"name":"routeResponseKey"},"description":"Represents the route response key of a route response."}]}}},"UpdateStageResponse":{"type":"object","properties":{"AccessLogSettings":{"allOf":[{"$ref":"#/components/schemas/AccessLogSettings"},{"xml":{"name":"accessLogSettings"},"description":"Settings for logging access in this stage."}]},"ApiGatewayManaged":{"allOf":[{"$ref":"#/components/schemas/__boolean"},{"xml":{"name":"apiGatewayManaged"},"description":"Specifies whether a stage is managed by API Gateway. If you created an API using quick create, the $default stage is managed by API Gateway. You can't modify the $default stage."}]},"AutoDeploy":{"allOf":[{"$ref":"#/components/schemas/__boolean"},{"xml":{"name":"autoDeploy"},"description":"Specifies whether updates to an API automatically trigger a new deployment. The default value is false."}]},"ClientCertificateId":{"allOf":[{"$ref":"#/components/schemas/Id"},{"xml":{"name":"clientCertificateId"},"description":"The identifier of a client certificate for a Stage. Supported only for WebSocket APIs."}]},"CreatedDate":{"allOf":[{"$ref":"#/components/schemas/__timestampIso8601"},{"xml":{"name":"createdDate"},"description":"The timestamp when the stage was created."}]},"DefaultRouteSettings":{"allOf":[{"$ref":"#/components/schemas/RouteSettings"},{"xml":{"name":"defaultRouteSettings"},"description":"Default route settings for the stage."}]},"DeploymentId":{"allOf":[{"$ref":"#/components/schemas/Id"},{"xml":{"name":"deploymentId"},"description":"The identifier of the Deployment that the Stage is associated with. Can't be updated if autoDeploy is enabled."}]},"Description":{"allOf":[{"$ref":"#/components/schemas/StringWithLengthBetween0And1024"},{"xml":{"name":"description"},"description":"The description of the stage."}]},"LastDeploymentStatusMessage":{"allOf":[{"$ref":"#/components/schemas/__string"},{"xml":{"name":"lastDeploymentStatusMessage"},"description":"Describes the status of the last deployment of a stage. Supported only for stages with autoDeploy enabled."}]},"LastUpdatedDate":{"allOf":[{"$ref":"#/components/schemas/__timestampIso8601"},{"xml":{"name":"lastUpdatedDate"},"description":"The timestamp when the stage was last updated."}]},"RouteSettings":{"allOf":[{"$ref":"#/components/schemas/RouteSettingsMap"},{"xml":{"name":"routeSettings"},"description":"Route settings for the stage, by routeKey."}]},"StageName":{"allOf":[{"$ref":"#/components/schemas/StringWithLengthBetween1And128"},{"xml":{"name":"stageName"},"description":"The name of the stage."}]},"StageVariables":{"allOf":[{"$ref":"#/components/schemas/StageVariablesMap"},{"xml":{"name":"stageVariables"},"description":"A map that defines the stage variables for a stage resource. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+."}]},"Tags":{"allOf":[{"$ref":"#/components/schemas/Tags"},{"xml":{"name":"tags"},"description":"The collection of tags. Each tag element is associated with a given resource."}]}}},"UpdateVpcLinkResponse":{"type":"object","properties":{"CreatedDate":{"allOf":[{"$ref":"#/components/schemas/__timestampIso8601"},{"xml":{"name":"createdDate"},"description":"The timestamp when the VPC link was created."}]},"Name":{"allOf":[{"$ref":"#/components/schemas/StringWithLengthBetween1And128"},{"xml":{"name":"name"},"description":"The name of the VPC link."}]},"SecurityGroupIds":{"allOf":[{"$ref":"#/components/schemas/SecurityGroupIdList"},{"xml":{"name":"securityGroupIds"},"description":"A list of security group IDs for the VPC link."}]},"SubnetIds":{"allOf":[{"$ref":"#/components/schemas/SubnetIdList"},{"xml":{"name":"subnetIds"},"description":"A list of subnet IDs to include in the VPC link."}]},"Tags":{"allOf":[{"$ref":"#/components/schemas/Tags"},{"xml":{"name":"tags"},"description":"Tags for the VPC link."}]},"VpcLinkId":{"allOf":[{"$ref":"#/components/schemas/Id"},{"xml":{"name":"vpcLinkId"},"description":"The ID of the VPC link."}]},"VpcLinkStatus":{"allOf":[{"$ref":"#/components/schemas/VpcLinkStatus"},{"xml":{"name":"vpcLinkStatus"},"description":"The status of the VPC link."}]},"VpcLinkStatusMessage":{"allOf":[{"$ref":"#/components/schemas/StringWithLengthBetween0And1024"},{"xml":{"name":"vpcLinkStatusMessage"},"description":"A message summarizing the cause of the status of the VPC link."}]},"VpcLinkVersion":{"allOf":[{"$ref":"#/components/schemas/VpcLinkVersion"},{"xml":{"name":"vpcLinkVersion"},"description":"The version of the VPC link."}]}}},"AccessLogSettings":{"type":"object","properties":{"DestinationArn":{"allOf":[{"$ref":"#/components/schemas/Arn"},{"xml":{"name":"destinationArn"},"description":"The ARN of the CloudWatch Logs log group to receive access logs."}]},"Format":{"allOf":[{"$ref":"#/components/schemas/StringWithLengthBetween1And1024"},{"xml":{"name":"format"},"description":"A single line format of the access logs of data, as specified by selected $context variables. The format must include at least $context.requestId."}]}},"description":"Settings for logging access in a stage."},"Id":{"type":"string","description":"The identifier."},"SelectionExpression":{"type":"string","description":"An expression used to extract information at runtime. See <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions\">Selection Expressions</a> for more information."},"Cors":{"type":"object","properties":{"AllowCredentials":{"allOf":[{"$ref":"#/components/schemas/__boolean"},{"xml":{"name":"allowCredentials"},"description":"Specifies whether credentials are included in the CORS request. Supported only for HTTP APIs."}]},"AllowHeaders":{"allOf":[{"$ref":"#/components/schemas/CorsHeaderList"},{"xml":{"name":"allowHeaders"},"description":"Represents a collection of allowed headers. Supported only for HTTP APIs."}]},"AllowMethods":{"allOf":[{"$ref":"#/components/schemas/CorsMethodList"},{"xml":{"name":"allowMethods"},"description":"Represents a collection of allowed HTTP methods. Supported only for HTTP APIs."}]},"AllowOrigins":{"allOf":[{"$ref":"#/components/schemas/CorsOriginList"},{"xml":{"name":"allowOrigins"},"description":"Represents a collection of allowed origins. Supported only for HTTP APIs."}]},"ExposeHeaders":{"allOf":[{"$ref":"#/components/schemas/CorsHeaderList"},{"xml":{"name":"exposeHeaders"},"description":"Represents a collection of exposed headers. Supported only for HTTP APIs."}]},"MaxAge":{"allOf":[{"$ref":"#/components/schemas/IntegerWithLengthBetweenMinus1And86400"},{"xml":{"name":"maxAge"},"description":"The number of seconds that the browser should cache preflight request results. Supported only for HTTP APIs."}]}},"description":"Represents a CORS configuration. Supported only for HTTP APIs. See <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-cors.html\">Configuring CORS</a> for more information."},"__timestampIso8601":{"type":"string","format":"date-time"},"StringWithLengthBetween0And1024":{"type":"string","description":"A string with a length between [0-1024]."},"ProtocolType":{"type":"string","enum":["WEBSOCKET","HTTP"],"description":"Represents a protocol type."},"Tags":{"type":"object","description":"Represents a collection of tags associated with the resource.","additionalProperties":{"$ref":"#/components/schemas/StringWithLengthBetween1And1600"}},"Api":{"type":"object","required":["RouteSelectionExpression","Name","ProtocolType"],"properties":{"ApiEndpoint":{"allOf":[{"$ref":"#/components/schemas/__string"},{"xml":{"name":"apiEndpoint"},"description":"The URI of the API, of the form {api-id}.execute-api.{region}.amazonaws.com. The stage name is typically appended to this URI to form a complete path to a deployed API stage."}]},"ApiGatewayManaged":{"allOf":[{"$ref":"#/components/schemas/__boolean"},{"xml":{"name":"apiGatewayManaged"},"description":"Specifies whether an API is managed by API Gateway. You can't update or delete a managed API by using API Gateway. A managed API can be deleted only through the tooling or service that created it."}]},"ApiId":{"allOf":[{"$ref":"#/components/schemas/Id"},{"xml":{"name":"apiId"},"description":"The API ID."}]},"ApiKeySelectionExpression":{"allOf":[{"$ref":"#/components/schemas/SelectionExpression"},{"xml":{"name":"apiKeySelectionExpression"},"description":"An API key selection expression. Supported only for WebSocket APIs. See <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions\">API Key Selection Expressions</a>."}]},"CorsConfiguration":{"allOf":[{"$ref":"#/components/schemas/Cors"},{"xml":{"name":"corsConfiguration"},"description":"A CORS configuration. Supported only for HTTP APIs."}]},"CreatedDate":{"allOf":[{"$ref":"#/components/schemas/__timestampIso8601"},{"xml":{"name":"createdDate"},"description":"The timestamp when the API was created."}]},"Description":{"allOf":[{"$ref":"#/components/schemas/StringWithLengthBetween0And1024"},{"xml":{"name":"description"},"description":"The description of the API."}]},"DisableSchemaValidation":{"allOf":[{"$ref":"#/components/schemas/__boolean"},{"xml":{"name":"disableSchemaValidation"},"description":"Avoid validating models when creating a deployment. Supported only for WebSocket APIs."}]},"DisableExecuteApiEndpoint":{"allOf":[{"$ref":"#/components/schemas/__boolean"},{"xml":{"name":"disableExecuteApiEndpoint"},"description":"Specifies whether clients can invoke your API by using the default execute-api endpoint. By default, clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint."}]},"ImportInfo":{"allOf":[{"$ref":"#/components/schemas/__listOf__string"},{"xml":{"name":"importInfo"},"description":"The validation information during API import. This may include particular properties of your OpenAPI definition which are ignored during import. Supported only for HTTP APIs."}]},"Name":{"allOf":[{"$ref":"#/components/schemas/StringWithLengthBetween1And128"},{"xml":{"name":"name"},"description":"The name of the API."}]},"ProtocolType":{"allOf":[{"$ref":"#/components/schemas/ProtocolType"},{"xml":{"name":"protocolType"},"description":"The API protocol."}]},"RouteSelectionExpression":{"allOf":[{"$ref":"#/components/schemas/SelectionExpression"},{"xml":{"name":"routeSelectionExpression"},"description":"The route selection expression for the API. For HTTP APIs, the routeSelectionExpression must be ${request.method} ${request.path}. If not provided, this will be the default for HTTP APIs. This property is required for WebSocket APIs."}]},"Tags":{"allOf":[{"$ref":"#/components/schemas/Tags"},{"xml":{"name":"tags"},"description":"A collection of tags associated with the API."}]},"Version":{"allOf":[{"$ref":"#/components/schemas/StringWithLengthBetween1And64"},{"xml":{"name":"version"},"description":"A version identifier for the API."}]},"Warnings":{"allOf":[{"$ref":"#/components/schemas/__listOf__string"},{"xml":{"name":"warnings"},"description":"The warning messages reported when failonwarnings is turned on during API import."}]}},"description":"Represents an API."},"SelectionKey":{"type":"string","description":"After evaluating a selection expression, the result is compared against one or more selection keys to find a matching key. See <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions\">Selection Expressions</a> for a list of expressions and each expression's associated selection key type."},"ApiMapping":{"type":"object","required":["Stage","ApiId"],"properties":{"ApiId":{"allOf":[{"$ref":"#/components/schemas/Id"},{"xml":{"name":"apiId"},"description":"The API identifier."}]},"ApiMappingId":{"allOf":[{"$ref":"#/components/schemas/Id"},{"xml":{"name":"apiMappingId"},"description":"The API mapping identifier."}]},"ApiMappingKey":{"allOf":[{"$ref":"#/components/schemas/SelectionKey"},{"xml":{"name":"apiMappingKey"},"description":"The API mapping key."}]},"Stage":{"allOf":[{"$ref":"#/components/schemas/StringWithLengthBetween1And128"},{"xml":{"name":"stage"},"description":"The API stage."}]}},"description":"Represents an API mapping."},"AuthorizationScopes":{"type":"array","description":"A list of authorization scopes configured on a route. The scopes are used with a JWT authorizer to authorize the method invocation. The authorization works by matching the route scopes against the scopes parsed from the access token in the incoming request. The method invocation is authorized if any route scope matches a claimed scope in the access token. Otherwise, the invocation is not authorized. When the route scope is configured, the client must provide an access token instead of an identity token for authorization purposes.","items":{"$ref":"#/components/schemas/StringWithLengthBetween1And64"}},"AuthorizationType":{"type":"string","enum":["NONE","AWS_IAM","CUSTOM","JWT"],"description":"The authorization type. For WebSocket APIs, valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer. For HTTP APIs, valid values are NONE for open access, JWT for using JSON Web Tokens, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer."},"IntegerWithLengthBetween0And3600":{"type":"integer","description":"An integer with a value between [0-3600].","minimum":0,"maximum":3600},"AuthorizerType":{"type":"string","enum":["REQUEST","JWT"],"description":"The authorizer type. Specify REQUEST for a Lambda function using incoming request parameters. Specify JWT to use JSON Web Tokens (supported only for HTTP APIs)."},"IdentitySourceList":{"type":"array","description":"The identity source for which authorization is requested. For the REQUEST authorizer, this is required when authorization caching is enabled. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an Auth header, a Name query string parameter are defined as identity sources, this value is $method.request.header.Auth, $method.request.querystring.Name. These parameters will be used to derive the authorization caching key and to perform runtime validation of the REQUEST authorizer by verifying all of the identity-related request parameters are present, not null and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function, otherwise, it returns a 401 Unauthorized response without calling the Lambda function. The valid value is a string of comma-separated mapping expressions of the specified request parameters. When the authorization caching is not enabled, this property is optional.","items":{"$ref":"#/components/schemas/__string"}},"JWTConfiguration":{"type":"object","properties":{"Audience":{"allOf":[{"$ref":"#/components/schemas/__listOf__string"},{"xml":{"name":"audience"},"description":"A list of the intended recipients of the JWT. A valid JWT must provide an aud that matches at least one entry in this list. See <a href=\"https://tools.ietf.org/html/rfc7519#section-4.1.3\">RFC 7519</a>. Supported only for HTTP APIs."}]},"Issuer":{"allOf":[{"$ref":"#/components/schemas/UriWithLengthBetween1And2048"},{"xml":{"name":"issuer"},"description":"The base domain of the identity provider that issues JSON Web Tokens. For example, an Amazon Cognito user pool has the following format: https://cognito-idp.<replaceable>{region}</replaceable>.amazonaws.com/<replaceable>{userPoolId}</replaceable>\n . Required for the JWT authorizer type. Supported only for HTTP APIs."}]}},"description":"Represents the configuration of a JWT authorizer. Required for the JWT authorizer type. Supported only for HTTP APIs."},"Authorizer":{"type":"object","required":["Name"],"properties":{"AuthorizerCredentialsArn":{"allOf":[{"$ref":"#/components/schemas/Arn"},{"xml":{"name":"authorizerCredentialsArn"},"description":"Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, don't specify this parameter. Supported only for REQUEST authorizers."}]},"AuthorizerId":{"allOf":[{"$ref":"#/components/schemas/Id"},{"xml":{"name":"authorizerId"},"description":"The authorizer identifier."}]},"AuthorizerPayloadFormatVersion":{"allOf":[{"$ref":"#/components/schemas/StringWithLengthBetween1And64"},{"xml":{"name":"authorizerPayloadFormatVersion"},"description":"Specifies the format of the payload sent to an HTTP API Lambda authorizer. Required for HTTP API Lambda authorizers. Supported values are 1.0 and 2.0. To learn more, see <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html\">Working with AWS Lambda authorizers for HTTP APIs</a>."}]},"AuthorizerResultTtlInSeconds":{"allOf":[{"$ref":"#/components/schemas/IntegerWithLengthBetween0And3600"},{"xml":{"name":"authorizerResultTtlInSeconds"},"description":"The time to live (TTL) for cached authorizer results, in seconds. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway caches authorizer responses. The maximum value is 3600, or 1 hour. Supported only for HTTP API Lambda authorizers."}]},"AuthorizerType":{"allOf":[{"$ref":"#/components/schemas/AuthorizerType"},{"xml":{"name":"authorizerType"},"description":"The authorizer type. Specify REQUEST for a Lambda function using incoming request parameters. Specify JWT to use JSON Web Tokens (supported only for HTTP APIs)."}]},"AuthorizerUri":{"allOf":[{"$ref":"#/components/schemas/UriWithLengthBetween1And2048"},{"xml":{"name":"authorizerUri"},"description":"The authorizer's Uniform Resource Identifier (URI). For REQUEST authorizers, this must be a well-formed Lambda function URI, for example, arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:<replaceable>{account_id}</replaceable>:function:<replaceable>{lambda_function_name}</replaceable>/invocations. In general, the URI has this form: arn:aws:apigateway:<replaceable>{region}</replaceable>:lambda:path/<replaceable>{service_api}</replaceable>\n , where <replaceable></replaceable>{region} is the same as the region hosting the Lambda function, path indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial /. For Lambda functions, this is usually of the form /2015-03-31/functions/[FunctionARN]/invocations. Supported only for REQUEST authorizers."}]},"EnableSimpleResponses":{"allOf":[{"$ref":"#/components/schemas/__boolean"},{"xml":{"name":"enableSimpleResponses"},"description":"Specifies whether a Lambda authorizer returns a response in a simple format. If enabled, the Lambda authorizer can return a boolean value instead of an IAM policy. Supported only for HTTP APIs. To learn more, see <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html\">Working with AWS Lambda authorizers for HTTP APIs</a>"}]},"IdentitySource":{"allOf":[{"$ref":"#/components/schemas/IdentitySourceList"},{"xml":{"name":"identitySource"},"description":"<p>The identity source for which authorization is requested.</p> <p>For a REQUEST authorizer, this is optional. The value is a set of one or more mapping expressions of the specified request parameters. The identity source can be headers, query string parameters, stage variables, and context parameters. For example, if an Auth header and a Name query string parameter are defined as identity sources, this value is route.request.header.Auth, route.request.querystring.Name for WebSocket APIs. For HTTP APIs, use selection expressions prefixed with $, for example, $request.header.Auth, $request.querystring.Name. These parameters are used to perform runtime validation for Lambda-based authorizers by verifying all of the identity-related request parameters are present in the request, not null, and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function. Otherwise, it returns a 401 Unauthorized response without calling the Lambda function. For HTTP APIs, identity sources are also used as the cache key when caching is enabled. To learn more, see <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html\">Working with AWS Lambda authorizers for HTTP APIs</a>.</p> <p>For JWT, a single entry that specifies where to extract the JSON Web Token (JWT) from inbound requests. Currently only header-based and query parameter-based selections are supported, for example $request.header.Authorization.</p>"}]},"IdentityValidationExpression":{"allOf":[{"$ref":"#/components/schemas/StringWithLengthBetween0And1024"},{"xml":{"name":"identityValidationExpression"},"description":"The validation expression does not apply to the REQUEST authorizer."}]},"JwtConfiguration":{"allOf":[{"$ref":"#/components/schemas/JWTConfiguration"},{"xml":{"name":"jwtConfiguration"},"description":"Represents the configuration of a JWT authorizer. Required for the JWT authorizer type. Supported only for HTTP APIs."}]},"Name":{"allOf":[{"$ref":"#/components/schemas/StringWithLengthBetween1And128"},{"xml":{"name":"name"},"description":"The name of the authorizer."}]}},"description":"Represents an authorizer."},"ConnectionType":{"type":"string","enum":["INTERNET","VPC_LINK"],"description":"Represents a connection type."},"ContentHandlingStrategy":{"type":"string","enum":["CONVERT_TO_BINARY","CONVERT_TO_TEXT"],"description":"Specifies how to handle response payload content type conversions. Supported only for WebSocket APIs."},"CreateApiMappingRequest":{"type":"object","required":["Stage","ApiId"],"title":"CreateApiMappingRequest","properties":{"ApiId":{"allOf":[{"$ref":"#/components/schemas/Id"},{"xml":{"name":"apiId"},"description":"The API identifier."}]},"ApiMappingKey":{"allOf":[{"$ref":"#/components/schemas/SelectionKey"},{"xml":{"name":"apiMappingKey"},"description":"The API mapping key."}]},"Stage":{"allOf":[{"$ref":"#/components/schemas/StringWithLengthBetween1And128"},{"xml":{"name":"stage"},"description":"The API stage."}]}},"description":"Creates a new ApiMapping resource to represent an API mapping."},"CreateApiRequest":{"type":"object","required":["ProtocolType","Name"],"title":"CreateApiRequest","properties":{"ApiKeySelectionExpression":{"allOf":[{"$ref":"#/components/schemas/SelectionExpression"},{"xml":{"name":"apiKeySelectionExpression"},"description":"An API key selection expression. Supported only for WebSocket APIs. See <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions\">API Key Selection Expressions</a>."}]},"CorsConfiguration":{"allOf":[{"$ref":"#/components/schemas/Cors"},{"xml":{"name":"corsConfiguration"},"description":"A CORS configuration. Supported only for HTTP APIs. See <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-cors.html\">Configuring CORS</a> for more information."}]},"CredentialsArn":{"allOf":[{"$ref":"#/components/schemas/Arn"},{"xml":{"name":"credentialsArn"},"description":"This property is part of quick create. It specifies the credentials required for the integration, if any. For a Lambda integration, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify arn:aws:iam::*:user/*. To use resource-based permissions on supported AWS services, specify null. Currently, this property is not used for HTTP integrations. Supported only for HTTP APIs."}]},"Description":{"allOf":[{"$ref":"#/components/schemas/StringWithLengthBetween0And1024"},{"xml":{"name":"description"},"description":"The description of the API."}]},"DisableSchemaValidation":{"allOf":[{"$ref":"#/components/schemas/__boolean"},{"xml":{"name":"disableSchemaValidation"},"description":"Avoid validating models when creating a deployment. Supported only for WebSocket APIs."}]},"DisableExecuteApiEndpoint":{"allOf":[{"$ref":"#/components/schemas/__boolean"},{"xml":{"name":"disableExecuteApiEndpoint"},"description":"Specifies whether clients can invoke your API by using the default execute-api endpoint. By default, clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint."}]},"Name":{"allOf":[{"$ref":"#/components/schemas/StringWithLengthBetween1And128"},{"xml":{"name":"name"},"description":"The name of the API."}]},"ProtocolType":{"allOf":[{"$ref":"#/components/schemas/ProtocolType"},{"xml":{"name":"protocolType"},"description":"The API protocol."}]},"RouteKey":{"allOf":[{"$ref":"#/components/schemas/SelectionKey"},{"xml":{"name":"routeKey"},"description":"This property is part of quick create. If you don't specify a routeKey, a default route of $default is created. The $default route acts as a catch-all for any request made to your API, for a particular stage. The $default route key can't be modified. You can add routes after creating the API, and you can update the route keys of additional routes. Supported only for HTTP APIs."}]},"RouteSelectionExpression":{"allOf":[{"$ref":"#/components/schemas/SelectionExpression"},{"xml":{"name":"routeSelectionExpression"},"description":"The route selection expression for the API. For HTTP APIs, the routeSelectionExpression must be ${request.method} ${request.path}. If not provided, this will be the default for HTTP APIs. This property is required for WebSocket APIs."}]},"Tags":{"allOf":[{"$ref":"#/components/schemas/Tags"},{"xml":{"name":"tags"},"description":"The collection of tags. Each tag element is associated with a given resource."}]},"Target":{"allOf":[{"$ref":"#/components/schemas/UriWithLengthBetween1And2048"},{"xml":{"name":"target"},"description":"This property is part of quick create. Quick create produces an API with an integration, a default catch-all route, and a default stage which is configured to automatically deploy changes. For HTTP integrations, specify a fully qualified URL. For Lambda integrations, specify a function ARN. The type of the integration will be HTTP_PROXY or AWS_PROXY, respectively. Supported only for HTTP APIs."}]},"Version":{"allOf":[{"$ref":"#/components/schemas/StringWithLengthBetween1And64"},{"xml":{"name":"version"},"description":"A version identifier for the API."}]}},"description":"Creates a new Api resource to represent an API."},"CreateAuthorizerRequest":{"type":"object","required":["AuthorizerType","IdentitySource","Name"],"title":"CreateAuthorizerRequest","properties":{"AuthorizerCredentialsArn":{"allOf":[{"$ref":"#/components/schemas/Arn"},{"xml":{"name":"authorizerCredentialsArn"},"description":"Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, don't specify this parameter. Supported only for REQUEST authorizers."}]},"AuthorizerPayloadFormatVersion":{"allOf":[{"$ref":"#/components/schemas/StringWithLengthBetween1And64"},{"xml":{"name":"authorizerPayloadFormatVersion"},"description":"Specifies the format of the payload sent to an HTTP API Lambda authorizer. Required for HTTP API Lambda authorizers. Supported values are 1.0 and 2.0. To learn more, see <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html\">Working with AWS Lambda authorizers for HTTP APIs</a>."}]},"AuthorizerResultTtlInSeconds":{"allOf":[{"$ref":"#/components/schemas/IntegerWithLengthBetween0And3600"},{"xml":{"name":"authorizerResultTtlInSeconds"},"description":"The time to live (TTL) for cached authorizer results, in seconds. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway caches authorizer responses. The maximum value is 3600, or 1 hour. Supported only for HTTP API Lambda authorizers."}]},"AuthorizerType":{"allOf":[{"$ref":"#/components/schemas/AuthorizerType"},{"xml":{"name":"authorizerType"},"description":"The authorizer type. Specify REQUEST for a Lambda function using incoming request parameters. Specify JWT to use JSON Web Tokens (supported only for HTTP APIs)."}]},"AuthorizerUri":{"allOf":[{"$ref":"#/components/schemas/UriWithLengthBetween1And2048"},{"xml":{"name":"authorizerUri"},"description":"The authorizer's Uniform Resource Identifier (URI). For REQUEST authorizers, this must be a well-formed Lambda function URI, for example, arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:<replaceable>{account_id}</replaceable>:function:<replaceable>{lambda_function_name}</replaceable>/invocations. In general, the URI has this form: arn:aws:apigateway:<replaceable>{region}</replaceable>:lambda:path/<replaceable>{service_api}</replaceable>\n , where <replaceable></replaceable>{region} is the same as the region hosting the Lambda function, path indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial /. For Lambda functions, this is usually of the form /2015-03-31/functions/[FunctionARN]/invocations. Supported only for REQUEST authorizers."}]},"EnableSimpleResponses":{"allOf":[{"$ref":"#/components/schemas/__boolean"},{"xml":{"name":"enableSimpleResponses"},"description":"Specifies whether a Lambda authorizer returns a response in a simple format. By default, a Lambda authorizer must return an IAM policy. If enabled, the Lambda authorizer can return a boolean value instead of an IAM policy. Supported only for HTTP APIs. To learn more, see <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html\">Working with AWS Lambda authorizers for HTTP APIs</a>"}]},"IdentitySource":{"allOf":[{"$ref":"#/components/schemas/IdentitySourceList"},{"xml":{"name":"identitySource"},"description":"<p>The identity source for which authorization is requested.</p> <p>For a REQUEST authorizer, this is optional. The value is a set of one or more mapping expressions of the specified request parameters. The identity source can be headers, query string parameters, stage variables, and context parameters. For example, if an Auth header and a Name query string parameter are defined as identity sources, this value is route.request.header.Auth, route.request.querystring.Name for WebSocket APIs. For HTTP APIs, use selection expressions prefixed with $, for example, $request.header.Auth, $request.querystring.Name. These parameters are used to perform runtime validation for Lambda-based authorizers by verifying all of the identity-related request parameters are present in the request, not null, and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function. Otherwise, it returns a 401 Unauthorized response without calling the Lambda function. For HTTP APIs, identity sources are also used as the cache key when caching is enabled. To learn more, see <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html\">Working with AWS Lambda authorizers for HTTP APIs</a>.</p> <p>For JWT, a single entry that specifies where to extract the JSON Web Token (JWT) from inbound requests. Currently only header-based and query parameter-based selections are supported, for example $request.header.Authorization.</p>"}]},"IdentityValidationExpression":{"allOf":[{"$ref":"#/components/schemas/StringWithLengthBetween0And1024"},{"xml":{"name":"identityValidationExpression"},"description":"This parameter is not used."}]},"JwtConfiguration":{"allOf":[{"$ref":"#/components/schemas/JWTConfiguration"},{"xml":{"name":"jwtConfiguration"},"description":"Represents the configuration of a JWT authorizer. Required for the JWT authorizer type. Supported only for HTTP APIs."}]},"Name":{"allOf":[{"$ref":"#/components/schemas/StringWithLengthBetween1And128"},{"xml":{"name":"name"},"description":"The name of the authorizer."}]}},"description":"Creates a new Authorizer resource to represent an authorizer."},"CreateDeploymentRequest":{"type":"object","title":"CreateDeploymentRequest","properties":{"Description":{"allOf":[{"$ref":"#/components/schemas/StringWithLengthBetween0And1024"},{"xml":{"name":"description"},"description":"The description for the deployment resource."}]},"StageName":{"allOf":[{"$ref":"#/components/schemas/StringWithLengthBetween1And128"},{"xml":{"name":"stageName"},"description":"The name of the Stage resource for the Deployment resource to create."}]}},"description":"Creates a new Deployment resource to represent a deployment."},"DeploymentStatus":{"type":"string","enum":["PENDING","FAILED","DEPLOYED"],"description":"Represents a deployment status."},"DomainNameConfigurations":{"type":"array","description":"The domain name configurations.","items":{"$ref":"#/components/schemas/DomainNameConfiguration"}},"MutualTlsAuthenticationInput":{"type":"object","properties":{"TruststoreUri":{"allOf":[{"$ref":"#/components/schemas/UriWithLengthBetween1And2048"},{"xml":{"name":"truststoreUri"},"description":"An Amazon S3 URL that specifies the truststore for mutual TLS authentication, for example, s3://<replaceable>bucket-name</replaceable>/<replaceable>key-name</replaceable>. The truststore can contain certificates from public or private certificate authorities. To update the truststore, upload a new version to S3, and then update your custom domain name to use the new version. To update the truststore, you must have permissions to access the S3 object."}]},"TruststoreVersion":{"allOf":[{"$ref":"#/components/schemas/StringWithLengthBetween1And64"},{"xml":{"name":"truststoreVersion"},"description":"The version of the S3 object that contains your truststore. To specify a version, you must have versioning enabled for the S3 bucket."}]}}},"CreateDomainNameRequest":{"type":"object","required":["DomainName"],"title":"CreateDomainNameRequest","properties":{"DomainName":{"allOf":[{"$ref":"#/components/schemas/StringWithLengthBetween1And512"},{"xml":{"name":"domainName"},"description":"The domain name."}]},"DomainNameConfigurations":{"allOf":[{"$ref":"#/components/schemas/DomainNameConfigurations"},{"xml":{"name":"domainNameConfigurations"},"description":"The domain name configurations."}]},"MutualTlsAuthentication":{"allOf":[{"$ref":"#/components/schemas/MutualTlsAuthenticationInput"},{"xml":{"name":"mutualTlsAuthentication"},"description":"The mutual TLS authentication configuration for a custom domain name."}]},"Tags":{"allOf":[{"$ref":"#/components/schemas/Tags"},{"xml":{"name":"tags"},"description":"The collection of tags associated with a domain name."}]}},"description":"Creates a new DomainName resource to represent a domain name."},"MutualTlsAuthentication":{"type":"object","properties":{"TruststoreUri":{"allOf":[{"$ref":"#/components/schemas/UriWithLengthBetween1And2048"},{"xml":{"name":"truststoreUri"},"description":"An Amazon S3 URL that specifies the truststore for mutual TLS authentication, for example, s3://<replaceable>bucket-name</replaceable>/<replaceable>key-name</replaceable>. The truststore can contain certificates from public or private certificate authorities. To update the truststore, upload a new version to S3, and then update your custom domain name to use the new version. To update the truststore, you must have permissions to access the S3 object."}]},"TruststoreVersion":{"allOf":[{"$ref":"#/components/schemas/StringWithLengthBetween1And64"},{"xml":{"name":"truststoreVersion"},"description":"The version of the S3 object that contains your truststore. To specify a version, you must have versioning enabled for the S3 bucket."}]},"TruststoreWarnings":{"allOf":[{"$ref":"#/components/schemas/__listOf__string"},{"xml":{"name":"truststoreWarnings"},"description":"A list of warnings that API Gateway returns while processing your truststore. Invalid certificates produce warnings. Mutual TLS is still enabled, but some clients might not be able to access your API. To resolve warnings, upload a new truststore to S3, and then update you domain name to use the new version."}]}}},"IntegrationType":{"type":"string","enum":["AWS","HTTP","MOCK","HTTP_PROXY","AWS_PROXY"],"description":"Represents an API method integration type."},"PassthroughBehavior":{"type":"string","enum":["WHEN_NO_MATCH","NEVER","WHEN_NO_TEMPLATES"],"description":"Represents passthrough behavior for an integration response. Supported only for WebSocket APIs."},"TemplateMap":{"type":"object","description":"A mapping of identifier keys to templates. The value is an actual template script. The key is typically a SelectionKey which is chosen based on evaluating a selection expression.","additionalProperties":{"$ref":"#/components/schemas/StringWithLengthBetween0And32K"}},"ResponseParameters":{"type":"object","description":"Supported only for HTTP APIs. You use response parameters to transform the HTTP response from a backend integration before returning the response to clients.","additionalProperties":{"$ref":"#/components/schemas/IntegrationParameters"}},"IntegerWithLengthBetween50And30000":{"type":"integer","description":"An integer with a value between [50-30000].","minimum":50,"maximum":30000},"TlsConfigInput":{"type":"object","properties":{"ServerNameToVerify":{"allOf":[{"$ref":"#/components/schemas/StringWithLengthBetween1And512"},{"xml":{"name":"serverNameToVerify"},"description":"If you specify a server name, API Gateway uses it to verify the hostname on the integration's certificate. The server name is also included in the TLS handshake to support Server Name Indication (SNI) or virtual hosting."}]}},"description":"The TLS configuration for a private integration. If you specify a TLS configuration, private integration traffic uses the HTTPS protocol. Supported only for HTTP APIs."},"CreateIntegrationRequest":{"type":"object","required":["IntegrationType"],"title":"CreateIntegrationRequest","properties":{"ConnectionId":{"allOf":[{"$ref":"#/components/schemas/StringWithLengthBetween1And1024"},{"xml":{"name":"connectionId"},"description":"The ID of the VPC link for a private integration. Supported only for HTTP APIs."}]},"ConnectionType":{"allOf":[{"$ref":"#/components/schemas/ConnectionType"},{"xml":{"name":"connectionType"},"description":"The type of the network connection to the integration endpoint. Specify INTERNET for connections through the public routable internet or VPC_LINK for private connections between API Gateway and resources in a VPC. The default value is INTERNET."}]},"ContentHandlingStrategy":{"allOf":[{"$ref":"#/components/schemas/ContentHandlingStrategy"},{"xml":{"name":"contentHandlingStrategy"},"description":"<p>Supported only for WebSocket APIs. Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:</p> <p>CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.</p> <p>CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.</p> <p>If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.</p>"}]},"CredentialsArn":{"allOf":[{"$ref":"#/components/schemas/Arn"},{"xml":{"name":"credentialsArn"},"description":"Specifies the credentials required for the integration, if any. For AWS integrations, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify the string arn:aws:iam::*:user/*. To use resource-based permissions on supported AWS services, specify null."}]},"Description":{"allOf":[{"$ref":"#/components/schemas/StringWithLengthBetween0And1024"},{"xml":{"name":"description"},"description":"The description of the integration."}]},"IntegrationMethod":{"allOf":[{"$ref":"#/components/schemas/StringWithLengthBetween1And64"},{"xml":{"name":"integrationMethod"},"description":"Specifies the integration's HTTP method type."}]},"IntegrationSubtype":{"allOf":[{"$ref":"#/components/schemas/StringWithLengthBetween1And128"},{"xml":{"name":"integrationSubtype"},"description":"Supported only for HTTP API AWS_PROXY integrations. Specifies the AWS service action to invoke. To learn more, see <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-aws-services-reference.html\">Integration subtype reference</a>."}]},"IntegrationType":{"allOf":[{"$ref":"#/components/schemas/IntegrationType"},{"xml":{"name":"integrationType"},"description":"<p>The integration type of an integration. One of the following:</p> <p>AWS: for integrating the route or method request with an AWS service action, including the Lambda function-invoking action. With the Lambda function-invoking action, this is referred to as the Lambda custom integration. With any other AWS service action, this is known as AWS integration. Supported only for WebSocket APIs.</p> <p>AWS_PROXY: for integrating the route or method request with a Lambda function or other AWS service action. This integration is also referred to as a Lambda proxy integration.</p> <p>HTTP: for integrating the route or method request with an HTTP endpoint. This integration is also referred to as the HTTP custom integration. Supported only for WebSocket APIs.</p> <p>HTTP_PROXY: for integrating the route or method request with an HTTP endpoint, with the client request passed through as-is. This is also referred to as HTTP proxy integration. For HTTP API private integrations, use an HTTP_PROXY integration.</p> <p>MOCK: for integrating the route or method request with API Gateway as a \"loopback\" endpoint without invoking any backend. Supported only for WebSocket APIs.</p>"}]},"IntegrationUri":{"allOf":[{"$ref":"#/components/schemas/UriWithLengthBetween1And2048"},{"xml":{"name":"integrationUri"},"description":"<p>For a Lambda integration, specify the URI of a Lambda function.</p> <p>For an HTTP integration, specify a fully-qualified URL.</p> <p>For an HTTP API private integration, specify the ARN of an Application Load Balancer listener, Network Load Balancer listener, or AWS Cloud Map service. If you specify the ARN of an AWS Cloud Map service, API Gateway uses DiscoverInstances to identify resources. You can use query parameters to target specific resources. To learn more, see <a href=\"https://docs.aws.amazon.com/cloud-map/latest/api/API_DiscoverInstances.html\">DiscoverInstances</a>. For private integrations, all resources must be owned by the same AWS account.</p>"}]},"PassthroughBehavior":{"allOf":[{"$ref":"#/components/schemas/PassthroughBehavior"},{"xml":{"name":"passthroughBehavior"},"description":"<p>Specifies the pass-through behavior for incoming requests based on the Content-Type header in the request, and the available mapping templates specified as the requestTemplates property on the Integration resource. There are three valid values: WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and NEVER. Supported only for WebSocket APIs.</p> <p>WHEN_NO_MATCH passes the request body for unmapped content types through to the integration backend without transformation.</p> <p>NEVER rejects unmapped content types with an HTTP 415 Unsupported Media Type response.</p> <p>WHEN_NO_TEMPLATES allows pass-through when the integration has no content types mapped to templates. However, if there is at least one content type defined, unmapped content types will be rejected with the same HTTP 415 Unsupported Media Type response.</p>"}]},"PayloadFormatVersion":{"allOf":[{"$ref":"#/components/schemas/StringWithLengthBetween1And64"},{"xml":{"name":"payloadFormatVersion"},"description":"Specifies the format of the payload sent to an integration. Required for HTTP APIs."}]},"RequestParameters":{"allOf":[{"$ref":"#/components/schemas/IntegrationParameters"},{"xml":{"name":"requestParameters"},"description":"<p>For WebSocket APIs, a key-value map specifying request parameters that are passed from the method request to the backend. The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the backend. The method request parameter value must match the pattern of method.request.<replaceable>{location}</replaceable>.<replaceable>{name}</replaceable>\n , where \n <replaceable>{location}</replaceable>\n is querystring, path, or header; and \n <replaceable>{name}</replaceable>\n must be a valid and unique method request parameter name.</p> <p>For HTTP API integrations with a specified integrationSubtype, request parameters are a key-value map specifying parameters that are passed to AWS_PROXY integrations. You can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-aws-services.html\">Working with AWS service integrations for HTTP APIs</a>.</p> <p>For HTTP API integrations without a specified integrationSubtype request parameters are a key-value map specifying how to transform HTTP requests before sending them to the backend. The key should follow the pattern <action>:<header|querystring|path>.<location> where action can be append, overwrite or remove. For values, you can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-parameter-mapping.html\">Transforming API requests and responses</a>.</p>"}]},"RequestTemplates":{"allOf":[{"$ref":"#/components/schemas/TemplateMap"},{"xml":{"name":"requestTemplates"},"description":"Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value. Supported only for WebSocket APIs."}]},"ResponseParameters":{"allOf":[{"$ref":"#/components/schemas/ResponseParameters"},{"xml":{"name":"responseParameters"},"description":"Supported only for HTTP APIs. You use response parameters to transform the HTTP response from a backend integration before returning the response to clients. Specify a key-value map from a selection key to response parameters. The selection key must be a valid HTTP status code within the range of 200-599. Response parameters are a key-value map. The key must match pattern <action>:<header>.<location> or overwrite.statuscode. The action can be append, overwrite or remove. The value can be a static value, or map to response data, stage variables, or context variables that are evaluated at runtime. To learn more, see <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-parameter-mapping.html\">Transforming API requests and responses</a>."}]},"TemplateSelectionExpression":{"allOf":[{"$ref":"#/components/schemas/SelectionExpression"},{"xml":{"name":"templateSelectionExpression"},"description":"The template selection expression for the integration."}]},"TimeoutInMillis":{"allOf":[{"$ref":"#/components/schemas/IntegerWithLengthBetween50And30000"},{"xml":{"name":"timeoutInMillis"},"description":"Custom timeout between 50 and 29,000 milliseconds for WebSocket APIs and between 50 and 30,000 milliseconds for HTTP APIs. The default timeout is 29 seconds for WebSocket APIs and 30 seconds for HTTP APIs."}]},"TlsConfig":{"allOf":[{"$ref":"#/components/schemas/TlsConfigInput"},{"xml":{"name":"tlsConfig"},"description":"The TLS configuration for a private integration. If you specify a TLS configuration, private integration traffic uses the HTTPS protocol. Supported only for HTTP APIs."}]}},"description":"Creates a new Integration resource to represent an integration."},"TlsConfig":{"type":"object","properties":{"ServerNameToVerify":{"allOf":[{"$ref":"#/components/schemas/StringWithLengthBetween1And512"},{"xml":{"name":"serverNameToVerify"},"description":"If you specify a server name, API Gateway uses it to verify the hostname on the integration's certificate. The server name is also included in the TLS handshake to support Server Name Indication (SNI) or virtual hosting."}]}},"description":"The TLS configuration for a private integration. If you specify a TLS configuration, private integration traffic uses the HTTPS protocol. Supported only for HTTP APIs."},"CreateIntegrationResponseRequest":{"type":"object","required":["IntegrationResponseKey"],"title":"CreateIntegrationResponseRequest","properties":{"ContentHandlingStrategy":{"allOf":[{"$ref":"#/components/schemas/ContentHandlingStrategy"},{"xml":{"name":"contentHandlingStrategy"},"description":"<p>Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:</p> <p>CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.</p> <p>CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.</p> <p>If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.</p>"}]},"IntegrationResponseKey":{"allOf":[{"$ref":"#/components/schemas/SelectionKey"},{"xml":{"name":"integrationResponseKey"},"description":"The integration response key."}]},"ResponseParameters":{"allOf":[{"$ref":"#/components/schemas/IntegrationParameters"},{"xml":{"name":"responseParameters"},"description":"A key-value map specifying response parameters that are passed to the method response from the backend. The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of method.response.header.{name}, where {name} is a valid and unique header name. The mapped non-static value must match the pattern of integration.response.header.{name} or integration.response.body.{JSON-expression}, where {name} is a valid and unique response header name and {JSON-expression} is a valid JSON expression without the $ prefix."}]},"ResponseTemplates":{"allOf":[{"$ref":"#/components/schemas/TemplateMap"},{"xml":{"name":"responseTemplates"},"description":"The collection of response templates for the integration response as a string-to-string map of key-value pairs. Response templates are represented as a key/value map, with a content-type as the key and a template as the value."}]},"TemplateSelectionExpression":{"allOf":[{"$ref":"#/components/schemas/SelectionExpression"},{"xml":{"name":"templateSelectionExpression"},"description":"The template selection expression for the integration response. Supported only for WebSocket APIs."}]}},"description":"Creates a new IntegrationResponse resource to represent an integration response."},"StringWithLengthBetween1And256":{"type":"string","description":"A string with a length between [1-256]."},"CreateModelRequest":{"type":"object","required":["Schema","Name"],"title":"CreateModelRequest","properties":{"ContentType":{"allOf":[{"$ref":"#/components/schemas/StringWithLengthBetween1And256"},{"xml":{"name":"contentType"},"description":"The content-type for the model, for example, \"application/json\"."}]},"Description":{"allOf":[{"$ref":"#/components/schemas/StringWithLengthBetween0And1024"},{"xml":{"name":"description"},"description":"The description of the model."}]},"Name":{"allOf":[{"$ref":"#/components/schemas/StringWithLengthBetween1And128"},{"xml":{"name":"name"},"description":"The name of the model. Must be alphanumeric."}]},"Schema":{"allOf":[{"$ref":"#/components/schemas/StringWithLengthBetween0And32K"},{"xml":{"name":"schema"},"description":"The schema for the model. For application/json models, this should be JSON schema draft 4 model."}]}},"description":"Creates a new Model."},"RouteModels":{"type":"object","description":"The route models.","additionalProperties":{"$ref":"#/components/schemas/StringWithLengthBetween1And128"}},"RouteParameters":{"type":"object","description":"The route parameters.","additionalProperties":{"$ref":"#/components/schemas/ParameterConstraints"}},"CreateRouteRequest":{"type":"object","required":["RouteKey"],"title":"CreateRouteRequest","properties":{"ApiKeyRequired":{"allOf":[{"$ref":"#/components/schemas/__boolean"},{"xml":{"name":"apiKeyRequired"},"description":"Specifies whether an API key is required for the route. Supported only for WebSocket APIs."}]},"AuthorizationScopes":{"allOf":[{"$ref":"#/components/schemas/AuthorizationScopes"},{"xml":{"name":"authorizationScopes"},"description":"The authorization scopes supported by this route."}]},"AuthorizationType":{"allOf":[{"$ref":"#/components/schemas/AuthorizationType"},{"xml":{"name":"authorizationType"},"description":"The authorization type for the route. For WebSocket APIs, valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer For HTTP APIs, valid values are NONE for open access, JWT for using JSON Web Tokens, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer."}]},"AuthorizerId":{"allOf":[{"$ref":"#/components/schemas/Id"},{"xml":{"name":"authorizerId"},"description":"The identifier of the Authorizer resource to be associated with this route. The authorizer identifier is generated by API Gateway when you created the authorizer."}]},"ModelSelectionExpression":{"allOf":[{"$ref":"#/components/schemas/SelectionExpression"},{"xml":{"name":"modelSelectionExpression"},"description":"The model selection expression for the route. Supported only for WebSocket APIs."}]},"OperationName":{"allOf":[{"$ref":"#/components/schemas/StringWithLengthBetween1And64"},{"xml":{"name":"operationName"},"description":"The operation name for the route."}]},"RequestModels":{"allOf":[{"$ref":"#/components/schemas/RouteModels"},{"xml":{"name":"requestModels"},"description":"The request models for the route. Supported only for WebSocket APIs."}]},"RequestParameters":{"allOf":[{"$ref":"#/components/schemas/RouteParameters"},{"xml":{"name":"requestParameters"},"description":"The request parameters for the route. Supported only for WebSocket APIs."}]},"RouteKey":{"allOf":[{"$ref":"#/components/schemas/SelectionKey"},{"xml":{"name":"routeKey"},"description":"The route key for the route."}]},"RouteResponseSelectionExpression":{"allOf":[{"$ref":"#/components/schemas/SelectionExpression"},{"xml":{"name":"routeResponseSelectionExpression"},"description":"The route response selection expression for the route. Supported only for WebSocket APIs."}]},"Target":{"allOf":[{"$ref":"#/components/schemas/StringWithLengthBetween1And128"},{"xml":{"name":"target"},"description":"The target for the route."}]}},"description":"Creates a new Route resource to represent a route."},"CreateRouteResponseRequest":{"type":"object","required":["RouteResponseKey"],"title":"CreateRouteResponseRequest","properties":{"ModelSelectionExpression":{"allOf":[{"$ref":"#/components/schemas/SelectionExpression"},{"xml":{"name":"modelSelectionExpression"},"description":"The model selection expression for the route response. Supported only for WebSocket APIs."}]},"ResponseModels":{"allOf":[{"$ref":"#/components/schemas/RouteModels"},{"xml":{"name":"responseModels"},"description":"The response models for the route response."}]},"ResponseParameters":{"allOf":[{"$ref":"#/components/schemas/RouteParameters"},{"xml":{"name":"responseParameters"},"description":"The route response parameters."}]},"RouteResponseKey":{"allOf":[{"$ref":"#/components/schemas/SelectionKey"},{"xml":{"name":"routeResponseKey"},"description":"The route response key."}]}},"description":"Creates a new RouteResponse resource to represent a route response."},"RouteSettingsMap":{"type":"object","description":"The route settings map.","additionalProperties":{"$ref":"#/components/schemas/RouteSettings"}},"StageVariablesMap":{"type":"object","description":"The stage variable map.","additionalProperties":{"$ref":"#/components/schemas/StringWithLengthBetween0And2048"}},"CreateStageRequest":{"type":"object","required":["StageName"],"title":"CreateStageRequest","properties":{"AccessLogSettings":{"allOf":[{"$ref":"#/components/schemas/AccessLogSettings"},{"xml":{"name":"accessLogSettings"},"description":"Settings for logging access in this stage."}]},"AutoDeploy":{"allOf":[{"$ref":"#/components/schemas/__boolean"},{"xml":{"name":"autoDeploy"},"description":"Specifies whether updates to an API automatically trigger a new deployment. The default value is false."}]},"ClientCertificateId":{"allOf":[{"$ref":"#/components/schemas/Id"},{"xml":{"name":"clientCertificateId"},"description":"The identifier of a client certificate for a Stage. Supported only for WebSocket APIs."}]},"DefaultRouteSettings":{"allOf":[{"$ref":"#/components/schemas/RouteSettings"},{"xml":{"name":"defaultRouteSettings"},"description":"The default route settings for the stage."}]},"DeploymentId":{"allOf":[{"$ref":"#/components/schemas/Id"},{"xml":{"name":"deploymentId"},"description":"The deployment identifier of the API stage."}]},"Description":{"allOf":[{"$ref":"#/components/schemas/StringWithLengthBetween0And1024"},{"xml":{"name":"description"},"description":"The description for the API stage."}]},"RouteSettings":{"allOf":[{"$ref":"#/components/schemas/RouteSettingsMap"},{"xml":{"name":"routeSettings"},"description":"Route settings for the stage, by routeKey."}]},"StageName":{"allOf":[{"$ref":"#/components/schemas/StringWithLengthBetween1And128"},{"xml":{"name":"stageName"},"description":"The name of the stage."}]},"StageVariables":{"allOf":[{"$ref":"#/components/schemas/StageVariablesMap"},{"xml":{"name":"stageVariables"},"description":"A map that defines the stage variables for a Stage. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+."}]},"Tags":{"allOf":[{"$ref":"#/components/schemas/Tags"},{"xml":{"name":"tags"},"description":"The collection of tags. Each tag element is associated with a given resource."}]}},"description":"Creates a new Stage resource to represent a stage."},"SecurityGroupIdList":{"type":"array","description":"A list of security group IDs for the VPC link.","items":{"$ref":"#/components/schemas/__string"}},"SubnetIdList":{"type":"array","description":"A list of subnet IDs to include in the VPC link.","items":{"$ref":"#/components/schemas/__string"}},"CreateVpcLinkRequest":{"type":"object","required":["SubnetIds","Name"],"title":"CreateVpcLinkRequest","properties":{"Name":{"allOf":[{"$ref":"#/components/schemas/StringWithLengthBetween1And128"},{"xml":{"name":"name"},"description":"The name of the VPC link."}]},"SecurityGroupIds":{"allOf":[{"$ref":"#/components/schemas/SecurityGroupIdList"},{"xml":{"name":"securityGroupIds"},"description":"A list of security group IDs for the VPC link."}]},"SubnetIds":{"allOf":[{"$ref":"#/components/schemas/SubnetIdList"},{"xml":{"name":"subnetIds"},"description":"A list of subnet IDs to include in the VPC link."}]},"Tags":{"allOf":[{"$ref":"#/components/schemas/Tags"},{"xml":{"name":"tags"},"description":"A list of tags."}]}},"description":"Creates a VPC link"},"VpcLinkStatus":{"type":"string","enum":["PENDING","AVAILABLE","DELETING","FAILED","INACTIVE"],"description":"The status of the VPC link."},"VpcLinkVersion":{"type":"string","enum":["V2"],"description":"The version of the VPC link."},"DeleteAccessLogSettingsRequest":{"type":"object","title":"DeleteAccessLogSettingsRequest","properties":{}},"DeleteApiMappingRequest":{"type":"object","title":"DeleteApiMappingRequest","properties":{}},"DeleteApiRequest":{"type":"object","title":"DeleteApiRequest","properties":{}},"DeleteAuthorizerRequest":{"type":"object","title":"DeleteAuthorizerRequest","properties":{}},"DeleteCorsConfigurationRequest":{"type":"object","title":"DeleteCorsConfigurationRequest","properties":{}},"DeleteDeploymentRequest":{"type":"object","title":"DeleteDeploymentRequest","properties":{}},"DeleteDomainNameRequest":{"type":"object","title":"DeleteDomainNameRequest","properties":{}},"DeleteIntegrationRequest":{"type":"object","title":"DeleteIntegrationRequest","properties":{}},"DeleteIntegrationResponseRequest":{"type":"object","title":"DeleteIntegrationResponseRequest","properties":{}},"DeleteModelRequest":{"type":"object","title":"DeleteModelRequest","properties":{}},"DeleteRouteRequest":{"type":"object","title":"DeleteRouteRequest","properties":{}},"DeleteRouteRequestParameterRequest":{"type":"object","title":"DeleteRouteRequestParameterRequest","properties":{}},"DeleteRouteResponseRequest":{"type":"object","title":"DeleteRouteResponseRequest","properties":{}},"DeleteRouteSettingsRequest":{"type":"object","title":"DeleteRouteSettingsRequest","properties":{}},"DeleteStageRequest":{"type":"object","title":"DeleteStageRequest","properties":{}},"DeleteVpcLinkRequest":{"type":"object","title":"DeleteVpcLinkRequest","properties":{}},"Deployment":{"type":"object","properties":{"AutoDeployed":{"allOf":[{"$ref":"#/components/schemas/__boolean"},{"xml":{"name":"autoDeployed"},"description":"Specifies whether a deployment was automatically released."}]},"CreatedDate":{"allOf":[{"$ref":"#/components/schemas/__timestampIso8601"},{"xml":{"name":"createdDate"},"description":"The date and time when the Deployment resource was created."}]},"DeploymentId":{"allOf":[{"$ref":"#/components/schemas/Id"},{"xml":{"name":"deploymentId"},"description":"The identifier for the deployment."}]},"DeploymentStatus":{"allOf":[{"$ref":"#/components/schemas/DeploymentStatus"},{"xml":{"name":"deploymentStatus"},"description":"The status of the deployment: PENDING, FAILED, or SUCCEEDED."}]},"DeploymentStatusMessage":{"allOf":[{"$ref":"#/components/schemas/__string"},{"xml":{"name":"deploymentStatusMessage"},"description":"May contain additional feedback on the status of an API deployment."}]},"Description":{"allOf":[{"$ref":"#/components/schemas/StringWithLengthBetween0And1024"},{"xml":{"name":"description"},"description":"The description for the deployment."}]}},"description":"An immutable representation of an API that can be called by users. A Deployment must be associated with a Stage for it to be callable over the internet."},"DomainName":{"type":"object","required":["DomainName"],"properties":{"ApiMappingSelectionExpression":{"allOf":[{"$ref":"#/components/schemas/SelectionExpression"},{"xml":{"name":"apiMappingSelectionExpression"},"description":"The API mapping selection expression."}]},"DomainName":{"allOf":[{"$ref":"#/components/schemas/StringWithLengthBetween1And512"},{"xml":{"name":"domainName"},"description":"The name of the DomainName resource."}]},"DomainNameConfigurations":{"allOf":[{"$ref":"#/components/schemas/DomainNameConfigurations"},{"xml":{"name":"domainNameConfigurations"},"description":"The domain name configurations."}]},"MutualTlsAuthentication":{"allOf":[{"$ref":"#/components/schemas/MutualTlsAuthentication"},{"xml":{"name":"mutualTlsAuthentication"},"description":"The mutual TLS authentication configuration for a custom domain name."}]},"Tags":{"allOf":[{"$ref":"#/components/schemas/Tags"},{"xml":{"name":"tags"},"description":"The collection of tags associated with a domain name."}]}},"description":"Represents a domain name."},"DomainNameStatus":{"type":"string","enum":["AVAILABLE","UPDATING","PENDING_CERTIFICATE_REIMPORT","PENDING_OWNERSHIP_VERIFICATION"],"description":"The status of the domain name migration. The valid values are AVAILABLE, UPDATING, PENDING_CERTIFICATE_REIMPORT, and PENDING_OWNERSHIP_VERIFICATION. If the status is UPDATING, the domain cannot be modified further until the existing operation is complete. If it is AVAILABLE, the domain can be updated."},"EndpointType":{"type":"string","enum":["REGIONAL","EDGE"],"description":"Represents an endpoint type."},"SecurityPolicy":{"type":"string","enum":["TLS_1_0","TLS_1_2"],"description":"The Transport Layer Security (TLS) version of the security policy for this domain name. The valid values are TLS_1_0 and TLS_1_2."},"ExportApiRequest":{"type":"object","title":"ExportApiRequest","properties":{}},"ExportedApi":{"type":"string","description":"Represents an exported definition of an API in a particular output format, for example, YAML. The API is serialized to the requested specification, for example, OpenAPI 3.0."},"ResetAuthorizersCacheRequest":{"type":"object","title":"ResetAuthorizersCacheRequest","properties":{}},"GetApiMappingRequest":{"type":"object","title":"GetApiMappingRequest","properties":{}},"GetApiMappingsRequest":{"type":"object","title":"GetApiMappingsRequest","properties":{}},"__listOfApiMapping":{"type":"array","items":{"$ref":"#/components/schemas/ApiMapping"}},"NextToken":{"type":"string","description":"The next page of elements from this collection. Not valid for the last element of the collection."},"GetApiRequest":{"type":"object","title":"GetApiRequest","properties":{}},"GetApisRequest":{"type":"object","title":"GetApisRequest","properties":{}},"__listOfApi":{"type":"array","items":{"$ref":"#/components/schemas/Api"}},"GetAuthorizerRequest":{"type":"object","title":"GetAuthorizerRequest","properties":{}},"GetAuthorizersRequest":{"type":"object","title":"GetAuthorizersRequest","properties":{}},"__listOfAuthorizer":{"type":"array","items":{"$ref":"#/components/schemas/Authorizer"}},"GetDeploymentRequest":{"type":"object","title":"GetDeploymentRequest","properties":{}},"GetDeploymentsRequest":{"type":"object","title":"GetDeploymentsRequest","properties":{}},"__listOfDeployment":{"type":"array","items":{"$ref":"#/components/schemas/Deployment"}},"GetDomainNameRequest":{"type":"object","title":"GetDomainNameRequest","properties":{}},"GetDomainNamesRequest":{"type":"object","title":"GetDomainNamesRequest","properties":{}},"__listOfDomainName":{"type":"array","items":{"$ref":"#/components/schemas/DomainName"}},"GetIntegrationRequest":{"type":"object","title":"GetIntegrationRequest","properties":{}},"GetIntegrationResponseRequest":{"type":"object","title":"GetIntegrationResponseRequest","properties":{}},"GetIntegrationResponsesRequest":{"type":"object","title":"GetIntegrationResponsesRequest","properties":{}},"__listOfIntegrationResponse":{"type":"array","items":{"$ref":"#/components/schemas/IntegrationResponse"}},"GetIntegrationsRequest":{"type":"object","title":"GetIntegrationsRequest","properties":{}},"__listOfIntegration":{"type":"array","items":{"$ref":"#/components/schemas/Integration"}},"GetModelRequest":{"type":"object","title":"GetModelRequest","properties":{}},"GetModelTemplateRequest":{"type":"object","title":"GetModelTemplateRequest","properties":{}},"GetModelsRequest":{"type":"object","title":"GetModelsRequest","properties":{}},"__listOfModel":{"type":"array","items":{"$ref":"#/components/schemas/Model"}},"GetRouteRequest":{"type":"object","title":"GetRouteRequest","properties":{}},"GetRouteResponseRequest":{"type":"object","title":"GetRouteResponseRequest","properties":{}},"GetRouteResponsesRequest":{"type":"object","title":"GetRouteResponsesRequest","properties":{}},"__listOfRouteResponse":{"type":"array","items":{"$ref":"#/components/schemas/RouteResponse"}},"GetRoutesRequest":{"type":"object","title":"GetRoutesRequest","properties":{}},"__listOfRoute":{"type":"array","items":{"$ref":"#/components/schemas/Route"}},"GetStageRequest":{"type":"object","title":"GetStageRequest","properties":{}},"GetStagesRequest":{"type":"object","title":"GetStagesRequest","properties":{}},"__listOfStage":{"type":"array","items":{"$ref":"#/components/schemas/Stage"}},"GetTagsRequest":{"type":"object","title":"GetTagsRequest","properties":{}},"GetVpcLinkRequest":{"type":"object","title":"GetVpcLinkRequest","properties":{}},"GetVpcLinksRequest":{"type":"object","title":"GetVpcLinksRequest","properties":{}},"__listOfVpcLink":{"type":"array","items":{"$ref":"#/components/schemas/VpcLink"}},"ImportApiRequest":{"type":"object","required":["Body"],"title":"ImportApiRequest","properties":{"Body":{"allOf":[{"$ref":"#/components/schemas/__string"},{"xml":{"name":"body"},"description":"The OpenAPI definition. Supported only for HTTP APIs."}]}},"description":""},"Integration":{"type":"object","properties":{"ApiGatewayManaged":{"allOf":[{"$ref":"#/components/schemas/__boolean"},{"xml":{"name":"apiGatewayManaged"},"description":"Specifies whether an integration is managed by API Gateway. If you created an API using using quick create, the resulting integration is managed by API Gateway. You can update a managed integration, but you can't delete it."}]},"ConnectionId":{"allOf":[{"$ref":"#/components/schemas/StringWithLengthBetween1And1024"},{"xml":{"name":"connectionId"},"description":"The ID of the VPC link for a private integration. Supported only for HTTP APIs."}]},"ConnectionType":{"allOf":[{"$ref":"#/components/schemas/ConnectionType"},{"xml":{"name":"connectionType"},"description":"The type of the network connection to the integration endpoint. Specify INTERNET for connections through the public routable internet or VPC_LINK for private connections between API Gateway and resources in a VPC. The default value is INTERNET."}]},"ContentHandlingStrategy":{"allOf":[{"$ref":"#/components/schemas/ContentHandlingStrategy"},{"xml":{"name":"contentHandlingStrategy"},"description":"<p>Supported only for WebSocket APIs. Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:</p> <p>CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.</p> <p>CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.</p> <p>If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.</p>"}]},"CredentialsArn":{"allOf":[{"$ref":"#/components/schemas/Arn"},{"xml":{"name":"credentialsArn"},"description":"Specifies the credentials required for the integration, if any. For AWS integrations, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify the string arn:aws:iam::*:user/*. To use resource-based permissions on supported AWS services, specify null."}]},"Description":{"allOf":[{"$ref":"#/components/schemas/StringWithLengthBetween0And1024"},{"xml":{"name":"description"},"description":"Represents the description of an integration."}]},"IntegrationId":{"allOf":[{"$ref":"#/components/schemas/Id"},{"xml":{"name":"integrationId"},"description":"Represents the identifier of an integration."}]},"IntegrationMethod":{"allOf":[{"$ref":"#/components/schemas/StringWithLengthBetween1And64"},{"xml":{"name":"integrationMethod"},"description":"Specifies the integration's HTTP method type."}]},"IntegrationResponseSelectionExpression":{"allOf":[{"$ref":"#/components/schemas/SelectionExpression"},{"xml":{"name":"integrationResponseSelectionExpression"},"description":"The integration response selection expression for the integration. Supported only for WebSocket APIs. See <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-integration-response-selection-expressions\">Integration Response Selection Expressions</a>."}]},"IntegrationSubtype":{"allOf":[{"$ref":"#/components/schemas/StringWithLengthBetween1And128"},{"xml":{"name":"integrationSubtype"},"description":"Supported only for HTTP API AWS_PROXY integrations. Specifies the AWS service action to invoke. To learn more, see <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-aws-services-reference.html\">Integration subtype reference</a>."}]},"IntegrationType":{"allOf":[{"$ref":"#/components/schemas/IntegrationType"},{"xml":{"name":"integrationType"},"description":"<p>The integration type of an integration. One of the following:</p> <p>AWS: for integrating the route or method request with an AWS service action, including the Lambda function-invoking action. With the Lambda function-invoking action, this is referred to as the Lambda custom integration. With any other AWS service action, this is known as AWS integration. Supported only for WebSocket APIs.</p> <p>AWS_PROXY: for integrating the route or method request with a Lambda function or other AWS service action. This integration is also referred to as a Lambda proxy integration.</p> <p>HTTP: for integrating the route or method request with an HTTP endpoint. This integration is also referred to as the HTTP custom integration. Supported only for WebSocket APIs.</p> <p>HTTP_PROXY: for integrating the route or method request with an HTTP endpoint, with the client request passed through as-is. This is also referred to as HTTP proxy integration.</p> <p>MOCK: for integrating the route or method request with API Gateway as a \"loopback\" endpoint without invoking any backend. Supported only for WebSocket APIs.</p>"}]},"IntegrationUri":{"allOf":[{"$ref":"#/components/schemas/UriWithLengthBetween1And2048"},{"xml":{"name":"integrationUri"},"description":"<p>For a Lambda integration, specify the URI of a Lambda function.</p> <p>For an HTTP integration, specify a fully-qualified URL.</p> <p>For an HTTP API private integration, specify the ARN of an Application Load Balancer listener, Network Load Balancer listener, or AWS Cloud Map service. If you specify the ARN of an AWS Cloud Map service, API Gateway uses DiscoverInstances to identify resources. You can use query parameters to target specific resources. To learn more, see <a href=\"https://docs.aws.amazon.com/cloud-map/latest/api/API_DiscoverInstances.html\">DiscoverInstances</a>. For private integrations, all resources must be owned by the same AWS account.</p>"}]},"PassthroughBehavior":{"allOf":[{"$ref":"#/components/schemas/PassthroughBehavior"},{"xml":{"name":"passthroughBehavior"},"description":"<p>Specifies the pass-through behavior for incoming requests based on the Content-Type header in the request, and the available mapping templates specified as the requestTemplates property on the Integration resource. There are three valid values: WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and NEVER. Supported only for WebSocket APIs.</p> <p>WHEN_NO_MATCH passes the request body for unmapped content types through to the integration backend without transformation.</p> <p>NEVER rejects unmapped content types with an HTTP 415 Unsupported Media Type response.</p> <p>WHEN_NO_TEMPLATES allows pass-through when the integration has no content types mapped to templates. However, if there is at least one content type defined, unmapped content types will be rejected with the same HTTP 415 Unsupported Media Type response.</p>"}]},"PayloadFormatVersion":{"allOf":[{"$ref":"#/components/schemas/StringWithLengthBetween1And64"},{"xml":{"name":"payloadFormatVersion"},"description":"Specifies the format of the payload sent to an integration. Required for HTTP APIs."}]},"RequestParameters":{"allOf":[{"$ref":"#/components/schemas/IntegrationParameters"},{"xml":{"name":"requestParameters"},"description":"<p>For WebSocket APIs, a key-value map specifying request parameters that are passed from the method request to the backend. The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the backend. The method request parameter value must match the pattern of method.request.<replaceable>{location}</replaceable>.<replaceable>{name}</replaceable>\n , where \n <replaceable>{location}</replaceable>\n is querystring, path, or header; and \n <replaceable>{name}</replaceable>\n must be a valid and unique method request parameter name.</p> <p>For HTTP API integrations with a specified integrationSubtype, request parameters are a key-value map specifying parameters that are passed to AWS_PROXY integrations. You can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-aws-services.html\">Working with AWS service integrations for HTTP APIs</a>.</p> <p>For HTTP API itegrations, without a specified integrationSubtype request parameters are a key-value map specifying how to transform HTTP requests before sending them to backend integrations. The key should follow the pattern <action>:<header|querystring|path>.<location>. The action can be append, overwrite or remove. For values, you can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-parameter-mapping.html\">Transforming API requests and responses</a>.</p>"}]},"RequestTemplates":{"allOf":[{"$ref":"#/components/schemas/TemplateMap"},{"xml":{"name":"requestTemplates"},"description":"Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value. Supported only for WebSocket APIs."}]},"ResponseParameters":{"allOf":[{"$ref":"#/components/schemas/ResponseParameters"},{"xml":{"name":"responseParameters"},"description":"Supported only for HTTP APIs. You use response parameters to transform the HTTP response from a backend integration before returning the response to clients. Specify a key-value map from a selection key to response parameters. The selection key must be a valid HTTP status code within the range of 200-599. Response parameters are a key-value map. The key must match pattern <action>:<header>.<location> or overwrite.statuscode. The action can be append, overwrite or remove. The value can be a static value, or map to response data, stage variables, or context variables that are evaluated at runtime. To learn more, see <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-parameter-mapping.html\">Transforming API requests and responses</a>."}]},"TemplateSelectionExpression":{"allOf":[{"$ref":"#/components/schemas/SelectionExpression"},{"xml":{"name":"templateSelectionExpression"},"description":"The template selection expression for the integration. Supported only for WebSocket APIs."}]},"TimeoutInMillis":{"allOf":[{"$ref":"#/components/schemas/IntegerWithLengthBetween50And30000"},{"xml":{"name":"timeoutInMillis"},"description":"Custom timeout between 50 and 29,000 milliseconds for WebSocket APIs and between 50 and 30,000 milliseconds for HTTP APIs. The default timeout is 29 seconds for WebSocket APIs and 30 seconds for HTTP APIs."}]},"TlsConfig":{"allOf":[{"$ref":"#/components/schemas/TlsConfig"},{"xml":{"name":"tlsConfig"},"description":"The TLS configuration for a private integration. If you specify a TLS configuration, private integration traffic uses the HTTPS protocol. Supported only for HTTP APIs."}]}},"description":"Represents an integration."},"IntegrationResponse":{"type":"object","required":["IntegrationResponseKey"],"properties":{"ContentHandlingStrategy":{"allOf":[{"$ref":"#/components/schemas/ContentHandlingStrategy"},{"xml":{"name":"contentHandlingStrategy"},"description":"<p>Supported only for WebSocket APIs. Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:</p> <p>CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.</p> <p>CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.</p> <p>If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.</p>"}]},"IntegrationResponseId":{"allOf":[{"$ref":"#/components/schemas/Id"},{"xml":{"name":"integrationResponseId"},"description":"The integration response ID."}]},"IntegrationResponseKey":{"allOf":[{"$ref":"#/components/schemas/SelectionKey"},{"xml":{"name":"integrationResponseKey"},"description":"The integration response key."}]},"ResponseParameters":{"allOf":[{"$ref":"#/components/schemas/IntegrationParameters"},{"xml":{"name":"responseParameters"},"description":"A key-value map specifying response parameters that are passed to the method response from the backend. The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of method.response.header.{name}, where name is a valid and unique header name. The mapped non-static value must match the pattern of integration.response.header.{name} or integration.response.body.{JSON-expression}, where name is a valid and unique response header name and JSON-expression is a valid JSON expression without the $ prefix."}]},"ResponseTemplates":{"allOf":[{"$ref":"#/components/schemas/TemplateMap"},{"xml":{"name":"responseTemplates"},"description":"The collection of response templates for the integration response as a string-to-string map of key-value pairs. Response templates are represented as a key/value map, with a content-type as the key and a template as the value."}]},"TemplateSelectionExpression":{"allOf":[{"$ref":"#/components/schemas/SelectionExpression"},{"xml":{"name":"templateSelectionExpression"},"description":"The template selection expressions for the integration response."}]}},"description":"Represents an integration response."},"Model":{"type":"object","required":["Name"],"properties":{"ContentType":{"allOf":[{"$ref":"#/components/schemas/StringWithLengthBetween1And256"},{"xml":{"name":"contentType"},"description":"The content-type for the model, for example, \"application/json\"."}]},"Description":{"allOf":[{"$ref":"#/components/schemas/StringWithLengthBetween0And1024"},{"xml":{"name":"description"},"description":"The description of the model."}]},"ModelId":{"allOf":[{"$ref":"#/components/schemas/Id"},{"xml":{"name":"modelId"},"description":"The model identifier."}]},"Name":{"allOf":[{"$ref":"#/components/schemas/StringWithLengthBetween1And128"},{"xml":{"name":"name"},"description":"The name of the model. Must be alphanumeric."}]},"Schema":{"allOf":[{"$ref":"#/components/schemas/StringWithLengthBetween0And32K"},{"xml":{"name":"schema"},"description":"The schema for the model. For application/json models, this should be JSON schema draft 4 model."}]}},"description":"Represents a data model for an API. Supported only for WebSocket APIs. See <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/models-mappings.html\">Create Models and Mapping Templates for Request and Response Mappings</a>."},"ReimportApiRequest":{"type":"object","required":["Body"],"title":"ReimportApiRequest","properties":{"Body":{"allOf":[{"$ref":"#/components/schemas/__string"},{"xml":{"name":"body"},"description":"The OpenAPI definition. Supported only for HTTP APIs."}]}},"description":""},"Route":{"type":"object","required":["RouteKey"],"properties":{"ApiGatewayManaged":{"allOf":[{"$ref":"#/components/schemas/__boolean"},{"xml":{"name":"apiGatewayManaged"},"description":"Specifies whether a route is managed by API Gateway. If you created an API using quick create, the $default route is managed by API Gateway. You can't modify the $default route key."}]},"ApiKeyRequired":{"allOf":[{"$ref":"#/components/schemas/__boolean"},{"xml":{"name":"apiKeyRequired"},"description":"Specifies whether an API key is required for this route. Supported only for WebSocket APIs."}]},"AuthorizationScopes":{"allOf":[{"$ref":"#/components/schemas/AuthorizationScopes"},{"xml":{"name":"authorizationScopes"},"description":"A list of authorization scopes configured on a route. The scopes are used with a JWT authorizer to authorize the method invocation. The authorization works by matching the route scopes against the scopes parsed from the access token in the incoming request. The method invocation is authorized if any route scope matches a claimed scope in the access token. Otherwise, the invocation is not authorized. When the route scope is configured, the client must provide an access token instead of an identity token for authorization purposes."}]},"AuthorizationType":{"allOf":[{"$ref":"#/components/schemas/AuthorizationType"},{"xml":{"name":"authorizationType"},"description":"The authorization type for the route. For WebSocket APIs, valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer For HTTP APIs, valid values are NONE for open access, JWT for using JSON Web Tokens, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer."}]},"AuthorizerId":{"allOf":[{"$ref":"#/components/schemas/Id"},{"xml":{"name":"authorizerId"},"description":"The identifier of the Authorizer resource to be associated with this route. The authorizer identifier is generated by API Gateway when you created the authorizer."}]},"ModelSelectionExpression":{"allOf":[{"$ref":"#/components/schemas/SelectionExpression"},{"xml":{"name":"modelSelectionExpression"},"description":"The model selection expression for the route. Supported only for WebSocket APIs."}]},"OperationName":{"allOf":[{"$ref":"#/components/schemas/StringWithLengthBetween1And64"},{"xml":{"name":"operationName"},"description":"The operation name for the route."}]},"RequestModels":{"allOf":[{"$ref":"#/components/schemas/RouteModels"},{"xml":{"name":"requestModels"},"description":"The request models for the route. Supported only for WebSocket APIs."}]},"RequestParameters":{"allOf":[{"$ref":"#/components/schemas/RouteParameters"},{"xml":{"name":"requestParameters"},"description":"The request parameters for the route. Supported only for WebSocket APIs."}]},"RouteId":{"allOf":[{"$ref":"#/components/schemas/Id"},{"xml":{"name":"routeId"},"description":"The route ID."}]},"RouteKey":{"allOf":[{"$ref":"#/components/schemas/SelectionKey"},{"xml":{"name":"routeKey"},"description":"The route key for the route."}]},"RouteResponseSelectionExpression":{"allOf":[{"$ref":"#/components/schemas/SelectionExpression"},{"xml":{"name":"routeResponseSelectionExpression"},"description":"The route response selection expression for the route. Supported only for WebSocket APIs."}]},"Target":{"allOf":[{"$ref":"#/components/schemas/StringWithLengthBetween1And128"},{"xml":{"name":"target"},"description":"The target for the route."}]}},"description":"Represents a route."},"RouteResponse":{"type":"object","required":["RouteResponseKey"],"properties":{"ModelSelectionExpression":{"allOf":[{"$ref":"#/components/schemas/SelectionExpression"},{"xml":{"name":"modelSelectionExpression"},"description":"Represents the model selection expression of a route response. Supported only for WebSocket APIs."}]},"ResponseModels":{"allOf":[{"$ref":"#/components/schemas/RouteModels"},{"xml":{"name":"responseModels"},"description":"Represents the response models of a route response."}]},"ResponseParameters":{"allOf":[{"$ref":"#/components/schemas/RouteParameters"},{"xml":{"name":"responseParameters"},"description":"Represents the response parameters of a route response."}]},"RouteResponseId":{"allOf":[{"$ref":"#/components/schemas/Id"},{"xml":{"name":"routeResponseId"},"description":"Represents the identifier of a route response."}]},"RouteResponseKey":{"allOf":[{"$ref":"#/components/schemas/SelectionKey"},{"xml":{"name":"routeResponseKey"},"description":"Represents the route response key of a route response."}]}},"description":"Represents a route response."},"Stage":{"type":"object","required":["StageName"],"properties":{"AccessLogSettings":{"allOf":[{"$ref":"#/components/schemas/AccessLogSettings"},{"xml":{"name":"accessLogSettings"},"description":"Settings for logging access in this stage."}]},"ApiGatewayManaged":{"allOf":[{"$ref":"#/components/schemas/__boolean"},{"xml":{"name":"apiGatewayManaged"},"description":"Specifies whether a stage is managed by API Gateway. If you created an API using quick create, the $default stage is managed by API Gateway. You can't modify the $default stage."}]},"AutoDeploy":{"allOf":[{"$ref":"#/components/schemas/__boolean"},{"xml":{"name":"autoDeploy"},"description":"Specifies whether updates to an API automatically trigger a new deployment. The default value is false."}]},"ClientCertificateId":{"allOf":[{"$ref":"#/components/schemas/Id"},{"xml":{"name":"clientCertificateId"},"description":"The identifier of a client certificate for a Stage. Supported only for WebSocket APIs."}]},"CreatedDate":{"allOf":[{"$ref":"#/components/schemas/__timestampIso8601"},{"xml":{"name":"createdDate"},"description":"The timestamp when the stage was created."}]},"DefaultRouteSettings":{"allOf":[{"$ref":"#/components/schemas/RouteSettings"},{"xml":{"name":"defaultRouteSettings"},"description":"Default route settings for the stage."}]},"DeploymentId":{"allOf":[{"$ref":"#/components/schemas/Id"},{"xml":{"name":"deploymentId"},"description":"The identifier of the Deployment that the Stage is associated with. Can't be updated if autoDeploy is enabled."}]},"Description":{"allOf":[{"$ref":"#/components/schemas/StringWithLengthBetween0And1024"},{"xml":{"name":"description"},"description":"The description of the stage."}]},"LastDeploymentStatusMessage":{"allOf":[{"$ref":"#/components/schemas/__string"},{"xml":{"name":"lastDeploymentStatusMessage"},"description":"Describes the status of the last deployment of a stage. Supported only for stages with autoDeploy enabled."}]},"LastUpdatedDate":{"allOf":[{"$ref":"#/components/schemas/__timestampIso8601"},{"xml":{"name":"lastUpdatedDate"},"description":"The timestamp when the stage was last updated."}]},"RouteSettings":{"allOf":[{"$ref":"#/components/schemas/RouteSettingsMap"},{"xml":{"name":"routeSettings"},"description":"Route settings for the stage, by routeKey."}]},"StageName":{"allOf":[{"$ref":"#/components/schemas/StringWithLengthBetween1And128"},{"xml":{"name":"stageName"},"description":"The name of the stage."}]},"StageVariables":{"allOf":[{"$ref":"#/components/schemas/StageVariablesMap"},{"xml":{"name":"stageVariables"},"description":"A map that defines the stage variables for a stage resource. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+."}]},"Tags":{"allOf":[{"$ref":"#/components/schemas/Tags"},{"xml":{"name":"tags"},"description":"The collection of tags. Each tag element is associated with a given resource."}]}},"description":"Represents an API stage."},"TagResourceRequest":{"type":"object","title":"TagResourceRequest","properties":{"Tags":{"allOf":[{"$ref":"#/components/schemas/Tags"},{"xml":{"name":"tags"},"description":"The collection of tags. Each tag element is associated with a given resource."}]}},"description":"Creates a new Tag resource to represent a tag."},"UntagResourceRequest":{"type":"object","title":"UntagResourceRequest","properties":{}},"UpdateApiMappingRequest":{"type":"object","required":["ApiId"],"title":"UpdateApiMappingRequest","properties":{"ApiId":{"allOf":[{"$ref":"#/components/schemas/Id"},{"xml":{"name":"apiId"},"description":"The API identifier."}]},"ApiMappingKey":{"allOf":[{"$ref":"#/components/schemas/SelectionKey"},{"xml":{"name":"apiMappingKey"},"description":"The API mapping key."}]},"Stage":{"allOf":[{"$ref":"#/components/schemas/StringWithLengthBetween1And128"},{"xml":{"name":"stage"},"description":"The API stage."}]}},"description":"Updates an ApiMapping."},"UpdateApiRequest":{"type":"object","title":"UpdateApiRequest","properties":{"ApiKeySelectionExpression":{"allOf":[{"$ref":"#/components/schemas/SelectionExpression"},{"xml":{"name":"apiKeySelectionExpression"},"description":"An API key selection expression. Supported only for WebSocket APIs. See <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions\">API Key Selection Expressions</a>."}]},"CorsConfiguration":{"allOf":[{"$ref":"#/components/schemas/Cors"},{"xml":{"name":"corsConfiguration"},"description":"A CORS configuration. Supported only for HTTP APIs."}]},"CredentialsArn":{"allOf":[{"$ref":"#/components/schemas/Arn"},{"xml":{"name":"credentialsArn"},"description":"This property is part of quick create. It specifies the credentials required for the integration, if any. For a Lambda integration, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify arn:aws:iam::*:user/*. To use resource-based permissions on supported AWS services, don't specify this parameter. Currently, this property is not used for HTTP integrations. If provided, this value replaces the credentials associated with the quick create integration. Supported only for HTTP APIs."}]},"Description":{"allOf":[{"$ref":"#/components/schemas/StringWithLengthBetween0And1024"},{"xml":{"name":"description"},"description":"The description of the API."}]},"DisableSchemaValidation":{"allOf":[{"$ref":"#/components/schemas/__boolean"},{"xml":{"name":"disableSchemaValidation"},"description":"Avoid validating models when creating a deployment. Supported only for WebSocket APIs."}]},"DisableExecuteApiEndpoint":{"allOf":[{"$ref":"#/components/schemas/__boolean"},{"xml":{"name":"disableExecuteApiEndpoint"},"description":"Specifies whether clients can invoke your API by using the default execute-api endpoint. By default, clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint."}]},"Name":{"allOf":[{"$ref":"#/components/schemas/StringWithLengthBetween1And128"},{"xml":{"name":"name"},"description":"The name of the API."}]},"RouteKey":{"allOf":[{"$ref":"#/components/schemas/SelectionKey"},{"xml":{"name":"routeKey"},"description":"This property is part of quick create. If not specified, the route created using quick create is kept. Otherwise, this value replaces the route key of the quick create route. Additional routes may still be added after the API is updated. Supported only for HTTP APIs."}]},"RouteSelectionExpression":{"allOf":[{"$ref":"#/components/schemas/SelectionExpression"},{"xml":{"name":"routeSelectionExpression"},"description":"The route selection expression for the API. For HTTP APIs, the routeSelectionExpression must be ${request.method} ${request.path}. If not provided, this will be the default for HTTP APIs. This property is required for WebSocket APIs."}]},"Target":{"allOf":[{"$ref":"#/components/schemas/UriWithLengthBetween1And2048"},{"xml":{"name":"target"},"description":"This property is part of quick create. For HTTP integrations, specify a fully qualified URL. For Lambda integrations, specify a function ARN. The type of the integration will be HTTP_PROXY or AWS_PROXY, respectively. The value provided updates the integration URI and integration type. You can update a quick-created target, but you can't remove it from an API. Supported only for HTTP APIs."}]},"Version":{"allOf":[{"$ref":"#/components/schemas/StringWithLengthBetween1And64"},{"xml":{"name":"version"},"description":"A version identifier for the API."}]}},"description":"Updates an Api."},"UpdateAuthorizerRequest":{"type":"object","title":"UpdateAuthorizerRequest","properties":{"AuthorizerCredentialsArn":{"allOf":[{"$ref":"#/components/schemas/Arn"},{"xml":{"name":"authorizerCredentialsArn"},"description":"Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, don't specify this parameter."}]},"AuthorizerPayloadFormatVersion":{"allOf":[{"$ref":"#/components/schemas/StringWithLengthBetween1And64"},{"xml":{"name":"authorizerPayloadFormatVersion"},"description":"Specifies the format of the payload sent to an HTTP API Lambda authorizer. Required for HTTP API Lambda authorizers. Supported values are 1.0 and 2.0. To learn more, see <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html\">Working with AWS Lambda authorizers for HTTP APIs</a>."}]},"AuthorizerResultTtlInSeconds":{"allOf":[{"$ref":"#/components/schemas/IntegerWithLengthBetween0And3600"},{"xml":{"name":"authorizerResultTtlInSeconds"},"description":"The time to live (TTL) for cached authorizer results, in seconds. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway caches authorizer responses. The maximum value is 3600, or 1 hour. Supported only for HTTP API Lambda authorizers."}]},"AuthorizerType":{"allOf":[{"$ref":"#/components/schemas/AuthorizerType"},{"xml":{"name":"authorizerType"},"description":"The authorizer type. Specify REQUEST for a Lambda function using incoming request parameters. Specify JWT to use JSON Web Tokens (supported only for HTTP APIs)."}]},"AuthorizerUri":{"allOf":[{"$ref":"#/components/schemas/UriWithLengthBetween1And2048"},{"xml":{"name":"authorizerUri"},"description":"The authorizer's Uniform Resource Identifier (URI). For REQUEST authorizers, this must be a well-formed Lambda function URI, for example, arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:<replaceable>{account_id}</replaceable>:function:<replaceable>{lambda_function_name}</replaceable>/invocations. In general, the URI has this form: arn:aws:apigateway:<replaceable>{region}</replaceable>:lambda:path/<replaceable>{service_api}</replaceable>\n , where <replaceable></replaceable>{region} is the same as the region hosting the Lambda function, path indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial /. For Lambda functions, this is usually of the form /2015-03-31/functions/[FunctionARN]/invocations. Supported only for REQUEST authorizers."}]},"EnableSimpleResponses":{"allOf":[{"$ref":"#/components/schemas/__boolean"},{"xml":{"name":"enableSimpleResponses"},"description":"Specifies whether a Lambda authorizer returns a response in a simple format. By default, a Lambda authorizer must return an IAM policy. If enabled, the Lambda authorizer can return a boolean value instead of an IAM policy. Supported only for HTTP APIs. To learn more, see <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html\">Working with AWS Lambda authorizers for HTTP APIs</a>"}]},"IdentitySource":{"allOf":[{"$ref":"#/components/schemas/IdentitySourceList"},{"xml":{"name":"identitySource"},"description":"<p>The identity source for which authorization is requested.</p> <p>For a REQUEST authorizer, this is optional. The value is a set of one or more mapping expressions of the specified request parameters. The identity source can be headers, query string parameters, stage variables, and context parameters. For example, if an Auth header and a Name query string parameter are defined as identity sources, this value is route.request.header.Auth, route.request.querystring.Name for WebSocket APIs. For HTTP APIs, use selection expressions prefixed with $, for example, $request.header.Auth, $request.querystring.Name. These parameters are used to perform runtime validation for Lambda-based authorizers by verifying all of the identity-related request parameters are present in the request, not null, and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function. Otherwise, it returns a 401 Unauthorized response without calling the Lambda function. For HTTP APIs, identity sources are also used as the cache key when caching is enabled. To learn more, see <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html\">Working with AWS Lambda authorizers for HTTP APIs</a>.</p> <p>For JWT, a single entry that specifies where to extract the JSON Web Token (JWT) from inbound requests. Currently only header-based and query parameter-based selections are supported, for example $request.header.Authorization.</p>"}]},"IdentityValidationExpression":{"allOf":[{"$ref":"#/components/schemas/StringWithLengthBetween0And1024"},{"xml":{"name":"identityValidationExpression"},"description":"This parameter is not used."}]},"JwtConfiguration":{"allOf":[{"$ref":"#/components/schemas/JWTConfiguration"},{"xml":{"name":"jwtConfiguration"},"description":"Represents the configuration of a JWT authorizer. Required for the JWT authorizer type. Supported only for HTTP APIs."}]},"Name":{"allOf":[{"$ref":"#/components/schemas/StringWithLengthBetween1And128"},{"xml":{"name":"name"},"description":"The name of the authorizer."}]}},"description":"Updates an Authorizer."},"UpdateDeploymentRequest":{"type":"object","title":"UpdateDeploymentRequest","properties":{"Description":{"allOf":[{"$ref":"#/components/schemas/StringWithLengthBetween0And1024"},{"xml":{"name":"description"},"description":"The description for the deployment resource."}]}},"description":"Updates a Deployment."},"UpdateDomainNameRequest":{"type":"object","title":"UpdateDomainNameRequest","properties":{"DomainNameConfigurations":{"allOf":[{"$ref":"#/components/schemas/DomainNameConfigurations"},{"xml":{"name":"domainNameConfigurations"},"description":"The domain name configurations."}]},"MutualTlsAuthentication":{"allOf":[{"$ref":"#/components/schemas/MutualTlsAuthenticationInput"},{"xml":{"name":"mutualTlsAuthentication"},"description":"The mutual TLS authentication configuration for a custom domain name."}]}},"description":"Updates a DomainName."},"UpdateIntegrationRequest":{"type":"object","title":"UpdateIntegrationRequest","properties":{"ConnectionId":{"allOf":[{"$ref":"#/components/schemas/StringWithLengthBetween1And1024"},{"xml":{"name":"connectionId"},"description":"The ID of the VPC link for a private integration. Supported only for HTTP APIs."}]},"ConnectionType":{"allOf":[{"$ref":"#/components/schemas/ConnectionType"},{"xml":{"name":"connectionType"},"description":"The type of the network connection to the integration endpoint. Specify INTERNET for connections through the public routable internet or VPC_LINK for private connections between API Gateway and resources in a VPC. The default value is INTERNET."}]},"ContentHandlingStrategy":{"allOf":[{"$ref":"#/components/schemas/ContentHandlingStrategy"},{"xml":{"name":"contentHandlingStrategy"},"description":"<p>Supported only for WebSocket APIs. Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:</p> <p>CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.</p> <p>CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.</p> <p>If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.</p>"}]},"CredentialsArn":{"allOf":[{"$ref":"#/components/schemas/Arn"},{"xml":{"name":"credentialsArn"},"description":"Specifies the credentials required for the integration, if any. For AWS integrations, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify the string arn:aws:iam::*:user/*. To use resource-based permissions on supported AWS services, specify null."}]},"Description":{"allOf":[{"$ref":"#/components/schemas/StringWithLengthBetween0And1024"},{"xml":{"name":"description"},"description":"The description of the integration"}]},"IntegrationMethod":{"allOf":[{"$ref":"#/components/schemas/StringWithLengthBetween1And64"},{"xml":{"name":"integrationMethod"},"description":"Specifies the integration's HTTP method type."}]},"IntegrationSubtype":{"allOf":[{"$ref":"#/components/schemas/StringWithLengthBetween1And128"},{"xml":{"name":"integrationSubtype"},"description":"Supported only for HTTP API AWS_PROXY integrations. Specifies the AWS service action to invoke. To learn more, see <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-aws-services-reference.html\">Integration subtype reference</a>."}]},"IntegrationType":{"allOf":[{"$ref":"#/components/schemas/IntegrationType"},{"xml":{"name":"integrationType"},"description":"<p>The integration type of an integration. One of the following:</p> <p>AWS: for integrating the route or method request with an AWS service action, including the Lambda function-invoking action. With the Lambda function-invoking action, this is referred to as the Lambda custom integration. With any other AWS service action, this is known as AWS integration. Supported only for WebSocket APIs.</p> <p>AWS_PROXY: for integrating the route or method request with a Lambda function or other AWS service action. This integration is also referred to as a Lambda proxy integration.</p> <p>HTTP: for integrating the route or method request with an HTTP endpoint. This integration is also referred to as the HTTP custom integration. Supported only for WebSocket APIs.</p> <p>HTTP_PROXY: for integrating the route or method request with an HTTP endpoint, with the client request passed through as-is. This is also referred to as HTTP proxy integration. For HTTP API private integrations, use an HTTP_PROXY integration.</p> <p>MOCK: for integrating the route or method request with API Gateway as a \"loopback\" endpoint without invoking any backend. Supported only for WebSocket APIs.</p>"}]},"IntegrationUri":{"allOf":[{"$ref":"#/components/schemas/UriWithLengthBetween1And2048"},{"xml":{"name":"integrationUri"},"description":"<p>For a Lambda integration, specify the URI of a Lambda function.</p> <p>For an HTTP integration, specify a fully-qualified URL.</p> <p>For an HTTP API private integration, specify the ARN of an Application Load Balancer listener, Network Load Balancer listener, or AWS Cloud Map service. If you specify the ARN of an AWS Cloud Map service, API Gateway uses DiscoverInstances to identify resources. You can use query parameters to target specific resources. To learn more, see <a href=\"https://docs.aws.amazon.com/cloud-map/latest/api/API_DiscoverInstances.html\">DiscoverInstances</a>. For private integrations, all resources must be owned by the same AWS account.</p>"}]},"PassthroughBehavior":{"allOf":[{"$ref":"#/components/schemas/PassthroughBehavior"},{"xml":{"name":"passthroughBehavior"},"description":"<p>Specifies the pass-through behavior for incoming requests based on the Content-Type header in the request, and the available mapping templates specified as the requestTemplates property on the Integration resource. There are three valid values: WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and NEVER. Supported only for WebSocket APIs.</p> <p>WHEN_NO_MATCH passes the request body for unmapped content types through to the integration backend without transformation.</p> <p>NEVER rejects unmapped content types with an HTTP 415 Unsupported Media Type response.</p> <p>WHEN_NO_TEMPLATES allows pass-through when the integration has no content types mapped to templates. However, if there is at least one content type defined, unmapped content types will be rejected with the same HTTP 415 Unsupported Media Type response.</p>"}]},"PayloadFormatVersion":{"allOf":[{"$ref":"#/components/schemas/StringWithLengthBetween1And64"},{"xml":{"name":"payloadFormatVersion"},"description":"Specifies the format of the payload sent to an integration. Required for HTTP APIs."}]},"RequestParameters":{"allOf":[{"$ref":"#/components/schemas/IntegrationParameters"},{"xml":{"name":"requestParameters"},"description":"<p>For WebSocket APIs, a key-value map specifying request parameters that are passed from the method request to the backend. The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the backend. The method request parameter value must match the pattern of method.request.<replaceable>{location}</replaceable>.<replaceable>{name}</replaceable>\n , where \n <replaceable>{location}</replaceable>\n is querystring, path, or header; and \n <replaceable>{name}</replaceable>\n must be a valid and unique method request parameter name.</p> <p>For HTTP API integrations with a specified integrationSubtype, request parameters are a key-value map specifying parameters that are passed to AWS_PROXY integrations. You can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-aws-services.html\">Working with AWS service integrations for HTTP APIs</a>.</p> <p>For HTTP API integrations, without a specified integrationSubtype request parameters are a key-value map specifying how to transform HTTP requests before sending them to the backend. The key should follow the pattern <action>:<header|querystring|path>.<location> where action can be append, overwrite or remove. For values, you can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-parameter-mapping.\">Transforming API requests and responses</a>.</p>"}]},"RequestTemplates":{"allOf":[{"$ref":"#/components/schemas/TemplateMap"},{"xml":{"name":"requestTemplates"},"description":"Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value. Supported only for WebSocket APIs."}]},"ResponseParameters":{"allOf":[{"$ref":"#/components/schemas/ResponseParameters"},{"xml":{"name":"responseParameters"},"description":"Supported only for HTTP APIs. You use response parameters to transform the HTTP response from a backend integration before returning the response to clients. Specify a key-value map from a selection key to response parameters. The selection key must be a valid HTTP status code within the range of 200-599. Response parameters are a key-value map. The key must match pattern <action>:<header>.<location> or overwrite.statuscode. The action can be append, overwrite or remove. The value can be a static value, or map to response data, stage variables, or context variables that are evaluated at runtime. To learn more, see <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-parameter-mapping.html\">Transforming API requests and responses</a>."}]},"TemplateSelectionExpression":{"allOf":[{"$ref":"#/components/schemas/SelectionExpression"},{"xml":{"name":"templateSelectionExpression"},"description":"The template selection expression for the integration."}]},"TimeoutInMillis":{"allOf":[{"$ref":"#/components/schemas/IntegerWithLengthBetween50And30000"},{"xml":{"name":"timeoutInMillis"},"description":"Custom timeout between 50 and 29,000 milliseconds for WebSocket APIs and between 50 and 30,000 milliseconds for HTTP APIs. The default timeout is 29 seconds for WebSocket APIs and 30 seconds for HTTP APIs."}]},"TlsConfig":{"allOf":[{"$ref":"#/components/schemas/TlsConfigInput"},{"xml":{"name":"tlsConfig"},"description":"The TLS configuration for a private integration. If you specify a TLS configuration, private integration traffic uses the HTTPS protocol. Supported only for HTTP APIs."}]}},"description":"Updates an Integration."},"UpdateIntegrationResponseRequest":{"type":"object","title":"UpdateIntegrationResponseRequest","properties":{"ContentHandlingStrategy":{"allOf":[{"$ref":"#/components/schemas/ContentHandlingStrategy"},{"xml":{"name":"contentHandlingStrategy"},"description":"<p>Supported only for WebSocket APIs. Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:</p> <p>CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.</p> <p>CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.</p> <p>If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.</p>"}]},"IntegrationResponseKey":{"allOf":[{"$ref":"#/components/schemas/SelectionKey"},{"xml":{"name":"integrationResponseKey"},"description":"The integration response key."}]},"ResponseParameters":{"allOf":[{"$ref":"#/components/schemas/IntegrationParameters"},{"xml":{"name":"responseParameters"},"description":"A key-value map specifying response parameters that are passed to the method response from the backend. The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of method.response.header.<replaceable>{name}</replaceable>\n , where name is a valid and unique header name. The mapped non-static value must match the pattern of integration.response.header.<replaceable>{name}</replaceable>\n or integration.response.body.<replaceable>{JSON-expression}</replaceable>\n , where \n <replaceable>{name}</replaceable>\n is a valid and unique response header name and \n <replaceable>{JSON-expression}</replaceable>\n is a valid JSON expression without the $ prefix."}]},"ResponseTemplates":{"allOf":[{"$ref":"#/components/schemas/TemplateMap"},{"xml":{"name":"responseTemplates"},"description":"The collection of response templates for the integration response as a string-to-string map of key-value pairs. Response templates are represented as a key/value map, with a content-type as the key and a template as the value."}]},"TemplateSelectionExpression":{"allOf":[{"$ref":"#/components/schemas/SelectionExpression"},{"xml":{"name":"templateSelectionExpression"},"description":"The template selection expression for the integration response. Supported only for WebSocket APIs."}]}},"description":"Updates an IntegrationResponses."},"UpdateModelRequest":{"type":"object","title":"UpdateModelRequest","properties":{"ContentType":{"allOf":[{"$ref":"#/components/schemas/StringWithLengthBetween1And256"},{"xml":{"name":"contentType"},"description":"The content-type for the model, for example, \"application/json\"."}]},"Description":{"allOf":[{"$ref":"#/components/schemas/StringWithLengthBetween0And1024"},{"xml":{"name":"description"},"description":"The description of the model."}]},"Name":{"allOf":[{"$ref":"#/components/schemas/StringWithLengthBetween1And128"},{"xml":{"name":"name"},"description":"The name of the model."}]},"Schema":{"allOf":[{"$ref":"#/components/schemas/StringWithLengthBetween0And32K"},{"xml":{"name":"schema"},"description":"The schema for the model. For application/json models, this should be JSON schema draft 4 model."}]}},"description":"Updates a Model."},"UpdateRouteRequest":{"type":"object","title":"UpdateRouteRequest","properties":{"ApiKeyRequired":{"allOf":[{"$ref":"#/components/schemas/__boolean"},{"xml":{"name":"apiKeyRequired"},"description":"Specifies whether an API key is required for the route. Supported only for WebSocket APIs."}]},"AuthorizationScopes":{"allOf":[{"$ref":"#/components/schemas/AuthorizationScopes"},{"xml":{"name":"authorizationScopes"},"description":"The authorization scopes supported by this route."}]},"AuthorizationType":{"allOf":[{"$ref":"#/components/schemas/AuthorizationType"},{"xml":{"name":"authorizationType"},"description":"The authorization type for the route. For WebSocket APIs, valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer For HTTP APIs, valid values are NONE for open access, JWT for using JSON Web Tokens, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer."}]},"AuthorizerId":{"allOf":[{"$ref":"#/components/schemas/Id"},{"xml":{"name":"authorizerId"},"description":"The identifier of the Authorizer resource to be associated with this route. The authorizer identifier is generated by API Gateway when you created the authorizer."}]},"ModelSelectionExpression":{"allOf":[{"$ref":"#/components/schemas/SelectionExpression"},{"xml":{"name":"modelSelectionExpression"},"description":"The model selection expression for the route. Supported only for WebSocket APIs."}]},"OperationName":{"allOf":[{"$ref":"#/components/schemas/StringWithLengthBetween1And64"},{"xml":{"name":"operationName"},"description":"The operation name for the route."}]},"RequestModels":{"allOf":[{"$ref":"#/components/schemas/RouteModels"},{"xml":{"name":"requestModels"},"description":"The request models for the route. Supported only for WebSocket APIs."}]},"RequestParameters":{"allOf":[{"$ref":"#/components/schemas/RouteParameters"},{"xml":{"name":"requestParameters"},"description":"The request parameters for the route. Supported only for WebSocket APIs."}]},"RouteKey":{"allOf":[{"$ref":"#/components/schemas/SelectionKey"},{"xml":{"name":"routeKey"},"description":"The route key for the route."}]},"RouteResponseSelectionExpression":{"allOf":[{"$ref":"#/components/schemas/SelectionExpression"},{"xml":{"name":"routeResponseSelectionExpression"},"description":"The route response selection expression for the route. Supported only for WebSocket APIs."}]},"Target":{"allOf":[{"$ref":"#/components/schemas/StringWithLengthBetween1And128"},{"xml":{"name":"target"},"description":"The target for the route."}]}},"description":"Updates a Route."},"UpdateRouteResponseRequest":{"type":"object","title":"UpdateRouteResponseRequest","properties":{"ModelSelectionExpression":{"allOf":[{"$ref":"#/components/schemas/SelectionExpression"},{"xml":{"name":"modelSelectionExpression"},"description":"The model selection expression for the route response. Supported only for WebSocket APIs."}]},"ResponseModels":{"allOf":[{"$ref":"#/components/schemas/RouteModels"},{"xml":{"name":"responseModels"},"description":"The response models for the route response."}]},"ResponseParameters":{"allOf":[{"$ref":"#/components/schemas/RouteParameters"},{"xml":{"name":"responseParameters"},"description":"The route response parameters."}]},"RouteResponseKey":{"allOf":[{"$ref":"#/components/schemas/SelectionKey"},{"xml":{"name":"routeResponseKey"},"description":"The route response key."}]}},"description":"Updates a RouteResponse."},"UpdateStageRequest":{"type":"object","title":"UpdateStageRequest","properties":{"AccessLogSettings":{"allOf":[{"$ref":"#/components/schemas/AccessLogSettings"},{"xml":{"name":"accessLogSettings"},"description":"Settings for logging access in this stage."}]},"AutoDeploy":{"allOf":[{"$ref":"#/components/schemas/__boolean"},{"xml":{"name":"autoDeploy"},"description":"Specifies whether updates to an API automatically trigger a new deployment. The default value is false."}]},"ClientCertificateId":{"allOf":[{"$ref":"#/components/schemas/Id"},{"xml":{"name":"clientCertificateId"},"description":"The identifier of a client certificate for a Stage."}]},"DefaultRouteSettings":{"allOf":[{"$ref":"#/components/schemas/RouteSettings"},{"xml":{"name":"defaultRouteSettings"},"description":"The default route settings for the stage."}]},"DeploymentId":{"allOf":[{"$ref":"#/components/schemas/Id"},{"xml":{"name":"deploymentId"},"description":"The deployment identifier for the API stage. Can't be updated if autoDeploy is enabled."}]},"Description":{"allOf":[{"$ref":"#/components/schemas/StringWithLengthBetween0And1024"},{"xml":{"name":"description"},"description":"The description for the API stage."}]},"RouteSettings":{"allOf":[{"$ref":"#/components/schemas/RouteSettingsMap"},{"xml":{"name":"routeSettings"},"description":"Route settings for the stage."}]},"StageVariables":{"allOf":[{"$ref":"#/components/schemas/StageVariablesMap"},{"xml":{"name":"stageVariables"},"description":"A map that defines the stage variables for a Stage. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+."}]}},"description":"Updates a Stage."},"UpdateVpcLinkRequest":{"type":"object","title":"UpdateVpcLinkRequest","properties":{"Name":{"allOf":[{"$ref":"#/components/schemas/StringWithLengthBetween1And128"},{"xml":{"name":"name"},"description":"The name of the VPC link."}]}},"description":"Updates a VPC link."},"VpcLink":{"type":"object","required":["VpcLinkId","SecurityGroupIds","SubnetIds","Name"],"properties":{"CreatedDate":{"allOf":[{"$ref":"#/components/schemas/__timestampIso8601"},{"xml":{"name":"createdDate"},"description":"The timestamp when the VPC link was created."}]},"Name":{"allOf":[{"$ref":"#/components/schemas/StringWithLengthBetween1And128"},{"xml":{"name":"name"},"description":"The name of the VPC link."}]},"SecurityGroupIds":{"allOf":[{"$ref":"#/components/schemas/SecurityGroupIdList"},{"xml":{"name":"securityGroupIds"},"description":"A list of security group IDs for the VPC link."}]},"SubnetIds":{"allOf":[{"$ref":"#/components/schemas/SubnetIdList"},{"xml":{"name":"subnetIds"},"description":"A list of subnet IDs to include in the VPC link."}]},"Tags":{"allOf":[{"$ref":"#/components/schemas/Tags"},{"xml":{"name":"tags"},"description":"Tags for the VPC link."}]},"VpcLinkId":{"allOf":[{"$ref":"#/components/schemas/Id"},{"xml":{"name":"vpcLinkId"},"description":"The ID of the VPC link."}]},"VpcLinkStatus":{"allOf":[{"$ref":"#/components/schemas/VpcLinkStatus"},{"xml":{"name":"vpcLinkStatus"},"description":"The status of the VPC link."}]},"VpcLinkStatusMessage":{"allOf":[{"$ref":"#/components/schemas/StringWithLengthBetween0And1024"},{"xml":{"name":"vpcLinkStatusMessage"},"description":"A message summarizing the cause of the status of the VPC link."}]},"VpcLinkVersion":{"allOf":[{"$ref":"#/components/schemas/VpcLinkVersion"},{"xml":{"name":"vpcLinkVersion"},"description":"The version of the VPC link."}]}},"description":"Represents a VPC link."}},"x-policies":{"/v2/domainnames/{domainName}/apimappings":"Domain Mappings","/v2/apis/{apiId}/integrations":"Integration Server Services","/v2/apis/{apiId}/models":"Models","/v2/apis/{apiId}/routes":"Routes","/v2/apis/{apiId}/routes/{routeId}/routeresponses":"Route Responses","/v2/apis/{apiId}/integrations/{integrationId}/integrationresponses":"Integration Responses","/v2/domainnames/{domainName}/apimappings/{apiMappingId}":"Domain Names","/v2/apis/{apiId}/cors":"Cro","/v2/vpclinks":"Virtual Private Networks","/v2/apis/{apiId}/stages/{stageName}/accesslogsettings":"Log Settings","/v2/domainnames/{domainName}":"Domain Names","/v2/apis/{apiId}/integrations/{integrationId}/integrationresponses/{integrationResponseId}":"Integration Server Services","/v2/apis/{apiId}/integrations/{integrationId}":"Integration Server Services","/v2/apis/{apiId}/stages/{stageName}":"Stages","/v2/vpclinks/{vpcLinkId}":"Virtual Private Networks","/v2/apis/{apiId}/exports/{specification}#outputType":"Export Specification","/v2/apis/{apiId}/models/{modelId}/template":"Model Templates","/v2/tags/{resource-arn}":"Tag Resources","/v2/tags/{resource-arn}#tagKeys":"Tag Resources","/v2/apis/{apiId}/stages/{stageName}/routesettings/{routeKey}":"Route Settings","/v2/apis/{apiId}/routes/{routeId}/routeresponses/{routeResponseId}":"Route Responses","/v2/apis/{apiId}/routes/{routeId}/requestparameters/{requestParameterKey}":"Route Parmaeters","/v2/apis/{apiId}/routes/{routeId}":"Routes","/v2/apis/{apiId}/models/{modelId}":"Models","/v2/apis/{apiId}/deployments/{deploymentId}":"Deployments","/v2/apis/{apiId}/authorizers/{authorizerId}":"Authorizers","/v2/apis/{apiId}/stages":"Stages","/v2/domainnames":"Domain Names","/v2/apis/{apiId}/deployments":"Deployments","/v2/apis/{apiId}/authorizers":"Authorizers","/v2/apis":"APIs","/v2/apis/{apiId}":"APIs","/v2/apis/{apiId}/stages/{stageName}/cache/authorizers":"Authorization Cache"}},"security":[{"hmac":[]}]}
/ v2 / apis
/ v2 / domainnames / {domainName} / apimappings
/ v2 / apis / {apiId} / authorizers
/ v2 / apis / {apiId} / deployments
/ v2 / domainnames
/ v2 / apis / {apiId} / integrations
/ v2 / apis / {apiId} / integrations / {integrationId} / integrationresponses
/ v2 / apis / {apiId} / models
/ v2 / apis / {apiId} / routes
/ v2 / apis / {apiId} / routes / {routeId} / routeresponses
/ v2 / apis / {apiId} / stages
/ v2 / vpclinks
/ v2 / apis / {apiId} / stages / {stageName} / accesslogsettings
/ v2 / apis / {apiId}
/ v2 / domainnames / {domainName} / apimappings / {apiMappingId}
/ v2 / apis / {apiId} / authorizers / {authorizerId}
/ v2 / apis / {apiId} / cors
/ v2 / apis / {apiId} / deployments / {deploymentId}
/ v2 / domainnames / {domainName}
/ v2 / apis / {apiId} / integrations / {integrationId}
/ v2 / apis / {apiId} / integrations / {integrationId} / integrationresponses / {integrationResponseId}
/ v2 / apis / {apiId} / models / {modelId}
/ v2 / apis / {apiId} / routes / {routeId}
/ v2 / apis / {apiId} / routes / {routeId} / requestparameters / {requestParameterKey}
/ v2 / apis / {apiId} / routes / {routeId} / routeresponses / {routeResponseId}
/ v2 / apis / {apiId} / stages / {stageName} / routesettings / {routeKey}
/ v2 / apis / {apiId} / stages / {stageName}
/ v2 / vpclinks / {vpcLinkId}
/ v2 / apis / {apiId} / exports / {specification}#outputType
/ v2 / apis / {apiId} / stages / {stageName} / cache / authorizers
/ v2 / apis / {apiId} / models / {modelId} / template
/ v2 / tags / {resource-arn}
/ v2 / tags / {resource-arn}#tagKeys
Amazon API Gateway OpenAPI	{"openapi":"3.0.0","info":{"version":"2015-07-09","x-release":"v4","title":"Amazon API Gateway","description":"<fullname>Amazon API Gateway</fullname> <p>Amazon API Gateway helps developers deliver robust, secure, and scalable mobile and web application back ends. API Gateway allows developers to securely connect mobile and web applications to APIs that run on AWS Lambda, Amazon EC2, or other publicly addressable web services that are hosted outside of AWS.</p>","x-logo":{"url":"https://api.apis.guru/v2/cache/logo/https_twitter.com_awscloud_profile_image.png","backgroundColor":"#FFFFFF"},"termsOfService":"https://aws.amazon.com/service-terms/","contact":{"name":"Mike Ralphson","email":"mike.ralphson@gmail.com","url":"https://github.com/mermade/aws2openapi","x-twitter":"PermittedSoc"},"license":{"name":"Apache 2.0 License","url":"http://www.apache.org/licenses/"},"x-providerName":"amazonaws.com","x-serviceName":"apigateway","x-origin":[{"contentType":"application/json","url":"https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/apigateway-2015-07-09.normal.json","converter":{"url":"https://github.com/mermade/aws2openapi","version":"1.0.0"},"x-apisguru-driver":"external"}],"x-apiClientRegistration":{"url":"https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct"},"x-apisguru-categories":["cloud"],"x-preferred":true},"externalDocs":{"description":"Amazon Web Services documentation","url":"https://docs.aws.amazon.com/apigateway/"},"servers":[{"url":"http://apigateway.{region}.amazonaws.com","variables":{"region":{"description":"The AWS region","enum":["us-east-1","us-east-2","us-west-1","us-west-2","us-gov-west-1","us-gov-east-1","ca-central-1","eu-north-1","eu-west-1","eu-west-2","eu-west-3","eu-central-1","eu-south-1","af-south-1","ap-northeast-1","ap-northeast-2","ap-northeast-3","ap-southeast-1","ap-southeast-2","ap-east-1","ap-south-1","sa-east-1","me-south-1"],"default":"us-east-1"}},"description":"The Amazon API Gateway multi-region endpoint"},{"url":"https://apigateway.{region}.amazonaws.com","variables":{"region":{"description":"The AWS region","enum":["us-east-1","us-east-2","us-west-1","us-west-2","us-gov-west-1","us-gov-east-1","ca-central-1","eu-north-1","eu-west-1","eu-west-2","eu-west-3","eu-central-1","eu-south-1","af-south-1","ap-northeast-1","ap-northeast-2","ap-northeast-3","ap-southeast-1","ap-southeast-2","ap-east-1","ap-south-1","sa-east-1","me-south-1"],"default":"us-east-1"}},"description":"The Amazon API Gateway multi-region endpoint"},{"url":"http://apigateway.{region}.amazonaws.com.cn","variables":{"region":{"description":"The AWS region","enum":["cn-north-1","cn-northwest-1"],"default":"cn-north-1"}},"description":"The Amazon API Gateway endpoint for China (Beijing) and China (Ningxia)"},{"url":"https://apigateway.{region}.amazonaws.com.cn","variables":{"region":{"description":"The AWS region","enum":["cn-north-1","cn-northwest-1"],"default":"cn-north-1"}},"description":"The Amazon API Gateway endpoint for China (Beijing) and China (Ningxia)"}],"x-hasEquivalentPaths":true,"paths":{"/apikeys":{"post":{"operationId":"CreateApiKey","description":"<p>Create an <a>ApiKey</a> resource. </p> <div class=\"seeAlso\"><a href=\"https://docs.aws.amazon.com/cli/latest/reference/apigateway/create-api-key.html\">AWS CLI</a></div>","responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiKey"}}}},"480":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"481":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}},"482":{"description":"LimitExceededException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LimitExceededException"}}}},"483":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"484":{"description":"UnauthorizedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedException"}}}},"485":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}}},"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"description":"The name of the <a>ApiKey</a>.","type":"string"},"description":{"description":"The description of the <a>ApiKey</a>.","type":"string"},"enabled":{"description":"Specifies whether the <a>ApiKey</a> can be used by callers.","type":"boolean"},"generateDistinctId":{"description":"Specifies whether (<code>true</code>) or not (<code>false</code>) the key identifier is distinct from the created API key value. This parameter is deprecated and should not be used.","type":"boolean"},"value":{"description":"Specifies a value of the API key.","type":"string"},"stageKeys":{"description":"DEPRECATED FOR USAGE PLANS - Specifies stages associated with the API key.","type":"array","items":{"$ref":"#/components/schemas/StageKey"}},"customerId":{"description":"An AWS Marketplace customer identifier , when integrating with the AWS SaaS Marketplace.","type":"string"},"tags":{"description":"The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with <code>aws:</code>. The tag value can be up to 256 characters.","type":"object","additionalProperties":{"$ref":"#/components/schemas/String"}}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}],"get":{"operationId":"GetApiKeys","description":"Gets information about the current <a>ApiKeys</a> resource.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiKeys"}}}},"480":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"481":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"482":{"description":"UnauthorizedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedException"}}}},"483":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}}},"parameters":[{"name":"position","in":"query","required":false,"description":"The current pagination position in the paged result set.","schema":{"type":"string"}},{"name":"limit","in":"query","required":false,"description":"The maximum number of returned results per page. The default value is 25 and the maximum value is 500.","schema":{"type":"integer"}},{"name":"name","in":"query","required":false,"description":"The name of queried API keys.","schema":{"type":"string"}},{"name":"customerId","in":"query","required":false,"description":"The identifier of a customer in AWS Marketplace or an external system, such as a developer portal.","schema":{"type":"string"}},{"name":"includeValues","in":"query","required":false,"description":"A boolean flag to specify whether (<code>true</code>) or not (<code>false</code>) the result contains key values.","schema":{"type":"boolean"}}]}},"/restapis/{restapi_id}/authorizers":{"post":{"operationId":"CreateAuthorizer","description":"<p>Adds a new <a>Authorizer</a> resource to an existing <a>RestApi</a> resource.</p> <div class=\"seeAlso\"><a href=\"https://docs.aws.amazon.com/cli/latest/reference/apigateway/create-authorizer.html\">AWS CLI</a></div>","responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Authorizer"}}}},"480":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"481":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}},"482":{"description":"LimitExceededException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LimitExceededException"}}}},"483":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"484":{"description":"UnauthorizedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedException"}}}},"485":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}}},"parameters":[{"name":"restapi_id","in":"path","required":true,"description":"[Required] The string identifier of the associated <a>RestApi</a>.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["name","type"],"properties":{"name":{"description":"[Required] The name of the authorizer.","type":"string"},"type":{"description":"The authorizer type. Valid values are <code>TOKEN</code> for a Lambda function using a single authorization token submitted in a custom header, <code>REQUEST</code> for a Lambda function using incoming request parameters, and <code>COGNITO_USER_POOLS</code> for using an Amazon Cognito user pool.","type":"string","enum":["TOKEN","REQUEST","COGNITO_USER_POOLS"]},"providerARNs":{"description":"A list of the Amazon Cognito user pool ARNs for the <code>COGNITO_USER_POOLS</code> authorizer. Each element is of this format: <code>arn:aws:cognito-idp:{region}:{account_id}:userpool/{user_pool_id}</code>. For a <code>TOKEN</code> or <code>REQUEST</code> authorizer, this is not defined.","type":"array","items":{"$ref":"#/components/schemas/ProviderARN"}},"authType":{"description":"Optional customer-defined field, used in OpenAPI imports and exports without functional impact.","type":"string"},"authorizerUri":{"description":"Specifies the authorizer's Uniform Resource Identifier (URI). For <code>TOKEN</code> or <code>REQUEST</code> authorizers, this must be a well-formed Lambda function URI, for example, <code>arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations</code>. In general, the URI has this form <code>arn:aws:apigateway:{region}:lambda:path/{service_api}</code>, where <code>{region}</code> is the same as the region hosting the Lambda function, <code>path</code> indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial <code>/</code>. For Lambda functions, this is usually of the form <code>/2015-03-31/functions/[FunctionARN]/invocations</code>.","type":"string"},"authorizerCredentials":{"description":"Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, specify null.","type":"string"},"identitySource":{"description":"The identity source for which authorization is requested. <ul><li>For a <code>TOKEN</code> or <code>COGNITO_USER_POOLS</code> authorizer, this is required and specifies the request header mapping expression for the custom header holding the authorization token submitted by the client. For example, if the token header name is <code>Auth</code>, the header mapping expression is <code>method.request.header.Auth</code>.</li><li>For the <code>REQUEST</code> authorizer, this is required when authorization caching is enabled. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an <code>Auth</code> header, a <code>Name</code> query string parameter are defined as identity sources, this value is <code>method.request.header.Auth, method.request.querystring.Name</code>. These parameters will be used to derive the authorization caching key and to perform runtime validation of the <code>REQUEST</code> authorizer by verifying all of the identity-related request parameters are present, not null and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function, otherwise, it returns a 401 Unauthorized response without calling the Lambda function. The valid value is a string of comma-separated mapping expressions of the specified request parameters. When the authorization caching is not enabled, this property is optional.</li></ul>","type":"string"},"identityValidationExpression":{"description":"A validation expression for the incoming identity token. For <code>TOKEN</code> authorizers, this value is a regular expression. For <code>COGNITO_USER_POOLS</code> authorizers, API Gateway will match the <code>aud</code> field of the incoming token from the client against the specified regular expression. It will invoke the authorizer's Lambda function when there is a match. Otherwise, it will return a 401 Unauthorized response without calling the Lambda function. The validation expression does not apply to the <code>REQUEST</code> authorizer.","type":"string"},"authorizerResultTtlInSeconds":{"description":"The TTL in seconds of cached authorizer results. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway will cache authorizer responses. If this field is not set, the default value is 300. The maximum value is 3600, or 1 hour.","type":"integer"}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}],"get":{"operationId":"GetAuthorizers","description":"<p>Describe an existing <a>Authorizers</a> resource.</p> <div class=\"seeAlso\"><a href=\"https://docs.aws.amazon.com/cli/latest/reference/apigateway/get-authorizers.html\">AWS CLI</a></div>","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Authorizers"}}}},"480":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"481":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"482":{"description":"UnauthorizedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedException"}}}},"483":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}}},"parameters":[{"name":"restapi_id","in":"path","required":true,"description":"[Required] The string identifier of the associated <a>RestApi</a>.","schema":{"type":"string"}},{"name":"position","in":"query","required":false,"description":"The current pagination position in the paged result set.","schema":{"type":"string"}},{"name":"limit","in":"query","required":false,"description":"The maximum number of returned results per page. The default value is 25 and the maximum value is 500.","schema":{"type":"integer"}}]}},"/domainnames/{domain_name}/basepathmappings":{"post":{"operationId":"CreateBasePathMapping","description":"Creates a new <a>BasePathMapping</a> resource.","responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BasePathMapping"}}}},"480":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"481":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}},"482":{"description":"LimitExceededException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LimitExceededException"}}}},"483":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"484":{"description":"UnauthorizedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedException"}}}},"485":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}}},"parameters":[{"name":"domain_name","in":"path","required":true,"description":"[Required] The domain name of the <a>BasePathMapping</a> resource to create.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["restApiId"],"properties":{"basePath":{"description":"The base path name that callers of the API must provide as part of the URL after the domain name. This value must be unique for all of the mappings across a single API. Specify '(none)' if you do not want callers to specify a base path name after the domain name.","type":"string"},"restApiId":{"description":"[Required] The string identifier of the associated <a>RestApi</a>.","type":"string"},"stage":{"description":"The name of the API's stage that you want to use for this mapping. Specify '(none)' if you want callers to explicitly specify the stage name after any base path name.","type":"string"}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}],"get":{"operationId":"GetBasePathMappings","description":"Represents a collection of <a>BasePathMapping</a> resources.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BasePathMappings"}}}},"480":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"481":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"482":{"description":"UnauthorizedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedException"}}}},"483":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}}},"parameters":[{"name":"domain_name","in":"path","required":true,"description":"[Required] The domain name of a <a>BasePathMapping</a> resource.","schema":{"type":"string"}},{"name":"position","in":"query","required":false,"description":"The current pagination position in the paged result set.","schema":{"type":"string"}},{"name":"limit","in":"query","required":false,"description":"The maximum number of returned results per page. The default value is 25 and the maximum value is 500.","schema":{"type":"integer"}}]}},"/restapis/{restapi_id}/deployments":{"post":{"operationId":"CreateDeployment","description":"Creates a <a>Deployment</a> resource, which makes a specified <a>RestApi</a> callable over the internet.","responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Deployment"}}}},"480":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"481":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}},"482":{"description":"LimitExceededException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LimitExceededException"}}}},"483":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"484":{"description":"UnauthorizedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedException"}}}},"485":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}},"486":{"description":"ServiceUnavailableException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceUnavailableException"}}}}},"parameters":[{"name":"restapi_id","in":"path","required":true,"description":"[Required] The string identifier of the associated <a>RestApi</a>.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"stageName":{"description":"The name of the <a>Stage</a> resource for the <a>Deployment</a> resource to create.","type":"string"},"stageDescription":{"description":"The description of the <a>Stage</a> resource for the <a>Deployment</a> resource to create.","type":"string"},"description":{"description":"The description for the <a>Deployment</a> resource to create.","type":"string"},"cacheClusterEnabled":{"description":"Enables a cache cluster for the <a>Stage</a> resource specified in the input.","type":"boolean"},"cacheClusterSize":{"description":"Returns the size of the <b>CacheCluster</b>.","type":"string","enum":["0.5","1.6","6.1","13.5","28.4","58.2","118","237"]},"variables":{"description":"A map that defines the stage variables for the <a>Stage</a> resource that is associated with the new deployment. Variable names can have alphanumeric and underscore characters, and the values must match <code>[A-Za-z0-9-._~:/?#&=,]+</code>.","type":"object","additionalProperties":{"$ref":"#/components/schemas/String"}},"canarySettings":{"description":"The input configuration for a canary deployment.","type":"object","properties":{"percentTraffic":{"allOf":[{"$ref":"#/components/schemas/Double"},{"description":"The percentage (0.0-100.0) of traffic routed to the canary deployment."}]},"stageVariableOverrides":{"allOf":[{"$ref":"#/components/schemas/MapOfStringToString"},{"description":"A stage variable overrides used for the canary release deployment. They can override existing stage variables or add new stage variables for the canary release deployment. These stage variables are represented as a string-to-string map between stage variable names and their values."}]},"useStageCache":{"allOf":[{"$ref":"#/components/schemas/Boolean"},{"description":"A Boolean flag to indicate whether the canary release deployment uses the stage cache or not."}]}}},"tracingEnabled":{"description":"Specifies whether active tracing with X-ray is enabled for the <a>Stage</a>.","type":"boolean"}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}],"get":{"operationId":"GetDeployments","description":"Gets information about a <a>Deployments</a> collection.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Deployments"}}}},"480":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"481":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"482":{"description":"UnauthorizedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedException"}}}},"483":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}},"484":{"description":"ServiceUnavailableException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceUnavailableException"}}}}},"parameters":[{"name":"restapi_id","in":"path","required":true,"description":"[Required] The string identifier of the associated <a>RestApi</a>.","schema":{"type":"string"}},{"name":"position","in":"query","required":false,"description":"The current pagination position in the paged result set.","schema":{"type":"string"}},{"name":"limit","in":"query","required":false,"description":"The maximum number of returned results per page. The default value is 25 and the maximum value is 500.","schema":{"type":"integer"}}]}},"/restapis/{restapi_id}/documentation/parts":{"post":{"operationId":"CreateDocumentationPart","description":"","responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentationPart"}}}},"480":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"481":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}},"482":{"description":"LimitExceededException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LimitExceededException"}}}},"483":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"484":{"description":"UnauthorizedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedException"}}}},"485":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}}},"parameters":[{"name":"restapi_id","in":"path","required":true,"description":"[Required] The string identifier of the associated <a>RestApi</a>.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["location","properties"],"properties":{"location":{"description":"Specifies the target API entity to which the documentation applies.","type":"object","properties":{"type":{"allOf":[{"$ref":"#/components/schemas/DocumentationPartType"},{"description":"[Required] The type of API entity to which the documentation content applies. Valid values are <code>API</code>, <code>AUTHORIZER</code>, <code>MODEL</code>, <code>RESOURCE</code>, <code>METHOD</code>, <code>PATH_PARAMETER</code>, <code>QUERY_PARAMETER</code>, <code>REQUEST_HEADER</code>, <code>REQUEST_BODY</code>, <code>RESPONSE</code>, <code>RESPONSE_HEADER</code>, and <code>RESPONSE_BODY</code>. Content inheritance does not apply to any entity of the <code>API</code>, <code>AUTHORIZER</code>, <code>METHOD</code>, <code>MODEL</code>, <code>REQUEST_BODY</code>, or <code>RESOURCE</code> type."}]},"path":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":"The URL path of the target. It is a valid field for the API entity types of <code>RESOURCE</code>, <code>METHOD</code>, <code>PATH_PARAMETER</code>, <code>QUERY_PARAMETER</code>, <code>REQUEST_HEADER</code>, <code>REQUEST_BODY</code>, <code>RESPONSE</code>, <code>RESPONSE_HEADER</code>, and <code>RESPONSE_BODY</code>. The default value is <code>/</code> for the root resource. When an applicable child entity inherits the content of another entity of the same type with more general specifications of the other <code>location</code> attributes, the child entity's <code>path</code> attribute must match that of the parent entity as a prefix."}]},"method":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":"The HTTP verb of a method. It is a valid field for the API entity types of <code>METHOD</code>, <code>PATH_PARAMETER</code>, <code>QUERY_PARAMETER</code>, <code>REQUEST_HEADER</code>, <code>REQUEST_BODY</code>, <code>RESPONSE</code>, <code>RESPONSE_HEADER</code>, and <code>RESPONSE_BODY</code>. The default value is <code>*</code> for any method. When an applicable child entity inherits the content of an entity of the same type with more general specifications of the other <code>location</code> attributes, the child entity's <code>method</code> attribute must match that of the parent entity exactly."}]},"statusCode":{"allOf":[{"$ref":"#/components/schemas/DocumentationPartLocationStatusCode"},{"description":"The HTTP status code of a response. It is a valid field for the API entity types of <code>RESPONSE</code>, <code>RESPONSE_HEADER</code>, and <code>RESPONSE_BODY</code>. The default value is <code>*</code> for any status code. When an applicable child entity inherits the content of an entity of the same type with more general specifications of the other <code>location</code> attributes, the child entity's <code>statusCode</code> attribute must match that of the parent entity exactly."}]},"name":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":"The name of the targeted API entity. It is a valid and required field for the API entity types of <code>AUTHORIZER</code>, <code>MODEL</code>, <code>PATH_PARAMETER</code>, <code>QUERY_PARAMETER</code>, <code>REQUEST_HEADER</code>, <code>REQUEST_BODY</code> and <code>RESPONSE_HEADER</code>. It is an invalid field for any other entity type."}]}}},"properties":{"description":"[Required] The new documentation content map of the targeted API entity. Enclosed key-value pairs are API-specific, but only OpenAPI-compliant key-value pairs can be exported and, hence, published.","type":"string"}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}],"get":{"operationId":"GetDocumentationParts","description":"","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentationParts"}}}},"480":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"481":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"482":{"description":"UnauthorizedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedException"}}}},"483":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}}},"parameters":[{"name":"restapi_id","in":"path","required":true,"description":"[Required] The string identifier of the associated <a>RestApi</a>.","schema":{"type":"string"}},{"name":"type","in":"query","required":false,"description":"The type of API entities of the to-be-retrieved documentation parts. ","schema":{"type":"string","enum":["API","AUTHORIZER","MODEL","RESOURCE","METHOD","PATH_PARAMETER","QUERY_PARAMETER","REQUEST_HEADER","REQUEST_BODY","RESPONSE","RESPONSE_HEADER","RESPONSE_BODY"]}},{"name":"name","in":"query","required":false,"description":"The name of API entities of the to-be-retrieved documentation parts.","schema":{"type":"string"}},{"name":"path","in":"query","required":false,"description":"The path of API entities of the to-be-retrieved documentation parts.","schema":{"type":"string"}},{"name":"position","in":"query","required":false,"description":"The current pagination position in the paged result set.","schema":{"type":"string"}},{"name":"limit","in":"query","required":false,"description":"The maximum number of returned results per page. The default value is 25 and the maximum value is 500.","schema":{"type":"integer"}},{"name":"locationStatus","in":"query","required":false,"description":"The status of the API documentation parts to retrieve. Valid values are <code>DOCUMENTED</code> for retrieving <a>DocumentationPart</a> resources with content and <code>UNDOCUMENTED</code> for <a>DocumentationPart</a> resources without content.","schema":{"type":"string","enum":["DOCUMENTED","UNDOCUMENTED"]}}]},"put":{"operationId":"ImportDocumentationParts","description":"","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentationPartIds"}}}},"480":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"481":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}},"482":{"description":"LimitExceededException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LimitExceededException"}}}},"483":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"484":{"description":"UnauthorizedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedException"}}}},"485":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}}},"parameters":[{"name":"restapi_id","in":"path","required":true,"description":"[Required] The string identifier of the associated <a>RestApi</a>.","schema":{"type":"string"}},{"name":"mode","in":"query","required":false,"description":"A query parameter to indicate whether to overwrite (<code>OVERWRITE</code>) any existing <a>DocumentationParts</a> definition or to merge (<code>MERGE</code>) the new definition into the existing one. The default value is <code>MERGE</code>.","schema":{"type":"string","enum":["merge","overwrite"]}},{"name":"failonwarnings","in":"query","required":false,"description":"A query parameter to specify whether to rollback the documentation importation (<code>true</code>) or not (<code>false</code>) when a warning is encountered. The default value is <code>false</code>.","schema":{"type":"boolean"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"description":"[Required] Raw byte array representing the to-be-imported documentation parts. To import from an OpenAPI file, this is a JSON object.","type":"string"}}}}}}}},"/restapis/{restapi_id}/documentation/versions":{"post":{"operationId":"CreateDocumentationVersion","description":"","responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentationVersion"}}}},"480":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"481":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}},"482":{"description":"LimitExceededException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LimitExceededException"}}}},"483":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"484":{"description":"UnauthorizedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedException"}}}},"485":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}}},"parameters":[{"name":"restapi_id","in":"path","required":true,"description":"[Required] The string identifier of the associated <a>RestApi</a>.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["documentationVersion"],"properties":{"documentationVersion":{"description":"[Required] The version identifier of the new snapshot.","type":"string"},"stageName":{"description":"The stage name to be associated with the new documentation snapshot.","type":"string"},"description":{"description":"A description about the new documentation snapshot.","type":"string"}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}],"get":{"operationId":"GetDocumentationVersions","description":"","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentationVersions"}}}},"480":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"481":{"description":"UnauthorizedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedException"}}}},"482":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"483":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}}},"parameters":[{"name":"restapi_id","in":"path","required":true,"description":"[Required] The string identifier of the associated <a>RestApi</a>.","schema":{"type":"string"}},{"name":"position","in":"query","required":false,"description":"The current pagination position in the paged result set.","schema":{"type":"string"}},{"name":"limit","in":"query","required":false,"description":"The maximum number of returned results per page. The default value is 25 and the maximum value is 500.","schema":{"type":"integer"}}]}},"/domainnames":{"post":{"operationId":"CreateDomainName","description":"Creates a new domain name.","responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DomainName"}}}},"480":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"481":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}},"482":{"description":"LimitExceededException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LimitExceededException"}}}},"483":{"description":"UnauthorizedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedException"}}}},"484":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}}},"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["domainName"],"properties":{"domainName":{"description":"[Required] The name of the <a>DomainName</a> resource.","type":"string"},"certificateName":{"description":"The user-friendly name of the certificate that will be used by edge-optimized endpoint for this domain name.","type":"string"},"certificateBody":{"description":"[Deprecated] The body of the server certificate that will be used by edge-optimized endpoint for this domain name provided by your certificate authority.","type":"string"},"certificatePrivateKey":{"description":"[Deprecated] Your edge-optimized endpoint's domain name certificate's private key.","type":"string"},"certificateChain":{"description":"[Deprecated] The intermediate certificates and optionally the root certificate, one after the other without any blank lines, used by an edge-optimized endpoint for this domain name. If you include the root certificate, your certificate chain must start with intermediate certificates and end with the root certificate. Use the intermediate certificates that were provided by your certificate authority. Do not include any intermediaries that are not in the chain of trust path.","type":"string"},"certificateArn":{"description":"The reference to an AWS-managed certificate that will be used by edge-optimized endpoint for this domain name. AWS Certificate Manager is the only supported source.","type":"string"},"regionalCertificateName":{"description":"The user-friendly name of the certificate that will be used by regional endpoint for this domain name.","type":"string"},"regionalCertificateArn":{"description":"The reference to an AWS-managed certificate that will be used by regional endpoint for this domain name. AWS Certificate Manager is the only supported source.","type":"string"},"endpointConfiguration":{"description":"The endpoint configuration to indicate the types of endpoints an API (<a>RestApi</a>) or its custom domain name (<a>DomainName</a>) has. ","type":"object","properties":{"types":{"allOf":[{"$ref":"#/components/schemas/ListOfEndpointType"},{"description":"A list of endpoint types of an API (<a>RestApi</a>) or its custom domain name (<a>DomainName</a>). For an edge-optimized API and its custom domain name, the endpoint type is <code>\"EDGE\"</code>. For a regional API and its custom domain name, the endpoint type is <code>REGIONAL</code>. For a private API, the endpoint type is <code>PRIVATE</code>."}]},"vpcEndpointIds":{"allOf":[{"$ref":"#/components/schemas/ListOfString"},{"description":"A list of VpcEndpointIds of an API (<a>RestApi</a>) against which to create Route53 ALIASes. It is only supported for <code>PRIVATE</code> endpoint type."}]}}},"tags":{"description":"The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with <code>aws:</code>. The tag value can be up to 256 characters.","type":"object","additionalProperties":{"$ref":"#/components/schemas/String"}},"securityPolicy":{"description":"The Transport Layer Security (TLS) version + cipher suite for this <a>DomainName</a>. The valid values are <code>TLS_1_0</code> and <code>TLS_1_2</code>.","type":"string","enum":["TLS_1_0","TLS_1_2"]},"mutualTlsAuthentication":{"description":"If specified, API Gateway performs two-way authentication between the client and the server. Clients must present a trusted certificate to access your custom domain name.","type":"object","properties":{"truststoreUri":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":"An Amazon S3 resource ARN that specifies the truststore for mutual TLS authentication, for example, <code>s3://bucket-name/key-name</code>. The truststore can contain certificates from public or private certificate authorities. To update the truststore, upload a new version to S3, and then update your custom domain name to use the new version. To update the truststore, you must have permissions to access the S3 object."}]},"truststoreVersion":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":"The version of the S3 object that contains your truststore. To specify a version, you must have versioning enabled for the S3 bucket."}]}}},"ownershipVerificationCertificateArn":{"description":"The ARN of the public certificate issued by ACM to validate ownership of your custom domain. Only required when configuring mutual TLS and using an ACM imported or private CA certificate ARN as the regionalCertificateArn.","type":"string"}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}],"get":{"operationId":"GetDomainNames","description":"Represents a collection of <a>DomainName</a> resources.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DomainNames"}}}},"480":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"481":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"482":{"description":"UnauthorizedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedException"}}}},"483":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}}},"parameters":[{"name":"position","in":"query","required":false,"description":"The current pagination position in the paged result set.","schema":{"type":"string"}},{"name":"limit","in":"query","required":false,"description":"The maximum number of returned results per page. The default value is 25 and the maximum value is 500.","schema":{"type":"integer"}}]}},"/restapis/{restapi_id}/models":{"post":{"operationId":"CreateModel","description":"Adds a new <a>Model</a> resource to an existing <a>RestApi</a> resource.","responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model"}}}},"480":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"481":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}},"482":{"description":"LimitExceededException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LimitExceededException"}}}},"483":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"484":{"description":"UnauthorizedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedException"}}}},"485":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}}},"parameters":[{"name":"restapi_id","in":"path","required":true,"description":"[Required] The <a>RestApi</a> identifier under which the <a>Model</a> will be created.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["name","contentType"],"properties":{"name":{"description":"[Required] The name of the model. Must be alphanumeric.","type":"string"},"description":{"description":"The description of the model.","type":"string"},"schema":{"description":"The schema for the model. For <code>application/json</code> models, this should be <a href=\"https://tools.ietf.org/html/draft-zyp-json-schema-04\" target=\"_blank\">JSON schema draft 4</a> model.","type":"string"},"contentType":{"description":"[Required] The content-type for the model.","type":"string"}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}],"get":{"operationId":"GetModels","description":"Describes existing <a>Models</a> defined for a <a>RestApi</a> resource.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Models"}}}},"480":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"481":{"description":"UnauthorizedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedException"}}}},"482":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"483":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}}},"parameters":[{"name":"restapi_id","in":"path","required":true,"description":"[Required] The string identifier of the associated <a>RestApi</a>.","schema":{"type":"string"}},{"name":"position","in":"query","required":false,"description":"The current pagination position in the paged result set.","schema":{"type":"string"}},{"name":"limit","in":"query","required":false,"description":"The maximum number of returned results per page. The default value is 25 and the maximum value is 500.","schema":{"type":"integer"}}]}},"/restapis/{restapi_id}/requestvalidators":{"post":{"operationId":"CreateRequestValidator","description":"Creates a <a>ReqeustValidator</a> of a given <a>RestApi</a>.","responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RequestValidator"}}}},"480":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"481":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}},"482":{"description":"LimitExceededException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LimitExceededException"}}}},"483":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"484":{"description":"UnauthorizedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedException"}}}},"485":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}}},"parameters":[{"name":"restapi_id","in":"path","required":true,"description":"[Required] The string identifier of the associated <a>RestApi</a>.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"description":"The name of the to-be-created <a>RequestValidator</a>.","type":"string"},"validateRequestBody":{"description":"A Boolean flag to indicate whether to validate request body according to the configured model schema for the method (<code>true</code>) or not (<code>false</code>).","type":"boolean"},"validateRequestParameters":{"description":"A Boolean flag to indicate whether to validate request parameters, <code>true</code>, or not <code>false</code>.","type":"boolean"}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}],"get":{"operationId":"GetRequestValidators","description":"Gets the <a>RequestValidators</a> collection of a given <a>RestApi</a>.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RequestValidators"}}}},"480":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"481":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"482":{"description":"UnauthorizedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedException"}}}},"483":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}}},"parameters":[{"name":"restapi_id","in":"path","required":true,"description":"[Required] The string identifier of the associated <a>RestApi</a>.","schema":{"type":"string"}},{"name":"position","in":"query","required":false,"description":"The current pagination position in the paged result set.","schema":{"type":"string"}},{"name":"limit","in":"query","required":false,"description":"The maximum number of returned results per page. The default value is 25 and the maximum value is 500.","schema":{"type":"integer"}}]}},"/restapis/{restapi_id}/resources/{parent_id}":{"post":{"operationId":"CreateResource","description":"Creates a <a>Resource</a> resource.","responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Resource"}}}},"480":{"description":"UnauthorizedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedException"}}}},"481":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"482":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}},"483":{"description":"LimitExceededException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LimitExceededException"}}}},"484":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"485":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}}},"parameters":[{"name":"restapi_id","in":"path","required":true,"description":"[Required] The string identifier of the associated <a>RestApi</a>.","schema":{"type":"string"}},{"name":"parent_id","in":"path","required":true,"description":"[Required] The parent resource's identifier.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["pathPart"],"properties":{"pathPart":{"description":"The last path segment for this resource.","type":"string"}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/restapis":{"post":{"operationId":"CreateRestApi","description":"Creates a new <a>RestApi</a> resource.","responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestApi"}}}},"480":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"481":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}},"482":{"description":"LimitExceededException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LimitExceededException"}}}},"483":{"description":"UnauthorizedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedException"}}}},"484":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}}},"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["name"],"properties":{"name":{"description":"[Required] The name of the <a>RestApi</a>.","type":"string"},"description":{"description":"The description of the <a>RestApi</a>.","type":"string"},"version":{"description":"A version identifier for the API.","type":"string"},"cloneFrom":{"description":"The ID of the <a>RestApi</a> that you want to clone from.","type":"string"},"binaryMediaTypes":{"description":"The list of binary media types supported by the <a>RestApi</a>. By default, the <a>RestApi</a> supports only UTF-8-encoded text payloads.","type":"array","items":{"$ref":"#/components/schemas/String"}},"minimumCompressionSize":{"description":"A nullable integer that is used to enable compression (with non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable compression (with a null value) on an API. When compression is enabled, compression or decompression is not applied on the payload if the payload size is smaller than this value. Setting it to zero allows compression for any payload size.","type":"integer"},"apiKeySource":{"description":"The source of the API key for metering requests according to a usage plan. Valid values are: <ul><li><code>HEADER</code> to read the API key from the <code>X-API-Key</code> header of a request. </li><li><code>AUTHORIZER</code> to read the API key from the <code>UsageIdentifierKey</code> from a custom authorizer.</li></ul>","type":"string","enum":["HEADER","AUTHORIZER"]},"endpointConfiguration":{"description":"The endpoint configuration to indicate the types of endpoints an API (<a>RestApi</a>) or its custom domain name (<a>DomainName</a>) has. ","type":"object","properties":{"types":{"allOf":[{"$ref":"#/components/schemas/ListOfEndpointType"},{"description":"A list of endpoint types of an API (<a>RestApi</a>) or its custom domain name (<a>DomainName</a>). For an edge-optimized API and its custom domain name, the endpoint type is <code>\"EDGE\"</code>. For a regional API and its custom domain name, the endpoint type is <code>REGIONAL</code>. For a private API, the endpoint type is <code>PRIVATE</code>."}]},"vpcEndpointIds":{"allOf":[{"$ref":"#/components/schemas/ListOfString"},{"description":"A list of VpcEndpointIds of an API (<a>RestApi</a>) against which to create Route53 ALIASes. It is only supported for <code>PRIVATE</code> endpoint type."}]}}},"policy":{"description":"A stringified JSON policy document that applies to this RestApi regardless of the caller and <a>Method</a> configuration.","type":"string"},"tags":{"description":"The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with <code>aws:</code>. The tag value can be up to 256 characters.","type":"object","additionalProperties":{"$ref":"#/components/schemas/String"}},"disableExecuteApiEndpoint":{"description":"Specifies whether clients can invoke your API by using the default <code>execute-api</code> endpoint. By default, clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint.","type":"boolean"}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}],"get":{"operationId":"GetRestApis","description":"Lists the <a>RestApis</a> resources for your collection.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestApis"}}}},"480":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"481":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"482":{"description":"UnauthorizedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedException"}}}},"483":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}}},"parameters":[{"name":"position","in":"query","required":false,"description":"The current pagination position in the paged result set.","schema":{"type":"string"}},{"name":"limit","in":"query","required":false,"description":"The maximum number of returned results per page. The default value is 25 and the maximum value is 500.","schema":{"type":"integer"}}]}},"/restapis/{restapi_id}/stages":{"post":{"operationId":"CreateStage","description":"Creates a new <a>Stage</a> resource that references a pre-existing <a>Deployment</a> for the API. ","responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Stage"}}}},"480":{"description":"UnauthorizedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedException"}}}},"481":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"482":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"483":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}},"484":{"description":"LimitExceededException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LimitExceededException"}}}},"485":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}}},"parameters":[{"name":"restapi_id","in":"path","required":true,"description":"[Required] The string identifier of the associated <a>RestApi</a>.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["stageName","deploymentId"],"properties":{"stageName":{"description":"[Required] The name for the <a>Stage</a> resource. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters.","type":"string"},"deploymentId":{"description":"[Required] The identifier of the <a>Deployment</a> resource for the <a>Stage</a> resource.","type":"string"},"description":{"description":"The description of the <a>Stage</a> resource.","type":"string"},"cacheClusterEnabled":{"description":"Whether cache clustering is enabled for the stage.","type":"boolean"},"cacheClusterSize":{"description":"Returns the size of the <b>CacheCluster</b>.","type":"string","enum":["0.5","1.6","6.1","13.5","28.4","58.2","118","237"]},"variables":{"description":"A map that defines the stage variables for the new <a>Stage</a> resource. Variable names can have alphanumeric and underscore characters, and the values must match <code>[A-Za-z0-9-._~:/?#&=,]+</code>.","type":"object","additionalProperties":{"$ref":"#/components/schemas/String"}},"documentationVersion":{"description":"The version of the associated API documentation.","type":"string"},"canarySettings":{"description":"Configuration settings of a canary deployment.","type":"object","properties":{"percentTraffic":{"allOf":[{"$ref":"#/components/schemas/Double"},{"description":"The percent (0-100) of traffic diverted to a canary deployment."}]},"deploymentId":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":"The ID of the canary deployment."}]},"stageVariableOverrides":{"allOf":[{"$ref":"#/components/schemas/MapOfStringToString"},{"description":"Stage variables overridden for a canary release deployment, including new stage variables introduced in the canary. These stage variables are represented as a string-to-string map between stage variable names and their values."}]},"useStageCache":{"allOf":[{"$ref":"#/components/schemas/Boolean"},{"description":"A Boolean flag to indicate whether the canary deployment uses the stage cache or not."}]}}},"tracingEnabled":{"description":"Specifies whether active tracing with X-ray is enabled for the <a>Stage</a>.","type":"boolean"},"tags":{"description":"The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with <code>aws:</code>. The tag value can be up to 256 characters.","type":"object","additionalProperties":{"$ref":"#/components/schemas/String"}}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}],"get":{"operationId":"GetStages","description":"Gets information about one or more <a>Stage</a> resources.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Stages"}}}},"480":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"481":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}},"482":{"description":"LimitExceededException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LimitExceededException"}}}},"483":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"484":{"description":"UnauthorizedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedException"}}}},"485":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}}},"parameters":[{"name":"restapi_id","in":"path","required":true,"description":"[Required] The string identifier of the associated <a>RestApi</a>.","schema":{"type":"string"}},{"name":"deploymentId","in":"query","required":false,"description":"The stages' deployment identifiers.","schema":{"type":"string"}}]}},"/usageplans":{"post":{"operationId":"CreateUsagePlan","description":"Creates a usage plan with the throttle and quota limits, as well as the associated API stages, specified in the payload. ","responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UsagePlan"}}}},"480":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"481":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}},"482":{"description":"LimitExceededException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LimitExceededException"}}}},"483":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"484":{"description":"UnauthorizedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedException"}}}},"485":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}}},"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["name"],"properties":{"name":{"description":"[Required] The name of the usage plan.","type":"string"},"description":{"description":"The description of the usage plan.","type":"string"},"apiStages":{"description":"The associated API stages of the usage plan.","type":"array","items":{"$ref":"#/components/schemas/ApiStage"}},"throttle":{"description":" The API request rate limits.","type":"object","properties":{"burstLimit":{"allOf":[{"$ref":"#/components/schemas/Integer"},{"description":"The API request burst limit, the maximum rate limit over a time ranging from one to a few seconds, depending upon whether the underlying token bucket is at its full capacity."}]},"rateLimit":{"allOf":[{"$ref":"#/components/schemas/Double"},{"description":"The API request steady-state rate limit."}]}}},"quota":{"description":"Quotas configured for a usage plan.","type":"object","properties":{"limit":{"allOf":[{"$ref":"#/components/schemas/Integer"},{"description":"The maximum number of requests that can be made in a given time period."}]},"offset":{"allOf":[{"$ref":"#/components/schemas/Integer"},{"description":"The day that a time period starts. For example, with a time period of <code>WEEK</code>, an offset of <code>0</code> starts on Sunday, and an offset of <code>1</code> starts on Monday."}]},"period":{"allOf":[{"$ref":"#/components/schemas/QuotaPeriodType"},{"description":"The time period in which the limit applies. Valid values are \"DAY\", \"WEEK\" or \"MONTH\"."}]}}},"tags":{"description":"The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with <code>aws:</code>. The tag value can be up to 256 characters.","type":"object","additionalProperties":{"$ref":"#/components/schemas/String"}}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}],"get":{"operationId":"GetUsagePlans","description":"Gets all the usage plans of the caller's account.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UsagePlans"}}}},"480":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"481":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"482":{"description":"UnauthorizedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedException"}}}},"483":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}}},"parameters":[{"name":"position","in":"query","required":false,"description":"The current pagination position in the paged result set.","schema":{"type":"string"}},{"name":"keyId","in":"query","required":false,"description":"The identifier of the API key associated with the usage plans.","schema":{"type":"string"}},{"name":"limit","in":"query","required":false,"description":"The maximum number of returned results per page. The default value is 25 and the maximum value is 500.","schema":{"type":"integer"}}]}},"/usageplans/{usageplanId}/keys":{"post":{"operationId":"CreateUsagePlanKey","description":"Creates a usage plan key for adding an existing API key to a usage plan.","responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UsagePlanKey"}}}},"480":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"481":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}},"482":{"description":"LimitExceededException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LimitExceededException"}}}},"483":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"484":{"description":"UnauthorizedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedException"}}}},"485":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}}},"parameters":[{"name":"usageplanId","in":"path","required":true,"description":"[Required] The Id of the <a>UsagePlan</a> resource representing the usage plan containing the to-be-created <a>UsagePlanKey</a> resource representing a plan customer.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["keyId","keyType"],"properties":{"keyId":{"description":"[Required] The identifier of a <a>UsagePlanKey</a> resource for a plan customer.","type":"string"},"keyType":{"description":"[Required] The type of a <a>UsagePlanKey</a> resource for a plan customer.","type":"string"}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}],"get":{"operationId":"GetUsagePlanKeys","description":"Gets all the usage plan keys representing the API keys added to a specified usage plan.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UsagePlanKeys"}}}},"480":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"481":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"482":{"description":"UnauthorizedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedException"}}}},"483":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}}},"parameters":[{"name":"usageplanId","in":"path","required":true,"description":"[Required] The Id of the <a>UsagePlan</a> resource representing the usage plan containing the to-be-retrieved <a>UsagePlanKey</a> resource representing a plan customer.","schema":{"type":"string"}},{"name":"position","in":"query","required":false,"description":"The current pagination position in the paged result set.","schema":{"type":"string"}},{"name":"limit","in":"query","required":false,"description":"The maximum number of returned results per page. The default value is 25 and the maximum value is 500.","schema":{"type":"integer"}},{"name":"name","in":"query","required":false,"description":"A query parameter specifying the name of the to-be-returned usage plan keys.","schema":{"type":"string"}}]}},"/vpclinks":{"post":{"operationId":"CreateVpcLink","description":"Creates a VPC link, under the caller's account in a selected region, in an asynchronous operation that typically takes 2-4 minutes to complete and become operational. The caller must have permissions to create and update VPC Endpoint services.","responses":{"202":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VpcLink"}}}},"480":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"481":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}},"482":{"description":"LimitExceededException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LimitExceededException"}}}},"483":{"description":"UnauthorizedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedException"}}}},"484":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}}},"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["name","targetArns"],"properties":{"name":{"description":"[Required] The name used to label and identify the VPC link.","type":"string"},"description":{"description":"The description of the VPC link.","type":"string"},"targetArns":{"description":"[Required] The ARN of the network load balancer of the VPC targeted by the VPC link. The network load balancer must be owned by the same AWS account of the API owner.","type":"array","items":{"$ref":"#/components/schemas/String"}},"tags":{"description":"The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with <code>aws:</code>. The tag value can be up to 256 characters.","type":"object","additionalProperties":{"$ref":"#/components/schemas/String"}}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}],"get":{"operationId":"GetVpcLinks","description":"Gets the <a>VpcLinks</a> collection under the caller's account in a selected region.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VpcLinks"}}}},"480":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"481":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"482":{"description":"UnauthorizedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedException"}}}},"483":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}}},"parameters":[{"name":"position","in":"query","required":false,"description":"The current pagination position in the paged result set.","schema":{"type":"string"}},{"name":"limit","in":"query","required":false,"description":"The maximum number of returned results per page. The default value is 25 and the maximum value is 500.","schema":{"type":"integer"}}]}},"/apikeys/{api_Key}":{"delete":{"operationId":"DeleteApiKey","description":"Deletes the <a>ApiKey</a> resource.","responses":{"202":{"description":"Success"},"480":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"481":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}},"482":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"483":{"description":"UnauthorizedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedException"}}}},"484":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}}},"parameters":[{"name":"api_Key","in":"path","required":true,"description":"[Required] The identifier of the <a>ApiKey</a> resource to be deleted.","schema":{"type":"string"}}]},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}],"get":{"operationId":"GetApiKey","description":"Gets information about the current <a>ApiKey</a> resource.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiKey"}}}},"480":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"481":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"482":{"description":"UnauthorizedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedException"}}}},"483":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}}},"parameters":[{"name":"api_Key","in":"path","required":true,"description":"[Required] The identifier of the <a>ApiKey</a> resource.","schema":{"type":"string"}},{"name":"includeValue","in":"query","required":false,"description":"A boolean flag to specify whether (<code>true</code>) or not (<code>false</code>) the result contains the key value.","schema":{"type":"boolean"}}]},"patch":{"operationId":"UpdateApiKey","description":"Changes information about an <a>ApiKey</a> resource.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiKey"}}}},"480":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"481":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}},"482":{"description":"LimitExceededException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LimitExceededException"}}}},"483":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"484":{"description":"UnauthorizedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedException"}}}},"485":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}}},"parameters":[{"name":"api_Key","in":"path","required":true,"description":"[Required] The identifier of the <a>ApiKey</a> resource to be updated.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"patchOperations":{"description":"A list of operations describing the updates to apply to the specified resource. The patches are applied in the order specified in the list.","type":"array","items":{"$ref":"#/components/schemas/PatchOperation"}}}}}}}}},"/restapis/{restapi_id}/authorizers/{authorizer_id}":{"delete":{"operationId":"DeleteAuthorizer","description":"<p>Deletes an existing <a>Authorizer</a> resource.</p> <div class=\"seeAlso\"><a href=\"https://docs.aws.amazon.com/cli/latest/reference/apigateway/delete-authorizer.html\">AWS CLI</a></div>","responses":{"202":{"description":"Success"},"480":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"481":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}},"482":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"483":{"description":"UnauthorizedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedException"}}}},"484":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}}},"parameters":[{"name":"restapi_id","in":"path","required":true,"description":"[Required] The string identifier of the associated <a>RestApi</a>.","schema":{"type":"string"}},{"name":"authorizer_id","in":"path","required":true,"description":"[Required] The identifier of the <a>Authorizer</a> resource.","schema":{"type":"string"}}]},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}],"get":{"operationId":"GetAuthorizer","description":"<p>Describe an existing <a>Authorizer</a> resource.</p> <div class=\"seeAlso\"><a href=\"https://docs.aws.amazon.com/cli/latest/reference/apigateway/get-authorizer.html\">AWS CLI</a></div>","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Authorizer"}}}},"480":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"481":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"482":{"description":"UnauthorizedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedException"}}}},"483":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}}},"parameters":[{"name":"restapi_id","in":"path","required":true,"description":"[Required] The string identifier of the associated <a>RestApi</a>.","schema":{"type":"string"}},{"name":"authorizer_id","in":"path","required":true,"description":"[Required] The identifier of the <a>Authorizer</a> resource.","schema":{"type":"string"}}]},"post":{"operationId":"TestInvokeAuthorizer","description":"<p>Simulate the execution of an <a>Authorizer</a> in your <a>RestApi</a> with headers, parameters, and an incoming request body.</p> <div class=\"seeAlso\"> <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-use-lambda-authorizer.html\">Use Lambda Function as Authorizer</a> <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-integrate-with-cognito.html\">Use Cognito User Pool as Authorizer</a> </div>","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TestInvokeAuthorizerResponse"}}}},"480":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"481":{"description":"UnauthorizedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedException"}}}},"482":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"483":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}}},"parameters":[{"name":"restapi_id","in":"path","required":true,"description":"[Required] The string identifier of the associated <a>RestApi</a>.","schema":{"type":"string"}},{"name":"authorizer_id","in":"path","required":true,"description":"[Required] Specifies a test invoke authorizer request's <a>Authorizer</a> ID.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"headers":{"description":"[Required] A key-value map of headers to simulate an incoming invocation request. This is where the incoming authorization token, or identity source, should be specified.","type":"object","additionalProperties":{"$ref":"#/components/schemas/String"}},"multiValueHeaders":{"description":"[Optional] The headers as a map from string to list of values to simulate an incoming invocation request. This is where the incoming authorization token, or identity source, may be specified.","type":"object","additionalProperties":{"$ref":"#/components/schemas/ListOfString"}},"pathWithQueryString":{"description":"[Optional] The URI path, including query string, of the simulated invocation request. Use this to specify path parameters and query string parameters.","type":"string"},"body":{"description":"[Optional] The simulated request body of an incoming invocation request.","type":"string"},"stageVariables":{"description":"A key-value map of stage variables to simulate an invocation on a deployed <a>Stage</a>.","type":"object","additionalProperties":{"$ref":"#/components/schemas/String"}},"additionalContext":{"description":"[Optional] A key-value map of additional context variables.","type":"object","additionalProperties":{"$ref":"#/components/schemas/String"}}}}}}}},"patch":{"operationId":"UpdateAuthorizer","description":"<p>Updates an existing <a>Authorizer</a> resource.</p> <div class=\"seeAlso\"><a href=\"https://docs.aws.amazon.com/cli/latest/reference/apigateway/update-authorizer.html\">AWS CLI</a></div>","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Authorizer"}}}},"480":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"481":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}},"482":{"description":"LimitExceededException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LimitExceededException"}}}},"483":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"484":{"description":"UnauthorizedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedException"}}}},"485":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}}},"parameters":[{"name":"restapi_id","in":"path","required":true,"description":"[Required] The string identifier of the associated <a>RestApi</a>.","schema":{"type":"string"}},{"name":"authorizer_id","in":"path","required":true,"description":"[Required] The identifier of the <a>Authorizer</a> resource.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"patchOperations":{"description":"A list of operations describing the updates to apply to the specified resource. The patches are applied in the order specified in the list.","type":"array","items":{"$ref":"#/components/schemas/PatchOperation"}}}}}}}}},"/domainnames/{domain_name}/basepathmappings/{base_path}":{"delete":{"operationId":"DeleteBasePathMapping","description":"Deletes the <a>BasePathMapping</a> resource.","responses":{"202":{"description":"Success"},"480":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"481":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}},"482":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"483":{"description":"UnauthorizedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedException"}}}},"484":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}}},"parameters":[{"name":"domain_name","in":"path","required":true,"description":"[Required] The domain name of the <a>BasePathMapping</a> resource to delete.","schema":{"type":"string"}},{"name":"base_path","in":"path","required":true,"description":"<p>[Required] The base path name of the <a>BasePathMapping</a> resource to delete.</p> <p>To specify an empty base path, set this parameter to <code>'(none)'</code>.</p>","schema":{"type":"string"}}]},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}],"get":{"operationId":"GetBasePathMapping","description":"Describe a <a>BasePathMapping</a> resource.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BasePathMapping"}}}},"480":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"481":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"482":{"description":"UnauthorizedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedException"}}}},"483":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}}},"parameters":[{"name":"domain_name","in":"path","required":true,"description":"[Required] The domain name of the <a>BasePathMapping</a> resource to be described.","schema":{"type":"string"}},{"name":"base_path","in":"path","required":true,"description":"[Required] The base path name that callers of the API must provide as part of the URL after the domain name. This value must be unique for all of the mappings across a single API. Specify '(none)' if you do not want callers to specify any base path name after the domain name.","schema":{"type":"string"}}]},"patch":{"operationId":"UpdateBasePathMapping","description":"Changes information about the <a>BasePathMapping</a> resource.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BasePathMapping"}}}},"480":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"481":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}},"482":{"description":"LimitExceededException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LimitExceededException"}}}},"483":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"484":{"description":"UnauthorizedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedException"}}}},"485":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}}},"parameters":[{"name":"domain_name","in":"path","required":true,"description":"[Required] The domain name of the <a>BasePathMapping</a> resource to change.","schema":{"type":"string"}},{"name":"base_path","in":"path","required":true,"description":"<p>[Required] The base path of the <a>BasePathMapping</a> resource to change.</p> <p>To specify an empty base path, set this parameter to <code>'(none)'</code>.</p>","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"patchOperations":{"description":"A list of operations describing the updates to apply to the specified resource. The patches are applied in the order specified in the list.","type":"array","items":{"$ref":"#/components/schemas/PatchOperation"}}}}}}}}},"/clientcertificates/{clientcertificate_id}":{"delete":{"operationId":"DeleteClientCertificate","description":"Deletes the <a>ClientCertificate</a> resource.","responses":{"202":{"description":"Success"},"480":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"481":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}},"482":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"483":{"description":"UnauthorizedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedException"}}}},"484":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}}},"parameters":[{"name":"clientcertificate_id","in":"path","required":true,"description":"[Required] The identifier of the <a>ClientCertificate</a> resource to be deleted.","schema":{"type":"string"}}]},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}],"get":{"operationId":"GetClientCertificate","description":"Gets information about the current <a>ClientCertificate</a> resource.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClientCertificate"}}}},"480":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"481":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"482":{"description":"UnauthorizedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedException"}}}},"483":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}}},"parameters":[{"name":"clientcertificate_id","in":"path","required":true,"description":"[Required] The identifier of the <a>ClientCertificate</a> resource to be described.","schema":{"type":"string"}}]},"patch":{"operationId":"UpdateClientCertificate","description":"Changes information about an <a>ClientCertificate</a> resource.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClientCertificate"}}}},"480":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"481":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}},"482":{"description":"LimitExceededException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LimitExceededException"}}}},"483":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"484":{"description":"UnauthorizedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedException"}}}},"485":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}}},"parameters":[{"name":"clientcertificate_id","in":"path","required":true,"description":"[Required] The identifier of the <a>ClientCertificate</a> resource to be updated.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"patchOperations":{"description":"A list of operations describing the updates to apply to the specified resource. The patches are applied in the order specified in the list.","type":"array","items":{"$ref":"#/components/schemas/PatchOperation"}}}}}}}}},"/restapis/{restapi_id}/deployments/{deployment_id}":{"delete":{"operationId":"DeleteDeployment","description":"Deletes a <a>Deployment</a> resource. Deleting a deployment will only succeed if there are no <a>Stage</a> resources associated with it.","responses":{"202":{"description":"Success"},"480":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"481":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}},"482":{"description":"LimitExceededException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LimitExceededException"}}}},"483":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"484":{"description":"UnauthorizedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedException"}}}},"485":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}}},"parameters":[{"name":"restapi_id","in":"path","required":true,"description":"[Required] The string identifier of the associated <a>RestApi</a>.","schema":{"type":"string"}},{"name":"deployment_id","in":"path","required":true,"description":"[Required] The identifier of the <a>Deployment</a> resource to delete.","schema":{"type":"string"}}]},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}],"get":{"operationId":"GetDeployment","description":"Gets information about a <a>Deployment</a> resource.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Deployment"}}}},"480":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"481":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"482":{"description":"UnauthorizedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedException"}}}},"483":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}},"484":{"description":"ServiceUnavailableException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceUnavailableException"}}}}},"parameters":[{"name":"restapi_id","in":"path","required":true,"description":"[Required] The string identifier of the associated <a>RestApi</a>.","schema":{"type":"string"}},{"name":"deployment_id","in":"path","required":true,"description":"[Required] The identifier of the <a>Deployment</a> resource to get information about.","schema":{"type":"string"}},{"name":"embed","in":"query","required":false,"description":"A query parameter to retrieve the specified embedded resources of the returned <a>Deployment</a> resource in the response. In a REST API call, this <code>embed</code> parameter value is a list of comma-separated strings, as in <code>GET /restapis/{restapi_id}/deployments/{deployment_id}?embed=var1,var2</code>. The SDK and other platform-dependent libraries might use a different format for the list. Currently, this request supports only retrieval of the embedded API summary this way. Hence, the parameter value must be a single-valued list containing only the <code>\"apisummary\"</code> string. For example, <code>GET /restapis/{restapi_id}/deployments/{deployment_id}?embed=apisummary</code>.","schema":{"type":"array","items":{"$ref":"#/components/schemas/String"}}}]},"patch":{"operationId":"UpdateDeployment","description":"Changes information about a <a>Deployment</a> resource.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Deployment"}}}},"480":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"481":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}},"482":{"description":"LimitExceededException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LimitExceededException"}}}},"483":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"484":{"description":"UnauthorizedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedException"}}}},"485":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}},"486":{"description":"ServiceUnavailableException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceUnavailableException"}}}}},"parameters":[{"name":"restapi_id","in":"path","required":true,"description":"[Required] The string identifier of the associated <a>RestApi</a>.","schema":{"type":"string"}},{"name":"deployment_id","in":"path","required":true,"description":"The replacement identifier for the <a>Deployment</a> resource to change information about.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"patchOperations":{"description":"A list of operations describing the updates to apply to the specified resource. The patches are applied in the order specified in the list.","type":"array","items":{"$ref":"#/components/schemas/PatchOperation"}}}}}}}}},"/restapis/{restapi_id}/documentation/parts/{part_id}":{"delete":{"operationId":"DeleteDocumentationPart","description":"","responses":{"202":{"description":"Success"},"480":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"481":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}},"482":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"483":{"description":"UnauthorizedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedException"}}}},"484":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}}},"parameters":[{"name":"restapi_id","in":"path","required":true,"description":"[Required] The string identifier of the associated <a>RestApi</a>.","schema":{"type":"string"}},{"name":"part_id","in":"path","required":true,"description":"[Required] The identifier of the to-be-deleted documentation part.","schema":{"type":"string"}}]},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}],"get":{"operationId":"GetDocumentationPart","description":"","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentationPart"}}}},"480":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"481":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"482":{"description":"UnauthorizedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedException"}}}},"483":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}}},"parameters":[{"name":"restapi_id","in":"path","required":true,"description":"[Required] The string identifier of the associated <a>RestApi</a>.","schema":{"type":"string"}},{"name":"part_id","in":"path","required":true,"description":"[Required] The string identifier of the associated <a>RestApi</a>.","schema":{"type":"string"}}]},"patch":{"operationId":"UpdateDocumentationPart","description":"","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentationPart"}}}},"480":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"481":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}},"482":{"description":"LimitExceededException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LimitExceededException"}}}},"483":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"484":{"description":"UnauthorizedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedException"}}}},"485":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}}},"parameters":[{"name":"restapi_id","in":"path","required":true,"description":"[Required] The string identifier of the associated <a>RestApi</a>.","schema":{"type":"string"}},{"name":"part_id","in":"path","required":true,"description":"[Required] The identifier of the to-be-updated documentation part.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"patchOperations":{"description":"A list of operations describing the updates to apply to the specified resource. The patches are applied in the order specified in the list.","type":"array","items":{"$ref":"#/components/schemas/PatchOperation"}}}}}}}}},"/restapis/{restapi_id}/documentation/versions/{doc_version}":{"delete":{"operationId":"DeleteDocumentationVersion","description":"","responses":{"202":{"description":"Success"},"480":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"481":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}},"482":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"483":{"description":"UnauthorizedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedException"}}}},"484":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}}},"parameters":[{"name":"restapi_id","in":"path","required":true,"description":"[Required] The string identifier of the associated <a>RestApi</a>.","schema":{"type":"string"}},{"name":"doc_version","in":"path","required":true,"description":"[Required] The version identifier of a to-be-deleted documentation snapshot.","schema":{"type":"string"}}]},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}],"get":{"operationId":"GetDocumentationVersion","description":"","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentationVersion"}}}},"480":{"description":"UnauthorizedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedException"}}}},"481":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"482":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}}},"parameters":[{"name":"restapi_id","in":"path","required":true,"description":"[Required] The string identifier of the associated <a>RestApi</a>.","schema":{"type":"string"}},{"name":"doc_version","in":"path","required":true,"description":"[Required] The version identifier of the to-be-retrieved documentation snapshot.","schema":{"type":"string"}}]},"patch":{"operationId":"UpdateDocumentationVersion","description":"","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentationVersion"}}}},"480":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"481":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}},"482":{"description":"LimitExceededException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LimitExceededException"}}}},"483":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"484":{"description":"UnauthorizedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedException"}}}},"485":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}}},"parameters":[{"name":"restapi_id","in":"path","required":true,"description":"[Required] The string identifier of the associated <a>RestApi</a>..","schema":{"type":"string"}},{"name":"doc_version","in":"path","required":true,"description":"[Required] The version identifier of the to-be-updated documentation version.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"patchOperations":{"description":"A list of operations describing the updates to apply to the specified resource. The patches are applied in the order specified in the list.","type":"array","items":{"$ref":"#/components/schemas/PatchOperation"}}}}}}}}},"/domainnames/{domain_name}":{"delete":{"operationId":"DeleteDomainName","description":"Deletes the <a>DomainName</a> resource.","responses":{"202":{"description":"Success"},"480":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"481":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}},"482":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"483":{"description":"UnauthorizedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedException"}}}},"484":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}}},"parameters":[{"name":"domain_name","in":"path","required":true,"description":"[Required] The name of the <a>DomainName</a> resource to be deleted.","schema":{"type":"string"}}]},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}],"get":{"operationId":"GetDomainName","description":"Represents a domain name that is contained in a simpler, more intuitive URL that can be called.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DomainName"}}}},"480":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"481":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"482":{"description":"UnauthorizedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedException"}}}},"483":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}}},"parameters":[{"name":"domain_name","in":"path","required":true,"description":"[Required] The name of the <a>DomainName</a> resource.","schema":{"type":"string"}}]},"patch":{"operationId":"UpdateDomainName","description":"Changes information about the <a>DomainName</a> resource.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DomainName"}}}},"480":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"481":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}},"482":{"description":"LimitExceededException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LimitExceededException"}}}},"483":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"484":{"description":"UnauthorizedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedException"}}}},"485":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}}},"parameters":[{"name":"domain_name","in":"path","required":true,"description":"[Required] The name of the <a>DomainName</a> resource to be changed.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"patchOperations":{"description":"A list of operations describing the updates to apply to the specified resource. The patches are applied in the order specified in the list.","type":"array","items":{"$ref":"#/components/schemas/PatchOperation"}}}}}}}}},"/restapis/{restapi_id}/gatewayresponses/{response_type}":{"delete":{"operationId":"DeleteGatewayResponse","description":"Clears any customization of a <a>GatewayResponse</a> of a specified response type on the given <a>RestApi</a> and resets it with the default settings.","responses":{"202":{"description":"Success"},"480":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"481":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}},"482":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"483":{"description":"UnauthorizedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedException"}}}},"484":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}}},"parameters":[{"name":"restapi_id","in":"path","required":true,"description":"[Required] The string identifier of the associated <a>RestApi</a>.","schema":{"type":"string"}},{"name":"response_type","in":"path","required":true,"description":"<p>[Required] <p>The response type of the associated <a>GatewayResponse</a>.</p></p>","schema":{"type":"string","enum":["DEFAULT_4XX","DEFAULT_5XX","RESOURCE_NOT_FOUND","UNAUTHORIZED","INVALID_API_KEY","ACCESS_DENIED","AUTHORIZER_FAILURE","AUTHORIZER_CONFIGURATION_ERROR","INVALID_SIGNATURE","EXPIRED_TOKEN","MISSING_AUTHENTICATION_TOKEN","INTEGRATION_FAILURE","INTEGRATION_TIMEOUT","API_CONFIGURATION_ERROR","UNSUPPORTED_MEDIA_TYPE","BAD_REQUEST_PARAMETERS","BAD_REQUEST_BODY","REQUEST_TOO_LARGE","THROTTLED","QUOTA_EXCEEDED","WAF_FILTERED"]}}]},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}],"get":{"operationId":"GetGatewayResponse","description":"Gets a <a>GatewayResponse</a> of a specified response type on the given <a>RestApi</a>.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GatewayResponse"}}}},"480":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"481":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"482":{"description":"UnauthorizedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedException"}}}},"483":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}}},"parameters":[{"name":"restapi_id","in":"path","required":true,"description":"[Required] The string identifier of the associated <a>RestApi</a>.","schema":{"type":"string"}},{"name":"response_type","in":"path","required":true,"description":"<p>[Required] <p>The response type of the associated <a>GatewayResponse</a>.</p></p>","schema":{"type":"string","enum":["DEFAULT_4XX","DEFAULT_5XX","RESOURCE_NOT_FOUND","UNAUTHORIZED","INVALID_API_KEY","ACCESS_DENIED","AUTHORIZER_FAILURE","AUTHORIZER_CONFIGURATION_ERROR","INVALID_SIGNATURE","EXPIRED_TOKEN","MISSING_AUTHENTICATION_TOKEN","INTEGRATION_FAILURE","INTEGRATION_TIMEOUT","API_CONFIGURATION_ERROR","UNSUPPORTED_MEDIA_TYPE","BAD_REQUEST_PARAMETERS","BAD_REQUEST_BODY","REQUEST_TOO_LARGE","THROTTLED","QUOTA_EXCEEDED","WAF_FILTERED"]}}]},"put":{"operationId":"PutGatewayResponse","description":"Creates a customization of a <a>GatewayResponse</a> of a specified response type and status code on the given <a>RestApi</a>.","responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GatewayResponse"}}}},"480":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"481":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}},"482":{"description":"LimitExceededException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LimitExceededException"}}}},"483":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"484":{"description":"UnauthorizedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedException"}}}},"485":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}}},"parameters":[{"name":"restapi_id","in":"path","required":true,"description":"[Required] The string identifier of the associated <a>RestApi</a>.","schema":{"type":"string"}},{"name":"response_type","in":"path","required":true,"description":"<p>[Required] <p>The response type of the associated <a>GatewayResponse</a>.</p></p>","schema":{"type":"string","enum":["DEFAULT_4XX","DEFAULT_5XX","RESOURCE_NOT_FOUND","UNAUTHORIZED","INVALID_API_KEY","ACCESS_DENIED","AUTHORIZER_FAILURE","AUTHORIZER_CONFIGURATION_ERROR","INVALID_SIGNATURE","EXPIRED_TOKEN","MISSING_AUTHENTICATION_TOKEN","INTEGRATION_FAILURE","INTEGRATION_TIMEOUT","API_CONFIGURATION_ERROR","UNSUPPORTED_MEDIA_TYPE","BAD_REQUEST_PARAMETERS","BAD_REQUEST_BODY","REQUEST_TOO_LARGE","THROTTLED","QUOTA_EXCEEDED","WAF_FILTERED"]}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"statusCode":{"description":"The status code.","type":"string","pattern":"[1-5]\\d\\d"},"responseParameters":{"description":"<p><p>Response parameters (paths, query strings and headers) of the <a>GatewayResponse</a> as a string-to-string map of key-value pairs.</p></p>","type":"object","additionalProperties":{"$ref":"#/components/schemas/String"}},"responseTemplates":{"description":"<p><p>Response templates of the <a>GatewayResponse</a> as a string-to-string map of key-value pairs.</p></p>","type":"object","additionalProperties":{"$ref":"#/components/schemas/String"}}}}}}}},"patch":{"operationId":"UpdateGatewayResponse","description":"Updates a <a>GatewayResponse</a> of a specified response type on the given <a>RestApi</a>.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GatewayResponse"}}}},"480":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"481":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}},"482":{"description":"LimitExceededException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LimitExceededException"}}}},"483":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"484":{"description":"UnauthorizedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedException"}}}},"485":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}}},"parameters":[{"name":"restapi_id","in":"path","required":true,"description":"[Required] The string identifier of the associated <a>RestApi</a>.","schema":{"type":"string"}},{"name":"response_type","in":"path","required":true,"description":"<p>[Required] <p>The response type of the associated <a>GatewayResponse</a>.</p></p>","schema":{"type":"string","enum":["DEFAULT_4XX","DEFAULT_5XX","RESOURCE_NOT_FOUND","UNAUTHORIZED","INVALID_API_KEY","ACCESS_DENIED","AUTHORIZER_FAILURE","AUTHORIZER_CONFIGURATION_ERROR","INVALID_SIGNATURE","EXPIRED_TOKEN","MISSING_AUTHENTICATION_TOKEN","INTEGRATION_FAILURE","INTEGRATION_TIMEOUT","API_CONFIGURATION_ERROR","UNSUPPORTED_MEDIA_TYPE","BAD_REQUEST_PARAMETERS","BAD_REQUEST_BODY","REQUEST_TOO_LARGE","THROTTLED","QUOTA_EXCEEDED","WAF_FILTERED"]}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"patchOperations":{"description":"A list of operations describing the updates to apply to the specified resource. The patches are applied in the order specified in the list.","type":"array","items":{"$ref":"#/components/schemas/PatchOperation"}}}}}}}}},"/restapis/{restapi_id}/resources/{resource_id}/methods/{http_method}/integration":{"delete":{"operationId":"DeleteIntegration","description":"Represents a delete integration.","responses":{"204":{"description":"Success"},"480":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"481":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}},"482":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"483":{"description":"UnauthorizedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedException"}}}},"484":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}}},"parameters":[{"name":"restapi_id","in":"path","required":true,"description":"[Required] The string identifier of the associated <a>RestApi</a>.","schema":{"type":"string"}},{"name":"resource_id","in":"path","required":true,"description":"[Required] Specifies a delete integration request's resource identifier.","schema":{"type":"string"}},{"name":"http_method","in":"path","required":true,"description":"[Required] Specifies a delete integration request's HTTP method.","schema":{"type":"string"}}]},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}],"get":{"operationId":"GetIntegration","description":"Get the integration settings.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Integration"}}}},"480":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"481":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"482":{"description":"UnauthorizedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedException"}}}},"483":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}}},"parameters":[{"name":"restapi_id","in":"path","required":true,"description":"[Required] The string identifier of the associated <a>RestApi</a>.","schema":{"type":"string"}},{"name":"resource_id","in":"path","required":true,"description":"[Required] Specifies a get integration request's resource identifier","schema":{"type":"string"}},{"name":"http_method","in":"path","required":true,"description":"[Required] Specifies a get integration request's HTTP method.","schema":{"type":"string"}}]},"put":{"operationId":"PutIntegration","description":"Sets up a method's integration.","responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Integration"}}}},"480":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"481":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}},"482":{"description":"LimitExceededException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LimitExceededException"}}}},"483":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"484":{"description":"UnauthorizedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedException"}}}},"485":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}}},"parameters":[{"name":"restapi_id","in":"path","required":true,"description":"[Required] The string identifier of the associated <a>RestApi</a>.","schema":{"type":"string"}},{"name":"resource_id","in":"path","required":true,"description":"[Required] Specifies a put integration request's resource ID.","schema":{"type":"string"}},{"name":"http_method","in":"path","required":true,"description":"[Required] Specifies a put integration request's HTTP method.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["type"],"properties":{"type":{"description":"The integration type. The valid value is <code>HTTP</code> for integrating an API method with an HTTP backend; <code>AWS</code> with any AWS service endpoints; <code>MOCK</code> for testing without actually invoking the backend; <code>HTTP_PROXY</code> for integrating with the HTTP proxy integration; <code>AWS_PROXY</code> for integrating with the Lambda proxy integration. ","type":"string","enum":["HTTP","AWS","MOCK","HTTP_PROXY","AWS_PROXY"]},"httpMethod":{"description":"Specifies a put integration HTTP method. When the integration type is HTTP or AWS, this field is required.","type":"string"},"uri":{"description":"<p>Specifies Uniform Resource Identifier (URI) of the integration endpoint.</p> <ul> <li><p> For <code>HTTP</code> or <code>HTTP_PROXY</code> integrations, the URI must be a fully formed, encoded HTTP(S) URL according to the <a href=\"https://en.wikipedia.org/wiki/Uniform_Resource_Identifier\" target=\"_blank\">RFC-3986 specification</a>, for either standard integration, where <code>connectionType</code> is not <code>VPC_LINK</code>, or private integration, where <code>connectionType</code> is <code>VPC_LINK</code>. For a private HTTP integration, the URI is not used for routing. </p> </li> <li><p> For <code>AWS</code> or <code>AWS_PROXY</code> integrations, the URI is of the form <code>arn:aws:apigateway:{region}:{subdomain.service|service}:path|action/{service_api}</code>. Here, <code>{Region}</code> is the API Gateway region (e.g., <code>us-east-1</code>); <code>{service}</code> is the name of the integrated AWS service (e.g., <code>s3</code>); and <code>{subdomain}</code> is a designated subdomain supported by certain AWS service for fast host-name lookup. <code>action</code> can be used for an AWS service action-based API, using an <code>Action={name}&{p1}={v1}&p2={v2}...</code> query string. The ensuing <code>{service_api}</code> refers to a supported action <code>{name}</code> plus any required input parameters. Alternatively, <code>path</code> can be used for an AWS service path-based API. The ensuing <code>service_api</code> refers to the path to an AWS service resource, including the region of the integrated AWS service, if applicable. For example, for integration with the S3 API of <code><a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/RESTObjectGET.html\">GetObject</a></code>, the <code>uri</code> can be either <code>arn:aws:apigateway:us-west-2:s3:action/GetObject&Bucket={bucket}&Key={key}</code> or <code>arn:aws:apigateway:us-west-2:s3:path/{bucket}/{key}</code></p> </li></ul>","type":"string"},"connectionType":{"description":"The type of the network connection to the integration endpoint. The valid value is <code>INTERNET</code> for connections through the public routable internet or <code>VPC_LINK</code> for private connections between API Gateway and a network load balancer in a VPC. The default value is <code>INTERNET</code>.","type":"string","enum":["INTERNET","VPC_LINK"]},"connectionId":{"description":"The (<a href=\"https://docs.aws.amazon.com/apigateway/api-reference/resource/vpc-link/#id\"><code>id</code></a>) of the <a>VpcLink</a> used for the integration when <code>connectionType=VPC_LINK</code> and undefined, otherwise.","type":"string"},"credentials":{"description":"Specifies whether credentials are required for a put integration.","type":"string"},"requestParameters":{"description":"A key-value map specifying request parameters that are passed from the method request to the back end. The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the back end. The method request parameter value must match the pattern of <code>method.request.{location}.{name}</code>, where <code>location</code> is <code>querystring</code>, <code>path</code>, or <code>header</code> and <code>name</code> must be a valid and unique method request parameter name.","type":"object","additionalProperties":{"$ref":"#/components/schemas/String"}},"requestTemplates":{"description":"Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value.","type":"object","additionalProperties":{"$ref":"#/components/schemas/String"}},"passthroughBehavior":{"description":"<p>Specifies the pass-through behavior for incoming requests based on the Content-Type header in the request, and the available mapping templates specified as the <code>requestTemplates</code> property on the Integration resource. There are three valid values: <code>WHEN_NO_MATCH</code>, <code>WHEN_NO_TEMPLATES</code>, and <code>NEVER</code>. </p> <ul> <li><p><code>WHEN_NO_MATCH</code> passes the request body for unmapped content types through to the integration back end without transformation.</p></li> <li><p><code>NEVER</code> rejects unmapped content types with an HTTP 415 'Unsupported Media Type' response.</p></li> <li><p><code>WHEN_NO_TEMPLATES</code> allows pass-through when the integration has NO content types mapped to templates. However if there is at least one content type defined, unmapped content types will be rejected with the same 415 response.</p></li> </ul>","type":"string"},"cacheNamespace":{"description":"Specifies a group of related cached parameters. By default, API Gateway uses the resource ID as the <code>cacheNamespace</code>. You can specify the same <code>cacheNamespace</code> across resources to return the same cached data for requests to different resources.","type":"string"},"cacheKeyParameters":{"description":"A list of request parameters whose values API Gateway caches. To be valid values for <code>cacheKeyParameters</code>, these parameters must also be specified for <a>Method</a> <code>requestParameters</code>.","type":"array","items":{"$ref":"#/components/schemas/String"}},"contentHandling":{"description":"<p>Specifies how to handle request payload content type conversions. Supported values are <code>CONVERT_TO_BINARY</code> and <code>CONVERT_TO_TEXT</code>, with the following behaviors:</p> <ul> <li><p><code>CONVERT_TO_BINARY</code>: Converts a request payload from a Base64-encoded string to the corresponding binary blob.</p></li> <li><p><code>CONVERT_TO_TEXT</code>: Converts a request payload from a binary blob to a Base64-encoded string.</p></li> </ul> <p>If this property is not defined, the request payload will be passed through from the method request to integration request without modification, provided that the <code>passthroughBehavior</code> is configured to support payload pass-through.</p>","type":"string","enum":["CONVERT_TO_BINARY","CONVERT_TO_TEXT"]},"timeoutInMillis":{"description":"Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds.","type":"integer"},"tlsConfig":{"description":"","type":"object","properties":{"insecureSkipVerification":{"allOf":[{"$ref":"#/components/schemas/Boolean"},{"description":"Specifies whether or not API Gateway skips verification that the certificate for an integration endpoint is issued by a <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-supported-certificate-authorities-for-http-endpoints.html\">supported certificate authority</a>. This isn’t recommended, but it enables you to use certificates that are signed by private certificate authorities, or certificates that are self-signed. If enabled, API Gateway still performs basic certificate validation, which includes checking the certificate's expiration date, hostname, and presence of a root certificate authority. Supported only for <code>HTTP</code> and <code>HTTP_PROXY</code> integrations."}]}}}}}}}}},"patch":{"operationId":"UpdateIntegration","description":"Represents an update integration.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Integration"}}}},"480":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"481":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}},"482":{"description":"LimitExceededException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LimitExceededException"}}}},"483":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"484":{"description":"UnauthorizedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedException"}}}},"485":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}}},"parameters":[{"name":"restapi_id","in":"path","required":true,"description":"[Required] The string identifier of the associated <a>RestApi</a>.","schema":{"type":"string"}},{"name":"resource_id","in":"path","required":true,"description":"[Required] Represents an update integration request's resource identifier.","schema":{"type":"string"}},{"name":"http_method","in":"path","required":true,"description":"[Required] Represents an update integration request's HTTP method.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"patchOperations":{"description":"A list of operations describing the updates to apply to the specified resource. The patches are applied in the order specified in the list.","type":"array","items":{"$ref":"#/components/schemas/PatchOperation"}}}}}}}}},"/restapis/{restapi_id}/resources/{resource_id}/methods/{http_method}/integration/responses/{status_code}":{"delete":{"operationId":"DeleteIntegrationResponse","description":"Represents a delete integration response.","responses":{"204":{"description":"Success"},"480":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"481":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}},"482":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"483":{"description":"UnauthorizedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedException"}}}},"484":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}}},"parameters":[{"name":"restapi_id","in":"path","required":true,"description":"[Required] The string identifier of the associated <a>RestApi</a>.","schema":{"type":"string"}},{"name":"resource_id","in":"path","required":true,"description":"[Required] Specifies a delete integration response request's resource identifier.","schema":{"type":"string"}},{"name":"http_method","in":"path","required":true,"description":"[Required] Specifies a delete integration response request's HTTP method.","schema":{"type":"string"}},{"name":"status_code","in":"path","required":true,"description":"[Required] Specifies a delete integration response request's status code.","schema":{"type":"string","pattern":"[1-5]\\d\\d","description":"The status code."}}]},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}],"get":{"operationId":"GetIntegrationResponse","description":"Represents a get integration response.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IntegrationResponse"}}}},"480":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"481":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"482":{"description":"UnauthorizedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedException"}}}},"483":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}}},"parameters":[{"name":"restapi_id","in":"path","required":true,"description":"[Required] The string identifier of the associated <a>RestApi</a>.","schema":{"type":"string"}},{"name":"resource_id","in":"path","required":true,"description":"[Required] Specifies a get integration response request's resource identifier.","schema":{"type":"string"}},{"name":"http_method","in":"path","required":true,"description":"[Required] Specifies a get integration response request's HTTP method.","schema":{"type":"string"}},{"name":"status_code","in":"path","required":true,"description":"[Required] Specifies a get integration response request's status code.","schema":{"type":"string","pattern":"[1-5]\\d\\d","description":"The status code."}}]},"put":{"operationId":"PutIntegrationResponse","description":"Represents a put integration.","responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IntegrationResponse"}}}},"480":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"481":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}},"482":{"description":"LimitExceededException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LimitExceededException"}}}},"483":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"484":{"description":"UnauthorizedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedException"}}}},"485":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}}},"parameters":[{"name":"restapi_id","in":"path","required":true,"description":"[Required] The string identifier of the associated <a>RestApi</a>.","schema":{"type":"string"}},{"name":"resource_id","in":"path","required":true,"description":"[Required] Specifies a put integration response request's resource identifier.","schema":{"type":"string"}},{"name":"http_method","in":"path","required":true,"description":"[Required] Specifies a put integration response request's HTTP method.","schema":{"type":"string"}},{"name":"status_code","in":"path","required":true,"description":"[Required] Specifies the status code that is used to map the integration response to an existing <a>MethodResponse</a>.","schema":{"type":"string","pattern":"[1-5]\\d\\d","description":"The status code."}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"selectionPattern":{"description":"Specifies the selection pattern of a put integration response.","type":"string"},"responseParameters":{"description":"A key-value map specifying response parameters that are passed to the method response from the back end. The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of <code>method.response.header.{name}</code>, where <code>name</code> is a valid and unique header name. The mapped non-static value must match the pattern of <code>integration.response.header.{name}</code> or <code>integration.response.body.{JSON-expression}</code>, where <code>name</code> must be a valid and unique response header name and <code>JSON-expression</code> a valid JSON expression without the <code>$</code> prefix.","type":"object","additionalProperties":{"$ref":"#/components/schemas/String"}},"responseTemplates":{"description":"Specifies a put integration response's templates.","type":"object","additionalProperties":{"$ref":"#/components/schemas/String"}},"contentHandling":{"description":"<p>Specifies how to handle response payload content type conversions. Supported values are <code>CONVERT_TO_BINARY</code> and <code>CONVERT_TO_TEXT</code>, with the following behaviors:</p> <ul> <li><p><code>CONVERT_TO_BINARY</code>: Converts a response payload from a Base64-encoded string to the corresponding binary blob.</p></li> <li><p><code>CONVERT_TO_TEXT</code>: Converts a response payload from a binary blob to a Base64-encoded string.</p></li> </ul> <p>If this property is not defined, the response payload will be passed through from the integration response to the method response without modification.</p>","type":"string","enum":["CONVERT_TO_BINARY","CONVERT_TO_TEXT"]}}}}}}},"patch":{"operationId":"UpdateIntegrationResponse","description":"Represents an update integration response.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IntegrationResponse"}}}},"480":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"481":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}},"482":{"description":"LimitExceededException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LimitExceededException"}}}},"483":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"484":{"description":"UnauthorizedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedException"}}}},"485":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}}},"parameters":[{"name":"restapi_id","in":"path","required":true,"description":"[Required] The string identifier of the associated <a>RestApi</a>.","schema":{"type":"string"}},{"name":"resource_id","in":"path","required":true,"description":"[Required] Specifies an update integration response request's resource identifier.","schema":{"type":"string"}},{"name":"http_method","in":"path","required":true,"description":"[Required] Specifies an update integration response request's HTTP method.","schema":{"type":"string"}},{"name":"status_code","in":"path","required":true,"description":"[Required] Specifies an update integration response request's status code.","schema":{"type":"string","pattern":"[1-5]\\d\\d","description":"The status code."}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"patchOperations":{"description":"A list of operations describing the updates to apply to the specified resource. The patches are applied in the order specified in the list.","type":"array","items":{"$ref":"#/components/schemas/PatchOperation"}}}}}}}}},"/restapis/{restapi_id}/resources/{resource_id}/methods/{http_method}":{"delete":{"operationId":"DeleteMethod","description":"Deletes an existing <a>Method</a> resource.","responses":{"204":{"description":"Success"},"480":{"description":"UnauthorizedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedException"}}}},"481":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"482":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}},"483":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}}},"parameters":[{"name":"restapi_id","in":"path","required":true,"description":"[Required] The string identifier of the associated <a>RestApi</a>.","schema":{"type":"string"}},{"name":"resource_id","in":"path","required":true,"description":"[Required] The <a>Resource</a> identifier for the <a>Method</a> resource.","schema":{"type":"string"}},{"name":"http_method","in":"path","required":true,"description":"[Required] The HTTP verb of the <a>Method</a> resource.","schema":{"type":"string"}}]},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}],"get":{"operationId":"GetMethod","description":"Describe an existing <a>Method</a> resource.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Method"}}}},"480":{"description":"UnauthorizedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedException"}}}},"481":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"482":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}}},"parameters":[{"name":"restapi_id","in":"path","required":true,"description":"[Required] The string identifier of the associated <a>RestApi</a>.","schema":{"type":"string"}},{"name":"resource_id","in":"path","required":true,"description":"[Required] The <a>Resource</a> identifier for the <a>Method</a> resource.","schema":{"type":"string"}},{"name":"http_method","in":"path","required":true,"description":"[Required] Specifies the method request's HTTP method type.","schema":{"type":"string"}}]},"put":{"operationId":"PutMethod","description":"Add a method to an existing <a>Resource</a> resource.","responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Method"}}}},"480":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"481":{"description":"UnauthorizedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedException"}}}},"482":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"483":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}},"484":{"description":"LimitExceededException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LimitExceededException"}}}},"485":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}}},"parameters":[{"name":"restapi_id","in":"path","required":true,"description":"[Required] The string identifier of the associated <a>RestApi</a>.","schema":{"type":"string"}},{"name":"resource_id","in":"path","required":true,"description":"[Required] The <a>Resource</a> identifier for the new <a>Method</a> resource.","schema":{"type":"string"}},{"name":"http_method","in":"path","required":true,"description":"[Required] Specifies the method request's HTTP method type.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["authorizationType"],"properties":{"authorizationType":{"description":"[Required] The method's authorization type. Valid values are <code>NONE</code> for open access, <code>AWS_IAM</code> for using AWS IAM permissions, <code>CUSTOM</code> for using a custom authorizer, or <code>COGNITO_USER_POOLS</code> for using a Cognito user pool.","type":"string"},"authorizerId":{"description":"Specifies the identifier of an <a>Authorizer</a> to use on this Method, if the type is CUSTOM or COGNITO_USER_POOLS. The authorizer identifier is generated by API Gateway when you created the authorizer.","type":"string"},"apiKeyRequired":{"description":"Specifies whether the method required a valid <a>ApiKey</a>.","type":"boolean"},"operationName":{"description":"A human-friendly operation identifier for the method. For example, you can assign the <code>operationName</code> of <code>ListPets</code> for the <code>GET /pets</code> method in the <code>PetStore</code> example.","type":"string"},"requestParameters":{"description":"A key-value map defining required or optional method request parameters that can be accepted by API Gateway. A key defines a method request parameter name matching the pattern of <code>method.request.{location}.{name}</code>, where <code>location</code> is <code>querystring</code>, <code>path</code>, or <code>header</code> and <code>name</code> is a valid and unique parameter name. The value associated with the key is a Boolean flag indicating whether the parameter is required (<code>true</code>) or optional (<code>false</code>). The method request parameter names defined here are available in <a>Integration</a> to be mapped to integration request parameters or body-mapping templates.","type":"object","additionalProperties":{"$ref":"#/components/schemas/NullableBoolean"}},"requestModels":{"description":"Specifies the <a>Model</a> resources used for the request's content type. Request models are represented as a key/value map, with a content type as the key and a <a>Model</a> name as the value.","type":"object","additionalProperties":{"$ref":"#/components/schemas/String"}},"requestValidatorId":{"description":"The identifier of a <a>RequestValidator</a> for validating the method request.","type":"string"},"authorizationScopes":{"description":"A list of authorization scopes configured on the method. The scopes are used with a <code>COGNITO_USER_POOLS</code> authorizer to authorize the method invocation. The authorization works by matching the method scopes against the scopes parsed from the access token in the incoming request. The method invocation is authorized if any method scopes matches a claimed scope in the access token. Otherwise, the invocation is not authorized. When the method scope is configured, the client must provide an access token instead of an identity token for authorization purposes.","type":"array","items":{"$ref":"#/components/schemas/String"}}}}}}}},"post":{"operationId":"TestInvokeMethod","description":"Simulate the execution of a <a>Method</a> in your <a>RestApi</a> with headers, parameters, and an incoming request body.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TestInvokeMethodResponse"}}}},"480":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"481":{"description":"UnauthorizedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedException"}}}},"482":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"483":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}}},"parameters":[{"name":"restapi_id","in":"path","required":true,"description":"[Required] The string identifier of the associated <a>RestApi</a>.","schema":{"type":"string"}},{"name":"resource_id","in":"path","required":true,"description":"[Required] Specifies a test invoke method request's resource ID.","schema":{"type":"string"}},{"name":"http_method","in":"path","required":true,"description":"[Required] Specifies a test invoke method request's HTTP method.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"pathWithQueryString":{"description":"The URI path, including query string, of the simulated invocation request. Use this to specify path parameters and query string parameters.","type":"string"},"body":{"description":"The simulated request body of an incoming invocation request.","type":"string"},"headers":{"description":"A key-value map of headers to simulate an incoming invocation request.","type":"object","additionalProperties":{"$ref":"#/components/schemas/String"}},"multiValueHeaders":{"description":"The headers as a map from string to list of values to simulate an incoming invocation request.","type":"object","additionalProperties":{"$ref":"#/components/schemas/ListOfString"}},"clientCertificateId":{"description":"A <a>ClientCertificate</a> identifier to use in the test invocation. API Gateway will use the certificate when making the HTTPS request to the defined back-end endpoint.","type":"string"},"stageVariables":{"description":"A key-value map of stage variables to simulate an invocation on a deployed <a>Stage</a>.","type":"object","additionalProperties":{"$ref":"#/components/schemas/String"}}}}}}}},"patch":{"operationId":"UpdateMethod","description":"Updates an existing <a>Method</a> resource.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Method"}}}},"480":{"description":"UnauthorizedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedException"}}}},"481":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"482":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"483":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}},"484":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}}},"parameters":[{"name":"restapi_id","in":"path","required":true,"description":"[Required] The string identifier of the associated <a>RestApi</a>.","schema":{"type":"string"}},{"name":"resource_id","in":"path","required":true,"description":"[Required] The <a>Resource</a> identifier for the <a>Method</a> resource.","schema":{"type":"string"}},{"name":"http_method","in":"path","required":true,"description":"[Required] The HTTP verb of the <a>Method</a> resource.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"patchOperations":{"description":"A list of operations describing the updates to apply to the specified resource. The patches are applied in the order specified in the list.","type":"array","items":{"$ref":"#/components/schemas/PatchOperation"}}}}}}}}},"/restapis/{restapi_id}/resources/{resource_id}/methods/{http_method}/responses/{status_code}":{"delete":{"operationId":"DeleteMethodResponse","description":"Deletes an existing <a>MethodResponse</a> resource.","responses":{"204":{"description":"Success"},"480":{"description":"UnauthorizedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedException"}}}},"481":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"482":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}},"483":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"484":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}}},"parameters":[{"name":"restapi_id","in":"path","required":true,"description":"[Required] The string identifier of the associated <a>RestApi</a>.","schema":{"type":"string"}},{"name":"resource_id","in":"path","required":true,"description":"[Required] The <a>Resource</a> identifier for the <a>MethodResponse</a> resource.","schema":{"type":"string"}},{"name":"http_method","in":"path","required":true,"description":"[Required] The HTTP verb of the <a>Method</a> resource.","schema":{"type":"string"}},{"name":"status_code","in":"path","required":true,"description":"[Required] The status code identifier for the <a>MethodResponse</a> resource.","schema":{"type":"string","pattern":"[1-5]\\d\\d","description":"The status code."}}]},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}],"get":{"operationId":"GetMethodResponse","description":"Describes a <a>MethodResponse</a> resource.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MethodResponse"}}}},"480":{"description":"UnauthorizedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedException"}}}},"481":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"482":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}}},"parameters":[{"name":"restapi_id","in":"path","required":true,"description":"[Required] The string identifier of the associated <a>RestApi</a>.","schema":{"type":"string"}},{"name":"resource_id","in":"path","required":true,"description":"[Required] The <a>Resource</a> identifier for the <a>MethodResponse</a> resource.","schema":{"type":"string"}},{"name":"http_method","in":"path","required":true,"description":"[Required] The HTTP verb of the <a>Method</a> resource.","schema":{"type":"string"}},{"name":"status_code","in":"path","required":true,"description":"[Required] The status code for the <a>MethodResponse</a> resource.","schema":{"type":"string","pattern":"[1-5]\\d\\d","description":"The status code."}}]},"put":{"operationId":"PutMethodResponse","description":"Adds a <a>MethodResponse</a> to an existing <a>Method</a> resource.","responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MethodResponse"}}}},"480":{"description":"UnauthorizedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedException"}}}},"481":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"482":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}},"483":{"description":"LimitExceededException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LimitExceededException"}}}},"484":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"485":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}}},"parameters":[{"name":"restapi_id","in":"path","required":true,"description":"[Required] The string identifier of the associated <a>RestApi</a>.","schema":{"type":"string"}},{"name":"resource_id","in":"path","required":true,"description":"[Required] The <a>Resource</a> identifier for the <a>Method</a> resource.","schema":{"type":"string"}},{"name":"http_method","in":"path","required":true,"description":"[Required] The HTTP verb of the <a>Method</a> resource.","schema":{"type":"string"}},{"name":"status_code","in":"path","required":true,"description":"[Required] The method response's status code.","schema":{"type":"string","pattern":"[1-5]\\d\\d","description":"The status code."}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"responseParameters":{"description":"A key-value map specifying required or optional response parameters that API Gateway can send back to the caller. A key defines a method response header name and the associated value is a Boolean flag indicating whether the method response parameter is required or not. The method response header names must match the pattern of <code>method.response.header.{name}</code>, where <code>name</code> is a valid and unique header name. The response parameter names defined here are available in the integration response to be mapped from an integration response header expressed in <code>integration.response.header.{name}</code>, a static value enclosed within a pair of single quotes (e.g., <code>'application/json'</code>), or a JSON expression from the back-end response payload in the form of <code>integration.response.body.{JSON-expression}</code>, where <code>JSON-expression</code> is a valid JSON expression without the <code>$</code> prefix.)","type":"object","additionalProperties":{"$ref":"#/components/schemas/NullableBoolean"}},"responseModels":{"description":"Specifies the <a>Model</a> resources used for the response's content type. Response models are represented as a key/value map, with a content type as the key and a <a>Model</a> name as the value.","type":"object","additionalProperties":{"$ref":"#/components/schemas/String"}}}}}}}},"patch":{"operationId":"UpdateMethodResponse","description":"Updates an existing <a>MethodResponse</a> resource.","responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MethodResponse"}}}},"480":{"description":"UnauthorizedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedException"}}}},"481":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"482":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}},"483":{"description":"LimitExceededException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LimitExceededException"}}}},"484":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"485":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}}},"parameters":[{"name":"restapi_id","in":"path","required":true,"description":"[Required] The string identifier of the associated <a>RestApi</a>.","schema":{"type":"string"}},{"name":"resource_id","in":"path","required":true,"description":"[Required] The <a>Resource</a> identifier for the <a>MethodResponse</a> resource.","schema":{"type":"string"}},{"name":"http_method","in":"path","required":true,"description":"[Required] The HTTP verb of the <a>Method</a> resource.","schema":{"type":"string"}},{"name":"status_code","in":"path","required":true,"description":"[Required] The status code for the <a>MethodResponse</a> resource.","schema":{"type":"string","pattern":"[1-5]\\d\\d","description":"The status code."}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"patchOperations":{"description":"A list of operations describing the updates to apply to the specified resource. The patches are applied in the order specified in the list.","type":"array","items":{"$ref":"#/components/schemas/PatchOperation"}}}}}}}}},"/restapis/{restapi_id}/models/{model_name}":{"delete":{"operationId":"DeleteModel","description":"Deletes a model.","responses":{"202":{"description":"Success"},"480":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"481":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}},"482":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"483":{"description":"UnauthorizedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedException"}}}},"484":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}}},"parameters":[{"name":"restapi_id","in":"path","required":true,"description":"[Required] The string identifier of the associated <a>RestApi</a>.","schema":{"type":"string"}},{"name":"model_name","in":"path","required":true,"description":"[Required] The name of the model to delete.","schema":{"type":"string"}}]},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}],"get":{"operationId":"GetModel","description":"Describes an existing model defined for a <a>RestApi</a> resource.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model"}}}},"480":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"481":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"482":{"description":"UnauthorizedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedException"}}}},"483":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}}},"parameters":[{"name":"restapi_id","in":"path","required":true,"description":"[Required] The <a>RestApi</a> identifier under which the <a>Model</a> exists.","schema":{"type":"string"}},{"name":"model_name","in":"path","required":true,"description":"[Required] The name of the model as an identifier.","schema":{"type":"string"}},{"name":"flatten","in":"query","required":false,"description":"A query parameter of a Boolean value to resolve (<code>true</code>) all external model references and returns a flattened model schema or not (<code>false</code>) The default is <code>false</code>.","schema":{"type":"boolean"}}]},"patch":{"operationId":"UpdateModel","description":"Changes information about a model.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model"}}}},"480":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"481":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}},"482":{"description":"LimitExceededException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LimitExceededException"}}}},"483":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"484":{"description":"UnauthorizedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedException"}}}},"485":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}}},"parameters":[{"name":"restapi_id","in":"path","required":true,"description":"[Required] The string identifier of the associated <a>RestApi</a>.","schema":{"type":"string"}},{"name":"model_name","in":"path","required":true,"description":"[Required] The name of the model to update.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"patchOperations":{"description":"A list of operations describing the updates to apply to the specified resource. The patches are applied in the order specified in the list.","type":"array","items":{"$ref":"#/components/schemas/PatchOperation"}}}}}}}}},"/restapis/{restapi_id}/requestvalidators/{requestvalidator_id}":{"delete":{"operationId":"DeleteRequestValidator","description":"Deletes a <a>RequestValidator</a> of a given <a>RestApi</a>.","responses":{"202":{"description":"Success"},"480":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"481":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}},"482":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"483":{"description":"UnauthorizedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedException"}}}},"484":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}}},"parameters":[{"name":"restapi_id","in":"path","required":true,"description":"[Required] The string identifier of the associated <a>RestApi</a>.","schema":{"type":"string"}},{"name":"requestvalidator_id","in":"path","required":true,"description":"[Required] The identifier of the <a>RequestValidator</a> to be deleted.","schema":{"type":"string"}}]},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}],"get":{"operationId":"GetRequestValidator","description":"Gets a <a>RequestValidator</a> of a given <a>RestApi</a>.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RequestValidator"}}}},"480":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"481":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"482":{"description":"UnauthorizedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedException"}}}},"483":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}}},"parameters":[{"name":"restapi_id","in":"path","required":true,"description":"[Required] The string identifier of the associated <a>RestApi</a>.","schema":{"type":"string"}},{"name":"requestvalidator_id","in":"path","required":true,"description":"[Required] The identifier of the <a>RequestValidator</a> to be retrieved.","schema":{"type":"string"}}]},"patch":{"operationId":"UpdateRequestValidator","description":"Updates a <a>RequestValidator</a> of a given <a>RestApi</a>.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RequestValidator"}}}},"480":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"481":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}},"482":{"description":"LimitExceededException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LimitExceededException"}}}},"483":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"484":{"description":"UnauthorizedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedException"}}}},"485":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}}},"parameters":[{"name":"restapi_id","in":"path","required":true,"description":"[Required] The string identifier of the associated <a>RestApi</a>.","schema":{"type":"string"}},{"name":"requestvalidator_id","in":"path","required":true,"description":"[Required] The identifier of <a>RequestValidator</a> to be updated.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"patchOperations":{"description":"A list of operations describing the updates to apply to the specified resource. The patches are applied in the order specified in the list.","type":"array","items":{"$ref":"#/components/schemas/PatchOperation"}}}}}}}}},"/restapis/{restapi_id}/resources/{resource_id}":{"delete":{"operationId":"DeleteResource","description":"Deletes a <a>Resource</a> resource.","responses":{"202":{"description":"Success"},"480":{"description":"UnauthorizedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedException"}}}},"481":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"482":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"483":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}},"484":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}}},"parameters":[{"name":"restapi_id","in":"path","required":true,"description":"[Required] The string identifier of the associated <a>RestApi</a>.","schema":{"type":"string"}},{"name":"resource_id","in":"path","required":true,"description":"[Required] The identifier of the <a>Resource</a> resource.","schema":{"type":"string"}}]},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}],"get":{"operationId":"GetResource","description":"Lists information about a resource.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Resource"}}}},"480":{"description":"UnauthorizedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedException"}}}},"481":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"482":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}}},"parameters":[{"name":"restapi_id","in":"path","required":true,"description":"[Required] The string identifier of the associated <a>RestApi</a>.","schema":{"type":"string"}},{"name":"resource_id","in":"path","required":true,"description":"[Required] The identifier for the <a>Resource</a> resource.","schema":{"type":"string"}},{"name":"embed","in":"query","required":false,"description":"A query parameter to retrieve the specified resources embedded in the returned <a>Resource</a> representation in the response. This <code>embed</code> parameter value is a list of comma-separated strings. Currently, the request supports only retrieval of the embedded <a>Method</a> resources this way. The query parameter value must be a single-valued list and contain the <code>\"methods\"</code> string. For example, <code>GET /restapis/{restapi_id}/resources/{resource_id}?embed=methods</code>.","schema":{"type":"array","items":{"$ref":"#/components/schemas/String"}}}]},"patch":{"operationId":"UpdateResource","description":"Changes information about a <a>Resource</a> resource.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Resource"}}}},"480":{"description":"UnauthorizedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedException"}}}},"481":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"482":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}},"483":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"484":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}}},"parameters":[{"name":"restapi_id","in":"path","required":true,"description":"[Required] The string identifier of the associated <a>RestApi</a>.","schema":{"type":"string"}},{"name":"resource_id","in":"path","required":true,"description":"[Required] The identifier of the <a>Resource</a> resource.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"patchOperations":{"description":"A list of operations describing the updates to apply to the specified resource. The patches are applied in the order specified in the list.","type":"array","items":{"$ref":"#/components/schemas/PatchOperation"}}}}}}}}},"/restapis/{restapi_id}":{"delete":{"operationId":"DeleteRestApi","description":"Deletes the specified API.","responses":{"202":{"description":"Success"},"480":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"481":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}},"482":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"483":{"description":"UnauthorizedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedException"}}}},"484":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}}},"parameters":[{"name":"restapi_id","in":"path","required":true,"description":"[Required] The string identifier of the associated <a>RestApi</a>.","schema":{"type":"string"}}]},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}],"get":{"operationId":"GetRestApi","description":"Lists the <a>RestApi</a> resource in the collection.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestApi"}}}},"480":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"481":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"482":{"description":"UnauthorizedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedException"}}}},"483":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}}},"parameters":[{"name":"restapi_id","in":"path","required":true,"description":"[Required] The string identifier of the associated <a>RestApi</a>.","schema":{"type":"string"}}]},"put":{"operationId":"PutRestApi","description":"A feature of the API Gateway control service for updating an existing API with an input of external API definitions. The update can take the form of merging the supplied definition into the existing API or overwriting the existing API.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestApi"}}}},"480":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"481":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}},"482":{"description":"LimitExceededException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LimitExceededException"}}}},"483":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"484":{"description":"UnauthorizedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedException"}}}},"485":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}}},"parameters":[{"name":"restapi_id","in":"path","required":true,"description":"[Required] The string identifier of the associated <a>RestApi</a>.","schema":{"type":"string"}},{"name":"mode","in":"query","required":false,"description":"The <code>mode</code> query parameter to specify the update mode. Valid values are \"merge\" and \"overwrite\". By default, the update mode is \"merge\".","schema":{"type":"string","enum":["merge","overwrite"]}},{"name":"failonwarnings","in":"query","required":false,"description":"A query parameter to indicate whether to rollback the API update (<code>true</code>) or not (<code>false</code>) when a warning is encountered. The default value is <code>false</code>.","schema":{"type":"boolean"}},{"name":"parameters","in":"query","required":false,"description":"Custom header parameters as part of the request. For example, to exclude <a>DocumentationParts</a> from an imported API, set <code>ignore=documentation</code> as a <code>parameters</code> value, as in the AWS CLI command of <code>aws apigateway import-rest-api --parameters ignore=documentation --body 'file:///path/to/imported-api-body.json'</code>.","schema":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/String"}}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"description":"[Required] The PUT request body containing external API definitions. Currently, only OpenAPI definition JSON/YAML files are supported. The maximum size of the API definition file is 6MB.","type":"string"}}}}}}},"patch":{"operationId":"UpdateRestApi","description":"Changes information about the specified API.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestApi"}}}},"480":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"481":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}},"482":{"description":"LimitExceededException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LimitExceededException"}}}},"483":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"484":{"description":"UnauthorizedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedException"}}}},"485":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}}},"parameters":[{"name":"restapi_id","in":"path","required":true,"description":"[Required] The string identifier of the associated <a>RestApi</a>.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"patchOperations":{"description":"A list of operations describing the updates to apply to the specified resource. The patches are applied in the order specified in the list.","type":"array","items":{"$ref":"#/components/schemas/PatchOperation"}}}}}}}}},"/restapis/{restapi_id}/stages/{stage_name}":{"delete":{"operationId":"DeleteStage","description":"Deletes a <a>Stage</a> resource.","responses":{"202":{"description":"Success"},"480":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"481":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}},"482":{"description":"LimitExceededException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LimitExceededException"}}}},"483":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"484":{"description":"UnauthorizedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedException"}}}},"485":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}}},"parameters":[{"name":"restapi_id","in":"path","required":true,"description":"[Required] The string identifier of the associated <a>RestApi</a>.","schema":{"type":"string"}},{"name":"stage_name","in":"path","required":true,"description":"[Required] The name of the <a>Stage</a> resource to delete.","schema":{"type":"string"}}]},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}],"get":{"operationId":"GetStage","description":"Gets information about a <a>Stage</a> resource.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Stage"}}}},"480":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"481":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}},"482":{"description":"LimitExceededException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LimitExceededException"}}}},"483":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"484":{"description":"UnauthorizedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedException"}}}},"485":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}}},"parameters":[{"name":"restapi_id","in":"path","required":true,"description":"[Required] The string identifier of the associated <a>RestApi</a>.","schema":{"type":"string"}},{"name":"stage_name","in":"path","required":true,"description":"[Required] The name of the <a>Stage</a> resource to get information about.","schema":{"type":"string"}}]},"patch":{"operationId":"UpdateStage","description":"Changes information about a <a>Stage</a> resource.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Stage"}}}},"480":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"481":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}},"482":{"description":"LimitExceededException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LimitExceededException"}}}},"483":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"484":{"description":"UnauthorizedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedException"}}}},"485":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}}},"parameters":[{"name":"restapi_id","in":"path","required":true,"description":"[Required] The string identifier of the associated <a>RestApi</a>.","schema":{"type":"string"}},{"name":"stage_name","in":"path","required":true,"description":"[Required] The name of the <a>Stage</a> resource to change information about.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"patchOperations":{"description":"A list of operations describing the updates to apply to the specified resource. The patches are applied in the order specified in the list.","type":"array","items":{"$ref":"#/components/schemas/PatchOperation"}}}}}}}}},"/usageplans/{usageplanId}":{"delete":{"operationId":"DeleteUsagePlan","description":"Deletes a usage plan of a given plan Id.","responses":{"202":{"description":"Success"},"480":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"481":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}},"482":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"483":{"description":"UnauthorizedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedException"}}}},"484":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}}},"parameters":[{"name":"usageplanId","in":"path","required":true,"description":"[Required] The Id of the to-be-deleted usage plan.","schema":{"type":"string"}}]},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}],"get":{"operationId":"GetUsagePlan","description":"Gets a usage plan of a given plan identifier.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UsagePlan"}}}},"480":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"481":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"482":{"description":"UnauthorizedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedException"}}}},"483":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}}},"parameters":[{"name":"usageplanId","in":"path","required":true,"description":"[Required] The identifier of the <a>UsagePlan</a> resource to be retrieved.","schema":{"type":"string"}}]},"patch":{"operationId":"UpdateUsagePlan","description":"Updates a usage plan of a given plan Id.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UsagePlan"}}}},"480":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"481":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}},"482":{"description":"LimitExceededException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LimitExceededException"}}}},"483":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"484":{"description":"UnauthorizedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedException"}}}},"485":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}}},"parameters":[{"name":"usageplanId","in":"path","required":true,"description":"[Required] The Id of the to-be-updated usage plan.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"patchOperations":{"description":"A list of operations describing the updates to apply to the specified resource. The patches are applied in the order specified in the list.","type":"array","items":{"$ref":"#/components/schemas/PatchOperation"}}}}}}}}},"/usageplans/{usageplanId}/keys/{keyId}":{"delete":{"operationId":"DeleteUsagePlanKey","description":"Deletes a usage plan key and remove the underlying API key from the associated usage plan.","responses":{"202":{"description":"Success"},"480":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"481":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}},"482":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"483":{"description":"UnauthorizedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedException"}}}},"484":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}}},"parameters":[{"name":"usageplanId","in":"path","required":true,"description":"[Required] The Id of the <a>UsagePlan</a> resource representing the usage plan containing the to-be-deleted <a>UsagePlanKey</a> resource representing a plan customer.","schema":{"type":"string"}},{"name":"keyId","in":"path","required":true,"description":"[Required] The Id of the <a>UsagePlanKey</a> resource to be deleted.","schema":{"type":"string"}}]},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}],"get":{"operationId":"GetUsagePlanKey","description":"Gets a usage plan key of a given key identifier.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UsagePlanKey"}}}},"480":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"481":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"482":{"description":"UnauthorizedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedException"}}}},"483":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}}},"parameters":[{"name":"usageplanId","in":"path","required":true,"description":"[Required] The Id of the <a>UsagePlan</a> resource representing the usage plan containing the to-be-retrieved <a>UsagePlanKey</a> resource representing a plan customer.","schema":{"type":"string"}},{"name":"keyId","in":"path","required":true,"description":"[Required] The key Id of the to-be-retrieved <a>UsagePlanKey</a> resource representing a plan customer.","schema":{"type":"string"}}]}},"/vpclinks/{vpclink_id}":{"delete":{"operationId":"DeleteVpcLink","description":"Deletes an existing <a>VpcLink</a> of a specified identifier.","responses":{"202":{"description":"Success"},"480":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"481":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}},"482":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"483":{"description":"UnauthorizedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedException"}}}},"484":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}}},"parameters":[{"name":"vpclink_id","in":"path","required":true,"description":"[Required] The identifier of the <a>VpcLink</a>. It is used in an <a>Integration</a> to reference this <a>VpcLink</a>.","schema":{"type":"string"}}]},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}],"get":{"operationId":"GetVpcLink","description":"Gets a specified VPC link under the caller's account in a region.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VpcLink"}}}},"480":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"481":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"482":{"description":"UnauthorizedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedException"}}}},"483":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}}},"parameters":[{"name":"vpclink_id","in":"path","required":true,"description":"[Required] The identifier of the <a>VpcLink</a>. It is used in an <a>Integration</a> to reference this <a>VpcLink</a>.","schema":{"type":"string"}}]},"patch":{"operationId":"UpdateVpcLink","description":"Updates an existing <a>VpcLink</a> of a specified identifier.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VpcLink"}}}},"480":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"481":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}},"482":{"description":"LimitExceededException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LimitExceededException"}}}},"483":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"484":{"description":"UnauthorizedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedException"}}}},"485":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}}},"parameters":[{"name":"vpclink_id","in":"path","required":true,"description":"[Required] The identifier of the <a>VpcLink</a>. It is used in an <a>Integration</a> to reference this <a>VpcLink</a>.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"patchOperations":{"description":"A list of operations describing the updates to apply to the specified resource. The patches are applied in the order specified in the list.","type":"array","items":{"$ref":"#/components/schemas/PatchOperation"}}}}}}}}},"/restapis/{restapi_id}/stages/{stage_name}/cache/authorizers":{"delete":{"operationId":"FlushStageAuthorizersCache","description":"Flushes all authorizer cache entries on a stage.","responses":{"202":{"description":"Success"},"480":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"481":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}},"482":{"description":"LimitExceededException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LimitExceededException"}}}},"483":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"484":{"description":"UnauthorizedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedException"}}}},"485":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}}},"parameters":[{"name":"restapi_id","in":"path","required":true,"description":"The string identifier of the associated <a>RestApi</a>.","schema":{"type":"string"}},{"name":"stage_name","in":"path","required":true,"description":"The name of the stage to flush.","schema":{"type":"string"}}]},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/restapis/{restapi_id}/stages/{stage_name}/cache/data":{"delete":{"operationId":"FlushStageCache","description":"Flushes a stage's cache.","responses":{"202":{"description":"Success"},"480":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"481":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}},"482":{"description":"LimitExceededException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LimitExceededException"}}}},"483":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"484":{"description":"UnauthorizedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedException"}}}},"485":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}}},"parameters":[{"name":"restapi_id","in":"path","required":true,"description":"[Required] The string identifier of the associated <a>RestApi</a>.","schema":{"type":"string"}},{"name":"stage_name","in":"path","required":true,"description":"[Required] The name of the stage to flush its cache.","schema":{"type":"string"}}]},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/clientcertificates":{"post":{"operationId":"GenerateClientCertificate","description":"Generates a <a>ClientCertificate</a> resource.","responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClientCertificate"}}}},"480":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"481":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}},"482":{"description":"LimitExceededException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LimitExceededException"}}}},"483":{"description":"UnauthorizedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedException"}}}},"484":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}}},"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"description":{"description":"The description of the <a>ClientCertificate</a>.","type":"string"},"tags":{"description":"The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with <code>aws:</code>. The tag value can be up to 256 characters.","type":"object","additionalProperties":{"$ref":"#/components/schemas/String"}}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}],"get":{"operationId":"GetClientCertificates","description":"Gets a collection of <a>ClientCertificate</a> resources.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClientCertificates"}}}},"480":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"481":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"482":{"description":"UnauthorizedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedException"}}}},"483":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}}},"parameters":[{"name":"position","in":"query","required":false,"description":"The current pagination position in the paged result set.","schema":{"type":"string"}},{"name":"limit","in":"query","required":false,"description":"The maximum number of returned results per page. The default value is 25 and the maximum value is 500.","schema":{"type":"integer"}}]}},"/account":{"get":{"operationId":"GetAccount","description":"Gets information about the current <a>Account</a> resource.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Account"}}}},"480":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"481":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"482":{"description":"UnauthorizedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedException"}}}},"483":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}}},"parameters":[]},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}],"patch":{"operationId":"UpdateAccount","description":"Changes information about the current <a>Account</a> resource.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Account"}}}},"480":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"481":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}},"482":{"description":"LimitExceededException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LimitExceededException"}}}},"483":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"484":{"description":"UnauthorizedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedException"}}}},"485":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}}},"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"patchOperations":{"description":"A list of operations describing the updates to apply to the specified resource. The patches are applied in the order specified in the list.","type":"array","items":{"$ref":"#/components/schemas/PatchOperation"}}}}}}}}},"/restapis/{restapi_id}/stages/{stage_name}/exports/{export_type}":{"get":{"operationId":"GetExport","description":"Exports a deployed version of a <a>RestApi</a> in a specified format.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExportResponse"}}}},"480":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"481":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}},"482":{"description":"LimitExceededException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LimitExceededException"}}}},"483":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"484":{"description":"UnauthorizedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedException"}}}},"485":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}}},"parameters":[{"name":"restapi_id","in":"path","required":true,"description":"[Required] The string identifier of the associated <a>RestApi</a>.","schema":{"type":"string"}},{"name":"stage_name","in":"path","required":true,"description":"[Required] The name of the <a>Stage</a> that will be exported.","schema":{"type":"string"}},{"name":"export_type","in":"path","required":true,"description":"[Required] The type of export. Acceptable values are 'oas30' for OpenAPI 3.0.x and 'swagger' for Swagger/OpenAPI 2.0.","schema":{"type":"string"}},{"name":"parameters","in":"query","required":false,"description":"A key-value map of query string parameters that specify properties of the export, depending on the requested <code>exportType</code>. For <code>exportType</code> <code>oas30</code> and <code>swagger</code>, any combination of the following parameters are supported: <code>extensions='integrations'</code> or <code>extensions='apigateway'</code> will export the API with x-amazon-apigateway-integration extensions. <code>extensions='authorizers'</code> will export the API with x-amazon-apigateway-authorizer extensions. <code>postman</code> will export the API with Postman extensions, allowing for import to the Postman tool","schema":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/String"}}},{"name":"Accept","in":"header","required":false,"description":"The content-type of the export, for example <code>application/json</code>. Currently <code>application/json</code> and <code>application/yaml</code> are supported for <code>exportType</code> of<code>oas30</code> and <code>swagger</code>. This should be specified in the <code>Accept</code> header for direct API requests.","schema":{"type":"string"}}]},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/restapis/{restapi_id}/gatewayresponses":{"get":{"operationId":"GetGatewayResponses","description":"Gets the <a>GatewayResponses</a> collection on the given <a>RestApi</a>. If an API developer has not added any definitions for gateway responses, the result will be the API Gateway-generated default <a>GatewayResponses</a> collection for the supported response types.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GatewayResponses"}}}},"480":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"481":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"482":{"description":"UnauthorizedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedException"}}}},"483":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}}},"parameters":[{"name":"restapi_id","in":"path","required":true,"description":"[Required] The string identifier of the associated <a>RestApi</a>.","schema":{"type":"string"}},{"name":"position","in":"query","required":false,"description":"The current pagination position in the paged result set. The <a>GatewayResponse</a> collection does not support pagination and the position does not apply here.","schema":{"type":"string"}},{"name":"limit","in":"query","required":false,"description":"The maximum number of returned results per page. The default value is 25 and the maximum value is 500. The <a>GatewayResponses</a> collection does not support pagination and the limit does not apply here.","schema":{"type":"integer"}}]},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/restapis/{restapi_id}/models/{model_name}/default_template":{"get":{"operationId":"GetModelTemplate","description":"Generates a sample mapping template that can be used to transform a payload into the structure of a model.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Template"}}}},"480":{"description":"UnauthorizedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedException"}}}},"481":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"482":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"483":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}}},"parameters":[{"name":"restapi_id","in":"path","required":true,"description":"[Required] The string identifier of the associated <a>RestApi</a>.","schema":{"type":"string"}},{"name":"model_name","in":"path","required":true,"description":"[Required] The name of the model for which to generate a template.","schema":{"type":"string"}}]},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/restapis/{restapi_id}/resources":{"get":{"operationId":"GetResources","description":"Lists information about a collection of <a>Resource</a> resources.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Resources"}}}},"480":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"481":{"description":"UnauthorizedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedException"}}}},"482":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"483":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}}},"parameters":[{"name":"restapi_id","in":"path","required":true,"description":"[Required] The string identifier of the associated <a>RestApi</a>.","schema":{"type":"string"}},{"name":"position","in":"query","required":false,"description":"The current pagination position in the paged result set.","schema":{"type":"string"}},{"name":"limit","in":"query","required":false,"description":"The maximum number of returned results per page. The default value is 25 and the maximum value is 500.","schema":{"type":"integer"}},{"name":"embed","in":"query","required":false,"description":"A query parameter used to retrieve the specified resources embedded in the returned <a>Resources</a> resource in the response. This <code>embed</code> parameter value is a list of comma-separated strings. Currently, the request supports only retrieval of the embedded <a>Method</a> resources this way. The query parameter value must be a single-valued list and contain the <code>\"methods\"</code> string. For example, <code>GET /restapis/{restapi_id}/resources?embed=methods</code>.","schema":{"type":"array","items":{"$ref":"#/components/schemas/String"}}}]},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/restapis/{restapi_id}/stages/{stage_name}/sdks/{sdk_type}":{"get":{"operationId":"GetSdk","description":"Generates a client SDK for a <a>RestApi</a> and <a>Stage</a>.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SdkResponse"}}}},"480":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"481":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}},"482":{"description":"LimitExceededException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LimitExceededException"}}}},"483":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"484":{"description":"UnauthorizedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedException"}}}},"485":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}}},"parameters":[{"name":"restapi_id","in":"path","required":true,"description":"[Required] The string identifier of the associated <a>RestApi</a>.","schema":{"type":"string"}},{"name":"stage_name","in":"path","required":true,"description":"[Required] The name of the <a>Stage</a> that the SDK will use.","schema":{"type":"string"}},{"name":"sdk_type","in":"path","required":true,"description":"[Required] The language for the generated SDK. Currently <code>java</code>, <code>javascript</code>, <code>android</code>, <code>objectivec</code> (for iOS), <code>swift</code> (for iOS), and <code>ruby</code> are supported.","schema":{"type":"string"}},{"name":"parameters","in":"query","required":false,"description":"A string-to-string key-value map of query parameters <code>sdkType</code>-dependent properties of the SDK. For <code>sdkType</code> of <code>objectivec</code> or <code>swift</code>, a parameter named <code>classPrefix</code> is required. For <code>sdkType</code> of <code>android</code>, parameters named <code>groupId</code>, <code>artifactId</code>, <code>artifactVersion</code>, and <code>invokerPackage</code> are required. For <code>sdkType</code> of <code>java</code>, parameters named <code>serviceName</code> and <code>javaPackageName</code> are required. ","schema":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/String"}}}]},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/sdktypes/{sdktype_id}":{"get":{"operationId":"GetSdkType","description":"","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SdkType"}}}},"480":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"481":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"482":{"description":"UnauthorizedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedException"}}}},"483":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}}},"parameters":[{"name":"sdktype_id","in":"path","required":true,"description":"[Required] The identifier of the queried <a>SdkType</a> instance.","schema":{"type":"string"}}]},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/sdktypes":{"get":{"operationId":"GetSdkTypes","description":"","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SdkTypes"}}}},"480":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"481":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"482":{"description":"UnauthorizedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedException"}}}},"483":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}}},"parameters":[{"name":"position","in":"query","required":false,"description":"The current pagination position in the paged result set.","schema":{"type":"string"}},{"name":"limit","in":"query","required":false,"description":"The maximum number of returned results per page. The default value is 25 and the maximum value is 500.","schema":{"type":"integer"}}]},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/tags/{resource_arn}":{"get":{"operationId":"GetTags","description":"Gets the <a>Tags</a> collection for a given resource.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Tags"}}}},"480":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"481":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"482":{"description":"UnauthorizedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedException"}}}},"483":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}}},"parameters":[{"name":"resource_arn","in":"path","required":true,"description":"[Required] The ARN of a resource that can be tagged.","schema":{"type":"string"}},{"name":"position","in":"query","required":false,"description":"(Not currently supported) The current pagination position in the paged result set.","schema":{"type":"string"}},{"name":"limit","in":"query","required":false,"description":"(Not currently supported) The maximum number of returned results per page. The default value is 25 and the maximum value is 500.","schema":{"type":"integer"}}]},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}],"put":{"operationId":"TagResource","description":"Adds or updates a tag on a given resource.","responses":{"204":{"description":"Success"},"480":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"481":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}},"482":{"description":"LimitExceededException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LimitExceededException"}}}},"483":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"484":{"description":"UnauthorizedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedException"}}}},"485":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}}},"parameters":[{"name":"resource_arn","in":"path","required":true,"description":"[Required] The ARN of a resource that can be tagged.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["tags"],"properties":{"tags":{"description":"[Required] The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with <code>aws:</code>. The tag value can be up to 256 characters.","type":"object","additionalProperties":{"$ref":"#/components/schemas/String"}}}}}}}}},"/usageplans/{usageplanId}/usage#startDate&endDate":{"get":{"operationId":"GetUsage","description":"Gets the usage data of a usage plan in a specified time interval.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Usage"}}}},"480":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"481":{"description":"UnauthorizedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedException"}}}},"482":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"483":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}}},"parameters":[{"name":"usageplanId","in":"path","required":true,"description":"[Required] The Id of the usage plan associated with the usage data.","schema":{"type":"string"}},{"name":"keyId","in":"query","required":false,"description":"The Id of the API key associated with the resultant usage data.","schema":{"type":"string"}},{"name":"startDate","in":"query","required":true,"description":"[Required] The starting date (e.g., 2016-01-01) of the usage data.","schema":{"type":"string"}},{"name":"endDate","in":"query","required":true,"description":"[Required] The ending date (e.g., 2016-12-31) of the usage data.","schema":{"type":"string"}},{"name":"position","in":"query","required":false,"description":"The current pagination position in the paged result set.","schema":{"type":"string"}},{"name":"limit","in":"query","required":false,"description":"The maximum number of returned results per page. The default value is 25 and the maximum value is 500.","schema":{"type":"integer"}}]},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/apikeys#mode=import&format":{"post":{"operationId":"ImportApiKeys","description":"Import API keys from an external source, such as a CSV-formatted file.","responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiKeyIds"}}}},"480":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"481":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}},"482":{"description":"LimitExceededException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LimitExceededException"}}}},"483":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"484":{"description":"UnauthorizedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedException"}}}},"485":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}}},"parameters":[{"name":"format","in":"query","required":true,"description":"A query parameter to specify the input format to imported API keys. Currently, only the <code>csv</code> format is supported.","schema":{"type":"string","enum":["csv"]}},{"name":"failonwarnings","in":"query","required":false,"description":"A query parameter to indicate whether to rollback <a>ApiKey</a> importation (<code>true</code>) or not (<code>false</code>) when error is encountered.","schema":{"type":"boolean"}},{"name":"mode","in":"query","required":true,"schema":{"type":"string","enum":["import"]}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"description":"The payload of the POST request to import API keys. For the payload format, see <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/api-key-file-format.html\">API Key File Format</a>.","type":"string"}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/restapis#mode=import":{"post":{"operationId":"ImportRestApi","description":"A feature of the API Gateway control service for creating a new API from an external API definition file.","responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestApi"}}}},"480":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"481":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}},"482":{"description":"LimitExceededException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LimitExceededException"}}}},"483":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"484":{"description":"UnauthorizedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedException"}}}},"485":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}}},"parameters":[{"name":"failonwarnings","in":"query","required":false,"description":"A query parameter to indicate whether to rollback the API creation (<code>true</code>) or not (<code>false</code>) when a warning is encountered. The default value is <code>false</code>.","schema":{"type":"boolean"}},{"name":"parameters","in":"query","required":false,"description":"<p>A key-value map of context-specific query string parameters specifying the behavior of different API importing operations. The following shows operation-specific parameters and their supported values.</p> <p> To exclude <a>DocumentationParts</a> from the import, set <code>parameters</code> as <code>ignore=documentation</code>.</p> <p> To configure the endpoint type, set <code>parameters</code> as <code>endpointConfigurationTypes=EDGE</code>, <code>endpointConfigurationTypes=REGIONAL</code>, or <code>endpointConfigurationTypes=PRIVATE</code>. The default endpoint type is <code>EDGE</code>.</p> <p> To handle imported <code>basepath</code>, set <code>parameters</code> as <code>basepath=ignore</code>, <code>basepath=prepend</code> or <code>basepath=split</code>.</p> <p>For example, the AWS CLI command to exclude documentation from the imported API is:</p> <pre><code>aws apigateway import-rest-api --parameters ignore=documentation --body 'file:///path/to/imported-api-body.json'</code></pre> <p>The AWS CLI command to set the regional endpoint on the imported API is:</p> <pre><code>aws apigateway import-rest-api --parameters endpointConfigurationTypes=REGIONAL --body 'file:///path/to/imported-api-body.json'</code></pre>","schema":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/String"}}},{"name":"mode","in":"query","required":true,"schema":{"type":"string","enum":["import"]}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"description":"[Required] The POST request body containing external API definitions. Currently, only OpenAPI definition JSON/YAML files are supported. The maximum size of the API definition file is 6MB.","type":"string"}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/tags/{resource_arn}#tagKeys":{"delete":{"operationId":"UntagResource","description":"Removes a tag from a given resource.","responses":{"204":{"description":"Success"},"480":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"481":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}},"482":{"description":"LimitExceededException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LimitExceededException"}}}},"483":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"484":{"description":"UnauthorizedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedException"}}}},"485":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}}},"parameters":[{"name":"resource_arn","in":"path","required":true,"description":"[Required] The ARN of a resource that can be tagged.","schema":{"type":"string"}},{"name":"tagKeys","in":"query","required":true,"description":"[Required] The Tag keys to delete.","schema":{"type":"array","items":{"$ref":"#/components/schemas/String"}}}]},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/usageplans/{usageplanId}/keys/{keyId}/usage":{"patch":{"operationId":"UpdateUsage","description":"Grants a temporary extension to the remaining quota of a usage plan associated with a specified API key.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Usage"}}}},"480":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"481":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}},"482":{"description":"LimitExceededException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LimitExceededException"}}}},"483":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"484":{"description":"UnauthorizedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedException"}}}},"485":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}}},"parameters":[{"name":"usageplanId","in":"path","required":true,"description":"[Required] The Id of the usage plan associated with the usage data.","schema":{"type":"string"}},{"name":"keyId","in":"path","required":true,"description":"[Required] The identifier of the API key associated with the usage plan in which a temporary extension is granted to the remaining quota.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"patchOperations":{"description":"A list of operations describing the updates to apply to the specified resource. The patches are applied in the order specified in the list.","type":"array","items":{"$ref":"#/components/schemas/PatchOperation"}}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]}},"components":{"parameters":{"X-Amz-Content-Sha256":{"name":"X-Amz-Content-Sha256","in":"header","schema":{"type":"string"},"required":false},"X-Amz-Date":{"name":"X-Amz-Date","in":"header","schema":{"type":"string"},"required":false},"X-Amz-Algorithm":{"name":"X-Amz-Algorithm","in":"header","schema":{"type":"string"},"required":false},"X-Amz-Credential":{"name":"X-Amz-Credential","in":"header","schema":{"type":"string"},"required":false},"X-Amz-Security-Token":{"name":"X-Amz-Security-Token","in":"header","schema":{"type":"string"},"required":false},"X-Amz-Signature":{"name":"X-Amz-Signature","in":"header","schema":{"type":"string"},"required":false},"X-Amz-SignedHeaders":{"name":"X-Amz-SignedHeaders","in":"header","schema":{"type":"string"},"required":false}},"securitySchemes":{"hmac":{"type":"apiKey","name":"Authorization","in":"header","description":"Amazon Signature authorization v4","x-amazon-apigateway-authtype":"awsSigv4"}},"schemas":{"ApiKey":{"type":"object","properties":{"id":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":"The identifier of the API Key."}]},"value":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":"The value of the API Key."}]},"name":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":"The name of the API Key."}]},"customerId":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":"An AWS Marketplace customer identifier , when integrating with the AWS SaaS Marketplace."}]},"description":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":"The description of the API Key."}]},"enabled":{"allOf":[{"$ref":"#/components/schemas/Boolean"},{"description":"Specifies whether the API Key can be used by callers."}]},"createdDate":{"allOf":[{"$ref":"#/components/schemas/Timestamp"},{"description":"The timestamp when the API Key was created."}]},"lastUpdatedDate":{"allOf":[{"$ref":"#/components/schemas/Timestamp"},{"description":"The timestamp when the API Key was last updated."}]},"stageKeys":{"allOf":[{"$ref":"#/components/schemas/ListOfString"},{"description":"A list of <a>Stage</a> resources that are associated with the <a>ApiKey</a> resource."}]},"tags":{"allOf":[{"$ref":"#/components/schemas/MapOfStringToString"},{"description":"The collection of tags. Each tag element is associated with a given resource."}]}},"description":"<p>A resource that can be distributed to callers for executing <a>Method</a> resources that require an API key. API keys can be mapped to any <a>Stage</a> on any <a>RestApi</a>, which indicates that the callers with the API key can make requests to that stage.</p> <div class=\"seeAlso\"> <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-api-keys.html\">Use API Keys</a> </div>"},"StageKey":{"type":"object","properties":{"restApiId":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":"The string identifier of the associated <a>RestApi</a>."}]},"stageName":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":"The stage name associated with the stage key."}]}},"description":"A reference to a unique stage identified in the format <code>{restApiId}/{stage}</code>."},"String":{"type":"string"},"BadRequestException":{},"ConflictException":{},"LimitExceededException":{},"NotFoundException":{},"UnauthorizedException":{},"TooManyRequestsException":{},"Authorizer":{"type":"object","properties":{"id":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":"The identifier for the authorizer resource."}]},"name":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":"[Required] The name of the authorizer."}]},"type":{"allOf":[{"$ref":"#/components/schemas/AuthorizerType"},{"description":"The authorizer type. Valid values are <code>TOKEN</code> for a Lambda function using a single authorization token submitted in a custom header, <code>REQUEST</code> for a Lambda function using incoming request parameters, and <code>COGNITO_USER_POOLS</code> for using an Amazon Cognito user pool."}]},"providerARNs":{"allOf":[{"$ref":"#/components/schemas/ListOfARNs"},{"description":"A list of the Amazon Cognito user pool ARNs for the <code>COGNITO_USER_POOLS</code> authorizer. Each element is of this format: <code>arn:aws:cognito-idp:{region}:{account_id}:userpool/{user_pool_id}</code>. For a <code>TOKEN</code> or <code>REQUEST</code> authorizer, this is not defined."}]},"authType":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":"Optional customer-defined field, used in OpenAPI imports and exports without functional impact."}]},"authorizerUri":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":"Specifies the authorizer's Uniform Resource Identifier (URI). For <code>TOKEN</code> or <code>REQUEST</code> authorizers, this must be a well-formed Lambda function URI, for example, <code>arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations</code>. In general, the URI has this form <code>arn:aws:apigateway:{region}:lambda:path/{service_api}</code>, where <code>{region}</code> is the same as the region hosting the Lambda function, <code>path</code> indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial <code>/</code>. For Lambda functions, this is usually of the form <code>/2015-03-31/functions/[FunctionARN]/invocations</code>."}]},"authorizerCredentials":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":"Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, specify null."}]},"identitySource":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":"The identity source for which authorization is requested. <ul><li>For a <code>TOKEN</code> or <code>COGNITO_USER_POOLS</code> authorizer, this is required and specifies the request header mapping expression for the custom header holding the authorization token submitted by the client. For example, if the token header name is <code>Auth</code>, the header mapping expression is <code>method.request.header.Auth</code>.</li><li>For the <code>REQUEST</code> authorizer, this is required when authorization caching is enabled. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an <code>Auth</code> header, a <code>Name</code> query string parameter are defined as identity sources, this value is <code>method.request.header.Auth, method.request.querystring.Name</code>. These parameters will be used to derive the authorization caching key and to perform runtime validation of the <code>REQUEST</code> authorizer by verifying all of the identity-related request parameters are present, not null and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function, otherwise, it returns a 401 Unauthorized response without calling the Lambda function. The valid value is a string of comma-separated mapping expressions of the specified request parameters. When the authorization caching is not enabled, this property is optional.</li></ul>"}]},"identityValidationExpression":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":"A validation expression for the incoming identity token. For <code>TOKEN</code> authorizers, this value is a regular expression. For <code>COGNITO_USER_POOLS</code> authorizers, API Gateway will match the <code>aud</code> field of the incoming token from the client against the specified regular expression. It will invoke the authorizer's Lambda function when there is a match. Otherwise, it will return a 401 Unauthorized response without calling the Lambda function. The validation expression does not apply to the <code>REQUEST</code> authorizer."}]},"authorizerResultTtlInSeconds":{"allOf":[{"$ref":"#/components/schemas/NullableInteger"},{"description":"The TTL in seconds of cached authorizer results. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway will cache authorizer responses. If this field is not set, the default value is 300. The maximum value is 3600, or 1 hour."}]}},"description":"<p>Represents an authorization layer for methods. If enabled on a method, API Gateway will activate the authorizer when a client calls the method.</p> <div class=\"seeAlso\"> <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-use-lambda-authorizer.html\">Use Lambda Function as Authorizer</a> <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-integrate-with-cognito.html\">Use Cognito User Pool as Authorizer</a> </div>"},"ProviderARN":{"type":"string"},"BasePathMapping":{"type":"object","properties":{"basePath":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":"The base path name that callers of the API must provide as part of the URL after the domain name."}]},"restApiId":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":"The string identifier of the associated <a>RestApi</a>."}]},"stage":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":"The name of the associated stage."}]}},"description":"<p>Represents the base path that callers of the API must provide as part of the URL after the domain name.</p> <div class=\"remarks\">A custom domain name plus a <code>BasePathMapping</code> specification identifies a deployed <a>RestApi</a> in a given stage of the owner <a>Account</a>.</div> <div class=\"seeAlso\"> <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-custom-domains.html\">Use Custom Domain Names</a> </div>"},"Deployment":{"type":"object","properties":{"id":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":"The identifier for the deployment resource."}]},"description":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":"The description for the deployment resource."}]},"createdDate":{"allOf":[{"$ref":"#/components/schemas/Timestamp"},{"description":"The date and time that the deployment resource was created."}]},"apiSummary":{"allOf":[{"$ref":"#/components/schemas/PathToMapOfMethodSnapshot"},{"description":"A summary of the <a>RestApi</a> at the date and time that the deployment resource was created."}]}},"description":"<p>An immutable representation of a <a>RestApi</a> resource that can be called by users using <a>Stages</a>. A deployment must be associated with a <a>Stage</a> for it to be callable over the Internet.</p> <div class=\"remarks\">To create a deployment, call <code>POST</code> on the <a>Deployments</a> resource of a <a>RestApi</a>. To view, update, or delete a deployment, call <code>GET</code>, <code>PATCH</code>, or <code>DELETE</code> on the specified deployment resource (<code>/restapis/{restapi_id}/deployments/{deployment_id}</code>).</div> <div class=\"seeAlso\"><a>RestApi</a>, <a>Deployments</a>, <a>Stage</a>, <a href=\"https://docs.aws.amazon.com/cli/latest/reference/apigateway/get-deployment.html\">AWS CLI</a>, <a href=\"https://aws.amazon.com/tools/\">AWS SDKs</a> </div>"},"Double":{"type":"number","format":"double"},"MapOfStringToString":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/String"}},"Boolean":{"type":"boolean"},"ServiceUnavailableException":{},"DocumentationPart":{"type":"object","properties":{"id":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":"The <a>DocumentationPart</a> identifier, generated by API Gateway when the <code>DocumentationPart</code> is created."}]},"location":{"allOf":[{"$ref":"#/components/schemas/DocumentationPartLocation"},{"description":"The location of the API entity to which the documentation applies. Valid fields depend on the targeted API entity type. All the valid location fields are not required. If not explicitly specified, a valid location field is treated as a wildcard and associated documentation content may be inherited by matching entities, unless overridden."}]},"properties":{"description":"A content map of API-specific key-value pairs describing the targeted API entity. The map must be encoded as a JSON string, e.g., <code>\"{ \\\"description\\\": \\\"The API does ...\\\" }\"</code>. Only OpenAPI-compliant documentation-related fields from the <literal>properties</literal> map are exported and, hence, published as part of the API entity definitions, while the original documentation parts are exported in a OpenAPI extension of <code>x-amazon-apigateway-documentation</code>."}},"description":"<p>A documentation part for a targeted API entity.</p> <div class=\"remarks\"> <p>A documentation part consists of a content map (<code>properties</code>) and a target (<code>location</code>). The target specifies an API entity to which the documentation content applies. The supported API entity types are <code>API</code>, <code>AUTHORIZER</code>, <code>MODEL</code>, <code>RESOURCE</code>, <code>METHOD</code>, <code>PATH_PARAMETER</code>, <code>QUERY_PARAMETER</code>, <code>REQUEST_HEADER</code>, <code>REQUEST_BODY</code>, <code>RESPONSE</code>, <code>RESPONSE_HEADER</code>, and <code>RESPONSE_BODY</code>. Valid <code>location</code> fields depend on the API entity type. All valid fields are not required.</p> <p>The content map is a JSON string of API-specific key-value pairs. Although an API can use any shape for the content map, only the OpenAPI-compliant documentation fields will be injected into the associated API entity definition in the exported OpenAPI definition file.</p></div> <div class=\"seeAlso\"> <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-documenting-api.html\">Documenting an API</a>, <a>DocumentationParts</a> </div>"},"DocumentationPartType":{"type":"string","enum":["API","AUTHORIZER","MODEL","RESOURCE","METHOD","PATH_PARAMETER","QUERY_PARAMETER","REQUEST_HEADER","REQUEST_BODY","RESPONSE","RESPONSE_HEADER","RESPONSE_BODY"]},"DocumentationPartLocationStatusCode":{"type":"string","pattern":"^([1-5]\\d\\d|\\*|\\s*)$"},"DocumentationVersion":{"type":"object","properties":{"version":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":"The version identifier of the API documentation snapshot."}]},"createdDate":{"allOf":[{"$ref":"#/components/schemas/Timestamp"},{"description":"The date when the API documentation snapshot is created."}]},"description":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":"The description of the API documentation snapshot."}]}},"description":"<p>A snapshot of the documentation of an API.</p> <div class=\"remarks\"><p>Publishing API documentation involves creating a documentation version associated with an API stage and exporting the versioned documentation to an external (e.g., OpenAPI) file.</p></div> <div class=\"seeAlso\"> <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-documenting-api.html\">Documenting an API</a>, <a>DocumentationPart</a>, <a>DocumentationVersions</a> </div>"},"DomainName":{"type":"object","properties":{"domainName":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":"The custom domain name as an API host name, for example, <code>my-api.example.com</code>."}]},"certificateName":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":"The name of the certificate that will be used by edge-optimized endpoint for this domain name."}]},"certificateArn":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":"The reference to an AWS-managed certificate that will be used by edge-optimized endpoint for this domain name. AWS Certificate Manager is the only supported source."}]},"certificateUploadDate":{"allOf":[{"$ref":"#/components/schemas/Timestamp"},{"description":"The timestamp when the certificate that was used by edge-optimized endpoint for this domain name was uploaded."}]},"regionalDomainName":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":"The domain name associated with the regional endpoint for this custom domain name. You set up this association by adding a DNS record that points the custom domain name to this regional domain name. The regional domain name is returned by API Gateway when you create a regional endpoint."}]},"regionalHostedZoneId":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":"The region-specific Amazon Route 53 Hosted Zone ID of the regional endpoint. For more information, see <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-regional-api-custom-domain-create.html\">Set up a Regional Custom Domain Name</a> and <a href=\"https://docs.aws.amazon.com/general/latest/gr/rande.html#apigateway_region\">AWS Regions and Endpoints for API Gateway</a>."}]},"regionalCertificateName":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":"The name of the certificate that will be used for validating the regional domain name."}]},"regionalCertificateArn":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":"The reference to an AWS-managed certificate that will be used for validating the regional domain name. AWS Certificate Manager is the only supported source."}]},"distributionDomainName":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":"The domain name of the Amazon CloudFront distribution associated with this custom domain name for an edge-optimized endpoint. You set up this association when adding a DNS record pointing the custom domain name to this distribution name. For more information about CloudFront distributions, see the <a href=\"https://aws.amazon.com/documentation/cloudfront/\" target=\"_blank\">Amazon CloudFront documentation</a>."}]},"distributionHostedZoneId":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":"The region-agnostic Amazon Route 53 Hosted Zone ID of the edge-optimized endpoint. The valid value is <code>Z2FDTNDATAQYW2</code> for all the regions. For more information, see <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-regional-api-custom-domain-create.html\">Set up a Regional Custom Domain Name</a> and <a href=\"https://docs.aws.amazon.com/general/latest/gr/rande.html#apigateway_region\">AWS Regions and Endpoints for API Gateway</a>."}]},"endpointConfiguration":{"allOf":[{"$ref":"#/components/schemas/EndpointConfiguration"},{"description":"The endpoint configuration of this <a>DomainName</a> showing the endpoint types of the domain name."}]},"domainNameStatus":{"allOf":[{"$ref":"#/components/schemas/DomainNameStatus"},{"description":"The status of the <a>DomainName</a> migration. The valid values are <code>AVAILABLE</code>, <code>UPDATING</code>, <code>PENDING_CERTIFICATE_REIMPORT</code>, and <code>PENDING_OWNERSHIP_VERIFICATION</code>. If the status is <code>UPDATING</code>, the domain cannot be modified further until the existing operation is complete. If it is <code>AVAILABLE</code>, the domain can be updated."}]},"domainNameStatusMessage":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":"An optional text message containing detailed information about status of the <a>DomainName</a> migration."}]},"securityPolicy":{"allOf":[{"$ref":"#/components/schemas/SecurityPolicy"},{"description":"The Transport Layer Security (TLS) version + cipher suite for this <a>DomainName</a>. The valid values are <code>TLS_1_0</code> and <code>TLS_1_2</code>."}]},"tags":{"allOf":[{"$ref":"#/components/schemas/MapOfStringToString"},{"description":"The collection of tags. Each tag element is associated with a given resource."}]},"mutualTlsAuthentication":{"allOf":[{"$ref":"#/components/schemas/MutualTlsAuthentication"},{"description":"The mutual TLS authentication configuration for a custom domain name. If specified, API Gateway performs two-way authentication between the client and the server. Clients must present a trusted certificate to access your API."}]},"ownershipVerificationCertificateArn":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":"The ARN of the public certificate issued by ACM to validate ownership of your custom domain. Only required when configuring mutual TLS and using an ACM imported or private CA certificate ARN as the regionalCertificateArn."}]}},"description":"<p>Represents a custom domain name as a user-friendly host name of an API (<a>RestApi</a>).</p> <div class=\"Remarks\"> <p>When you deploy an API, API Gateway creates a default host name for the API. This default API host name is of the <code>{restapi-id}.execute-api.{region}.amazonaws.com</code> format. With the default host name, you can access the API's root resource with the URL of <code>https://{restapi-id}.execute-api.{region}.amazonaws.com/{stage}/</code>. When you set up a custom domain name of <code>apis.example.com</code> for this API, you can then access the same resource using the URL of the <code>https://apis.examples.com/myApi</code>, where <code>myApi</code> is the base path mapping (<a>BasePathMapping</a>) of your API under the custom domain name. </p> </div> <div class=\"seeAlso\"> <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-custom-domains.html\">Set a Custom Host Name for an API</a> </div>"},"ListOfEndpointType":{"type":"array","items":{"$ref":"#/components/schemas/EndpointType"}},"ListOfString":{"type":"array","items":{"$ref":"#/components/schemas/String"}},"Model":{"type":"object","properties":{"id":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":"The identifier for the model resource."}]},"name":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":"The name of the model. Must be an alphanumeric string."}]},"description":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":"The description of the model."}]},"schema":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":"The schema for the model. For <code>application/json</code> models, this should be <a href=\"https://tools.ietf.org/html/draft-zyp-json-schema-04\" target=\"_blank\">JSON schema draft 4</a> model. Do not include \"\\*/\" characters in the description of any properties because such \"\\*/\" characters may be interpreted as the closing marker for comments in some languages, such as Java or JavaScript, causing the installation of your API's SDK generated by API Gateway to fail."}]},"contentType":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":"The content-type for the model."}]}},"description":"<p>Represents the data structure of a method's request or response payload.</p> <div class=\"remarks\"> <p>A request model defines the data structure of the client-supplied request payload. A response model defines the data structure of the response payload returned by the back end. Although not required, models are useful for mapping payloads between the front end and back end.</p> <p>A model is used for generating an API's SDK, validating the input request body, and creating a skeletal mapping template.</p> </div> <div class=\"seeAlso\"> <a>Method</a>, <a>MethodResponse</a>, <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/models-mappings.html\">Models and Mappings</a> </div>"},"RequestValidator":{"type":"object","properties":{"id":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":"The identifier of this <a>RequestValidator</a>."}]},"name":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":"The name of this <a>RequestValidator</a>"}]},"validateRequestBody":{"allOf":[{"$ref":"#/components/schemas/Boolean"},{"description":"A Boolean flag to indicate whether to validate a request body according to the configured <a>Model</a> schema."}]},"validateRequestParameters":{"allOf":[{"$ref":"#/components/schemas/Boolean"},{"description":"A Boolean flag to indicate whether to validate request parameters (<code>true</code>) or not (<code>false</code>)."}]}},"description":"<p>A set of validation rules for incoming <a>Method</a> requests.</p> <div class=\"remarks\"> <p>In OpenAPI, a <a>RequestValidator</a> of an API is defined by the <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-swagger-extensions.html#api-gateway-swagger-extensions-request-validators.requestValidator.html\">x-amazon-apigateway-request-validators.requestValidator</a> object. It the referenced using the <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-swagger-extensions.html#api-gateway-swagger-extensions-request-validator\">x-amazon-apigateway-request-validator</a> property.</p> </div> <div class=\"seeAlso\"><a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-method-request-validation.html\">Enable Basic Request Validation in API Gateway</a></div>"},"Resource":{"type":"object","properties":{"id":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":"The resource's identifier."}]},"parentId":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":"The parent resource's identifier."}]},"pathPart":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":"The last path segment for this resource."}]},"path":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":"The full path for this resource."}]},"resourceMethods":{"allOf":[{"$ref":"#/components/schemas/MapOfMethod"},{"description":"<p>Gets an API resource's method of a given HTTP verb.</p> <div class=\"remarks\"> <p>The resource methods are a map of methods indexed by methods' HTTP verbs enabled on the resource. This method map is included in the <code>200 OK</code> response of the <code>GET /restapis/{restapi_id}/resources/{resource_id}</code> or <code>GET /restapis/{restapi_id}/resources/{resource_id}?embed=methods</code> request.</p> <h4>Example: Get the GET method of an API resource</h4> <h5>Request</h5> <pre><code>GET /restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET HTTP/1.1 Content-Type: application/json Host: apigateway.us-east-1.amazonaws.com X-Amz-Date: 20170223T031827Z Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID}/20170223/us-east-1/apigateway/aws4_request, SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash}</code></pre> <h5>Response</h5> <pre><code>{ \"_links\": { \"curies\": [ { \"href\": \"https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-{rel}.html\", \"name\": \"integration\", \"templated\": true }, { \"href\": \"https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-response-{rel}.html\", \"name\": \"integrationresponse\", \"templated\": true }, { \"href\": \"https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-method-{rel}.html\", \"name\": \"method\", \"templated\": true }, { \"href\": \"https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-method-response-{rel}.html\", \"name\": \"methodresponse\", \"templated\": true } ], \"self\": { \"href\": \"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET\", \"name\": \"GET\", \"title\": \"GET\" }, \"integration:put\": { \"href\": \"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration\" }, \"method:delete\": { \"href\": \"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET\" }, \"method:integration\": { \"href\": \"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration\" }, \"method:responses\": { \"href\": \"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200\", \"name\": \"200\", \"title\": \"200\" }, \"method:update\": { \"href\": \"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET\" }, \"methodresponse:put\": { \"href\": \"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/{status_code}\", \"templated\": true } }, \"apiKeyRequired\": false, \"authorizationType\": \"NONE\", \"httpMethod\": \"GET\", \"_embedded\": { \"method:integration\": { \"_links\": { \"self\": { \"href\": \"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration\" }, \"integration:delete\": { \"href\": \"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration\" }, \"integration:responses\": { \"href\": \"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200\", \"name\": \"200\", \"title\": \"200\" }, \"integration:update\": { \"href\": \"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration\" }, \"integrationresponse:put\": { \"href\": \"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/{status_code}\", \"templated\": true } }, \"cacheKeyParameters\": [], \"cacheNamespace\": \"3kzxbg5sa2\", \"credentials\": \"arn:aws:iam::123456789012:role/apigAwsProxyRole\", \"httpMethod\": \"POST\", \"passthroughBehavior\": \"WHEN_NO_MATCH\", \"requestParameters\": { \"integration.request.header.Content-Type\": \"'application/x-amz-json-1.1'\" }, \"requestTemplates\": { \"application/json\": \"{\\n}\" }, \"type\": \"AWS\", \"uri\": \"arn:aws:apigateway:us-east-1:kinesis:action/ListStreams\", \"_embedded\": { \"integration:responses\": { \"_links\": { \"self\": { \"href\": \"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200\", \"name\": \"200\", \"title\": \"200\" }, \"integrationresponse:delete\": { \"href\": \"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200\" }, \"integrationresponse:update\": { \"href\": \"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200\" } }, \"responseParameters\": { \"method.response.header.Content-Type\": \"'application/xml'\" }, \"responseTemplates\": { \"application/json\": \"$util.urlDecode(\\\"%3CkinesisStreams%3E#foreach($stream in $input.path('$.StreamNames'))%3Cstream%3E%3Cname%3E$stream%3C/name%3E%3C/stream%3E#end%3C/kinesisStreams%3E\\\")\\n\" }, \"statusCode\": \"200\" } } }, \"method:responses\": { \"_links\": { \"self\": { \"href\": \"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200\", \"name\": \"200\", \"title\": \"200\" }, \"methodresponse:delete\": { \"href\": \"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200\" }, \"methodresponse:update\": { \"href\": \"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200\" } }, \"responseModels\": { \"application/json\": \"Empty\" }, \"responseParameters\": { \"method.response.header.Content-Type\": false }, \"statusCode\": \"200\" } } }</code></pre> <p>If the <code>OPTIONS</code> is enabled on the resource, you can follow the example here to get that method. Just replace the <code>GET</code> of the last path segment in the request URL with <code>OPTIONS</code>.</p> </div> <div class=\"seeAlso\"> </div>"}]}},"description":"<p>Represents an API resource.</p> <div class=\"seeAlso\"> <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-create-api.html\">Create an API</a> </div>"},"RestApi":{"type":"object","properties":{"id":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":"The API's identifier. This identifier is unique across all of your APIs in API Gateway."}]},"name":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":"The API's name."}]},"description":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":"The API's description."}]},"createdDate":{"allOf":[{"$ref":"#/components/schemas/Timestamp"},{"description":"The timestamp when the API was created."}]},"version":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":"A version identifier for the API."}]},"warnings":{"allOf":[{"$ref":"#/components/schemas/ListOfString"},{"description":"The warning messages reported when <code>failonwarnings</code> is turned on during API import."}]},"binaryMediaTypes":{"allOf":[{"$ref":"#/components/schemas/ListOfString"},{"description":"The list of binary media types supported by the <a>RestApi</a>. By default, the <a>RestApi</a> supports only UTF-8-encoded text payloads."}]},"minimumCompressionSize":{"allOf":[{"$ref":"#/components/schemas/NullableInteger"},{"description":"A nullable integer that is used to enable compression (with non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable compression (with a null value) on an API. When compression is enabled, compression or decompression is not applied on the payload if the payload size is smaller than this value. Setting it to zero allows compression for any payload size."}]},"apiKeySource":{"allOf":[{"$ref":"#/components/schemas/ApiKeySourceType"},{"description":"The source of the API key for metering requests according to a usage plan. Valid values are: <ul><li><code>HEADER</code> to read the API key from the <code>X-API-Key</code> header of a request. </li><li><code>AUTHORIZER</code> to read the API key from the <code>UsageIdentifierKey</code> from a custom authorizer.</li></ul>"}]},"endpointConfiguration":{"allOf":[{"$ref":"#/components/schemas/EndpointConfiguration"},{"description":"The endpoint configuration of this <a>RestApi</a> showing the endpoint types of the API."}]},"policy":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":"A stringified JSON policy document that applies to this RestApi regardless of the caller and <a>Method</a> configuration."}]},"tags":{"allOf":[{"$ref":"#/components/schemas/MapOfStringToString"},{"description":"The collection of tags. Each tag element is associated with a given resource."}]},"disableExecuteApiEndpoint":{"allOf":[{"$ref":"#/components/schemas/Boolean"},{"description":"Specifies whether clients can invoke your API by using the default <code>execute-api</code> endpoint. By default, clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint."}]}},"description":"<p>Represents a REST API.</p> <div class=\"seeAlso\"> <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-create-api.html\">Create an API</a> </div>"},"Stage":{"type":"object","properties":{"deploymentId":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":"The identifier of the <a>Deployment</a> that the stage points to."}]},"clientCertificateId":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":"The identifier of a client certificate for an API stage."}]},"stageName":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":"The name of the stage is the first path segment in the Uniform Resource Identifier (URI) of a call to API Gateway. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters."}]},"description":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":"The stage's description."}]},"cacheClusterEnabled":{"allOf":[{"$ref":"#/components/schemas/Boolean"},{"description":"Specifies whether a cache cluster is enabled for the stage."}]},"cacheClusterSize":{"allOf":[{"$ref":"#/components/schemas/CacheClusterSize"},{"description":"The size of the cache cluster for the stage, if enabled."}]},"cacheClusterStatus":{"allOf":[{"$ref":"#/components/schemas/CacheClusterStatus"},{"description":"The status of the cache cluster for the stage, if enabled."}]},"methodSettings":{"allOf":[{"$ref":"#/components/schemas/MapOfMethodSettings"},{"description":"A map that defines the method settings for a <a>Stage</a> resource. Keys (designated as <code>/{method_setting_key</code> below) are method paths defined as <code>{resource_path}/{http_method}</code> for an individual method override, or <code>/\\*/\\*</code> for overriding all methods in the stage. "}]},"variables":{"allOf":[{"$ref":"#/components/schemas/MapOfStringToString"},{"description":"A map that defines the stage variables for a <a>Stage</a> resource. Variable names can have alphanumeric and underscore characters, and the values must match <code>[A-Za-z0-9-._~:/?#&=,]+</code>."}]},"documentationVersion":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":"The version of the associated API documentation."}]},"accessLogSettings":{"allOf":[{"$ref":"#/components/schemas/AccessLogSettings"},{"description":"Settings for logging access in this stage."}]},"canarySettings":{"allOf":[{"$ref":"#/components/schemas/CanarySettings"},{"description":"Settings for the canary deployment in this stage."}]},"tracingEnabled":{"allOf":[{"$ref":"#/components/schemas/Boolean"},{"description":"Specifies whether active tracing with X-ray is enabled for the <a>Stage</a>."}]},"webAclArn":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":"The ARN of the WebAcl associated with the <a>Stage</a>."}]},"tags":{"allOf":[{"$ref":"#/components/schemas/MapOfStringToString"},{"description":"The collection of tags. Each tag element is associated with a given resource."}]},"createdDate":{"allOf":[{"$ref":"#/components/schemas/Timestamp"},{"description":"The timestamp when the stage was created."}]},"lastUpdatedDate":{"allOf":[{"$ref":"#/components/schemas/Timestamp"},{"description":"The timestamp when the stage last updated."}]}},"description":"<p>Represents a unique identifier for a version of a deployed <a>RestApi</a> that is callable by users.</p> <div class=\"seeAlso\"> <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-deploy-api.html\">Deploy an API</a> </div>"},"UsagePlan":{"type":"object","properties":{"id":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":"The identifier of a <a>UsagePlan</a> resource."}]},"name":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":"The name of a usage plan."}]},"description":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":"The description of a usage plan."}]},"apiStages":{"allOf":[{"$ref":"#/components/schemas/ListOfApiStage"},{"description":"The associated API stages of a usage plan."}]},"throttle":{"allOf":[{"$ref":"#/components/schemas/ThrottleSettings"},{"description":"The request throttle limits of a usage plan."}]},"quota":{"allOf":[{"$ref":"#/components/schemas/QuotaSettings"},{"description":"The maximum number of permitted requests per a given unit time interval."}]},"productCode":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":"The AWS Markeplace product identifier to associate with the usage plan as a SaaS product on AWS Marketplace."}]},"tags":{"allOf":[{"$ref":"#/components/schemas/MapOfStringToString"},{"description":"The collection of tags. Each tag element is associated with a given resource."}]}},"description":"<p>Represents a usage plan than can specify who can assess associated API stages with specified request limits and quotas.</p> <div class=\"remarks\"> <p>In a usage plan, you associate an API by specifying the API's Id and a stage name of the specified API. You add plan customers by adding API keys to the plan. </p> </div> <div class=\"seeAlso\"> <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-api-usage-plans.html\">Create and Use Usage Plans</a> </div>"},"ApiStage":{"type":"object","properties":{"apiId":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":"API Id of the associated API stage in a usage plan."}]},"stage":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":"API stage name of the associated API stage in a usage plan."}]},"throttle":{"allOf":[{"$ref":"#/components/schemas/MapOfApiStageThrottleSettings"},{"description":"Map containing method level throttling information for API stage in a usage plan."}]}},"description":"API stage name of the associated API stage in a usage plan."},"Integer":{"type":"integer"},"QuotaPeriodType":{"type":"string","enum":["DAY","WEEK","MONTH"]},"UsagePlanKey":{"type":"object","properties":{"id":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":"The Id of a usage plan key."}]},"type":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":"The type of a usage plan key. Currently, the valid key type is <code>API_KEY</code>."}]},"value":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":"The value of a usage plan key."}]},"name":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":"The name of a usage plan key."}]}},"description":"<p>Represents a usage plan key to identify a plan customer.</p> <div class=\"remarks\"> <p>To associate an API stage with a selected API key in a usage plan, you must create a UsagePlanKey resource to represent the selected <a>ApiKey</a>.</p> </div>\" <div class=\"seeAlso\"> <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-api-usage-plans.html\">Create and Use Usage Plans</a> </div>"},"VpcLink":{"type":"object","properties":{"id":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":"The identifier of the <a>VpcLink</a>. It is used in an <a>Integration</a> to reference this <a>VpcLink</a>."}]},"name":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":"The name used to label and identify the VPC link."}]},"description":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":"The description of the VPC link."}]},"targetArns":{"allOf":[{"$ref":"#/components/schemas/ListOfString"},{"description":"The ARN of the network load balancer of the VPC targeted by the VPC link. The network load balancer must be owned by the same AWS account of the API owner."}]},"status":{"allOf":[{"$ref":"#/components/schemas/VpcLinkStatus"},{"description":"The status of the VPC link. The valid values are <code>AVAILABLE</code>, <code>PENDING</code>, <code>DELETING</code>, or <code>FAILED</code>. Deploying an API will wait if the status is <code>PENDING</code> and will fail if the status is <code>DELETING</code>."}]},"statusMessage":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":"A description about the VPC link status."}]},"tags":{"allOf":[{"$ref":"#/components/schemas/MapOfStringToString"},{"description":"The collection of tags. Each tag element is associated with a given resource."}]}},"description":"<p>An API Gateway VPC link for a <a>RestApi</a> to access resources in an Amazon Virtual Private Cloud (VPC).</p> <div class=\"remarks\"> <p><p>To enable access to a resource in an Amazon Virtual Private Cloud through Amazon API Gateway, you, as an API developer, create a <a>VpcLink</a> resource targeted for one or more network load balancers of the VPC and then integrate an API method with a private integration that uses the <a>VpcLink</a>. The private integration has an integration type of <code>HTTP</code> or <code>HTTP_PROXY</code> and has a connection type of <code>VPC_LINK</code>. The integration uses the <code>connectionId</code> property to identify the <a>VpcLink</a> used.</p></p> </div>"},"ClientCertificate":{"type":"object","properties":{"clientCertificateId":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":"The identifier of the client certificate."}]},"description":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":"The description of the client certificate."}]},"pemEncodedCertificate":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":"The PEM-encoded public key of the client certificate, which can be used to configure certificate authentication in the integration endpoint ."}]},"createdDate":{"allOf":[{"$ref":"#/components/schemas/Timestamp"},{"description":"The timestamp when the client certificate was created."}]},"expirationDate":{"allOf":[{"$ref":"#/components/schemas/Timestamp"},{"description":"The timestamp when the client certificate will expire."}]},"tags":{"allOf":[{"$ref":"#/components/schemas/MapOfStringToString"},{"description":"The collection of tags. Each tag element is associated with a given resource."}]}},"description":"<p>Represents a client certificate used to configure client-side SSL authentication while sending requests to the integration endpoint.</p> <div class=\"remarks\">Client certificates are used to authenticate an API by the backend server. To authenticate an API client (or user), use IAM roles and policies, a custom <a>Authorizer</a> or an Amazon Cognito user pool.</div> <div class=\"seeAlso\"> <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/getting-started-client-side-ssl-authentication.html\">Use Client-Side Certificate</a> </div>"},"Account":{"type":"object","properties":{"cloudwatchRoleArn":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":"The ARN of an Amazon CloudWatch role for the current <a>Account</a>."}]},"throttleSettings":{"allOf":[{"$ref":"#/components/schemas/ThrottleSettings"},{"description":"Specifies the API request limits configured for the current <a>Account</a>."}]},"features":{"allOf":[{"$ref":"#/components/schemas/ListOfString"},{"description":"A list of features supported for the account. When usage plans are enabled, the features list will include an entry of <code>\"UsagePlans\"</code>."}]},"apiKeyVersion":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":"The version of the API keys used for the account."}]}},"description":"<p>Represents an AWS account that is associated with API Gateway.</p> <div class=\"remarks\"> <p>To view the account info, call <code>GET</code> on this resource.</p> <h4>Error Codes</h4> <p>The following exception may be thrown when the request fails.</p> <ul> <li>UnauthorizedException</li> <li>NotFoundException</li> <li>TooManyRequestsException</li> </ul> <p>For detailed error code information, including the corresponding HTTP Status Codes, see <a href=\"https://docs.aws.amazon.com/apigateway/api-reference/handling-errors/#api-error-codes\">API Gateway Error Codes</a></p> <h4>Example: Get the information about an account.</h4> <h5>Request</h5> <pre><code>GET /account HTTP/1.1 Content-Type: application/json Host: apigateway.us-east-1.amazonaws.com X-Amz-Date: 20160531T184618Z Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID}/us-east-1/apigateway/aws4_request, SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash} </code></pre> <h5>Response</h5> <p>The successful response returns a <code>200 OK</code> status code and a payload similar to the following:</p> <pre><code>{ \"_links\": { \"curies\": { \"href\": \"https://docs.aws.amazon.com/apigateway/latest/developerguide/account-apigateway-{rel}.html\", \"name\": \"account\", \"templated\": true }, \"self\": { \"href\": \"/account\" }, \"account:update\": { \"href\": \"/account\" } }, \"cloudwatchRoleArn\": \"arn:aws:iam::123456789012:role/apigAwsProxyRole\", \"throttleSettings\": { \"rateLimit\": 500, \"burstLimit\": 1000 } } </code></pre> <p>In addition to making the REST API call directly, you can use the AWS CLI and an AWS SDK to access this resource.</p> </div> <div class=\"seeAlso\"> <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-limits.html\">API Gateway Limits</a> <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/welcome.html\">Developer Guide</a>, <a href=\"https://docs.aws.amazon.com/cli/latest/reference/apigateway/get-account.html\">AWS CLI</a> </div>"},"ApiKeys":{"type":"object","properties":{"warnings":{"allOf":[{"$ref":"#/components/schemas/ListOfString"},{"description":"A list of warning messages logged during the import of API keys when the <code>failOnWarnings</code> option is set to true."}]},"position":{"$ref":"#/components/schemas/String"},"items":{"allOf":[{"$ref":"#/components/schemas/ListOfApiKey"},{"xml":{"name":"item"},"description":"The current page of elements from this collection."}]}},"description":"<p>Represents a collection of API keys as represented by an <a>ApiKeys</a> resource.</p> <div class=\"seeAlso\"> <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-api-keys.html\">Use API Keys</a> </div>"},"Authorizers":{"type":"object","properties":{"position":{"$ref":"#/components/schemas/String"},"items":{"allOf":[{"$ref":"#/components/schemas/ListOfAuthorizer"},{"xml":{"name":"item"},"description":"The current page of elements from this collection."}]}},"description":"<p>Represents a collection of <a>Authorizer</a> resources.</p> <div class=\"seeAlso\"> <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-use-lambda-authorizer.html\">Use Lambda Function as Authorizer</a> <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-integrate-with-cognito.html\">Use Cognito User Pool as Authorizer</a> </div>"},"BasePathMappings":{"type":"object","properties":{"position":{"$ref":"#/components/schemas/String"},"items":{"allOf":[{"$ref":"#/components/schemas/ListOfBasePathMapping"},{"xml":{"name":"item"},"description":"The current page of elements from this collection."}]}},"description":"<p>Represents a collection of <a>BasePathMapping</a> resources.</p> <div class=\"seeAlso\"> <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-custom-domains.html\">Use Custom Domain Names</a> </div>"},"ClientCertificates":{"type":"object","properties":{"position":{"$ref":"#/components/schemas/String"},"items":{"allOf":[{"$ref":"#/components/schemas/ListOfClientCertificate"},{"xml":{"name":"item"},"description":"The current page of elements from this collection."}]}},"description":"<p>Represents a collection of <a>ClientCertificate</a> resources.</p> <div class=\"seeAlso\"> <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/getting-started-client-side-ssl-authentication.html\">Use Client-Side Certificate</a> </div>"},"Deployments":{"type":"object","properties":{"position":{"$ref":"#/components/schemas/String"},"items":{"allOf":[{"$ref":"#/components/schemas/ListOfDeployment"},{"xml":{"name":"item"},"description":"The current page of elements from this collection."}]}},"description":"<p>Represents a collection resource that contains zero or more references to your existing deployments, and links that guide you on how to interact with your collection. The collection offers a paginated view of the contained deployments.</p> <div class=\"remarks\">To create a new deployment of a <a>RestApi</a>, make a <code>POST</code> request against this resource. To view, update, or delete an existing deployment, make a <code>GET</code>, <code>PATCH</code>, or <code>DELETE</code> request, respectively, on a specified <a>Deployment</a> resource.</div> <div class=\"seeAlso\"> <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-deploy-api.html\">Deploying an API</a>, <a href=\"https://docs.aws.amazon.com/cli/latest/reference/apigateway/get-deployment.html\">AWS CLI</a>, <a href=\"https://aws.amazon.com/tools/\">AWS SDKs</a> </div>"},"DocumentationParts":{"type":"object","properties":{"position":{"$ref":"#/components/schemas/String"},"items":{"allOf":[{"$ref":"#/components/schemas/ListOfDocumentationPart"},{"xml":{"name":"item"},"description":"The current page of elements from this collection."}]}},"description":"<p>The collection of documentation parts of an API.</p> <div class=\"remarks\"/> <div class=\"seeAlso\"> <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-documenting-api.html\">Documenting an API</a>, <a>DocumentationPart</a> </div>"},"DocumentationVersions":{"type":"object","properties":{"position":{"$ref":"#/components/schemas/String"},"items":{"allOf":[{"$ref":"#/components/schemas/ListOfDocumentationVersion"},{"xml":{"name":"item"},"description":"The current page of elements from this collection."}]}},"description":"<p>The collection of documentation snapshots of an API. </p> <div class=\"remarks\"><p>Use the <a>DocumentationVersions</a> to manage documentation snapshots associated with various API stages.</p></div> <div class=\"seeAlso\"> <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-documenting-api.html\">Documenting an API</a>, <a>DocumentationPart</a>, <a>DocumentationVersion</a> </div>"},"DomainNames":{"type":"object","properties":{"position":{"$ref":"#/components/schemas/String"},"items":{"allOf":[{"$ref":"#/components/schemas/ListOfDomainName"},{"xml":{"name":"item"},"description":"The current page of elements from this collection."}]}},"description":"<p>Represents a collection of <a>DomainName</a> resources.</p> <div class=\"seeAlso\"> <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-custom-domains.html\">Use Client-Side Certificate</a> </div>"},"ExportResponse":{"type":"object","properties":{"body":{"allOf":[{"$ref":"#/components/schemas/Blob"},{"description":"The binary blob response to <a>GetExport</a>, which contains the export."}]}},"description":"The binary blob response to <a>GetExport</a>, which contains the generated SDK."},"GatewayResponse":{"type":"object","properties":{"responseType":{"allOf":[{"$ref":"#/components/schemas/GatewayResponseType"},{"description":"The response type of the associated <a>GatewayResponse</a>."}]},"statusCode":{"allOf":[{"$ref":"#/components/schemas/StatusCode"},{"description":"The HTTP status code for this <a>GatewayResponse</a>."}]},"responseParameters":{"allOf":[{"$ref":"#/components/schemas/MapOfStringToString"},{"description":"Response parameters (paths, query strings and headers) of the <a>GatewayResponse</a> as a string-to-string map of key-value pairs."}]},"responseTemplates":{"allOf":[{"$ref":"#/components/schemas/MapOfStringToString"},{"description":"Response templates of the <a>GatewayResponse</a> as a string-to-string map of key-value pairs."}]},"defaultResponse":{"allOf":[{"$ref":"#/components/schemas/Boolean"},{"description":"A Boolean flag to indicate whether this <a>GatewayResponse</a> is the default gateway response (<code>true</code>) or not (<code>false</code>). A default gateway response is one generated by API Gateway without any customization by an API developer. "}]}},"description":"<p>A gateway response of a given response type and status code, with optional response parameters and mapping templates.</p> <div class=\"remarks\"> For more information about valid gateway response types, see <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/supported-gateway-response-types.html\">Gateway Response Types Supported by API Gateway</a> <div class=\"example\"> <h4>Example: Get a Gateway Response of a given response type</h4> <h5>Request</h5> <p>This example shows how to get a gateway response of the <code>MISSING_AUTHENTICATION_TOKEN</code> type.</p> <pre><code>GET /restapis/o81lxisefl/gatewayresponses/MISSING_AUTHENTICATION_TOKEN HTTP/1.1 Host: beta-apigateway.us-east-1.amazonaws.com Content-Type: application/json X-Amz-Date: 20170503T202516Z Authorization: AWS4-HMAC-SHA256 Credential={access-key-id}/20170503/us-east-1/apigateway/aws4_request, SignedHeaders=content-type;host;x-amz-date, Signature=1b52460e3159c1a26cff29093855d50ea141c1c5b937528fecaf60f51129697a Cache-Control: no-cache Postman-Token: 3b2a1ce9-c848-2e26-2e2f-9c2caefbed45 </code></pre> <p>The response type is specified as a URL path.</p> <h5>Response</h5> <p>The successful operation returns the <code>200 OK</code> status code and a payload similar to the following:</p> <pre><code>{ \"_links\": { \"curies\": { \"href\": \"http://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-gatewayresponse-{rel}.html\", \"name\": \"gatewayresponse\", \"templated\": true }, \"self\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/MISSING_AUTHENTICATION_TOKEN\" }, \"gatewayresponse:delete\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/MISSING_AUTHENTICATION_TOKEN\" }, \"gatewayresponse:put\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/{response_type}\", \"templated\": true }, \"gatewayresponse:update\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/MISSING_AUTHENTICATION_TOKEN\" } }, \"defaultResponse\": false, \"responseParameters\": { \"gatewayresponse.header.x-request-path\": \"method.request.path.petId\", \"gatewayresponse.header.Access-Control-Allow-Origin\": \"'a.b.c'\", \"gatewayresponse.header.x-request-query\": \"method.request.querystring.q\", \"gatewayresponse.header.x-request-header\": \"method.request.header.Accept\" }, \"responseTemplates\": { \"application/json\": \"{\\n \\\"message\\\": $context.error.messageString,\\n \\\"type\\\": \\\"$context.error.responseType\\\",\\n \\\"stage\\\": \\\"$context.stage\\\",\\n \\\"resourcePath\\\": \\\"$context.resourcePath\\\",\\n \\\"stageVariables.a\\\": \\\"$stageVariables.a\\\",\\n \\\"statusCode\\\": \\\"'404'\\\"\\n}\" }, \"responseType\": \"MISSING_AUTHENTICATION_TOKEN\", \"statusCode\": \"404\" }</code></pre> <p/> </div> </div> <div class=\"seeAlso\"> <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/customize-gateway-responses.html\">Customize Gateway Responses</a> </div>"},"GatewayResponses":{"type":"object","properties":{"position":{"$ref":"#/components/schemas/String"},"items":{"allOf":[{"$ref":"#/components/schemas/ListOfGatewayResponse"},{"xml":{"name":"item"},"description":"Returns the entire collection, because of no pagination support."}]}},"description":"<p>The collection of the <a>GatewayResponse</a> instances of a <a>RestApi</a> as a <code>responseType</code>-to-<a>GatewayResponse</a> object map of key-value pairs. As such, pagination is not supported for querying this collection.</p> <div class=\"remarks\"> For more information about valid gateway response types, see <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/supported-gateway-response-types.html\">Gateway Response Types Supported by API Gateway</a> <div class=\"example\"> <h4>Example: Get the collection of gateway responses of an API</h4> <h5>Request</h5> <p>This example request shows how to retrieve the <a>GatewayResponses</a> collection from an API.</p> <pre><code>GET /restapis/o81lxisefl/gatewayresponses HTTP/1.1 Host: beta-apigateway.us-east-1.amazonaws.com Content-Type: application/json X-Amz-Date: 20170503T220604Z Authorization: AWS4-HMAC-SHA256 Credential={access-key-id}/20170503/us-east-1/apigateway/aws4_request, SignedHeaders=content-type;host;x-amz-date, Signature=59b42fe54a76a5de8adf2c67baa6d39206f8e9ad49a1d77ccc6a5da3103a398a Cache-Control: no-cache Postman-Token: 5637af27-dc29-fc5c-9dfe-0645d52cb515 </code></pre> <p/> <h5>Response</h5> <p>The successful operation returns the <code>200 OK</code> status code and a payload similar to the following:</p> <pre><code>{ \"_links\": { \"curies\": { \"href\": \"http://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-gatewayresponse-{rel}.html\", \"name\": \"gatewayresponse\", \"templated\": true }, \"self\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses\" }, \"first\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses\" }, \"gatewayresponse:by-type\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/{response_type}\", \"templated\": true }, \"item\": [ { \"href\": \"/restapis/o81lxisefl/gatewayresponses/INTEGRATION_FAILURE\" }, { \"href\": \"/restapis/o81lxisefl/gatewayresponses/RESOURCE_NOT_FOUND\" }, { \"href\": \"/restapis/o81lxisefl/gatewayresponses/REQUEST_TOO_LARGE\" }, { \"href\": \"/restapis/o81lxisefl/gatewayresponses/THROTTLED\" }, { \"href\": \"/restapis/o81lxisefl/gatewayresponses/UNSUPPORTED_MEDIA_TYPE\" }, { \"href\": \"/restapis/o81lxisefl/gatewayresponses/AUTHORIZER_CONFIGURATION_ERROR\" }, { \"href\": \"/restapis/o81lxisefl/gatewayresponses/DEFAULT_5XX\" }, { \"href\": \"/restapis/o81lxisefl/gatewayresponses/DEFAULT_4XX\" }, { \"href\": \"/restapis/o81lxisefl/gatewayresponses/BAD_REQUEST_PARAMETERS\" }, { \"href\": \"/restapis/o81lxisefl/gatewayresponses/BAD_REQUEST_BODY\" }, { \"href\": \"/restapis/o81lxisefl/gatewayresponses/EXPIRED_TOKEN\" }, { \"href\": \"/restapis/o81lxisefl/gatewayresponses/ACCESS_DENIED\" }, { \"href\": \"/restapis/o81lxisefl/gatewayresponses/INVALID_API_KEY\" }, { \"href\": \"/restapis/o81lxisefl/gatewayresponses/UNAUTHORIZED\" }, { \"href\": \"/restapis/o81lxisefl/gatewayresponses/API_CONFIGURATION_ERROR\" }, { \"href\": \"/restapis/o81lxisefl/gatewayresponses/QUOTA_EXCEEDED\" }, { \"href\": \"/restapis/o81lxisefl/gatewayresponses/INTEGRATION_TIMEOUT\" }, { \"href\": \"/restapis/o81lxisefl/gatewayresponses/MISSING_AUTHENTICATION_TOKEN\" }, { \"href\": \"/restapis/o81lxisefl/gatewayresponses/INVALID_SIGNATURE\" }, { \"href\": \"/restapis/o81lxisefl/gatewayresponses/AUTHORIZER_FAILURE\" } ] }, \"_embedded\": { \"item\": [ { \"_links\": { \"self\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/INTEGRATION_FAILURE\" }, \"gatewayresponse:put\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/{response_type}\", \"templated\": true }, \"gatewayresponse:update\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/INTEGRATION_FAILURE\" } }, \"defaultResponse\": true, \"responseParameters\": {}, \"responseTemplates\": { \"application/json\": \"{\\\"message\\\":$context.error.messageString}\" }, \"responseType\": \"INTEGRATION_FAILURE\", \"statusCode\": \"504\" }, { \"_links\": { \"self\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/RESOURCE_NOT_FOUND\" }, \"gatewayresponse:put\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/{response_type}\", \"templated\": true }, \"gatewayresponse:update\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/RESOURCE_NOT_FOUND\" } }, \"defaultResponse\": true, \"responseParameters\": {}, \"responseTemplates\": { \"application/json\": \"{\\\"message\\\":$context.error.messageString}\" }, \"responseType\": \"RESOURCE_NOT_FOUND\", \"statusCode\": \"404\" }, { \"_links\": { \"self\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/REQUEST_TOO_LARGE\" }, \"gatewayresponse:put\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/{response_type}\", \"templated\": true }, \"gatewayresponse:update\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/REQUEST_TOO_LARGE\" } }, \"defaultResponse\": true, \"responseParameters\": {}, \"responseTemplates\": { \"application/json\": \"{\\\"message\\\":$context.error.messageString}\" }, \"responseType\": \"REQUEST_TOO_LARGE\", \"statusCode\": \"413\" }, { \"_links\": { \"self\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/THROTTLED\" }, \"gatewayresponse:put\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/{response_type}\", \"templated\": true }, \"gatewayresponse:update\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/THROTTLED\" } }, \"defaultResponse\": true, \"responseParameters\": {}, \"responseTemplates\": { \"application/json\": \"{\\\"message\\\":$context.error.messageString}\" }, \"responseType\": \"THROTTLED\", \"statusCode\": \"429\" }, { \"_links\": { \"self\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/UNSUPPORTED_MEDIA_TYPE\" }, \"gatewayresponse:put\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/{response_type}\", \"templated\": true }, \"gatewayresponse:update\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/UNSUPPORTED_MEDIA_TYPE\" } }, \"defaultResponse\": true, \"responseParameters\": {}, \"responseTemplates\": { \"application/json\": \"{\\\"message\\\":$context.error.messageString}\" }, \"responseType\": \"UNSUPPORTED_MEDIA_TYPE\", \"statusCode\": \"415\" }, { \"_links\": { \"self\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/AUTHORIZER_CONFIGURATION_ERROR\" }, \"gatewayresponse:put\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/{response_type}\", \"templated\": true }, \"gatewayresponse:update\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/AUTHORIZER_CONFIGURATION_ERROR\" } }, \"defaultResponse\": true, \"responseParameters\": {}, \"responseTemplates\": { \"application/json\": \"{\\\"message\\\":$context.error.messageString}\" }, \"responseType\": \"AUTHORIZER_CONFIGURATION_ERROR\", \"statusCode\": \"500\" }, { \"_links\": { \"self\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/DEFAULT_5XX\" }, \"gatewayresponse:put\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/{response_type}\", \"templated\": true }, \"gatewayresponse:update\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/DEFAULT_5XX\" } }, \"defaultResponse\": true, \"responseParameters\": {}, \"responseTemplates\": { \"application/json\": \"{\\\"message\\\":$context.error.messageString}\" }, \"responseType\": \"DEFAULT_5XX\" }, { \"_links\": { \"self\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/DEFAULT_4XX\" }, \"gatewayresponse:put\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/{response_type}\", \"templated\": true }, \"gatewayresponse:update\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/DEFAULT_4XX\" } }, \"defaultResponse\": true, \"responseParameters\": {}, \"responseTemplates\": { \"application/json\": \"{\\\"message\\\":$context.error.messageString}\" }, \"responseType\": \"DEFAULT_4XX\" }, { \"_links\": { \"self\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/BAD_REQUEST_PARAMETERS\" }, \"gatewayresponse:put\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/{response_type}\", \"templated\": true }, \"gatewayresponse:update\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/BAD_REQUEST_PARAMETERS\" } }, \"defaultResponse\": true, \"responseParameters\": {}, \"responseTemplates\": { \"application/json\": \"{\\\"message\\\":$context.error.messageString}\" }, \"responseType\": \"BAD_REQUEST_PARAMETERS\", \"statusCode\": \"400\" }, { \"_links\": { \"self\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/BAD_REQUEST_BODY\" }, \"gatewayresponse:put\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/{response_type}\", \"templated\": true }, \"gatewayresponse:update\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/BAD_REQUEST_BODY\" } }, \"defaultResponse\": true, \"responseParameters\": {}, \"responseTemplates\": { \"application/json\": \"{\\\"message\\\":$context.error.messageString}\" }, \"responseType\": \"BAD_REQUEST_BODY\", \"statusCode\": \"400\" }, { \"_links\": { \"self\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/EXPIRED_TOKEN\" }, \"gatewayresponse:put\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/{response_type}\", \"templated\": true }, \"gatewayresponse:update\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/EXPIRED_TOKEN\" } }, \"defaultResponse\": true, \"responseParameters\": {}, \"responseTemplates\": { \"application/json\": \"{\\\"message\\\":$context.error.messageString}\" }, \"responseType\": \"EXPIRED_TOKEN\", \"statusCode\": \"403\" }, { \"_links\": { \"self\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/ACCESS_DENIED\" }, \"gatewayresponse:put\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/{response_type}\", \"templated\": true }, \"gatewayresponse:update\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/ACCESS_DENIED\" } }, \"defaultResponse\": true, \"responseParameters\": {}, \"responseTemplates\": { \"application/json\": \"{\\\"message\\\":$context.error.messageString}\" }, \"responseType\": \"ACCESS_DENIED\", \"statusCode\": \"403\" }, { \"_links\": { \"self\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/INVALID_API_KEY\" }, \"gatewayresponse:put\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/{response_type}\", \"templated\": true }, \"gatewayresponse:update\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/INVALID_API_KEY\" } }, \"defaultResponse\": true, \"responseParameters\": {}, \"responseTemplates\": { \"application/json\": \"{\\\"message\\\":$context.error.messageString}\" }, \"responseType\": \"INVALID_API_KEY\", \"statusCode\": \"403\" }, { \"_links\": { \"self\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/UNAUTHORIZED\" }, \"gatewayresponse:put\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/{response_type}\", \"templated\": true }, \"gatewayresponse:update\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/UNAUTHORIZED\" } }, \"defaultResponse\": true, \"responseParameters\": {}, \"responseTemplates\": { \"application/json\": \"{\\\"message\\\":$context.error.messageString}\" }, \"responseType\": \"UNAUTHORIZED\", \"statusCode\": \"401\" }, { \"_links\": { \"self\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/API_CONFIGURATION_ERROR\" }, \"gatewayresponse:put\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/{response_type}\", \"templated\": true }, \"gatewayresponse:update\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/API_CONFIGURATION_ERROR\" } }, \"defaultResponse\": true, \"responseParameters\": {}, \"responseTemplates\": { \"application/json\": \"{\\\"message\\\":$context.error.messageString}\" }, \"responseType\": \"API_CONFIGURATION_ERROR\", \"statusCode\": \"500\" }, { \"_links\": { \"self\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/QUOTA_EXCEEDED\" }, \"gatewayresponse:put\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/{response_type}\", \"templated\": true }, \"gatewayresponse:update\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/QUOTA_EXCEEDED\" } }, \"defaultResponse\": true, \"responseParameters\": {}, \"responseTemplates\": { \"application/json\": \"{\\\"message\\\":$context.error.messageString}\" }, \"responseType\": \"QUOTA_EXCEEDED\", \"statusCode\": \"429\" }, { \"_links\": { \"self\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/INTEGRATION_TIMEOUT\" }, \"gatewayresponse:put\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/{response_type}\", \"templated\": true }, \"gatewayresponse:update\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/INTEGRATION_TIMEOUT\" } }, \"defaultResponse\": true, \"responseParameters\": {}, \"responseTemplates\": { \"application/json\": \"{\\\"message\\\":$context.error.messageString}\" }, \"responseType\": \"INTEGRATION_TIMEOUT\", \"statusCode\": \"504\" }, { \"_links\": { \"self\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/MISSING_AUTHENTICATION_TOKEN\" }, \"gatewayresponse:put\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/{response_type}\", \"templated\": true }, \"gatewayresponse:update\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/MISSING_AUTHENTICATION_TOKEN\" } }, \"defaultResponse\": true, \"responseParameters\": {}, \"responseTemplates\": { \"application/json\": \"{\\\"message\\\":$context.error.messageString}\" }, \"responseType\": \"MISSING_AUTHENTICATION_TOKEN\", \"statusCode\": \"403\" }, { \"_links\": { \"self\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/INVALID_SIGNATURE\" }, \"gatewayresponse:put\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/{response_type}\", \"templated\": true }, \"gatewayresponse:update\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/INVALID_SIGNATURE\" } }, \"defaultResponse\": true, \"responseParameters\": {}, \"responseTemplates\": { \"application/json\": \"{\\\"message\\\":$context.error.messageString}\" }, \"responseType\": \"INVALID_SIGNATURE\", \"statusCode\": \"403\" }, { \"_links\": { \"self\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/AUTHORIZER_FAILURE\" }, \"gatewayresponse:put\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/{response_type}\", \"templated\": true }, \"gatewayresponse:update\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/AUTHORIZER_FAILURE\" } }, \"defaultResponse\": true, \"responseParameters\": {}, \"responseTemplates\": { \"application/json\": \"{\\\"message\\\":$context.error.messageString}\" }, \"responseType\": \"AUTHORIZER_FAILURE\", \"statusCode\": \"500\" } ] } }</code></pre> <p/> </div> </div> <div class=\"seeAlso\"> <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/customize-gateway-responses.html\">Customize Gateway Responses</a> </div>"},"Integration":{"type":"object","properties":{"type":{"allOf":[{"$ref":"#/components/schemas/IntegrationType"},{"description":"<p>Specifies an API method integration type. The valid value is one of the following:</p> <ul> <li><code>AWS</code>: for integrating the API method request with an AWS service action, including the Lambda function-invoking action. With the Lambda function-invoking action, this is referred to as the Lambda custom integration. With any other AWS service action, this is known as AWS integration.</li> <li><code>AWS_PROXY</code>: for integrating the API method request with the Lambda function-invoking action with the client request passed through as-is. This integration is also referred to as the Lambda proxy integration.</li> <li><code>HTTP</code>: for integrating the API method request with an HTTP endpoint, including a private HTTP endpoint within a VPC. This integration is also referred to as the HTTP custom integration.</li> <li><code>HTTP_PROXY</code>: for integrating the API method request with an HTTP endpoint, including a private HTTP endpoint within a VPC, with the client request passed through as-is. This is also referred to as the HTTP proxy integration.</li> <li><code>MOCK</code>: for integrating the API method request with API Gateway as a \"loop-back\" endpoint without invoking any backend.</li> </ul> <p>For the HTTP and HTTP proxy integrations, each integration can specify a protocol (<code>http/https</code>), port and path. Standard 80 and 443 ports are supported as well as custom ports above 1024. An HTTP or HTTP proxy integration with a <code>connectionType</code> of <code>VPC_LINK</code> is referred to as a private integration and uses a <a>VpcLink</a> to connect API Gateway to a network load balancer of a VPC.</p>"}]},"httpMethod":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":"Specifies the integration's HTTP method type."}]},"uri":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":"<p>Specifies Uniform Resource Identifier (URI) of the integration endpoint.</p> <ul> <li><p> For <code>HTTP</code> or <code>HTTP_PROXY</code> integrations, the URI must be a fully formed, encoded HTTP(S) URL according to the <a href=\"https://en.wikipedia.org/wiki/Uniform_Resource_Identifier\" target=\"_blank\">RFC-3986 specification</a>, for either standard integration, where <code>connectionType</code> is not <code>VPC_LINK</code>, or private integration, where <code>connectionType</code> is <code>VPC_LINK</code>. For a private HTTP integration, the URI is not used for routing. </p> </li> <li><p> For <code>AWS</code> or <code>AWS_PROXY</code> integrations, the URI is of the form <code>arn:aws:apigateway:{region}:{subdomain.service|service}:path|action/{service_api}</code>. Here, <code>{Region}</code> is the API Gateway region (e.g., <code>us-east-1</code>); <code>{service}</code> is the name of the integrated AWS service (e.g., <code>s3</code>); and <code>{subdomain}</code> is a designated subdomain supported by certain AWS service for fast host-name lookup. <code>action</code> can be used for an AWS service action-based API, using an <code>Action={name}&{p1}={v1}&p2={v2}...</code> query string. The ensuing <code>{service_api}</code> refers to a supported action <code>{name}</code> plus any required input parameters. Alternatively, <code>path</code> can be used for an AWS service path-based API. The ensuing <code>service_api</code> refers to the path to an AWS service resource, including the region of the integrated AWS service, if applicable. For example, for integration with the S3 API of <code><a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/RESTObjectGET.html\">GetObject</a></code>, the <code>uri</code> can be either <code>arn:aws:apigateway:us-west-2:s3:action/GetObject&Bucket={bucket}&Key={key}</code> or <code>arn:aws:apigateway:us-west-2:s3:path/{bucket}/{key}</code></p> </li></ul>"}]},"connectionType":{"allOf":[{"$ref":"#/components/schemas/ConnectionType"},{"description":"The type of the network connection to the integration endpoint. The valid value is <code>INTERNET</code> for connections through the public routable internet or <code>VPC_LINK</code> for private connections between API Gateway and a network load balancer in a VPC. The default value is <code>INTERNET</code>."}]},"connectionId":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":"The (<a href=\"https://docs.aws.amazon.com/apigateway/api-reference/resource/vpc-link/#id\"><code>id</code></a>) of the <a>VpcLink</a> used for the integration when <code>connectionType=VPC_LINK</code> and undefined, otherwise."}]},"credentials":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":"Specifies the credentials required for the integration, if any. For AWS integrations, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify the string <code>arn:aws:iam::\\*:user/\\*</code>. To use resource-based permissions on supported AWS services, specify null."}]},"requestParameters":{"allOf":[{"$ref":"#/components/schemas/MapOfStringToString"},{"description":"A key-value map specifying request parameters that are passed from the method request to the back end. The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the back end. The method request parameter value must match the pattern of <code>method.request.{location}.{name}</code>, where <code>location</code> is <code>querystring</code>, <code>path</code>, or <code>header</code> and <code>name</code> must be a valid and unique method request parameter name."}]},"requestTemplates":{"allOf":[{"$ref":"#/components/schemas/MapOfStringToString"},{"description":"Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value."}]},"passthroughBehavior":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":"<div> <p> Specifies how the method request body of an unmapped content type will be passed through the integration request to the back end without transformation. A content type is unmapped if no mapping template is defined in the integration or the content type does not match any of the mapped content types, as specified in <code>requestTemplates</code>. The valid value is one of the following: </p> <ul> <li> <code>WHEN_NO_MATCH</code>: passes the method request body through the integration request to the back end without transformation when the method request content type does not match any content type associated with the mapping templates defined in the integration request. </li> <li> <code>WHEN_NO_TEMPLATES</code>: passes the method request body through the integration request to the back end without transformation when no mapping template is defined in the integration request. If a template is defined when this option is selected, the method request of an unmapped content-type will be rejected with an HTTP <code>415 Unsupported Media Type</code> response. </li> <li> <code>NEVER</code>: rejects the method request with an HTTP <code>415 Unsupported Media Type</code> response when either the method request content type does not match any content type associated with the mapping templates defined in the integration request or no mapping template is defined in the integration request. </li> </ul> </div>"}]},"contentHandling":{"allOf":[{"$ref":"#/components/schemas/ContentHandlingStrategy"},{"description":"<p>Specifies how to handle request payload content type conversions. Supported values are <code>CONVERT_TO_BINARY</code> and <code>CONVERT_TO_TEXT</code>, with the following behaviors:</p> <ul> <li><p><code>CONVERT_TO_BINARY</code>: Converts a request payload from a Base64-encoded string to the corresponding binary blob.</p></li> <li><p><code>CONVERT_TO_TEXT</code>: Converts a request payload from a binary blob to a Base64-encoded string.</p></li> </ul> <p>If this property is not defined, the request payload will be passed through from the method request to integration request without modification, provided that the <code>passthroughBehavior</code> is configured to support payload pass-through.</p>"}]},"timeoutInMillis":{"allOf":[{"$ref":"#/components/schemas/Integer"},{"description":"Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds."}]},"cacheNamespace":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":"Specifies a group of related cached parameters. By default, API Gateway uses the resource ID as the <code>cacheNamespace</code>. You can specify the same <code>cacheNamespace</code> across resources to return the same cached data for requests to different resources."}]},"cacheKeyParameters":{"allOf":[{"$ref":"#/components/schemas/ListOfString"},{"description":"A list of request parameters whose values API Gateway caches. To be valid values for <code>cacheKeyParameters</code>, these parameters must also be specified for <a>Method</a> <code>requestParameters</code>."}]},"integrationResponses":{"allOf":[{"$ref":"#/components/schemas/MapOfIntegrationResponse"},{"description":"<p>Specifies the integration's responses.</p> <div class=\"remarks\"> <p/> <h4>Example: Get integration responses of a method</h4> <h5>Request</h5> <p/> <pre><code>GET /restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200 HTTP/1.1 Content-Type: application/json Host: apigateway.us-east-1.amazonaws.com X-Amz-Date: 20160607T191449Z Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID}/20160607/us-east-1/apigateway/aws4_request, SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash} </code></pre> <h5>Response</h5> <p>The successful response returns <code>200 OK</code> status and a payload as follows:</p> <pre><code>{ \"_links\": { \"curies\": { \"href\": \"https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-response-{rel}.html\", \"name\": \"integrationresponse\", \"templated\": true }, \"self\": { \"href\": \"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200\", \"title\": \"200\" }, \"integrationresponse:delete\": { \"href\": \"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200\" }, \"integrationresponse:update\": { \"href\": \"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200\" } }, \"responseParameters\": { \"method.response.header.Content-Type\": \"'application/xml'\" }, \"responseTemplates\": { \"application/json\": \"$util.urlDecode(\\\"%3CkinesisStreams%3E#foreach($stream in $input.path('$.StreamNames'))%3Cstream%3E%3Cname%3E$stream%3C/name%3E%3C/stream%3E#end%3C/kinesisStreams%3E\\\")\\n\" }, \"statusCode\": \"200\" }</code></pre> <p/> </div> <div class=\"seeAlso\"> <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-create-api.html\">Creating an API</a> </div>"}]},"tlsConfig":{"allOf":[{"$ref":"#/components/schemas/TlsConfig"},{"description":"Specifies the TLS configuration for an integration."}]}},"description":"<p>Represents an HTTP, HTTP_PROXY, AWS, AWS_PROXY, or Mock integration.</p> <div class=\"remarks\">In the API Gateway console, the built-in Lambda integration is an AWS integration.</div> <div class=\"seeAlso\"> <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-create-api.html\">Creating an API</a> </div>"},"IntegrationResponse":{"type":"object","properties":{"statusCode":{"allOf":[{"$ref":"#/components/schemas/StatusCode"},{"description":"Specifies the status code that is used to map the integration response to an existing <a>MethodResponse</a>."}]},"selectionPattern":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":"Specifies the regular expression (regex) pattern used to choose an integration response based on the response from the back end. For example, if the success response returns nothing and the error response returns some string, you could use the <code>.+</code> regex to match error response. However, make sure that the error response does not contain any newline (<code>\\n</code>) character in such cases. If the back end is an AWS Lambda function, the AWS Lambda function error header is matched. For all other HTTP and AWS back ends, the HTTP status code is matched."}]},"responseParameters":{"allOf":[{"$ref":"#/components/schemas/MapOfStringToString"},{"description":"A key-value map specifying response parameters that are passed to the method response from the back end. The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of <code>method.response.header.{name}</code>, where <code>name</code> is a valid and unique header name. The mapped non-static value must match the pattern of <code>integration.response.header.{name}</code> or <code>integration.response.body.{JSON-expression}</code>, where <code>name</code> is a valid and unique response header name and <code>JSON-expression</code> is a valid JSON expression without the <code>$</code> prefix."}]},"responseTemplates":{"allOf":[{"$ref":"#/components/schemas/MapOfStringToString"},{"description":"Specifies the templates used to transform the integration response body. Response templates are represented as a key/value map, with a content-type as the key and a template as the value."}]},"contentHandling":{"allOf":[{"$ref":"#/components/schemas/ContentHandlingStrategy"},{"description":"<p>Specifies how to handle response payload content type conversions. Supported values are <code>CONVERT_TO_BINARY</code> and <code>CONVERT_TO_TEXT</code>, with the following behaviors:</p> <ul> <li><p><code>CONVERT_TO_BINARY</code>: Converts a response payload from a Base64-encoded string to the corresponding binary blob.</p></li> <li><p><code>CONVERT_TO_TEXT</code>: Converts a response payload from a binary blob to a Base64-encoded string.</p></li> </ul> <p>If this property is not defined, the response payload will be passed through from the integration response to the method response without modification.</p>"}]}},"description":"<p>Represents an integration response. The status code must map to an existing <a>MethodResponse</a>, and parameters and templates can be used to transform the back-end response.</p> <div class=\"seeAlso\"> <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-create-api.html\">Creating an API</a> </div>"},"Method":{"type":"object","properties":{"httpMethod":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":"The method's HTTP verb."}]},"authorizationType":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":"The method's authorization type. Valid values are <code>NONE</code> for open access, <code>AWS_IAM</code> for using AWS IAM permissions, <code>CUSTOM</code> for using a custom authorizer, or <code>COGNITO_USER_POOLS</code> for using a Cognito user pool."}]},"authorizerId":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":"The identifier of an <a>Authorizer</a> to use on this method. The <code>authorizationType</code> must be <code>CUSTOM</code>."}]},"apiKeyRequired":{"allOf":[{"$ref":"#/components/schemas/NullableBoolean"},{"description":"A boolean flag specifying whether a valid <a>ApiKey</a> is required to invoke this method."}]},"requestValidatorId":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":"The identifier of a <a>RequestValidator</a> for request validation."}]},"operationName":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":"A human-friendly operation identifier for the method. For example, you can assign the <code>operationName</code> of <code>ListPets</code> for the <code>GET /pets</code> method in the <code>PetStore</code> example."}]},"requestParameters":{"allOf":[{"$ref":"#/components/schemas/MapOfStringToBoolean"},{"description":"A key-value map defining required or optional method request parameters that can be accepted by API Gateway. A key is a method request parameter name matching the pattern of <code>method.request.{location}.{name}</code>, where <code>location</code> is <code>querystring</code>, <code>path</code>, or <code>header</code> and <code>name</code> is a valid and unique parameter name. The value associated with the key is a Boolean flag indicating whether the parameter is required (<code>true</code>) or optional (<code>false</code>). The method request parameter names defined here are available in <a>Integration</a> to be mapped to integration request parameters or templates."}]},"requestModels":{"allOf":[{"$ref":"#/components/schemas/MapOfStringToString"},{"description":"A key-value map specifying data schemas, represented by <a>Model</a> resources, (as the mapped value) of the request payloads of given content types (as the mapping key)."}]},"methodResponses":{"allOf":[{"$ref":"#/components/schemas/MapOfMethodResponse"},{"description":"<p>Gets a method response associated with a given HTTP status code. </p> <div class=\"remarks\"> <p>The collection of method responses are encapsulated in a key-value map, where the key is a response's HTTP status code and the value is a <a>MethodResponse</a> resource that specifies the response returned to the caller from the back end through the integration response.</p> <h4>Example: Get a 200 OK response of a GET method</h4> <h5>Request</h5> <p/> <pre><code>GET /restapis/uojnr9hd57/resources/0cjtch/methods/GET/responses/200 HTTP/1.1 Content-Type: application/json Host: apigateway.us-east-1.amazonaws.com Content-Length: 117 X-Amz-Date: 20160613T215008Z Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID}/20160613/us-east-1/apigateway/aws4_request, SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash}</code></pre> <h5>Response</h5> <p>The successful response returns a <code>200 OK</code> status code and a payload similar to the following:</p> <pre><code>{ \"_links\": { \"curies\": { \"href\": \"https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-method-response-{rel}.html\", \"name\": \"methodresponse\", \"templated\": true }, \"self\": { \"href\": \"/restapis/uojnr9hd57/resources/0cjtch/methods/GET/responses/200\", \"title\": \"200\" }, \"methodresponse:delete\": { \"href\": \"/restapis/uojnr9hd57/resources/0cjtch/methods/GET/responses/200\" }, \"methodresponse:update\": { \"href\": \"/restapis/uojnr9hd57/resources/0cjtch/methods/GET/responses/200\" } }, \"responseModels\": { \"application/json\": \"Empty\" }, \"responseParameters\": { \"method.response.header.operator\": false, \"method.response.header.operand_2\": false, \"method.response.header.operand_1\": false }, \"statusCode\": \"200\" }</code></pre> <p/> </div> <div class=\"seeAlso\"> <a href=\"https://docs.aws.amazon.com/cli/latest/reference/apigateway/get-method-response.html\">AWS CLI</a> </div>"}]},"methodIntegration":{"allOf":[{"$ref":"#/components/schemas/Integration"},{"description":"<p>Gets the method's integration responsible for passing the client-submitted request to the back end and performing necessary transformations to make the request compliant with the back end.</p> <div class=\"remarks\"> <p/> <h4>Example: </h4> <h5>Request</h5> <p/> <pre><code>GET /restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration HTTP/1.1 Content-Type: application/json Host: apigateway.us-east-1.amazonaws.com Content-Length: 117 X-Amz-Date: 20160613T213210Z Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID}/20160613/us-east-1/apigateway/aws4_request, SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash}</code></pre> <h5>Response</h5> <p>The successful response returns a <code>200 OK</code> status code and a payload similar to the following:</p> <pre><code>{ \"_links\": { \"curies\": [ { \"href\": \"https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-{rel}.html\", \"name\": \"integration\", \"templated\": true }, { \"href\": \"https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-response-{rel}.html\", \"name\": \"integrationresponse\", \"templated\": true } ], \"self\": { \"href\": \"/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration\" }, \"integration:delete\": { \"href\": \"/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration\" }, \"integration:responses\": { \"href\": \"/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration/responses/200\", \"name\": \"200\", \"title\": \"200\" }, \"integration:update\": { \"href\": \"/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration\" }, \"integrationresponse:put\": { \"href\": \"/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration/responses/{status_code}\", \"templated\": true } }, \"cacheKeyParameters\": [], \"cacheNamespace\": \"0cjtch\", \"credentials\": \"arn:aws:iam::123456789012:role/apigAwsProxyRole\", \"httpMethod\": \"POST\", \"passthroughBehavior\": \"WHEN_NO_MATCH\", \"requestTemplates\": { \"application/json\": \"{\\n \\\"a\\\": \\\"$input.params('operand1')\\\",\\n \\\"b\\\": \\\"$input.params('operand2')\\\", \\n \\\"op\\\": \\\"$input.params('operator')\\\" \\n}\" }, \"type\": \"AWS\", \"uri\": \"arn:aws:apigateway:us-west-2:lambda:path//2015-03-31/functions/arn:aws:lambda:us-west-2:123456789012:function:Calc/invocations\", \"_embedded\": { \"integration:responses\": { \"_links\": { \"self\": { \"href\": \"/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration/responses/200\", \"name\": \"200\", \"title\": \"200\" }, \"integrationresponse:delete\": { \"href\": \"/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration/responses/200\" }, \"integrationresponse:update\": { \"href\": \"/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration/responses/200\" } }, \"responseParameters\": { \"method.response.header.operator\": \"integration.response.body.op\", \"method.response.header.operand_2\": \"integration.response.body.b\", \"method.response.header.operand_1\": \"integration.response.body.a\" }, \"responseTemplates\": { \"application/json\": \"#set($res = $input.path('$'))\\n{\\n \\\"result\\\": \\\"$res.a, $res.b, $res.op => $res.c\\\",\\n \\\"a\\\" : \\\"$res.a\\\",\\n \\\"b\\\" : \\\"$res.b\\\",\\n \\\"op\\\" : \\\"$res.op\\\",\\n \\\"c\\\" : \\\"$res.c\\\"\\n}\" }, \"selectionPattern\": \"\", \"statusCode\": \"200\" } } }</code></pre> <p/> </div> <div class=\"seeAlso\"> <a href=\"https://docs.aws.amazon.com/cli/latest/reference/apigateway/get-integration.html\">AWS CLI</a> </div>"}]},"authorizationScopes":{"allOf":[{"$ref":"#/components/schemas/ListOfString"},{"description":"A list of authorization scopes configured on the method. The scopes are used with a <code>COGNITO_USER_POOLS</code> authorizer to authorize the method invocation. The authorization works by matching the method scopes against the scopes parsed from the access token in the incoming request. The method invocation is authorized if any method scopes matches a claimed scope in the access token. Otherwise, the invocation is not authorized. When the method scope is configured, the client must provide an access token instead of an identity token for authorization purposes."}]}},"description":"<p> Represents a client-facing interface by which the client calls the API to access back-end resources. A <b>Method</b> resource is integrated with an <a>Integration</a> resource. Both consist of a request and one or more responses. The method request takes the client input that is passed to the back end through the integration request. A method response returns the output from the back end to the client through an integration response. A method request is embodied in a <b>Method</b> resource, whereas an integration request is embodied in an <a>Integration</a> resource. On the other hand, a method response is represented by a <a>MethodResponse</a> resource, whereas an integration response is represented by an <a>IntegrationResponse</a> resource. </p> <div class=\"remarks\"> <p/> <h4>Example: Retrive the GET method on a specified resource</h4> <h5>Request</h5> <p>The following example request retrieves the information about the GET method on an API resource (<code>3kzxbg5sa2</code>) of an API (<code>fugvjdxtri</code>). </p> <pre><code>GET /restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET HTTP/1.1 Content-Type: application/json Host: apigateway.us-east-1.amazonaws.com X-Amz-Date: 20160603T210259Z Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID}/20160603/us-east-1/apigateway/aws4_request, SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash}</code></pre> <h5>Response</h5> <p>The successful response returns a <code>200 OK</code> status code and a payload similar to the following:</p> <pre><code>{ \"_links\": { \"curies\": [ { \"href\": \"https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-{rel}.html\", \"name\": \"integration\", \"templated\": true }, { \"href\": \"https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-response-{rel}.html\", \"name\": \"integrationresponse\", \"templated\": true }, { \"href\": \"https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-method-{rel}.html\", \"name\": \"method\", \"templated\": true }, { \"href\": \"https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-method-response-{rel}.html\", \"name\": \"methodresponse\", \"templated\": true } ], \"self\": { \"href\": \"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET\", \"name\": \"GET\", \"title\": \"GET\" }, \"integration:put\": { \"href\": \"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration\" }, \"method:delete\": { \"href\": \"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET\" }, \"method:integration\": { \"href\": \"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration\" }, \"method:responses\": { \"href\": \"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200\", \"name\": \"200\", \"title\": \"200\" }, \"method:update\": { \"href\": \"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET\" }, \"methodresponse:put\": { \"href\": \"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/{status_code}\", \"templated\": true } }, \"apiKeyRequired\": true, \"authorizationType\": \"NONE\", \"httpMethod\": \"GET\", \"_embedded\": { \"method:integration\": { \"_links\": { \"self\": { \"href\": \"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration\" }, \"integration:delete\": { \"href\": \"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration\" }, \"integration:responses\": { \"href\": \"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200\", \"name\": \"200\", \"title\": \"200\" }, \"integration:update\": { \"href\": \"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration\" }, \"integrationresponse:put\": { \"href\": \"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/{status_code}\", \"templated\": true } }, \"cacheKeyParameters\": [], \"cacheNamespace\": \"3kzxbg5sa2\", \"credentials\": \"arn:aws:iam::123456789012:role/apigAwsProxyRole\", \"httpMethod\": \"POST\", \"passthroughBehavior\": \"WHEN_NO_MATCH\", \"requestParameters\": { \"integration.request.header.Content-Type\": \"'application/x-amz-json-1.1'\" }, \"requestTemplates\": { \"application/json\": \"{\\n}\" }, \"type\": \"AWS\", \"uri\": \"arn:aws:apigateway:us-east-1:kinesis:action/ListStreams\", \"_embedded\": { \"integration:responses\": { \"_links\": { \"self\": { \"href\": \"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200\", \"name\": \"200\", \"title\": \"200\" }, \"integrationresponse:delete\": { \"href\": \"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200\" }, \"integrationresponse:update\": { \"href\": \"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200\" } }, \"responseParameters\": { \"method.response.header.Content-Type\": \"'application/xml'\" }, \"responseTemplates\": { \"application/json\": \"$util.urlDecode(\\\"%3CkinesisStreams%3E%23foreach(%24stream%20in%20%24input.path(%27%24.StreamNames%27))%3Cstream%3E%3Cname%3E%24stream%3C%2Fname%3E%3C%2Fstream%3E%23end%3C%2FkinesisStreams%3E\\\")\" }, \"statusCode\": \"200\" } } }, \"method:responses\": { \"_links\": { \"self\": { \"href\": \"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200\", \"name\": \"200\", \"title\": \"200\" }, \"methodresponse:delete\": { \"href\": \"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200\" }, \"methodresponse:update\": { \"href\": \"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200\" } }, \"responseModels\": { \"application/json\": \"Empty\" }, \"responseParameters\": { \"method.response.header.Content-Type\": false }, \"statusCode\": \"200\" } } }</code></pre> <p>In the example above, the response template for the <code>200 OK</code> response maps the JSON output from the <code>ListStreams</code> action in the back end to an XML output. The mapping template is URL-encoded as <code>%3CkinesisStreams%3E%23foreach(%24stream%20in%20%24input.path(%27%24.StreamNames%27))%3Cstream%3E%3Cname%3E%24stream%3C%2Fname%3E%3C%2Fstream%3E%23end%3C%2FkinesisStreams%3E</code> and the output is decoded using the <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-mapping-template-reference.html#util-templat-reference\">$util.urlDecode()</a> helper function.</p> </div> <div class=\"seeAlso\"> <a>MethodResponse</a>, <a>Integration</a>, <a>IntegrationResponse</a>, <a>Resource</a>, <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-method-settings.html\">Set up an API's method</a> </div>"},"MethodResponse":{"type":"object","properties":{"statusCode":{"allOf":[{"$ref":"#/components/schemas/StatusCode"},{"description":"The method response's status code."}]},"responseParameters":{"allOf":[{"$ref":"#/components/schemas/MapOfStringToBoolean"},{"description":"A key-value map specifying required or optional response parameters that API Gateway can send back to the caller. A key defines a method response header and the value specifies whether the associated method response header is required or not. The expression of the key must match the pattern <code>method.response.header.{name}</code>, where <code>name</code> is a valid and unique header name. API Gateway passes certain integration response data to the method response headers specified here according to the mapping you prescribe in the API's <a>IntegrationResponse</a>. The integration response data that can be mapped include an integration response header expressed in <code>integration.response.header.{name}</code>, a static value enclosed within a pair of single quotes (e.g., <code>'application/json'</code>), or a JSON expression from the back-end response payload in the form of <code>integration.response.body.{JSON-expression}</code>, where <code>JSON-expression</code> is a valid JSON expression without the <code>$</code> prefix.)"}]},"responseModels":{"allOf":[{"$ref":"#/components/schemas/MapOfStringToString"},{"description":"Specifies the <a>Model</a> resources used for the response's content-type. Response models are represented as a key/value map, with a content-type as the key and a <a>Model</a> name as the value."}]}},"description":"<p>Represents a method response of a given HTTP status code returned to the client. The method response is passed from the back end through the associated integration response that can be transformed using a mapping template. </p> <div class=\"remarks\"> <p/> <h4>Example: A <b>MethodResponse</b> instance of an API</h4> <h5>Request</h5> <p>The example request retrieves a <b>MethodResponse</b> of the 200 status code.</p> <pre><code>GET /restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200 HTTP/1.1 Content-Type: application/json Host: apigateway.us-east-1.amazonaws.com X-Amz-Date: 20160603T222952Z Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID}/20160603/us-east-1/apigateway/aws4_request, SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash}</code></pre> <h5>Response</h5> <p>The successful response returns <code>200 OK</code> status and a payload as follows:</p> <pre><code>{ \"_links\": { \"curies\": { \"href\": \"https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-method-response-{rel}.html\", \"name\": \"methodresponse\", \"templated\": true }, \"self\": { \"href\": \"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200\", \"title\": \"200\" }, \"methodresponse:delete\": { \"href\": \"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200\" }, \"methodresponse:update\": { \"href\": \"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200\" } }, \"responseModels\": { \"application/json\": \"Empty\" }, \"responseParameters\": { \"method.response.header.Content-Type\": false }, \"statusCode\": \"200\" }</code></pre> <p/> </div> <div class=\"seeAlso\"> <a>Method</a>, <a>IntegrationResponse</a>, <a>Integration</a> <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-create-api.html\">Creating an API</a> </div>"},"Template":{"type":"object","properties":{"value":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":"The Apache <a href=\"https://velocity.apache.org/engine/devel/vtl-reference.html\" target=\"_blank\">Velocity Template Language (VTL)</a> template content used for the template resource."}]}},"description":"<p>Represents a mapping template used to transform a payload.</p> <div class=\"seeAlso\"> <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/models-mappings.html#models-mappings-mappings\">Mapping Templates</a> </div>"},"Models":{"type":"object","properties":{"position":{"$ref":"#/components/schemas/String"},"items":{"allOf":[{"$ref":"#/components/schemas/ListOfModel"},{"xml":{"name":"item"},"description":"The current page of elements from this collection."}]}},"description":"<p>Represents a collection of <a>Model</a> resources.</p> <div class=\"seeAlso\"> <a>Method</a>, <a>MethodResponse</a>, <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/models-mappings.html\">Models and Mappings</a> </div>"},"RequestValidators":{"type":"object","properties":{"position":{"$ref":"#/components/schemas/String"},"items":{"allOf":[{"$ref":"#/components/schemas/ListOfRequestValidator"},{"xml":{"name":"item"},"description":"The current page of elements from this collection."}]}},"description":"<p>A collection of <a>RequestValidator</a> resources of a given <a>RestApi</a>.</p> <div class=\"remarks\"> <p>In OpenAPI, the <a>RequestValidators</a> of an API is defined by the <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-swagger-extensions.html#api-gateway-swagger-extensions-request-validators.html\">x-amazon-apigateway-request-validators</a> extension.</p> </div> <div class=\"seeAlso\"><a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-method-request-validation.html\">Enable Basic Request Validation in API Gateway</a></div>"},"Resources":{"type":"object","properties":{"position":{"$ref":"#/components/schemas/String"},"items":{"allOf":[{"$ref":"#/components/schemas/ListOfResource"},{"xml":{"name":"item"},"description":"The current page of elements from this collection."}]}},"description":"<p>Represents a collection of <a>Resource</a> resources.</p> <div class=\"seeAlso\"> <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-create-api.html\">Create an API</a> </div>"},"RestApis":{"type":"object","properties":{"position":{"$ref":"#/components/schemas/String"},"items":{"allOf":[{"$ref":"#/components/schemas/ListOfRestApi"},{"xml":{"name":"item"},"description":"The current page of elements from this collection."}]}},"description":"<p>Contains references to your APIs and links that guide you in how to interact with your collection. A collection offers a paginated view of your APIs.</p> <div class=\"seeAlso\"> <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-create-api.html\">Create an API</a> </div>"},"SdkResponse":{"type":"object","properties":{"body":{"allOf":[{"$ref":"#/components/schemas/Blob"},{"description":"The binary blob response to <a>GetSdk</a>, which contains the generated SDK."}]}},"description":"The binary blob response to <a>GetSdk</a>, which contains the generated SDK."},"SdkType":{"type":"object","properties":{"id":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":"The identifier of an <a>SdkType</a> instance."}]},"friendlyName":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":"The user-friendly name of an <a>SdkType</a> instance."}]},"description":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":"The description of an <a>SdkType</a>."}]},"configurationProperties":{"allOf":[{"$ref":"#/components/schemas/ListOfSdkConfigurationProperty"},{"description":"A list of configuration properties of an <a>SdkType</a>."}]}},"description":"A type of SDK that API Gateway can generate."},"SdkTypes":{"type":"object","properties":{"position":{"$ref":"#/components/schemas/String"},"items":{"allOf":[{"$ref":"#/components/schemas/ListOfSdkType"},{"xml":{"name":"item"},"description":"The current page of elements from this collection."}]}},"description":"The collection of <a>SdkType</a> instances."},"Stages":{"type":"object","properties":{"item":{"allOf":[{"$ref":"#/components/schemas/ListOfStage"},{"description":"The current page of elements from this collection."}]}},"description":"<p>A list of <a>Stage</a> resources that are associated with the <a>ApiKey</a> resource.</p> <div class=\"seeAlso\"><a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/stages.html\">Deploying API in Stages</a></div>"},"Tags":{"type":"object","properties":{"tags":{"allOf":[{"$ref":"#/components/schemas/MapOfStringToString"},{"description":"The collection of tags. Each tag element is associated with a given resource."}]}},"description":"The collection of tags. Each tag element is associated with a given resource."},"Usage":{"type":"object","properties":{"usagePlanId":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":"The plan Id associated with this usage data."}]},"startDate":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":"The starting date of the usage data."}]},"endDate":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":"The ending date of the usage data."}]},"position":{"$ref":"#/components/schemas/String"},"items":{"allOf":[{"$ref":"#/components/schemas/MapOfKeyUsages"},{"xml":{"name":"values"},"description":"The usage data, as daily logs of used and remaining quotas, over the specified time interval indexed over the API keys in a usage plan. For example, <code>{..., \"values\" : { \"{api_key}\" : [ [0, 100], [10, 90], [100, 10]]}</code>, where <code>{api_key}</code> stands for an API key value and the daily log entry is of the format <code>[used quota, remaining quota]</code>."}]}},"description":"<p>Represents the usage data of a usage plan.</p> <div class=\"remarks\"/> <div class=\"seeAlso\"> <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-api-usage-plans.html\">Create and Use Usage Plans</a>, <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-create-usage-plans-with-console.html#api-gateway-usage-plan-manage-usage\">Manage Usage in a Usage Plan</a> </div>"},"UsagePlanKeys":{"type":"object","properties":{"position":{"$ref":"#/components/schemas/String"},"items":{"allOf":[{"$ref":"#/components/schemas/ListOfUsagePlanKey"},{"xml":{"name":"item"},"description":"The current page of elements from this collection."}]}},"description":"<p>Represents the collection of usage plan keys added to usage plans for the associated API keys and, possibly, other types of keys.</p> <div class=\"seeAlso\"> <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-api-usage-plans.html\">Create and Use Usage Plans</a> </div>"},"UsagePlans":{"type":"object","properties":{"position":{"$ref":"#/components/schemas/String"},"items":{"allOf":[{"$ref":"#/components/schemas/ListOfUsagePlan"},{"xml":{"name":"item"},"description":"The current page of elements from this collection."}]}},"description":"<p>Represents a collection of usage plans for an AWS account.</p> <div class=\"seeAlso\"> <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-api-usage-plans.html\">Create and Use Usage Plans</a> </div>"},"VpcLinks":{"type":"object","properties":{"position":{"$ref":"#/components/schemas/String"},"items":{"allOf":[{"$ref":"#/components/schemas/ListOfVpcLink"},{"xml":{"name":"item"},"description":"The current page of elements from this collection."}]}},"description":"<p>The collection of VPC links under the caller's account in a region.</p> <div class=\"seeAlso\"> <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/getting-started-with-private-integration.html\">Getting Started with Private Integrations</a>, <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/set-up-private-integration.html\">Set up Private Integrations</a> </div>"},"ApiKeyIds":{"type":"object","properties":{"ids":{"allOf":[{"$ref":"#/components/schemas/ListOfString"},{"description":"A list of all the <a>ApiKey</a> identifiers."}]},"warnings":{"allOf":[{"$ref":"#/components/schemas/ListOfString"},{"description":"A list of warning messages."}]}},"description":"The identifier of an <a>ApiKey</a> used in a <a>UsagePlan</a>."},"DocumentationPartIds":{"type":"object","properties":{"ids":{"allOf":[{"$ref":"#/components/schemas/ListOfString"},{"description":"A list of the returned documentation part identifiers."}]},"warnings":{"allOf":[{"$ref":"#/components/schemas/ListOfString"},{"description":"A list of warning messages reported during import of documentation parts."}]}},"description":"<p>A collection of the imported <a>DocumentationPart</a> identifiers.</p> <div class=\"remarks\">This is used to return the result when documentation parts in an external (e.g., OpenAPI) file are imported into API Gateway</div> <div class=\"seeAlso\"> <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-documenting-api.html\">Documenting an API</a>, <a href=\"https://docs.aws.amazon.com/apigateway/api-reference/link-relation/documentationpart-import/\">documentationpart:import</a>, <a>DocumentationPart</a> </div>"},"NullableBoolean":{"type":"boolean"},"TestInvokeAuthorizerResponse":{"type":"object","properties":{"clientStatus":{"allOf":[{"$ref":"#/components/schemas/Integer"},{"description":"The HTTP status code that the client would have received. Value is 0 if the authorizer succeeded."}]},"log":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":"The API Gateway execution log for the test authorizer request."}]},"latency":{"allOf":[{"$ref":"#/components/schemas/Long"},{"description":"The execution latency of the test authorizer request."}]},"principalId":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":"The principal identity returned by the <a>Authorizer</a>"}]},"policy":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":"The JSON policy document returned by the <a>Authorizer</a>"}]},"authorization":{"$ref":"#/components/schemas/MapOfStringToList"},"claims":{"allOf":[{"$ref":"#/components/schemas/MapOfStringToString"},{"description":"The <a href=\"https://openid.net/specs/openid-connect-core-1_0.html#StandardClaims\">open identity claims</a>, with any supported custom attributes, returned from the Cognito Your User Pool configured for the API."}]}},"description":"Represents the response of the test invoke request for a custom <a>Authorizer</a>"},"TestInvokeMethodResponse":{"type":"object","properties":{"status":{"allOf":[{"$ref":"#/components/schemas/Integer"},{"description":"The HTTP status code."}]},"body":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":"The body of the HTTP response."}]},"headers":{"allOf":[{"$ref":"#/components/schemas/MapOfStringToString"},{"description":"The headers of the HTTP response."}]},"multiValueHeaders":{"allOf":[{"$ref":"#/components/schemas/MapOfStringToList"},{"description":"The headers of the HTTP response as a map from string to list of values."}]},"log":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":"The API Gateway execution log for the test invoke request."}]},"latency":{"allOf":[{"$ref":"#/components/schemas/Long"},{"description":"The execution latency of the test invoke request."}]}},"description":"<p>Represents the response of the test invoke request in the HTTP method.</p> <div class=\"seeAlso\"> <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-test-method.html#how-to-test-method-console\">Test API using the API Gateway console</a> </div>"},"PatchOperation":{"type":"object","properties":{"op":{"allOf":[{"$ref":"#/components/schemas/Op"},{"description":" An update operation to be performed with this PATCH request. The valid value can be <code>add</code>, <code>remove</code>, <code>replace</code> or <code>copy</code>. Not all valid operations are supported for a given resource. Support of the operations depends on specific operational contexts. Attempts to apply an unsupported operation on a resource will return an error message."}]},"path":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":"The <code>op</code> operation's target, as identified by a <a href=\"https://tools.ietf.org/html/draft-ietf-appsawg-json-pointer-08\">JSON Pointer</a> value that references a location within the targeted resource. For example, if the target resource has an updateable property of <code>{\"name\":\"value\"}</code>, the path for this property is <code>/name</code>. If the <code>name</code> property value is a JSON object (e.g., <code>{\"name\": {\"child/name\": \"child-value\"}}</code>), the path for the <code>child/name</code> property will be <code>/name/child~1name</code>. Any slash (\"/\") character appearing in path names must be escaped with \"~1\", as shown in the example above. Each <code>op</code> operation can have only one <code>path</code> associated with it."}]},"value":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":"The new target value of the update operation. It is applicable for the <code>add</code> or <code>replace</code> operation. When using AWS CLI to update a property of a JSON value, enclose the JSON object with a pair of single quotes in a Linux shell, e.g., '{\"a\": ...}'. In a Windows shell, see <a href=\"https://docs.aws.amazon.com/cli/latest/userguide/cli-using-param.html#cli-using-param-json\">Using JSON for Parameters</a>."}]},"from":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":"The <code>copy</code> update operation's source as identified by a <code>JSON-Pointer</code> value referencing the location within the targeted resource to copy the value from. For example, to promote a canary deployment, you copy the canary deployment ID to the affiliated deployment ID by calling a PATCH request on a <a>Stage</a> resource with <code>\"op\":\"copy\"</code>, <code>\"from\":\"/canarySettings/deploymentId\"</code> and <code>\"path\":\"/deploymentId\"</code>."}]}},"description":"A single patch operation to apply to the specified resource. Please refer to http://tools.ietf.org/html/rfc6902#section-4 for an explanation of how each operation is used."},"AccessLogSettings":{"type":"object","properties":{"format":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":"A single line format of the access logs of data, as specified by selected <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-mapping-template-reference.html#context-variable-reference\">$context variables</a>. The format must include at least <code>$context.requestId</code>."}]},"destinationArn":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":"The Amazon Resource Name (ARN) of the CloudWatch Logs log group or Kinesis Data Firehose delivery stream to receive access logs. If you specify a Kinesis Data Firehose delivery stream, the stream name must begin with <code>amazon-apigateway-</code>."}]}},"description":"Access log settings, including the access log format and access log destination ARN."},"ThrottleSettings":{"type":"object","properties":{"burstLimit":{"allOf":[{"$ref":"#/components/schemas/Integer"},{"description":"The API request burst limit, the maximum rate limit over a time ranging from one to a few seconds, depending upon whether the underlying token bucket is at its full capacity."}]},"rateLimit":{"allOf":[{"$ref":"#/components/schemas/Double"},{"description":"The API request steady-state rate limit."}]}},"description":" The API request rate limits."},"Timestamp":{"type":"string","format":"date-time"},"ApiKeySourceType":{"type":"string","enum":["HEADER","AUTHORIZER"]},"ListOfApiKey":{"type":"array","items":{"$ref":"#/components/schemas/ApiKey"}},"ApiKeysFormat":{"type":"string","enum":["csv"]},"MapOfApiStageThrottleSettings":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/ThrottleSettings"}},"AuthorizerType":{"type":"string","enum":["TOKEN","REQUEST","COGNITO_USER_POOLS"],"description":"The authorizer type. Valid values are <code>TOKEN</code> for a Lambda function using a single authorization token submitted in a custom header, <code>REQUEST</code> for a Lambda function using incoming request parameters, and <code>COGNITO_USER_POOLS</code> for using an Amazon Cognito user pool."},"ListOfARNs":{"type":"array","items":{"$ref":"#/components/schemas/ProviderARN"}},"NullableInteger":{"type":"integer"},"ListOfAuthorizer":{"type":"array","items":{"$ref":"#/components/schemas/Authorizer"}},"ListOfBasePathMapping":{"type":"array","items":{"$ref":"#/components/schemas/BasePathMapping"}},"Blob":{"type":"string"},"CacheClusterSize":{"type":"string","enum":["0.5","1.6","6.1","13.5","28.4","58.2","118","237"],"description":"Returns the size of the <b>CacheCluster</b>."},"CacheClusterStatus":{"type":"string","enum":["CREATE_IN_PROGRESS","AVAILABLE","DELETE_IN_PROGRESS","NOT_AVAILABLE","FLUSH_IN_PROGRESS"],"description":"Returns the status of the <b>CacheCluster</b>."},"CanarySettings":{"type":"object","properties":{"percentTraffic":{"allOf":[{"$ref":"#/components/schemas/Double"},{"description":"The percent (0-100) of traffic diverted to a canary deployment."}]},"deploymentId":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":"The ID of the canary deployment."}]},"stageVariableOverrides":{"allOf":[{"$ref":"#/components/schemas/MapOfStringToString"},{"description":"Stage variables overridden for a canary release deployment, including new stage variables introduced in the canary. These stage variables are represented as a string-to-string map between stage variable names and their values."}]},"useStageCache":{"allOf":[{"$ref":"#/components/schemas/Boolean"},{"description":"A Boolean flag to indicate whether the canary deployment uses the stage cache or not."}]}},"description":"Configuration settings of a canary deployment."},"ListOfClientCertificate":{"type":"array","items":{"$ref":"#/components/schemas/ClientCertificate"}},"ConnectionType":{"type":"string","enum":["INTERNET","VPC_LINK"]},"ContentHandlingStrategy":{"type":"string","enum":["CONVERT_TO_BINARY","CONVERT_TO_TEXT"]},"ListOfStageKeys":{"type":"array","items":{"$ref":"#/components/schemas/StageKey"}},"CreateApiKeyRequest":{"type":"object","title":"CreateApiKeyRequest","properties":{"name":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":"The name of the <a>ApiKey</a>."}]},"description":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":"The description of the <a>ApiKey</a>."}]},"enabled":{"allOf":[{"$ref":"#/components/schemas/Boolean"},{"description":"Specifies whether the <a>ApiKey</a> can be used by callers."}]},"generateDistinctId":{"allOf":[{"$ref":"#/components/schemas/Boolean"},{"description":"Specifies whether (<code>true</code>) or not (<code>false</code>) the key identifier is distinct from the created API key value. This parameter is deprecated and should not be used."}]},"value":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":"Specifies a value of the API key."}]},"stageKeys":{"allOf":[{"$ref":"#/components/schemas/ListOfStageKeys"},{"description":"DEPRECATED FOR USAGE PLANS - Specifies stages associated with the API key."}]},"customerId":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":"An AWS Marketplace customer identifier , when integrating with the AWS SaaS Marketplace."}]},"tags":{"allOf":[{"$ref":"#/components/schemas/MapOfStringToString"},{"description":"The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with <code>aws:</code>. The tag value can be up to 256 characters."}]}},"description":"Request to create an <a>ApiKey</a> resource."},"CreateAuthorizerRequest":{"type":"object","required":["name","type"],"title":"CreateAuthorizerRequest","properties":{"name":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":"[Required] The name of the authorizer."}]},"type":{"allOf":[{"$ref":"#/components/schemas/AuthorizerType"},{"description":"[Required] The authorizer type. Valid values are <code>TOKEN</code> for a Lambda function using a single authorization token submitted in a custom header, <code>REQUEST</code> for a Lambda function using incoming request parameters, and <code>COGNITO_USER_POOLS</code> for using an Amazon Cognito user pool."}]},"providerARNs":{"allOf":[{"$ref":"#/components/schemas/ListOfARNs"},{"description":"A list of the Amazon Cognito user pool ARNs for the <code>COGNITO_USER_POOLS</code> authorizer. Each element is of this format: <code>arn:aws:cognito-idp:{region}:{account_id}:userpool/{user_pool_id}</code>. For a <code>TOKEN</code> or <code>REQUEST</code> authorizer, this is not defined."}]},"authType":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":"Optional customer-defined field, used in OpenAPI imports and exports without functional impact."}]},"authorizerUri":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":"Specifies the authorizer's Uniform Resource Identifier (URI). For <code>TOKEN</code> or <code>REQUEST</code> authorizers, this must be a well-formed Lambda function URI, for example, <code>arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations</code>. In general, the URI has this form <code>arn:aws:apigateway:{region}:lambda:path/{service_api}</code>, where <code>{region}</code> is the same as the region hosting the Lambda function, <code>path</code> indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial <code>/</code>. For Lambda functions, this is usually of the form <code>/2015-03-31/functions/[FunctionARN]/invocations</code>."}]},"authorizerCredentials":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":"Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, specify null."}]},"identitySource":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":"The identity source for which authorization is requested. <ul><li>For a <code>TOKEN</code> or <code>COGNITO_USER_POOLS</code> authorizer, this is required and specifies the request header mapping expression for the custom header holding the authorization token submitted by the client. For example, if the token header name is <code>Auth</code>, the header mapping expression is <code>method.request.header.Auth</code>.</li><li>For the <code>REQUEST</code> authorizer, this is required when authorization caching is enabled. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an <code>Auth</code> header, a <code>Name</code> query string parameter are defined as identity sources, this value is <code>method.request.header.Auth, method.request.querystring.Name</code>. These parameters will be used to derive the authorization caching key and to perform runtime validation of the <code>REQUEST</code> authorizer by verifying all of the identity-related request parameters are present, not null and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function, otherwise, it returns a 401 Unauthorized response without calling the Lambda function. The valid value is a string of comma-separated mapping expressions of the specified request parameters. When the authorization caching is not enabled, this property is optional.</li></ul>"}]},"identityValidationExpression":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":"A validation expression for the incoming identity token. For <code>TOKEN</code> authorizers, this value is a regular expression. For <code>COGNITO_USER_POOLS</code> authorizers, API Gateway will match the <code>aud</code> field of the incoming token from the client against the specified regular expression. It will invoke the authorizer's Lambda function when there is a match. Otherwise, it will return a 401 Unauthorized response without calling the Lambda function. The validation expression does not apply to the <code>REQUEST</code> authorizer."}]},"authorizerResultTtlInSeconds":{"allOf":[{"$ref":"#/components/schemas/NullableInteger"},{"description":"The TTL in seconds of cached authorizer results. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway will cache authorizer responses. If this field is not set, the default value is 300. The maximum value is 3600, or 1 hour."}]}},"description":"Request to add a new <a>Authorizer</a> to an existing <a>RestApi</a> resource."},"CreateBasePathMappingRequest":{"type":"object","required":["restApiId"],"title":"CreateBasePathMappingRequest","properties":{"basePath":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":"The base path name that callers of the API must provide as part of the URL after the domain name. This value must be unique for all of the mappings across a single API. Specify '(none)' if you do not want callers to specify a base path name after the domain name."}]},"restApiId":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":"[Required] The string identifier of the associated <a>RestApi</a>."}]},"stage":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":"The name of the API's stage that you want to use for this mapping. Specify '(none)' if you want callers to explicitly specify the stage name after any base path name."}]}},"description":"Requests API Gateway to create a new <a>BasePathMapping</a> resource."},"DeploymentCanarySettings":{"type":"object","properties":{"percentTraffic":{"allOf":[{"$ref":"#/components/schemas/Double"},{"description":"The percentage (0.0-100.0) of traffic routed to the canary deployment."}]},"stageVariableOverrides":{"allOf":[{"$ref":"#/components/schemas/MapOfStringToString"},{"description":"A stage variable overrides used for the canary release deployment. They can override existing stage variables or add new stage variables for the canary release deployment. These stage variables are represented as a string-to-string map between stage variable names and their values."}]},"useStageCache":{"allOf":[{"$ref":"#/components/schemas/Boolean"},{"description":"A Boolean flag to indicate whether the canary release deployment uses the stage cache or not."}]}},"description":"The input configuration for a canary deployment."},"CreateDeploymentRequest":{"type":"object","title":"CreateDeploymentRequest","properties":{"stageName":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":"The name of the <a>Stage</a> resource for the <a>Deployment</a> resource to create."}]},"stageDescription":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":"The description of the <a>Stage</a> resource for the <a>Deployment</a> resource to create."}]},"description":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":"The description for the <a>Deployment</a> resource to create."}]},"cacheClusterEnabled":{"allOf":[{"$ref":"#/components/schemas/NullableBoolean"},{"description":"Enables a cache cluster for the <a>Stage</a> resource specified in the input."}]},"cacheClusterSize":{"allOf":[{"$ref":"#/components/schemas/CacheClusterSize"},{"description":"Specifies the cache cluster size for the <a>Stage</a> resource specified in the input, if a cache cluster is enabled."}]},"variables":{"allOf":[{"$ref":"#/components/schemas/MapOfStringToString"},{"description":"A map that defines the stage variables for the <a>Stage</a> resource that is associated with the new deployment. Variable names can have alphanumeric and underscore characters, and the values must match <code>[A-Za-z0-9-._~:/?#&=,]+</code>."}]},"canarySettings":{"allOf":[{"$ref":"#/components/schemas/DeploymentCanarySettings"},{"description":"The input configuration for the canary deployment when the deployment is a canary release deployment. "}]},"tracingEnabled":{"allOf":[{"$ref":"#/components/schemas/NullableBoolean"},{"description":"Specifies whether active tracing with X-ray is enabled for the <a>Stage</a>."}]}},"description":"Requests API Gateway to create a <a>Deployment</a> resource."},"DocumentationPartLocation":{"type":"object","required":["type"],"properties":{"type":{"allOf":[{"$ref":"#/components/schemas/DocumentationPartType"},{"description":"[Required] The type of API entity to which the documentation content applies. Valid values are <code>API</code>, <code>AUTHORIZER</code>, <code>MODEL</code>, <code>RESOURCE</code>, <code>METHOD</code>, <code>PATH_PARAMETER</code>, <code>QUERY_PARAMETER</code>, <code>REQUEST_HEADER</code>, <code>REQUEST_BODY</code>, <code>RESPONSE</code>, <code>RESPONSE_HEADER</code>, and <code>RESPONSE_BODY</code>. Content inheritance does not apply to any entity of the <code>API</code>, <code>AUTHORIZER</code>, <code>METHOD</code>, <code>MODEL</code>, <code>REQUEST_BODY</code>, or <code>RESOURCE</code> type."}]},"path":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":"The URL path of the target. It is a valid field for the API entity types of <code>RESOURCE</code>, <code>METHOD</code>, <code>PATH_PARAMETER</code>, <code>QUERY_PARAMETER</code>, <code>REQUEST_HEADER</code>, <code>REQUEST_BODY</code>, <code>RESPONSE</code>, <code>RESPONSE_HEADER</code>, and <code>RESPONSE_BODY</code>. The default value is <code>/</code> for the root resource. When an applicable child entity inherits the content of another entity of the same type with more general specifications of the other <code>location</code> attributes, the child entity's <code>path</code> attribute must match that of the parent entity as a prefix."}]},"method":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":"The HTTP verb of a method. It is a valid field for the API entity types of <code>METHOD</code>, <code>PATH_PARAMETER</code>, <code>QUERY_PARAMETER</code>, <code>REQUEST_HEADER</code>, <code>REQUEST_BODY</code>, <code>RESPONSE</code>, <code>RESPONSE_HEADER</code>, and <code>RESPONSE_BODY</code>. The default value is <code>*</code> for any method. When an applicable child entity inherits the content of an entity of the same type with more general specifications of the other <code>location</code> attributes, the child entity's <code>method</code> attribute must match that of the parent entity exactly."}]},"statusCode":{"allOf":[{"$ref":"#/components/schemas/DocumentationPartLocationStatusCode"},{"description":"The HTTP status code of a response. It is a valid field for the API entity types of <code>RESPONSE</code>, <code>RESPONSE_HEADER</code>, and <code>RESPONSE_BODY</code>. The default value is <code>*</code> for any status code. When an applicable child entity inherits the content of an entity of the same type with more general specifications of the other <code>location</code> attributes, the child entity's <code>statusCode</code> attribute must match that of the parent entity exactly."}]},"name":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":"The name of the targeted API entity. It is a valid and required field for the API entity types of <code>AUTHORIZER</code>, <code>MODEL</code>, <code>PATH_PARAMETER</code>, <code>QUERY_PARAMETER</code>, <code>REQUEST_HEADER</code>, <code>REQUEST_BODY</code> and <code>RESPONSE_HEADER</code>. It is an invalid field for any other entity type."}]}},"description":"Specifies the target API entity to which the documentation applies."},"CreateDocumentationPartRequest":{"type":"object","required":["location","properties"],"title":"CreateDocumentationPartRequest","properties":{"location":{"allOf":[{"$ref":"#/components/schemas/DocumentationPartLocation"},{"description":"[Required] The location of the targeted API entity of the to-be-created documentation part."}]},"properties":{"description":"[Required] The new documentation content map of the targeted API entity. Enclosed key-value pairs are API-specific, but only OpenAPI-compliant key-value pairs can be exported and, hence, published."}},"description":"Creates a new documentation part of a given API."},"CreateDocumentationVersionRequest":{"type":"object","required":["documentationVersion"],"title":"CreateDocumentationVersionRequest","properties":{"documentationVersion":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":"[Required] The version identifier of the new snapshot."}]},"stageName":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":"The stage name to be associated with the new documentation snapshot."}]},"description":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":"A description about the new documentation snapshot."}]}},"description":"Creates a new documentation version of a given API."},"EndpointConfiguration":{"type":"object","properties":{"types":{"allOf":[{"$ref":"#/components/schemas/ListOfEndpointType"},{"description":"A list of endpoint types of an API (<a>RestApi</a>) or its custom domain name (<a>DomainName</a>). For an edge-optimized API and its custom domain name, the endpoint type is <code>\"EDGE\"</code>. For a regional API and its custom domain name, the endpoint type is <code>REGIONAL</code>. For a private API, the endpoint type is <code>PRIVATE</code>."}]},"vpcEndpointIds":{"allOf":[{"$ref":"#/components/schemas/ListOfString"},{"description":"A list of VpcEndpointIds of an API (<a>RestApi</a>) against which to create Route53 ALIASes. It is only supported for <code>PRIVATE</code> endpoint type."}]}},"description":"The endpoint configuration to indicate the types of endpoints an API (<a>RestApi</a>) or its custom domain name (<a>DomainName</a>) has. "},"SecurityPolicy":{"type":"string","enum":["TLS_1_0","TLS_1_2"]},"MutualTlsAuthenticationInput":{"type":"object","properties":{"truststoreUri":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":"An Amazon S3 resource ARN that specifies the truststore for mutual TLS authentication, for example, <code>s3://bucket-name/key-name</code>. The truststore can contain certificates from public or private certificate authorities. To update the truststore, upload a new version to S3, and then update your custom domain name to use the new version. To update the truststore, you must have permissions to access the S3 object."}]},"truststoreVersion":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":"The version of the S3 object that contains your truststore. To specify a version, you must have versioning enabled for the S3 bucket."}]}},"description":"If specified, API Gateway performs two-way authentication between the client and the server. Clients must present a trusted certificate to access your custom domain name."},"CreateDomainNameRequest":{"type":"object","required":["domainName"],"title":"CreateDomainNameRequest","properties":{"domainName":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":"[Required] The name of the <a>DomainName</a> resource."}]},"certificateName":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":"The user-friendly name of the certificate that will be used by edge-optimized endpoint for this domain name."}]},"certificateBody":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":"[Deprecated] The body of the server certificate that will be used by edge-optimized endpoint for this domain name provided by your certificate authority."}]},"certificatePrivateKey":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":"[Deprecated] Your edge-optimized endpoint's domain name certificate's private key."}]},"certificateChain":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":"[Deprecated] The intermediate certificates and optionally the root certificate, one after the other without any blank lines, used by an edge-optimized endpoint for this domain name. If you include the root certificate, your certificate chain must start with intermediate certificates and end with the root certificate. Use the intermediate certificates that were provided by your certificate authority. Do not include any intermediaries that are not in the chain of trust path."}]},"certificateArn":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":"The reference to an AWS-managed certificate that will be used by edge-optimized endpoint for this domain name. AWS Certificate Manager is the only supported source."}]},"regionalCertificateName":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":"The user-friendly name of the certificate that will be used by regional endpoint for this domain name."}]},"regionalCertificateArn":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":"The reference to an AWS-managed certificate that will be used by regional endpoint for this domain name. AWS Certificate Manager is the only supported source."}]},"endpointConfiguration":{"allOf":[{"$ref":"#/components/schemas/EndpointConfiguration"},{"description":"The endpoint configuration of this <a>DomainName</a> showing the endpoint types of the domain name."}]},"tags":{"allOf":[{"$ref":"#/components/schemas/MapOfStringToString"},{"description":"The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with <code>aws:</code>. The tag value can be up to 256 characters."}]},"securityPolicy":{"allOf":[{"$ref":"#/components/schemas/SecurityPolicy"},{"description":"The Transport Layer Security (TLS) version + cipher suite for this <a>DomainName</a>. The valid values are <code>TLS_1_0</code> and <code>TLS_1_2</code>."}]},"mutualTlsAuthentication":{"$ref":"#/components/schemas/MutualTlsAuthenticationInput"},"ownershipVerificationCertificateArn":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":"The ARN of the public certificate issued by ACM to validate ownership of your custom domain. Only required when configuring mutual TLS and using an ACM imported or private CA certificate ARN as the regionalCertificateArn."}]}},"description":"A request to create a new domain name."},"CreateModelRequest":{"type":"object","required":["name","contentType"],"title":"CreateModelRequest","properties":{"name":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":"[Required] The name of the model. Must be alphanumeric."}]},"description":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":"The description of the model."}]},"schema":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":"The schema for the model. For <code>application/json</code> models, this should be <a href=\"https://tools.ietf.org/html/draft-zyp-json-schema-04\" target=\"_blank\">JSON schema draft 4</a> model."}]},"contentType":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":"[Required] The content-type for the model."}]}},"description":"Request to add a new <a>Model</a> to an existing <a>RestApi</a> resource."},"CreateRequestValidatorRequest":{"type":"object","title":"CreateRequestValidatorRequest","properties":{"name":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":"The name of the to-be-created <a>RequestValidator</a>."}]},"validateRequestBody":{"allOf":[{"$ref":"#/components/schemas/Boolean"},{"description":"A Boolean flag to indicate whether to validate request body according to the configured model schema for the method (<code>true</code>) or not (<code>false</code>)."}]},"validateRequestParameters":{"allOf":[{"$ref":"#/components/schemas/Boolean"},{"description":"A Boolean flag to indicate whether to validate request parameters, <code>true</code>, or not <code>false</code>."}]}},"description":"Creates a <a>RequestValidator</a> of a given <a>RestApi</a>."},"CreateResourceRequest":{"type":"object","required":["pathPart"],"title":"CreateResourceRequest","properties":{"pathPart":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":"The last path segment for this resource."}]}},"description":"Requests API Gateway to create a <a>Resource</a> resource."},"CreateRestApiRequest":{"type":"object","required":["name"],"title":"CreateRestApiRequest","properties":{"name":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":"[Required] The name of the <a>RestApi</a>."}]},"description":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":"The description of the <a>RestApi</a>."}]},"version":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":"A version identifier for the API."}]},"cloneFrom":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":"The ID of the <a>RestApi</a> that you want to clone from."}]},"binaryMediaTypes":{"allOf":[{"$ref":"#/components/schemas/ListOfString"},{"description":"The list of binary media types supported by the <a>RestApi</a>. By default, the <a>RestApi</a> supports only UTF-8-encoded text payloads."}]},"minimumCompressionSize":{"allOf":[{"$ref":"#/components/schemas/NullableInteger"},{"description":"A nullable integer that is used to enable compression (with non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable compression (with a null value) on an API. When compression is enabled, compression or decompression is not applied on the payload if the payload size is smaller than this value. Setting it to zero allows compression for any payload size."}]},"apiKeySource":{"allOf":[{"$ref":"#/components/schemas/ApiKeySourceType"},{"description":"The source of the API key for metering requests according to a usage plan. Valid values are: <ul><li><code>HEADER</code> to read the API key from the <code>X-API-Key</code> header of a request. </li><li><code>AUTHORIZER</code> to read the API key from the <code>UsageIdentifierKey</code> from a custom authorizer.</li></ul>"}]},"endpointConfiguration":{"allOf":[{"$ref":"#/components/schemas/EndpointConfiguration"},{"description":"The endpoint configuration of this <a>RestApi</a> showing the endpoint types of the API."}]},"policy":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":"A stringified JSON policy document that applies to this RestApi regardless of the caller and <a>Method</a> configuration."}]},"tags":{"allOf":[{"$ref":"#/components/schemas/MapOfStringToString"},{"description":"The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with <code>aws:</code>. The tag value can be up to 256 characters."}]},"disableExecuteApiEndpoint":{"allOf":[{"$ref":"#/components/schemas/Boolean"},{"description":"Specifies whether clients can invoke your API by using the default <code>execute-api</code> endpoint. By default, clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint."}]}},"description":"The POST Request to add a new <a>RestApi</a> resource to your collection."},"CreateStageRequest":{"type":"object","required":["stageName","deploymentId"],"title":"CreateStageRequest","properties":{"stageName":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":"[Required] The name for the <a>Stage</a> resource. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters."}]},"deploymentId":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":"[Required] The identifier of the <a>Deployment</a> resource for the <a>Stage</a> resource."}]},"description":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":"The description of the <a>Stage</a> resource."}]},"cacheClusterEnabled":{"allOf":[{"$ref":"#/components/schemas/Boolean"},{"description":"Whether cache clustering is enabled for the stage."}]},"cacheClusterSize":{"allOf":[{"$ref":"#/components/schemas/CacheClusterSize"},{"description":"The stage's cache cluster size."}]},"variables":{"allOf":[{"$ref":"#/components/schemas/MapOfStringToString"},{"description":"A map that defines the stage variables for the new <a>Stage</a> resource. Variable names can have alphanumeric and underscore characters, and the values must match <code>[A-Za-z0-9-._~:/?#&=,]+</code>."}]},"documentationVersion":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":"The version of the associated API documentation."}]},"canarySettings":{"allOf":[{"$ref":"#/components/schemas/CanarySettings"},{"description":"The canary deployment settings of this stage."}]},"tracingEnabled":{"allOf":[{"$ref":"#/components/schemas/Boolean"},{"description":"Specifies whether active tracing with X-ray is enabled for the <a>Stage</a>."}]},"tags":{"allOf":[{"$ref":"#/components/schemas/MapOfStringToString"},{"description":"The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with <code>aws:</code>. The tag value can be up to 256 characters."}]}},"description":"Requests API Gateway to create a <a>Stage</a> resource."},"CreateUsagePlanKeyRequest":{"type":"object","required":["keyId","keyType"],"title":"CreateUsagePlanKeyRequest","properties":{"keyId":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":"[Required] The identifier of a <a>UsagePlanKey</a> resource for a plan customer."}]},"keyType":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":"[Required] The type of a <a>UsagePlanKey</a> resource for a plan customer."}]}},"description":"The POST request to create a usage plan key for adding an existing API key to a usage plan."},"ListOfApiStage":{"type":"array","items":{"$ref":"#/components/schemas/ApiStage"}},"QuotaSettings":{"type":"object","properties":{"limit":{"allOf":[{"$ref":"#/components/schemas/Integer"},{"description":"The maximum number of requests that can be made in a given time period."}]},"offset":{"allOf":[{"$ref":"#/components/schemas/Integer"},{"description":"The day that a time period starts. For example, with a time period of <code>WEEK</code>, an offset of <code>0</code> starts on Sunday, and an offset of <code>1</code> starts on Monday."}]},"period":{"allOf":[{"$ref":"#/components/schemas/QuotaPeriodType"},{"description":"The time period in which the limit applies. Valid values are \"DAY\", \"WEEK\" or \"MONTH\"."}]}},"description":"Quotas configured for a usage plan."},"CreateUsagePlanRequest":{"type":"object","required":["name"],"title":"CreateUsagePlanRequest","properties":{"name":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":"[Required] The name of the usage plan."}]},"description":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":"The description of the usage plan."}]},"apiStages":{"allOf":[{"$ref":"#/components/schemas/ListOfApiStage"},{"description":"The associated API stages of the usage plan."}]},"throttle":{"allOf":[{"$ref":"#/components/schemas/ThrottleSettings"},{"description":"The throttling limits of the usage plan."}]},"quota":{"allOf":[{"$ref":"#/components/schemas/QuotaSettings"},{"description":"The quota of the usage plan."}]},"tags":{"allOf":[{"$ref":"#/components/schemas/MapOfStringToString"},{"description":"The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with <code>aws:</code>. The tag value can be up to 256 characters."}]}},"description":"The POST request to create a usage plan with the name, description, throttle limits and quota limits, as well as the associated API stages, specified in the payload."},"CreateVpcLinkRequest":{"type":"object","required":["name","targetArns"],"title":"CreateVpcLinkRequest","properties":{"name":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":"[Required] The name used to label and identify the VPC link."}]},"description":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":"The description of the VPC link."}]},"targetArns":{"allOf":[{"$ref":"#/components/schemas/ListOfString"},{"description":"[Required] The ARN of the network load balancer of the VPC targeted by the VPC link. The network load balancer must be owned by the same AWS account of the API owner."}]},"tags":{"allOf":[{"$ref":"#/components/schemas/MapOfStringToString"},{"description":"The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with <code>aws:</code>. The tag value can be up to 256 characters."}]}},"description":"Creates a VPC link, under the caller's account in a selected region, in an asynchronous operation that typically takes 2-4 minutes to complete and become operational. The caller must have permissions to create and update VPC Endpoint services."},"DeleteApiKeyRequest":{"type":"object","title":"DeleteApiKeyRequest","properties":{},"description":"A request to delete the <a>ApiKey</a> resource."},"DeleteAuthorizerRequest":{"type":"object","title":"DeleteAuthorizerRequest","properties":{},"description":"Request to delete an existing <a>Authorizer</a> resource."},"DeleteBasePathMappingRequest":{"type":"object","title":"DeleteBasePathMappingRequest","properties":{},"description":"A request to delete the <a>BasePathMapping</a> resource."},"DeleteClientCertificateRequest":{"type":"object","title":"DeleteClientCertificateRequest","properties":{},"description":"A request to delete the <a>ClientCertificate</a> resource."},"DeleteDeploymentRequest":{"type":"object","title":"DeleteDeploymentRequest","properties":{},"description":"Requests API Gateway to delete a <a>Deployment</a> resource."},"DeleteDocumentationPartRequest":{"type":"object","title":"DeleteDocumentationPartRequest","properties":{},"description":"Deletes an existing documentation part of an API."},"DeleteDocumentationVersionRequest":{"type":"object","title":"DeleteDocumentationVersionRequest","properties":{},"description":"Deletes an existing documentation version of an API."},"DeleteDomainNameRequest":{"type":"object","title":"DeleteDomainNameRequest","properties":{},"description":"A request to delete the <a>DomainName</a> resource."},"GatewayResponseType":{"type":"string","enum":["DEFAULT_4XX","DEFAULT_5XX","RESOURCE_NOT_FOUND","UNAUTHORIZED","INVALID_API_KEY","ACCESS_DENIED","AUTHORIZER_FAILURE","AUTHORIZER_CONFIGURATION_ERROR","INVALID_SIGNATURE","EXPIRED_TOKEN","MISSING_AUTHENTICATION_TOKEN","INTEGRATION_FAILURE","INTEGRATION_TIMEOUT","API_CONFIGURATION_ERROR","UNSUPPORTED_MEDIA_TYPE","BAD_REQUEST_PARAMETERS","BAD_REQUEST_BODY","REQUEST_TOO_LARGE","THROTTLED","QUOTA_EXCEEDED","WAF_FILTERED"]},"DeleteGatewayResponseRequest":{"type":"object","title":"DeleteGatewayResponseRequest","properties":{},"description":"Clears any customization of a <a>GatewayResponse</a> of a specified response type on the given <a>RestApi</a> and resets it with the default settings."},"DeleteIntegrationRequest":{"type":"object","title":"DeleteIntegrationRequest","properties":{},"description":"Represents a delete integration request."},"StatusCode":{"type":"string","pattern":"[1-5]\\d\\d","description":"The status code."},"DeleteIntegrationResponseRequest":{"type":"object","title":"DeleteIntegrationResponseRequest","properties":{},"description":"Represents a delete integration response request."},"DeleteMethodRequest":{"type":"object","title":"DeleteMethodRequest","properties":{},"description":"Request to delete an existing <a>Method</a> resource."},"DeleteMethodResponseRequest":{"type":"object","title":"DeleteMethodResponseRequest","properties":{},"description":"A request to delete an existing <a>MethodResponse</a> resource."},"DeleteModelRequest":{"type":"object","title":"DeleteModelRequest","properties":{},"description":"Request to delete an existing model in an existing <a>RestApi</a> resource."},"DeleteRequestValidatorRequest":{"type":"object","title":"DeleteRequestValidatorRequest","properties":{},"description":"Deletes a specified <a>RequestValidator</a> of a given <a>RestApi</a>."},"DeleteResourceRequest":{"type":"object","title":"DeleteResourceRequest","properties":{},"description":"Request to delete a <a>Resource</a>."},"DeleteRestApiRequest":{"type":"object","title":"DeleteRestApiRequest","properties":{},"description":"Request to delete the specified API from your collection."},"DeleteStageRequest":{"type":"object","title":"DeleteStageRequest","properties":{},"description":"Requests API Gateway to delete a <a>Stage</a> resource."},"DeleteUsagePlanKeyRequest":{"type":"object","title":"DeleteUsagePlanKeyRequest","properties":{},"description":"The DELETE request to delete a usage plan key and remove the underlying API key from the associated usage plan."},"DeleteUsagePlanRequest":{"type":"object","title":"DeleteUsagePlanRequest","properties":{},"description":"The DELETE request to delete a usage plan of a given plan Id."},"DeleteVpcLinkRequest":{"type":"object","title":"DeleteVpcLinkRequest","properties":{},"description":"Deletes an existing <a>VpcLink</a> of a specified identifier."},"PathToMapOfMethodSnapshot":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/MapOfMethodSnapshot"}},"ListOfDeployment":{"type":"array","items":{"$ref":"#/components/schemas/Deployment"}},"ListOfDocumentationPart":{"type":"array","items":{"$ref":"#/components/schemas/DocumentationPart"}},"ListOfDocumentationVersion":{"type":"array","items":{"$ref":"#/components/schemas/DocumentationVersion"}},"DomainNameStatus":{"type":"string","enum":["AVAILABLE","UPDATING","PENDING","PENDING_CERTIFICATE_REIMPORT","PENDING_OWNERSHIP_VERIFICATION"]},"MutualTlsAuthentication":{"type":"object","properties":{"truststoreUri":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":"An Amazon S3 URL that specifies the truststore for mutual TLS authentication, for example <code>s3://bucket-name/key-name</code>. The truststore can contain certificates from public or private certificate authorities. To update the truststore, upload a new version to S3, and then update your custom domain name to use the new version. To update the truststore, you must have permissions to access the S3 object."}]},"truststoreVersion":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":"The version of the S3 object that contains your truststore. To specify a version, you must have versioning enabled for the S3 bucket."}]},"truststoreWarnings":{"allOf":[{"$ref":"#/components/schemas/ListOfString"},{"description":"A list of warnings that API Gateway returns while processing your truststore. Invalid certificates produce warnings. Mutual TLS is still enabled, but some clients might not be able to access your API. To resolve warnings, upload a new truststore to S3, and then update you domain name to use the new version."}]}},"description":"If specified, API Gateway performs two-way authentication between the client and the server. Clients must present a trusted certificate to access your custom domain name."},"ListOfDomainName":{"type":"array","items":{"$ref":"#/components/schemas/DomainName"}},"EndpointType":{"type":"string","enum":["REGIONAL","EDGE","PRIVATE"],"description":"The endpoint type. The valid values are <code>EDGE</code> for edge-optimized API setup, most suitable for mobile applications; <code>REGIONAL</code> for regional API endpoint setup, most suitable for calling from AWS Region; and <code>PRIVATE</code> for private APIs."},"FlushStageAuthorizersCacheRequest":{"type":"object","title":"FlushStageAuthorizersCacheRequest","properties":{},"description":"Request to flush authorizer cache entries on a specified stage."},"FlushStageCacheRequest":{"type":"object","title":"FlushStageCacheRequest","properties":{},"description":"Requests API Gateway to flush a stage's cache."},"ListOfGatewayResponse":{"type":"array","items":{"$ref":"#/components/schemas/GatewayResponse"}},"GenerateClientCertificateRequest":{"type":"object","title":"GenerateClientCertificateRequest","properties":{"description":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":"The description of the <a>ClientCertificate</a>."}]},"tags":{"allOf":[{"$ref":"#/components/schemas/MapOfStringToString"},{"description":"The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with <code>aws:</code>. The tag value can be up to 256 characters."}]}},"description":"A request to generate a <a>ClientCertificate</a> resource."},"GetAccountRequest":{"type":"object","title":"GetAccountRequest","properties":{},"description":"Requests API Gateway to get information about the current <a>Account</a> resource."},"GetApiKeyRequest":{"type":"object","title":"GetApiKeyRequest","properties":{},"description":"A request to get information about the current <a>ApiKey</a> resource."},"GetApiKeysRequest":{"type":"object","title":"GetApiKeysRequest","properties":{},"description":"A request to get information about the current <a>ApiKeys</a> resource."},"GetAuthorizerRequest":{"type":"object","title":"GetAuthorizerRequest","properties":{},"description":"Request to describe an existing <a>Authorizer</a> resource."},"GetAuthorizersRequest":{"type":"object","title":"GetAuthorizersRequest","properties":{},"description":"Request to describe an existing <a>Authorizers</a> resource."},"GetBasePathMappingRequest":{"type":"object","title":"GetBasePathMappingRequest","properties":{},"description":"Request to describe a <a>BasePathMapping</a> resource."},"GetBasePathMappingsRequest":{"type":"object","title":"GetBasePathMappingsRequest","properties":{},"description":"A request to get information about a collection of <a>BasePathMapping</a> resources."},"GetClientCertificateRequest":{"type":"object","title":"GetClientCertificateRequest","properties":{},"description":"A request to get information about the current <a>ClientCertificate</a> resource."},"GetClientCertificatesRequest":{"type":"object","title":"GetClientCertificatesRequest","properties":{},"description":"A request to get information about a collection of <a>ClientCertificate</a> resources."},"GetDeploymentRequest":{"type":"object","title":"GetDeploymentRequest","properties":{},"description":"Requests API Gateway to get information about a <a>Deployment</a> resource."},"GetDeploymentsRequest":{"type":"object","title":"GetDeploymentsRequest","properties":{},"description":"Requests API Gateway to get information about a <a>Deployments</a> collection."},"GetDocumentationPartRequest":{"type":"object","title":"GetDocumentationPartRequest","properties":{},"description":"Gets a specified documentation part of a given API."},"LocationStatusType":{"type":"string","enum":["DOCUMENTED","UNDOCUMENTED"]},"GetDocumentationPartsRequest":{"type":"object","title":"GetDocumentationPartsRequest","properties":{},"description":"Gets the documentation parts of an API. The result may be filtered by the type, name, or path of API entities (targets)."},"GetDocumentationVersionRequest":{"type":"object","title":"GetDocumentationVersionRequest","properties":{},"description":"Gets a documentation snapshot of an API."},"GetDocumentationVersionsRequest":{"type":"object","title":"GetDocumentationVersionsRequest","properties":{},"description":"Gets the documentation versions of an API."},"GetDomainNameRequest":{"type":"object","title":"GetDomainNameRequest","properties":{},"description":"Request to get the name of a <a>DomainName</a> resource."},"GetDomainNamesRequest":{"type":"object","title":"GetDomainNamesRequest","properties":{},"description":"Request to describe a collection of <a>DomainName</a> resources."},"GetExportRequest":{"type":"object","title":"GetExportRequest","properties":{},"description":"Request a new export of a <a>RestApi</a> for a particular <a>Stage</a>."},"GetGatewayResponseRequest":{"type":"object","title":"GetGatewayResponseRequest","properties":{},"description":"Gets a <a>GatewayResponse</a> of a specified response type on the given <a>RestApi</a>."},"GetGatewayResponsesRequest":{"type":"object","title":"GetGatewayResponsesRequest","properties":{},"description":"Gets the <a>GatewayResponses</a> collection on the given <a>RestApi</a>. If an API developer has not added any definitions for gateway responses, the result will be the API Gateway-generated default <a>GatewayResponses</a> collection for the supported response types."},"GetIntegrationRequest":{"type":"object","title":"GetIntegrationRequest","properties":{},"description":"Represents a request to get the integration configuration."},"GetIntegrationResponseRequest":{"type":"object","title":"GetIntegrationResponseRequest","properties":{},"description":"Represents a get integration response request."},"GetMethodRequest":{"type":"object","title":"GetMethodRequest","properties":{},"description":"Request to describe an existing <a>Method</a> resource."},"GetMethodResponseRequest":{"type":"object","title":"GetMethodResponseRequest","properties":{},"description":"Request to describe a <a>MethodResponse</a> resource."},"GetModelRequest":{"type":"object","title":"GetModelRequest","properties":{},"description":"Request to list information about a model in an existing <a>RestApi</a> resource."},"GetModelTemplateRequest":{"type":"object","title":"GetModelTemplateRequest","properties":{},"description":"Request to generate a sample mapping template used to transform the payload."},"GetModelsRequest":{"type":"object","title":"GetModelsRequest","properties":{},"description":"Request to list existing <a>Models</a> defined for a <a>RestApi</a> resource."},"GetRequestValidatorRequest":{"type":"object","title":"GetRequestValidatorRequest","properties":{},"description":"Gets a <a>RequestValidator</a> of a given <a>RestApi</a>."},"GetRequestValidatorsRequest":{"type":"object","title":"GetRequestValidatorsRequest","properties":{},"description":"Gets the <a>RequestValidators</a> collection of a given <a>RestApi</a>."},"GetResourceRequest":{"type":"object","title":"GetResourceRequest","properties":{},"description":"Request to list information about a resource."},"GetResourcesRequest":{"type":"object","title":"GetResourcesRequest","properties":{},"description":"Request to list information about a collection of resources."},"GetRestApiRequest":{"type":"object","title":"GetRestApiRequest","properties":{},"description":"The GET request to list an existing <a>RestApi</a> defined for your collection. "},"GetRestApisRequest":{"type":"object","title":"GetRestApisRequest","properties":{},"description":"The GET request to list existing <a>RestApis</a> defined for your collection."},"GetSdkRequest":{"type":"object","title":"GetSdkRequest","properties":{},"description":"Request a new generated client SDK for a <a>RestApi</a> and <a>Stage</a>."},"GetSdkTypeRequest":{"type":"object","title":"GetSdkTypeRequest","properties":{},"description":"Get an <a>SdkType</a> instance."},"GetSdkTypesRequest":{"type":"object","title":"GetSdkTypesRequest","properties":{},"description":"Get the <a>SdkTypes</a> collection."},"GetStageRequest":{"type":"object","title":"GetStageRequest","properties":{},"description":"Requests API Gateway to get information about a <a>Stage</a> resource."},"GetStagesRequest":{"type":"object","title":"GetStagesRequest","properties":{},"description":"Requests API Gateway to get information about one or more <a>Stage</a> resources."},"GetTagsRequest":{"type":"object","title":"GetTagsRequest","properties":{},"description":"Gets the <a>Tags</a> collection for a given resource."},"GetUsagePlanKeyRequest":{"type":"object","title":"GetUsagePlanKeyRequest","properties":{},"description":"The GET request to get a usage plan key of a given key identifier."},"GetUsagePlanKeysRequest":{"type":"object","title":"GetUsagePlanKeysRequest","properties":{},"description":"The GET request to get all the usage plan keys representing the API keys added to a specified usage plan."},"GetUsagePlanRequest":{"type":"object","title":"GetUsagePlanRequest","properties":{},"description":"The GET request to get a usage plan of a given plan identifier."},"GetUsagePlansRequest":{"type":"object","title":"GetUsagePlansRequest","properties":{},"description":"The GET request to get all the usage plans of the caller's account."},"GetUsageRequest":{"type":"object","title":"GetUsageRequest","properties":{},"description":"The GET request to get the usage data of a usage plan in a specified time interval."},"GetVpcLinkRequest":{"type":"object","title":"GetVpcLinkRequest","properties":{},"description":"Gets a specified VPC link under the caller's account in a region."},"GetVpcLinksRequest":{"type":"object","title":"GetVpcLinksRequest","properties":{},"description":"Gets the <a>VpcLinks</a> collection under the caller's account in a selected region."},"ImportApiKeysRequest":{"type":"object","required":["body"],"title":"ImportApiKeysRequest","properties":{"body":{"allOf":[{"$ref":"#/components/schemas/Blob"},{"description":"The payload of the POST request to import API keys. For the payload format, see <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/api-key-file-format.html\">API Key File Format</a>."}]}},"description":"The POST request to import API keys from an external source, such as a CSV-formatted file."},"PutMode":{"type":"string","enum":["merge","overwrite"]},"ImportDocumentationPartsRequest":{"type":"object","required":["body"],"title":"ImportDocumentationPartsRequest","properties":{"body":{"allOf":[{"$ref":"#/components/schemas/Blob"},{"description":"[Required] Raw byte array representing the to-be-imported documentation parts. To import from an OpenAPI file, this is a JSON object."}]}},"description":"Import documentation parts from an external (e.g., OpenAPI) definition file. "},"ImportRestApiRequest":{"type":"object","required":["body"],"title":"ImportRestApiRequest","properties":{"body":{"allOf":[{"$ref":"#/components/schemas/Blob"},{"description":"[Required] The POST request body containing external API definitions. Currently, only OpenAPI definition JSON/YAML files are supported. The maximum size of the API definition file is 6MB."}]}},"description":"A POST request to import an API to API Gateway using an input of an API definition file."},"IntegrationType":{"type":"string","enum":["HTTP","AWS","MOCK","HTTP_PROXY","AWS_PROXY"],"description":"The integration type. The valid value is <code>HTTP</code> for integrating an API method with an HTTP backend; <code>AWS</code> with any AWS service endpoints; <code>MOCK</code> for testing without actually invoking the backend; <code>HTTP_PROXY</code> for integrating with the HTTP proxy integration; <code>AWS_PROXY</code> for integrating with the Lambda proxy integration. "},"MapOfIntegrationResponse":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/IntegrationResponse"}},"TlsConfig":{"type":"object","properties":{"insecureSkipVerification":{"allOf":[{"$ref":"#/components/schemas/Boolean"},{"description":"Specifies whether or not API Gateway skips verification that the certificate for an integration endpoint is issued by a <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-supported-certificate-authorities-for-http-endpoints.html\">supported certificate authority</a>. This isn’t recommended, but it enables you to use certificates that are signed by private certificate authorities, or certificates that are self-signed. If enabled, API Gateway still performs basic certificate validation, which includes checking the certificate's expiration date, hostname, and presence of a root certificate authority. Supported only for <code>HTTP</code> and <code>HTTP_PROXY</code> integrations."}]}}},"Long":{"type":"integer"},"ListOfLong":{"type":"array","items":{"$ref":"#/components/schemas/Long"}},"ListOfModel":{"type":"array","items":{"$ref":"#/components/schemas/Model"}},"ListOfPatchOperation":{"type":"array","description":"A list of operations describing the updates to apply to the specified resource. The patches are applied in the order specified in the list.","items":{"$ref":"#/components/schemas/PatchOperation"}},"ListOfRequestValidator":{"type":"array","items":{"$ref":"#/components/schemas/RequestValidator"}},"ListOfResource":{"type":"array","items":{"$ref":"#/components/schemas/Resource"}},"ListOfRestApi":{"type":"array","items":{"$ref":"#/components/schemas/RestApi"}},"SdkConfigurationProperty":{"type":"object","properties":{"name":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":"The name of a an <a>SdkType</a> configuration property."}]},"friendlyName":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":"The user-friendly name of an <a>SdkType</a> configuration property."}]},"description":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":"The description of an <a>SdkType</a> configuration property."}]},"required":{"allOf":[{"$ref":"#/components/schemas/Boolean"},{"description":"A boolean flag of an <a>SdkType</a> configuration property to indicate if the associated SDK configuration property is required (<code>true</code>) or not (<code>false</code>)."}]},"defaultValue":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":"The default value of an <a>SdkType</a> configuration property."}]}},"description":"A configuration property of an SDK type."},"ListOfSdkConfigurationProperty":{"type":"array","items":{"$ref":"#/components/schemas/SdkConfigurationProperty"}},"ListOfSdkType":{"type":"array","items":{"$ref":"#/components/schemas/SdkType"}},"ListOfStage":{"type":"array","items":{"$ref":"#/components/schemas/Stage"}},"ListOfUsage":{"type":"array","items":{"$ref":"#/components/schemas/ListOfLong"}},"ListOfUsagePlan":{"type":"array","items":{"$ref":"#/components/schemas/UsagePlan"}},"ListOfUsagePlanKey":{"type":"array","items":{"$ref":"#/components/schemas/UsagePlanKey"}},"ListOfVpcLink":{"type":"array","items":{"$ref":"#/components/schemas/VpcLink"}},"MapOfKeyUsages":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/ListOfUsage"}},"MapOfMethod":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/Method"}},"MapOfMethodResponse":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/MethodResponse"}},"MethodSetting":{"type":"object","properties":{"metricsEnabled":{"allOf":[{"$ref":"#/components/schemas/Boolean"},{"description":"Specifies whether Amazon CloudWatch metrics are enabled for this method. The PATCH path for this setting is <code>/{method_setting_key}/metrics/enabled</code>, and the value is a Boolean."}]},"loggingLevel":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":"Specifies the logging level for this method, which affects the log entries pushed to Amazon CloudWatch Logs. The PATCH path for this setting is <code>/{method_setting_key}/logging/loglevel</code>, and the available levels are <code>OFF</code>, <code>ERROR</code>, and <code>INFO</code>. Choose <code>ERROR</code> to write only error-level entries to CloudWatch Logs, or choose <code>INFO</code> to include all <code>ERROR</code> events as well as extra informational events."}]},"dataTraceEnabled":{"allOf":[{"$ref":"#/components/schemas/Boolean"},{"description":"Specifies whether data trace logging is enabled for this method, which affects the log entries pushed to Amazon CloudWatch Logs. The PATCH path for this setting is <code>/{method_setting_key}/logging/dataTrace</code>, and the value is a Boolean."}]},"throttlingBurstLimit":{"allOf":[{"$ref":"#/components/schemas/Integer"},{"description":"Specifies the throttling burst limit. The PATCH path for this setting is <code>/{method_setting_key}/throttling/burstLimit</code>, and the value is an integer."}]},"throttlingRateLimit":{"allOf":[{"$ref":"#/components/schemas/Double"},{"description":"Specifies the throttling rate limit. The PATCH path for this setting is <code>/{method_setting_key}/throttling/rateLimit</code>, and the value is a double."}]},"cachingEnabled":{"allOf":[{"$ref":"#/components/schemas/Boolean"},{"description":"Specifies whether responses should be cached and returned for requests. A cache cluster must be enabled on the stage for responses to be cached. The PATCH path for this setting is <code>/{method_setting_key}/caching/enabled</code>, and the value is a Boolean."}]},"cacheTtlInSeconds":{"allOf":[{"$ref":"#/components/schemas/Integer"},{"description":"Specifies the time to live (TTL), in seconds, for cached responses. The higher the TTL, the longer the response will be cached. The PATCH path for this setting is <code>/{method_setting_key}/caching/ttlInSeconds</code>, and the value is an integer."}]},"cacheDataEncrypted":{"allOf":[{"$ref":"#/components/schemas/Boolean"},{"description":"Specifies whether the cached responses are encrypted. The PATCH path for this setting is <code>/{method_setting_key}/caching/dataEncrypted</code>, and the value is a Boolean."}]},"requireAuthorizationForCacheControl":{"allOf":[{"$ref":"#/components/schemas/Boolean"},{"description":"Specifies whether authorization is required for a cache invalidation request. The PATCH path for this setting is <code>/{method_setting_key}/caching/requireAuthorizationForCacheControl</code>, and the value is a Boolean."}]},"unauthorizedCacheControlHeaderStrategy":{"allOf":[{"$ref":"#/components/schemas/UnauthorizedCacheControlHeaderStrategy"},{"description":"Specifies how to handle unauthorized requests for cache invalidation. The PATCH path for this setting is <code>/{method_setting_key}/caching/unauthorizedCacheControlHeaderStrategy</code>, and the available values are <code>FAIL_WITH_403</code>, <code>SUCCEED_WITH_RESPONSE_HEADER</code>, <code>SUCCEED_WITHOUT_RESPONSE_HEADER</code>."}]}},"description":"Specifies the method setting properties."},"MapOfMethodSettings":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/MethodSetting"}},"MethodSnapshot":{"type":"object","properties":{"authorizationType":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":"The method's authorization type. Valid values are <code>NONE</code> for open access, <code>AWS_IAM</code> for using AWS IAM permissions, <code>CUSTOM</code> for using a custom authorizer, or <code>COGNITO_USER_POOLS</code> for using a Cognito user pool."}]},"apiKeyRequired":{"allOf":[{"$ref":"#/components/schemas/Boolean"},{"description":"Specifies whether the method requires a valid <a>ApiKey</a>."}]}},"description":"Represents a summary of a <a>Method</a> resource, given a particular date and time."},"MapOfMethodSnapshot":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/MethodSnapshot"}},"MapOfStringToBoolean":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/NullableBoolean"}},"MapOfStringToList":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/ListOfString"}},"UnauthorizedCacheControlHeaderStrategy":{"type":"string","enum":["FAIL_WITH_403","SUCCEED_WITH_RESPONSE_HEADER","SUCCEED_WITHOUT_RESPONSE_HEADER"]},"Op":{"type":"string","enum":["add","remove","replace","move","copy","test"]},"PutGatewayResponseRequest":{"type":"object","title":"PutGatewayResponseRequest","properties":{"statusCode":{"allOf":[{"$ref":"#/components/schemas/StatusCode"},{"description":"The HTTP status code of the <a>GatewayResponse</a>."}]},"responseParameters":{"allOf":[{"$ref":"#/components/schemas/MapOfStringToString"},{"description":"<p><p>Response parameters (paths, query strings and headers) of the <a>GatewayResponse</a> as a string-to-string map of key-value pairs.</p></p>"}]},"responseTemplates":{"allOf":[{"$ref":"#/components/schemas/MapOfStringToString"},{"description":"<p><p>Response templates of the <a>GatewayResponse</a> as a string-to-string map of key-value pairs.</p></p>"}]}},"description":"Creates a customization of a <a>GatewayResponse</a> of a specified response type and status code on the given <a>RestApi</a>."},"PutIntegrationRequest":{"type":"object","required":["type"],"title":"PutIntegrationRequest","properties":{"type":{"allOf":[{"$ref":"#/components/schemas/IntegrationType"},{"description":"[Required] Specifies a put integration input's type."}]},"integrationHttpMethod":{"allOf":[{"$ref":"#/components/schemas/String"},{"xml":{"name":"httpMethod"},"description":"Specifies a put integration HTTP method. When the integration type is HTTP or AWS, this field is required."}]},"uri":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":"<p>Specifies Uniform Resource Identifier (URI) of the integration endpoint.</p> <ul> <li><p> For <code>HTTP</code> or <code>HTTP_PROXY</code> integrations, the URI must be a fully formed, encoded HTTP(S) URL according to the <a href=\"https://en.wikipedia.org/wiki/Uniform_Resource_Identifier\" target=\"_blank\">RFC-3986 specification</a>, for either standard integration, where <code>connectionType</code> is not <code>VPC_LINK</code>, or private integration, where <code>connectionType</code> is <code>VPC_LINK</code>. For a private HTTP integration, the URI is not used for routing. </p> </li> <li><p> For <code>AWS</code> or <code>AWS_PROXY</code> integrations, the URI is of the form <code>arn:aws:apigateway:{region}:{subdomain.service|service}:path|action/{service_api}</code>. Here, <code>{Region}</code> is the API Gateway region (e.g., <code>us-east-1</code>); <code>{service}</code> is the name of the integrated AWS service (e.g., <code>s3</code>); and <code>{subdomain}</code> is a designated subdomain supported by certain AWS service for fast host-name lookup. <code>action</code> can be used for an AWS service action-based API, using an <code>Action={name}&{p1}={v1}&p2={v2}...</code> query string. The ensuing <code>{service_api}</code> refers to a supported action <code>{name}</code> plus any required input parameters. Alternatively, <code>path</code> can be used for an AWS service path-based API. The ensuing <code>service_api</code> refers to the path to an AWS service resource, including the region of the integrated AWS service, if applicable. For example, for integration with the S3 API of <code><a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/RESTObjectGET.html\">GetObject</a></code>, the <code>uri</code> can be either <code>arn:aws:apigateway:us-west-2:s3:action/GetObject&Bucket={bucket}&Key={key}</code> or <code>arn:aws:apigateway:us-west-2:s3:path/{bucket}/{key}</code></p> </li></ul>"}]},"connectionType":{"allOf":[{"$ref":"#/components/schemas/ConnectionType"},{"description":"The type of the network connection to the integration endpoint. The valid value is <code>INTERNET</code> for connections through the public routable internet or <code>VPC_LINK</code> for private connections between API Gateway and a network load balancer in a VPC. The default value is <code>INTERNET</code>."}]},"connectionId":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":"The (<a href=\"https://docs.aws.amazon.com/apigateway/api-reference/resource/vpc-link/#id\"><code>id</code></a>) of the <a>VpcLink</a> used for the integration when <code>connectionType=VPC_LINK</code> and undefined, otherwise."}]},"credentials":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":"Specifies whether credentials are required for a put integration."}]},"requestParameters":{"allOf":[{"$ref":"#/components/schemas/MapOfStringToString"},{"description":"A key-value map specifying request parameters that are passed from the method request to the back end. The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the back end. The method request parameter value must match the pattern of <code>method.request.{location}.{name}</code>, where <code>location</code> is <code>querystring</code>, <code>path</code>, or <code>header</code> and <code>name</code> must be a valid and unique method request parameter name."}]},"requestTemplates":{"allOf":[{"$ref":"#/components/schemas/MapOfStringToString"},{"description":"Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value."}]},"passthroughBehavior":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":"<p>Specifies the pass-through behavior for incoming requests based on the Content-Type header in the request, and the available mapping templates specified as the <code>requestTemplates</code> property on the Integration resource. There are three valid values: <code>WHEN_NO_MATCH</code>, <code>WHEN_NO_TEMPLATES</code>, and <code>NEVER</code>. </p> <ul> <li><p><code>WHEN_NO_MATCH</code> passes the request body for unmapped content types through to the integration back end without transformation.</p></li> <li><p><code>NEVER</code> rejects unmapped content types with an HTTP 415 'Unsupported Media Type' response.</p></li> <li><p><code>WHEN_NO_TEMPLATES</code> allows pass-through when the integration has NO content types mapped to templates. However if there is at least one content type defined, unmapped content types will be rejected with the same 415 response.</p></li> </ul>"}]},"cacheNamespace":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":"Specifies a group of related cached parameters. By default, API Gateway uses the resource ID as the <code>cacheNamespace</code>. You can specify the same <code>cacheNamespace</code> across resources to return the same cached data for requests to different resources."}]},"cacheKeyParameters":{"allOf":[{"$ref":"#/components/schemas/ListOfString"},{"description":"A list of request parameters whose values API Gateway caches. To be valid values for <code>cacheKeyParameters</code>, these parameters must also be specified for <a>Method</a> <code>requestParameters</code>."}]},"contentHandling":{"allOf":[{"$ref":"#/components/schemas/ContentHandlingStrategy"},{"description":"<p>Specifies how to handle request payload content type conversions. Supported values are <code>CONVERT_TO_BINARY</code> and <code>CONVERT_TO_TEXT</code>, with the following behaviors:</p> <ul> <li><p><code>CONVERT_TO_BINARY</code>: Converts a request payload from a Base64-encoded string to the corresponding binary blob.</p></li> <li><p><code>CONVERT_TO_TEXT</code>: Converts a request payload from a binary blob to a Base64-encoded string.</p></li> </ul> <p>If this property is not defined, the request payload will be passed through from the method request to integration request without modification, provided that the <code>passthroughBehavior</code> is configured to support payload pass-through.</p>"}]},"timeoutInMillis":{"allOf":[{"$ref":"#/components/schemas/NullableInteger"},{"description":"Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds."}]},"tlsConfig":{"$ref":"#/components/schemas/TlsConfig"}},"description":"Sets up a method's integration."},"PutIntegrationResponseRequest":{"type":"object","title":"PutIntegrationResponseRequest","properties":{"selectionPattern":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":"Specifies the selection pattern of a put integration response."}]},"responseParameters":{"allOf":[{"$ref":"#/components/schemas/MapOfStringToString"},{"description":"A key-value map specifying response parameters that are passed to the method response from the back end. The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of <code>method.response.header.{name}</code>, where <code>name</code> is a valid and unique header name. The mapped non-static value must match the pattern of <code>integration.response.header.{name}</code> or <code>integration.response.body.{JSON-expression}</code>, where <code>name</code> must be a valid and unique response header name and <code>JSON-expression</code> a valid JSON expression without the <code>$</code> prefix."}]},"responseTemplates":{"allOf":[{"$ref":"#/components/schemas/MapOfStringToString"},{"description":"Specifies a put integration response's templates."}]},"contentHandling":{"allOf":[{"$ref":"#/components/schemas/ContentHandlingStrategy"},{"description":"<p>Specifies how to handle response payload content type conversions. Supported values are <code>CONVERT_TO_BINARY</code> and <code>CONVERT_TO_TEXT</code>, with the following behaviors:</p> <ul> <li><p><code>CONVERT_TO_BINARY</code>: Converts a response payload from a Base64-encoded string to the corresponding binary blob.</p></li> <li><p><code>CONVERT_TO_TEXT</code>: Converts a response payload from a binary blob to a Base64-encoded string.</p></li> </ul> <p>If this property is not defined, the response payload will be passed through from the integration response to the method response without modification.</p>"}]}},"description":"Represents a put integration response request."},"PutMethodRequest":{"type":"object","required":["authorizationType"],"title":"PutMethodRequest","properties":{"authorizationType":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":"[Required] The method's authorization type. Valid values are <code>NONE</code> for open access, <code>AWS_IAM</code> for using AWS IAM permissions, <code>CUSTOM</code> for using a custom authorizer, or <code>COGNITO_USER_POOLS</code> for using a Cognito user pool."}]},"authorizerId":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":"Specifies the identifier of an <a>Authorizer</a> to use on this Method, if the type is CUSTOM or COGNITO_USER_POOLS. The authorizer identifier is generated by API Gateway when you created the authorizer."}]},"apiKeyRequired":{"allOf":[{"$ref":"#/components/schemas/Boolean"},{"description":"Specifies whether the method required a valid <a>ApiKey</a>."}]},"operationName":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":"A human-friendly operation identifier for the method. For example, you can assign the <code>operationName</code> of <code>ListPets</code> for the <code>GET /pets</code> method in the <code>PetStore</code> example."}]},"requestParameters":{"allOf":[{"$ref":"#/components/schemas/MapOfStringToBoolean"},{"description":"A key-value map defining required or optional method request parameters that can be accepted by API Gateway. A key defines a method request parameter name matching the pattern of <code>method.request.{location}.{name}</code>, where <code>location</code> is <code>querystring</code>, <code>path</code>, or <code>header</code> and <code>name</code> is a valid and unique parameter name. The value associated with the key is a Boolean flag indicating whether the parameter is required (<code>true</code>) or optional (<code>false</code>). The method request parameter names defined here are available in <a>Integration</a> to be mapped to integration request parameters or body-mapping templates."}]},"requestModels":{"allOf":[{"$ref":"#/components/schemas/MapOfStringToString"},{"description":"Specifies the <a>Model</a> resources used for the request's content type. Request models are represented as a key/value map, with a content type as the key and a <a>Model</a> name as the value."}]},"requestValidatorId":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":"The identifier of a <a>RequestValidator</a> for validating the method request."}]},"authorizationScopes":{"allOf":[{"$ref":"#/components/schemas/ListOfString"},{"description":"A list of authorization scopes configured on the method. The scopes are used with a <code>COGNITO_USER_POOLS</code> authorizer to authorize the method invocation. The authorization works by matching the method scopes against the scopes parsed from the access token in the incoming request. The method invocation is authorized if any method scopes matches a claimed scope in the access token. Otherwise, the invocation is not authorized. When the method scope is configured, the client must provide an access token instead of an identity token for authorization purposes."}]}},"description":"Request to add a method to an existing <a>Resource</a> resource."},"PutMethodResponseRequest":{"type":"object","title":"PutMethodResponseRequest","properties":{"responseParameters":{"allOf":[{"$ref":"#/components/schemas/MapOfStringToBoolean"},{"description":"A key-value map specifying required or optional response parameters that API Gateway can send back to the caller. A key defines a method response header name and the associated value is a Boolean flag indicating whether the method response parameter is required or not. The method response header names must match the pattern of <code>method.response.header.{name}</code>, where <code>name</code> is a valid and unique header name. The response parameter names defined here are available in the integration response to be mapped from an integration response header expressed in <code>integration.response.header.{name}</code>, a static value enclosed within a pair of single quotes (e.g., <code>'application/json'</code>), or a JSON expression from the back-end response payload in the form of <code>integration.response.body.{JSON-expression}</code>, where <code>JSON-expression</code> is a valid JSON expression without the <code>$</code> prefix.)"}]},"responseModels":{"allOf":[{"$ref":"#/components/schemas/MapOfStringToString"},{"description":"Specifies the <a>Model</a> resources used for the response's content type. Response models are represented as a key/value map, with a content type as the key and a <a>Model</a> name as the value."}]}},"description":"Request to add a <a>MethodResponse</a> to an existing <a>Method</a> resource."},"PutRestApiRequest":{"type":"object","required":["body"],"title":"PutRestApiRequest","properties":{"body":{"allOf":[{"$ref":"#/components/schemas/Blob"},{"description":"[Required] The PUT request body containing external API definitions. Currently, only OpenAPI definition JSON/YAML files are supported. The maximum size of the API definition file is 6MB."}]}},"description":"A PUT request to update an existing API, with external API definitions specified as the request body."},"TagResourceRequest":{"type":"object","required":["tags"],"title":"TagResourceRequest","properties":{"tags":{"allOf":[{"$ref":"#/components/schemas/MapOfStringToString"},{"description":"[Required] The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with <code>aws:</code>. The tag value can be up to 256 characters."}]}},"description":"Adds or updates a tag on a given resource."},"TestInvokeAuthorizerRequest":{"type":"object","title":"TestInvokeAuthorizerRequest","properties":{"headers":{"allOf":[{"$ref":"#/components/schemas/MapOfStringToString"},{"description":"[Required] A key-value map of headers to simulate an incoming invocation request. This is where the incoming authorization token, or identity source, should be specified."}]},"multiValueHeaders":{"allOf":[{"$ref":"#/components/schemas/MapOfStringToList"},{"description":"[Optional] The headers as a map from string to list of values to simulate an incoming invocation request. This is where the incoming authorization token, or identity source, may be specified."}]},"pathWithQueryString":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":"[Optional] The URI path, including query string, of the simulated invocation request. Use this to specify path parameters and query string parameters."}]},"body":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":"[Optional] The simulated request body of an incoming invocation request."}]},"stageVariables":{"allOf":[{"$ref":"#/components/schemas/MapOfStringToString"},{"description":"A key-value map of stage variables to simulate an invocation on a deployed <a>Stage</a>."}]},"additionalContext":{"allOf":[{"$ref":"#/components/schemas/MapOfStringToString"},{"description":"[Optional] A key-value map of additional context variables."}]}},"description":"Make a request to simulate the execution of an <a>Authorizer</a>."},"TestInvokeMethodRequest":{"type":"object","title":"TestInvokeMethodRequest","properties":{"pathWithQueryString":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":"The URI path, including query string, of the simulated invocation request. Use this to specify path parameters and query string parameters."}]},"body":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":"The simulated request body of an incoming invocation request."}]},"headers":{"allOf":[{"$ref":"#/components/schemas/MapOfStringToString"},{"description":"A key-value map of headers to simulate an incoming invocation request."}]},"multiValueHeaders":{"allOf":[{"$ref":"#/components/schemas/MapOfStringToList"},{"description":"The headers as a map from string to list of values to simulate an incoming invocation request."}]},"clientCertificateId":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":"A <a>ClientCertificate</a> identifier to use in the test invocation. API Gateway will use the certificate when making the HTTPS request to the defined back-end endpoint."}]},"stageVariables":{"allOf":[{"$ref":"#/components/schemas/MapOfStringToString"},{"description":"A key-value map of stage variables to simulate an invocation on a deployed <a>Stage</a>."}]}},"description":"Make a request to simulate the execution of a <a>Method</a>."},"UntagResourceRequest":{"type":"object","title":"UntagResourceRequest","properties":{},"description":"Removes a tag from a given resource."},"UpdateAccountRequest":{"type":"object","title":"UpdateAccountRequest","properties":{"patchOperations":{"allOf":[{"$ref":"#/components/schemas/ListOfPatchOperation"},{"description":"A list of update operations to be applied to the specified resource and in the order specified in this list."}]}},"description":"Requests API Gateway to change information about the current <a>Account</a> resource."},"UpdateApiKeyRequest":{"type":"object","title":"UpdateApiKeyRequest","properties":{"patchOperations":{"allOf":[{"$ref":"#/components/schemas/ListOfPatchOperation"},{"description":"A list of update operations to be applied to the specified resource and in the order specified in this list."}]}},"description":"A request to change information about an <a>ApiKey</a> resource."},"UpdateAuthorizerRequest":{"type":"object","title":"UpdateAuthorizerRequest","properties":{"patchOperations":{"allOf":[{"$ref":"#/components/schemas/ListOfPatchOperation"},{"description":"A list of update operations to be applied to the specified resource and in the order specified in this list."}]}},"description":"Request to update an existing <a>Authorizer</a> resource."},"UpdateBasePathMappingRequest":{"type":"object","title":"UpdateBasePathMappingRequest","properties":{"patchOperations":{"allOf":[{"$ref":"#/components/schemas/ListOfPatchOperation"},{"description":"A list of update operations to be applied to the specified resource and in the order specified in this list."}]}},"description":"A request to change information about the <a>BasePathMapping</a> resource."},"UpdateClientCertificateRequest":{"type":"object","title":"UpdateClientCertificateRequest","properties":{"patchOperations":{"allOf":[{"$ref":"#/components/schemas/ListOfPatchOperation"},{"description":"A list of update operations to be applied to the specified resource and in the order specified in this list."}]}},"description":"A request to change information about an <a>ClientCertificate</a> resource."},"UpdateDeploymentRequest":{"type":"object","title":"UpdateDeploymentRequest","properties":{"patchOperations":{"allOf":[{"$ref":"#/components/schemas/ListOfPatchOperation"},{"description":"A list of update operations to be applied to the specified resource and in the order specified in this list."}]}},"description":"Requests API Gateway to change information about a <a>Deployment</a> resource."},"UpdateDocumentationPartRequest":{"type":"object","title":"UpdateDocumentationPartRequest","properties":{"patchOperations":{"allOf":[{"$ref":"#/components/schemas/ListOfPatchOperation"},{"description":"A list of update operations to be applied to the specified resource and in the order specified in this list."}]}},"description":"Updates an existing documentation part of a given API."},"UpdateDocumentationVersionRequest":{"type":"object","title":"UpdateDocumentationVersionRequest","properties":{"patchOperations":{"allOf":[{"$ref":"#/components/schemas/ListOfPatchOperation"},{"description":"A list of update operations to be applied to the specified resource and in the order specified in this list."}]}},"description":"Updates an existing documentation version of an API."},"UpdateDomainNameRequest":{"type":"object","title":"UpdateDomainNameRequest","properties":{"patchOperations":{"allOf":[{"$ref":"#/components/schemas/ListOfPatchOperation"},{"description":"A list of update operations to be applied to the specified resource and in the order specified in this list."}]}},"description":"A request to change information about the <a>DomainName</a> resource."},"UpdateGatewayResponseRequest":{"type":"object","title":"UpdateGatewayResponseRequest","properties":{"patchOperations":{"allOf":[{"$ref":"#/components/schemas/ListOfPatchOperation"},{"description":"A list of update operations to be applied to the specified resource and in the order specified in this list."}]}},"description":"Updates a <a>GatewayResponse</a> of a specified response type on the given <a>RestApi</a>."},"UpdateIntegrationRequest":{"type":"object","title":"UpdateIntegrationRequest","properties":{"patchOperations":{"allOf":[{"$ref":"#/components/schemas/ListOfPatchOperation"},{"description":"A list of update operations to be applied to the specified resource and in the order specified in this list."}]}},"description":"Represents an update integration request."},"UpdateIntegrationResponseRequest":{"type":"object","title":"UpdateIntegrationResponseRequest","properties":{"patchOperations":{"allOf":[{"$ref":"#/components/schemas/ListOfPatchOperation"},{"description":"A list of update operations to be applied to the specified resource and in the order specified in this list."}]}},"description":"Represents an update integration response request."},"UpdateMethodRequest":{"type":"object","title":"UpdateMethodRequest","properties":{"patchOperations":{"allOf":[{"$ref":"#/components/schemas/ListOfPatchOperation"},{"description":"A list of update operations to be applied to the specified resource and in the order specified in this list."}]}},"description":"Request to update an existing <a>Method</a> resource."},"UpdateMethodResponseRequest":{"type":"object","title":"UpdateMethodResponseRequest","properties":{"patchOperations":{"allOf":[{"$ref":"#/components/schemas/ListOfPatchOperation"},{"description":"A list of update operations to be applied to the specified resource and in the order specified in this list."}]}},"description":"A request to update an existing <a>MethodResponse</a> resource."},"UpdateModelRequest":{"type":"object","title":"UpdateModelRequest","properties":{"patchOperations":{"allOf":[{"$ref":"#/components/schemas/ListOfPatchOperation"},{"description":"A list of update operations to be applied to the specified resource and in the order specified in this list."}]}},"description":"Request to update an existing model in an existing <a>RestApi</a> resource."},"UpdateRequestValidatorRequest":{"type":"object","title":"UpdateRequestValidatorRequest","properties":{"patchOperations":{"allOf":[{"$ref":"#/components/schemas/ListOfPatchOperation"},{"description":"A list of update operations to be applied to the specified resource and in the order specified in this list."}]}},"description":"Updates a <a>RequestValidator</a> of a given <a>RestApi</a>."},"UpdateResourceRequest":{"type":"object","title":"UpdateResourceRequest","properties":{"patchOperations":{"allOf":[{"$ref":"#/components/schemas/ListOfPatchOperation"},{"description":"A list of update operations to be applied to the specified resource and in the order specified in this list."}]}},"description":"Request to change information about a <a>Resource</a> resource."},"UpdateRestApiRequest":{"type":"object","title":"UpdateRestApiRequest","properties":{"patchOperations":{"allOf":[{"$ref":"#/components/schemas/ListOfPatchOperation"},{"description":"A list of update operations to be applied to the specified resource and in the order specified in this list."}]}},"description":"Request to update an existing <a>RestApi</a> resource in your collection."},"UpdateStageRequest":{"type":"object","title":"UpdateStageRequest","properties":{"patchOperations":{"allOf":[{"$ref":"#/components/schemas/ListOfPatchOperation"},{"description":"A list of update operations to be applied to the specified resource and in the order specified in this list."}]}},"description":"Requests API Gateway to change information about a <a>Stage</a> resource."},"UpdateUsagePlanRequest":{"type":"object","title":"UpdateUsagePlanRequest","properties":{"patchOperations":{"allOf":[{"$ref":"#/components/schemas/ListOfPatchOperation"},{"description":"A list of update operations to be applied to the specified resource and in the order specified in this list."}]}},"description":"The PATCH request to update a usage plan of a given plan Id."},"UpdateUsageRequest":{"type":"object","title":"UpdateUsageRequest","properties":{"patchOperations":{"allOf":[{"$ref":"#/components/schemas/ListOfPatchOperation"},{"description":"A list of update operations to be applied to the specified resource and in the order specified in this list."}]}},"description":"The PATCH request to grant a temporary extension to the remaining quota of a usage plan associated with a specified API key."},"UpdateVpcLinkRequest":{"type":"object","title":"UpdateVpcLinkRequest","properties":{"patchOperations":{"allOf":[{"$ref":"#/components/schemas/ListOfPatchOperation"},{"description":"A list of update operations to be applied to the specified resource and in the order specified in this list."}]}},"description":"Updates an existing <a>VpcLink</a> of a specified identifier."},"VpcLinkStatus":{"type":"string","enum":["AVAILABLE","PENDING","DELETING","FAILED"]}},"x-policies":{"/apikeys":"API Key","/restapis/{restapi_id}/authorizers":"Authorizers","/domainnames/{domain_name}/basepathmappings":"Domain Mapping","/restapis/{restapi_id}/deployments":"Deployments","/restapis/{restapi_id}/documentation/parts":"Documentation Parts","/restapis/{restapi_id}/documentation/versions":"Documentation Versions","/domainnames":"Domain Names","/restapis/{restapi_id}/models":"Models","/restapis/{restapi_id}/requestvalidators":"Request Validation","/restapis/{restapi_id}/resources/{parent_id}":"Resource Parents","/restapis":"APIs","/restapis/{restapi_id}/stages":"Stages","/usageplans":"Plans","/usageplans/{usageplanId}/keys":"Plan Keys","/vpclinks":"Virtual Private Networks","/apikeys/{api_Key}":"API Key","/restapis/{restapi_id}/authorizers/{authorizer_id}":"Authorizers","/domainnames/{domain_name}/basepathmappings/{base_path}":"Domain Names","/clientcertificates/{clientcertificate_id}":"Certificates","/restapis/{restapi_id}/deployments/{deployment_id}":"Deploymeents","/restapis/{restapi_id}/documentation/parts/{part_id}":"Documentation Parts","/restapis/{restapi_id}/documentation/versions/{doc_version}":"Documentation Versions","/domainnames/{domain_name}":"Domain Names","/restapis/{restapi_id}/gatewayresponses/{response_type}":"Response Types","/restapis/{restapi_id}/resources/{resource_id}/methods/{http_method}/integration":"HTTP Integrations","/restapis/{restapi_id}/resources/{resource_id}/methods/{http_method}/integration/responses/{status_code}":"Response Status Codes","/restapis/{restapi_id}/resources/{resource_id}/methods/{http_method}":"Methods","/restapis/{restapi_id}/resources/{resource_id}/methods/{http_method}/responses/{status_code}":"Response Status Codes","/restapis/{restapi_id}/models/{model_name}":"Models","/restapis/{restapi_id}/requestvalidators/{requestvalidator_id}":"Request Validation","/restapis/{restapi_id}/resources/{resource_id}":"Resources","/restapis/{restapi_id}":"APIs","/restapis/{restapi_id}/stages/{stage_name}":"Stages","/usageplans/{usageplanId}":"Plans","/usageplans/{usageplanId}/keys/{keyId}":"Plan Keys","/vpclinks/{vpclink_id}":"Virtual Private Networks","/restapis/{restapi_id}/stages/{stage_name}/cache/authorizers":"Authorizer Cache","/restapis/{restapi_id}/stages/{stage_name}/cache/data":"Cache Data","/clientcertificates":"Client Certificates","/account":"Accounts","/restapis/{restapi_id}/stages/{stage_name}/exports/{export_type}":"Stage Exports","/restapis/{restapi_id}/gatewayresponses":"Gateway Responses","/restapis/{restapi_id}/models/{model_name}/default_template":"Default Templates","/restapis/{restapi_id}/resources":"Resources","/restapis/{restapi_id}/stages/{stage_name}/sdks/{sdk_type}":"SDKs","/sdktypes/{sdktype_id}":"SDK Types","/sdktypes":"SDK Types","/tags/{resource_arn}":"Tags","/usageplans/{usageplanId}/usage#startDate&endDate":"Plan Usage","/apikeys#mode=import&format":"API Keys","/restapis#mode=import":"APIs","/tags/{resource_arn}#tagKeys":"Tags","/usageplans/{usageplanId}/keys/{keyId}/usage":"Key Usage"}},"security":[{"hmac":[]}]}
/ apikeys
/ restapis / {restapi_id} / authorizers
/ domainnames / {domain_name} / basepathmappings
/ restapis / {restapi_id} / deployments
/ restapis / {restapi_id} / documentation / parts
/ restapis / {restapi_id} / documentation / versions
/ domainnames
/ restapis / {restapi_id} / models
/ restapis / {restapi_id} / requestvalidators
/ restapis / {restapi_id} / resources / {parent_id}
/ restapis
/ restapis / {restapi_id} / stages
/ usageplans
/ usageplans / {usageplanId} / keys
/ vpclinks
/ apikeys / {api_Key}
/ restapis / {restapi_id} / authorizers / {authorizer_id}
/ domainnames / {domain_name} / basepathmappings / {base_path}
/ clientcertificates / {clientcertificate_id}
/ restapis / {restapi_id} / deployments / {deployment_id}
/ restapis / {restapi_id} / documentation / parts / {part_id}
/ restapis / {restapi_id} / documentation / versions / {doc_version}
/ domainnames / {domain_name}
/ restapis / {restapi_id} / gatewayresponses / {response_type}
/ restapis / {restapi_id} / resources / {resource_id} / methods / {http_method} / integration
/ restapis / {restapi_id} / resources / {resource_id} / methods / {http_method} / integration / responses / {status_code}
/ restapis / {restapi_id} / resources / {resource_id} / methods / {http_method}
/ restapis / {restapi_id} / resources / {resource_id} / methods / {http_method} / responses / {status_code}
/ restapis / {restapi_id} / models / {model_name}
/ restapis / {restapi_id} / requestvalidators / {requestvalidator_id}
/ restapis / {restapi_id} / resources / {resource_id}
/ restapis / {restapi_id}
/ restapis / {restapi_id} / stages / {stage_name}
/ usageplans / {usageplanId}
/ usageplans / {usageplanId} / keys / {keyId}
/ vpclinks / {vpclink_id}
/ restapis / {restapi_id} / stages / {stage_name} / cache / authorizers
/ restapis / {restapi_id} / stages / {stage_name} / cache / data
/ clientcertificates
/ account
/ restapis / {restapi_id} / stages / {stage_name} / exports / {export_type}
/ restapis / {restapi_id} / gatewayresponses
/ restapis / {restapi_id} / models / {model_name} / default_template
/ restapis / {restapi_id} / resources
/ restapis / {restapi_id} / stages / {stage_name} / sdks / {sdk_type}
/ sdktypes / {sdktype_id}
/ sdktypes
/ tags / {resource_arn}
/ usageplans / {usageplanId} / usage#startDate&endDate
/ apikeys#mode=import&format
/ restapis#mode=import
/ tags / {resource_arn}#tagKeys
/ usageplans / {usageplanId} / keys / {keyId} / usage
No API Resources

(Product) (Docs)

---

{"class":["gateway"],"properties":{"name":"Apigee Edge","provider":"Google Cloud","slug":"apigee-edge","rating":1,"license":"Proprietary","status":"Pending Review","researchDate":"2021-10","description":"Apigee Edge is a first-generation, commercial gateway platform. It includes a fully-integrated API Provider experience along with API Consumer management via a [Portal](../../platform-capabilities/developer-portal/). While Apigee Edge comes with a number of different delivery options, newer SaaS deliveries seem to be getting pushed more towards [Apigee X](../apigee-x/). Policies for Apigee Edge Gateways are configured with XML and can be accessed via a UI, CLI, and API. Apigee Edge has a few different gateway offerings, including both a microgateway hybrid approach.\n","platformCapabilities":["Design","Gateway","Analytics","Monetization","Monitoring","Portal","Threat Protection","Documentation"],"gatewayCapabilities":["Custom Code Execution","Protocol Transformation","Versioning","Traffic Management","Mediation","OpenAPI Integration"],"customCodeSupport":["Java","JavaScript","Node.js","Python"],"upstreamProtocols":["HTTP/1.1"],"downstreamProtocols":["HTTP/1.1"],"deliveryModels":["SaaS","Customer Managed (Cloud)","Customer Managed (On-Premises)","Hybrid"],"policies":[{"category":"Traffic Management","capabilities":["Cache Lookup","Cache Invalidation","Cache Population","Cache Target Response","Concurrent Rate Limit","Quota","Quota Reset","Spike Arrest"]},{"category":"Mediation","capabilities":["Platform Data Lookup","Request Transformation","Response Transformation","Context Persistence","Custom Data Storage","JSON to XML","XML to JSON","SOAP Validation","OpenAPI Validation","Custom Exception Handling","XSL Tranformations"]},{"category":"Security","capabilities":["IP Access Rules","Basic Authentication","API Key","OAuth 2.0","OAuth 1.0","HMAC","JSON Threat Protection","XML Threat Protection","JWS","JWT","LDAP","Message Inspection","SAML Assertion"]},{"category":"Extensions","capabilities":["Platform Integration","Java","JavaScript","Python","Message Logging","HTTP Callout","Statistics Collection"]}]},"links":[{"rel":["urn:gateway:product"],"title":"Product","href":"https://docs.apigee.com/"},{"rel":["urn:gateway:docs"],"title":"Documentation","href":"https://docs.apigee.com/api-platform/get-started/get-started"},{"rel":["urn:gateway:logo"],"title":"Logo","href":"/images/gateways/apigee-edge.svg"},{"rel":["urn:gateway:related"],"title":"Apigee X","href":"../apigee-x"},{"rel":["urn:gateway:screenshot"],"title":"Screenshot","href":"https://kinlane-productions2.s3.amazonaws.com/api-gateways/apigee-edge.png"}]}

Apigee Edge

Apigee Edge is a first-generation, commercial gateway platform. It includes a fully-integrated API Provider experience along with API Consumer management via a [Portal](../../platform-capabilities/developer-portal/). While Apigee Edge comes with a number of different delivery options, newer SaaS deliveries seem to be getting pushed more towards [Apigee X](../apigee-x/). Policies for Apigee Edge Gateways are configured with XML and can be accessed via a UI, CLI, and API. Apigee Edge has a few different gateway offerings, including both a microgateway hybrid approach.

Platform Capabilities

These are the wider capabilities beyond the gateway they offer.

• Design
• Gateway
• Analytics
• Monetization
• Monitoring
• Portal
• Threat Protection
• Documentation

Gateway Capabilities

These are the capabilities the gateway supports.

• Custom Code Execution
• Protocol Transformation
• Versioning
• Traffic Management
• Mediation
• OpenAPI Integration

Upstream Protocols

The different protocols they support upstream.

• HTTP/1.1

Downtream Protocols

The different protocols they support downstream.

• HTTP/1.1

Custom Code

If they offer plugin, extension, and custom coding options.

• Java
• JavaScript
• Node.js
• Python

Delivery Models

These are they ways you can deliver this solution.

• SaaS
• Customer Managed (Cloud)
• Customer Managed (On-Premises)
• Hybrid

Policies

These are the policies available across the gateway capabilities.

Traffic Management

• Cache Lookup
• Cache Invalidation
• Cache Population
• Cache Target Response
• Concurrent Rate Limit
• Quota
• Quota Reset
• Spike Arrest

Mediation

• Platform Data Lookup
• Request Transformation
• Response Transformation
• Context Persistence
• Custom Data Storage
• JSON to XML
• XML to JSON
• SOAP Validation
• OpenAPI Validation
• Custom Exception Handling
• XSL Tranformations

Security

• IP Access Rules
• Basic Authentication
• API Key
• OAuth 2.0
• OAuth 1.0
• HMAC
• JSON Threat Protection
• XML Threat Protection
• JWS
• JWT
• LDAP
• Message Inspection
• SAML Assertion

Extensions

• Platform Integration
• Java
• JavaScript
• Python
• Message Logging
• HTTP Callout
• Statistics Collection

API Resources

OAuth 1.0a Request Tokens API OpenAPI	{"openapi":"3.0.0","servers":[{"url":"https://api.enterprise.apigee.com/v1"}],"info":{"title":"OAuth 1.0a Request Tokens API","description":"Description.","version":"1.0"},"security":[{"Basic":[]},{"OAuth":[]}],"paths":{"/organizations/{org_name}/oauth1/requesttokens":{"get":{"tags":["OAuth 1.0a"],"summary":"List OAuth 1.0a request tokens","description":"Lists the OAuth 1.0a request tokens in an organization.","operationId":"listOAuth10aRequestTokens","parameters":[{"$ref":"#/components/parameters/org_name"}],"responses":{"200":{"description":"OK"},"400":{"description":"Bad request"}}}},"/organizations/{org_name}/oauth1/requesttokens/{request_token}":{"delete":{"tags":["OAuth 1.0a"],"summary":"Delete OAuth 1.0a Request Token","description":"Deletes the specified OAuth 1.0a request token.","operationId":"deleteOAuth10aRequestToken","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/request_token"}],"responses":{"200":{"description":"OK"},"400":{"description":"Bad request"}}},"post":{"tags":["OAuth 1.0a"],"summary":"Approve, revoke, or update OAuth 1.0a request token","description":"Enables you to perform one of the following tasks:\n\n* Approve or revoke the specified request token by setting the `action` query parameter to `approve` or `revoke`.\n* Update the specified request token with a new profile. With Apigee Edge for Public Cloud, the attribute limit is 18.","operationId":"approveRevokeUpdateOAuth10aRequestToken","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/request_token"},{"$ref":"#/components/parameters/request_token"}],"responses":{"200":{"description":"OK"},"400":{"description":"Bad request"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessTokenAttributes"}}}}},"get":{"tags":["OAuth 1.0a"],"summary":"Get OAuth 1.0a request token","description":"Gets details for the specified OAuth 1.0a request token.","operationId":"getOAuth10aRequestToken","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/request_token"}],"responses":{"200":{"description":"OK"},"400":{"description":"Bad request"}}}}},"components":{"securitySchemes":{"Basic":{"type":"http","scheme":"basic","description":"Multi-factor authentication is not supported."},"OAuth":{"type":"apiKey","name":"Authorization","in":"header","description":"For OAuth, enter the following in the Key field: Bearer %your-token% (see https://docs.apigee.com/api-platform/system-administration/using-oauth2#get-the-tokens)"}},"parameters":{"org_name":{"in":"path","name":"org_name","required":true,"schema":{"type":"string"},"description":"Organization name."},"request_token":{"in":"path","name":"request_token","required":true,"schema":{"type":"string"},"description":"Organization name."},"action":{"in":"query","name":"action","required":false,"schema":{"type":"string"},"description":"Set to `approve` or `revoke`."}},"schemas":{"AccessTokenAttributes":{"description":"Update access token attributes.","type":"object","properties":{"attributes":{"description":"Attributes used to extend the default profile.","type":"array","items":{"$ref":"#/components/schemas/NameValue"}},"scope":{"description":"List of scopes associated with the access token, validated at runtime against scopes defined in API product.","type":"string"}}},"NameValue":{"description":"Name/value attribute pairs.","type":"object","properties":{"name":{"description":"Name of attribute.","type":"string"},"value":{"description":"Value of attribute.","type":"string"}}}}}}
/ organizations / {org_name} / oauth1 / requesttokens
/ organizations / {org_name} / oauth1 / requesttokens / {request_token}
Collections API OpenAPI	{"openapi":"3.0.1","info":{"title":"Collections API","description":"Collections enable you to group API proxies, targets, or developer apps and set up appropriate threshold values for all members of the group to diagnose issues faster. For more information, see <a href=\"https://docs.apigee.com/api-monitoring/collections-api\">Manage collections using the API</a>.\n","version":"1.0"},"servers":[{"url":"https://apimonitoring.enterprise.apigee.com"}],"security":[{"OAuth":[]}],"paths":{"/collections":{"get":{"tags":["API Montoring"],"summary":"List collections","operationId":"listCollections","description":"Lists collections in an organization.\nYou can filter the list of returned collections by the Edge environment, collection type, collection name, and collection members.\n\n**Note**: Edge imposes a quota on this API. You can call this API at most **six times per minute**.\n\nFor more information and examples of this API, see <a href=\"https://docs.apigee.com/api-monitoring/collections-api\">Manage collections using the API</a>.","parameters":[{"$ref":"#/components/parameters/org"},{"$ref":"#/components/parameters/env"},{"$ref":"#/components/parameters/name"},{"$ref":"#/components/parameters/type"},{"$ref":"#/components/parameters/member"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Collections"}}}}}},"post":{"tags":["API Montoring"],"summary":"Create a collection","operationId":"createCollection","description":"Creates a collection. \n\n\n**Notes**: \n\n* You can add a maximum of **20 items** to a collection.\n* Edge imposes a quota on this API. You can call this API at most **six times per minute**.\n\n\nFor more information and examples of this API, see <a href=\"https://docs.apigee.com/api-monitoring/collections-api\">Manage collections using the API</a>.\n","requestBody":{"description":"Collection details.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Collection"}}},"required":true},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Collection"},"example":{"uuid":"<uuid>","organization":"myorg","environment":"prod","name":"Critical APIs","type":"proxy","members":["proxy1","proxy2"],"description":"My collection for critical APIs","updatedAt":"2018-08-08T17:46:50Z","updatedBy":"ahamilton@example.com"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-codegen-request-body-name":"collection"}},"/collections/{collection_id}":{"get":{"tags":["API Montoring"],"summary":"Get a collection","operationId":"getCollection","description":"Gets a collection.\n\n**Note**: Edge imposes a quota on this API. You can call this API at most **six times** per minute.\n\nFor more information and examples of this API, see <a href=\"https://docs.apigee.com/api-monitoring/collections-api\">Manage collections using the API</a>.","parameters":[{"$ref":"#/components/parameters/collection_id"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Collection"},"example":{"uuid":"<uuid>","organization":"myorg","environment":"prod","name":"Critical APIs","type":"proxy","members":["proxy1","proxy2"],"description":"My collection for critical APIs","updatedAt":"2018-08-08T17:46:50Z","updatedBy":"ahamilton@example.com"}}}}}},"delete":{"tags":["API Montoring"],"summary":"Delete a collection","operationId":"deleteCollection","description":"Deletes a collection.\n\n**Notes**: \n\n* Edge imposes a quota on this API. You can call this API at most **six times** per minute.\n* **This API cannot be executed using the Try this API panel**.\n\nFor more information and examples of this API, see <a href=\"https://docs.apigee.com/api-monitoring/collections-api\">Manage collections using the API</a>.","parameters":[{"$ref":"#/components/parameters/collection_id"},{"$ref":"#/components/parameters/Content-type"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Delete"},"example":{"uuid":"<uuid>","organization":"myorg","environment":"prod","name":"Critical APIs","type":"proxy","members":["proxy1","proxy2"],"description":"My collection for critical APIs","updatedAt":"2018-08-08T17:46:50Z","updatedBy":"ahamilton@example.com"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"patch":{"tags":["API Montoring"],"summary":"Update a collection","operationId":"updateCollection","description":"Updates a collection. \nYou must specify the organization in the JSON payload but all other properties are optional. \n\n**Notes**: \n\n* You cannot change the organization, environment, or collection type when updating the collection.\n* Edge imposes a quota on this API. You can call this API at most **six times per minute**.\n* **This API cannot be executed using the Try this API panel**.\n\nFor more information and examples of this API, see <a href=\"https://docs.apigee.com/api-monitoring/collections-api\">Manage collections using the API</a>.","parameters":[{"name":"collection_id","in":"path","description":"Valid collection ID. Use the <a href=\"/docs/collections-api/1/routes/collections/get\">Get collections API</a> to get a list of collection IDs.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Collection object that is being updated\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Collection"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Collection"},"example":{"uuid":"<uuid>","organization":"myorg","environment":"prod","name":"Critical APIs","type":"proxy","members":["proxy1","proxy2"],"description":"My collection for critical APIs","updatedAt":"2018-08-08T17:46:50Z","updatedBy":"ahamilton@example.com"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}}},"components":{"securitySchemes":{"OAuth":{"type":"apiKey","name":"Authorization","in":"header","description":"For OAuth, enter the following in the Key field: Bearer %your-token% (see https://docs.apigee.com/api-platform/system-administration/using-oauth2#get-the-tokens)"}},"parameters":{"org":{"name":"org","in":"query","description":"Organization name.","required":true,"schema":{"type":"string"}},"env":{"name":"env","in":"query","description":"Environment name.","required":false,"schema":{"type":"string"}},"name":{"name":"name","in":"query","description":"Collection name.","required":false,"schema":{"type":"string"}},"type":{"name":"type","in":"query","description":"Type of collection. Valid values include: `proxy`, `target`, or `developerApp`. By default, all collection types are returned.","required":false,"schema":{"type":"string"}},"member":{"name":"member","in":"query","description":"Name of the API proxy, target, or developer app that is a member of the collection for which you want to list details.","schema":{"type":"string"}},"collection_id":{"name":"collection_id","in":"path","description":"Valid collection ID.","required":true,"schema":{"type":"string"}},"Content-type":{"name":"Content-type","in":"header","description":"Content-type header","required":true,"schema":{"type":"string"}}},"schemas":{"Collections":{"type":"array","description":"`proxy`, `target` or `developerApp` collections.","items":{"$ref":"#/components/schemas/Collection"}},"Collection":{"type":"object","properties":{"name":{"type":"string","description":"Name of the collection. Required when creating a collection.","example":"LowTraffic"},"organization":{"type":"string","description":"Organization name. Required when creating a collection; cannot be updated.","example":"myOrg"},"environment":{"type":"string","description":"Environment name. Required when creating a collection; cannot be updated.","example":"test"},"description":{"type":"string","description":"Description of the collection. Required when creating a collection.","example":"Collection of Low Traffic targets"},"type":{"type":"string","description":"Type of collection. Valid values include `proxy`, `target`, or `developerApp`. Required when creating a collection; cannot be updated.","example":"target"},"members":{"type":"array","description":"API proxy, target, or develoer app members belonging to the collection. Required when creating a collection.","example":["Target123","Target345"],"items":{"type":"string"}},"updatedAt":{"type":"string","description":"Output only. Time the condition was updated.\n","format":"iso8601","example":"2017-10-12T23:19:09Z"},"updatedBy":{"type":"string","description":"Output only. Email address of the user that created or last modified the collection.\n","format":"email","example":"user@example.com"},"uuid":{"type":"string","description":"Collection ID.","example":"1ae31238-6469-11e8-adc0-fa7ae01bbebc"}},"description":"Collection details."},"Error":{"type":"object","properties":{"errorCode":{"type":"integer"},"status":{"type":"integer","description":"HTTP status code\n","example":500},"message":{"type":"string"}}},"Delete":{"type":"object","properties":{"status":{"type":"integer","description":"HTTP status code","example":200}}}}}}
/ collections
/ collections / {collection_id}
Policies API OpenAPI	{"openapi":"3.0.0","servers":[{"url":"https://api.enterprise.apigee.com/v1"}],"info":{"title":"Policies API","description":"Apigee Edge out-of-the-box policies augment your APIs to control traffic,enhance performance, enforce security, and increase the utility of your APIs, without requiring you to write any code or modify any backend services. In addition, Apigee provides extension policies that let you implement custom logic in the form of JavaScript, Python, Java, and XSLT stylesheets.","version":"1.0"},"security":[{"Basic":[]},{"OAuth":[]}],"paths":{"/organizations/{org_name}/apis/{api_name}/revisions/{revision_number}/policies":{"post":{"tags":["Policy"],"summary":"Create a policy for an API proxy revision","description":"Creates a policy for a specific API proxy revision. \n\nApigee Edge validates the policy, and you'll receive an error if the policy is invalid. For more information about creating policies, see <a href=\"https://docs.apigee.com/api-platform/reference/policies/reference-overview-policy\">Policy reference overview</a>.\nTo use the new policy in the API proxy revision, you must attach it to the desired place in the proxy flow. ","operationId":"createPolicy","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/api_name"},{"$ref":"#/components/parameters/revision_number"}],"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Policy"}},"application/xml":{"schema":{"$ref":"#/components/schemas/Policy"}}}},"400":{"description":"Bad request"}},"requestBody":{"content":{"application/xml":{"schema":{"$ref":"#/components/schemas/Policy"}}}}},"get":{"tags":["Policy"],"summary":"List policies for an API proxy revision","description":"Lists policies for an API proxy revision.","operationId":"getPolicies","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/api_name"},{"$ref":"#/components/parameters/revision_number"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}}},"400":{"description":"Bad request"}}}},"/organizations/{org_name}/apis/{api_name}/revisions/{revision_number}/policies/{policy_name}":{"get":{"tags":["Policy"],"summary":"Get policy for an API proxy revision","description":"Gets policy details for an API proxy revision.","operationId":"getPolicy","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/api_name"},{"$ref":"#/components/parameters/revision_number"},{"$ref":"#/components/parameters/policy_name"},{"$ref":"#/components/parameters/Accept"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Policy"}},"application/xml":{"schema":{"$ref":"#/components/schemas/Policy"}}}},"400":{"description":"Bad request"}}},"delete":{"tags":["Policy"],"summary":"Delete policy for an API proxy revision","description":"Deletes a policy for an API proxy revision.","operationId":"getPolicy","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/api_name"},{"$ref":"#/components/parameters/revision_number"},{"$ref":"#/components/parameters/policy_name"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Policy"}},"application/xml":{"schema":{"$ref":"#/components/schemas/Policy"}}}},"400":{"description":"Bad request"}}}}},"components":{"securitySchemes":{"Basic":{"type":"http","scheme":"basic","description":"Multi-factor authentication is not supported."},"OAuth":{"type":"apiKey","name":"Authorization","in":"header","description":"For OAuth, enter the following in the Key field: Bearer %your-token% (see https://docs.apigee.com/api-platform/system-administration/using-oauth2#get-the-tokens)"}},"parameters":{"org_name":{"in":"path","name":"org_name","required":true,"schema":{"type":"string"},"description":"Organization name."},"api_name":{"in":"path","name":"api_name","required":true,"schema":{"type":"string"},"description":"API proxy name."},"revision_number":{"in":"path","name":"revision_number","required":true,"schema":{"type":"string"},"description":"Revision number."},"policy_name":{"in":"path","name":"policy_name","required":true,"schema":{"type":"string"},"description":"Name of the policy."},"Accept":{"in":"header","name":"Accept","required":true,"schema":{"type":"string"},"description":"Set to `application/json` or `application/xml`."}},"schemas":{"Policy":{"description":"Policy details. Descriptions of common policy elements and attributes are provided below. For information about the complete set of elements available for each policy type, see <a href=\"https://docs.apigee.com/api-platform/reference/policies/reference-overview-policy\">Policy reference overview</a>.","type":"object","properties":{"async":{"type":"string","description":"This attribute is deprecated."},"continueOnError":{"type":"string","description":"Flag that specifies whether to continue flow execution even after the policy fails. Set to `true` to continue flow execution. Defaults to `false`."},"DisplayName":{"type":"string","description":"Display name used to label the policy in the Edge UI proxy editor with a different, natural-language name."},"enabled":{"type":"string","description":"Flag that specifies whether the policy is enabled. Set to `false` to \"turn off\" the policy. Defaults to `true`."},"name":{"type":"string","description":"Internal name of the policy. The value of the name attribute can contain letters, numbers, spaces, hyphens, underscores, and periods. This value cannot exceed 255 characters. Optionally, set `DisplayName` to label the policy in the Edge UI proxy editor with a different, natural-language name."}},"example":{"VerifyAPIKey":{"DisplayName":"VerifyAPIKey","FaultRules":"","Properties":"","APIKey":{"_ref":"request.header.x-DNA-Api-Key"},"_async":"false","_continueOnError":"false","_enabled":"true","_name":"VerifyAPIKey"}}}}}}
/ organizations / {org_name} / apis / {api_name} / revisions / {revision_number} / policies
/ organizations / {org_name} / apis / {api_name} / revisions / {revision_number} / policies / {policy_name}
Cached Logs API OpenAPI	{"openapi":"3.0.0","servers":[{"url":"https://api.enterprise.apigee.com/v1"}],"info":{"title":"Cached Logs API","description":"Access cached log for an API.","version":"1.0"},"security":[{"Basic":[]},{"OAuth":[]}],"paths":{"/organizations/{org_name}/environments/{env_name}/apis/{api_name}/cachedlogs/categories":{"get":{"tags":["Cached Log"],"summary":"List cached log categories","description":"Lists the names of the available cached log categories for the specified API.\n\nCategories include:\n\n* `nodejs`\n* `hostedtarget-build`\n* `hostedtarget-runtime`","operationId":"getCachedLogs","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/env_name"},{"$ref":"#/components/parameters/api_name"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}}},"400":{"description":"Bad request"}}}},"/organizations/{org_name}/environments/{env_name}/apis/{api_name}/cachedlogs/categories/{category_name}":{"get":{"tags":["Cached Log"],"summary":"Get Cached Logs","description":"Gets the most recent log records for the specified API and category.\n\nSupported categories include:\n\n* `nodejs` - Logs for <a href=\"https://docs.apigee.com/api-platform/nodejs/overview-nodejs-apigee-edge\">Node.js proxy applications</a>. \n* `hostedtarget-build` - Build logs for <a href=\"https://docs.apigee.com/api-platform/hosted-targets/hosted-targets-overview\">Hosted Targets applications</a>.Shows you output related to deploying and building the `Node.js` app. \n* `hostedtarget-runtime` - Runtime logs for for <a href=\"https://docs.apigee.com/api-platform/hosted-targets/hosted-targets-overview\">Hosted Targets applications</a>. Shows output related to the running app. Runtime logs are scoped to the environment and return logs for the currently deployed proxy revision. \n\nThe exact number of log records returned may change depending on system configuration, but it will typically be 500 for each message processor or 1000 in most configurations. Hosted Target logs are retained for 7 days or 50 GBs per month, whichever comes first.\n\nThe response format is as follows:\n\n`[TIMESTAMP CATEGORY SERVER] Record...`\n\nWhere:\n\n* `TIMESTAMP`: Time at which the log record was generated.\n* `CATEGORY`: Log category (`nodejs`, `hostedtarget-build`, or `hostedtarget-runtime`) and whether the log went to `stdout` or `stderr`.\n* `SERVER`:\n * For `Node.js`, uniquely identifies the server within Apigee Edge where the log was generated. For example: `[2014-10-09T00:58:17.619Z nodejs/stdout svr.701]Hello, World!`\n * For Hosted Targets, `SERVER` is always reported as: `svr.0`\n \n\nExample Hosted Targets runtime log output:\n\n``` [2018-01-19T18:09:06.733Z hostedtarget-runtime/stdout svr.0] Node HTTP server is listening\n[2018-01-19T18:09:18.118Z hostedtarget-runtime/stdout svr.0] GET /\n[2018-01-19T18:09:21.286Z hostedtarget-runtime/stdout svr.0] The time is 2018-01-19T18:06:18.182Z\n```\n\nExample Hosted Targets build log output:\n\n\n``` [2018-01-19T18:03:53.000Z hostedtarget-build/stdout svr.0] BUILD\n[2018-01-19T18:03:53.000Z hostedtarget-build/stdout svr.0] Starting Step #0\n[2018-01-19T18:03:53.000Z hostedtarget-build/stdout svr.0] Step #0: Pulling image: gcr.io/turbo-validators/nodevalidation:0.0.1\n[2018-01-19T18:03:53.000Z hostedtarget-build/stdout svr.0] Step #0: 0.0.1: Pulling from turbo-validators/nodevalidation\n```","operationId":"getCachedLogs","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/env_name"},{"$ref":"#/components/parameters/api_name"},{"$ref":"#/components/parameters/category_name"},{"$ref":"#/components/parameters/getState"},{"$ref":"#/components/parameters/state"},{"$ref":"#/components/parameters/tz"}],"responses":{"200":{"description":"OK"},"400":{"description":"Bad request"}}}}},"components":{"securitySchemes":{"Basic":{"type":"http","scheme":"basic","description":"Multi-factor authentication is not supported."},"OAuth":{"type":"apiKey","name":"Authorization","in":"header","description":"For OAuth, enter the following in the Key field: Bearer %your-token% (see https://docs.apigee.com/api-platform/system-administration/using-oauth2#get-the-tokens)"}},"parameters":{"org_name":{"name":"org_name","in":"path","required":true,"schema":{"type":"string"},"description":"Organization name."},"env_name":{"name":"env_name","in":"path","required":true,"schema":{"type":"string"},"description":"Environment name."},"api_name":{"name":"api_name","in":"path","required":true,"schema":{"type":"string"},"description":"API name."},"category_name":{"name":"category_name","in":"path","required":true,"schema":{"type":"string"},"description":"Category name. Valid values include:\n* `nodejs` - Logs for <a href=\"https://docs.apigee.com/api-platform/nodejs/overview-nodejs-apigee-edge\">Node.js proxy applications</a>.\n* `hostedtarget-build` - Build logs for <a href=\"https://docs.apigee.com/api-platform/hosted-targets/hosted-targets-overview\">Hosted Targets applications</a>, including data related to deploying and building the Node.js app. See also runtime logs.\n* `hostedtarget-runtime` - Runtime logs for for <a href=\"https://docs.apigee.com/api-platform/hosted-targets/hosted-targets-overview\">Hosted Targets applications</a>, including data related to the running app. Runtime logs are scoped to the environment and return logs for the currently deployed proxy revision. See also <a href=\"https://docs.apigee.com/api-platform/hosted-targets/hosted-targets-reference#about-log-files\" target=\"_blank\">runtime logs</a>."},"getState":{"name":"getState","in":"query","required":false,"schema":{"type":"boolean"},"description":"Set to true to have the last line of the log output use the following format: `[state XXXX,]`, where `XXXX` is an opaque value that represents the current position in the log. For example: `[state 4-Li2Msq8PDg8sn9mlxcHEfYBBafBbEB]`."},"state":{"name":"state","in":"query","required":false,"schema":{"type":"string"},"description":"Set to the state returned from a previous log request using `getState=true` to return only log records that were created since that point.\n\nNote that each API call to cachedlogs/categories/nodejs may return a different state value.\n\nA script that wishes to `tail -f` the logs must add `getState=true` to each API call and then pass the new state every time.\n\nFor example: `.../cachedlogs/categories/nodejs?getState=true&state=4-Li2Msq8PDg8sn9mlxcHEfYBBafBbEB`."},"tz":{"name":"tz","in":"query","required":false,"schema":{"type":"string"},"description":"Enter a standard time zone abbreviation to express the `TIMESTAMP` value in that time zone. For example, enter `EST` or `PST`. By default, the timestamp value is expressed in UTC/GMT time."}}}}
/ organizations / {org_name} / environments / {env_name} / apis / {api_name} / cachedlogs / categories
/ organizations / {org_name} / environments / {env_name} / apis / {api_name} / cachedlogs / categories / {category_name}
Logs API OpenAPI	{"openapi":"3.0.1","info":{"title":"Logs API","description":"View logs aggregated by Apigee API Monitoring. For more information, see <a href=\"https://docs.apigee.com/api-monitoring/logs-api\">View logs using the API</a>.\n","version":"1.0"},"servers":[{"url":"https://apimonitoring.enterprise.apigee.com/"}],"security":[{"OAuth":[]}],"paths":{"/logs":{"get":{"summary":"Get log entries","description":"Gets traffic metrics. \n\n\nBy default, the API returns the most recent 10 logs for the previous hour. Use the `from`, `to`, and `timeRange` query parameters to specify a different duration. The `from` and `to` query paramaters use an ISO formatted time range. The date format can be either:\n\n\n* `yyyy-mm-ddThh:mm:ssZ`\n* `yyyy-mm-ddThh:mm:ss+00:00`\n \n\nThe `timeRange` query parameter value supports the following formats:\n\n* `-<value><unit>` specifes a time in the past (note the leading hyphen):\n * `<value>` – an integer\n * `<unit>` – a time unit of: `s`, `sec`, `second`, `m`, `min`, `minute`, `h`, `hr`, `hour`, `d`, `day`\n \n \nFor example:\n\n* `1h`\n* `10min`\n\n\nYou can specify either `from` or `timeRange` but not both.\n\n\nThis API also defines query paramaters that you can use to filter the results by API proxy, region, fault flow, and other options.\n \n \n**Note**: You can call this API at most **six times per minute**. \n\n\nFor more information and examples of this API, see\n[View logs using the API](https://docs.apigee.com/api-monitoring/logs-api).\n","parameters":[{"$ref":"#/components/parameters/org"},{"$ref":"#/components/parameters/env"},{"$ref":"#/components/parameters/proxy"},{"$ref":"#/components/parameters/from"},{"$ref":"#/components/parameters/to"},{"$ref":"#/components/parameters/timeRange"},{"$ref":"#/components/parameters/select"},{"$ref":"#/components/parameters/source"},{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/region"},{"$ref":"#/components/parameters/flow"},{"$ref":"#/components/parameters/policy"},{"$ref":"#/components/parameters/status"},{"$ref":"#/components/parameters/faultcode"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","description":"Log entries.","items":{"$ref":"#/components/schemas/Log"}}}}},"default":{"description":"Unexpected error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/logs/apiproxies":{"get":{"summary":"Get proxies for virtual host and base path","description":"Get the list of API proxies associated with a specific virtual host and base path.\n\n\n**Note**: You can call this API at most **six times per minute**.\n\n\nA virtual host on an Edge Router lets you specify a domain name, protocol such as HTTP/HTTPS, and port number. For example, you define a virtual host on an Edge Router with the following settings:\n\n\n```\nhost alias = apis.acme.com\nport = 443\nTLS enabled\n```\n\n\nBased on these settings, a request to an API proxy associated with this virtual host uses the form:\n\n`https://apis.acme.com/proxy-base-path/resource-path`\n\n\nWhere:\n\n\n* `proxy-base-path` is defined when you create an API proxy and is unique for each API proxy.\n* `resource-path` is the path to a resource accessible through the API proxy.\n\n\nFor more on virtual hosts, see <a href=\"https://docs.apigee.com/api-platform/fundamentals/virtual-hosts\">About virtual hosts</a>. For more information and examples of this API, see <a href=\"https://docs.apigee.com/api-monitoring/logs-api\">View logs using the API</a>.\n","parameters":[{"$ref":"#/components/parameters/org"},{"$ref":"#/components/parameters/env"},{"$ref":"#/components/parameters/select"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","description":"List of API proxies","items":{"type":"string"}}}}},"default":{"description":"Unexpected error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}}},"components":{"securitySchemes":{"OAuth":{"type":"apiKey","name":"Authorization","in":"header","description":"For OAuth, enter the following in the Key field: Bearer %your-token% To get a token, see https://docs.apigee.com/api-platform/system-administration/using-oauth2#get-the-tokens"}},"parameters":{"org":{"name":"org","in":"query","description":"Organization name.","required":true,"schema":{"type":"string"}},"env":{"name":"env","in":"query","description":"Filter events by the specified environment.","required":false,"schema":{"type":"string"}},"proxy":{"name":"proxy","in":"query","description":"Filter metrics by the specified API proxy name. Specify multiple values as a comma-separated list.","schema":{"type":"string"}},"from":{"name":"from","in":"query","description":"Start of the time interval for which alerts should be fetched. Defaults to the current time minus one hour. Required for latency metrics.\n","required":false,"schema":{"type":"string","default":"-1h"}},"to":{"name":"to","in":"query","description":"End of the time interval for which alerts should be fetched. Defaults to the\n current time. See the description above about setting this parameter.\n","required":false,"schema":{"type":"string","default":"now"}},"timeRange":{"name":"timeRange","in":"query","description":"Duration prior to the to time for which log entries are fetched. You can specify either from or timeRange but not both.\n","required":false,"schema":{"type":"string","default":"now"}},"select":{"name":"select","in":"query","description":"Filter returned logs by HTTP status codes or API proxy URI. Supported HTTP status values are: `2xx`, `4xx`, `5xx`. Specify multiple values as a comma-separated list. The `status` query parameter lets you specify an explicit HTTP status codes in the form: `201`, `404`, `501`.","schema":{"type":"string"}},"source":{"name":"source","in":"query","description":"Source of errors for which logs should be returned. Supported values are: `proxy`, `target`, or `apigee`. By default, logs from all sources are returned.","required":false,"schema":{"type":"string"}},"limit":{"name":"limit","in":"query","description":"Number of log entries that will be returned. The maximum value is 1000. Defaults to 10.","required":false,"schema":{"type":"string"}},"region":{"name":"region","in":"query","description":"Filter events by the specified region.","required":false,"schema":{"type":"string"}},"flow":{"name":"flow","in":"query","description":"Filter events by the specified fault flow.","required":false,"schema":{"type":"string"}},"policy":{"name":"policy","in":"query","description":"Filter events by the specified fault policy.","required":false,"schema":{"type":"string"}},"status":{"name":"status","in":"query","description":"Filter log entries by the specified HTTP status code. For example, `201`, `404`, or `501`. Specify multiple values as a comma-separated list. The `select` query parameter lets you specify a range of HTTP status codes in the form: `2xx`, `4xx`, `5xx`.","required":false,"schema":{"type":"string"}},"faultcode":{"name":"faultcode","in":"query","description":"Filter log entries by the specified fault code.","required":false,"schema":{"type":"string"}}},"schemas":{"Log":{"type":"object","properties":{"request":{"type":"string","description":"Request details.\n"},"request_length":{"type":"integer","description":"Length of the request.\n"},"request_message_id":{"type":"string","description":"Request message ID.\n"},"virtual_host":{"type":"string","description":"Virtual host details.\n"},"response_size":{"type":"integer","description":"Size of the response.\n"},"response_time":{"type":"number","description":"Length of time for the response. \n"},"response_status":{"type":"string","description":"HTTP status of the response.\n"},"timestamp":{"type":"string","description":"Response timestamp in ISO format.\n"},"fault_code":{"type":"string","description":"Fault code returned.\n"},"fault_flow":{"type":"string","description":"Fault flow.\n"},"fault_policy":{"type":"string","description":"Fault policy.\n"},"fault_proxy":{"type":"string","description":"API proxy associated with the fault.\n"},"fault_source":{"type":"string","description":"Source of the fault, such as `target`.\n"}},"example":{"request":"GET /v1/o/myorg/z HTTP/1.1","request_length":1349,"request_message_id":"rrt-0623eb157b650315c-c-ne-7785-16029140-1","virtual_host":"api.example.com","response_size":144,"response_time":0.551,"response_status":"404","timestamp":"2018-08-14T17:31:07Z","fault_code":"messaging.adaptors.http.flow.ErrorResponseCode","fault_flow":"-","fault_policy":"null/null","fault_proxy":"/organizations/myorg/environments/prod/apiproxies/myAPI/revisions/50","fault_source":"target"}},"Error":{"type":"object","properties":{"error":{"type":"string","description":"Error message"}}}}}}
/ logs
/ logs / apiproxies
Environments API OpenAPI	{"openapi":"3.0.0","servers":[{"url":"https://api.enterprise.apigee.com/v1"}],"info":{"title":"Environments API","description":"By default, Apigee organizations are provisioned with two environments: `test` and `prod`. An environment provides a runtime execution context for APIs. An API revision must be deployed to an environment before it can be accessed at runtime. No constraints are placed on the usage between different environments (`test` versus `prod`, for example). Developers are free to implement and enforce any type or testing, promotion, and deployment procedures that suit their development lifecycle.","version":"1.0"},"security":[{"Basic":[]},{"OAuth":[]}],"paths":{"/organizations/{org_name}/environments":{"post":{"tags":["Environment"],"summary":"Create environment","description":"Creates an environment in an existing organization.\n\n**Notes**:\n* **Apigee Edge for Private Cloud only**. If you are using Apigee Edge for Public Cloud, contact Apigee Support for assistance.\n* **This API cannot be executed using the Try this API panel**.\n\n\nAfter you create the environment, you must:\n\n* Associate the environment with one or more Message processors. See <a href=\"/docs/environments/1/routes/organizations/%7Borg_name%7D/environments/%7Benv_name%7D/servers/post\">Associate an environment with a Message Processor</a>. \n* Enable analytics on the environment. See <a href=\"/docs/analytics/1/routes/organizations/%7Borg_name%7D/environments/%7Benv_name%7D/analytics/admin/post\">Enable analytics for an environment</a>.\n\nEdge provides scripts and other tools that you can use as an alternative to making API calls directly. For example, see <a href=\"https://docs.apigee.com/private-cloud/latest/creating-organization-environment-and-virtual-host\">Creating an organization, environment, and virtual host</a>.","operationId":"createEnvironment","parameters":[{"$ref":"#/components/parameters/org_name"}],"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Environment"}}}},"400":{"description":"Bad request"}},"requestBody":{"description":"Environment details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Environment"}}}}},"get":{"tags":["Environment"],"summary":"List environments","description":"Lists all environments in an organization. By default, an Apigee organization contains two environments: `test` and `prod`\n\n**Note**: The <strong>portal</strong> environment is available for configuring custom domains on the integrated portal. See <a href=\"https://docs.apigee.com/api-platform/publish/portal/custom-domain\">Customize your domain</a>. ","operationId":"listEnvironments","parameters":[{"$ref":"#/components/parameters/org_name"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}}},"400":{"description":"Bad request"}}}},"/organizations/{org_name}/environments/{env_name}":{"post":{"tags":["Environment"],"summary":"Update an environment","description":"Updates an existing environment.\n\n**Notes**:\n* **Apigee Edge for Private Cloud only**. If you are using Apigee Edge for Public Cloud, contact Apigee Support for assistance.\n* **This API cannot be executed using the Try this API panel**.\n* If you have set properties on the environment and want to update one or more of those properties, you must pass all properties to the API, even if they are not being changed. To get the current list of properties for the environment, use the <a href=\"/docs/environments/1/routes/organizations/%7Borg_name%7D/environments/%7Benv_name%7D/get\">Get environment details</a>. ","operationId":"updateEnvironment","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/env_name"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Environment"}}}},"400":{"description":"Bad request"}}},"delete":{"tags":["Environment"],"summary":"Delete an environment","description":"Deletes an environment.\n\n**Notes**:\n* **Apigee Edge for Private Cloud only**. If you are using Apigee Edge for Public Cloud, contact Apigee Support for assistance.\n* **This API cannot be executed using the Try this API panel**.Deletes an environment, \n\nYou can only delete an environment after you have:\n\n* Deleted all virtual hosts in the environment. See <a href=\"/docs/virtualhosts/1/routes/organizations/%7Borg_name%7D/environments/%7Benv_name%7D/virtualhosts/%7Benv_name%7/delete\">Delete a virtual host</a>.\n\n* Disassociated the environment from all Message Processors. See <a href=\"/docs/environments/1/routes/organizations/%7Borg_name%7D/environments/%7Benv_name%7D/servers/post\">Disassociate an environment from a Message Processor</a>.\n\n* Cleaned up analytics. See <a href=\"/docs/analytics/1/routes/analytics/groups/%7Bgroup_name%7D/scopes/delete\">Remove analytics information about an environment</a>.","operationId":"deleteEnvironment","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/env_name"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Environment"}}}},"400":{"description":"Bad request"}}},"get":{"tags":["Environment"],"summary":"Get Environment Details","description":"Gets environment details, including:\n\n* UNIX times at which the environment was created and last modified\n* Email address of the Apigee user who created and last modified the environment\n* List of property names and values that are reserved for use by Apigee","operationId":"getEnvironment","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/env_name"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Environment"}}}},"400":{"description":"Bad request"}}}},"/organizations/{org_name}/environments/{env_name}/servers":{"post":{"tags":["Environment","API Proxy","Servers"],"summary":"Associate or disassociate an environment and a Message Processor","description":"Associates or disassociates an environment and a Message Processor.\n \n \n**Notes**:\n* **Apigee Edge for Private Cloud only**. If you are using Apigee Edge for Public Cloud, contact Apigee Support for assistance.\n* **This API cannot be executed using the Try this API panel**.\n\n**Associate an environment with a Message Processor**\n\nAfter you <a href=\"/docs/environments/1/routes/organizations/%7Borg_name%7D/environments/post\">create an environment</a>, you must associate it with one or more Message Processors. You must call this API for each Message Processor associated with the environment. \n\nTo call the API, you need the UUID of the Message Processor. Use the following cURL command to obtain that UUID:\n\n`curl http://<mp-ip>:8082/v1/servers/self`\n\nWhere `<mp-ip>` is the IP address of the Message Processor.\n\n**Disassociate an environment from a Message Processor**\n\nBefore you can <a href=\"/docs/environments/1/routes/organizations/%7Borg_name%7D/environments/%7Benv_name%7D/delete\">delete an environment</a>, you must disassociate it from all Message Processors. You must call this API for each Message Processor associated with the environment. \n\nTo determine the list of Message Processor UUIDs associate with the environment, use Get servers associated with an environment.\n\nThe request body must contain:\n```\naction=remove&uuid={MP_UUID}\n````\n\nwhere `MP_UUID` is the UUID of the Message Processor. For example, in a cURL command, the request would appear as:\n\n```\ncurl -X POST http://<MS_IP>:8080/v1/organizations/{org_name}/environments/{env_name}/servers -d \"action=remove&uuid=MP_UUID\" \\\n -H \"Content-Type:application/x-www-form-urlencoded\" \\\n -u sysAdminEmail:pWord \n \n```\n \n\nwhere `MS_IP` is the IP address or DNS name of the Edge Server.","operationId":"associateDisassociateEnvironmentMP","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/env_name"}],"responses":{"200":{"description":"OK"},"400":{"description":"Bad request"}}},"get":{"tags":["Environment","API Proxy","Servers"],"summary":"List servers associated with an environment","description":"Lists the UUIDs of the Message Processors associated with the environment.\n\n**Notes**:\n* **Apigee Edge for Private Cloud only**. If you are using Apigee Edge for Public Cloud, contact Apigee Support for assistance.\n* **This API cannot be executed using the Try this API panel**.","operationId":"listServersEnvironment","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/env_name"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}}},"400":{"description":"Bad request"}}}}},"components":{"securitySchemes":{"Basic":{"type":"http","scheme":"basic","description":"Multi-factor authentication is not supported."},"OAuth":{"type":"apiKey","name":"Authorization","in":"header","description":"For OAuth, enter the following in the Key field: Bearer %your-token% (see https://docs.apigee.com/api-platform/system-administration/using-oauth2#get-the-tokens)"}},"parameters":{"org_name":{"in":"path","name":"org_name","required":true,"schema":{"type":"string"},"description":"Organization name."},"env_name":{"in":"path","name":"env_name","required":true,"schema":{"type":"string"},"description":"Environment name."}},"schemas":{"Environment":{"description":"Environment details.","type":"object","required":["name"],"properties":{"createdAt":{"format":"int32","description":"Output only. Time the environment was created in milliseconds since epoch.","type":"integer"},"createdBy":{"description":"Output only. Email address of the admin that created the environment.","type":"string"},"description":{"type":"string","description":"Description of the environment."},"lastModifiedAt":{"format":"int32","description":"Output only. Time the environment was last modified in milliseconds since epoch.","type":"integer"},"lastModifiedBy":{"description":"Output only. Email of admin that last modified the environment.","type":"string"},"name":{"description":"Name of the environment. Valid characters include: `a-zA-Z0-9._\\-$ %`.","type":"string"},"properties":{"description":"List of properties that can be used to customize the environment.","type":"object","properties":{"property":{"description":"Environment property names and values.","type":"array","items":{"type":"object","properties":{"name":{"description":"Name of property.","type":"string"},"value":{"description":"Set to `\"true\"` to enable or `\"false\"` to disable the property.","type":"string"}}}}}}},"example":{"createdAt":1394486446988,"createdBy":"noreply_admin@apigee.com","displayName":"myorg","lastModifiedAt":1590113466345,"lastModifiedBy":"admin@example.com","name":"test","properties":{"property":[{"name":"useSampling","value":100},{"name":"samplingThreshold","value":100000}]}}}}}}
/ organizations / {org_name} / environments
/ organizations / {org_name} / environments / {env_name}
/ organizations / {org_name} / environments / {env_name} / servers
Analytics API OpenAPI	{"openapi":"3.0.0","servers":[{"url":"https://api.enterprise.apigee.com/v1"}],"info":{"title":"Analytics API","description":"Use Apigee Edge Analytics.","version":"1.0"},"security":[{"Basic":[]},{"OAuth":[]}],"paths":{"/analytics/groups/ax/{group_name}/scopes":{"delete":{"tags":["Analytics"],"summary":"Remove analytics information about an environment","description":"Remove analytics information for an environment. You must remove analtyics information before you can delete an environment.\n\n**Notes**:\n* **Apigee Edge for Private Cloud only**. If you are using Apigee Edge for Public Cloud, contact Apigee Support for assistance.\n* **This API cannot be executed using the Try this API panel**.\n\nBy default, the name of the analytics group is `analytics-001`. If you need to determine the group name, you can use the following curl command:\n```\ncurl -u sysAdminEmail:password \"http://<MS_IP>:8080/v1/analytics/groups/ax\"\n```\n\nwhere `sysAdminEmail:password` is the email address and password of the system administrator, and `MS_IP` is the IP address or DNS name of the Edge Management Server.","operationId":"deleteAnalytics","parameters":[{"$ref":"#/components/parameters/group_name"},{"$ref":"#/components/parameters/org"},{"$ref":"#/components/parameters/env"}],"responses":{"200":{"description":"OK"},"400":{"description":"Bad request"}}}},"/organizations/{org_name}/environments/{env_name}/analytics/admin":{"post":{"tags":["Analytics"],"summary":"Enable analytics for an environment","description":"Enables analytics for an environment.\n\n**Notes**:\n* **Apigee Edge for Private Cloud only**. If you are using Apigee Edge for Public Cloud, contact Apigee Support for assistance.\n* **This API cannot be executed using the Try this API panel**.\n\nAfter you <a href=\"/docs/environments/1/routes/organizations/%7Borg_name%7D/environments/post\">create an environment</a>, you can enable analytics for the environment. If you wish to enable analytics for one environment, you must enable analytics for all environments in the organization.\n\nYou must pass the entries for Analtyics onboarding in a file named `sample.json`. For example:\n\n```\n{\n \"properties\" : {\n \"samplingAlgo\" : \"reservoir_sampler\",\n \"samplingTables\" : \"10=ten;1=one;\",\n \"aggregationinterval\" : \"300000\",\n \"samplingInterval\" : \"300000\",\n \"useSampling\" : \"100\",\n \"samplingThreshold\" : \"100000\"\n },\n \"servers\" : {\n \"postgres-server\" : [ \"1acff3a5-8a6a-4097-8d26-d0886853239c\", \"f93367f7-edc8-4d55-92c1-2fba61ccc4ab\" ],\n \"qpid-server\" : [ \"d3c5acf0-f88a-478e-948d-6f3094f12e3b\", \"74f67bf2-86b2-44b7-a3d9-41ff117475dd\"]\n }\n}\n```\nThe `postgres-servers` property contains a comma-separated list of the Postgres UUIDs, and the `qpid-server` property contains the Qpid UUIDs. If you need to obtain these UUIDs, use the following commands.\n\n\n For Qpid, run the following command:\n\n\n ```\n curl -u <sysAdminEmail>:<passwd> http://<ms-ip>/v1/servers?pod=central\n ```\n\nThe output of this command is a JSON object. For each Qpid server, you will see output in the form:\n\n``` \"type\" : [ \"qpid-server\" ],\n\"uUID\" : \"d3c5acf0-f88a-478e-948d-6f3094f12e3b\"\n```\n\nFor Postgres, run the following command:\n```\ncurl -u <sysAdminEmail>:<passwd> http://<ms-ip>/v1/servers?pod=analytics\n```\n\nFor each Postgres server, you will see output in the form:\n\n``` \"type\" : [ \"postgres-server\" ],\n\"uUID\" : \"d3c5acf0-f88a-478e-948d-6f3094f12e3b\"\n```\n\nIf you are using Edge for Private Cloud 4.16.01 or later, rather than use the API call, use the following command to enable Analytics:\n\n```\n/<inst_root>/apigee/apigee-service/bin/apigee-service apigee-provision enable-ax -f configFile\n```\nWhere `configFile` contains:\n```\nORG_NAME=orgName # lowercase only, no spaces, underscores, or periods.\nENV_NAME=envName\nADMIN_EMAIL=adminEmail\nAPIGEE_ADMINPW=adminPWord\n```","operationId":"enableAnalytics","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/env_name"}],"requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"file":{"type":"string","format":"binary","description":"File named `sample.json` that contains entires for onboarding."}}}}}},"responses":{"200":{"description":"OK"},"400":{"description":"Bad request"}}}},"/organizations/{org_name}/environments/{env_name}/analytics/exports":{"post":{"tags":["Analytics","Data Exports"],"summary":"Create an analytics data export job","description":"Creates an analytics data export job.\n\nThe API returns the data export job ID that you use to track the status of the job. You must be in the role of organization administrator to call this API.\n\n\n**Note** Free and trial accounts cannot export analytics data. For more information on Edge pricing plans, see <a href=\"https://cloud.google.com/apigee/pricing\">Apigee pricing plans</a>.\n\nTo export data from an organization that supports monetization, specify `\"dataset\":\"mint\"`. The organization must support monetization to set this option, otherwise omit this property.\n\nSee <a href=\"https://docs.apigee.com/api-platform/analytics/export-data\">Export data from Analytics</a> for more information and examples.\n\n**Export API quotas**\n\nTo prevent overuse of expensive data export API calls, Edge enforces a quota on calls to this API:\n\n* For organizations and environments that **do not have monetization** enabled, the quota is 70 calls per month per organization/environment. For example, if you have two environments in your organization, `prod` and `test`, you can make 70 API calls per month for each environment.\n\n* For organizations and environments **with monetization enabled**, the quota is:\n\n * 70 calls per month for each organization and environment for standard data\n * 70 calls per month for each organization and environment for monetization data\n\n\n For example, if you enable monetization on your `prod` organization, you can make 70 API calls for standard data and 70 additional API calls for monetization data.\n\n\nIf you exceed the call quota, this API returns an `HTTP 429` response.","operationId":"createDataExport","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/env_name"}],"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Export"},"example":{"self":"/v1/organizations/myorg/environments/test/analytics/exports/4d6d94ad-a33b-4572-8dba-8677c9c4bd98","name":"Export results To Cloud Storage","description":"One-time export to Google Cloud Storage","userId":"my@email.com","datastoreName":"My Cloud Storage data store","executionTime":"36 seconds","created":"2018-09-28T12:39:35Z","updated":"2018-09-28T12:39:42Z","state":"enqueued"}}}},"400":{"description":"Bad request"}},"requestBody":{"description":"Data export request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExportRequest"},"example":{"datastoreName":"My Cloud Storage data repository","dateRange":{"start":"2018-06-08","end":"2018-06-09"},"description":"Export raw results to Cloud Storage for last 24 hours","name":"Export raw results to Cloud Storage","outputFormat":"json"}}}}},"get":{"tags":["Analytics","Data Exports"],"summary":"Get a list of analytics data export jobs","description":"Gets a list of all analytics data export jobs created for an organization and environment. The response provides links to get status of individual jobs. See <a href=\"https://docs.apigee.com/api-platform/analytics/export-data\">Export data from Analytics</a> for more information and examples.","operationId":"getDataExportJobs","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/env_name"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","description":"List of data export jobs, including status.","items":{"$ref":"#/components/schemas/Export"}},"example":{"self":"/v1/organizations/myorg/environments/test/analytics/exports/4d6d94ad-a33b-4572-8dba-8677c9c4bd98","name":"Export results To Cloud Storage","description":"One-time export to Google Cloud Storage","userId":"my@email.com","datastoreName":"My Cloud Storage data store","executionTime":"36 seconds","created":"2018-09-28T12:39:35Z","updated":"2018-09-28T12:39:42Z","state":"enqueued"}}}},"400":{"description":"Bad request"}}}},"/organizations/{org_name}/environments/{env_name}/analytics/exports/{export_id}":{"get":{"tags":["Analytics","Data Exports"],"summary":"Get analytics data export job status","description":"Gets the status of an analytics data export job. Create an export job using the Create an analytics data export job API.\n\nThe `state` property specifies the status of the job and can have one of the following values: `enqueued`, `running`, `completed`, `failed`\n\nSee <a href=\"https://docs.apigee.com/api-platform/analytics/export-data\">Export data from Analytics</a> for more information and examples.","operationId":"getDataExportJobs","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/env_name"},{"$ref":"#/components/parameters/export_id"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Export"},"example":{"self":"/v1/organizations/myorg/environments/test/analytics/exports/4d6d94ad-a33b-4572-8dba-8677c9c4bd98","name":"Export results To Cloud Storage","description":"One-time export to Google Cloud Storage","userId":"my@email.com","datastoreName":"My Cloud Storage data store","executionTime":"36 seconds","created":"2018-09-28T12:39:35Z","updated":"2018-09-28T12:39:42Z","state":"enqueued"}}}},"400":{"description":"Bad request"}}}},"/organizations/{org_name}/environments/{env_name}/queries":{"post":{"tags":["Analytics"],"summary":"Create an asynchronous analytics query","description":"Creates an asynchronous analytics query.\n\n\n You must be an organization administrator to call this API. You can make up to seven calls per hour to this API. If you exceed the call quota, this API returns an `HTTP 429` response.\n\n\n**Note**: Free and trial accounts cannot create asynchronous reports. For more information on Edge pricing plans, see\n <a href=\"https://cloud.google.com/apigee/pricing\">Apigee pricing plans</a>.\n\n\nSee <a href=\"https://docs.apigee.com/api-platform/analytics/asynch-reports-api\">Use the asynchronous custom reports API</a> for more information and examples.","operationId":"getDataExportJobs","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/env_name"}],"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Query"},"example":{"self":"/organizations/myorg/environments/myenv/queries/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd","created":"2018-05-10T07:11:10Z","state":"enqueued","error":"false"}}}},"400":{"description":"Bad request"}},"requestBody":{"description":"Asynchronous analytics query request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryRequest"},"example":{"metrics":[{"name":"message_count","function":"sum","alias":"sum_txn"}],"dimensions":["apiproxy"],"timeRange":"last24hours","limit":14400,"filter":"(message_count ge 0)"}}}}},"get":{"tags":["Analytics"],"summary":"Lists asynchronous analytics queries","description":"Lists the asynchronous analytics queries for an environment.","operationId":"listAsynchronousAnlayticsQueries","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/env_name"},{"$ref":"#/components/parameters/submittedBy"},{"$ref":"#/components/parameters/status"},{"$ref":"#/components/parameters/dataset"},{"$ref":"#/components/parameters/inclQueriesWithoutReport"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","description":"List of asynchronous analytics queries.","items":{"$ref":"#/components/schemas/Query"}},"example":{"self":"/organizations/myorg/environments/test/queries/b23415d7-edd0-4c84-99e4-e4dc790f723b","state":"completed","userId":"ahamilton@example.com","result":{"self":"/organizations/myorg/environments/test/queries/b23415d7-edd0-4c84-99e4-e4dc790f723b/result","expires":"2020-10-13T19:46:44Z"},"resultFileSize":"0.02 KB","resultRows":"0","executionTime":"10 seconds","queryParams":{"dimensions":["apiproxy"],"endTimestamp":"2020-10-06T19:46:30.006Z","metrics":["name:message_count,func:sum,alias:sum_txn"],"startTimestamp":"2020-10-05T19:46:30.006Z"},"created":"2020-10-06T19:46:30Z","updated":"2020-10-06T19:46:44Z"}}}},"400":{"description":"Bad request"}}}},"/organizations/{org_name}/environments/{env_name}/queries/{queryId}":{"get":{"tags":["Analytics"],"summary":"Get status of an asychronous analytics query","description":"Gets the status of an asynchronous analytics query.\nObtain the `queryId` when you created the query by using the <a href=\"https://docs-edgeapis.apigee.io/docs/analytics/1/routes/organizations/%7Borg_name%7D/environments/%7Benv_name%7D/queries/post\">Create an asynchronous analytics query API</a>.\n\nIn the response, the value of the state property contains the query status as either `running` or `completed`.\n\nSee <a href=\"https://docs.apigee.com/api-platform/analytics/asynch-reports-api\">Use the asynchronous custom reports API</a> for more information and examples.","operationId":"getDataExportJobs","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/env_name"},{"$ref":"#/components/parameters/queryId"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Query"},"example":{"self":"/organizations/myorg/environments/myenv/queries/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd","state":"completed","result":{"self":"/organizations/myorg/environments/myenv/queries/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd/result","expires":"2017-05-22T14:56:31Z"},"resultRows":1,"resultFileSize":"922KB","executionTime":"11 sec","created":"2018-05-10T07:11:10Z","updated":"2018-05-10T07:13:22Z"}}}},"400":{"description":"Bad request"}}}},"/organizations/{org_name}/environments/{env_name}/queries/{queryId}/result":{"get":{"tags":["Analytics"],"summary":"Get results of an asychronous analytics query","description":"Gets the results of an asynchronous analytics query.\nThe `status` value must be set to `completed`.\nIf the request succeeds, and there is a non-zero result set, the result is downloaded to the client as a zipped JSON (newline-delimited) file. The name of the downloaded file will be: `OfflineQueryResult-<query-id>.zip`\n\nFor example: `OfflineQueryResult-9cfc0d85-0f30-46d6-ae6f-318d0cb961bd.zip`\n\n**Notes**:\n* A zip file is downloaded because for very large files it takes Edge a long time to combine the results. Thus, for performance reasons, Edge returns a zip file consisting of the result parts.\n* **Currently, this API cannot be executed using the Try this API panel**.\n\nObtain the `queryId` when you created the query by using the <a href=\"https://docs-edgeapis.apigee.io/docs/analytics/1/routes/organizations/%7Borg_name%7D/environments/%7Benv_name%7D/queries/post\">Create an asynchronous analytics query API</a>.\n\nSee <a href=\"https://docs.apigee.com/api-platform/analytics/asynch-reports-api\">Use the asynchronous custom reports API</a> for more information and examples.","operationId":"getDataExportJobs","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/env_name"},{"$ref":"#/components/parameters/queryId"}],"responses":{"200":{"description":"OK"},"400":{"description":"Bad request"}}}}},"components":{"securitySchemes":{"Basic":{"type":"http","scheme":"basic","description":"Multi-factor authentication is not supported."},"OAuth":{"type":"apiKey","name":"Authorization","in":"header","description":"For OAuth, enter the following in the Key field: Bearer %your-token% (see https://docs.apigee.com/api-platform/system-administration/using-oauth2#get-the-tokens)"}},"parameters":{"org_name":{"in":"path","name":"org_name","required":true,"schema":{"type":"string"},"description":"Organization name."},"env_name":{"in":"path","name":"env_name","required":true,"schema":{"type":"string"},"description":"Environment name."},"export_id":{"in":"path","name":"export_id","required":true,"schema":{"type":"string"},"description":"ID of the data export job."},"queryId":{"in":"path","name":"queryId","required":true,"schema":{"type":"string"},"description":"ID of the asynchronous analytics query."},"group_name":{"in":"path","name":"group_name","required":true,"schema":{"type":"string"},"description":"Group name."},"dimension_name":{"in":"path","name":"dimension_name","required":true,"schema":{"type":"string"},"description":"Dimension name."},"org":{"in":"query","name":"org","required":true,"schema":{"type":"string"},"description":"Name of the organization."},"env":{"in":"query","name":"env","required":true,"schema":{"type":"string"},"description":"Name of the environment."},"submittedBy":{"in":"query","name":"submittedBy","required":false,"schema":{"type":"string"},"description":"Filter response by email address of user who submitted the queries."},"status":{"in":"query","name":"status","required":false,"schema":{"type":"string"},"description":"Filter response list by asynchronous query status."},"dataset":{"in":"query","name":"dataset","required":false,"schema":{"type":"string"},"description":"Filter response list by dataset type, `api` or` mint`. By default, all datasets are returned."},"inclQueriesWithoutReport":{"in":"query","name":"inclQueriesWithoutReport","required":false,"schema":{"type":"string"},"description":"If `true`, include asynchronous queries that don't have a report definition."}},"schemas":{"ExportRequest":{"description":"Details for data export.","type":"object","required":["name","dateRange","outputFormat","datastoreName"],"properties":{"csvDelimiter":{"type":"string","description":"Delimiter used in the CSV output file, if `outputFormat` is set to `csv`."},"dateRange":{"type":"object","description":"Start and end time of the data to export in the format `yy-mm-dd`. For example:\n\n```\n\"dateRange\": {\n \"start\": \"2018-07-29\",\n \"end\": \"2018-07-30\"\n}\n```\nThe `dateRange` value can only span one day. The date range begins at 00:00:00 UTC on the start date and ends at 00:00:00 UTC on the end date.","properties":{"start":{"type":"string","description":"Start time in the format `yy-mm-dd`."},"end":{"type":"string","description":"End time in the format `yy-mm-dd`."}}},"dataset":{"type":"string","description":"To export data from an organization that supports monetization, specify `\"dataset\":\"mint\"`. You must set this property for organizations that support monetization; otherwise omit this property."},"datastoreName":{"type":"string","description":"Name of the data store containing the definition of your data store. The data store defines the connection to your export data repository (GCS, BigQuery), including the credentials used to access the data repository. You must create the data store in the Edge UI. See <a href=\"https://docs.apigee.com/api-platform/analytics/export-data#create-a-data-store\">Create a data store</a>."},"description":{"type":"string","description":"Description of the data export request."},"name":{"type":"string","description":"Name of the data export request."},"outputFormat":{"type":"string","description":"Format of the response. Set to `json` or `csv`."}}},"QueryRequest":{"description":"Details for asynchronous analytics query.","type":"object","properties":{"csvDelimiter":{"type":"string","description":"Delimiter used in the CSV output file, if `outputFormat` is set to `csv`. Defaults to the `,` (comma) character. Supported delimiter characters include comma (`,`), pipe (`|`), and tab (`\\t`)."},"timeRange":{"description":"Start and end time of the asynchronous analytics query.\nYou can use the following predefined strings to specify the time range: `last60minutes`, `last24hours`, `last7days`. Or, you can specify the timeRange as a structure describing start and end timestamps in the ISO format: `yyyy-mm-ddThh:mm:ssZ`. For example:\n\n```\n\"timeRange\": {\n \"start\": \"2018-07-29T00:13:00Z\",\n \"end\": \"2018-08-01T00:18:00Z\"\n}\n```","oneOf":[{"type":"string"},{"type":"object","properties":{"start":{"type":"string","description":"Start time in ISO format: `yyyy-mm-ddThh:mm:ssZ`."},"end":{"type":"string","description":"End time in ISO format: `yyyy-mm-ddThh:mm:ssZ`."}}}]},"metrics":{"type":"array","description":"List of metrics. You can specify one or more metrics for a query.","items":{"type":"object","required":["name"],"properties":{"name":{"type":"string","description":"Name of the metric. For a list of valid metrics, see <a href=\"https://docs.apigee.com/api-platform/analytics/analytics-reference#metrics\">Metrics</a>."},"function":{"type":"string","description":"Aggregation function as `avg`, `min`, `max`, or `sum`. Not all metrics support all aggregation functions. See <a href=\"https://docs.apigee.com/api-platform/analytics/analytics-reference#metrics\">Metrics</a>."},"alias":{"type":"string","description":"Name of the proroperty containing the metric data in the output. If omitted, it defaults to the metric name combined with the name of the aggregation function."},"operator":{"type":"string","description":"Operation to perform on the metric after its value has been calculated. Works with the value property. Supported operations include: `+ - / % *` The operator and value properties define a post-processing operation performed on the metric. For example, if you specify the metric `response_processing_latency`, the metric returns the average response processing latency with a unit of milliseconds. To convert the units to seconds, set the operator to `/` and the value to `1000.0`. See <a href=\"https://docs.apigee.com/api-platform/analytics/analytics-reference\">Analytics metrics, dimensions, and filters reference</a>."},"value":{"type":"string","description":"Value applied to the calculated metric by the specified operator."}}}},"dimensions":{"type":"array","description":"Array of dimensions to group the metrics. For more information, see the list of <a href=\"https://docs.apigee.com/api-platform/analytics/analytics-reference#dimensions\">supported dimensions</a>. You can specify multiple dimensions.","items":{"type":"string"}},"groupByTimeUnit":{"type":"string","description":"Time unit used to group the result set. Valid values include: `second`, `minute`, `hour`, `day`, `week`, or `month`. If a query includes `groupByTimeUnit`, then the result is an aggregation based on the specified time unit and the resultant timestamp does not include milliseconds precision. If a query omits `groupByTimeUnit`, then the resultant timestamp includes milliseconds precision."},"limit":{"type":"integer","description":"Maximum number of rows that can be returned in the result."},"filter":{"type":"string","description":"Boolean expression that can be used to filter data. Filter expressions can be combined using AND/OR terms and should be fully parenthesized to avoid ambiguity. See <a href=\"https://docs.apigee.com/api-platform/analytics/analytics-reference\">Analytics metrics, dimensions, and filters reference</a> for more information on the fields available to filter on. For more information on the tokens that you use to build filter expressions, see <a href=\"https://docs.apigee.com/api-platform/analytics/asynch-reports-api#filter-expression-syntax\">Filter expression syntax</a>."},"outputFormat":{"type":"string","description":"Format of the response. Set to `json` or `csv`. Defaults to `json`."}}},"Export":{"description":"Status of data export job. When you create a data export initially, only the `created`, `self`, and `state` values are returned in the response.","type":"object","properties":{"created":{"type":"string","description":"Date and time the data export request was created."},"datastoreName":{"type":"string","description":"Name of the data store."},"description":{"type":"string","description":"Description of the data export request."},"executionTime":{"type":"string","description":"Time required to execute data export."},"name":{"type":"string","description":"Display name of the data export request."},"self":{"type":"string","description":"URL to access the data export job."},"state":{"type":"string","description":"Status of the data export job. Valid values include: `enqueued`, `running`, `completed`, and `failed`."},"updated":{"type":"string","description":"Date and time the data export request was created."},"userId":{"type":"string","description":"Email address of the user that requested the data export."}}},"Query":{"description":"Status of asynchronous analytics query. When you create an asynchronous analytics query initially, only the `created`, `self`, and `state` values are returned in the response.","type":"object","properties":{"created":{"type":"string","description":"Date and time the asynchronous analytics query was created."},"error":{"type":"string","description":"Flag that specifies whether or not an error was encountered."},"executionTime":{"type":"string","description":"Time required to execute asynchronous analytics query in the ISO format: `yyyy-mm-ddThh:mm:ssZ`."},"result":{"type":"object","description":"Result information. Provided when `state` is set to `completed`.","properties":{"expires":{"type":"string","description":"Date and time the asynchronous analytics query expires in the ISO format: `yyyy-mm-ddThh:mm:ssZ`."},"self":{"type":"string","description":"URL to access the asynchronous analytics query result."}}},"resultFileSize":{"type":"string","description":"File size in KBs of the asynchronous analytics query results. Provided when `state` is set to `completed`."},"resultRows":{"type":"integer","description":"Number of rows in the asynchronous analytics query results. Provided when `state` is set to `completed`."},"self":{"type":"string","description":"URL to access the asynchronous analytics query results."},"state":{"type":"string","description":"Status of the asynchronous analytics query. Valid values include `enqueued`, `running`, and `completed`."},"updated":{"type":"string","description":"Date and time the asynchronous analytics query was created in the ISO format: `yyyy-mm-ddThh:mm:ssZ`."}}}}}}
/ analytics / groups / ax / {group_name} / scopes
/ organizations / {org_name} / environments / {env_name} / analytics / admin
/ organizations / {org_name} / environments / {env_name} / analytics / exports
/ organizations / {org_name} / environments / {env_name} / analytics / exports / {export_id}
/ organizations / {org_name} / environments / {env_name} / queries
/ organizations / {org_name} / environments / {env_name} / queries / {queryId}
/ organizations / {org_name} / environments / {env_name} / queries / {queryId} / result
Metrics API OpenAPI	{"openapi":"3.0.1","info":{"title":"Metrics API","description":"View metrics aggregated by API Monitoring. For more information, see <a href=\"https://docs.apigee.com/api-monitoring/metrics-api\">View metrics data using the API</a>.\n","version":"1.0"},"servers":[{"url":"https://apimonitoring.enterprise.apigee.com/metrics"}],"security":[{"OAuth":[]}],"paths":{"/traffic":{"get":{"summary":"Get traffic metrics","description":"Gets traffic metrics. Specify filters such as proxy name, interval, time window,\ntarget, status code, and many others.\n\n**Setting groupBy and env**\n\n\nThe `groupBy` query parameter specifies how to aggregate metrics. The `env` query parameter filters results by a specific environment name. You must specify either `groupBy` to include the `env` option or specify an environment name using the `env` query parameter. For example:\n\n```\n\ngroupBy=env // env query param is empty\n\n```\n\nor:\n\n```\n\nenv=envName // groupBy query param is empty; envName is the name of the env\n\n```\n\n\n\nYou can specify both query params. For example, the following settings aggregate metrics by environment, region, and organization and filters the results for the environment named `prod`:\n\n```\n\ngroupBy=env,region,org&env=prod\n```\n\n**Setting interval**\n\n\nThe `interval` query parameter specifies the frequency that the metric is saved to the results. Each data point in the metric results is calculated over the preceding `interval` of time.\n\n\nFor example, if `interval` is 10 minutes, then the metric is calcluated over the previous 10 minutes, and written to the results every 10 minutes.\n\n\nThe `interval` query parameter value supports the following format:\n\n * `<value><unit>` where:\n * `<value>` – an integer\n * `<unit>` – a time unit of: `u`, `ms`, `s`, `sec`, `m`, `h`, `d`, `w`\n\nFor example:\n\n * `1m`\n * `10h`\n * `2d`\n\n\n**Setting `to` and `from`**\n\nBy default, the API returns alerts for the previousz hour. Use the `from` and `to` query parameters to specify a different duration.\n\n\nThe `from` and `to` query parameter values support the following formats:\n\n\n * `now` (current time)\n * `-<value><unit>` specifes a time in the past (note the leading hyphen):\n * `<value>` – an integer\n * `<unit>` – a time unit of: `s`, `sec`, `second`, `m`, `min`, `minute`, `h`, `hr`, `hour`, `d`, `day`\n\n * An ISO formatted date as either:\n * `yyyy-mm-ddThh:mm:ssZ`\n * `yyyy-mm-ddThh:mm:ss+00:00`\n\n\nFor example:\n\n * `now`\n * `-1h`\n * `-10min`\n * `2018-08-13T14:04:00+00:00`\n\n\n**Note**: You can call this API at most **six times per minute**.\n\nFor more information and examples of this API, see\n[View metrics data using the API](https://docs.apigee.com/api-monitoring/metrics-api).\n","parameters":[{"$ref":"#/components/parameters/org"},{"$ref":"#/components/parameters/interval"},{"$ref":"#/components/parameters/groupBy"},{"$ref":"#/components/parameters/env"},{"$ref":"#/components/parameters/from"},{"$ref":"#/components/parameters/to"},{"$ref":"#/components/parameters/select"},{"$ref":"#/components/parameters/region"},{"$ref":"#/components/parameters/developerApp"},{"$ref":"#/components/parameters/proxy"},{"$ref":"#/components/parameters/target"},{"$ref":"#/components/parameters/statusCode"},{"$ref":"#/components/parameters/targetStatusCode"},{"$ref":"#/components/parameters/faultCodeName"},{"$ref":"#/components/parameters/faultCodeCategory"},{"$ref":"#/components/parameters/faultCodeSubCategory"},{"$ref":"#/components/parameters/collection"}],"responses":{"200":{"description":"Query results","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MetricsResponse"}}}},"default":{"description":"Unexpected error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/latency":{"get":{"summary":"Get latency metrics","description":"Gets latency metrics for requests to Edge and to backend targets. Specify filters such as proxy name, interval, target, status code, and many others.\n\n\nFor this API:\n\n * You must specify the `percentile` query parameter as `50`, `90`, `95`, or `99`. For example, if you specify `90`, the API returns the total response latency value in the 90th percentile.\n\n**Setting interval**\n\nThe `interval` query parameter defines the update interval for the value in the results, where:\n\n * `interval` specifies the frequency that the metric is saved to the results.\n Must be set to multiples of 60 seconds, with a minimum value of 60 seconds and a\n maximum value of 300 seconds (5 minutes).\n\nThe interval query parameter value supports the following format:\n\n * `<value><unit>` where:\n * `<value>` – an integer\n * `<unit>` – a time unit of: `u`, `ms`, `s`, `sec`, `m`, `h`, `d`, `w`\n\nFor example:\n\n * `1u`\n * `2s`\n * `5m`\n\n\n**Setting `to` and `from`**\n\nBy default, the API returns alerts for the previous hour. Use the `from` and `to` query parameters to specify a different duration.\n\n\nThe `from` and `to` query parameter values support the following formats:\n\n\n * `now` (current time)\n * `-<value><unit>` specifes a time in the past (note the leading hyphen):\n * `<value>` – an integer\n * `<unit>` – a time unit of: `s`, `sec`, `second`, `m`, `min`, `minute`, `h`, `hr`, `hour`, `d`, `day`\n * An ISO formatted date as either:\n * `yyyy-mm-ddThh:mm:ssZ`\n * `yyyy-mm-ddThh:mm:ss+00:00`\n\n\nFor example:\n\n * `now`\n * `-1h`\n * `-10min`\n * `2018-08-13T14:04:00+00:00`\n\n\n**Note**: You can call this API at most **six times per minute**.\n\n\nFor more information and examples of this API, see\n[View metrics data using the API](https://docs.apigee.com/api-monitoring/metrics-api).\n","parameters":[{"$ref":"#/components/parameters/org"},{"$ref":"#/components/parameters/percentile"},{"$ref":"#/components/parameters/interval"},{"$ref":"#/components/parameters/select"},{"$ref":"#/components/parameters/groupBy"},{"$ref":"#/components/parameters/from"},{"$ref":"#/components/parameters/to"},{"$ref":"#/components/parameters/region"},{"$ref":"#/components/parameters/env"},{"$ref":"#/components/parameters/proxy"},{"$ref":"#/components/parameters/target"},{"$ref":"#/components/parameters/collection"}],"responses":{"200":{"description":"Query results","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MetricsResponse"}}}},"default":{"description":"Unexpected error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/targets":{"get":{"summary":"List target domains","description":"Lists target domains for a specific organization and environment.\n\n \n**Note**: You can call this API at most **six times per minute**. \n\n\nFor more information and examples of this API, see\n[View metrics data using the API](https://docs.apigee.com/api-monitoring/metrics-api).\n","parameters":[{"$ref":"#/components/parameters/org"},{"$ref":"#/components/parameters/env"}],"responses":{"200":{"description":"Query results","content":{"application/json":{"schema":{"title":"Array of target endpoints","type":"array","items":{"type":"string","example":"abc.com"}}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/alerthistory":{"get":{"summary":"Get alert history","description":"Gets alert history metrics for a specific organization and time interval.\n\n\nThe maximum duration of the time interval is seven days, meaning you can view alerts only for the past seven days. By default, the API returns alerts for the previous one hour. Use the `from` and `to` query parameters to specify a different duration.\n\n\nThe `from` and `to` query parameter values support the following formats:\n\n\n * `now` (current time)\n * `-<value><unit>` specifes a time in the past (note the leading hyphen):\n * `<value>` – an integer\n * `<unit>` – a time unit of: `s`, `sec`, `second`, `m`, `min`, `minute`, `h`, `hr`, `hour`, `d`, `day`\n * An ISO formatted date as either:\n * `yyyy-mm-ddThh:mm:ssZ`\n * `yyyy-mm-ddThh:mm:ss+00:00`\n\n\nFor example:\n\n * `now`\n * `-1h`\n * `-10min`\n * `2018-08-13T14:04:00+00:00`\n\n\n**Notes**: You can call this API at most **six times per minute**.\n\n\nFor more information and examples of this API, see\n[View metrics data using the API](https://docs.apigee.com/api-monitoring/metrics-api).\n","parameters":[{"$ref":"#/components/parameters/org"},{"$ref":"#/components/parameters/alertId"},{"$ref":"#/components/parameters/from"},{"$ref":"#/components/parameters/to"}],"responses":{"200":{"description":"Query results","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Events"}}}},"default":{"description":"Unexpected error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/alertsummary":{"get":{"summary":"Get alert count","description":"Gets the total count of alerts for an organization and time interval.\n\n\nBy default, the API returns alerts for the previous hour. Use the `from` and `to` query parameters to specify a different duration.\n\n\nThe `from` and `to` query parameter values support the following formats:\n\n\n * `now` (current time)\n * `-<value><unit>` specifes a time in the past (note the leading hyphen):\n * `<value>` – an integer\n * `<unit>` – a time unit of: `s`, `sec`, `second`, `m`, `min`, `minute`, `h`, `hr`, `hour`, `d`, `day`\n * An ISO formatted date as either:\n * `yyyy-mm-ddThh:mm:ssZ`\n * `yyyy-mm-ddThh:mm:ss+00:00`\n\n\nFor example:\n\n * `now`\n * `-1h`\n * `-10min`\n * `2018-08-13T14:04:00+00:00`\n\n\n**Note**: You can call this API at most **six times per minute**.\n\nFor more information and examples of this API, see\n[View metrics data using the API](https://docs.apigee.com/api-monitoring/metrics-api).\n","parameters":[{"$ref":"#/components/parameters/org"},{"$ref":"#/components/parameters/from"},{"$ref":"#/components/parameters/to"}],"responses":{"200":{"description":"Query results","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"event":{"type":"object","properties":{"environment":{"type":"string","description":"Environment name."}}},"count":{"type":"integer","description":"Number of for the environment."}}}}}}},"default":{"description":"Unexpected error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/events":{"get":{"summary":"Get events","description":"Gets all events in an organization for a specified time interval. The list of events includes anomalies detected by Edge and any triggered alerts. The alerts can include both fixed and anomaly alerts.\n\nThe `from` and `to` query parameter values support the following formats:\n\n\n * `now` (current time)\n * `-<value><unit>` specifes a time in the past (note the leading hyphen):\n * `<value>` – an integer\n * `<unit>` – a time unit of: `s`, `sec`, `second`, `m`, `min`, `minute`, `h`, `hr`, `hour`, `d`, `day`\n * An ISO formatted date as either:\n * `yyyy-mm-ddThh:mm:ssZ`\n * `yyyy-mm-ddThh:mm:ss+00:00`\n\n\nFor example:\n\n * `now`\n * `-1h`\n * `-10min`\n * `2018-08-13T14:04:00+00:00`\n\n\n**Note**: You can call this API at most **six times per minute**.\nFor more information and examples of this API, see [View metrics data using the API](https://docs.apigee.com/api-monitoring/metrics-api).","parameters":[{"$ref":"#/components/parameters/org"},{"$ref":"#/components/parameters/from"},{"$ref":"#/components/parameters/to"},{"$ref":"#/components/parameters/alertId"},{"$ref":"#/components/parameters/env"},{"$ref":"#/components/parameters/name"},{"$ref":"#/components/parameters/region"},{"$ref":"#/components/parameters/type"},{"$ref":"#/components/parameters/alertType"},{"$ref":"#/components/parameters/alertSubType"}],"responses":{"200":{"description":"Query results","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Events"}}}}},"default":{"description":"Unexpected error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/alertinstance/{instance_id}":{"get":{"summary":"Get alert instance","description":"Gets information about a triggered alert for an organization.\n\n\nUse the <a href=\"/docs/metrics-api/1/routes/alerthistory/get\">Get alert history API</a> (`/alerthistory`) to return information about triggered alerts, including alert IDs, for an organization.\n\n\n**Note**: You can call this API at most **six times per minute**.\n\n\nFor more information and examples of this API, see\n[View metrics data using the API](https://docs.apigee.com/api-monitoring/metrics-api).\n","parameters":[{"$ref":"#/components/parameters/instance_id"},{"$ref":"#/components/parameters/org"}],"responses":{"200":{"description":"Query results","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Event"}}}},"default":{"description":"Unexpected error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/faultcodenames":{"get":{"summary":"List fault code names","description":"Lists fault code names.\n\n \n**Note**: You can call this API at most **six times per minute**. \n\n\nFor more information and examples of this API, see\n[View metrics data using the API](https://docs.apigee.com/api-monitoring/metrics-api).\n","responses":{"200":{"description":"Query results","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FaultCodeNames"}}}},"default":{"description":"Unexpected error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/faultcodes":{"get":{"summary":"List fault codes","description":"Lists available fault codes.\n\n \n**Note**: You can call this API at most **six times per minute**. \n\n\nFor more information and examples of this API, see\n[View metrics data using the API](https://docs.apigee.com/api-monitoring/metrics\n","responses":{"200":{"description":"Query results","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FaultCodes"}}}},"default":{"description":"Unexpected error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/faultcodecategories":{"get":{"summary":"List fault code categories","description":"Lists available fault code categories.\n\n \n**Note**: You can call this API at most **six times per minute**. \n\n\nFor more information and examples of this API, see\n[View metrics data using the API](https://docs.apigee.com/api-monitoring/metrics-api).\n","responses":{"200":{"description":"Query results","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FaultCodeCategories"}}}},"default":{"description":"Unexpected error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/faultcodesubcategories":{"get":{"summary":"List fault code subcategories","description":"Lists available fault code subcategories.\n\n \n**Note**: You can call this API at most **six times per minute**. \n\n\nFor more information and examples of this API, see\n[View metrics data using the API](https://docs.apigee.com/api-monitoring/metrics-api).\n","responses":{"200":{"description":"Query results","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FaultCodeSubCategories"}}}},"default":{"description":"Unexpected error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/faultcodedetails":{"get":{"summary":"List fault code details","description":"Lists available fault codes with details.\n\n \n**Note**: You can call this API at most **six times per minute**. \n \n\nFor more information and examples of this API, see\n[View metrics data using the API](https://docs.apigee.com/api-monitoring/metrics-api).\n","responses":{"200":{"description":"Query results","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/FaultCodeDetail"}}}}},"default":{"description":"Unexpected error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}}},"components":{"securitySchemes":{"OAuth":{"type":"apiKey","name":"Authorization","in":"header","description":"For OAuth, enter the following in the Key field: Bearer %your-token% (see https://docs.apigee.com/api-platform/system-administration/using-oauth2#get-the-tokens)"}},"parameters":{"instance_id":{"name":"instance_id","in":"path","description":"Alert instance ID","required":true,"schema":{"type":"string"}},"org":{"name":"org","in":"query","description":"Organization name.","required":true,"schema":{"type":"string"}},"from":{"name":"from","in":"query","description":"Start of the time interval for which alerts should be fetched. Defaults to the current time minus one hour. **Required for latency metrics.**\n","required":false,"schema":{"type":"string","default":"-1h"}},"to":{"name":"to","in":"query","description":"End of the time interval for which alerts should be fetched. Defaults to the current time. \n","required":false,"schema":{"type":"string","default":"now"}},"alertId":{"name":"alertId","in":"query","description":"Filter alert history by the specified alert definition ID. To get a list of alert IDs, see <a href=\"/docs/alerts-api/1/routes/alerts/get\">Get alerts</a>.","required":false,"schema":{"type":"string"}},"env":{"name":"env","in":"query","description":"Filter events by the specified environment.","required":false,"schema":{"type":"string"}},"region":{"name":"region","in":"query","description":"Filter events by the specified region.","required":false,"schema":{"type":"string"}},"type":{"name":"type","in":"query","description":"Filter events by the specified type. Valid values include `alert` and `anomaly`.","required":false,"schema":{"type":"string"}},"alertType":{"name":"alertType","in":"query","description":"Filter alert events by the specified alertType. The only valid value is `runtime`, which is the default.\n","required":false,"schema":{"type":"string"}},"alertSubType":{"name":"alertSubType","in":"query","description":"Filter alert events by the specified alertSubType. Valid values include `fixed` and `anomaly`. By default returns all alerts for the given type.\n","required":false,"schema":{"type":"string"}},"name":{"name":"name","in":"query","description":"Filter events by the specified name. The semantics of name depends on the type of the event.","required":false,"schema":{"type":"string"}},"component":{"name":"component","in":"query","description":"Filter events by the specified component. The semantics of name depends on the type of the event.","required":false,"schema":{"type":"string"}},"select":{"name":"select","in":"query","description":"Metrics to query. Valid values for latency metrics include `totalLatency` and `targetLatency`. Valid values for traffic metrics include `count`, `rate`, and `tps`. Specify multiple values as a comma-separated list. Required for latency metrics.\n","required":false,"schema":{"type":"string"}},"interval":{"name":"interval","in":"query","description":"For latency metrics, frequency that the latency metric is saved to the results. The maximum interval is 5 minutes (`5m`). For traffic metrics, frequency that the metric is saved to the results, and the interval over which the metric is calculated. \n","required":true,"schema":{"type":"string"}},"groupBy":{"name":"groupBy","in":"query","description":"Tags to aggregate metrics by. Valid options include `org,env,region`, `org,env,region,proxy`, or `org,env,region,proxy,target`. **Required for latency metrics.**\n","required":true,"schema":{"type":"string"}},"percentile":{"name":"percentile","in":"query","description":"You must specify the `percentile` query parameter as `50`, `90`, `95`, or `99`.\n For example, if you specify `90`, the API returns the total response latency value in the 90th percentile.\n","required":true,"schema":{"type":"string"}},"proxy":{"name":"proxy","in":"query","description":"Filter metrics by the specified API proxy name. Specify multiple values as a comma-separated list.","schema":{"type":"string"}},"target":{"name":"target","in":"query","description":"Filter metrics by the specified target domain name. Specify multiple values as a comma-separated list.","schema":{"type":"string"}},"collection":{"name":"collection","in":"query","description":"Filter metrics by the collection ID. Specify multiple values as a comma-separated list.","schema":{"type":"string"}},"statusCode":{"name":"statusCode","in":"query","description":"Filter metrics by the specified HTTP status code. Values include:\n `2xx`, `4xx`, `5xx`, and `errors`, which includes all HTTP 4xx and 5xx status codes. You can also specify a specific HTTP status code, such as `203` or `404`. Specify multiple values as a comma-separated list.\n","required":false,"schema":{"type":"string"}},"targetStatusCode":{"name":"targetStatusCode","in":"query","description":"Filter metrics by the specified HTTP status code returned by the target.\n For example, `201`, `404`, or `501`. You must specify an explicit status code. You cannot use wildcards such as `4xx` or `5xx`. Specify multiple values as a comma-separated list. To set this value, you must also set `groupBy` to include the `target` option.\n","required":false,"schema":{"type":"string"}},"faultCodeName":{"name":"faultCodeName","in":"query","description":"Filter metrics by the specified fault code name. Specify multiple values as a comma-separated list.","required":false,"schema":{"type":"string"}},"faultCodeCategory":{"name":"faultCodeCategory","in":"query","description":"Filter metrics by the specified fault code category. Specify multiple values as a comma-separated list.","required":false,"schema":{"type":"string"}},"faultCodeSubCategory":{"name":"faultCodeSubCategory","in":"query","description":"Filter metrics by the specified fault code subcategory. Specify multiple values as a comma-separated list.","schema":{"type":"string"},"required":false},"developerApp":{"name":"developerApp","in":"query","description":"Filter metrics by the specified developer app name and developer email address. For example, `MyCoolDevapp(developer@example.com)`. Specify multiple values as a comma-separated list.\n","required":false,"schema":{"type":"string"}}},"schemas":{"Events":{"type":"array","items":{"$ref":"#/components/schemas/Event"}},"Event":{"type":"object","properties":{"id":{"type":"string","description":"Alert ID."},"shared_id":{"type":"string","description":"TBD"},"entity_key":{"type":"string","description":"Entity key."},"entity_value":{"type":"string","description":"Entity value."},"dependent_entity_key":{"type":"string","description":"Dependent entity key."},"dependent_entity_value":{"type":"string","description":"Dependent entity value."},"component":{"type":"string","description":"Component."},"pod":{"type":"string","description":"Pod."},"region":{"type":"string","description":"Region."},"organization":{"type":"string","description":"Organization name."},"environment":{"type":"string","description":"Environment name."},"name":{"type":"string","description":"Name of the alert."},"type":{"type":"string","description":"Type of event. Valid values include `alert` or `anomaly`."},"source":{"type":"string","description":"Source of the alert."},"raw_payload":{"description":"Raw payload of the alert. For details, see <a href=\"/docs/alerts-api/1/types/Alert\">Alert</a>."},"time":{"type":"string","description":"Time the alert was triggered."}}},"Condition":{"type":"object","properties":{"comparator":{"type":"string","description":"Operator that is used to compare the metric value\nagainst the `threshold` value to determine if this\ncondition is met. Valid values include:\n\n* `>` or `gt` (greater than)\n\n* `<` or `lt` (less than)\n\n* `>=` or `gte` (greater than or equal to)\n\n* `<=` or `lte` (less than or equal to)\n\n* `==` (equal to)\n\nNot valid for `anomaly` alert subtype.\n","example":">="},"uuid":{"type":"string","description":"Output only. Unique identifier for this condition.\n","format":"uuid","example":"926aa42e-afa6-11e7-abc4-cec278b6b50a"},"description":{"maxLength":1000,"type":"string","description":"Description of alert condition.\n","example":"Triggers when proxy 5xx rate for prod weatherapi is\nover 1.5% for 30 seconds\n"},"dimensions":{"type":"object","description":"Object with key-value pairs that identify\nthe metric resource(s). For example, an environment, API proxy, or\nset of targets in an API proxy. Few keys like `statusCode` or\n`faultCodes` not valid for latency alerts.\n","$ref":"#/components/schemas/Dimension","example":{"org":"testOrg","env":"testEnv","proxy":"weatherapi","statusCode":"5xx"}},"metric":{"type":"string","description":"Metric monitored for the resources specified by `dimension`. Valid values include `rate`, `count`, `tps`, `totalLatency` or `targetLatency`. `count` and `totalLatency` are only valid metric for the anomaly alert subtype."},"threshold":{"type":"number","description":"Threshold values that is compared against the\nmetric value using `comparator` to determine\nif this condition is met. For `rate` metrics, this value is in the range 0-1.\n","example":0.015},"durationSeconds":{"type":"number","description":"Duration time, in seconds, for which the metric value\nmust continuously match the `threshold` value using\nthe `comparator` operator to determine if this\ncondition is met.\n\n\nFor example, given the following parameters:\n\n```\n{\n \"durationSeconds\": 30,\n \"threshold\": 0.015,\n \"comparator\": \">=\"\n}\n```\n\n\nThe condition is met when the metric is greater than\nor equal to 0.015 for 30 seconds, and not below\nthat value at any time within that duration.\n\nValid values include:\n\n* `60` (1 minute)\n\n* `120` (2 minutes)\n\n* `180` (3 minutes)\n\n* `240` (4 minutes)\n\n* `300` (5 minutes)\n\n* `600` (10 minutes)\n\n* `900` (15 minutes)\n\n* `1200` (20 minutes)\n\n* `1800` (30 minutes)\n\n* `3600` (1 hour)\n","example":30.0}}},"Dimension":{"type":"object","properties":{"collection":{"type":"string","description":"Collection ID to monitor collection of targets or API proxies."},"developerApp":{"type":"string","description":"Developer app name, or the special value `ANY` to monitor any developer app in the environment."},"env":{"type":"string","description":"Environment name."},"faultCodeCategory":{"type":"string","description":"Fault code category. Valid in conjunction with `faultCodeSubCategory`. Not valid if `statusCode` is present. Not valid for latency alerts."},"faultCodeName":{"type":"string","description":"Fault code name. Valid only if you specify a value for `faultCodeSubCategory`. Specify a specific name, ALL, or ANY. You can only specify a name if you specified an explicit subcategory to `faultCodeSubCategory`. That is, `faultCodeSubCategory` cannot be set to `ALL` or `ANY`. `ALL` specifies that all fault code names must have been violated for the alert to trigger. `ANY` specifies to trigger the alert if any fault code name has been violated."},"faultCodeSubCategory":{"type":"string","description":"Fault code subcategory. Valid only if you specify a value for `faultCodeCategory`. Specify a specific subcategory, `ALL`, or `ANY`. `ALL` specifies that all subcategories must have been violated for the alert to trigger. `ANY` specifies to trigger the alert if any subcategory fault has been violated."},"percentile":{"type":"string","description":"Percentile (50, 90, 95, 99) of the latency value that, if violated, the alert is fired."},"proxy":{"type":"string","description":"API proxy name, or the special value `ANY` or `ALL` to monitor any API proxy in the environment."},"region":{"type":"string","description":"Region."},"statusCode":{"type":"string","description":"Status code, such as `5xx`, `4xx`, `404`, `2xx` on whose rate or count if violated the alert should be fired. Not valid for latency alerts."},"target":{"type":"string","description":"Target name, or the special value `ANY` or `ALL` to monitor any target in the API proxy."}}},"MetricsResponse":{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/components/schemas/MetricsResult"}}},"example":{"results":[{"series":[{"name":"proxy","tags":{"env":"prod","mpHost":"ALL","org":"apigee-internal","percentile":"90","proxy":"ALL","region":"us-east-1","target":"ALL"},"columns":["time","totalLatency"],"values":[["2020-11-05T14:00:00Z",12],["2020-11-05T14:05:00Z",12]]}]}]}},"Error":{"type":"object","properties":{"error":{"type":"string","description":"Error message"}}},"MetricsResult":{"type":"object","properties":{"series":{"type":"array","items":{"$ref":"#/components/schemas/MetricsSeries"}}}},"MetricsSeries":{"type":"object","properties":{"name":{"type":"string"},"tags":{"type":"object","properties":{"env":{"type":"string","description":"Environments used to filter metrics."},"mpHost":{"type":"string","description":"MP host used to filter metrics."},"org":{"type":"string","description":"Organization used to filter metrics."},"percentile":{"type":"string","description":"Latency percentile used to filter metrics."},"proxy":{"type":"string","description":"Name of the API proxies used to filter metrics or `ALL`."},"region":{"type":"string","description":"Name of the regions used to filter metrics."},"target":{"type":"string","description":"Name of the target domains used to filter metrics."}}},"columns":{"description":"Columns included.","type":"array","items":{"type":"string"}},"values":{"type":"array","items":{"type":"array","items":{"type":"number"}}}}},"FaultCodeNames":{"type":"object","properties":{"faultCodeNames":{"type":"array","items":{"type":"string"}}}},"FaultCodes":{"type":"object","properties":{"faultCodes":{"type":"array","items":{"type":"string"}}}},"FaultCodeCategories":{"type":"object","properties":{"faultCodeCategories":{"type":"array","items":{"type":"string"}}}},"FaultCodeSubCategories":{"type":"object","properties":{"faultCodeSubCategories":{"type":"array","items":{"type":"string"}}}},"FaultCodeDetail":{"type":"object","properties":{"faultCode":{"type":"string"},"faultCodeCategory":{"type":"string"},"faultCodeSubCategory":{"type":"string"},"faultCodeName":{"type":"string"},"faultCodeDocumentLink":{"type":"string"}}}}}}
/ traffic
/ latency
/ targets
/ alerthistory
/ alertsummary
/ events
/ alertinstance / {instance_id}
/ faultcodenames
/ faultcodes
/ faultcodecategories
/ faultcodesubcategories
/ faultcodedetails
Reports API OpenAPI	{"openapi":"3.0.0","servers":[{"url":"https://api.enterprise.apigee.com/v1"}],"info":{"title":"Reports API","description":"Define custom analytics report definitions. Report definitions define what type of metrics you want to view, how to group the data (dimensions), and which data to include (filters). \nThe report definitions you create appear in the Edge UI list of custom reports, where you can further manipulate the report definitions in the UI and run the reports.","version":"1.0"},"security":[{"Basic":[]},{"OAuth":[]}],"paths":{"/organizations/{org_name}/reports":{"get":{"tags":["Analytics","Custom Reports"],"summary":"Lists custom analytics report definitions","description":"Lists custom analytics report definitions for an organization.","operationId":"listCustomReportDefinitions","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/expand"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"qualifier":{"type":"array","description":"List of custom analytics report definitions.","items":{"type":"object","properties":{"displayName":{"type":"string","description":"Display name for the custom analytics report definition."},"name":{"type":"string","description":"ID of the custom analytics report definition."}}}}}},"example":{"qualifier":[{"displayName":"MyFirstReport","name":"74f47936-98df-43a4-bd85-3499bbd56820"},{"displayName":"MySecondReport","name":"8e5d348d-aa11-4158-a37f-ed254347e994"}]}}}},"400":{"description":"Bad request"}}},"post":{"tags":["Analytics","Custom Reports"],"summary":"Create a custom analytics report definition","description":"Creates a custom analytics report definition.\nFor more information on metrics, dimensions, and other report settings, see <a href=\"https://docs.apigee.com/api-platform/analytics/create-custom-reports\">Create and manage custom reports</a>.","operationId":"createCustomReportDefinition","parameters":[{"$ref":"#/components/parameters/org_name"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Report"},"example":{"chartType":"line","comments":[],"createdAt":1585880499000,"createdBy":"ahamilton@example.com","dimensions":["ax_dn_region","apiproxy"],"displayName":"MyReport1","environment":"test","lastModifiedAt":1585936509000,"lastModifiedBy":"ahamilton@example.com","lastViewedAt":1585936509000,"metrics":[{"function":"sum","name":"is_error"},{"function":"sum","name":"message_count"}],"name":"74f47936-98df-43a4-bd85-3499bbd56820","organization":"myog","properties":[],"sortbyCols":[],"tags":[]}}}},"400":{"description":"Bad request"}},"requestBody":{"description":"Custom analytics report definition.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Report"},"example":{"chartType":"line","dimensions":["ax_dn_region","apiproxy"],"displayName":"MyReport1","environment":"test","metrics":[{"function":"sum","name":"is_error"},{"function":"sum","name":"message_count"}]}}}}}},"/organizations/{org_name}/reports/{report_name}":{"put":{"tags":["Analytics","Custom Reports"],"summary":"Update a custom analytics report definition","description":"Updates a custom analytics report definition. \n\n**IMPORTANT**: To update a report, you must send the entire report definition that includes your report updates; otherwise the report definition is overwritten to include only the updated properties.\n\nFor more information on metrics, dimensions, and other report settings, see <a href=\"https://docs.apigee.com/api-platform/analytics/create-custom-reports\">Create and manage custom reports</a>.","operationId":"updateCustomReportDefinition","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/report_name"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Report"},"example":{"chartType":"line","comments":[],"createdAt":1585880499000,"createdBy":"ahamilton@example.com","dimensions":["ax_dn_region","apiproxy"],"displayName":"MyReport1","environment":"test","lastModifiedAt":1585936509000,"lastModifiedBy":"ahamilton@example.com","lastViewedAt":1585936509000,"metrics":[{"function":"sum","name":"is_error"},{"function":"sum","name":"message_count"}],"name":"74f47936-98df-43a4-bd85-3499bbd56820","organization":"myog","properties":[],"sortbyCols":[],"tags":[]}}}},"400":{"description":"Bad request"}},"requestBody":{"description":"Custom analytics report definition.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Report"},"example":{"chartType":"line","dimensions":["ax_dn_region","apiproxy"],"displayName":"MyReport1","environment":"test","metrics":[{"function":"sum","name":"is_error"},{"function":"sum","name":"message_count"}]}}}}},"get":{"tags":["Analytics","Custom Reports"],"summary":"Get a custom analytics report definition","description":"Gets the contents of a custom analytics report definition.","operationId":"getCustomReportDefinition","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/report_name"},{"$ref":"#/components/parameters/expand"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Report"},"example":{"chartType":"line","comments":[],"createdAt":1585880499000,"createdBy":"ahamilton@example.com","dimensions":["ax_dn_region","apiproxy"],"displayName":"MyReport1","environment":"test","lastModifiedAt":1585936509000,"lastModifiedBy":"ahamilton@example.com","lastViewedAt":1585936509000,"metrics":[{"function":"sum","name":"is_error"},{"function":"sum","name":"message_count"}],"name":"74f47936-98df-43a4-bd85-3499bbd56820","organization":"myog","properties":[],"sortbyCols":[],"tags":[]}}}},"400":{"description":"Bad request"}}},"delete":{"tags":["Analytics","Custom Reports"],"summary":"Delete a custom analytics report definition","description":"Deletes a custom analytics report definition from an organization.","operationId":"deleteCustomReportDefinition","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/report_name"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Message indicating that the custom analytics report definition has been deleted. For example: `\"Deleted report 54ae232a-ed02-4f34-b5a0-f5dbb56bde50\"`"}}}}}},"400":{"description":"Bad request"}}}}},"components":{"securitySchemes":{"Basic":{"type":"http","scheme":"basic","description":"Multi-factor authentication is not supported."},"OAuth":{"type":"apiKey","name":"Authorization","in":"header","description":"For OAuth, enter the following in the Key field: Bearer %your-token% (see https://docs.apigee.com/api-platform/system-administration/using-oauth2#get-the-tokens)"}},"parameters":{"org_name":{"in":"path","name":"org_name","required":true,"schema":{"type":"string"},"description":"Organization name."},"report_name":{"in":"path","name":"report_name","required":true,"schema":{"type":"string"},"description":"Report ID specified using the `name` property. For example, `62d9de1f-9b56-4a27-ad74-14199eb07201`. Get the report name by using the <a href=\"/docs/reports/1/routes/organizations/%7Borg_name%7D/reports/get\">Lists analytics report definitions API</a>."},"expand":{"in":"query","name":"expand","required":false,"schema":{"type":"boolean"},"description":"Flag that specifies whether to view expanded details for each report. Set to `true` to view expanded details. Defaults to `false`."}},"schemas":{"Report":{"description":"Details for the custom analytics report definition.","type":"object","properties":{"chartType":{"type":"string","description":"Type of chart. Valid values include `column` and `line`."},"comments":{"type":"array","description":"List of comments associated with a custom analytics report definition.","items":{"type":"string"}},"createdAt":{"type":"integer","description":"Output only. Time at which the custom analytics report definition was created in milliseconds since epoch."},"createdBy":{"type":"string","description":"Output only. User that created the custom analytics report definition."},"dimensions":{"type":"array","description":"Dimensions used in the custom analytics report definition. See <a href=\"https://docs.apigee.com/api-platform/analytics/analytics-reference#dimensions\">Dimensions</a>.","items":{"type":"string"}},"displayName":{"type":"string","description":"Display name for the analtyics report definition."},"environment":{"type":"string","description":"Environment name."},"lastModifiedAt":{"type":"integer","description":"Output only. Time at which the custom analytics report definition was last modified in milliseconds since epoch."},"lastModifiedBy":{"type":"string","description":"Output only. User that last updated the custom analytics report definition."},"lastViewedAt":{"type":"integer","description":"Output only. Time at which the custom analytics report definition was last viewed in milliseconds since epoch."},"metrics":{"type":"array","description":"List of metric names and functions.","items":{"type":"object","properties":{"function":{"type":"string","description":"Function name."},"name":{"type":"string","description":"Metric name."}}}},"name":{"type":"string","description":"ID of the custom analytics report definition."},"organization":{"type":"string","description":"Output only. Organization name."},"properties":{"type":"array","description":"Properties associated with the custom analytics report definition.","items":{"type":"object","properties":{"property":{"type":"string","description":"Property name."},"value":{"type":"array","description":"Value of the property.","items":{"type":"object","properties":{"name":{"type":"string","description":"Name of the property."}}}}}}},"sortbyCols":{"type":"array","description":"Columns by which to sort.","items":{"type":"string"}},"tags":{"type":"array","description":"List of tags associated with the customer analytics report definition.","items":{"type":"string"}},"timeUnit":{"type":"string","description":"Time unit of aggregation to use. Set to `second`, `minute`, `hour`, `day`, `week`, `month`, `quarter`, `year`, `decade`, `century`, or `millennium`."}}}}}}
/ organizations / {org_name} / reports
/ organizations / {org_name} / reports / {report_name}
Monetization API OpenAPI	{"openapi":"3.0.0","servers":[{"url":"https://api.enterprise.apigee.com/v1"}],"info":{"title":"Monetization API","description":"Monetize your APIs. For more information, see <a href=\"https://docs.apigee.com/api-platform/monetization/basics-monetization\">Monetization overview</a>.","version":"1.0"},"security":[{"Basic":[]},{"OAuth":[]}],"paths":{"/mint/organizations/{org_name}/monetization-packages":{"post":{"summary":"Create an API package","tags":["API packages"],"operationId":"createAPIPackage","description":"Creates an API package.\n\nAn API package is a collection of API products that is presented to developers as a bundle, and typically associated with one or more rate plans for monetization. An API package does not become visible to developers until you publish a rate plan for the package (with a start date of the current or future date).\n\nDevelopers can register their apps to use an API package only by purchasing one of the rate plans currently in effect. If an API package does not have a published rate plan that is currently in effect, the package is not monetized.\n\nYou can create multiple API packages. You decide which API products to include in each API package. You can even put the same API product or products in different packages and associate them with the same or different rate plans.\n\nAfter you add an API product to a package, you may need to set up price points for the API product. You need to do this only if all of the following are true:\n\n* You set up a revenue sharing rate plan for the API product.</li><li>Developers charge third parties for the use of the resources in the API product.\n* There is a minimum or maximum restriction on the amount developers can charge and you want to notify developers of the restriction.\n\nThe minimum and maximum prices are displayed in the details for the API package.\n\nSee also <a href=\"https://docs.apigee.com/api-platform/monetization/api-product-bundles#createpackapi\">Creating an API product bundle using the API</a>.\n\n**Note**: Once you create a package, you cannot delete it.","parameters":[{"$ref":"#/components/parameters/org_name"}],"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIPackage"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIPackage"}}},"description":"API package details."}},"get":{"summary":"List API packages","tags":["API packages"],"operationId":"listAPIPackages","description":"Lists API packages for the specified organization. See also <a href=\"http://docs.apigee.com/monetization/content/create-api-packages#getpackapi\">Viewing API product bundles using the API</a>.","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/all"},{"$ref":"#/components/parameters/size"},{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/monetized"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIPackages"}}}}}}},"/mint/organizations/{org_name}/monetization-packages/{package_id}":{"get":{"summary":"Get an API package","tags":["API packages"],"operationId":"getAPIPackage","description":"Gets an API package for the specified organization. See also <a href=\"http://docs.apigee.com/monetization/content/create-api-packages#getpackapi\">Viewing API product bundle using the API</a>.","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/package_id"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIPackage"}}}}}},"delete":{"summary":"Delete an API package","tags":["API packages"],"operationId":"deleteAPIPackage","description":"Deletes an API package for the specified organization. You can delete an API package only if it does not have any rate plans defined. See also <a href=\"https://docs.apigee.com/api-platform/monetization/api-product-bundles#deletepackage\">Deleting an API product bundle using the API</a>.","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/package_id"}],"responses":{"204":{"description":"No Content"}}}},"/mint/organizations/{org_name}/developers/{developer_email}/monetization-packages":{"get":{"summary":"List API packages accepted by a developer","tags":["API packages"],"operationId":"listAPIPackagesAcceptedDev","description":"Lists all API packages accepted by a developer. See also <a href=\"http://docs.apigee.com/monetization/content/create-api-packages#getdevpackapi\">Viewing API product bundle accepted by a developeror company using the API</a>.","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/developer_email"},{"$ref":"#/components/parameters/current"},{"$ref":"#/components/parameters/allAvailable"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIPackages"}}}}}}},"/mint/organizations/{org_name}/companies/{company_id}/monetization-packages":{"get":{"summary":"List API packages accepted by a company","tags":["API packages"],"operationId":"listAPIPackagesAcceptedCompany","description":"Lists API packages accepted by a company. See also <a href=\"http://docs.apigee.com/monetization/content/create-api-packages#getdevpackapi\">Viewing API product bundle accepted by a developeror company using the API</a>.","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/company_id"},{"$ref":"#/components/parameters/current"},{"$ref":"#/components/parameters/allAvailable"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIPackages"}}}}}}},"/mint/organizations/{org_name}/monetization-packages/{package_id}/products/{product_id}":{"post":{"summary":"Add an API product to an API package","tags":["API packages"],"operationId":"addAPIProductAPIPackage","description":"Adds an API product to an API package.\n\nIf you have an API product-specific rate plan defined (rate card or revenue share), you can specify the details in the request body. Otherwise, specify `{ }`.\n\nSee also <a href=\"http://docs.apigee.com/monetization/content/create-api-packages#addprodtopackapi\">Managing the API products in an API product bundle using the API</a>.","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/package_id"},{"$ref":"#/components/parameters/product_id"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Rateplan"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Rateplan"}}}},"description":"API product-specific rate plan details. Only required if you have an API product-specific rate plan defined (rate card or revenue share). If not required, specify {}."}},"delete":{"summary":"Delete an API product from an API package","tags":["API packages"],"operationId":"deleteAPIProductAPIPackage","description":"Deletes the specified API product from an API package. See also <a href=\"http://docs.apigee.com/monetization/content/create-api-packages#deleteprodfrompackage\">Deleting an API product from an API product bundle</a>.","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/package_id"},{"$ref":"#/components/parameters/product_id"}],"responses":{"204":{"description":"No Content"}}}},"/mint/organizations/{org_name}/products":{"get":{"summary":"List API products","tags":["API products"],"operationId":"listAPIProducts","description":"Lists API products for the specified organization. See also <a href=\"https://docs.apigee.com/api-platform/publish/create-api-products\">Manage API products</a>.","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/all"},{"$ref":"#/components/parameters/size"},{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/monetized"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIProducts"}}}}}}},"/mint/organizations/{org_name}/products/{product_id}":{"get":{"summary":"Get an API product","tags":["API products"],"operationId":"getAPIProduct","description":"Gets an API product in the specified organization. See also <a href=\"https://docs.apigee.com/api-platform/publish/create-api-products\">Manage API products</a>.","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/product_id"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIProduct"}}}}}}},"/mint/organizations/{org_name}/billing-adjustments":{"post":{"summary":"Make a billing adjustment","tags":["Billing adjustments"],"operationId":"makeBillingAdjustment","description":"Makes a billing adjustment for the specified organization.\n\nIf you do not specify an optional property, the billing adjustment will be all inclusive for that property. For example, if you do not specify a transaction type, the billing adjustment will apply to all transaction types. See also <a href=\"http://docs.apigee.com/monetization/content/make-billing-adjustments#makeadjapi\">Making a billing adjustment using the API</a>.","parameters":[{"$ref":"#/components/parameters/org_name"}],"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BillingAdjustment"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BillingAdjustment"}}},"description":"Billing adjustment."}},"get":{"summary":"List billing adjustments","tags":["Billing adjustments"],"operationId":"listBillingAdjustments","description":"Lists billing adjustments for the organization. See also <a href=\"http://docs.apigee.com/monetization/content/make-billing-adjustments#getadjapi\">Viewing billing adjustments using the API</a>.","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/all"},{"$ref":"#/components/parameters/size"},{"$ref":"#/components/parameters/page"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BillingAdjustments"}}}}}}},"/mint/organizations/{org_name}/billing-adjustments/{billing_adjustment_id}":{"get":{"summary":"Get the specified billing adjustment","tags":["Billing adjustments"],"operationId":"getBillingAdjustment","description":"Gets the specified billing adjustment for the organization. See also <a href=\"http://docs.apigee.com/monetization/content/make-billing-adjustments#getadjapi\">Viewing billing adjustments using the API</a>.","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/billing_adjustment_id"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BillingAdjustment"}}}}}},"put":{"summary":"Update a billing adjustment","tags":["Billing adjustments"],"operationId":"updateBillingAdjustment","description":"Updates the specified billing adjustment for the organization.\n\nYou must specify all of the same properties that you set when creating the billing adjustment and include the ID of the billing adjustment.\n\nYou can modify the name and adjustment percentage values only. See also <a href=\"https://docs.apigee.com/api-platform/monetization/make-billing-adjustments#updateadjapi\">Updating a billing adjustment using the API</a>.\n\n**Note**: When you update a billing adjustment, you need to specify all the billing adjustement settings, not only the settings you want to update. You might want to <a href=\"https://apidocs.apigee.com/docs/monetization/1/routes/mint/organizations/%7Borg_name%7D/billing-adjustments/%7Bbilling_adjustment_id%7D/get\">get the billing adjustment</a>, copy the response payload, modify it as required, and then pass the modified payload in the request body.","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/billing_adjustment_id"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BillingAdjustment"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BillingAdjustment"}}},"description":"Updates details for the billing adjustment."}},"delete":{"summary":"Delete a billing adjustment","tags":["Billing adjustments"],"operationId":"deleteBillingAdjustment","description":"Deletes the specified billing adjustment for the organization. See also <a href=\"http://docs.apigee.com/monetization/content/make-billing-adjustments#deleteadjapi\">Deleting a billing adjustment using the API</a>.","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/billing_adjustment_id"}],"responses":{"204":{"description":"No Content"}}}},"/mint/organizations/{org_name}/tax-engine":{"get":{"summary":"Get the tax rate for a developer","tags":["Billing documents"],"operationId":"getTaxRateDeveloper","description":"Gets the tax rate for a developer in an organization. See also <a href=\"http://docs.apigee.com/monetization/content/companies-and-developers-manage-manually#gettaxratedevapi\">Retrieving the tax rate for a developer using the API</a>.","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/developer_email"}],"responses":{"200":{"description":"OK"}}}},"/mint/organizations/{org_name}/monetization-packages/{package_id}/rate-plans/{plan_id}/real-currency-credit-transactions":{"post":{"summary":"Issue credit to a developer","operationId":"Issue credit to a developer","tags":["Credits"],"description":"Issues credit to a developer. You can apply credit against a package as a whole, or against the use of a specific product within a package. See also <a href=\"http://docs.apigee.com/monetization/content/manage-credit#issuecreditapi\">Issuing the credits using the API</a>.","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/package_id"},{"$ref":"#/components/parameters/plan_id"},{"$ref":"#/components/parameters/billingMonth"},{"$ref":"#/components/parameters/billingYear"},{"$ref":"#/components/parameters/currencyId"},{"$ref":"#/components/parameters/developerId"},{"$ref":"#/components/parameters/productId"},{"$ref":"#/components/parameters/transactionAmount"},{"$ref":"#/components/parameters/transactionNote"}],"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Transaction"}}}}}}},"/mint/organizations/{org_name}/developers/{developer_email}/developer-credit-limit":{"post":{"summary":"Set a credit limit for a developer","operationId":"setCreditLimitDevS","tags":["Credit limits"],"description":"Sets a credit limit for a developer. See also <a href=\"http://docs.apigee.com/monetization/content/manage-postpaid-balances#setcreditlimitapi\">Setting a credit limit using the API</a>.\n\n**Note**: When you add a supported currency for an organization, you can set a credit limit. The credit limit applies to all postpaid developers in the organization. This API overrides the credit limit for the specified developer only.'","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/developer_email"},{"$ref":"#/components/parameters/supportedCurrencyId"},{"$ref":"#/components/parameters/amount"}],"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PrepaidBalance"}}}}}},"get":{"summary":"Get the credit limit for a developer","operationId":"getCreditLimitDev","tags":["Credit limits"],"description":"Gets the credit limit for a developer. See also <a href=\"http://docs.apigee.com/monetization/content/manage-postpaid-balances#getcreditlimitapi\">Retrieving a credit limit using the API</a>.","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/developer_email"},{"$ref":"#/components/parameters/all"},{"$ref":"#/components/parameters/size"},{"$ref":"#/components/parameters/page"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreditLimit"}}}}}}},"/mint/organizations/{org_name}/supported-currencies":{"get":{"summary":"Get supported currencies","tags":["Currency"],"operationId":"getSupportedCurrencies","description":"Gets supported currencies. See also <a href=\"http://docs.apigee.com/monetization/content/manage-supported-currencies#getcurrapi\">Retrieving supported currencies using the API</a>.","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/all"},{"$ref":"#/components/parameters/size"},{"$ref":"#/components/parameters/page"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SupportedCurrencies"}}}}}},"post":{"summary":"Add a supported currency","tags":["Currency"],"operationId":"addSupportedCurrency","description":"Adds a supported currency. See also <a href=\"http://docs.apigee.com/monetization/content/manage-supported-currencies#addcurrapi\">Adding supported currencies using the API</a>.","parameters":[{"$ref":"#/components/parameters/org_name"}],"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SupportedCurrency"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SupportedCurrency"}}},"description":"Supported currency details."}}},"/mint/organizations/{org_name}/supported-currencies/{supportedcurrency_id}":{"get":{"summary":"Get supported currency","tags":["Currency"],"operationId":"getSupportedCurrency","description":"Gets details for a supported currency. See also <a href=\"http://docs.apigee.com/monetization/content/manage-supported-currencies#getcurrapi\">Retrieving supported currencies using the API</a>.","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/supportedcurrency_id"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SupportedCurrency"}}}}}},"put":{"summary":"Update a supported currency","tags":["Currency"],"operationId":"updateSupportedCurrency","description":"Updates a supported currency. See also <a href=\"http://docs.apigee.com/monetization/content/manage-supported-currencies#updatecurrapi\">Updating a supported currency using the API</a>.\n\n**Note**: All properties in the request body are required.","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/supportedcurrency_id"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SupportedCurrency"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SupportedCurrency"}}},"description":"Supported currency details."}},"delete":{"summary":"Delete supported currency","tags":["Currency"],"operationId":"deleteSupportedCurrency","description":"Deletes a supported currency. See also <a href=\"http://docs.apigee.com/monetization/content/manage-supported-currencies#deletecurrapi\">Deleting a supported currency using the API</a>.","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/supportedcurrency_id"}],"responses":{"204":{"description":"No Content"}}}},"/mint/organizations/{org_name}/developer-categories":{"get":{"summary":"List developer categories","tags":["Developer categories"],"operationId":"listDeveloperCategories","description":"Lists developer categories in an organization. See also <a href=\"http://docs.apigee.com/monetization/content/manage-developer-categories#getdevcatapi\">Retrieving developer categories using the API<a>.","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/all"},{"$ref":"#/components/parameters/size"},{"$ref":"#/components/parameters/page"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeveloperCategories"}}}}}},"post":{"summary":"Create a developer category","tags":["Developer categories"],"operationId":"createDeveloperCategory","description":"Creates a developer category for an organization. See also <a href=\"http://docs.apigee.com/monetization/content/manage-developer-categories#createdevcatapi\">Creating a developer category using the API</a>.","parameters":[{"$ref":"#/components/parameters/org_name"}],"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeveloperCategory"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeveloperCategory"}}},"description":"Developer category details."}}},"/mint/organizations/{org_name}/developer-categories/{category_id}":{"get":{"summary":"Get developer category","tags":["Developer categories"],"operationId":"getDeveloperCategory","description":"Gets details of a developer category. See also <a href=\"http://docs.apigee.com/monetization/content/manage-developer-categories#getdevcatapi\">Retrieving developer categories using the API<a>.","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/category_id"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeveloperCategory"}}}}}},"put":{"summary":"Update a developer category","tags":["Developer categories"],"operationId":"updateDeveloperCategory","description":"Updates a developer category for an organization. See also <a href=\"http://docs.apigee.com/monetization/content/manage-developer-categories#updatedevcatapi\">Updating a developer category using the API<a>.","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/category_id"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeveloperCategory"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeveloperCategory"}}},"description":"Developer category details."}},"delete":{"summary":"Delete developer category","tags":["Developer categories"],"operationId":"deleteDeveloperCategory","description":"Deletes a developer category from an organization. See also <a href=\"http://docs.apigee.com/monetization/content/manage-developer-categories#deletedevcatapi\">Deleting a developer category using the API</a>.","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/category_id"}],"responses":{"204":{"description":"No Content"}}}},"/mint/organizations/{org_name}/transactions":{"post":{"summary":"Migrate existing transactions or fees","tags":["Developer migration"],"operationId":"migrateExistingTransactionsFees","description":"Migrates existing transactions or fees. See also <a href=\"http://docs.apigee.com/monetization/content/migrating-developers-monetization\">Migrating developers to monetization</a>.","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/force"}],"responses":{"201":{"description":"Created"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransactionsMigrate"}}},"description":"Migration details."}}},"/mint/organizations/{org_name}/developer-roles":{"get":{"summary":"List developer roles","tags":["Developer roles"],"operationId":"listDeveloperRoles","description":"Lists developer roles in an organization. See <a href=\"http://docs.apigee.com/monetization/content/companies-and-developers-manage-manually#getdevrolesapi\">Retrieving a developer role</a>.","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/all"},{"$ref":"#/components/parameters/size"},{"$ref":"#/components/parameters/page"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeveloperRoles"}}}}}},"post":{"summary":"Create a developer role","tags":["Developer roles"],"operationId":"createDeveloperRole","description":"Creates a developer role for an organization. See <a href=\"http://docs.apigee.com/monetization/content/companies-and-developers-manage-manually#createdevroleapi\">Creating a developer role</a>.","parameters":[{"$ref":"#/components/parameters/org_name"}],"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeveloperRole"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeveloperRole"}}},"description":"Developer role details."}}},"/mint/organizations/{org_name}/notification-email-templates":{"get":{"summary":"List notification email templates","tags":["Event notifications"],"operationId":"listNotificationEmailTemplates","description":"Lists notification email templates. The items in the templates that begin with `$` are variables. See also <a href=\"http://docs.apigee.com/monetization/content/set-up-notification-templates#notiftempapi\">Managing notification templates using the API</a>.","parameters":[{"$ref":"#/components/parameters/org_name"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotificationEmailTemplates"}}}}}},"post":{"summary":"Create a notification email template","tags":["Event notifications"],"operationId":"createNotificationEmailTemplate","description":"Creates a notification email template. See also <a href=\"http://docs.apigee.com/monetization/content/set-up-notification-templates#notiftempapi\">Managing notification templates using the API</a>.","parameters":[{"$ref":"#/components/parameters/org_name"}],"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotificationEmailTemplate"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotificationEmailTemplate"}}},"description":"Notification email template."}}},"/mint/organizations/{org_name}/notification-email-templates/{template_id}":{"get":{"summary":"Get a notification email template","tags":["Event notifications"],"operationId":"getNotificationEmailTemplate","description":"Gets a notification email template. See also <a href=\"http://docs.apigee.com/monetization/content/set-up-notification-templates#notiftempapi\">Managing notification templates using the API</a>.","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/template_id"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotificationEmailTemplate"}}}}}},"put":{"summary":"Update a notification email template","tags":["Event notifications"],"operationId":"updateNotificationEmailTemplate","description":"Updates a notification email template. See also <a href=\"http://docs.apigee.com/monetization/content/set-up-notification-templates#notiftempapi\">Managing notification templates using the API</a>.","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/template_id"}],"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotificationEmailTemplate"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotificationEmailTemplate"}}},"description":"Notification email template."}}},"/mint/organizations/{org_name}/notification-conditions/{condition_id}":{"get":{"summary":"Get a notification condition and action","tags":["Event notifications"],"operationId":"getNotificationConditionAction","description":"Gets a notification condition and action. See also <a href=\"http://docs.apigee.com/monetization/content/set-up-notification-templates#condactapi\">Configuring notification conditions and actions using the API</a>.","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/condition_id"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotificationCondition"}}}}}},"put":{"summary":"Update notification condition and action","tags":["Event notifications"],"operationId":"updateNotificationConditionAction","description":"Updates a notification condition and action. See also <a href=\"http://docs.apigee.com/monetization/content/set-up-notification-templates#condactapi\">Configuring notification conditions and actions using the API</a>.","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/condition_id"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotificationCondition"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotificationRequest"}}},"description":"Notification condition and action."}},"delete":{"summary":"Delete a notification condition and action","tags":["Event notifications"],"operationId":"deleteNotificationConditionAction","description":"Deletes a notification condition and action. See also <a href=\"http://docs.apigee.com/monetization/content/set-up-notification-templates#condactapi\">Configuring notification conditions and actions using the API</a>.","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/condition_id"}],"responses":{"204":{"description":"No Content"}}}},"/mint/organizations/{org_name}/notification-conditions":{"get":{"summary":"List notification conditions and actions","tags":["Event notifications"],"operationId":"listNotificationConditionsActions","description":"Lists notification conditions and actions. See also <a href=\"http://docs.apigee.com/monetization/content/set-up-notification-templates#condactapi\">Configuring notification conditions and actions using the API</a>.","parameters":[{"$ref":"#/components/parameters/org_name"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotificationConditionsActions"}}}}}},"post":{"summary":"Create notification condition and action","tags":["Event notifications"],"operationId":"createNotificationConditionAction","description":"Creates a notification condition and action. See also <a href=\"http://docs.apigee.com/monetization/content/set-up-notification-templates#condactapi\">Configuring notification conditions and actions using the API</a>.","parameters":[{"$ref":"#/components/parameters/org_name"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotificationCondition"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotificationRequest"}}},"description":"Notification condition and action."}}},"/mint/organizations/{org_name}/webhooks":{"get":{"summary":"List webhooks","tags":["Event notifications"],"operationId":"listWebhooks","description":"Lists webhooks. See also <a href=\"http://docs.apigee.com/monetization/content/set-up-notification-webhooks#webhooksapi-viewingallwebhooksusingtheapi\">Viewing all webhooks using the API</a>.","parameters":[{"$ref":"#/components/parameters/org_name"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Webhooks"}}}}}},"post":{"summary":"Create a webhook","tags":["Event notifications"],"operationId":"createWebhook","description":"Creates a webhook. See also <a href=\"http://docs.apigee.com/monetization/content/set-up-notification-webhooks#webhooksapi-creatingawebhookusingtheapi\">Creating a webhook using the API</a>.","parameters":[{"$ref":"#/components/parameters/org_name"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Webhook"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Webhook"}}},"description":"Webhook details."}}},"/mint/organizations/{org_name}/webhooks/{webhook_id}":{"get":{"summary":"Get a webhook","tags":["Event notifications"],"operationId":"getWebhook","description":"Gets a webhook. See also <a href=\"http://docs.apigee.com/monetization/content/set-up-notification-webhooks#webhooksapi-viewingawebhookusingtheapi\">Viewing a webhook using the API</a>.","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/webhook_id"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Webhook"}}}}}},"post":{"summary":"Update a webhook","tags":["Event notifications"],"operationId":"updateWebhook","description":"Updates a webhook. See also <a href=\"http://docs.apigee.com/monetization/content/set-up-notification-webhooks#webhooksapi-updatingawebhookusingtheapi\">Updating a webhook using the API</a>.","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/webhook_id"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Webhook"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Webhook"}}},"description":"Webhook details."}},"delete":{"summary":"Delete a webhook","operationId":"deleteWebhook","tags":["Event notifications"],"description":"Deletes a webhook. See also <a href=\"http://docs.apigee.com/monetization/content/set-up-notification-webhooks#webhooksapi-deletingawebhookusingtheapi\">Deleting a webhook using the API</a>.","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/webhook_id"},{"$ref":"#/components/parameters/forceDelete"}],"responses":{"204":{"description":"No Content"}}}},"/mint/organizations/{org_name}/webhooks/{webhook_id}/test/{developer_email}/{app_id}/{product_id}/{rateplan_id}":{"get":{"summary":"List available webhook notification trigger types.","operationId":"listWebhookNotificationTriggerTypes","tags":["Event notifications"],"description":"Lists available webhook notification trigger types. See also <a href=\"http://docs.apigee.com/monetization/content/testing-monetization#view-webhooks\">Viewing the available webhook notification trigger types</a>.","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/webhook_id"},{"$ref":"#/components/parameters/developer_email"},{"$ref":"#/components/parameters/app_id"},{"$ref":"#/components/parameters/product_id"},{"$ref":"#/components/parameters/rateplan_id"}],"responses":{"200":{"description":"OK"}}},"post":{"summary":"Test the execution of a webhook.","operationId":"testWebhook","tags":["Event notifications"],"description":"Test the execution of a webhook. See also <a href=\"http://docs.apigee.com/monetization/content/testing-monetization#test-webhook\">Testing the execution of a webhook</a>.","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/webhook_id"},{"$ref":"#/components/parameters/developer_email"},{"$ref":"#/components/parameters/app_id"},{"$ref":"#/components/parameters/product_id"},{"$ref":"#/components/parameters/rateplan_id"}],"responses":{"201":{"description":"Created"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookTest"}}},"description":"Webhook details."}}},"/mint/organizations/{org_name}/webhooks/{webhook_id}/test/{developer_email}/{app_id}/{product_id}/{rateplan_id}/{trigger_type}":{"get":{"summary":"Get a sample request payload for the webhook trigger type.","operationId":"getSampleWebhookTriggerType","tags":["Event notifications"],"description":"Gets a sample request payload for the webhook trigger type. See also <a href=\"http://docs.apigee.com/monetization/content/testing-monetization#view-webhook-schema\">Viewing a sample request payload for webhook notification testing</a>.","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/webhook_id"},{"$ref":"#/components/parameters/developer_email"},{"$ref":"#/components/parameters/app_id"},{"$ref":"#/components/parameters/product_id"},{"$ref":"#/components/parameters/rateplan_id"},{"$ref":"#/components/parameters/trigger_type"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookSample"}}}}}}},"/mint/organizations/{org_name}/notification-service-items":{"get":{"summary":"Get notifications sent","operationId":"getNotificationsSent","tags":["Event notifications"],"description":"Gets notifications that have been sent for an organization.\n\nA maximum of 1000 notifications are returned. In the response, the `hasMoreItems` flag indicates whether the number of notifications in the specified list amounts to more than 1000. If `hasMoreItems` is `true`, indicating that there are more notifications than could be displayed, and you would like to view the remaining notifications, you need to refine your query parameter filters to process smaller groups of notifications per request. For example, you might make multiple requests using several smaller date ranges, or return notifications with only certain status values.\n\nSee also <a href=\"http://docs.apigee.com/monetization/content/testing-monetization#view-notifications\">Viewing the notifications sent</a>.","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/startdate"},{"$ref":"#/components/parameters/enddate"},{"$ref":"#/components/parameters/status"}],"responses":{"200":{"description":"OK"}}}},"/mint/organizations/{org_name}/notification-service-items/{notification_id}":{"get":{"summary":"Get notification details","operationId":"getNotificationDetails","tags":["Event notifications"],"description":"Gets details for a specific notification. See also <a href=\"http://docs.apigee.com/monetization/content/testing-monetization#view-notification-details\">Viewing details for a notification</a>.","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/notification_id"}],"responses":{"200":{"description":"OK"}}}},"/mint/organizations/{org_name}/notification-service-items/{notification_id}/reprocess":{"post":{"summary":"Reprocess a notification","operationId":"reporcessNotification","tags":["Event notifications"],"description":"Reprocess a notification. See also <a href=\"http://docs.apigee.com/monetization/content/testing-monetization#reprocess-notification\">Reprocessing a notification</a>.","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/notification_id"}],"responses":{"201":{"description":"Created"}}}},"/mint/organizations/{org_name}":{"get":{"summary":"Get the organization profile","tags":["Organization profile"],"operationId":"getOrganizationProfile","description":"Gets the organization profile. See also <a href=\"http://docs.apigee.com/monetization/content/edit-organization-profile#view-api\">View the organization profile using the API</a>.","parameters":[{"$ref":"#/components/parameters/org_name"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrganizationProfile"}}}}}},"put":{"summary":"Update organization profile","tags":["Organization profile"],"operationId":"updateOrganizationProfile","description":"Update the organization profile. See also <a href=\"http://docs.apigee.com/monetization/content/edit-organization-profile#edit-api\">Edit the organization profile using the API</a>.\n\n**Note**: When you update the organization profile, you need to specify all the organization profile settings, not only the settings you want to update. You might want to <a href=\"https://apidocs.apigee.com/docs/monetization/1/routes/mint/organizations/%7Borg_name%7D/get\">get the organization profile</a> copy the response payload, modify it as required, and then pass the modified payload in the request body.","parameters":[{"$ref":"#/components/parameters/org_name"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Organization"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrganizationProfile"}}},"description":"Organization profile."}}},"/mint/organizations/{org_name}/developers/{developer_email}/developer-balances/recurring-setup":{"post":{"summary":"Set up automatic reload of prepaid account balance for a developer","tags":["Prepaid account balances"],"operationId":"automaticReloadPrepaidAccountBalanceDev","description":"Set up automatic reload of prepaid account balance for a developer. See also <a href=\"http://docs.apigee.com/monetization/content/manage-prepaid-balances#settingupautomaticreloadofprepaidaccountbalancesusingtheapi-settingupautomaticreloadofprepaidaccountbalancesforadeveloper\">Setting up automatic reload of prepaid account balances for a developer</a>.","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/developer_email"},{"$ref":"#/components/parameters/supportedCurrencyId"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PrepaidBalanceDevelopers"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PrepaidBalanceReload"}}},"description":"Automatic prepaid account balance details."}}},"/mint/organizations/{org_name}/companies/{company_id}/developer-balances/recurring-setup":{"post":{"summary":"Set up automatic reload of prepaid account balance for a company","tags":["Prepaid account balances"],"operationId":"automaticReloadPrepaidAccountBalanceCompany","description":"Set up automatic reload of prepaid account balance for a company. See also <a href=\"https://docs.apigee.com/api-platform/monetization/manage-prepaid-balances#settingupautomaticreloadofprepaidaccountbalancesusingtheapi-settingupautomaticreloadofprepaidaccountbalancesforacompany\">Setting up automatic reload of prepaid account balances for a company</a>.","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/company_id"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PrepaidBalanceReload"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PrepaidBalanceReload"}}},"description":"Automatic prepaid account balance details."}}},"/mint/organizations/{org_name}/companies/{company_id}/developer-balances":{"get":{"summary":"Get prepaid account balance and recurring setup for a company","tags":["Prepaid account balances"],"operationId":"getPrepaidAccountBalanceRecurringCompany","description":"Gets prepaid account balance and recurring setup for a company. See also <a href=\"http://docs.apigee.com/monetization/content/manage-prepaid-balances#getbalancesapi-viewingprepaidaccountbalancesforacompany\">Viewing prepaid account balances for a company</a>.","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/company_id"},{"$ref":"#/components/parameters/all"},{"$ref":"#/components/parameters/size"},{"$ref":"#/components/parameters/page"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PrepaidBalances"}}}}}},"post":{"summary":"Reload prepaid account balance for a company","tags":["Prepaid account balances"],"operationId":"reloadPrepaidAccountBalanceCompany","description":"Reload prepaid account balance for a company. See also <a href=\"http://docs.apigee.com/monetization/content/manage-prepaid-balances#reload\">Reloading a prepaid account balance using the API</a>.","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/company_id"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PrepaidBalance"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Reload"}}},"description":"Automatic prepaid account balance details."}}},"/mint/organizations/{org_name}/developers/{developer_email}/developer-balances":{"get":{"summary":"Account balance for a developer","tags":["Prepaid account balances"],"operationId":"getPrepaidAccountBalanceDev","description":"Gets account balance for a developer. See also <a href=\"http://docs.apigee.com/monetization/content/manage-prepaid-balances#getbalancesapi-viewingprepaidaccountbalancesforadeveloper\">Viewing prepaid account balances for a developer</a>.","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/developer_email"},{"$ref":"#/components/parameters/all"},{"$ref":"#/components/parameters/size"},{"$ref":"#/components/parameters/page"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PrepaidBalances"}}}}}},"post":{"summary":"Reload prepaid account balance for a developer","tags":["Prepaid account balances"],"operationId":"relaodPrepaidAccountBalanceDev","description":"Reload prepaid account balance for a developer. See also <a href=\"http://docs.apigee.com/monetization/content/manage-prepaid-balances#reload\">Reloading a prepaid account balance using the API</a>.","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/developer_email"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PrepaidBalance"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Reload"}}},"description":"Automatic prepaid account balance details."}}},"/mint/organizations/{org_name}/developers/{developer_email}/prepaid-developer-balance":{"get":{"summary":"Get prepaid account balance, top up, and tax information for a developer","tags":["Prepaid account balances"],"operationId":"getAccountDetailsDev","description":"Gets prepaid account balance information including current and total balance, usage, top ups, and usage tax. See also <a href=\"http://docs.apigee.com/monetization/content/manage-prepaid-balances#getbalancesapi-viewingprepaidaccountbalancesforadeveloper\">Viewing prepaid account balances for a developer</a>.","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/developer_email"},{"$ref":"#/components/parameters/billingMonth"},{"$ref":"#/components/parameters/billingYear"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PrepaidBalanceDevelopers"}}}}}}},"/mint/organizations/{org_name}/companies/{company_id}/eligible-products":{"get":{"summary":"Get eligible API products for a company","tags":["API products"],"operationId":"getEligibleAPIProductsCompany","description":"Gets the API products that a company is eligible to access, including:\n\n* API products for which a company has accepted a rate plan.\n* API products that do not have a published rate plan.\n\nSee also <a href=\"https://docs.apigee.com/api-platform/publish/using-edge-management-api-publish-apis#viewingapiproducts\">View API products</a>.</p>","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/company_id"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EligibleProducts"}}}}}}},"/mint/organizations/{org_name}/developers":{"get":{"summary":"Get monetization information for developers","tags":["Developers"],"operationId":"getMonetizationDevs","description":"Gets the monetization information for all developers in an organization.\n\nYou can define the monetization information by passing custom attributes when <a href=\"https://apidocs.apigee.com/docs/developers/1/routes/organizations/%7Borg_name%7D/developers/post\">creating</a> or <a href=\"https://apidocs.apigee.com/docs/developers/1/routes/organizations/%7Borg_name%7D/developers/%7Bdeveloper_email%7D/post\">updating</a> a developer.\n\nYou can get the monetization custom attributes set using the standard (non-monetization) API to get <a href=\"https://apidocs.apigee.com/docs/developers/1/routes/organizations/%7Borg_name%7D/developers/get\">all developers</a> or a <a href=\"https://apidocs.apigee.com/docs/developers/1/routes/organizations/%7Borg_name%7D/developers/%7Bdeveloper_email%7D/get\">single developer</a>.","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/all"},{"$ref":"#/components/parameters/size"},{"$ref":"#/components/parameters/page"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Developers"}}}}}}},"/mint/organizations/{org_name}/developers/{developer_email}":{"get":{"summary":"Get monetization information for a developer","tags":["Developers"],"operationId":"getMonetizationDev","description":"Gets the monetization information for a developers in an organization.\n\nYou can define the monetization information by passing custom attributes when <a href=\"https://apidocs.apigee.com/docs/developers/1/routes/organizations/%7Borg_name%7D/developers/post\">creating</a> or <a href=\"https://apidocs.apigee.com/docs/developers/1/routes/organizations/%7Borg_name%7D/developers/%7Bdeveloper_email%7D/post\">updating</a> a developer.\n\nYou can get the monetization custom attributes set using the standard (non-monetization) API to get <a href=\"https://apidocs.apigee.com/docs/developers/1/routes/organizations/%7Borg_name%7D/developers/get\">all developers</a> or a <a href=\"https://apidocs.apigee.com/docs/developers/1/routes/organizations/%7Borg_name%7D/developers/%7Bdeveloper_email%7D/get\">single developer</a>.","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/developer_email"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Developer"}}}}}}},"/mint/organizations/{org_name}/developers/{developer_email}/eligible-products":{"get":{"summary":"Get eligible API products for a developer","tags":["API products"],"operationId":"getEligibleAPIProductsDev","description":"Gets the API products that a developer is eligible to access, including:\n\n* API products for which a developer has accepted a rate plan.\n* API products that do not have a published rate plan.\n\nSee also <a href=\"https://docs.apigee.com/api-platform/publish/using-edge-management-api-publish-apis#viewingapiproducts\">View API products</a>.</p>","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/developer_email"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EligibleProducts"}}}}}}},"/mint/organizations/{org_name}/providers":{"get":{"summary":"Get third-party payment providers","tags":["Prepaid account balances"],"operationId":"getThirdPartyPaymentProviders","description":"Gets third-party payment providers for your organization. See also <a href=\"https://docs.apigee.com/api-platform/monetization/manage-prepaid-balances#view-payment-providers\">Viewing the payment providers configured for your organization</a>.","parameters":[{"$ref":"#/components/parameters/org_name"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentProviders"}}}}}},"post":{"summary":"Configure third-party payment provider","tags":["Prepaid account balances"],"operationId":"Configure third-party payment provider","description":"Configure third-party payment providers for your organization. See also <a href=\"https://docs.apigee.com/api-platform/monetization/manage-prepaid-balances#worldpay-edge\">Viewing the payment providers configured for your organization</a>.","parameters":[{"$ref":"#/components/parameters/org_name"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentProvider"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentProvider"}}},"description":"Third-party payment provider details."}}},"/mint/organizations/{org_name}/providers/{provider_id}":{"put":{"summary":"Update third-party payment provider","tags":["Prepaid account balances"],"operationId":"updateThirdPartyPaymentProvider","description":"Updates third-party payment providers for your organization. See also <a href=\"https://docs.apigee.com/api-platform/monetization/manage-prepaid-balances#worldpay-edge\">Viewing the payment providers configured for your organization</a>.","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/provider_id"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentProvider"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentProvider"}}},"description":"Payment provider details."}},"delete":{"summary":"Delete third-party payment provider","tags":["Prepaid account balances"],"operationId":"deleteThirdPartyPaymentProvider","description":"Deletes third-party payment provider for your organization. See also <a href=\"https://docs.apigee.com/api-platform/monetization/manage-prepaid-balances#managingprepaidaccountbalancesusingapaymentprovider-deletingthirdpartypaymentproviders>Deleting third-party payment providers\"</a>.","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/provider_id"}],"responses":{"204":{"description":"OK"}}}},"/mint/organizations/{org_name}/rate-plans":{"get":{"summary":"List rate plans for an organization","operationId":"listRatePlansOrg","tags":["Rate plans"],"description":"Lists rate plans for your organization. See also <a href=\"http://docs.apigee.com/monetization/content/view-rate-plans#viewingrateplansusingtheapi\">Viewing rate plans using the API</a>.","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/all"},{"$ref":"#/components/parameters/size"},{"$ref":"#/components/parameters/page"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Rateplans"}}}}}}},"/mint/organizations/{org_name}/monetization-packages/{package_id}/rate-plans":{"post":{"summary":"Create a rate plan","operationId":"createRatePlan","tags":["Rate plans"],"description":"A rate plan specifies the monetization approach for your API package or for individual API products in the package. For example, it specifies whether you charge for the use of your API package and products based on a flat rate or a variable rate, and whether there are additional fees.\n\nYou define the type of plan to indicate whether it applies to all developers, developers in a specific category, or a specific developer. You can configure the following features:\n\n* Set a one-time or recurring fee for the plan\n* Add a freemium part to the plan enabling devleopers to try out features for free over a period of time\n* Configure a rate plan type, such as revenue share, rate card, or combination\n* Set a renewal period\n* Define product-specific plans, if desired\n\nAfter you initially set up a rate plan, you can update it to add fees, add a fremium plan, or specify additional rate plan details.\n\n**Note**: You can set up multiple rate plans for an API package.\n\nSee also <a href=\"http://docs.apigee.com/monetization/content/create-rate-plans\">Create rate plans</a>.","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/package_id"}],"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Rateplan"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Rateplan"}}},"description":"Rate plan details."}},"get":{"summary":"List rate plans for an API package","operationId":"listRatePlansAPIPackage","tags":["Rate plans"],"description":"Lists rate plans for an API package. See also <a href=\"http://docs.apigee.com/monetization/content/view-rate-plans#viewingrateplansusingtheapi\">Viewing rate plans using the API</a>.","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/package_id"},{"$ref":"#/components/parameters/current"},{"$ref":"#/components/parameters/showPrivate"},{"$ref":"#/components/parameters/standard"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Rateplans"}}}}}}},"/mint/organizations/{org_name}/monetization-packages/{package_id}/rate-plans/{plan_id}":{"put":{"summary":"Update a rate plan","operationId":"updateRatePlan","tags":["Rate plans"],"description":"Update a rate plan for an API package. See also <a href=\"http://docs.apigee.com/monetization/content/publish-rate-plans#updaterpapi\">Editing a rate plan draft using the API</a>.","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/package_id"},{"$ref":"#/components/parameters/plan_id"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Rateplan"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Rateplan"}}},"description":"Rate plan details."}},"get":{"summary":"Get a rate plan","operationId":"getRatePlan","tags":["Rate plans"],"description":"Gets a rate plan for an API package. See also <a href=\"http://docs.apigee.com/monetization/content/view-rate-plans#viewingrateplansusingtheapi-viewingarateplanforanapipackageusingtheapi\">Viewing a rate plan for an API package using the API</a>.","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/package_id"},{"$ref":"#/components/parameters/plan_id"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Rateplan"}}}}}},"delete":{"summary":"Delete a rate plan","operationId":"deleteRatePlan","tags":["Rate plans"],"description":"Deletes a rate plan for an API package that is in draft mode. You cannot delete a rate plan once it has been published. See also <a href=\"http://docs.apigee.com/monetization/content/publish-rate-plans#deleterpapi\">Deleting a rate plan draft using the API</a>.","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/package_id"},{"$ref":"#/components/parameters/plan_id"}],"responses":{"204":{"description":"Success, No Content"}}}},"/mint/organizations/{org_name}/monetization-packages/{package_id}/rate-plans/{plan_id}/revision":{"post":{"summary":"Create a rate plan revision (or future rate plan)","operationId":"createRatePlanRevision","tags":["Rate plans"],"description":"Create a revision of an existing rate plan. A revision is a new plan; the original plan and the revision both exist as rate plans.\n\nAfter an existing rate plan is published, the only property you can change is its end date. However, you can create a new version of the plan that includes changed properties, such as changed rate plan rates. You can set up the revision to go into effect at a future date. The original rate plan ends when the revision goes into effect.\n\nDevelopers are notified about the revision. Those developers who accept the original rate plan are automatically registered for the revision (but have the option of rejecting the revision).\n\nSee also <a href=\"http://docs.apigee.com/monetization/content/create-future-rate-plans#setupfrpapi\">Creating a future rate plan using the API</a>.</p>'","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/package_id"},{"$ref":"#/components/parameters/plan_id"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Rateplan"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Rateplan"}}},"description":"Rate plan details."}}},"/mint/organizations/{org_name}/developers/{developer_email}/developer-rateplans":{"get":{"summary":"List active rate plans for a developer","operationId":"listActiveRatePlansDev","tags":["Rate plans"],"description":"Lists active rate plans for a developer. See also <a href=\"http://docs.apigee.com/monetization/content/view-rate-plans#viewingrateplansusingtheapi-viewingallactiverateplansforadeveloperusingtheapi\">Viewing all active rate plans for a developer using the API.</a>","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/developer_email"},{"$ref":"#/components/parameters/all"},{"$ref":"#/components/parameters/size"},{"$ref":"#/components/parameters/page"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Rateplans"}}}}}},"post":{"summary":"Accept rate plan","operationId":"acceptRatePlan","tags":["Rate plans"],"description":"Accept a published rate plan for a developer. See also <a href=\"http://docs.apigee.com/monetization/content/subscribe-published-rate-plan-using-api\">Accept published rate plans using the API</a>.","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/developer_email"}],"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeveloperRatePlan"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AcceptRateplan"}}},"description":"Accept rate plan."}}},"/mint/organizations/{org_name}/developers/{developer_email}/developer-rateplans/{developer_rateplan_id}":{"get":{"summary":"Get an accepted rate plan for a developer","operationId":"getAcceptedRatePlanDev","tags":["Rate plans"],"description":"Gets an active rate plan for a developer. See also <a href=\"http://docs.apigee.com/monetization/content/view-rate-plans#viewingrateplansusingtheapi-viewinganactiverateplanforadeveloperusingtheapi\">Viewing an active rate plan for a developer using the API</a>.","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/developer_email"},{"$ref":"#/components/parameters/developer_rateplan_id"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeveloperRatePlan"}}}}}}},"/mint/organizations/{org_name}/developers/{developer_email}/products/{product_id}/rate-plan-by-developer-product":{"get":{"summary":"List active rate plans that contain an API product","operationId":"listAllActiveRatePlansWithProduct","tags":["Rate plans"],"description":"Lists active rate plans for a developer that contain an API product. See also <a href=\"http://docs.apigee.com/monetization/content/view-rate-plans#viewingrateplansusingtheapi-viewingallactiverateplansforadeveloperthatcontainanapiproductusingtheapi\">Viewing all active rate plans for a developer that contain an API product using the API</a>.","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/developer_email"},{"$ref":"#/components/parameters/product_id"},{"$ref":"#/components/parameters/showPrivate"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Rateplans"}}}}}}},"/mint/organizations/{org_name}/developers/{developer_email}/developer-accepted-rateplans":{"get":{"summary":"Get rate plans accepted by a developer","operationId":"listAcceptedRatePlans","tags":["Rate plans"],"description":"Lists rate plans accepted by a developer. See also <a href=\"http://docs.apigee.com/monetization/content/view-rate-plans#viewingrateplansusingtheapi-viewingallrateplansacceptedbyadeveloperusingtheapi\">Viewing all rate plans accepted by a developer using the API</a>.","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/developer_email"},{"$ref":"#/components/parameters/all"},{"$ref":"#/components/parameters/size"},{"$ref":"#/components/parameters/page"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeveloperRatePlans"}}}}}}},"/mint/organizations/{org_name}/monetization-packages/{package_id}/refund-transactions":{"post":{"summary":"Post a refund","tags":["Refunds"],"operationId":"postRefund","description":"Post a refund to an API package. See also <a href=\"http://docs.apigee.com/monetization/content/post-refunds#postrefundapi\">Posting a refund using the API</a>.","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/package_id"},{"$ref":"#/components/parameters/monetizationPackageId"},{"$ref":"#/components/parameters/parentTxId"},{"$ref":"#/components/parameters/refundAmount"},{"$ref":"#/components/parameters/revenueType"},{"$ref":"#/components/parameters/transactionNote"}],"responses":{"201":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Transaction"}}}}}}},"/mint/organizations/{org_name}/report-definitions":{"post":{"summary":"Create a report definition","tags":["Reports"],"operationId":"createReportDefinition","description":"Create a report definition for an organization. You must create a report definition before you can generate a report. See also <a href=\"http://docs.apigee.com/monetization/content/create-reports#createreportdefapi\">Creating a report definition using the API</a>.","parameters":[{"$ref":"#/components/parameters/org_name"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReportDefinition"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReportDefinition"}}},"description":"Report definition details."}},"get":{"summary":"Get report definitions","tags":["Reports"],"operationId":"getReportDefinitions","description":"Gets report definitions for an organization. You can specify query parameters to limit the number of report definitions returned or to sort them using a specified field. See also <a href=\"http://docs.apigee.com/monetization/content/create-reports#getreportdefapi\">Viewing report definitions using the API</a>.","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/all"},{"$ref":"#/components/parameters/size"},{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/sort"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReportDefinitions"}}}}}}},"/mint/organizations/{org_name}/developers/{developer_email}/report-definitions":{"post":{"summary":"Create a report definition for a developer","tags":["Reports"],"operationId":"createReportDefinitionDev","description":"Create a report definition for a developer. You must create a report definition before you can generate a report. See also <a href=\"http://docs.apigee.com/monetization/content/create-reports#createreportdefapi\">Creating a report definition using the API</a>.","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/developer_email"}],"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReportDefinition"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReportDefinition"}}},"description":"Report definition details."}},"get":{"summary":"Get report definitions for a developer.","tags":["Reports"],"operationId":"getReportDefinitionsDev","description":"Gets report definitions for a developer. You can specify query parameters to limit the number of report definitions returned or to sort them using a specified field. See also <a href=\"http://docs.apigee.com/monetization/content/create-reports#getreportdefapi\">Viewing report definitions using the API</a>.","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/developer_email"},{"$ref":"#/components/parameters/all"},{"$ref":"#/components/parameters/size"},{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/sort"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReportDefinitions"}}}}}}},"/mint/organizations/{org_name}/report-definitions/{report_definition_id}":{"put":{"summary":"Update a report definition","tags":["Reports"],"operationId":"updateReportDefinition","description":"Updates a report definition. See also <a href=\"http://docs.apigee.com/monetization/content/create-reports#updatereportdefapi\">Updating a report definition using the API</a>.","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/report_definition_id"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReportDefinition"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReportDefinition"}}},"description":"Report definition details."}},"get":{"summary":"Get report definition.","tags":["Reports"],"operationId":"getReportDefinition","description":"Gets details for a report definition. See also <a href=\"http://docs.apigee.com/monetization/content/create-reports#getreportdefapi\">Viewing report definitions using the API</a>.","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/report_definition_id"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReportDefinition"}}}}}},"delete":{"summary":"Delete a report definition.","tags":["Reports"],"operationId":"deleteReportDefintion","description":"Deletes the specified report definition. See also <a href=\"http://docs.apigee.com/monetization/content/create-reports#deletereportdefapi\">Deleting a report definition using the API</a>.","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/report_definition_id"}],"responses":{"204":{"description":"No Content"}}}},"/mint/organizations/{org_name}/{report_type}":{"post":{"summary":"Generate a report.","tags":["Reports"],"operationId":"generateReport","description":"Generate a report of the specified type. See also <a href=\"http://docs.apigee.com/monetization/content/create-reports#genreportapi\">Generating a report using the API</a>.","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/report_type"}],"responses":{"200":{"description":"OK"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MintCriteria"}}},"description":"Criteria used to generate report."}}},"/mint/organizations/{org_name}/developers/{developer_email}/revenue-reports":{"post":{"summary":"Generate a revenue report for a developer.","tags":["Reports"],"operationId":"generateRevenueReportDev","description":"Generates a revenue report for a developer. See also <a href=\"http://docs.apigee.com/monetization/content/create-reports#genreportapi\">Generating a report using the API</a>.","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/developer_email"}],"responses":{"200":{"description":"OK"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MintCriteria"},"example":{"appCriteria":"","billingMonth":"JULY","billingYear":"2015","currCriteria":"","currencyOption":"USD","devCriteria":"","devCustomAttribute":"object","fromDate":"","groupBy":[""],"monetizationPackageIds":[""],"pkgCriteria":"","prevFromDate":"","prevToDate":"","prodCriteria":"","productIds":[""],"pricingTypes":"","ratePlanLevels":"","showEntityId":false,"showRevSharePct":false,"showSummary":false,"showTxDetail":false,"showTxType":false,"toDate":"","transactionStatus":"","transactionCustomAttributes":"","transactionTypes":"object"}}},"description":"Search criteria."}}},"/mint/organizations/{org_name}/transaction-search":{"post":{"summary":"Get transaction activity","tags":["Reports"],"operationId":"getTransactionActivity","description":"Gets transaction activity for the specified organization using the specified criteria. See also <a href=\"http://docs.apigee.com/monetization/content/create-reports#reptransactapi\">Reporting transaction activity using the API</a>.","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/all"},{"$ref":"#/components/parameters/size"},{"$ref":"#/components/parameters/page"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Transactions"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MintCriteria"}}},"description":"Criteria used to search for transactions."}}},"/mint/organizations/{org_name}/applications-with-transactions":{"get":{"summary":"Get transaction activity for applications","tags":["Transaction activity"],"operationId":"getTransactionActivityApplications","description":"Gets transaction activity for applications. See also <a href=\"http://docs.apigee.com/monetization/content/create-reports#reptransactapi\">Reporting transaction activity using the API</a>.","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/START_DATE"},{"$ref":"#/components/parameters/END_DATE"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"application":{"type":"array","description":"List of applications.","items":{"$ref":"#/components/schemas/Application"}}}}}}}}}},"/mint/organizations/{org_name}/developers-with-transactions":{"get":{"summary":"Get transaction activity for a developers","tags":["Transaction activity"],"operationId":"get transaction activity for developers","description":"Gets transaction activity for developers. See also <a href=\"http://docs.apigee.com/monetization/content/create-reports#reptransactapi\">Reporting transaction activity using the API</a>.","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/START_DATE"},{"$ref":"#/components/parameters/END_DATE"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Developers"}}}}}}},"/mint/organizations/{org_name}/products-with-transactions":{"get":{"summary":"Get transaction activity for API products","tags":["Transaction activity"],"operationId":"getTransactionActivityAPIProducts","description":"Gets transaction activity for API products. See also <a href=\"http://docs.apigee.com/monetization/content/create-reports#reptransactapi\">Reporting transaction activity using the API</a>.","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/START_DATE"},{"$ref":"#/components/parameters/END_DATE"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIProducts"}}}}}}},"/mint/organizations/{org_name}/packages-with-transactions":{"get":{"summary":"List API packages with transactions","tags":["Transaction activity"],"operationId":"listAPIPackagesTransactions","description":"Lists API packages with transactions for the specified organization. See also <a href=\"http://docs.apigee.com/monetization/content/create-reports#reptransactapi\">Reporting transaction activity using the API</a>.","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/START_DATE"},{"$ref":"#/components/parameters/END_DATE"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIPackages"}}}}}}},"/triggers":{"get":{"summary":"List currently scheduled monetization jobs","tags":["Scheduled jobs"],"operationId":"listScheduledMonetizationJobs","description":"Lists currently scheduled monetization jobs. See also <a href=\"http://docs.apigee.com/monetization/content/schedule-monetization-jobs#getschedjobsapi\">Viewing scheduled jobs using the API</a>.\n\n**Notes:**\n\n* **Apigee Edge Private Cloud customers only**. You must have `system admin` privileges to use the APIs. Apigee Edge Cloud customers should contact <a href=\"https://cloud.google.com/apigee/support\">Apigee Support</a> for assistance with managing the monetization job schedule.\n* **This API cannot be executed using the Try this API panel**.","parameters":[{"$ref":"#/components/parameters/orgid"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScheduledJobs"}}}}}}},"/triggers/{trig_id}":{"get":{"summary":"Get a scheduled job","tags":["Scheduled jobs"],"operationId":"getScheduledMonetizationJob","description":"Gets a scheduled monetization job. See also <a href=\"http://docs.apigee.com/monetization/content/schedule-monetization-jobs#getschedjobsapi\">Viewing scheduled jobs using the API</a>.\n\n**Notes:**\n\n* **Apigee Edge Private Cloud customers only**. You must have `system admin` privileges to use the APIs. Apigee Edge Cloud customers should contact <a href=\"https://cloud.google.com/apigee/support\">Apigee Support</a> for assistance with managing the monetization job schedule.\n* **This API cannot be executed using the Try this API panel**.","parameters":[{"$ref":"#/components/parameters/trig_id"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScheduledJob"}}}}}},"put":{"summary":"Update scheduled monetization jobs","tags":["Scheduled jobs"],"operationId":"updateScheduledMonetizationJobs","description":"Updates scheduled monetization jobs. See also <a href=\"http://docs.apigee.com/monetization/content/schedule-monetization-jobs#updateschedjobapi\">Updating scheduled jobs using the API</a>.\n\n**Notes:**\n\n* **Apigee Edge Private Cloud customers only**. You must have `system admin` privileges to use the APIs. Apigee Edge Cloud customers should contact <a href=\"https://cloud.google.com/apigee/support\">Apigee Support</a> for assistance with managing the monetization job schedule.\n* **This API cannot be executed using the Try this API panel**.","parameters":[{"$ref":"#/components/parameters/trig_id"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScheduledJob"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScheduledJob"}}},"description":"Job request details."}}},"/mint/organizations/{org_name}/suspended-developers":{"get":{"summary":"Get suspended developers","tags":["Suspended developers"],"operationId":"listSuspendedDevelopers","description":"Lists suspended developers for an organization. See also <a href=\"http://docs.apigee.com/monetization/content/unsuspend-developers#viewall-suspended\">Viewing all suspended developers using the API</a>.","parameters":[{"$ref":"#/components/parameters/org_name"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuspendedDevelopers"}}}}}}},"/mint/organizations/{org_name}/suspended-developers/{id}":{"get":{"summary":"Get a suspended developer","tags":["Suspended developers"],"operationId":"getSuspendedDeveloper","description":"Gets a suspended developer for an organization. See also <a href=\"http://docs.apigee.com/monetization/content/unsuspend-developers#view-suspended\">Viewing a suspended developer using the API</a>.","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/id"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuspendedDeveloper"}}}}}},"delete":{"summary":"Unsuspend a developer","tags":["Suspended developers"],"operationId":"unsuspendDeveloper","description":"Unsuspend the specified developer. See also <a href=\"http://docs.apigee.com/monetization/content/unsuspend-developers#unsuspend-dev\">Unsuspending a developer using the API</a>.","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/id"}],"responses":{"204":{"description":"No Content"}}}},"/mint/organizations/{org_name}/suspended-developers/unsuspend-by-product/{suspendedProduct_id}":{"post":{"summary":"Unsuspend all developers for an API product","tags":["Suspended developers"],"operationId":"Unsuspend all developers for an API product","description":"Unsuspend all developers for an API product. See also <a href=\"http://docs.apigee.com/monetization/content/unsuspend-developers#unsuspend-product\">Unsuspending all developers for an API product using the API</a>.","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/suspendedProduct_id"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuspendedDeveloper"}}}}}}},"/mint/organizations/{org_name}/sync-organization":{"get":{"summary":"Synchronize with monetization your organization","tags":["Synchronize monetization"],"operationId":"synchronizeOrgWithMonetization","description":"Synchronize with monetization your organization. See also <a href=\"http://docs.apigee.com/monetization/content/synchronize-apigee-edge-data-monetization#syncorgapi\">Synchronizing your organization using the API</a>.","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/childEntities"}],"responses":{"200":{"description":"OK"}}}},"/mint/organizations/{org_name}/sync-products":{"get":{"summary":"Synchronize with monetization all API products","tags":["Synchronize monetization"],"operationId":"Synchronize with monetization all API products","description":"Synchronize with monetization the API products in your organization. See also <a href=\"http://docs.apigee.com/monetization/content/synchronize-apigee-edge-data-monetization#syncprodapi\">Synchronizing products using the API</a","parameters":[{"$ref":"#/components/parameters/org_name"}],"responses":{"200":{"description":"OK"}}}},"/mint/organizations/{org_name}/sync-developers":{"get":{"summary":"Synchronize with monetization all developers","tags":["Synchronize monetization"],"operationId":"Synchronize with monetization all developers","description":"Synchronize with monetization the developers in your organization. See also <a href=\"http://docs.apigee.com/monetization/content/synchronize-apigee-edge-data-monetization#syncdevapi\">Synchronizing developers using the API</a>.","parameters":[{"$ref":"#/components/parameters/org_name"}],"responses":{"200":{"description":"OK"}}}},"/mint/organizations/{org_name}/sync-applications":{"get":{"summary":"Synchronize with monetization all applications","tags":["Synchronize monetization"],"operationId":"Synchronize with monetization all applications","description":"Synchronize with monetization the applications in your organization. See also <a href=\"http://docs.apigee.com/monetization/content/synchronize-apigee-edge-data-monetization#syncappapi\">Synchronizing applications using the API</a>.","parameters":[{"$ref":"#/components/parameters/org_name"}],"responses":{"200":{"description":"OK"}}}},"/mint/organizations/{org_name}/tncs":{"get":{"summary":"List terms and conditions","tags":["Terms and conditions"],"operationId":"listTermsConditions","description":"Lists terms and conditions. See also <a href=\"http://docs.apigee.com/monetization/content/specify-terms-and-conditions#gettcapi\">Viewing terms and conditions using the API</a>.","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/all"},{"$ref":"#/components/parameters/size"},{"$ref":"#/components/parameters/page"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TNCs"}}}}}},"post":{"summary":"Add terms and conditions","tags":["Terms and conditions"],"operationId":"addTermsConditions","description":"Add terms and conditions. See also <a href=\"http://docs.apigee.com/monetization/content/specify-terms-and-conditions#addtcapi\">Adding terms and conditions using the API</a>.","parameters":[{"$ref":"#/components/parameters/org_name"}],"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TNC"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TNC"}}},"description":"Terms and conditions."}}},"/mint/organizations/{org_name}/tncs/{tncs_id}":{"get":{"summary":"Get a terms and conditions document","tags":["Terms and conditions"],"operationId":"getTermsConditionsDocument","description":"Gets a terms and conditions document. See also <a href=\"http://docs.apigee.com/monetization/content/specify-terms-and-conditions#gettcapi\">Viewing terms and conditions using the API</a>.","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/tncs_id"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TNC"}}}}}},"put":{"summary":"Update a terms and conditions document","tags":["Terms and conditions"],"operationId":"updateTermsConditionsDocument","description":"Updates a terms and conditions document. See also <a href=\"http://docs.apigee.com/monetization/content/specify-terms-and-conditions#updatetcapi\">Updating terms and conditions using the API</a>.","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/tncs_id"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TNC"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TNC"}}},"description":"Terms and conditions."}},"delete":{"summary":"Delete a terms and conditions document","tags":["Terms and conditions"],"operationId":"deleteTermsConditionsDocument","description":"Deletes a terms and conditions document. See also <a href=\"http://docs.apigee.com/monetization/content/specify-terms-and-conditions#deletetcapi\">Deleting terms and conditions using the API</a>.","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/tncs_id"}],"responses":{"204":{"description":"No Content"}}}},"/mint/organizations/{org_name}/developers/{developer_email}/developer-tncs":{"get":{"summary":"Get the terms and conditions documents accepted by a developer","tags":["Terms and conditions"],"operationId":"getTermsConditionsDocumentsAcceptedDeveloper","description":"Gets the terms and conditions documents accepted by the specified developer. See also <a href=\"http://docs.apigee.com/monetization/content/specify-terms-and-conditions#getacceptedtcapi\">Viewing terms and conditions accepted by a developer using the API</a>.","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/developer_email"},{"$ref":"#/components/parameters/current"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeveloperTNCs"}}}}}}},"/mint/organizations/{org_name}/developers/{developer_email}/tncs/{tncs_id}/developer-tncs":{"post":{"summary":"Accept a terms and conditions document for a developer","tags":["Terms and conditions"],"operationId":"acceptTermsConditionsDocumentDeveloper","description":"Accept the terms and conditions document for a developer. See also <a href=\"https://docs.apigee.com/api-platform/monetization/specify-terms-and-conditions#api\">Manage terms and conditions using the API</a>.","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/developer_email"},{"$ref":"#/components/parameters/tncs_id"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeveloperTNC"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AcceptTNC"}}},"description":"Report definition details."}}},"/mint/organizations/{org_name}/transactions/developers/{developer_email}":{"get":{"summary":"Get the status of transactions.","operationId":"getStatusTransactions","tags":["Transaction activity"],"description":"Gets the status of transcations that have occurred during a specified time range. See also <a href=\"http://docs.apigee.com/monetization/content/transaction-status\">View the status of transactions</a>.","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/developer_email"},{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/productId"},{"$ref":"#/components/parameters/utctme"},{"$ref":"#/components/parameters/utctme2"}],"responses":{"200":{"description":"Success"}}}}},"components":{"securitySchemes":{"Basic":{"type":"http","scheme":"basic","description":"Multi-factor authentication is not supported."},"OAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"parameters":{"org_name":{"in":"path","name":"org_name","required":true,"schema":{"type":"string"},"description":"Organization name."},"package_id":{"name":"package_id","in":"path","description":"ID of the API package.","required":true,"schema":{"type":"string"}},"product_id":{"name":"product_id","in":"path","description":"ID of the API product.","required":true,"schema":{"type":"string"}},"company_id":{"name":"company_id","in":"path","description":"ID of the company.","required":true,"schema":{"type":"string"}},"billing_adjustment_id":{"name":"billing_adjustment_id","in":"path","description":"ID of the billing adjustment.","required":true,"schema":{"type":"string"}},"template_id":{"name":"template_id","in":"path","description":"ID of the notification email template.","required":true,"schema":{"type":"string"}},"condition_id":{"name":"condition_id","in":"path","description":"ID of the notification condition and action.","required":true,"schema":{"type":"string"}},"webhook_id":{"name":"webhook_id","in":"path","description":"ID of the webhook.","required":true,"schema":{"type":"string"}},"developer_email":{"name":"developer_email","in":"path","description":"ID of the developer.","required":true,"schema":{"type":"string"}},"app_id":{"name":"app_id","in":"path","description":"ID of the application for which you are testing webhook triggering.","required":true,"schema":{"type":"string"}},"rateplan_id":{"name":"rateplan_id","in":"path","description":"ID of the rate plan for which you are testing webhook triggering.","required":true,"schema":{"type":"string"}},"trigger_type":{"name":"trigger_type","in":"path","description":"Name of the webhook notification trigger type. For example, `RATEPLANQUOTAUSAGE`.","required":true,"schema":{"type":"string"}},"trig_id":{"name":"trig_id","in":"path","description":"ID of the job trigger.","required":true,"schema":{"type":"string"}},"id":{"name":"id","in":"path","description":"Email or ID of the developer.","required":true,"schema":{"type":"string"}},"provider_id":{"name":"provider_id","in":"path","description":"ID of the third-party payment provider.","required":true,"schema":{"type":"string"}},"plan_id":{"name":"plan_id","in":"path","description":"ID of the rate plan.","required":true,"schema":{"type":"string"}},"category_id":{"name":"category_id","in":"path","description":"ID of the developer category.","required":true,"schema":{"type":"string"}},"notification_id":{"name":"notification_id","in":"path","description":"ID of the notification item for which you want to display details.","required":true,"schema":{"type":"string"}},"tncs_id":{"name":"tncs_id","in":"path","description":"ID of the terms and conditions document.","required":true,"schema":{"type":"string"}},"supportedcurrency_id":{"name":"supportedcurrency_id","in":"path","description":"ID for the currency.","required":true,"schema":{"type":"string"}},"all":{"name":"all","in":"query","description":"Flag that specifies whether to return all records. If set to `false`, the number of records returned per page is defined by the `size` query parameter.","required":false,"schema":{"type":"boolean","default":false}},"size":{"name":"size","in":"query","description":"Number of records returned per page. If the `all` query parameter is set to `true`, this parameter is ignored.","schema":{"type":"integer","default":20}},"page":{"name":"page","in":"query","description":"Number of the page that you want to return (if content is paginated). If the `all` query parameter is set to `true`, this parameter is ignored.","schema":{"type":"integer","default":1},"required":false},"monetized":{"name":"monetized","in":"query","description":"Flag that specifies whether to return only monetized API products (that is, API products with at least one published rate plan).","schema":{"type":"boolean","default":true},"required":false},"sort":{"name":"sort","in":"query","description":"Name of field on which you would like to sort the results.","required":false,"schema":{"type":"string"}},"current":{"name":"current","in":"query","description":"Flag specifying whether to show only:\n\n* Active API packages (`true`). Defaults to `false` in this case.\n* Current rate plans (`true`), or current, draft, and expired plans (`false`). Defaults to `true` in this case.","required":false,"schema":{"type":"boolean"}},"allAvailable":{"name":"allAvailable","in":"query","description":"Flag specifying whether to show all available packages or only those available to the specified developer. This flag defaults to true.","required":false,"schema":{"type":"boolean","default":true}},"billingMonth":{"name":"billingMonth","in":"query","description":"Billing month for which the credit applies (in all upper-case). For example, APRIL.","required":true,"schema":{"type":"string"}},"billingYear":{"name":"billingYear","in":"query","description":"Billing year for which the credit applies. For example, 2013.","schema":{"type":"string"},"required":true},"currencyId":{"name":"currencyId","in":"query","description":"Currency used for the credit.","schema":{"type":"string"},"required":true},"developerId":{"name":"developerId","in":"query","description":"ID of the developer to whom the credit applies.","required":true,"schema":{"type":"string"}},"productId":{"name":"productId","in":"query","description":"ID of the API product to which the credit applies. If not specified, applies to all API products in the API package.","required":false,"schema":{"type":"string"}},"transactionAmount":{"name":"transactionAmount","in":"query","description":"Amount of credit.","required":true,"schema":{"type":"string"}},"transactionNote":{"name":"transactionNote","in":"query","description":"Note that describes the reason for the credit.","schema":{"type":"string"},"required":true},"supportedCurrencyId":{"name":"supportedCurrencyId","in":"query","description":"Currency used for the credit limit.","schema":{"type":"string"},"required":true},"amount":{"name":"amount","in":"query","description":"Amount of credit limit.","required":true,"schema":{"type":"string"}},"force":{"name":"force","in":"query","description":"Flag that specifies whether to skip validation steps and forcibly set the number of transactions. By default, `?force=false` and validation steps are executed. For example, if a prepaid developer has a zero balance and activity on the account is suspended, if `?force=false` the request will fail during validation.","required":false,"schema":{"type":"boolean"}},"forceDelete":{"name":"forceDelete","in":"query","description":"Flag that specifies whether or not to force the deletion if processes are in progress. Set to `true` to force deleting.","required":false,"schema":{"type":"boolean","default":true}},"startdate":{"name":"startdate","in":"query","description":"Start date in UTC. Use the following format: `YYYY-MM-DD HH:mm:ss`. If you do not specify a timestamp (not recommended), `00:00:00` (midnight) is used by default.","required":false,"schema":{"type":"string"}},"enddate":{"name":"enddate","in":"query","description":"End date in UTC. Use the following format: `YYYY-MM-DD HH:mm:ss`. If you do not specify a timestamp (not recommended), `00:00:00` (midnight) is used by default.","required":false,"schema":{"type":"string"}},"status":{"name":"status","in":"query","description":"Status of the notification. Valid values include: `BLANK_MESSAGE`, `DUPLICATE`, `FAILED`, `NOTIFICATION_SENT`, `OPT_OUT`, `QUEUED`, and `TEMPLATE_NOT_FOUND`.","required":false,"schema":{"type":"string"}},"showPrivate":{"name":"showPrivate","in":"query","description":"Flag that specifies whether to show public and private plans (`true`) or public plans only (`false`).","required":false,"schema":{"type":"boolean","default":false}},"standard":{"name":"standard","in":"query","description":"Flag that specifies whether to display all types of rate plans, including standard, developer, and developer category. Set to `true` to display standard rate plan types only. Set to `false` to display all types.","required":false,"schema":{"type":"boolean","default":true}},"developer_rateplan_id":{"name":"developer_rateplan_id","in":"path","description":"ID of the accepted rate plan that is returned in the response when you accept the rate plan.","required":true,"schema":{"type":"string"}},"monetizationPackageId":{"name":"monetizationPackageId","in":"query","description":"API package to which the refund applies.","schema":{"type":"string"},"required":false},"parentTxId":{"name":"parentTxId","in":"query","description":"The purchase transation to be refunded.","schema":{"type":"string"},"required":true},"refundAmount":{"name":"refundAmount","in":"query","description":"The amount of the refund.","schema":{"type":"number"},"required":true},"revenueType":{"name":"revenueType","in":"query","description":"Revenue type (GROSS or NET) of the purchase transaction.","schema":{"type":"string"},"required":true},"report_definition_id":{"name":"report_definition_id","in":"path","description":"Report definition ID.","required":true,"schema":{"type":"string"}},"report_type":{"name":"report_type","in":"path","description":"Type of report to generate. Valid values include: `billing-reports`, `revenue-reports`, `prepaid-balance-reports`, or `variance-reports`.","required":true,"schema":{"type":"string"}},"START_DATE":{"name":"START_DATE","in":"query","description":"Start date of the transaction activity as `YYYY-MM-DD`.","required":true,"schema":{"type":"string"}},"END_DATE":{"name":"END_DATE","in":"query","description":"End date of the transaction activity as `YYYY-MM-DD`.","required":true,"schema":{"type":"string"}},"orgid":{"name":"orgid","in":"query","description":"Name of your organization.","required":true,"schema":{"type":"string"}},"suspendedProduct_id":{"name":"suspendedProduct_id","in":"path","description":"ID of the API product, using a format similar to the following: `{org_id}@@@{product_id}`. This value is returned as `prodId` when you view all or specific suspended developers.","required":true,"schema":{"type":"string"}},"childEntities":{"name":"childEntities","in":"query","description":"Flag that specifies to synchronize all products, developers, and applications in your organization.","schema":{"type":"boolean"},"required":false},"limit":{"name":"limit","in":"query","description":"Maximum number of transaction records to return. This value must be set to a value less than or equal to 1000. Defaults to 1000.","required":false,"schema":{"type":"integer"}},"utctme":{"name":"utctme","in":"query","description":"Start time in the format `YYYY-MM-DD HH:mm:ss`. If the end time `utctime2` is not specified, the time range will be: `utctime < txTime < utctime - 10 seconds`.","required":true,"schema":{"type":"string"}},"utctme2":{"name":"utctme2","in":"query","description":"End time in the format `YYYY-MM-DD HH:mm:ss`. This value must be no greater than 1 minute from the start time. In this case, the time range will be: `utctime < txTime < utctime2`.","required":false,"schema":{"type":"string"}}},"schemas":{"Organization":{"type":"object","properties":{"approvedTrusted":{"type":"boolean","description":"Flag that specifies whether the developer is given approved status by the organization."},"approvedUntrusted":{"type":"boolean","description":"Flag that specifies whether untrusted developers are given approved status by the organization."},"billingCycle":{"type":"string","description":"Billing cycle period. Valid values include:\n\n* `PRORATED`: Billing is based on the number of days that an API product is used in a calendar month.\n* `CALENDAR_MONTH`: Billing is done monthly."},"country":{"type":"string","description":"<a href=\"https://en.wikipedia.org/wiki/ISO_3166-2\" target=\"_blank\">ISO 3166-2 code</a> for the country of operation for the organization, such as `US` for United States or `BR` for Brazil."},"currency":{"type":"string","description":"<a href=\"https://en.wikipedia.org/wiki/ISO_4217\" target=\"_blank\">ISO 4217 code</a> for the \"base\" or accounting currency that the organization uses, such as `usd` for Unites States dollar. For revenue sharing plans, the specified currency is used for your plan. For rate card (charging model) plans, the specified currency is used by default. However, you can change the currency setting to any currency supported by the organization. For fees only plans, you can change the currency setting to any currency supported by the organization."},"description":{"type":"string","description":"Brief description of the organization."},"hasBillingAdjustment":{"type":"boolean","description":"Flag that specifies whether adjustments are enabled. If enabled, you can make adjustments to the traffic details recorded by API services for your API products."},"hasBroker":{"type":"boolean","description":"Flag that specifies whether the revenue is based on net."},"hasSelfBilling":{"type":"boolean","description":"Flag that directs monetization to generate a self-billing invoice instead of a revenue share statement. A self-billing invoice is a financial document that details the amount due to the developer. It acts as an invoice to the API Provider on behalf of the developer."},"hasSeparateInvoiceForProduct":{"type":"boolean","description":"Flag that specifies whether a separate invoice is generated for each API product."},"id":{"type":"string","description":"ID of the organization."},"issueNettingStmt":{"type":"boolean","description":"Flag that specifies whether a netting statement is generated when creating billing documents."},"logoUrl":{"type":"string","description":"URL of the organization's logo."},"name":{"type":"string","description":"Name of the organization."},"netPaymentAdviceNote":{"type":"string","description":"Net payment advice note."},"nettingStmtPerCurrency":{"type":"boolean","description":"Flag that specifies whether a separate netting statement is generated for each currency used."},"regNo":{"type":"string","description":"Organization's registration number. The registration number is displayed at the bottom of billing documents."},"selfBillingAsExchOrg":{"type":"boolean","description":"This feature is deprecated."},"selfBillingForAllDev":{"type":"boolean","description":"If self-billing invoices are enabled, flag that specifies whether they are enabled for all developers. By default, self-billing invoices are generated only for developers who have signed an agreement with the API provider."},"separateInvoiceForFees":{"type":"boolean","description":"Flag that specifies whether a separate invoice is published for fees."},"status":{"type":"string","description":"Status of the organization. Valid values include:\n\n* `ACTIVE`: The organization account is registered in monetization and is available for use.\n* `INACTIVE`: The organization account is registered in monetization, but is not available for use.</li></ul>'"},"supportedBillingType":{"type":"string","description":"Developer payment model used for billing. Valid values include:\n\n* `PREPAID`: The developer pays in advance for the use of an API product. Funds are deducted from the developer's balance when the API product is used. The developer must maintain a prepaid balance sufficient to purchase the API product.\n* `POSTPAID`: The developer is billed monthly (through an invoice) for the use of API products. The developer pays for the use of API products based on the payment terms set by the plan(s) included on the invoice.\n* `BOTH`: In this case, the billing type defaults to PREPAID."},"taxEngineExternalId":{"type":"string","description":"External ID for a third-party tax engine."},"taxModel":{"type":"string","description":"**Note**: This property only applies if you set up revenue sharing plans and you want monetization to generate billing documents.\n\nTax model you want to use for revenue sharing plans which dictates the type of billing documents that monetization produces. This applies to an individual operator or organization. Valid values include:\n\n* `Disclosed`: In this tax model, the API provider acts as a disclosed agent of the developer. The gross revenue (including sales taxes) collected from the end user is passed to the developer. The API provider’s commission is collected from the developer in the form of a commission invoice. The API provider does not handle the sales tax collected from the end user, and it is the developer’s responsibility to report the sales tax.\n\n* `Undisclosed`: In this tax model, the API provider acts as an undisclosed agent of the developer, and deducts the tax collected from the end users and pays it to the local tax authorities. The developer invoices the API provider for the net revenue share due to the developer (less sales taxes and the API provider’s commission).\n\n* `Hybrid`: In this tax model, the API provider acts as a disclosed agent of the developer. However, the API provider pays the sales tax collected from their subscribers to the local tax authorities on the developer’s behalf. The API provider passes the remaining revenue to the developer, and then invoices for commission charges."},"taxNexus":{"type":"string","description":"The country in which the organization is registered for tax purposes.\n\n**Note**: If the tax nexus is the United States, you need to provide additional information on all the states where you are registered for tax purposes. You provide this information as part of a configuration questionnaire when you first purchase monetization."},"taxRegNo":{"type":"string","description":"Organization’s tax registration number or Value Added Tax (VAT) registration number, if applicable. This property is optional because the tax registration number or VAT registration number does not apply in all countries. The VAT registration number is displayed at the bottom of billing documents."},"transactionalRelayURL":{"type":"string","description":"URL of another system to which transactions can be relayed, such as a data warehouse."},"timezone":{"type":"string","description":"The time zone identifier for the organization’s operations, such as America/New_York or Europe/Paris. Time zone abbreviations, such as EST (Eastern Standard Time) or CET (Central European Time), are also supported. Use caution when updating the timezone setting in an organization profile, as it can impact date- and time-based events including when a rate plan starts and ends and when notifications are sent."}}},"OrganizationProfile":{"required":["name"],"type":"object","properties":{"address":{"type":"array","items":{"$ref":"#/components/schemas/Address"},"description":"Address of the organization.\n\n**Note**: The address is displayed at the API package-level only."},"approvedTrusted":{"type":"boolean","description":"Flag that specifies whether the developer is given approved status by the organization."},"approvedUntrusted":{"type":"boolean","description":"Flag that specifies whether untrusted developers are given approved status by the organization."},"billingCycle":{"type":"string","description":"Billing cycle period. Valid values include:\n\n* `PRORATED`: Billing is based on the number of days that an API product is used in a calendar month.\n* `CALENDAR_MONTH`: Billing is done monthly."},"country":{"type":"string","description":"<a href=\"https://en.wikipedia.org/wiki/ISO_3166-2\">ISO 3166-2 code</a> for the country of operation for the organization, such as US for United States or BR for Brazil.'"},"currency":{"type":"string","description":"<a href=\"https://en.wikipedia.org/wiki/ISO_4217\">ISO 4217 code</a> for the \"base\" or accounting currency that the organization uses, such as `usd` for Unites States dollar. For revenue sharing plans, the specified currency is used for your plan. For rate card (charging model) plans, the specified currency is used by default. However, you can change the currency setting to any currency supported by the organization. For fees only plans, you can change the currency setting to any currency supported by the organization."},"description":{"type":"string","description":"Brief description of the organization."},"hasBillingAdjustment":{"type":"boolean","description":"Flag that specifies whether adjustments are enabled. If enabled, you can make adjustments to the traffic details recorded by API services for your API products."},"hasBroker":{"type":"boolean","description":"Flag that specifies whether the revenue is based on net."},"hasSelfBilling":{"type":"boolean","description":"Flag that directs monetization to generate a self-billing invoice instead of a revenue share statement. A self-billing invoice is a financial document that details the amount due to the developer. It acts as an invoice to the API Provider on behalf of the developer."},"hasSeparateInvoiceForProduct":{"type":"boolean","description":"Flag that specifies whether a separate invoice is generated for each API product."},"id":{"type":"string","description":"ID of the organization."},"issueNettingStmt":{"type":"boolean","description":"Flag that specifies whether a netting statement is generated when creating billing documents."},"logoUrl":{"type":"string","description":"URL of the organization's logo."},"name":{"type":"string","description":"Name of the organization."},"netPaymentAdviceNote":{"type":"string","description":"Net payment advice note."},"nettingStmtPerCurrency":{"type":"boolean","description":"Flag that specifies whether a separate netting statement is generated for each currency used."},"regNo":{"type":"string","description":"Organization's registration number. The registration number is displayed at the bottom of billing documents."},"selfBillingAsExchOrg":{"type":"boolean","description":"This feature is deprecated."},"selfBillingForAllDev":{"type":"boolean","description":"If self-billing invoices are enabled, flag that specifies whether they are enabled for all developers. By default, self-billing invoices are generated only for developers who have signed an agreement with the API provider."},"separateInvoiceForFees":{"type":"boolean","description":"Flag that specifies whether a separate invoice is published for fees."},"status":{"type":"string","description":"Status of the organization. Valid values include:\n\n* `ACTIVE`: The organization account is registered in monetization and is available for use.\n* `INACTIVE`: The organization account is registered in monetization, but is not available for use.</li></ul>'"},"supportedBillingType":{"type":"string","description":"Developer payment model used for billing. Valid values include:\n\n* `PREPAID`: The developer pays in advance for the use of an API product. Funds are deducted from the developer's balance when the API product is used. The developer must maintain a prepaid balance sufficient to purchase the API product.\n* `POSTPAID`: The developer is billed monthly (through an invoice) for the use of API products. The developer pays for the use of API products based on the payment terms set by the plan(s) included on the invoice.\n* `BOTH`: In this case, the billing type defaults to `PREPAID`."},"taxEngineExternalId":{"type":"string","description":"External ID for a third-party tax engine."},"taxModel":{"type":"string","description":"**Note**: This property only applies if you set up revenue sharing plans and you want monetization to generate billing documents.\n\nTax model you want to use for revenue sharing plans which dictates the type of billing documents that monetization produces. This applies to an individual operator or organization. Valid values include:\n\n* `Disclosed`: In this tax model, the API provider acts as a disclosed agent of the developer. The gross revenue (including sales taxes) collected from the end user is passed to the developer. The API provider’s commission is collected from the developer in the form of a commission invoice. The API provider does not handle the sales tax collected from the end user, and it is the developer’s responsibility to report the sales tax.\n\n* `Undisclosed`: In this tax model, the API provider acts as an undisclosed agent of the developer, and deducts the tax collected from the end users and pays it to the local tax authorities. The developer invoices the API provider for the net revenue share due to the developer (less sales taxes and the API provider’s commission).\n\n* `Hybrid`: In this tax model, the API provider acts as a disclosed agent of the developer. However, the API provider pays the sales tax collected from their subscribers to the local tax authorities on the developer’s behalf. The API provider passes the remaining revenue to the developer, and then invoices for commission charges."},"taxNexus":{"type":"string","description":"The country in which the organization is registered for tax purposes.\n\n**Note**: If the tax nexus is the United States, you need to provide additional information on all the states where you are registered for tax purposes. You provide this information as part of a configuration questionnaire when you first purchase monetization."},"taxRegNo":{"type":"string","description":"Organization’s tax registration number or Value Added Tax (VAT) registration number, if applicable. This property is optional because the tax registration number or VAT registration number does not apply in all countries. The VAT registration number is displayed at the bottom of billing documents."},"transactionalRelayURL":{"type":"string","description":"URL of another system to which transactions can be relayed, such as a data warehouse."},"timezone":{"type":"string","description":"The time zone identifier for the organization’s operations, such as America/New_York or Europe/Paris. Time zone abbreviations, such as EST (Eastern Standard Time) or CET (Central European Time), are also supported. Use caution when updating the timezone setting in an organization profile, as it can impact date- and time-based events including when a rate plan starts and ends and when notifications are sent"}}},"BillingAdjustment":{"required":["adjustmentPercentageFactor","billingMonth","billingYear","name","organization"],"type":"object","properties":{"adjustmentPercentageFactor":{"type":"number","description":"Percentage factor by which the bill was adjusted. This value can be positive or negative decimal value to increase or reduce the bill, respectively. Valid values are in the range of `-100` to `999.9999`."},"billingMonth":{"type":"string","description":"Billing month, specified as an integer. For example, `11` for Decemer.'"},"billingYear":{"type":"integer","description":"Billing year, specified using the following format: `YYYY`. For example, `2017`."},"developerBillingType":{"type":"string","description":"Developer billing type for which the billing adjustment applies. Valid values include: `PREPAID`, `POSTPAID`, `BOTH`."},"id":{"type":"string","description":"ID of the billing adjustment. **Required when updating the billing adjustment."},"isPublished":{"type":"boolean","description":"Flag that specifies whether the billing adjustment should be published."},"monetizationPackage":{"type":"object","properties":{"id":{"type":"string","description":"ID of the API package."}}},"name":{"type":"string","description":"Name that describes the billing adjustment."},"organization":{"$ref":"#/components/schemas/Organization","description":"Details of organization for which you are making billing adjustments. When creating or updating a billing adjustment, specify the `id` of the organization only."},"product":{"$ref":"#/components/schemas/APIProduct","description":"Details of API product for which you are making billing adjustments. When creating or updating a billing adjustment, specify the `id` of the API product only."},"transactionType":{"type":"string","description":"Type of transaction for which the billing adjustment applies. Valid values include: `PURCHASE`, `CHARGE`, `REFUND`, `CREDIT`, `BALANCE`, `SETUPFEES`, `TERMINATIONFEES`, `TRUEUPS`. `TRUEUPS` are transacions that are used to adjust rated transactions; invoked when tax changes are made in the previous month."}}},"BillingAdjustments":{"type":"object","properties":{"billingAdjustment":{"type":"array","items":{"$ref":"#/components/schemas/BillingAdjustment"},"description":"Details of the billing adjustments."},"totalRecords":{"type":"integer","description":"Total number of records."}}},"APIPackage":{"required":["name","displayName","description","product","status"],"type":"object","properties":{"description":{"type":"string","description":"Description of the API package."},"displayName":{"type":"string","description":"User-friendly display name for the API package."},"id":{"type":"string","description":"Output only. ID of the API package."},"name":{"type":"string","description":"Name of the API package."},"organization":{"type":"object","properties":{"id":{"type":"string","description":"ID of the organization."}}},"product":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"ID of the API product."}}},"description":"List of API products to include in the API package."},"status":{"type":"string","description":"Status indicator for the API package. Valid values include: `CREATED`, `ACTIVE , `INACTIVE`.\n\n**Note**: This value is maintained but not currently used by the API package."}}},"APIPackages":{"type":"object","properties":{"monetizationPackage":{"type":"array","description":"List of API packages.","items":{"$ref":"#/components/schemas/APIPackage"}},"totalRecords":{"type":"integer","description":"Total number of records."}}},"APIProduct":{"type":"object","properties":{"customAtt1Name":{"type":"string","description":"Custom attribute name. There may be zero or more custom attributes. For example, `customAtt1Name`, `customAtt2Name`, `customAtt3Name`, and so on."},"description":{"type":"string","description":"Description of API product."},"displayName":{"type":"string","description":"User-friendly display name of the API product."},"id":{"type":"string","description":"ID of the API product."},"name":{"type":"string","description":"Name of the API product."},"organization":{"$ref":"#/components/schemas/Organization"},"refundSuccessCriteria":{"type":"string","description":"Expression that is compared to the value of the Status attribute and is used to determine when the refund transaction is successful (for charging purposes). For example: `txProviderStatus == 'OK'`. Not applicable to `POST` operations."},"status":{"type":"string","description":"Status indicator for the API product. Valid values include: `CREATED`, `ACTIVE`, `INACTIVE`. This value is maintained but not currently used by the API product."},"transactionSuccessCriteria":{"type":"string","description":"Expression that is compared to the value of the Status attribute and is used to determine when the transaction is successful (for charging purposes). For example: `txProviderStatus == 'OK`'. Not applicable to `POST` operations."}}},"Address":{"type":"object","properties":{"address1":{"type":"string","description":"Street address of the bank at which the account is held."},"city":{"type":"string","description":"City."},"country":{"type":"string","description":"Country."},"id":{"type":"string","description":"ID of the address. This value must be unique when creating an entity."},"isPrimary":{"type":"boolean","description":"Flag that specifies whether this is the primary address."},"state":{"type":"string","description":"State."},"zip":{"type":"string","description":"Zip code."}}},"Rateplans":{"type":"object","properties":{"ratePlan":{"type":"array","items":{"$ref":"#/components/schemas/Rateplan"}},"total":{"type":"integer","description":"Total number of rate plans."},"totalRecords":{"type":"integer","description":"Total number of records."}}},"Rateplan":{"type":"object","properties":{"advance":{"type":"boolean","description":"Flag that specifies whether or not the recurring fee is charged in advance. For example, if set to true and the period is 1 month, the recurring fee is charged on the invoice generated when the prior billing month ends. Defaults to `false`."},"contractDuration":{"type":"integer","description":"Length of the contract for the plan together with `contractDurationType`. For example, to specify a contract duration of 6 months, set `contractDuration` to `6` and `contractDurationType` to `MONTH`."},"contractDurationType":{"type":"string","description":"Length of the contract for the plan together with `contractDuration`. Valid values include: `DAY`, `WEEK`, `MONTH`, `QUARTER`, or `YEAR`."},"currency":{"type":"object","properties":{"id":{"type":"string","description":"<a href=\"https://en.wikipedia.org/wiki/ISO_4217\">ISO 4217 code</a> for the currency, such as `usd` for United States dollar or `chf` for Swiss franc."}}},"description":{"type":"string","description":"Description of the rate plan."},"developer":{"$ref":"#/components/schemas/DeveloperInfo"},"developerCategory":{"$ref":"#/components/schemas/DeveloperCategory"},"displayName":{"type":"string","description":"User-friendly display name for the rate plan."},"earlyTerminationFee":{"type":"integer","description":"One-time fee that is charged if the developer ends the plan before the renewal term."},"endDate":{"type":"string","description":"Date and time that the plan ends in UTC. Use the following format: `YYYY-MM-DD HH:mm:ss`. If you do not specify a timestamp (not recommended), 00:00:00 (midnight) is used by default. Developers are not able to view the rate plan after this date. If you do not want the rate plan to end on a specific date, specify a null value."},"freemiumDuration":{"type":"integer","description":"Period of time for the freemium period together with `freemiumDurationType`. For example, to specify that the freemium period is 30 days, set `freemiumDuration` to `30` and `freemiumDurationType` to `DAY`."},"freemiumDurationType":{"type":"string","description":"Period of time for the freemium period together with freemiumDuration. Valid values include: `DAY`, `WEEK`, `MONTH`, `QUARTER`, or `YEAR`."},"freemiumUnit":{"type":"string","description":"Freemium quantity. The value can be the number of transactions or the number of units pertaining to a custom attribute recorded in the transaction recording policy."},"frequencyDuration":{"type":"integer","description":"Together with `frequencyDurationType`, indicates the period of time between recurring fee charges. For example, to specify that the period of time between fee charges is 30 days, set `frequencyDuration` to `30` and `frequencyDurationTime` to `DAY`."},"frequencyDurationType":{"type":"string","description":"Period of time between recurring fee charges. Valid values include: `DAY`, `WEEK`, `MONTH`, `QUARTER`, or `YEAR`."},"id":{"type":"string","description":"ID of the rate plan. Only required when updating a rate plan."},"isPrivate":{"type":"boolean","description":"Flag that specifies whether the rate plan is public or private. Defaults to false (public)."},"keepOriginalStartDate":{"type":"boolean","description":"Flag that specifies whether to maintain the start date of the parent rate plan. Defaults to `false`.\n\n**Note**: This setting applies to future rate plans only."},"monetizationPackage":{"type":"object","properties":{"id":{"type":"string","description":"ID of the API package."}}},"name":{"type":"string","description":"Name of the rate plan."},"organization":{"$ref":"#/components/schemas/Organization","description":"When creating a rate plan, specify only the `id` of the organization."},"parentRatePlan":{"type":"object","description":"Output only. Parent rate plan details."},"paymentDueDays":{"type":"integer","description":"Number of days at which time the fees are due."},"prorate":{"type":"boolean","description":"Flag that specifies whether the recurring fee is prorated. This flag pertains to the developer starting or ending the plan part of the way through a month. If set to `true`, the intial fee is prorated bsed on the number of days until the end of the period or the number of days used in the period. Defaults to `false`."},"published":{"type":"boolean","description":"Flag that specifies whether the rate plan should be published, making it available to developers."},"ratePlanDetails":{"type":"array","items":{"$ref":"#/components/schemas/RateplanDetails"},"description":"Details for the rate plan."},"recurringFee":{"type":"integer","description":"Fee that is charged to the developer on an ongoing basis until the developer ends the plan."},"recurringStartUnit":{"type":"number","description":"Valid only if `recurringType` is set to `CALENDAR`. Day of the month to charge the recurring fee. For example, if the recurring fee is charged monthly and `recurringStartUnit` is set to `1`, the recurring fee is charged on the first day of each month."},"recurringType":{"type":"string","description":"Schedule for the recurring fee. Valid values include: `CALENDAR` or `CUSTOM`."},"setUpFee":{"type":"integer","description":"One-time fee that is charged to each developer on the start date of the plan (that is, the date the developer purchases the plan)."},"startDate":{"type":"string","description":"Date and time when the rate plan starts in UTC. Use the following format: `YYYY-MM-DD HH:mm:ss`. If you do not specify a timestamp (not recommended), 00:00:00 (midnight) is used by default."},"type":{"type":"string","description":"Type of rate plan. Valid values include: `STANDARD` (all developers), `DEVELOPER_CATEGORY` (developers within a category), or `DEVELOPER` (specific developer).'"}}},"RateplanDetails":{"type":"object","properties":{"aggregateFreemiumCounters":{"type":"boolean","description":"Flag that specifies whether or not aggregate counters are enabled to determine if usage of an API product is in the free range. Aggregate counters must be enabled to set up a freemium plan for a product."},"aggregateStandardCounters":{"type":"boolean","description":"Flag that specifies whether or not aggregate counters are used to determine the band of usage (such as a volume band for a rate card plan)."},"currency":{"type":"object","properties":{"id":{"type":"string","description":"<a href=\"https://en.wikipedia.org/wiki/ISO_4217\">ISO 4217 code</a> for the currency, such as `usd` for United States dollar or `chf` for Swiss franc."}}},"duration":{"type":"number","description":"Period of time for the aggregation basis, together with `durationType`. For example, set `duration` to `30` and `durationType` to `DAY` to specify an aggregation basis of 30 days."},"durationType":{"type":"string","description":"Period of time for the aggregation basis, together with durationType. Valid values include: `DAY`, `WEEK`, `MONTH`, `QUARTER`, or `YEAR`."},"freemiumDuration":{"type":"integer","description":"Period of time for the freemium period for an individual API product together with `freemiumDurationType`. For example, to specify that the freemium period is 30 days, set `freemiumDuration` to `30` and `freemiumDurationType` to `DAY`."},"freemiumDurationType":{"type":"string","description":"Period of time for the freemium period for an individual API product together with freemiumDuration. Valid values include: `DAY`, `WEEK`, `MONTH`, `QUARTER`, or `YEAR`."},"freemiumUnit":{"type":"string","description":"Freemium quantity for an API product. The value can be the number of transactions or the number of units pertaining to a custom attribute recorded in the transaction recording policy."},"meteringType":{"type":"string","description":"Charging model for a rate card plan. Valid values include: `UNIT` (flat rate), `VOLUME` (volume-banded), `STAIR_STEP` (bundled), or `DEV_SPECIFIC` (adjustable notification revenue model only)."},"paymentDueDays":{"type":"number","description":"Payment due date for a postpaid developer. For example, set the value to `30` to indicate that payment is due in 30 days."},"ratePlanRates":{"type":"array","items":{"$ref":"#/components/schemas/RateplanRates"},"description":"Rate plan rate details, such as the type of rate plan (`REVSHARE` or `RATECARD`), the rate for a rate card plan, the revenue share for a revenue share plan, and the range (starting unit and ending unit for which the rate plan rate applies)."},"ratingParameter":{"type":"string","description":"Basis for the rate plan. The rate plan is based on transactions or on a custom attribute. Valid values include: `VOLUME` (based on volume of transactions) or `MINT_CUSTOM_ATTRIBUTE_{num}`. If you set it to `MINT_CUSTOM_ATTRIBUTE_{num}`, then the rate plan is based on a custom attribute, where `{num}` is an integer for example, `MINT_CUSTOM_ATTRIBUTE_1`. This value is defined in the transaction recording policy for the API product and is valid for rate card plans only. The custom attribute name cannot be defined as `VOLUME`."},"ratingParameterUnit":{"type":"string","description":"Unit that applies to the `ratingParameter`."},"revenueType":{"type":"string","description":"Basis of the revenue share in a revenue share plan. Valid values include: `GROSS` (based on percentage of the gross price of a transaction) and `NET` (based on a percentage of the net price of a transaction)."},"type":{"type":"string","description":"Revenue model for the plan. Valid values include: `REVSHARE`, `RATECARD`, `REVSHARE_RATECARD`, `USAGE_TARGET` (adjustable notifications)."}}},"AcceptRateplan":{"required":["developer","startDate","ratePlan"],"type":"object","properties":{"developer":{"type":"object","properties":{"id":{"type":"string","description":"ID of the developer or company accepting the rate plan."}}},"endDate":{"type":"string","description":"Date and time that the rate plan ends in UTC. The rate plan will be in effect until the end of the day on the date specified. If you want to expire a rate plan on December 1, 2016, for example, you should set the `endDate` value to `2016-11-30`. In this case, the rate plan will expire at the end of the day on November 30, 2016; all requests on December 1, 2016 will be blocked.\n\n**Note**: When viewing the rate plan using the API, the `endDate` time stamp is specified as `YYYY-MM-DD 00:00:00`, which may be misleading."},"quotaTarget":{"type":"integer","description":"Target number of transactions allowed for the app developer. You can configure if and when notifications are sent based on what percentage of the target number has been reached, such as 90%, 100%, or 150%. Additional transactions are not blocked after the target number is reached. Set this value to a positive integer value or 0 to disable notifications for an app developer.\n\n**Note**: This property is valid for adjustable notification rate plans only."},"ratePlan":{"type":"object","properties":{"id":{"type":"string","description":"ID of the developer or company accepting the rate plan."}}},"startDate":{"type":"string","description":"Date and time that the rate plan starts in UTC. Use the following format: `YYYY-MM-DD HH:mm:ss`. If you do not specify a timestamp (not recommended), 00:00:00 (midnight) is used by default."},"suppressWarning":{"type":"string","description":"Flag that specifies whether to suppress the error if the developer attempts to accept a rate plan that overlaps another accepted rate plan. If set to `true`, monetization terminates all accepted rate plans that the developer has to API packages that contain the conflicting API products. It then accepts a new API package for the developer."},"waveTerminationCharge":{"type":"boolean","description":"Flag that specifies whether termination fees are waved when an active rate plan is terminated as part of activitating a new rate plan."}}},"RateplanRates":{"type":"object","properties":{"endUnit":{"type":"number","description":"End unit."},"id":{"type":"string","description":"ID of the rate plan rate. Only valid and required when you are updating a draft rate plan rate."},"rate":{"type":"number","description":"Rate for the rate card plan. Specify for RATECARD plans only."},"revshare":{"type":"number","description":"Revenue share. Specify for REVSHARE plans only."},"startUnit":{"type":"number","description":"Start unit."},"type":{"type":"string","description":"Type of the rate plan. Valid values include: `REVSHARE` or `RATECARD`."}}},"DeveloperInfo":{"properties":{"id":{"type":"string","description":"ID of the developer."},"legalName":{"type":"string","description":"Legal name of the developer."},"name":{"type":"string","description":"Name of the developer."}}},"DeveloperCategory":{"properties":{"id":{"type":"string","description":"Output only. ID of the developer category."},"name":{"type":"string","description":"Name of the developer category."},"description":{"type":"string","description":"Description of the developer category."}}},"WebhookTest":{"required":["eventTriggerReason","properties"],"type":"object","properties":{"eventTriggerReason":{"type":"string","description":"Webhook notification trigger type."},"properties":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","description":"Property used as key for notification trigger."},"value":{"type":"string","description":"Value that triggers the webhook notification."}}}}}},"WebhookSample":{"type":"object","properties":{"eventTriggerReason":{"type":"string","description":"Webhook notification trigger type."},"properties":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","description":"Property used as key for notification trigger."},"value":{"type":"string","description":"Value that triggers the webhook notification."}}}}}},"TransactionsMigrate":{"type":"object","properties":{"application":{"type":"object","properties":{"id":{"type":"string","description":"ID of the application. Required only when migrating a batch transaction; not required when charging fees."}}},"batchSize":{"type":"integer","description":"When migrating transactions, specifies the number of transactions that you want to transfer. Defaults to 1. Required only when migrating a batch transaction; not required when charging fees."},"custAttn":{"type":"number","description":"When migrating transactions, specifies the value of the custom attribute that is used with batchSize to calculate the transaction usage. The custom attribute number in the message must be specified as a positive whole or decimal (up to four decimal places) value. Negative values are not allowed. The custom attribute must be defined in either the transaction recording policy for the API product or the active rate plan for the API product. Required only when migrating a batch transaction; not required when charging fees."},"currency":{"properties":{"id":{"type":"string","description":"Currency used for the rate plan. Specify the <a href=\"https://en.wikipedia.org/wiki/ISO_4217\">ISO 4217 code</a> for the currency, such as `usd` for United States dollar or `chf` for Swiss franc. Required only when charging a setup or recurring fee; not required when migrating a batch transaction."}}},"developer":{"type":"object","properties":{"id":{"type":"string","description":"ID of the developer. Required only when charging a setup or recurring fee; not required when migrating a batch transaction."}}},"product":{"type":"object","properties":{"id":{"type":"string","description":"ID of the API product. Required only when migrating a batch transaction; not required when charging a setup or recurring fee."}}},"rate":{"type":"number","description":"Setup or recurring fee to charge. Required only when charging a setup or recurring fee; not required when migrating a batch transaction."},"ratePlan":{"type":"object","properties":{"id":{"type":"string","description":"ID of the rate plan. Required only when charging a setup or recurring fee; not required when migrating a batch transaction."}}},"type":{"type":"string","description":"Type of migration. Valid values include: `CHARGE`, `SETUPFEES`, or `RECURRINGFEES`. Defaults to `CHARGE`. Required only when charging setup or recurring fees."}}},"NotificationRequest":{"properties":{"notificationCondition":{"type":"array","items":{"$ref":"#/components/schemas/NotificationCondition"}},"actions":{"type":"array","items":{"$ref":"#/components/schemas/NotificationAction"}}}},"NotificationCondition":{"properties":{"name":{"type":"string","description":"Name of the notification condition. The name must be unique. Specify with attribute property only."},"attribute":{"type":"string","description":"Attribute used to define the notification condition. You can specify one or more attributes to refine the notification condition. Specify with either name or value property only."},"limit":{"type":"object","properties":{"id":{"type":"string","description":"ID of the notification template. Specify with value property only."}}},"value":{"type":"string","description":"Value of the attribute used to trigger the action. Specify with either attribute or limit only."}}},"ReportDefinitions":{"type":"object","properties":{"reportDefinition":{"type":"array","items":{"$ref":"#/components/schemas/ReportDefinition"}},"totalRecords":{"type":"integer","description":"Total number of records."}}},"ReportDefinition":{"type":"object","properties":{"description":{"type":"string","description":"Description of the report definition."},"developer":{"$ref":"#/components/schemas/DeveloperInfo","description":"Output only. Developer details or null if not a developer report definition."},"id":{"type":"string","description":"ID of the report definition. Required only when updating a report definition."},"lastModified":{"type":"string","description":"Output only. Time that the report definition was last modified in UTC."},"mintCriteria":{"$ref":"#/components/schemas/MintCriteria"},"name":{"type":"string","description":"Name of the report definition."},"organization":{"description":"Output only. Organization details.","$ref":"#/components/schemas/Organization"},"type":{"type":"string","description":"Type of report definition. Valid values include: `BILLING`, `PREPAID_BALANCE`, `REVENUE`, and `VARIANCE`."}}},"MintCriteria":{"type":"object","properties":{"appCriteria":{"type":"array","description":"ID and organization for a specific application to be included in the report. If this property is not specified, all applications are included in the report.","items":{"type":"object","properties":{"id":{"type":"string","description":"App ID."},"orgId":{"type":"string","description":"Organization name."}}}},"billingMonth":{"type":"string","description":"Billing month of the report, such as `JULY`.\n\n**Note**: This property is not valid for revenue reports."},"billingYear":{"type":"string","description":"Billing year for the report, such as `2015`.\n\n**Note**: This property is not valid for revenue reports."},"currCriteria":{"type":"array","description":"ID and organization for a specific currency to be included in the report. If this property is not specified, all supported currencies are included in the report.","items":{"type":"object","properties":{"id":{"type":"string","description":"Currency ID."},"orgId":{"type":"string","description":"Organization name."}}}},"currencyOption":{"type":"string","description":"Currency for the report. Valid values include:\n\n* `LOCAL`: Each line of the report is displayed using the applicable rate plan. This means that there may be multiple currencies in one report if the developers have plans that use different currencies.</li><li>`EUR`: Local currency transactions are converted and displayed in Euros.\n* `GPB`: Local currency transactions are converted and displayed in United Kingdom pounds.\n* `USD`: Local currency transactions are converted and displayed in United States dollars.\n\n**Note**: If you select `EUR`, `GBP`, or `USD`, the report displays all transactions using that single currency, based on the exchange rate in effect on the date of the transaction."},"devCriteria":{"type":"array","description":"Developer ID or email address, and organization name for a specific developer to be included in the report. If this property is not specified, all developers are included in the report.","items":{"type":"object","properties":{"id":{"type":"string","description":"Developer ID."},"orgId":{"type":"string","description":"Organization name."}}}},"devCustomAttribute":{"type":"array","description":"Custom attributes to include in the report, if defined for a developer.\n\n**Note**: This property is not valid for revenue reports. Do not specify the predefined `MINT_*` and `ADMIN_*` attributes in the `devCustomAttributes` array.","items":{"type":"string"}},"fromDate":{"type":"string","description":"Starting date and time of the report in UTC time. For example: `2017-01-15 01:30:00`. You can omit the timestamp; if not specified it defaults to `00:00:00`.\n\n**Note**: This property applies only to revenue and variance reports."},"groupBy":{"type":"array","description":"Order in which sections are grouped in the report. Enter the values in the desired order: `APPLICATION`, `BALANCE`, `DEVELOPER`, `ORG`, `PACKAGE`, `PRODUCT`, and `RATEPLAN`.","items":{"type":"string"}},"monetizationPackageIds":{"type":"array","description":"ID of one or more API packages to include in the report. If this property is not specified, all API packages are included inthe report. \n\n**Note**: This property is not valid when viewing transaction activity (`/transaction-search`). ","items":{"type":"string"}},"pkgCriteria":{"type":"string","description":"ID and organization for a specific API package to be included in the report. If this property is not specified, all API packages are included in the report. This property can be specified instead of the `monetizationpackageIds` property. \n\n \n**Note**: This property is not valid when viewing transaction activity (`/transaction-search`). "},"prevFromDate":{"type":"string","description":"Starting date of a previous period in UTC. Used to create a report for a previous period for comparison against a current report.\n\n**Note**: This property applies only to variance reports."},"prevToDate":{"type":"string","description":"Ending date of a previous period in UTC. Used to create a report for a previous period for comparison against a current report.\n\n**Note**: This property applies only to variance reports."},"prodCriteria":{"type":"string","description":"ID and organization for a specific API product to be included in the report. If this property is not specified, all API products are included in the report. This property can be specified instead of the `productIds` property. \n\n**Note**: This property is not valid when viewing transaction activity (`/transaction-search`)."},"productIds":{"type":"array","description":"ID of one or more API products to include in the report. If this property is not specified, all API products are included in the report. \n\nAPI product IDs should be specified as `org-name@@@product-name`. For example: `\"productIds\": [\"myorg@@@myproduct\", \"myorg@@@myproduct2\"]`","items":{"type":"string"}},"pricingTypes":{"type":"array","description":"Pricing type of rate plan to be included in the report. Valid values include:\n* `REVSHARE`: Revenue share plan.\n* `REVSHARE_RATECARD`: Revenue share and rate card rate plan.\n* `RATECARD`: Rate card plan.\nIf this property is not specified, rate plans of all pricing types are included in the report.","items":{"type":"string"}},"ratePlanLevels":{"type":"array","description":"Type of rate plan to be included in the report. Valid values include:\n\n* `DEVELOPER`: Developer rate plan.\n* `STANDARD`: Standard rate plan.\n\nIf this property is not specified, both developer-specific and standard rate plans are included in the report.","items":{"type":"string"}},"showEntityId":{"type":"boolean","description":"Flag that specifies whether the reports shows the entity ID."},"showRevSharePct":{"type":"boolean","description":"Flag that specifies whether the report shows revenue share percentages."},"showSummary":{"type":"boolean","description":"Flag that specifies whether the report is a summary."},"showTxDetail":{"type":"boolean","description":"Flag that specifies whether the report shows transaction level details.\n\n**Note**: This property applies only to revenue reports."},"showTxType":{"type":"boolean","description":"Flag that specifies whether the report shows the type of each transaction."},"toDate":{"type":"string","description":"Ending date and time of the report in UTC time. For example: `2017-01-15 01:30:00`. You can omit the timestamp; if not specified it defaults to `00:00:00`. \n**Note**: This property applies only to revenue and variance reports."},"transactionStatus":{"type":"array","description":"Status of transactions to include in the report. Valid values include:\n\n* `SUCCESS`: Successful transactions.\n* `FAILED`: Failed transaction.\n* `FINAL`: Transactions marked as final.\n* `REVIEW`: Transaction marked as under review.","items":{"type":"string"}},"transactionCustomAttributes":{"type":"array","description":"Custom transaction attributes to include in summary revenue reports. You must enable this feature in your organization. See Including custom transaction attributes in revenue summary reports.","items":{"type":"string"}},"transactionTypes":{"type":"array","description":"Type of transactions to be included in the report. Valid values include: `PURCHASE`, `CHARGE`, `REFUND`, `CREDIT`, `BALANCE`, `SETUPFEES`, `TERMINATIONFEES`, `RECURRINGFEES`, and `TRUEUP`. `TRUEUP`s are transactions that are used to readjust rated transactions. They are invoked when tax changes are made in the previous billing month. If this property is not specified, all transaction types are included in the report.","items":{"type":"string"}}}},"CreditLimit":{"$ref":"#/components/schemas/PrepaidBalanceDevelopers"},"SupportedCurrencies":{"type":"object","properties":{"SupportedCurrency":{"type":"array","items":{"$ref":"#/components/schemas/SupportedCurrency"},"description":"Details of the supported currency."},"totalRecords":{"type":"integer","description":"Total number of records."}}},"SupportedCurrency":{"required":["description","displayName","name","organization","status","virtualCurrency"],"type":"object","properties":{"creditLimit":{"type":"number","description":"The credit limit for the supported currency. The credit limit can be overridden for a developer in the developer's postpaid balance. \n\n**Note**: This property applies to postpaid developers only."},"description":{"type":"string","description":"Description of the supported currency."},"displayName":{"type":"string","description":"Name displayed in the UI."},"id":{"type":"string","description":"ID of the supported currency."},"minimumTopupAmount":{"type":"number","description":"Minimum amount that developers can add to their prepaid account balance in the specified currency.\n\n**Note**: This property applies to prepaid developers only."},"name":{"type":"string","description":"<a href=\"https://en.wikipedia.org/wiki/ISO_4217\">ISO 4217 code</a> for the currency, such as `usd` for United States dollar."},"organization":{"type":"object","properties":{"id":{"type":"string","description":"ID of the organization."}}},"status":{"type":"string","description":"Status of the currency. Valid values include:\n\n* `ACTIVE`: The currency is available for use.\n* `INACTIVE`: The currency is not available for use."},"virtualCurrency":{"type":"string","description":"Flag that specifies whether or not the currency is virtual currency."}}},"PrepaidBalanceReload":{"required":["providerID","isRecurring","replenishAmount","recurringAmount"],"type":"object","properties":{"isRecurring":{"type":"boolean","description":"Flag that specifies wehether to enable automatic reload."},"providerId":{"type":"string","description":"ID of the payment provider to use to reload the account."},"recurringAmount":{"type":"number","description":"Amount to add automatically to the account. It is recommended that you set `recurringAmount` to a value that is large enough to cover fees incurred for the next 24-hour period. This value must be greater than the minimum reload value configured for the specified currency (`supportedCurrencyId` query parameter)."},"replenishAmount":{"type":"number","description":"Threshold that the prepaid account balance must drop below in order to trigger automatic reload."}}},"PrepaidBalances":{"type":"object","properties":{"developerBalance":{"type":"array","items":{"$ref":"#/components/schemas/PrepaidBalance"},"description":"List of account balances."},"totalRecords":{"type":"integer","description":"Total number of records."}}},"PrepaidBalance":{"type":"object","properties":{"amount":{"type":"number","description":"Amount of the prepaid account balance."},"chargePerUsage":{"type":"boolean","description":"This attribute is deprecated."},"id":{"type":"string","description":"ID of the payment provider."},"isRecurring":{"type":"boolean","description":"Flag that specifies whether automatic reload of the prepaid account is enabled."},"providerID":{"type":"string","description":"ID of the payment provider to use to reload the account, if configured."},"recurringAmount":{"type":"number","description":"Amount to add automatically to the account, if configured."},"replenishAmount":{"type":"number","description":"Threshold that the prepaid account balance must drop below in order to trigger automatic reload, if configured."},"supportedCurrency":{"$ref":"#/components/schemas/SupportedCurrency"},"usage":{"type":"number","description":"Amount used."}}},"PrepaidBalanceDevelopers":{"type":"object","properties":{"developerBalance":{"type":"array","items":{"$ref":"#/components/schemas/PrepaidBalanceDeveloper"},"description":"List of prepaid account balances."},"totalRecords":{"type":"integer","description":"Total number of records."}}},"PrepaidBalanceDeveloper":{"type":"object","properties":{"approxTaxRate":{"type":"number","description":"Tax rate for developer."},"currentBalance":{"type":"number","description":"Current balance in account based on current usage."},"currentTotalBalance":{"type":"number","description":"Total balance in account without subtracting current usage."},"currentUsage":{"type":"number","description":"Current usage."},"id":{"type":"string","description":"ID of the payment provider."},"month":{"type":"string","description":"Billing month."},"previousBalance":{"type":"number","description":"Previous balance in account."},"supportedCurrency":{"$ref":"#/components/schemas/SupportedCurrency"},"tax":{"type":"number","description":"Usage tax."},"topups":{"type":"number","description":"Sum of top ups."},"usage":{"type":"number","description":"Amount used."},"year":{"type":"integer","description":"Billing year."}}},"TNCs":{"type":"object","properties":{"tnc":{"type":"array","description":"Array of terms and conditions.","items":{"$ref":"#/components/schemas/TNC"}},"totalRecords":{"type":"integer","description":"Total number of records."}}},"TNC":{"type":"object","properties":{"id":{"type":"string","description":"ID of the terms and conditions document. Required only when updating the terms and conditions."},"organization":{"description":"Organization details. When creating a terms and conditions document, set the `id` for the organization.","$ref":"#/components/schemas/Organization"},"startDate":{"type":"string","description":"Date and time that the rate plan starts in UTC. Use the following format: `YYYY-MM-DD HH:mm:ss`. If you do not specify a timestamp (not recommended), 00:00:00 (midnight) is used by default."},"tncText":{"type":"string","description":"Brief description of the terms and conditions."},"url":{"type":"string","description":"URL to the terms and conditions."},"version":{"type":"string","description":"Version number for the terms and conditions. The version number allows you to keep track of different terms and conditions."}}},"DeveloperTNCs":{"type":"object","properties":{"developerTnc":{"type":"array","items":{"$ref":"#/components/schemas/DeveloperTNC"},"description":"Details of the terms and conditions agreement."},"totalRecords":{"type":"integer","description":"Total number of records."}}},"DeveloperTNC":{"type":"object","properties":{"action":{"type":"string","description":"Action. Valid values are ACCEPTED or DECLINED."},"auditDate":{"type":"string","description":"Date accepted."},"id":{"type":"string","description":"ID of the developer."},"tnc":{"$ref":"#/components/schemas/TNC"}}},"AcceptTNC":{"type":"object","properties":{"action":{"type":"string","description":"Action. Valid values are ACCEPTED or DECLINED."},"auditDate":{"type":"string","description":"Date and time accepted in UTC format. Use the following format: `YYYY-MM-DD HH:mm:ss`."}}},"SuspendedDevelopers":{"type":"array","items":{"$ref":"#/components/schemas/SuspendedDeveloper"},"description":"List of suspended developers."},"SuspendedDeveloper":{"type":"object","properties":{"creationDate":{"type":"integer","description":"Creation date in epoch format."},"devId":{"type":"string","description":"ID of the developer using a format similar to the following: `{org_id}@@@{dev_id}`."},"id":{"type":"string","description":"ID of the suspended developer record."},"message":{"type":"string","description":"Message that describes the reason for the suspension."},"orgId":{"type":"string","description":"ID of the organization."},"prodId":{"type":"string","description":"ID of the API product."},"reasonCode":{"type":"string","description":"Reason code for the suspension. Valid codes include: `INSUFFICIENT_FUNDS`, `LIMIT_VIOLATED`, `NO_CURRENT_PUBLISHABLE_ENTITY`, or `RATE_PLAN_RATE_BAND_EXCEEDED`."},"ttlInSeconds":{"type":"integer","description":"Amount of time (epoch format) in seconds that the suspension will be lifted. If the developer is suspended indefinitely, the value will be set to 2500 days in epoch format."}}},"Developer":{"type":"object","properties":{"address":{"type":"array","description":"Developer address.","items":{"$ref":"#/components/schemas/Address"}},"approxTaxRate":{"type":"number","description":"Approximate tax rate for the developer."},"billingType":{"type":"string","description":"Developer payment model used for billing. Valid values include:\n\n* `PREPAID`: The developer pays in advance for the use of an API product. Funds are deducted from the developer's balance when the API product is used. The developer must maintain a prepaid balance sufficient to purchase the API product.\n* `POSTPAID`: The developer is billed monthly (through an invoice) for the use of API products. The developer pays for the use of API products based on the payment terms set by the plan(s) included on the invoice.\n* `BOTH`: In this case, the billing type defaults to `PREPAID`."},"broker":{"type":"boolean","description":"Flag that specifies whether the revenue is based on net."},"email":{"type":"string","description":"Email ID for the developer or company."},"id":{"type":"string","description":"Developer or company ID."},"isCompany":{"type":"boolean","description":"Flag that specifies whether this is a company."},"legalName":{"type":"string","description":"Legal name of the developer or company."},"name":{"type":"string","description":"Name of the developer or company."},"organization":{"description":"Organization details.","$ref":"#/components/schemas/Organization"},"registrationId":{"type":"string","description":"Registration ID."},"status":{"type":"string","description":"Status indicator for the developer. Valid values include: `ACTIV`E or `INACTIVE`."},"type":{"type":"string","description":"Developer type (TRUSTED or UNTRUSTED)."}}},"DeveloperCategories":{"type":"object","properties":{"developerCategory":{"type":"array","items":{"$ref":"#/components/schemas/DeveloperCategory"}}}},"NotificationEmailTemplates":{"type":"object","properties":{"emailTemplates":{"type":"array","items":{"$ref":"#/components/schemas/NotificationEmailTemplate"}}}},"NotificationEmailTemplate":{"type":"object","properties":{"createdDate":{"type":"integer","description":"Output only. Creation time in epoch format."},"htmlImage":{"type":"string","description":"Message body in HTML format. You can include one or more variables, using Spring Expression Language (SpEL), to represent values returned in the Transaction object."},"id":{"type":"string","description":"ID of the notification email template. Required only when updating a notification email template."},"name":{"type":"string","description":"Name of the notification email template."},"orgId":{"type":"string","description":"Name of the organization."},"source":{"type":"string","description":"Source of the notification.,"},"subject":{"type":"string","description":"Subject line of the notification email template."},"updatedDate":{"type":"integer","description":"Date in epoch format that the template was updated."}}},"NotificationConditionsActions":{"type":"object","properties":{"notificationConditions":{"type":"array","items":{"$ref":"#/components/schemas/NotificationConditionAction"},"description":"Details of the notification conditions."},"totalRecords":{"type":"integer","description":"Total number of records."}}},"NotificationConditionAction":{"type":"object","properties":{"actions":{"type":"array","description":"Details of each notification action.","items":{"$ref":"#/components/schemas/NotificationAction"}},"notificationCondition":{"type":"array","description":"Details of each notification condition.","items":{"$ref":"#/components/schemas/NotificationConditionDetails"}},"associated-condition":{"type":"object","properties":{"attribute":{"type":"string","description":"Details of the notification condition. You can specify one or more attributes to refine the notification condition. Valid values include: `ADD_RATEPLAN`, `ADHOC_NOTIFY_DEVELOPERS`, `APP_ID`, `Balance`, `BILLING_DOCS_PUBLISHED`, `COMPANY_ACCEPTS_INVITATION`, `COMPANY_CANCELS_INVITATION`, `COMPANY_DECLINES_INVITATION`, `CREATE_APPLICATION`, `CREATE_DEVELOPER`, `CreditLimit`, `DATE`, `DEV_ID`, `DEVELOPER_ACCEPTS_INVITATION`, `DEVELOPER_CANCELS_INVITATION`, `DEVELOPER_DECLINES_INVITATION`, `EXPIRING_TNC`, `FeeExposure`, `FREEMIUMN_USED_UP`, `LIMIT_ID`, `NEW_PACKAGE`, `NEW_PRODUCT`, `NEW_TNC`, `ORG_ID`, `PUBLISHED`, `RATEPLAN`, `RATEPLAN_ACCEPTED`, `RATEPLAN_COUNT`, `RATEPLAN_ENDED`, `RATEPLAN_EXPIRED`, `RATEPLAN_RENEWED`, `RATEPLAN_REVISION`, `SpendLimit`, `TNC_ACCEPTANCE`, `Transactions`, `UPDATE_DEVELOPER`, and `VOLUME`."},"id":{"type":"string","description":"ID of the notification condition."},"organization":{"$ref":"#/components/schemas/Organization"},"value":{"type":"string","description":"Value of the attribute."}}}}},"NotificationConditionDetails":{"type":"object","properties":{"attribute":{"type":"string","description":"Details of the notification condition. You can specify one or more attributes to refine the notification condition. Valid values include: `ADD_RATEPLAN`, `ADHOC_NOTIFY_DEVELOPERS`, `APP_ID`, `Balance`, `BILLING_DOCS_PUBLISHED`, `COMPANY_ACCEPTS_INVITATION`, `COMPANY_CANCELS_INVITATION`, `COMPANY_DECLINES_INVITATION`, `CREATE_APPLICATION`, `CREATE_DEVELOPER`, `CreditLimit`, `DATE`, `DEV_ID`, `DEVELOPER_ACCEPTS_INVITATION`, `DEVELOPER_CANCELS_INVITATION`, `DEVELOPER_DECLINES_INVITATION`, `EXPIRING_TNC`, `FeeExposure`, `FREEMIUMN_USED_UP`, `LIMIT_ID`, `NEW_PACKAGE`, `NEW_PRODUCT`, `NEW_TNC`, `ORG_ID`, `PUBLISHED`, `RATEPLAN`, `RATEPLAN_ACCEPTED`, `RATEPLAN_COUNT`, `RATEPLAN_ENDED`, `RATEPLAN_EXPIRED`, `RATEPLAN_RENEWED`, `RATEPLAN_REVISION`, `SpendLimit`, `TNC_ACCEPTANCE`, `Transactions`, `UPDATE_DEVELOPER`, and `VOLUME`."},"id":{"type":"string","description":"ID of the notification condition."},"organization":{"$ref":"#/components/schemas/Organization"},"value":{"type":"string","description":"Value of the attribute."}}},"NotificationAction":{"type":"object","properties":{"actionAttribute":{"type":"string","description":"Type of action. Valid values include: `ORG_EMAIL` (recipient identified by email address), `DEV_ID` (recipient identified by developer ID), `COMPANY_ADMINS` (recipients are all company administrators), and `WEBHOOK` (recipient is webhook callback handler."},"condition":{"$ref":"#/components/schemas/Condition"},"id":{"type":"string","description":"ID of the action."},"postURL":{"type":"string","description":"Callback handler for the webhook.\n\n**Note**: This option is valid only if `actionAttribute` is set to `WEBHOOK`."},"templateId":{"type":"string","description":"ID of the notification template.\n\n**Note**: This option is not valid if `actionAttribute` is set to `WEBHOOK`."},"value":{"type":"string","description":"Value of the action attribute. If `actionAttribute` is set to `ORG_EMAIL` or `DEV_ID`, a value of `ANY` sends ther notification to any appliable recipent, for example, any `ORG_EMAIL` address or any `DEV_ID`. If `actionAttribute` is set to `WEBHOOK`, set this value to the ID of the webhook."}}},"Condition":{"type":"object","properties":{"attribute":{"type":"string","description":"Details of the notification condition. You can specify one or more attributes to refine the notification condition. Valid values include: `ADD_RATEPLAN`, `ADHOC_NOTIFY_DEVELOPERS`, `APP_ID`, `Balance`, `BILLING_DOCS_PUBLISHED`, `COMPANY_ACCEPTS_INVITATION`, `COMPANY_CANCELS_INVITATION`, `COMPANY_DECLINES_INVITATION`, `CREATE_APPLICATION`, `CREATE_DEVELOPER`, `CreditLimit`, `DATE`, `DEV_ID`, `DEVELOPER_ACCEPTS_INVITATION`, `DEVELOPER_CANCELS_INVITATION`, `DEVELOPER_DECLINES_INVITATION`, `EXPIRING_TNC`, `FeeExposure`, `FREEMIUMN_USED_UP`, `LIMIT_ID`, `NEW_PACKAGE`, `NEW_PRODUCT`, `NEW_TNC`, `ORG_ID`, `PUBLISHED`, `RATEPLAN`, `RATEPLAN_ACCEPTED`, `RATEPLAN_COUNT`, `RATEPLAN_ENDED`, `RATEPLAN_EXPIRED`, `RATEPLAN_RENEWED`, `RATEPLAN_REVISION`, `SpendLimit`, `TNC_ACCEPTANCE`, `Transactions`, `UPDATE_DEVELOPER`, and `VOLUME`,"},"id":{"type":"string","description":"ID of the notification condition."},"name":{"type":"string","description":"Name of the notification condition."},"organization":{"$ref":"#/components/schemas/Organization"}}},"DeveloperRatePlans":{"type":"object","properties":{"developerRatePlan":{"type":"array","items":{"$ref":"#/components/schemas/DeveloperRatePlan"}},"totalRecords":{"type":"integer","description":"Total number of records."}}},"DeveloperRatePlan":{"type":"array","items":{"properties":{"created":{"type":"string","description":"Date the rate plan was created."},"developer":{"$ref":"#/components/schemas/Developer"},"endDate":{"type":"string","description":"End date of the rate plan in UTC."},"id":{"type":"string","description":"ID of the developer rate plan."},"nextCycleStartDate":{"type":"string","description":"Start date and time for the next cycle in UTC. Uses the following format: `YYYY-MM-DD HH:mm:ss`."},"nextRecurringFeeDate":{"type":"string","description":"Date and time for the next recurring fee in UTC. This value is based on the `recurringStartUnit` value, which specifies the day of the month that recurring fees are charged. Uses the following format: `YYYY-MM-DD HH:mm:ss`."},"prevRecurringFeeDate":{"type":"string","description":"Date and time of the previous recurring fee in UTC. This value is based on the `recurringStartUnit` value, which specifies the day of the month that recurring fees are charged. Except, for the first month, the date reflects the actual day of the month the rate plan was accepted. Uses the following format: `YYYY-MM-DD HH:mm:ss`."},"quotaTarget":{"type":"integer","description":"Target number of transactions allowed for the app developer. You can configure if and when notifications are sent based on what percentage of the target number has been reached, such as 90%, 100%, or 150%. Additional transactions are not blocked after the target number is reached. Set this value to a positive integer value or 0 to disable notifications for an app developer. **Note**: This property is valid for adjustable notification rate plans only."},"ratePlan":{"$ref":"#/components/schemas/Rateplan"},"startDate":{"type":"string","description":"Date and time that the rate plan starts in UTC. Use the following format: `YYYY-MM-DD HH:mm:ss`. If you do not specify a timestamp (not recommended), 00:00:00 (midnight) is used by default."},"updated":{"type":"string","description":"Date the rate plan was updated in UTC."}}}},"DeveloperRoles":{"type":"object","properties":{"developerRole":{"type":"array","items":{"$ref":"#/components/schemas/DeveloperRole"},"description":"List of developer roles."},"totalRecords":{"type":"integer","description":"Total number of records."}}},"DeveloperRole":{"type":"object","properties":{"description":{"type":"string","description":"Description of the developer role."},"id":{"type":"string","description":"Output only. ID of the developer role."},"name":{"type":"string","description":"Name of thd developer role."},"organization":{"$ref":"#/components/schemas/Organization","description":"When creating a developer role, specify only the `id` of the organization."}}},"Transactions":{"type":"object","properties":{"totalRecords":{"type":"integer","description":"Total number of records."},"transaction":{"type":"array","items":{"$ref":"#/components/schemas/Transaction"},"description":"Details of the transactions."}}},"Transaction":{"type":"object","properties":{"application":{"$ref":"#/components/schemas/Application"},"batchSize":{"type":"number","description":"Batch size of the transaction, if applicable."},"currency":{"type":"string","description":"Type of currency. For example, `USD`."},"developer":{"$ref":"#/components/schemas/DeveloperInfo"},"endTime":{"type":"string","description":"Time that the transaction ended."},"environment":{"type":"string","description":"Environment, such as test or `prod`."},"euroExchangeRate":{"type":"number","description":"European exchange rate, if applicable."},"gbpExchangeRate":{"type":"number","description":"British pound exchange rate, if applicable."},"id":{"type":"string","description":"Type of the transaction."},"isVirtualCurrency":{"type":"boolean","description":"Flag that specifies whether the currency is virtual."},"notes":{"type":"string","description":"Notes about the transaction."},"parentId":{"type":"string","description":"ID of the purchase transaction that you are refunding. Applies to refunds only."},"pkgId":{"type":"string","description":"API package ID."},"pkgRatePlanProductName":{"type":"string","description":"Name of the API product in the API package."},"product":{"$ref":"#/components/schemas/APIProduct"},"providerTxId":{"type":"string","description":"Transaction provider ID."},"rate":{"type":"number","description":"Rate."},"ratePlanLevel":{"type":"string","description":"Type of rate plan. Valid values include: `STANDARD` (all developers), `DEVELOPER_CATEGORY` (developers within a category), or `DEVELOPER` (specific developer).'"},"ratedVolume":{"type":"number","description":"Rated volume."},"revenueShareAmount":{"type":"number","description":"Revenue share amount."},"startTime":{"type":"string","description":"Time that the transaction started."},"status":{"type":"string","description":"Status of the transaction."},"taxModel":{"type":"string","description":"Tax model. Valid values include:\n\n* `Disclosed`: In this tax model, the API provider acts as a disclosed agent of the developer. The gross revenue (including sales taxes) collected from the end user is passed to the developer. The API provider’s commission is collected from the developer in the form of a commission invoice. The API provider does not handle the sales tax collected from the end user, and it is the developer’s responsibility to report the sales tax.\n* `Undisclosed`: In this tax model, the API provider acts as an undisclosed agent of the developer, and deducts the tax collected from the end users and pays it to the local tax authorities. The developer invoices the API provider for the net revenue share due to the developer (less sales taxes and the API provider’s commission).\n* `Hybrid`: In this tax model, the API provider acts as a disclosed agent of the developer. However, the API provider pays the sales tax collected from their subscribers to the local tax authorities on the developer’s behalf. The API provider passes the remaining revenue to the developer, and then invoices for commission charges."},"txProviderStatus":{"type":"string","description":"Transaction provider status."},"type":{"type":"string","description":"Type of transaction. Valid values include: `PURCHASE`, `CHARGE`, `REFUND`, `CREDIT`, `BALANCE`, `SETUPFEES`, `TERMINATIONFEES`, `TRUEUPS`. `TRUEUPS` are transacions that are used to adjust rated transactions; invoked when tax changes are made in the previous month."},"usdExchangeRate":{"type":"number","description":"US exchange rate."},"utcEndTime":{"type":"string","description":"Time that the transaction ended in UTC."},"utcStartTime":{"type":"string","description":"Time that the transaction started in UTC."}}},"Application":{"type":"object","properties":{"description":{"type":"string","description":"Description of the application."},"id":{"type":"string","description":"ID of the application."},"name":{"type":"string","description":"Name of the application."},"organization":{"$ref":"#/components/schemas/Organization"},"product":{"type":"array","items":{"$ref":"#/components/schemas/APIProduct"}}}},"Developers":{"type":"object","properties":{"developer":{"type":"array","description":"List of developers.","items":{"$ref":"#/components/schemas/Developer"}},"totalRecords":{"type":"integer","description":"Total number of records."}}},"APIProducts":{"type":"object","properties":{"product":{"type":"array","items":{"$ref":"#/components/schemas/APIProduct"}}}},"Webhooks":{"type":"object","properties":{"totalRecords":{"type":"integer","description":"Total number of records."},"webhooks":{"type":"array","items":{"$ref":"#/components/schemas/Webhook"},"description":"Details of the webhooks."}}},"Webhook":{"type":"object","properties":{"created":{"type":"integer","description":"Output only. Time that the webhook was created in epoch format."},"createdBy":{"type":"string","description":"Output only. Email address of the developer that created the webhook."},"enabled":{"type":"boolean","description":"Flag that specifies whether the webhook is enabled or disabled."},"id":{"type":"string","description":"ID of the webhook."},"name":{"type":"string","description":"Name of the webhook."},"postUrl":{"type":"string","description":"URL of the callback handler."},"updated":{"type":"integer","description":"Output only. Time that the webhook was updated in epoch format."},"updatedBy":{"type":"string","description":"Output only. ID of the user that updated the webhook."}}},"ScheduledJobs":{"type":"object","properties":{"scheduled-job":{"type":"array","items":{"$ref":"#/components/schemas/ScheduledJob"},"description":"Details of the scheduled job."}}},"ScheduledJob":{"type":"object","properties":{"createdDate":{"type":"integer","description":"Output only. Job creation date in epoch format."},"cronExpression":{"type":"string","description":"Cron expression to create a firing schedule for the trigger, such as: `At 8:00 A.M. every Monday through Friday` or `At 1:30 A.M. every last Friday of the month`. Specifying this property defines the trigger as a cron trigger. See also <a href=\"http://docs.apigee.com/monetization/content/schedule-monetization-jobs#cronexps\">Building cron expressions</a>."},"endTime":{"type":"integer","description":"Time in epoch format when the trigger's schedule is no longer in effect."},"enabled":{"type":"boolean","description":"Flag that indicates whether the trigger is enabled to execute. Set this value to true to enable execution of the trigger."},"group":{"type":"string","description":"Type of server in which the trigger will execute. For example, if the trigger is supposed to execute in a management server, the value should be set to `management-server`. If the trigger is supposed to execute in a message processing server, the value should be set to `message-processor`."},"id":{"type":"string","description":"ID of the trigger."},"jobId":{"type":"string","description":"ID of the job that is to be executed."},"name":{"type":"string","description":"Unique name used to identify the trigger."},"priority":{"type":"string","description":"Relative firing priority of the triggers if multiple triggers are scheduled to execute at the same. The lower the value, the higher the priority. For example, if two triggers are scheduled to execute at the same time, and if one trigger has a priority of 1 and the other a priority of 2, the trigger with priority 1 executes first. This property applies only if multiple triggers have exactly the same firing time."},"startTime":{"type":"integer","description":"Time in epoch format when the trigger's schedule goes into effect. \n**Note**: Applies to simple triggers only."},"suiteId":{"type":"string","description":"Flag that specifies whether the notification part of the system-level or default-level suite of notifications. Valid values are `DEFAULT` or `SYSTEM`, or you can specify your own unique suite name."},"triggerDataMap":{"type":"object","properties":{"custom_lock_key":{"type":"string","description":"Lock key that prevents multiple servers from executing the same job at the same time."}}},"updatedDate":{"type":"integer","description":"Date job was last updated in epoch format."}}},"PaymentProviders":{"type":"object","properties":{"provider":{"type":"array","items":{"$ref":"#/components/schemas/PaymentProvider"}}}},"PaymentProvider":{"type":"object","properties":{"authType":{"type":"string","description":"Installation ID provided by the payment provider."},"credential":{"type":"string","description":"Base64-encoded credentials (`username:XMLpassword`) for your Worldpay merchant account; `username ` is equivalent to the merchant code (in all caps) and `XMLpassword` specifies the XML password you set in the previous step, when setting up your Worldpay merchant account."},"description":{"type":"string","description":"Description of the payment provider."},"endpoint":{"type":"string","description":"Endpoint used to access the payment provider."},"id":{"type":"string","description":"ID of the payment provider. Required only when updating a payment provider."},"merchantCode":{"type":"string","description":"Merchant code provided by the payment provider to the API consumer."},"name":{"type":"string","description":"Name of the WorldPay payment provider."}}},"Reload":{"type":"object","properties":{"amount":{"type":"integer","description":"Amount to reload the prepaid account."},"supportedCurrency":{"type":"object","properties":{"id":{"type":"string","description":"Supported currency."}}}}},"EligibleProducts":{"type":"object","properties":{"product":{"type":"array","description":"Product details.","items":{"$ref":"#/components/schemas/APIProduct"}}}}}}}
/ mint / organizations / {org_name} / monetization-packages
/ mint / organizations / {org_name} / monetization-packages / {package_id}
/ mint / organizations / {org_name} / developers / {developer_email} / monetization-packages
/ mint / organizations / {org_name} / companies / {company_id} / monetization-packages
/ mint / organizations / {org_name} / monetization-packages / {package_id} / products / {product_id}
/ mint / organizations / {org_name} / products
/ mint / organizations / {org_name} / products / {product_id}
/ mint / organizations / {org_name} / billing-adjustments
/ mint / organizations / {org_name} / billing-adjustments / {billing_adjustment_id}
/ mint / organizations / {org_name} / tax-engine
/ mint / organizations / {org_name} / monetization-packages / {package_id} / rate-plans / {plan_id} / real-currency-credit-transactions
/ mint / organizations / {org_name} / developers / {developer_email} / developer-credit-limit
/ mint / organizations / {org_name} / supported-currencies
/ mint / organizations / {org_name} / supported-currencies / {supportedcurrency_id}
/ mint / organizations / {org_name} / developer-categories
/ mint / organizations / {org_name} / developer-categories / {category_id}
/ mint / organizations / {org_name} / transactions
/ mint / organizations / {org_name} / developer-roles
/ mint / organizations / {org_name} / notification-email-templates
/ mint / organizations / {org_name} / notification-email-templates / {template_id}
/ mint / organizations / {org_name} / notification-conditions / {condition_id}
/ mint / organizations / {org_name} / notification-conditions
/ mint / organizations / {org_name} / webhooks
/ mint / organizations / {org_name} / webhooks / {webhook_id}
/ mint / organizations / {org_name} / webhooks / {webhook_id} / test / {developer_email} / {app_id} / {product_id} / {rateplan_id}
/ mint / organizations / {org_name} / webhooks / {webhook_id} / test / {developer_email} / {app_id} / {product_id} / {rateplan_id} / {trigger_type}
/ mint / organizations / {org_name} / notification-service-items
/ mint / organizations / {org_name} / notification-service-items / {notification_id}
/ mint / organizations / {org_name} / notification-service-items / {notification_id} / reprocess
/ mint / organizations / {org_name}
/ mint / organizations / {org_name} / developers / {developer_email} / developer-balances / recurring-setup
/ mint / organizations / {org_name} / companies / {company_id} / developer-balances / recurring-setup
/ mint / organizations / {org_name} / companies / {company_id} / developer-balances
/ mint / organizations / {org_name} / developers / {developer_email} / developer-balances
/ mint / organizations / {org_name} / developers / {developer_email} / prepaid-developer-balance
/ mint / organizations / {org_name} / companies / {company_id} / eligible-products
/ mint / organizations / {org_name} / developers
/ mint / organizations / {org_name} / developers / {developer_email}
/ mint / organizations / {org_name} / developers / {developer_email} / eligible-products
/ mint / organizations / {org_name} / providers
/ mint / organizations / {org_name} / providers / {provider_id}
/ mint / organizations / {org_name} / rate-plans
/ mint / organizations / {org_name} / monetization-packages / {package_id} / rate-plans
/ mint / organizations / {org_name} / monetization-packages / {package_id} / rate-plans / {plan_id}
/ mint / organizations / {org_name} / monetization-packages / {package_id} / rate-plans / {plan_id} / revision
/ mint / organizations / {org_name} / developers / {developer_email} / developer-rateplans
/ mint / organizations / {org_name} / developers / {developer_email} / developer-rateplans / {developer_rateplan_id}
/ mint / organizations / {org_name} / developers / {developer_email} / products / {product_id} / rate-plan-by-developer-product
/ mint / organizations / {org_name} / developers / {developer_email} / developer-accepted-rateplans
/ mint / organizations / {org_name} / monetization-packages / {package_id} / refund-transactions
/ mint / organizations / {org_name} / report-definitions
/ mint / organizations / {org_name} / developers / {developer_email} / report-definitions
/ mint / organizations / {org_name} / report-definitions / {report_definition_id}
/ mint / organizations / {org_name} / {report_type}
/ mint / organizations / {org_name} / developers / {developer_email} / revenue-reports
/ mint / organizations / {org_name} / transaction-search
/ mint / organizations / {org_name} / applications-with-transactions
/ mint / organizations / {org_name} / developers-with-transactions
/ mint / organizations / {org_name} / products-with-transactions
/ mint / organizations / {org_name} / packages-with-transactions
/ triggers
/ triggers / {trig_id}
/ mint / organizations / {org_name} / suspended-developers
/ mint / organizations / {org_name} / suspended-developers / {id}
/ mint / organizations / {org_name} / suspended-developers / unsuspend-by-product / {suspendedProduct_id}
/ mint / organizations / {org_name} / sync-organization
/ mint / organizations / {org_name} / sync-products
/ mint / organizations / {org_name} / sync-developers
/ mint / organizations / {org_name} / sync-applications
/ mint / organizations / {org_name} / tncs
/ mint / organizations / {org_name} / tncs / {tncs_id}
/ mint / organizations / {org_name} / developers / {developer_email} / developer-tncs
/ mint / organizations / {org_name} / developers / {developer_email} / tncs / {tncs_id} / developer-tncs
/ mint / organizations / {org_name} / transactions / developers / {developer_email}
Company App Keys API OpenAPI	{"openapi":"3.0.0","servers":[{"url":"https://api.enterprise.apigee.com/v1"}],"info":{"title":"Company App Keys API","description":"Manage consumer credentials (also known as \"API keys\" or \"app keys\") that are generated, provisioned, and managed by Apigee Edge for apps associated with company entities.","version":"1.0"},"security":[{"Basic":[]},{"OAuth":[]}],"paths":{"/organizations/{org_name}/companies/{company_name}/apps/{app_name}/keys/create":{"post":{"tags":["Company","Company App","Consumer Key"],"summary":"Create a consumer key and secret","description":"Creates a custom consumer key and secret for a company app. This is particularly useful if you want to migrate existing consumer keys/secrets to Edge from another system.\n\nAfter creating the consumer key and secret, associate the key with an API product, as described in Add API Product to Key.\n\nConsumer keys and secrets can contain letters, numbers, underscores, and hyphens. No other special characters are allowed.\n\n**Note**: Be aware of the following size limits on API keys. By staying within these limits, you help avoid service disruptions.\n\n* Consumer key (API key) size: 2 KB\n* Consumer secret size: 2 KB\n\nIf a consumer key and secret already exist, you can either keep them or delete them, as described in Delete Key for a Developer App.\n\nIn addition, you can use this API if you have existing API keys and secrets that you want to copy into Edge from another system. For more information, see <a href=\"https://docs.apigee.com/developer-services/content/import-existing-consumer-keys-and-secrets\">Import existing consumer keys and secrets</a>.","operationId":"createDevAppKey","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/company_name"},{"$ref":"#/components/parameters/app_name"}],"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Keys"},"example":{"apiProducts":[{"apiproduct":"Hotels","status":"approved"}],"attributes":[{"name":"attribute1","value":"value1"}],"consumerKey":"<consumerKey>","consumerSecret":"<consumerSecret>","expiresAt":-1,"issuedAt":1523971974806,"scopes":["scope1","scope2"],"status":"approved"}}}},"400":{"description":"Bad request"}},"requestBody":{"description":"Consumer key and secret.","content":{"application/json":{"schema":{"type":"object","properties":{"consumerKey":{"description":"Consumer key.","type":"string"},"consumerSecret":{"description":"Consumer secret.","type":"string"}}},"example":{"consumerKey":"<consumerKey>","consumerSecret":"<consumerSecret>"}}}}}},"/organizations/{org_name}/companies/{company_name}/apps/{app_name}/keys/{consumer_key}":{"get":{"tags":["Company App Keys"],"description":"Get key information for a company app","summary":"Gets information about the consumer key issued to a specific company app.","operationId":"getCompanyAppKey","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/company_name"},{"$ref":"#/components/parameters/app_name"},{"$ref":"#/components/parameters/consumer_key"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Keys"},"example":{"apiProducts":[{"apiproduct":"Hotels","status":"approved"}],"attributes":[{"name":"attribute1","value":"value1"}],"consumerKey":"<consumerKey>","consumerSecret":"<consumerSecret>","expiresAt":-1,"issuedAt":1523971974806,"scopes":["scope1","scope2"],"status":"approved"}}}},"400":{"description":"Bad request"}}},"post":{"summary":"Add an API product, or approve or revoke a key for a company app","description":"Enables you to perform one of the following tasks:\n\n* Add an API product to a company app key, enabling the app that holds the key to access the API resources bundled in the API product. You can also use this API to add attributes to the key. You must include all existing attributes, whether or not you are updating them, as well as any new attributes that you are adding. After adding the API product, you can use the same key to access all API products associated with the app.\n\n* Approve or revoke a specific consumer key for an app. Call the API with the `action` query parameter set to `approve` or `revoke `(with no request body) and set the `Content-type` header to `application/octet-stream`. If successful, the HTTP status code for success is: `204 No Content` **Currently, this action cannot be executed using the Try this API panel.**\n\nYou can approve a consumer key that is currently revoked or pending. Once approved, the app can use the consumer key to access APIs. Revoking a consumer key renders it unusable for the app to use to access an API. An app with an unapproved key cannot access any API products and cannot invoke any APIs managed by Apigee Edge.\n**Note**: Any access tokens associated with a revoked app key will remain active. However, Apigee Edge checks the status of the app key and if set to `revoked` it will not allow API calls to go through.","operationId":"approveRevokeAddProductCompanyAppKey","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/company_name"},{"$ref":"#/components/parameters/app_name"},{"$ref":"#/components/parameters/consumer_key"},{"$ref":"#/components/parameters/action"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Keys"},"example":{"apiProducts":[{"apiproduct":"Hotels","status":"approved"}],"attributes":[{"name":"attribute1","value":"value1"}],"consumerKey":"<consumerKey>","consumerSecret":"<consumerSecret>","expiresAt":-1,"issuedAt":1523971974806,"scopes":["scope1","scope2"],"status":"approved"}}}},"204":{"description":"No content"},"400":{"description":"Bad request"}},"requestBody":{"description":"List of API products and attributes.","content":{"application/json":{"schema":{"type":"object","properties":{"apiProducts":{"type":"array","description":"List of API products associated with an API key. Required when adding an API product to a key.","items":{"type":"string"}},"attributes":{"type":"array","description":"List of attributes associated with an API key.","items":{"type":"object","properties":{"name":{"type":"string","description":"Name of the custom attribute."},"value":{"type":"string","description":"Value of the custom attribute."}}}}}},"example":{"apiProducts":["Hotels","Restaurants"],"attributes":[{"name":"attribute1","value":"value1"}]}}}}},"delete":{"summary":"Delete key for a company app","description":"Deletes a key for a company app and removes all API products associated with the app. The key can no longer be used to access any APIs.","operationId":"deleteCompanyAppKey","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/company_name"},{"$ref":"#/components/parameters/app_name"},{"$ref":"#/components/parameters/consumer_key"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Keys"},"example":{"apiProducts":[{"apiproduct":"Hotels","status":"approved"}],"attributes":[{"name":"attribute1","value":"value1"}],"consumerKey":"<consumerKey>","consumerSecret":"<consumerSecret>","expiresAt":-1,"issuedAt":1523971974806,"scopes":["scope1","scope2"],"status":"approved"}}}},"400":{"description":"Bad request"}}}},"/organizations/{org_name}/companies/{company_name}/apps/{app_name}/keys/{consumer_key}/apiproducts/{apiproduct_name}":{"post":{"tags":["Company App Keys"],"summary":"Approve or revoke API product for a company app API key","description":"Sets the association of a company app's consumer key with an API product to `approved` or `revoked`. The API product must already be associated with the company app.\nTo consume API resources defined in an API product, a company app's consumer key must be `approved` and it must also be `approved` for that specific API product.","operationId":"approveRevokeCompanyAppKeyAPIProduct","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/company_name"},{"$ref":"#/components/parameters/app_name"},{"$ref":"#/components/parameters/consumer_key"},{"$ref":"#/components/parameters/apiproduct_name"},{"$ref":"#/components/parameters/action"}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad request"}}},"delete":{"tags":["Company App Keys"],"summary":"Remove API product for a company app API key","description":"Removes an API product from a company app's consumer key, and thereby renders the company app unable to access the API resources defined in that API product.\n\nNote that the consumer key itself still exists after this call. Only the association of the key with the API product is removed.","operationId":"approveRevokeCompanyAppKeyAPIProduct","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/company_name"},{"$ref":"#/components/parameters/app_name"},{"$ref":"#/components/parameters/consumer_key"},{"$ref":"#/components/parameters/apiproduct_name"}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad request"}}}}},"components":{"securitySchemes":{"Basic":{"type":"http","scheme":"basic","description":"Multi-factor authentication is not supported."},"OAuth":{"type":"apiKey","name":"Authorization","in":"header","description":"For OAuth, enter the following in the Key field: Bearer %your-token% (see https://docs.apigee.com/api-platform/system-administration/using-oauth2#get-the-tokens)"}},"parameters":{"org_name":{"in":"path","name":"org_name","required":true,"schema":{"type":"string"},"description":"Organization name."},"company_name":{"in":"path","name":"company_name","required":true,"schema":{"type":"string"},"description":"Company name."},"app_name":{"in":"path","name":"app_name","required":true,"schema":{"type":"string"},"description":"App name."},"consumer_key":{"in":"path","name":"consumer_key","required":true,"schema":{"type":"string"},"description":"Consumer key."},"apiproduct_name":{"in":"path","name":"apiproduct_name","required":true,"schema":{"type":"string"},"description":"API product name."},"action":{"in":"query","name":"action","required":false,"schema":{"type":"string"},"description":"Set to `approve` or `revoke`."}},"schemas":{"Keys":{"description":"Consumer key and secret.","type":"object","properties":{"apiProducts":{"type":"array","description":"List of API products associated with an API key. Required when adding an API product to a key.","items":{"type":"object","properties":{"apiproduct":{"type":"string","description":"Name of the API product."},"status":{"type":"string","description":"Status of the API product. Valid values include `approved` or `revoked`."}}}},"attributes":{"type":"array","description":"List of attributes associated with an API key.","items":{"type":"object","properties":{"name":{"type":"string","description":"Name of the custom attribute."},"value":{"type":"string","description":"Value of the custom attribute."}}}},"consumerKey":{"description":"Consumer key.","type":"string"},"consumerSecret":{"description":"Consumer secret.","type":"string"},"expiresAt":{"type":"integer","description":"Time at which the consumer key and secret expire in milliseconds since epoch. Set to -1 to never expire."},"issuedAt":{"type":"integer","description":"Time at which the consumer key and secret were issued in milliseconds since epoch."},"scopes":{"type":"array","description":"List of OAuth scopes.","items":{"type":"string"}},"status":{"type":"string","description":"Status of the API key. Valid values include `approved` or `revoked`."}}}}}}
/ organizations / {org_name} / companies / {company_name} / apps / {app_name} / keys / create
/ organizations / {org_name} / companies / {company_name} / apps / {app_name} / keys / {consumer_key}
/ organizations / {org_name} / companies / {company_name} / apps / {app_name} / keys / {consumer_key} / apiproducts / {apiproduct_name}
Alerts API OpenAPI	{"openapi":"3.0.1","info":{"title":"Alerts API","description":"Set up alerts and notifications and obtain metrics and log information. For more information, see <a href=\"https://docs.apigee.com/api-monitoring/alerts-notifications-api\">Managing alerts and notification using the API</a>.\n","version":"1.0"},"servers":[{"url":"https://apimonitoring.enterprise.apigee.com"}],"security":[{"OAuth":[]}],"paths":{"/alerts":{"get":{"tags":["API Montoring"],"summary":"List alerts for an organization","description":"Lists alerts for an organization.\n\n\n**Note**: Edge imposes a quota on this API of 60 calls per minute per organization. This quota is calculated by multiplying 20 (number of allowed alerts) * 3 = 60 calls.\n\n\nFor more information and examples of this API, see <a href=\"https://docs.apigee.com/api-monitoring/alerts-notifications-api\">Managing alerts and notifications using the API</a>.\n","parameters":[{"$ref":"#/components/parameters/org"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"title":"Array of alerts","type":"array","items":{"$ref":"#/components/schemas/Alert"}},"example":{"uuid":"<uuid>","name":"API 5xx error rate","enabled":true,"description":"Proxy for UI traffic going to back end services","conditions":[{"uuid":"<uuid>","description":"","dimensions":{"env":"prod","org":"myorg","proxy":"myproxy","region":"ANY","statusCode":"5xx"},"metric":"rate","threshold":0.02,"durationSeconds":600,"comparator":">","updatedBy":"ahamilton@example.com"}],"playbook":"Link to playbook","throttleIntervalSeconds":3600,"self":"/alerts/abcd1234","feed":"/o/apigee-internal/events/abcd1234","organization":"myorg","environment":"prod","notifications":[{"channel":"email","destination":"ahamilton@example.com"}],"alertType":"runtime","alertSubType":"fixed","updatedAt":"2020-05-11T16:12:04.911775Z","updatedBy":"ahamilton@example.com"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"post":{"tags":["API Montoring"],"summary":"Create an alert","description":"Creates an alert.\n\nYou can set up a **maximum of 20 alerts per organization**. The alert settings apply to all users in the organization; they are not per user. If you change the alert settings, they change for all users in your organization.\n\n**Note**: Edge imposes a quota on this API of 60 calls per minute per organization. This quota is calculated by multiplying 20 (number of allowed alerts) * 3 = 60 calls.\n\nFor more information and examples of this API, see <a href=\"https://docs.apigee.com/api-monitoring/alerts-notifications-api\">Managing alerts and notifications using the API</a>.","requestBody":{"description":"Alert details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Alert"},"example":{"name":"API 5xx error rate","enabled":true,"description":"Proxy for UI traffic going to back end services","conditions":[{"description":"","dimensions":{"env":"prod","org":"myorg","proxy":"myproxy","region":"ANY","statusCode":"5xx"},"metric":"rate","threshold":0.02,"durationSeconds":600,"comparator":">"}],"playbook":"Link to playbook","throttleIntervalSeconds":3600,"self":"/alerts/abcd1234","feed":"/o/apigee-internal/events/abcd1234","organization":"myorg","environment":"prod","notifications":[{"channel":"email","destination":"ahamilton@example.com"}],"alertType":"runtime","alertSubType":"fixed"}}},"required":true},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Alert"},"example":{"uuid":"<uuid>","name":"API 5xx error rate","enabled":true,"description":"Proxy for UI traffic going to back end services","conditions":[{"uuid":"<uuid>","description":"","dimensions":{"env":"prod","org":"myorg","proxy":"myproxy","region":"ANY","statusCode":"5xx"},"metric":"rate","threshold":0.02,"durationSeconds":600,"comparator":">","updatedBy":"ahamilton@example.com"}],"playbook":"Link to playbook","throttleIntervalSeconds":3600,"self":"/alerts/abcd1234","feed":"/o/apigee-internal/events/abcd1234","organization":"myorg","environment":"prod","notifications":[{"channel":"email","destination":"ahamilton@example.com"}],"alertType":"runtime","alertSubType":"fixed","updatedAt":"2020-05-11T16:12:04.911775Z","updatedBy":"ahamilton@example.com"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-codegen-request-body-name":"alert"}},"/alerts/{alertId}":{"get":{"tags":["API Montoring"],"summary":"Get an alert","description":"Gets an alert definition.\n\n\n**Note**: Edge imposes a quota on this API of 60 calls per minute per organization. This quota is calculated by multiplying 20 (number of allowed alerts) * 3 = 60 calls.\n\n\nUse Get Alerts to get the UUIDs of all alerts for an organization.\n\n\nFor more information and examples of this API, see <a href=\"https://docs.apigee.com/api-monitoring/alerts-notifications-api\">Managing alerts and notifications using the API</a>.\n","parameters":[{"$ref":"#/components/parameters/alertId"}],"responses":{"200":{"description":"Successful response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Alert"},"example":{"uuid":"<uuid>","name":"API 5xx error rate","enabled":true,"description":"Proxy for UI traffic going to back end services","conditions":[{"uuid":"<uuid>","description":"","dimensions":{"env":"prod","org":"myorg","proxy":"myproxy","region":"ANY","statusCode":"5xx"},"metric":"rate","threshold":0.02,"durationSeconds":600,"comparator":">","updatedBy":"ahamilton@example.com"}],"playbook":"Link to playbook","throttleIntervalSeconds":3600,"self":"/alerts/abcd1234","feed":"/o/apigee-internal/events/abcd1234","organization":"myorg","environment":"prod","notifications":[{"channel":"email","destination":"ahamilton@example.com"}],"alertType":"runtime","alertSubType":"fixed","updatedAt":"2020-05-11T16:12:04.911775Z","updatedBy":"ahamilton@example.com"}}}},"default":{"description":"Error","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"put":{"tags":["API Montoring"],"summary":"Update an alert","description":"Updates an alert.\n\n\nUse Get Alerts to get the UUIDs of all alerts for an organization. For more information and examples of this API, see <a href=\"https://docs.apigee.com/api-monitoring/alerts-notifications-api\">Managing alerts and notifications using the API</a>.\n\n**Notes**:\n\n\n* You cannot change the organization when updating the alert.\n\n* Edge imposes a quota on this API of 60 calls per minute per organization. This quota is calculated by multiplying 20 (number of allowed alerts) * 3 = 60 calls.\n\n* **This API cannot be executed using the Try this API panel**.\n","parameters":[{"$ref":"#/components/parameters/alertId"}],"requestBody":{"description":"Updated alert payload\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Alert"},"example":{"name":"API 5xx error rate","enabled":true,"description":"Proxy for UI traffic going to back end services","conditions":[{"description":"","dimensions":{"env":"prod","org":"myorg","proxy":"myproxy","region":"ANY","statusCode":"5xx"},"metric":"rate","threshold":0.02,"durationSeconds":600,"comparator":">"}],"playbook":"Link to playbook","throttleIntervalSeconds":3600,"self":"/alerts/abcd1234","feed":"/o/apigee-internal/events/abcd1234","organization":"myorg","environment":"prod","notifications":[{"channel":"email","destination":"ahamilton@example.com"}],"alertType":"runtime","alertSubType":"fixed"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Alert"},"example":{"uuid":"<uuid>","name":"API 5xx error rate","enabled":true,"description":"Proxy for UI traffic going to back end services","conditions":[{"uuid":"<uuid>","description":"","dimensions":{"env":"prod","org":"myorg","proxy":"myproxy","region":"ANY","statusCode":"5xx"},"metric":"rate","threshold":0.02,"durationSeconds":600,"comparator":">","updatedBy":"ahamilton@example.com"}],"playbook":"Link to playbook","throttleIntervalSeconds":3600,"self":"/alerts/abcd1234","feed":"/o/apigee-internal/events/abcd1234","organization":"myorg","environment":"prod","notifications":[{"channel":"email","destination":"ahamilton@example.com"}],"alertType":"runtime","alertSubType":"fixed","updatedAt":"2020-05-11T16:12:04.911775Z","updatedBy":"ahamilton@example.com"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-codegen-request-body-name":"alert"},"delete":{"tags":["API Montoring"],"summary":"Delete an alert","description":"Deletes an alert.\n\n\n**Notes**:\n\n\n* Edge imposes a quota on this API of 60 calls per minute per organization. This quota is calculated by multiplying 20 (number of allowed alerts) * 3 = 60 calls.\n\n* **This API cannot be executed using the Try this API panel**.\n\n\nUse Get Alerts to get the UUIDs of all alerts for an organization.\n\n\nFor more information and examples of this API, see <a href=\"https://docs.apigee.com/api-monitoring/alerts-notifications-api\">Managing alerts and notifications using the API</a>.\n","parameters":[{"$ref":"#/components/parameters/alertId"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Alert"},"example":{"uuid":"<uuid>","name":"API 5xx error rate","enabled":true,"description":"Proxy for UI traffic going to back end services","conditions":[{"uuid":"<uuid>","description":"","dimensions":{"env":"prod","org":"myorg","proxy":"myproxy","region":"ANY","statusCode":"5xx"},"metric":"rate","threshold":0.02,"durationSeconds":600,"comparator":">","updatedBy":"ahamilton@example.com"}],"playbook":"Link to playbook","throttleIntervalSeconds":3600,"self":"/alerts/abcd1234","feed":"/o/apigee-internal/events/abcd1234","organization":"myorg","environment":"prod","notifications":[{"channel":"email","destination":"ahamilton@example.com"}],"alertType":"runtime","alertSubType":"fixed","updatedAt":"2020-05-11T16:12:04.911775Z","updatedBy":"ahamilton@example.com"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}}},"components":{"securitySchemes":{"OAuth":{"type":"apiKey","name":"Authorization","in":"header","description":"For OAuth, enter the following in the Key field: Bearer %your-token% (see https://docs.apigee.com/api-platform/system-administration/using-oauth2#get-the-tokens)"}},"parameters":{"alertId":{"name":"alertId","in":"path","description":"Alert UUID.","required":true,"schema":{"type":"string"}},"org":{"in":"query","name":"org","required":true,"schema":{"type":"string"},"description":"Name of the organization."}},"schemas":{"Alert":{"type":"object","properties":{"uuid":{"type":"string","description":"Output only. Unique identifier for this alert.\n","format":"uuid","example":"42e6c0d3-ad53-11e7-a6eb-a08cfdd8891d"},"name":{"maxLength":100,"type":"string","description":"Alert name.\n","example":"weatherapi 5xx rate is fatal"},"enabled":{"type":"boolean","description":"Flag that specifies whether the alert is enabled.\nIf `true`, this alert will be triggered when conditions\nare met, and any configured notifications are\nsent. Defaults to `true`.\n","default":true},"description":{"maxLength":1000,"type":"string","description":"Alert description.\n","example":"Triggers when proxy 5xx rate for prod weatherapi is\nover 1.5% for 30 seconds\n"},"conditions":{"type":"array","description":"Conditions that must *all* be satisfied\nfor this alert to trigger. The minimum length is `1` and the\nmaximum length is `5`.\n","items":{"$ref":"#/components/schemas/Condition"}},"playbook":{"type":"string","description":"Message for consumers of this alert that\ncontains instructions and links for how to resolve\nthe root cause.\n","example":"Check charts at http://example.com and restart\nbackend servers\n"},"throttleIntervalSeconds":{"minimum":0,"type":"integer","description":"Minimum amount of time, in seconds, between\nrepeated notifications for a triggered alert. Values must be in increments of 60 seconds (one minute). For example, 300 (5 minutes), 360 (6 minutes), 420 (seven minutes), and so on. The minimum value is 300 seconds (5 minutes). The maximum value is 86400 seconds (24 hours).\n","example":300},"self":{"type":"string","description":"Output only.","example":"/alerts/42e6c0d3-ad53-11e7-a6eb-a08cfdd8891d"},"feed":{"type":"string","description":"Output only. Feed url on which notifications are posted\n","example":"/o/demo/events/42e6c0d3-ad53-11e7-a6eb-a08cfdd8891d"},"organization":{"type":"string","description":"Organization name. You cannot change the organization name when updating an alert.\n","example":"testOrg"},"environment":{"type":"string","description":"Environment name.\n","example":"testEnv"},"notifications":{"type":"array","description":"Notification endpoints that the alert will\nbe sent to when triggered. Notifications will fire repeatedly, at most\n`throttleIntervalSeconds` apart, while triggered.\n","items":{"$ref":"#/components/schemas/Notification"}},"alertType":{"type":"string","description":"Alert type. Set to `runtime`."},"alertSubType":{"type":"string","description":"Alert subtype. Valid values are `anomaly` or `fixed`."},"reportEnabled":{"type":"boolean","description":"Flag that specifies whether to create a custom report.\nIf `true`, a custom report is created based on\nalert condition. Defaults to `false`.\n","default":false},"reportUUID":{"type":"string","description":"Output only. Unique identifier for the UAP custom report generated for the alert. Only included if `reportEnabled` is set to `true`.\n","format":"uuid","example":"62e6c0d3-ad53-11e7-a6eb-a08cfdd8891d"},"updatedAt":{"type":"string","description":"Output only. Time the alert was updated.\n","format":"iso8601","example":"2017-10-12T23:19:09Z"},"updatedBy":{"type":"string","description":"Output only. Email address of the user that created or last modified\nthis alert.\n","format":"email","example":"user@example.com"}},"example":{"uuid":"<uuid>","name":"API 5xx error rate","enabled":false,"description":"Proxy for UI traffic going to back end services in apigee.com go/ue-how","conditions":[{"uuid":"<uuid>","description":"","dimensions":{"env":"prod","org":"myorg","proxy":"myproxy","region":"ANY","statusCode":"5xx"},"metric":"rate","threshold":0.02,"durationSeconds":600,"comparator":">","updatedBy":"ahamilton@example.com"}],"playbook":"Link to playbook","throttleIntervalSeconds":3600,"self":"/alerts/abcd1234","feed":"/o/apigee-internal/events/abcd1234","organization":"myorg","environment":"prod","notifications":[{"channel":"email","destination":"ahamilton@example.com"}],"alertType":"runtime","alertSubType":"fixed","updatedAt":"2020-05-11T16:12:04.911775Z","updatedBy":"ahamilton@example.com"}},"Condition":{"type":"object","properties":{"uuid":{"type":"string","description":"Output only. Unique identifier for this condition.\n","format":"uuid","example":"926aa42e-afa6-11e7-abc4-cec278b6b50a"},"description":{"maxLength":1000,"type":"string","description":"Description of alert condition.\n","example":"Triggers when proxy 5xx rate for prod weatherapi is\nover 1.5% for 30 seconds\n"},"dimensions":{"type":"object","description":"Object with key-value pairs that identify\nthe metric resource(s). For example, an environment, API proxy, or\nset of targets in an API proxy. Few keys like `statusCode` or\n`faultCodes` not valid for latency alerts.\n","$ref":"#/components/schemas/Dimension","example":{"org":"testOrg","env":"testEnv","proxy":"weatherapi","statusCode":"5xx"}},"metric":{"type":"string","description":"Metric monitored for the resources specified by `dimension`. Valid values include `rate`, `count`, `tps`, `totalLatency` or `targetLatency`. `count` and `totalLatency` are only valid metric for the anomaly alert subtype."},"threshold":{"type":"number","description":"Threshold values that is compared against the\nmetric value using `comparator` to determine\nif this condition is met. For `rate` metrics, this value is in the range 0-1.\n","example":0.015},"durationSeconds":{"type":"number","description":"Duration time, in seconds, for which the metric value\nmust continuously match the `threshold` value using\nthe `comparator` operator to determine if this\ncondition is met.\n\n\nFor example, given the following parameters:\n\n```\n{\n \"durationSeconds\": 30,\n \"threshold\": 0.015,\n \"comparator\": \">=\"\n}\n```\n\n\nThe condition is met when the metric is greater than\nor equal to 0.015 for 30 seconds, and not below\nthat value at any time within that duration.\n\nValid values include:\n\n* `60` (1 minute)\n\n* `120` (2 minutes)\n\n* `180` (3 minutes)\n\n* `240` (4 minutes)\n\n* `300` (5 minutes)\n\n* `600` (10 minutes)\n\n* `900` (15 minutes)\n\n* `1200` (20 minutes)\n\n* `1800` (30 minutes)\n\n* `3600` (1 hour)\n","example":30.0},"comparator":{"type":"string","description":"Operator that is used to compare the metric value\nagainst the `threshold` value to determine if this\ncondition is met. Valid values include:\n\n* `>` or `gt` (greater than)\n\n* `<` or `lt` (less than)\n\n* `>=` or `gte` (greater than or equal to)\n\n* `<=` or `lte` (less than or equal to)\n\n* `==` (equal to)\n\nNot valid for `anomaly` alert subtype.\n","example":">="},"updatedAt":{"type":"string","description":"Output only. Time the condition was updated.\n","format":"iso8601","example":"2017-10-12T23:19:09Z"},"updatedBy":{"type":"string","description":"Output only. Email address of the user that created or last modified\nthis condition.\n","format":"email","example":"user@example.com"}}},"Notification":{"type":"object","properties":{"channel":{"type":"string","description":"Channel on which to notify. Valid values include `email`, `pagerduty`, `slack`, or `webhook`.\n","example":"email"},"destination":{"type":"string","description":"Channel-specific destination to which the notification is sent.\n* For `email` channel, enter an email address\n\n* For `pagerduty` channel, enter a [PagerDuty Events API v2](https://v2.developer.pagerduty.com/docs/events-api-v2) integration (routing) key\n\n* For `slack` channel, enter a [Slack Incoming Webhook](https://api.slack.com/incoming-webhooks) URL","example":"user@example.com"}}},"Dimension":{"type":"object","properties":{"collection":{"type":"string","description":"Collection ID to monitor collection of targets or API proxies."},"developerApp":{"type":"string","description":"Developer app name, or the special value `ANY` to monitor any developer app in the environment."},"env":{"type":"string","description":"Environment name."},"faultCodeCategory":{"type":"string","description":"Fault code category. Valid in conjunction with `faultCodeSubCategory`. Not valid if `statusCode` is present. Not valid for latency alerts."},"faultCodeName":{"type":"string","description":"Fault code name. Valid only if you specify a value for `faultCodeSubCategory`. Specify a specific name, ALL, or ANY. You can only specify a name if you specified an explicit subcategory to `faultCodeSubCategory`. That is, `faultCodeSubCategory` cannot be set to `ALL` or `ANY`. `ALL` specifies that all fault code names must have been violated for the alert to trigger. `ANY` specifies to trigger the alert if any fault code name has been violated."},"faultCodeSubCategory":{"type":"string","description":"Fault code subcategory. Valid only if you specify a value for `faultCodeCategory`. Specify a specific subcategory, `ALL`, or `ANY`. `ALL` specifies that all subcategories must have been violated for the alert to trigger. `ANY` specifies to trigger the alert if any subcategory fault has been violated."},"percentile":{"type":"string","description":"Percentile (50, 90, 95, 99) of the latency value that, if violated, the alert is fired."},"proxy":{"type":"string","description":"API proxy name, or the special value `ANY` or `ALL` to monitor any API proxy in the environment."},"statusCode":{"type":"string","description":"Status code, such as `5xx`, `4xx`, `404`, `2xx` on whose rate or count if violated the alert should be fired. Not valid for latency alerts."},"target":{"type":"string","description":"Target name, or the special value `ANY` or `ALL` to monitor any target in the API proxy."}}},"Error":{"type":"object","properties":{"errorCode":{"type":"integer"},"status":{"type":"integer","description":"HTTP status code\n","example":500},"message":{"type":"string"}}},"Delete":{"type":"object","properties":{"status":{"type":"integer","description":"HTTP status code\n","example":200},"message":{"type":"string","example":"delete `selfUrl` successful"}}}}}}
/ alerts
/ alerts / {alertId}
Keystores and truststores API OpenAPI	{"openapi":"3.0.0","servers":[{"url":"https://api.enterprise.apigee.com/v1"}],"info":{"title":"Keystores and truststores API","description":"Manage keystors and truststores. \n\nKeystores and truststores define repositories of security certificates used for TLS encryption. The main difference between the two is where they are used in the TLS handshaking process:\n* A keystore is maintained on the server hosting the TLS endpoint. It contains a TLS certificate and private key. When a client connects to the TLS endpoint on the server, the keystore presents the server's certificate (public cert) to the client.\n\n All servers hosting an TLS endpoint create a keystore for both one-way and two-way, or client, TLS.\n\n* A truststore contains trusted certificates stored on the client that are used when the client makes an outbound TLS connection to an TLS endpoint. The contents of the truststore are used to validate the identity of the server's certificate being presented to the client.\n\n A server typically creates a truststore when configuring two-way TLS. The server maintains its cert and private key in its keystore, and maintains the client's cert in its truststore.\n\nFor more information, see <a href=\"https://docs.apigee.com/api-platform/system-administration/creating-keystores-and-truststore-cloud-using-edge-management-api\">Creating keystores and trustores using the Edge API</a>.","version":"1.0"},"security":[{"Basic":[]},{"OAuth":[]}],"paths":{"/organizations/{org_name}/environments/{env_name}/keystores":{"post":{"tags":["Keystore","Truststore"],"summary":"Create a keystore or truststore","description":"Creates a keystore or truststore in an environment.\n\n* **Keystore**: Contains the TLS certificate and private key used to identify the entity during TLS handshaking.\n* **Truststore**: Contains trusted certificates on an TLS client used to validate a TLS server's certificate presented to the client. These certificates are typically self-signed certificates or certificates that are not signed by a trusted CA.\n\nTo configure functionality that relies on public key infrastructure (TLS and SAML, for example) you need to create keystores and truststores that provide the necessary keys and digital certificates. Keystores and truststores define repositories of security certificates used for TLS encryption.\n\nThe APIs that you use to create a truststore are the same as used to create a keystore. The only difference is that you pass the cert file as a PEM file instead of a JAR file.\n\nKeystore names can contain only alphanumeric characters. For more information, see <a href=\"https://docs.apigee.com/api-platform/system-administration/creating-keystores-and-truststore-cloud-using-edge-management-api\">Creating keystores and trustores using the Edge API</a>.","operationId":"createKeystoreTruststore","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/env_name"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/KeystoreTrustore"},"example":{"aliases":[],"certs":[],"keys":[],"name":"MyTestKeystore"}}}},"400":{"description":"Bad request"}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"description":"Name of the keystore or truststore.","type":"string"}}}}}}},"get":{"tags":["Keystore","Truststore"],"summary":"List keystores and truststores","description":"Lists the keystores and truststores in the environment.\n\nIn Edge, keystores and truststores are both represented by a keystore entity. That is, the contents of the keystore determine if it is used as an TLS keystore or truststore:\n\n* **keystore**: Keystore entity that contains one or more aliases, where each alias contains a cert/key pair.\n* **truststore**: Keystore entity that contains one or more aliases, where each alias contains a cert only.","operationId":"listKeystoresTruststores","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/env_name"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}}},"400":{"description":"Bad request"}}}},"/organizations/{org_name}/environments/{env_name}/keystores/{keystore_name}":{"delete":{"tags":["Keystore","Truststore"],"summary":"Delete a keystore or truststore","description":"Deletes a keystore or truststore in an environment.","operationId":"deleteKeystoreTruststore","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/env_name"},{"$ref":"#/components/parameters/keystore_name"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/KeystoreTrustore"},"example":{"aliases":[],"certs":[],"keys":[],"name":"MyTestKeystore"}}}},"400":{"description":"Bad request"}}},"get":{"tags":["Keystore","Truststore"],"summary":"Get a keystore or truststore","description":"Gets a keystore or truststore in the environment, including the list of keys and certs.","operationId":"getKeystoreTruststore","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/env_name"},{"$ref":"#/components/parameters/keystore_name"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/KeystoreTrustore"},"example":{"aliases":[{"aliasName":"myTestAlias","cert":"myTestAlias-cert","key":"myTestAlias-key"}],"certs":["myTestAlias-cert"],"keys":["myTestAlias"],"name":"MyTestKeystore"}}}},"400":{"description":"Bad request"}}}},"/organizations/{org_name}/environments/{env_name}/keystores/{keystore_name}/aliases":{"post":{"tags":["Keystore","Truststore"],"summary":"Create an alias","description":"Creates a new alias in a keystore or trustore. The input certificate/key formats supported are PKCS12, JAR, certificate PEM file (for truststore), or self-signed certificate.\n\n**Note**: **Currently, you cannot create an alias using the Try this API panel**.\n\n**Deprecation Warning**: The `password` query parameter to this method has been deprecated for security reasons. If the private key requires a password, you must pass it as `multipart/form-data`. For example, if you are using curl, use the `-F` password option to specify the password:\n\n**Create an alias in a keystore from a JAR file**\n\nTo use a JAR file to create the alias, it must include the certificate and private key files, and a `META-INF/descriptor.properties` file that contains the following information:\n\n```\ncertFile=<certfile> \nkeyFile=<privatekeyfile>\n```\n\nA keystore JAR can contain just those three files. If you have a certificate chain, all certs in the chain must be appended into a single PEM file, where the last certificate should be signed by a root CA. The certs must be appended to the PEM file in the correct order, with an empty line between each cert.\nSet the `format` query parameter to `keycertjar`. \n\nFor example:\n\n```\ncurl \"https://api.enterprise.apigee.com/v1/o/{org_name}/e/{env_name}/keystores/{keystore_name}/aliases?alias={alias_name}&format=keycertjar\" \\\n -X POST \n -H \"Content-Type: multipart/form-data\" \\\n -F file=\"@myKeystore.jar\" \\\n -F password=key_pword \\\n -u orgAdminEmail:password \n```\n\n**Create an alias in a keystore from a PKCS file**\n\nTo create an alias in a keystore from a PKCS file, set the `format` query parameter to `pkcs12`. \n\nFor example:\n\n```\ncurl \"https://api.enterprise.apigee.com/v1/o/{org_name}/e/{env_name}/keystores/{keystore_name}/aliases?alias={alias_name}&format=pkcs12\" \\\n -X POST \n -H \"Content-Type: multipart/form-data\" \\\n -F file=\"@myKeystore.pfx\" \\\n -F password=key_pword \\\n -u orgAdminEmail:password \n```\n\n**Create an alias in a keystore from PEM files**\n\nTo create an alias in a keystore from a PEM file, the certificate and key to be in separate PEM files, as `keyFile` and `certFile`, respectively. Set the `format` query parameter to `keycertfile`. \n\nFor example:\n\n```\ncurl \"https://api.enterprise.apigee.com/v1/o/{org_name}/e/{env_name}/keystores/{keystore_name}/aliases?alias={alias_name}&format=keycertfile\" \\\n -X POST \\\n -H \"Content-Type: multipart/form-data\" \\\n -F keyFile=\"@server.key\" \\\n -F certFile=\"@signed.crt\" \\\n -F password=key_pword \\\n -u orgAdminEmail:password \n```\n\n**Create a truststore**\n\nTo create a truststore, create aliases from **certificates only** in PEM format and set the `format` query parameter to `keycertfile`. \n\n**Create an alias by generating a self-signed certificate**\n\nTo creat an alias by generating a self-signed certificate, set the `format` query parameter to `selfsignedcert` and pass the contents of the self-signed certificate in the request body. \n\nSee <a href=\"https://docs.apigee.com/api-platform/system-administration/creating-keystores-and-truststore-cloud-using-edge-management-api\">Creating keystores and truststores using the Edge API</a> for more examples.","operationId":"createAlias","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/env_name"},{"$ref":"#/components/parameters/keystore_name"},{"$ref":"#/components/parameters/alias"},{"$ref":"#/components/parameters/format"},{"$ref":"#/components/parameters/ignoreExpiryValidation"},{"$ref":"#/components/parameters/ignoreNewlineValidation"}],"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Alias"}}}},"400":{"description":"Bad request"}},"requestBody":{"content":{"multipart/form-data":{"schema":{"type":"string","format":"binary","description":"Alias details, in one of the following formats:\n\n* JAR file containing key, certificate, and a descriptor file (if `format=keycertjar`), or pfx/p12 file (if `format=pkcs12`).\n* Two PEM files, `keyFile` and `certFile`, containing the private key and certificate, respectively.\n* Single PEM file, `certFile`, containing the certificate in PEM format."}},"application/json":{"schema":{"$ref":"#/components/schemas/SelfSignedCertificate"}}}}},"get":{"tags":["Keystore","Truststore"],"summary":"List aliases","description":"Lists aliases in the keystore.","operationId":"listAliases","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/env_name"},{"$ref":"#/components/parameters/keystore_name"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}}},"400":{"description":"Bad request"}}}},"/organizations/{org_name}/environments/{env_name}/keystores/{keystore_name}/aliases/{alias_name}":{"put":{"tags":["Keystore","Truststore"],"summary":"Update the certificate in an alias","description":"Updates the certificate in the alias. The certificate must be a PEM file with a maximum size of 50 KB.\n\n**Note**: Do not use this API to update an existing deployed certificate. If you do, you must contact Apigee Support to restart the Routers and Message Processors.","operationId":"updateCertificateAlias","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/env_name"},{"$ref":"#/components/parameters/keystore_name"},{"$ref":"#/components/parameters/alias_name"},{"$ref":"#/components/parameters/ignoreExpiryValidation"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Alias"}}}},"400":{"description":"Bad request"}},"requestBody":{"description":"Certificate file in PEM format.","content":{"multipart/form-data":{"schema":{"type":"string","format":"binary"}}}}},"delete":{"tags":["Keystore","Truststore"],"summary":"Delete an alias","description":"Deletes an alias and the associated cert and key.\n\n**Note**: If you delete an alias, and it is currently being used by a virtual host or target endpoint, then any API calls through the virtual host or target endpoint will fail.","operationId":"deleteAlias","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/env_name"},{"$ref":"#/components/parameters/keystore_name"},{"$ref":"#/components/parameters/alias_name"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Alias"}}}},"400":{"description":"Bad request"}}},"get":{"tags":["Keystore","Truststore"],"summary":"Get alias","description":"Gets details about an alias, including information about the certificate and key associated with the alias.","operationId":"getAlias","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/env_name"},{"$ref":"#/components/parameters/keystore_name"},{"$ref":"#/components/parameters/alias_name"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Alias"}}}},"400":{"description":"Bad request"}}}},"/organizations/{org_name}/environments/{env_name}/keystores/{keystore_name}/aliases/{alias_name}/certificate":{"get":{"tags":["Keystore","Truststore"],"summary":"Export a certificate for an alias","description":"Exports a certificate or certificate chain for the specified alias in a keystore. The certificate is displayed in the following form:\n\n```\n-----BEGIN CERTIFICATE-----\nMIIDgTCCAuqgAwIBAgIJANjlQa0bGWn2MA0GCSqGSIb3DQEBCwUAMIGIMQswCQYD\nVQQGEwJVUzEWMBQGA1UECe563653657567ZXR0czEUMBIGA1UEBxMLTm9ydGhh\nbXB0b24xDDAKBgNVBAoTA1NNRzEMMAoGA1UECxMDRG9jMQwwCgYDVQQDEwNTTUcx\nITAfBgkqhkiG9w0BCQEWEnNnaWxzb25AYXBpZ2VlLmNvbTAeFw0xNDExMDYyMDAy\nNTNaFw0yNDExMDUyMDAyNTNaMIGIMQswCQYDVQQGEwJVUzEWMBQGA1UECBMNTWFz\nc2FjaHVzZXR0879870394753944353452345235Htc+9i/mrTSh/lbZFMmW0EYzTgSvnJ0DF+bWuaC\nyfaqd31HMbr7DVFJAji1CI8Ggmvu8gA0lnkCAwEAAaOB8DCB7TAdBgNVHQ4EFgQU\nHEXLx5XxwdLiX9+XYl9OGv19hPQwgb0GA1UdIwSBtTCBsoAUHEXLx5XxwdLiX9+X\nYl9OGv19hPShgY6cjhdfjhsdfjhlkjsdfMTA1NNRzEhMB8GCSqGSIb3DQEJARYSc2dpbHNvbkBh\ncGlnZWUuY29tggkA2OVBrRsZafYwDAYDVR0TBAUwAwEB/zANBgkqhkiG9w0BAQsF\nAAOBgQAYHdIdgfCz3ed1aoDCepPKwrYC6MhmzNYH4rPy0QR3UwKGom7VM0ifWlCr\nuxtg7lPF/nA5du2oGjizrtsjFTJ/DE5uV3XdnLHcsdxrJ1AmfNgH8xBqkJGlNv8/\naPTO/HQqsxi6WSuog1sC1w3VMQS2seUKLOVgkKDmsmcHc3AbXg==\n-----END CERTIFICATE-----\n```\n\nIf you copy the certificate to a file, from `-----BEGIN CERTIFICATE` through `END CERTIFICATE-----`, you can use the following command to obtain the public key:\n\n`openssl x509 -pubkey -noout -in fNAME`\n\nThis command displays the key in the following form:\n\n```\n-----BEGIN PUBLIC KEY-----\nMIGfMA0GCSqGSIb3DQEBAQUAA4GNsdfgsdfgQCs90FmfufNs1yIup5B2mdFFcKS\nacW71GeMNVaPBsgsdfgsdfgHjF2BcDT+6FO2FYLJfZXI0lcv5afDdKq+apalG4\niicdvimUe1z72L+sdfgsdfsdfgLJ9qp3fUcxuvsNUUkC\nOLUIjwaCa+sdfsdfsdADSWeQIDAQAB \n-----END PUBLIC KEY----- ```","operationId":"exportCertificateAlias","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/env_name"},{"$ref":"#/components/parameters/keystore_name"},{"$ref":"#/components/parameters/alias_name"}],"responses":{"200":{"description":"OK"},"400":{"description":"Bad request"}}}},"/organizations/{org_name}/environments/{env_name}/keystores/{keystore_name}/aliases/{alias_name}/csr":{"get":{"tags":["Keystore","Truststore"],"summary":"Generate a CSR for an alias","description":"Generate a Certificate Signing Request (CSR) based on the private key for the specified alias. Use this API if you have an expired cert and want to renew it. Download the CSR and then send it to your CA. \n\nFor example:\n\n```\n-----BEGIN CERTIFICATE-----\nMIIDgTCCAuqgAwIBAgIJANjlQa0bGWn2MA0GCSqGSIb3DQEBCwUAMIGIMQswCQYD\nVQQGEwJVUzEWMBQGA1UECe563653657567ZXR0czEUMBIGA1UEBxMLTm9ydGhh\nbXB0b24xDDAKBgNVBAoTA1NNRzEMMAoGA1UECxMDRG9jMQwwCgYDVQQDEwNTTUcx\nITAfBgkqhkiG9w0BCQEWEnNnaWxzb25AYXBpZ2VlLmNvbTAeFw0xNDExMDYyMDAy\nNTNaFw0yNDExMDUyMDAyNTNaMIGIMQswCQYDVQQGEwJVUzEWMBQGA1UECBMNTWFz\nc2FjaHVzZXR0879870394753944353452345235Htc+9i/mrTSh/lbZFMmW0EYzTgSvnJ0DF+bWuaC\nyfaqd31HMbr7DVFJAji1CI8Ggmvu8gA0lnkCAwEAAaOB8DCB7TAdBgNVHQ4EFgQU\nHEXLx5XxwdLiX9+XYl9OGv19hPQwgb0GA1UdIwSBtTCBsoAUHEXLx5XxwdLiX9+X\nYl9OGv19hPShgY6cjhdfjhsdfjhlkjsdfMTA1NNRzEhMB8GCSqGSIb3DQEJARYSc2dpbHNvbkBh\ncGlnZWUuY29tggkA2OVBrRsZafYwDAYDVR0TBAUwAwEB/zANBgkqhkiG9w0BAQsF\nAAOBgQAYHdIdgfCz3ed1aoDCepPKwrYC6MhmzNYH4rPy0QR3UwKGom7VM0ifWlCr\nuxtg7lPF/nA5du2oGjizrtsjFTJ/DE5uV3XdnLHcsdxrJ1AmfNgH8xBqkJGlNv8/\naPTO/HQqsxi6WSuog1sC1w3VMQS2seUKLOVgkKDmsmcHc3AbXg==\n-----END CERTIFICATE-----\n```","operationId":"generateCSRAlias","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/env_name"},{"$ref":"#/components/parameters/keystore_name"},{"$ref":"#/components/parameters/alias_name"}],"responses":{"200":{"description":"OK"},"400":{"description":"Bad request"}}}},"/organizations/{org_name}/environments/{env_name}/keystores/{keystore_name}/certs":{"get":{"tags":["Keystore","Truststore"],"summary":"Lists certificates for a keystore or truststore","description":"Lists certificates for a keystore or truststore.","operationId":"getCertsKeystoreTruststore","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/env_name"},{"$ref":"#/components/parameters/keystore_name"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}}},"400":{"description":"Bad request"}}},"post":{"tags":["Keystore","Truststore"],"summary":"Upload a certificate to a truststore","description":"Uploads a certificate to a truststore in an environment.\n\nIf the cert is part of a chain, then the truststore must contain all certs in the chain, either as individual PEM or DER files or as a single file. If you use a single file, then the certs must be in order where the first cert in the file is the certificate used for TLS followed by the chain of certs, in order, to the CA certificate.\n\nThe final certificate is typically signed by the certificate issuer. For example, in the truststore, you upload a client certificate, `client_cert_1`, and the client certificate issuer's certificate, `ca_cert`. \n\nThis API validates the following:\n\n* File size is no larger than 50KB.\n* Certificate is of type PEM or DER.\n* Certificate is not expired. To bypass this validation, set `ignoreExpiryValidation=true`.","operationId":"uploadCertTruststore","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/env_name"},{"$ref":"#/components/parameters/keystore_name"},{"$ref":"#/components/parameters/alias"},{"$ref":"#/components/parameters/ignoreExpiryValidation"},{"$ref":"#/components/parameters/ignoreNewlineValidation"}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad request"}}}},"/organizations/{org_name}/environments/{env_name}/keystores/{keystore_name}/certs/{cert_name}":{"delete":{"tags":["Keystore","Truststore"],"summary":"Delete cert from a keystore or truststore","description":"Deletes a cert from a keystore or truststore. \n\nTo view the list of cert aliases in a keystore or truststore, see <a href=\"/docs/keystores-and-trustores-api/1/routes/organizations/%7Borg_name%7D/environments/%7Benv_name%7D/keystores/%7Bkeystore_name%7D/certs/%7Bcert_name%7D/get\">Get cert details from a keystore or truststore</a>.\n\n**Note**: If the cert is part of a cert chain, deleting it could cause TLS handshaking to fail.","operationId":"deleteCertKeystoreTruststore","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/env_name"},{"$ref":"#/components/parameters/keystore_name"},{"$ref":"#/components/parameters/cert_name"}],"responses":{"200":{"description":"OK"},"400":{"description":"Bad request"}}},"get":{"tags":["Keystore","Truststore"],"summary":"Get cert details from a keystore or truststore","description":"Gets cert details from a keystore or truststore.","operationId":"getCertKeystoreTruststore","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/env_name"},{"$ref":"#/components/parameters/keystore_name"},{"$ref":"#/components/parameters/cert_name"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Certificate"},"example":{"certInfo":[{"basicConstraints":"CA:FALSE","expiryDate":1470268707000,"isValid":"No","issuer":"EMAILADDRESS=test@test.com, CN=api-ssl.example.com, OU=E2E, O=Apigee, L=San Jose, ST=CA, C=US","publicKey":"RSA Public Key, 2048 bits","serialNumber":"00:92:85:f7:e5:3b:c5:30:26","sigAlgName":"SHA1withRSA","subject":"EMAILADDRESS=test@test.com, CN=api-ssl.example.com, OU=E2E, O=Apigee, L=San Jose, ST=CA, C=US","subjectAlternativeNames":[],"validFrom":1438732707000,"version":1}],"certName":"myTestAlias-cert"}}}},"400":{"description":"Bad request"}}}},"/organizations/{org_name}/environments/{env_name}/keystores/{keystore_name}/certs/{cert_name}/export":{"get":{"tags":["Keystore","Truststore"],"summary":"Export a certificate from a keystore or truststore","description":"Exports a certificate. The certificate is displayed in the following form:\n\n```\n-----BEGIN CERTIFICATE-----\nMIIDgTCCAuqgAwIBAgIJANjlQa0bGWn2MA0GCSqGSIb3DQEBCwUAMIGIMQswCQYD\nVQQGEwJVUzEWMBQGA1UECe563653657567ZXR0czEUMBIGA1UEBxMLTm9ydGhh\nbXB0b24xDDAKBgNVBAoTA1NNRzEMMAoGA1UECxMDRG9jMQwwCgYDVQQDEwNTTUcx\nITAfBgkqhkiG9w0BCQEWEnNnaWxzb25AYXBpZ2VlLmNvbTAeFw0xNDExMDYyMDAy\nNTNaFw0yNDExMDUyMDAyNTNaMIGIMQswCQYDVQQGEwJVUzEWMBQGA1UECBMNTWFz\nc2FjaHVzZXR0879870394753944353452345235Htc+9i/mrTSh/lbZFMmW0EYzTgSvnJ0DF+bWuaC\nyfaqd31HMbr7DVFJAji1CI8Ggmvu8gA0lnkCAwEAAaOB8DCB7TAdBgNVHQ4EFgQU\nHEXLx5XxwdLiX9+XYl9OGv19hPQwgb0GA1UdIwSBtTCBsoAUHEXLx5XxwdLiX9+X\nYl9OGv19hPShgY6cjhdfjhsdfjhlkjsdfMTA1NNRzEhMB8GCSqGSIb3DQEJARYSc2dpbHNvbkBh\ncGlnZWUuY29tggkA2OVBrRsZafYwDAYDVR0TBAUwAwEB/zANBgkqhkiG9w0BAQsF\nAAOBgQAYHdIdgfCz3ed1aoDCepPKwrYC6MhmzNYH4rPy0QR3UwKGom7VM0ifWlCr\nuxtg7lPF/nA5du2oGjizrtsjFTJ/DE5uV3XdnLHcsdxrJ1AmfNgH8xBqkJGlNv8/\naPTO/HQqsxi6WSuog1sC1w3VMQS2seUKLOVgkKDmsmcHc3AbXg==\n-----END CERTIFICATE-----\n```\n\nIf you copy the certificate to a file, from `-----BEGIN CERTIFICATE` through `END CERTIFICATE-----`, you can use the following command to obtain the public key:\n\n`openssl x509 -pubkey -noout -in fNAME`\n\nThis command displays the key in the following form:\n\n``` \n-----BEGIN PUBLIC KEY-----\nMIGfMA0GCSqGSIb3DQEBAQUAA4GNsdfgsdfgQCs90FmfufNs1yIup5B2mdFFcKS\nacW71GeMNVaPBsgsdfgsdfgHjF2BcDT+6FO2FYLJfZXI0lcv5afDdKq+apalG4\niicdvimUe1z72L+sdfgsdfsdfgLJ9qp3fUcxuvsNUUkC\nOLUIjwaCa+sdfsdfsdADSWeQIDAQAB\n-----END PUBLIC KEY-----\n```","operationId":"exportCertKeystoreTruststore","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/env_name"},{"$ref":"#/components/parameters/keystore_name"},{"$ref":"#/components/parameters/cert_name"}],"responses":{"200":{"description":"OK"},"400":{"description":"Bad request"}}}},"/organizations/{org_name}/environments/{env_name}/keystores/{keystore_name}/keys":{"post":{"tags":["Keystore","Truststore"],"summary":"Upload a JAR file to a keystore","description":"After you've created a keystore in an environment, you can use this API to upload your JAR files that contain a cert and private key. \n\nThis API validates the following:\n\n* File size is no larger than 50KB.\n* Certificate is of type PEM or DER.\n* Certificate is not expired. To bypass this validation, set `ignoreExpiryValidation=true`.\n\n\n**Deprecation Warning**: The `password` query paramater to this method has been deprecated for security reasons. If the private key requires a password, you must pass it as `multipart/form-data`. For example, if you are using cURL, use the `-F` password option to specify the password:\n\n```\ncurl \"https://api.enterprise.apigee.com/v1/o/{org_name}/environments/{env_name}/keystores/{myKeystore}/keys?alias={key_alias}\" \\\n -X POST \\\n -H \"Content-Type: multipart/form-data\" \\\n -F file=\"@myKeystore.jar\" \\\n -F password=key_pword \\\n -u email:password\n```\n\nSee <a href=\"https://docs.apigee.com/api-platform/system-administration/create-keystores-and-truststores-private-cloud\">Create keystores and truststores for the Private Cloud version 4.17.09 and earlier</a> for more examples.","operationId":"uploadJARKeystore","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/env_name"},{"$ref":"#/components/parameters/keystore_name"},{"$ref":"#/components/parameters/alias"},{"$ref":"#/components/parameters/ignoreExpiryValidation"},{"$ref":"#/components/parameters/ignoreNewlineValidation"}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad request"}},"requestBody":{"description":"JAR file containing the cert and private key.","content":{"multipart/form-data":{"schema":{"type":"string","format":"binary"}}}}}},"/organizations/{org_name}/environments/{env_name}/testssl":{"post":{"tags":["Keystore","Truststore"],"summary":"Test a keystore or truststore","description":"Tests your truststore and keystore in the Edge UI to verify that they are configured properly. The test API validates a TLS request from Edge to a backend service. The backend service can be configured to support one-way or two-way TLS.","operationId":"testKeystoreTruststore","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/env_name"}],"responses":{"200":{"description":"OK"},"400":{"description":"Bad request"}},"requestBody":{"description":"Test details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TestTLS"}}}}}}},"components":{"securitySchemes":{"Basic":{"type":"http","scheme":"basic","description":"Multi-factor authentication is not supported."},"OAuth":{"type":"apiKey","name":"Authorization","in":"header","description":"For OAuth, enter the following in the Key field: Bearer %your-token% (see https://docs.apigee.com/api-platform/system-administration/using-oauth2#get-the-tokens)"}},"parameters":{"org_name":{"in":"path","name":"org_name","required":true,"schema":{"type":"string"},"description":"Organization name."},"env_name":{"in":"path","name":"env_name","required":true,"schema":{"type":"string"},"description":"Environment name."},"keystore_name":{"in":"path","name":"keystore_name","required":true,"schema":{"type":"string"},"description":"Keystore or trustore name."},"cert_name":{"in":"path","name":"cert_name","required":true,"schema":{"type":"string"},"description":"Certificate name. Use the certificate alias, if available."},"alias_name":{"in":"path","name":"alias_name","required":true,"schema":{"type":"string"},"description":"Alias name."},"count":{"in":"query","name":"count","required":false,"schema":{"type":"integer"},"description":"**Apigee Edge for Public Cloud only**. Number of API products to return in the API call. The limit is 1000. Required if you specify `startKey`."},"expand":{"in":"query","name":"expand","required":false,"schema":{"type":"boolean"},"description":"Flag that specifies whether to view expanded details about each API product. Set to `true` to view expanded details."},"startKey":{"in":"query","name":"startKey","required":false,"schema":{"type":"string"},"description":"**Apigee Edge for Public Cloud only**. Name of an API product from which to start displaying the list of API products. For example, if you're returning 50 API products at a time (using the count query parameter), you can view products 50-99 by entering the name of the 50th API product. The API product name is case sensitive."},"alias":{"in":"query","name":"alias","required":false,"schema":{"type":"string"},"description":"Alias name. Not required for self-signed certificates."},"format":{"in":"query","name":"format","required":true,"schema":{"type":"string"},"description":"Type of alias creation. Valid values include: `keycertjar`, `pkcs12`, `keycertfile`, and `selfsignedcert`."},"ignoreExpiryValidation":{"in":"query","name":"ignoreExpiryValidation","required":false,"schema":{"type":"string"},"description":"Flag that specifies whether to validate that the certificate hasn't expired. Set this value to true to skip validation. Defaults to `false`."},"ignoreNewlineValidation":{"in":"query","name":"ignoreNewlineValidation","required":false,"schema":{"type":"string"},"description":"If false, do not throw an error when the file contains a chain with no newline between each cert. By default, Edge requires a newline between each cert in a chain. Defaults to `true`."}},"schemas":{"KeystoreTrustore":{"description":"Keystore or trustore details.","type":"object","properties":{"aliases":{"type":"array","description":"List of associated aliases.","items":{"type":"object","properties":{"aliasName":{"type":"string","description":"Name of the alias."},"cert":{"type":"string","description":"Name of the cert."},"key":{"type":"string","description":"Name of the key."}}}},"certs":{"type":"array","description":"List of associated certs.","items":{"type":"string"}},"keys":{"type":"array","description":"List of associated keys.","items":{"type":"string"}},"name":{"type":"string","description":"Name of keystore or trustore."}}},"Alias":{"description":"Alias details.","type":"object","properties":{"alias":{"type":"string","description":"Alias name."},"certsInfo":{"type":"object","description":"List of associated certs.","properties":{"certInfo":{"type":"array","items":{"type":"object","properties":{"basicConstraints":{"type":"string","description":"Basic constraints."},"expiryDate":{"type":"string","description":"Expiration date in milliseconds since epoch."},"isValid":{"type":"string","description":"Flag that specifies whether the certificate is valid."},"issuer":{"type":"string","description":"Cert issuer details."},"publicKey":{"type":"string","description":"Public key details."},"serialNumber":{"type":"string","description":"Serial number of the certificate."},"sigAlgName":{"type":"string","description":"Name of the ignature algorithm, such as `SHA1withRSA`."},"subject":{"type":"string","description":"Subject details."},"subjectAlternativeNames":{"type":"array","description":"Alternative names for subject.","items":{"type":"string"}},"validFrom":{"type":"string","description":"Date from which the certificate is valid in milliseconds since epoch."},"version":{"type":"integer","description":"Version number."}}}},"certName":{"type":"string","description":"Name of the certificate."}}},"keyName":{"type":"string","description":"Name of the key."}}},"Certificate":{"description":"Certificate details.","type":"object","properties":{"certInfo":{"type":"array","items":{"type":"object","properties":{"basicConstraints":{"type":"string","description":"Constraints."},"expiryDate":{"type":"string","description":"Expiration date in milliseconds since epoch."},"isValid":{"type":"string","description":"Flag that specifies whether the certificate is valid."},"issuer":{"type":"string","description":"Cert issuer details."},"publicKey":{"type":"string","description":"Public key details."},"serialNumber":{"type":"string","description":"Serial number of the certificate."},"sigAlgName":{"type":"string","description":"Name of the ignature algorithm, such as `SHA1withRSA`."},"subject":{"type":"string","description":"Subject details."},"subjectAlternativeNames":{"type":"array","description":"Alternative names for subject.","items":{"type":"string"}},"validFrom":{"type":"string","description":"Date from which the certificate is valid in milliseconds since epoch."},"version":{"type":"integer","description":"Version number."}}}},"certName":{"type":"string","description":"Name of the certificate."}}},"TestTLS":{"description":"Test TLS details.","type":"object","properties":{"host":{"type":"string","description":"TLS host name."},"port":{"type":"string","description":"TLS port numbeer."},"connectionTimeout":{"type":"string","description":"TLS connection timeout, in milliseconds. Defaults to 3000."},"targetEndpointConfiguration":{"type":"object","description":"TargetEndpoint configuration.","properties":{"ciphers":{"description":"List of TLS ciphers to whitelist.","type":"array","items":{"type":"string"}},"clientAuthEnabled":{"type":"boolean","description":"Set to `true` to enable two-way (or client) TLS between Edge (as a client making the request) and the target (as a server). Defaults to `false`."},"keyAlias":{"description":"Alias specified when you uploaded the JAR file containing the cert and private key to the keystore.","type":"string"},"keyStore":{"description":"Name of the keystore on Edge.","type":"string"},"protocols":{"description":"TLS protocol, such as `SSLv3`, `TLSv1`, `TLSv1.1`, or `TLSv1.2`. If no protocols are specified, then all protocols available will be permitted.","type":"array","items":{"type":"string"}},"trustStore":{"description":"Name of the truststore on Edge that contains the certificate or certificate chain used for two-way TLS.","type":"string"}}}}},"SelfSignedCertificate":{"description":"Self-signed certificate details.","type":"object","required":["alias","commonName"],"properties":{"alias":{"type":"string","description":"Alias name. Maximum length is 128 characters."},"keySize":{"type":"string","description":"Key size. Default and maximum value is 2048 bits.","default":2048},"sigAlg":{"type":"string","description":"Signature algorithm to generate private key. Valid values are `SHA512withRSA`, `SHA384withRSA`, and `SHA256withRSA` (default).","default":"SHA256withRSA"},"subject":{"type":"object","description":"Subject details.","properties":{"countryCode":{"type":"string","description":"Two-letter country code. Example, IN for India, US for United States of America."},"state":{"type":"string","description":"State or district name. Maximum length is 128 characters."},"locality":{"type":"string","description":"City or town name. Maximum length is 128 characters."},"org":{"type":"string","description":"Organization name. Maximum length is 64 characters."},"orgUnit":{"type":"string","description":"Organization team name. Maximum length is 64 characters."},"commonName":{"type":"string","description":"Common name of the organization. Maximum length is 64 characters."},"email":{"type":"string","description":"Email address. Max 255 characters."}}},"subjectAlternativeDNSNames":{"type":"object","description":"List of alternative host names. Maximum length is 255 characters for each value.","properties":{"subjectAlternativeName":{"type":"array","items":{"type":"string"}}}},"certValidityInDays":{"type":"string","description":"Validity duration of certificate, in days. Accepts positive non-zero value. Defaults to 365.","default":365}}}}}}
/ organizations / {org_name} / environments / {env_name} / keystores
/ organizations / {org_name} / environments / {env_name} / keystores / {keystore_name}
/ organizations / {org_name} / environments / {env_name} / keystores / {keystore_name} / aliases
/ organizations / {org_name} / environments / {env_name} / keystores / {keystore_name} / aliases / {alias_name}
/ organizations / {org_name} / environments / {env_name} / keystores / {keystore_name} / aliases / {alias_name} / certificate
/ organizations / {org_name} / environments / {env_name} / keystores / {keystore_name} / aliases / {alias_name} / csr
/ organizations / {org_name} / environments / {env_name} / keystores / {keystore_name} / certs
/ organizations / {org_name} / environments / {env_name} / keystores / {keystore_name} / certs / {cert_name}
/ organizations / {org_name} / environments / {env_name} / keystores / {keystore_name} / certs / {cert_name} / export
/ organizations / {org_name} / environments / {env_name} / keystores / {keystore_name} / keys
/ organizations / {org_name} / environments / {env_name} / testssl
References API OpenAPI	{"openapi":"3.0.0","servers":[{"url":"https://api.enterprise.apigee.com/v1"}],"info":{"title":"References API","description":"When configuring a virtual host to support TLS, you can specify a keystore or truststore by using a reference. A reference is a variable that contains the name of the keystore or truststore, rather than specifying the keystore or truststore name directly. Apigee strongly recommends that you use references to keystores and truststores in a virtual host and do not use names directly.","version":"1.0"},"security":[{"Basic":[]},{"OAuth":[]}],"paths":{"/organizations/{org_name}/environments/{env_name}/references":{"get":{"tags":["References"],"summary":"List references","description":"List all references in an environment.","operationId":"listReferences","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/env_name"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}},"example":["MyReference","AnotherReference"]}}},"400":{"description":"Bad request"}}},"post":{"tags":["References"],"summary":"Create reference","description":"Creates a reference.\nFor example, when creating a reference to a keystore, set `resourceType` to `KeyStore` and `refers` to the name of the keystore. ","operationId":"createReference","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/env_name"}],"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Reference"},"example":{"name":"MyReference","refers":"MyKeystore","resourceType":"KeyStore"}}}},"400":{"description":"Bad request"}},"requestBody":{"description":"Resource details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Reference"},"example":{"name":"MyReference","refers":"MyKeystore","resourceType":"KeyStore"}}}}}},"/organizations/{org_name}/environments/{env_name}/references/{ref_name}":{"delete":{"tags":["References"],"summary":"Delete reference","description":"Deletes a reference.","operationId":"deleteReference","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/env_name"},{"$ref":"#/components/parameters/ref_name"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Reference"},"example":{"name":"MyReference","refers":"MyKeystore","resourceType":"KeyStore"}}}},"400":{"description":"Bad request"}}},"put":{"tags":["References"],"summary":"Update reference","description":"Updates a reference.","operationId":"updateReference","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/env_name"},{"$ref":"#/components/parameters/ref_name"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Reference"},"example":{"name":"MyReference","refers":"MyKeystore","resourceType":"KeyStore"}}}},"400":{"description":"Bad request"}},"requestBody":{"description":"Resource details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Reference"},"example":{"name":"MyReference","refers":"MyKeystore","resourceType":"KeyStore"}}}}},"get":{"tags":["References"],"summary":"Get reference","description":"Gets reference details.","operationId":"getReference","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/env_name"},{"$ref":"#/components/parameters/ref_name"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Reference"},"example":{"name":"MyReference","refers":"MyKeystore","resourceType":"KeyStore"}}}},"400":{"description":"Bad request"}}}}},"components":{"securitySchemes":{"Basic":{"type":"http","scheme":"basic","description":"Multi-factor authentication is not supported."},"OAuth":{"type":"apiKey","name":"Authorization","in":"header","description":"For OAuth, enter the following in the Key field: Bearer %your-token% (see https://docs.apigee.com/api-platform/system-administration/using-oauth2#get-the-tokens)"}},"parameters":{"org_name":{"in":"path","name":"org_name","required":true,"schema":{"type":"string"},"description":"Organization name."},"env_name":{"in":"path","name":"env_name","required":true,"schema":{"type":"string"},"description":"Environment name."},"ref_name":{"in":"path","name":"ref_name","required":true,"schema":{"type":"string"},"description":"Reference name."}},"schemas":{"Reference":{"description":"Organization details.","type":"object","required":["name","refers","resourceType"],"properties":{"name":{"description":"Name of the reference.","type":"string"},"refers":{"description":"Name of the keystore or truststore being referenced.","type":"string"},"resourceType":{"description":"Set to `KeyStore` or `TrustStore`.","type":"string"}}}}}}
/ organizations / {org_name} / environments / {env_name} / references
/ organizations / {org_name} / environments / {env_name} / references / {ref_name}
API security reports API (Beta) OpenAPI	{"openapi":"3.0.1","info":{"title":"API security reports API (Beta)","description":"Access API security reports. For more about security reports, see <a href=\"https://docs.apigee.com/api-platform/security/reports\">Introduction to security reports</a>.\n\nNote: This is the Beta release of API security reports. See <a href=\"https://docs.apigee.com/release/release-stages\">Release Stages</a>.","version":"1.0"},"servers":[{"url":"https://apisecurity.enterprise.apigee.com"}],"security":[{"OAuth":[]}],"paths":{"/security/overview/faultcode":{"get":{"tags":["API Security Reporting","Overview Service"],"summary":"Get fault code counts","description":"Gets fault code counts for selected time range.\n\n**Notes**:\n\n* This is the Beta release of API security reports. See <a href=\"https://docs.apigee.com/release/release-stages\">Release Stages</a>.\n* **Only available for Edge for Cloud Enterprise customers with the Advanced API Ops option.**\n* You can call this API at most six times per minute.","operationId":"overviewFaultCodes","parameters":[{"$ref":"#/components/parameters/org"},{"$ref":"#/components/parameters/from"},{"$ref":"#/components/parameters/to"}],"responses":{"200":{"description":"OK"}}}},"/security/overview/policies":{"get":{"tags":["API Security Reporting","Overview Service"],"summary":"Get policy usage information","description":"Gets information about the policy usage for a given organization and environment.\n\n**Notes**:\n\n* This is the Beta release of API security reports. See <a href=\"https://docs.apigee.com/release/release-stages\">Release Stages</a>.\n* **Only available for Edge for Cloud Enterprise customers with the Advanced API Ops option.**\n* You can call this API at most six times per minute.","operationId":"overviewPolicies","parameters":[{"$ref":"#/components/parameters/org"},{"$ref":"#/components/parameters/env"}],"responses":{"200":{"description":"OK"}}}},"/security/overview/proxies":{"get":{"tags":["API Security Reporting","Overview Service"],"summary":"Retrieves the overall traffic and count of active proxies for a given time range.","description":"Gets the overall traffic and count of active proxies for a given time range.\n\n**Notes**:\n\n* This is the Beta release of API security reports. See <a href=\"https://docs.apigee.com/release/release-stages\">Release Stages</a>.\n* **Only available for Edge for Cloud Enterprise customers with the Advanced API Ops option.**\n* You can call this API at most six times per minute.","operationId":"overviewProxies","parameters":[{"$ref":"#/components/parameters/org"},{"$ref":"#/components/parameters/env"},{"$ref":"#/components/parameters/from"},{"$ref":"#/components/parameters/to"}],"responses":{"200":{"description":"OK"}}}},"/security/overview/traffic/environments":{"get":{"tags":["API Security Reporting","Overview Service"],"summary":"Get traffic by environment","description":"Gets traffic data by environment for a given time range.\n\n**Notes**:\n\n* This is the Beta release of API security reports. See <a href=\"https://docs.apigee.com/release/release-stages\">Release Stages</a>.\n* **Only available for Edge for Cloud Enterprise customers with the Advanced API Ops option.**\n* You can call this API at most six times per minute.","operationId":"overviewTrafficEnvironments","parameters":[{"$ref":"#/components/parameters/org"},{"$ref":"#/components/parameters/from"},{"$ref":"#/components/parameters/to"}],"responses":{"200":{"description":"OK."}}}},"/security/overview/traffic/envbyregion":{"get":{"tags":["API Security Reporting","Overview Service"],"summary":"Get traffic by region and environment","description":"Gets traffic for every region and environment combination.\n\n**Notes**:\n\n* This is the Beta release of API security reports. See <a href=\"https://docs.apigee.com/release/release-stages\">Release Stages</a>.\n* **Only available for Edge for Cloud Enterprise customers with the Advanced API Ops option.**\n* You can call this API at most six times per minute.","operationId":"overviewTrafficEnvbyregion","parameters":[{"$ref":"#/components/parameters/org"},{"$ref":"#/components/parameters/from"},{"$ref":"#/components/parameters/to"}],"responses":{"200":{"description":"OK"}}}},"/security/overview/traffic/resource":{"get":{"tags":["API Security Reporting","Overview Service"],"summary":"Get traffic information grouped by resource","description":"Gets traffic information grouped by a given resource (such as by northbound proxy).\n\n**Notes**:\n\n* This is the Beta release of API security reports. See <a href=\"https://docs.apigee.com/release/release-stages\">Release Stages</a>.\n* **Only available for Edge for Cloud Enterprise customers with the Advanced API Ops option.**\n* You can call this API at most six times per minute.","parameters":[{"$ref":"#/components/parameters/org"},{"$ref":"#/components/parameters/env"},{"$ref":"#/components/parameters/from"},{"$ref":"#/components/parameters/to"},{"$ref":"#/components/parameters/groupBy"},{"$ref":"#/components/parameters/topn"},{"$ref":"#/components/parameters/filters.proxy"},{"$ref":"#/components/parameters/filters.region"},{"$ref":"#/components/parameters/filters.target"},{"$ref":"#/components/parameters/filters.devapp"}],"operationId":"overviewTrafficResource","responses":{"200":{"description":"OK"}}}},"/security/overview/traffic/total":{"get":{"tags":["API Security Reporting","Overview Service"],"summary":"Get total traffic in a time series","description":"Gets total traffic in a time series.\n\n**Notes**:\n\n* This is the Beta release of API security reports. See <a href=\"https://docs.apigee.com/release/release-stages\">Release Stages</a>.\n* **Only available for Edge for Cloud Enterprise customers with the Advanced API Ops option.**\n* You can call this API at most six times per minute.","operationId":"overviewTrafficTotal","parameters":[{"$ref":"#/components/parameters/org"},{"$ref":"#/components/parameters/env"},{"$ref":"#/components/parameters/from"},{"$ref":"#/components/parameters/to"},{"$ref":"#/components/parameters/interval"},{"$ref":"#/components/parameters/filters.proxy"},{"$ref":"#/components/parameters/filters.region"},{"$ref":"#/components/parameters/filters.target"},{"$ref":"#/components/parameters/filters.devapp"}],"responses":{"200":{"description":"OK"}}}},"/security/configuration/flow":{"get":{"tags":["API Security Reporting","Configuration Service"],"summary":"Get information about a shared flow","description":"Gets information about a shared flow.\n\n**Notes**:\n\n* This is the Beta release of API security reports. See <a href=\"https://docs.apigee.com/release/release-stages\">Release Stages</a>.\n* **Only available for Edge for Cloud Enterprise customers with the Advanced API Ops option.**\n* You can call this API at most six times per minute.","operationId":"configurationFlow","parameters":[{"$ref":"#/components/parameters/org"},{"$ref":"#/components/parameters/env"},{"$ref":"#/components/parameters/sharedFlow"}],"responses":{"200":{"description":"OK"}}}},"/security/configuration/sharedflows":{"get":{"tags":["API Security Reporting","Configuration Service"],"summary":"Get information about all shared flows","description":"Gets information about all shared flows deployed in an environment.\n\n**Notes**:\n\n* This is the Beta release of API security reports. See <a href=\"https://docs.apigee.com/release/release-stages\">Release Stages</a>.\n* **Only available for Edge for Cloud Enterprise customers with the Advanced API Ops option.**\n* You can call this API at most six times per minute.","operationId":"configurationFlow","parameters":[{"$ref":"#/components/parameters/org"},{"$ref":"#/components/parameters/env"}],"responses":{"200":{"description":"OK"}}}},"/security/configuration/sharedflows/detail":{"get":{"tags":["API Security Reporting","Configuration Service"],"summary":"Get information about a shared flow revision","description":"Gets information about a shared flow revision.\n\n**Notes**:\n\n* This is the Beta release of API security reports. See <a href=\"https://docs.apigee.com/release/release-stages\">Release Stages</a>.\n* **Only available for Edge for Cloud Enterprise customers with the Advanced API Ops option.**\n* You can call this API at most six times per minute.","operationId":"configurationFlow","parameters":[{"$ref":"#/components/parameters/org"},{"$ref":"#/components/parameters/env"},{"$ref":"#/components/parameters/shared_flow"},{"$ref":"#/components/parameters/revision"}],"responses":{"200":{"description":"OK"}}}},"/security/configuration/proxy":{"get":{"tags":["API Security Reporting","Configuration Service"],"summary":"Get information about deployed proxies","description":"Gets information about the proxies deployed for a given organization and environment.\n\n**Notes**:\n\n* This is the Beta release of API security reports. See <a href=\"https://docs.apigee.com/release/release-stages\">Release Stages</a>.\n* **Only available for Edge for Cloud Enterprise customers with the Advanced API Ops option.**\n* You can call this API at most six times per minute.","operationId":"configurationProxy","parameters":[{"$ref":"#/components/parameters/org"},{"$ref":"#/components/parameters/env"},{"$ref":"#/components/parameters/filters.proxy"},{"$ref":"#/components/parameters/filters.region"},{"$ref":"#/components/parameters/filters.target"},{"$ref":"#/components/parameters/filters.devapp"},{"$ref":"#/components/parameters/sortBy"}],"responses":{"200":{"description":"OK"}}}},"/security/configuration/proxy/flow":{"get":{"tags":["API Security Reporting","Configuration Service"],"summary":"Get information about shared flow connections with an API proxy","description":"Gets information about shared flow connections with an API proxy. Includes both flow callouts and flow hooks.\n\n**Notes**:\n\n* This is the Beta release of API security reports. See <a href=\"https://docs.apigee.com/release/release-stages\">Release Stages</a>.\n* **Only available for Edge for Cloud Enterprise customers with the Advanced API Ops option.**\n* You can call this API at most six times per minute.","operationId":"configurationProxy","parameters":[{"$ref":"#/components/parameters/org"},{"$ref":"#/components/parameters/env"},{"$ref":"#/components/parameters/proxy"}],"responses":{"200":{"description":"OK"}}}},"/security/configuration/proxy/policies":{"get":{"tags":["API Security Reporting","Configuration Service"],"summary":"Get policy information for a proxy","description":"Gets policy information for a proxy.\n\n**Notes**:\n\n* This is the Beta release of API security reports. See <a href=\"https://docs.apigee.com/release/release-stages\">Release Stages</a>.\n* **Only available for Edge for Cloud Enterprise customers with the Advanced API Ops option.**\n* You can call this API at most six times per minute.","operationId":"configurationProxyPolicies","parameters":[{"$ref":"#/components/parameters/org"},{"$ref":"#/components/parameters/env"},{"$ref":"#/components/parameters/proxy"}],"responses":{"200":{"description":"OK"}}}},"/security/configuration/targets":{"get":{"tags":["API Security Reporting","Configuration Service"],"summary":"Get configured API proxy target security information","description":"Gets security information for configured API proxy targets.\n\n**Notes**:\n\n* This is the Beta release of API security reports. See <a href=\"https://docs.apigee.com/release/release-stages\">Release Stages</a>.\n* **Only available for Edge for Cloud Enterprise customers with the Advanced API Ops option.**\n* You can call this API at most six times per minute.","operationId":"configurationProxyPolicies","parameters":[{"$ref":"#/components/parameters/org"},{"$ref":"#/components/parameters/env"},{"$ref":"#/components/parameters/filters.target"}],"responses":{"200":{"description":"OK"}}}},"/security/runtime/proxy":{"get":{"tags":["API Security Reporting","Runtime Service"],"summary":"Get traffic information separated by protocol","description":"Gets traffic information for the various proxies, separated by HTTP versus HTTPS.\n\n\n**Notes**:\n\n* This is the Beta release of API security reports. See <a href=\"https://docs.apigee.com/release/release-stages\">Release Stages</a>.\n* **Only available for Edge for Cloud Enterprise customers with the Advanced API Ops option.**\n* You can call this API at most six times per minute.","operationId":"runtimeProxy","parameters":[{"$ref":"#/components/parameters/org"},{"$ref":"#/components/parameters/env"},{"$ref":"#/components/parameters/from"},{"$ref":"#/components/parameters/to"},{"$ref":"#/components/parameters/filters.proxy"},{"$ref":"#/components/parameters/filters.region"},{"$ref":"#/components/parameters/filters.target"}],"responses":{"200":{"description":"OK"}}}},"/security/runtime/target":{"get":{"tags":["API Security Reporting","Runtime Service"],"summary":"Get target traffic information","description":"Gets information about traffic on various targets.\n\n**Notes**:\n\n* This is the Beta release of API security reports. See <a href=\"https://docs.apigee.com/release/release-stages\">Release Stages</a>.\n* **Only available for Edge for Cloud Enterprise customers with the Advanced API Ops option.**\n* You can call this API at most six times per minute.","operationId":"runtimeTarget","parameters":[{"$ref":"#/components/parameters/org"},{"$ref":"#/components/parameters/env"},{"$ref":"#/components/parameters/from"},{"$ref":"#/components/parameters/to"},{"$ref":"#/components/parameters/filters.proxy"},{"$ref":"#/components/parameters/filters.region"},{"$ref":"#/components/parameters/filters.target"}],"responses":{"200":{"description":"OK"}}}},"/security/runtime/devapp":{"get":{"tags":["API Security Reporting","Runtime Service"],"summary":"Get developer app traffic","description":"Gets traffic data aggregated by developer app in given time range.\n\n\n**Notes**:\n\n* This is the Beta release of API security reports. See <a href=\"https://docs.apigee.com/release/release-stages\">Release Stages</a>.\n* **Only available for Edge for Cloud Enterprise customers with the Advanced API Ops option.**\n* You can call this API at most six times per minute.","operationId":"runtimeDevapp","parameters":[{"$ref":"#/components/parameters/org"},{"$ref":"#/components/parameters/env"},{"$ref":"#/components/parameters/from"},{"$ref":"#/components/parameters/to"}],"responses":{"200":{"description":"OK"}}}},"/security/runtime/devapp/proxy":{"get":{"tags":["API Security Reporting","Runtime Service"],"summary":"Get proxy traffic for developer app","description":"Gets traffic data for every proxy for a developer app and time range.\n\n\n**Notes**:\n\n* This is the Beta release of API security reports. See <a href=\"https://docs.apigee.com/release/release-stages\">Release Stages</a>.\n* **Only available for Edge for Cloud Enterprise customers with the Advanced API Ops option.**\n* You can call this API at most six times per minute.","operationId":"runtimeDevappProxy","parameters":[{"$ref":"#/components/parameters/org"},{"$ref":"#/components/parameters/env"},{"$ref":"#/components/parameters/devapp"},{"$ref":"#/components/parameters/from"},{"$ref":"#/components/parameters/to"}],"responses":{"200":{"description":"OK"}}}},"/security/runtime/faultcode/timeseries":{"get":{"tags":["API Security Reporting","Runtime Service"],"summary":"Get timeseries data for a fault code","description":"Gets the timeseries data for a specific fault code. Use <a href=\"/docs/api-security-reports/1/routes/security/runtime/faultcode/summary/get\">Get fault code summary</a> to obtain the list of fault codes that have occurred for an organization and environment.\n\n\n**Notes**:\n\n* This is the Beta release of API security reports. See <a href=\"https://docs.apigee.com/release/release-stages\">Release Stages</a>.\n* **Only available for Edge for Cloud Enterprise customers with the Advanced API Ops option.**\n* You can call this API at most six times per minute.","operationId":"runtimeFaultcodeTimeseries","parameters":[{"$ref":"#/components/parameters/org"},{"$ref":"#/components/parameters/env"},{"$ref":"#/components/parameters/code"},{"$ref":"#/components/parameters/from"},{"$ref":"#/components/parameters/to"},{"$ref":"#/components/parameters/filters.region"},{"$ref":"#/components/parameters/intervalfs"}],"responses":{"200":{"description":"OK"}}}},"/security/runtime/faultcode/resource":{"get":{"tags":["API Security Reporting","Runtime Service"],"summary":"Get grouped timeseries data for a fault code","description":"Gets the timeseries data for a fault code based on a resource grouping.\n\n\n**Notes**:\n\n* This is the Beta release of API security reports. See <a href=\"https://docs.apigee.com/release/release-stages\">Release Stages</a>.\n* **Only available for Edge for Cloud Enterprise customers with the Advanced API Ops option.**\n* You can call this API at most six times per minute.","operationId":"runtimeFaultcodeResource","parameters":[{"$ref":"#/components/parameters/org"},{"$ref":"#/components/parameters/env"},{"$ref":"#/components/parameters/code"},{"$ref":"#/components/parameters/from"},{"$ref":"#/components/parameters/to"},{"$ref":"#/components/parameters/groupBy"},{"$ref":"#/components/parameters/topN"},{"$ref":"#/components/parameters/filters.region"}],"responses":{"200":{"description":"OK"}}}},"/security/runtime/faultcode/summary":{"get":{"tags":["API Security Reporting","Runtime Service"],"summary":"Get fault code summary","description":"Gets the distribution of errors per fault code for an organization and environment.\n\n\n**Notes**:\n\n* This is the Beta release of API security reports. See <a href=\"https://docs.apigee.com/release/release-stages\">Release Stages</a>.\n* **Only available for Edge for Cloud Enterprise customers with the Advanced API Ops option.**\n* You can call this API at most six times per minute.","operationId":"runtimeFaultcodeResource","parameters":[{"$ref":"#/components/parameters/org"},{"$ref":"#/components/parameters/env"},{"$ref":"#/components/parameters/from"},{"$ref":"#/components/parameters/to"},{"$ref":"#/components/parameters/filters.region"}],"responses":{"200":{"description":"OK"}}}},"/security/runtime/traffic":{"get":{"tags":["API Security Reporting","Runtime Service"],"summary":"Get traffic data","description":"Gets the traffic data for an organization and environment.\n\n\n**Notes**:\n\n* This is the Beta release of API security reports. See <a href=\"https://docs.apigee.com/release/release-stages\">Release Stages</a>.\n* **Only available for Edge for Cloud Enterprise customers with the Advanced API Ops option.**\n* You can call this API at most six times per minute.","operationId":"runtimeTraffic","parameters":[{"$ref":"#/components/parameters/org"},{"$ref":"#/components/parameters/env"},{"$ref":"#/components/parameters/from"},{"$ref":"#/components/parameters/to"},{"$ref":"#/components/parameters/proxy.names"},{"$ref":"#/components/parameters/region"}],"responses":{"200":{"description":"OK"}}}},"/security/users/summary":{"get":{"tags":["API Security Reporting","Runtime Service"],"summary":"Get all user activity","description":"Gets aggregated user activity information for all users in an organization for specified time range.\n\n\n**Notes**:\n\n* This is the Beta release of API security reports. See <a href=\"https://docs.apigee.com/release/release-stages\">Release Stages</a>.\n* **Only available for Edge for Cloud Enterprise customers with the Advanced API Ops option.**\n* You can call this API at most six times per minute.","operationId":"userSummary","parameters":[{"$ref":"#/components/parameters/org"},{"$ref":"#/components/parameters/from"},{"$ref":"#/components/parameters/to"}],"responses":{"200":{"description":"OK"}}}},"/security/users/activity":{"get":{"tags":["API Security Reporting","Runtime Service"],"summary":"Get user activity","description":"Gets user activity details for a given user in specified time range.\n\n\n**Notes**:\n\n* This is the Beta release of API security reports. See <a href=\"https://docs.apigee.com/release/release-stages\">Release Stages</a>.\n* **Only available for Edge for Cloud Enterprise customers with the Advanced API Ops option.**\n* You can call this API at most six times per minute.\n\n**Returning results in pages**\n\nBy default, this API returns all activity details in a single `logs` array as part of the response object. Because there can be a large number of entries in the `logs` array, you can configure the API to return the results as a collection of pages. For example:\n\n* On the first call, return the first 25 results in the `logs` array. This response contains the first results page.\n* On the second call, return the next 25 results. This response contains the second results page.\n* Continue until you have returned all entries in the `logs` array.\n\nTo configure the API to return results as a collection of pages:\n\n\nOn the first call, pass the `page.size` query parameter specifying the number of results to return per page.\n\n\n ```\n\n https://apisecurity.enterprise.apigee.com/security/users/activity?org={org}&from={start}&to={end}&email={email}&page.size=25\n\n ```\n\n\n The response object contains the `page.nextPageToken` property that identifies the second page of results:\n\n\n ```\n\n \"page\": {\n \"current\": 0,\n \"total\": 0,\n \"nextPageToken\": \"TOKEN\"\n },\n\n ```\n\n\n Note that `current` and `total` are always set to 0.\n\n\nOn the second API request, pass the `TOKEN` as the value of the `page.pageToken` query parameter to obtain the second page of results.\n\n\n\n ```\n\n https://apisecurity.enterprise.apigee.com/security/users/activity?org={org}&from={start}&to={end}&email={email}&page.size=25&page.pageToken=TOKEN\n\n ```\n\n\n The second page of results contains a new `TOKEN` value that identifies the third page.\n\n\n Pass the new `TOKEN` to the API to obtain the third page of results.\n\n\nRepeat these steps until you have received all the results.","operationId":"usersActivity","parameters":[{"$ref":"#/components/parameters/org"},{"$ref":"#/components/parameters/email"},{"$ref":"#/components/parameters/from"},{"$ref":"#/components/parameters/to"},{"$ref":"#/components/parameters/log.type"},{"$ref":"#/components/parameters/page.size"},{"$ref":"#/components/parameters/page.pageToken"}],"responses":{"200":{"description":"OK"}}}}},"components":{"securitySchemes":{"OAuth":{"type":"apiKey","name":"Authorization","in":"header","description":"For OAuth, enter the following in the Key field: Bearer %your-token%"}},"parameters":{"org":{"in":"query","name":"org","required":true,"schema":{"type":"string"},"description":"Name of the organization."},"env":{"in":"query","name":"env","required":true,"schema":{"type":"string"},"description":"Name of the environment."},"proxy":{"in":"query","name":"proxy","required":true,"schema":{"type":"string"},"description":"Name of the API proxy."},"code":{"in":"query","name":"code","required":true,"schema":{"type":"string"},"description":"Fault code."},"devapp":{"in":"query","name":"devapp","required":true,"schema":{"type":"string"},"description":"Name of the developer app."},"shared_flow":{"in":"query","name":"shared_flow","required":true,"schema":{"type":"string"},"description":"Name of the shared flow."},"sharedFlow":{"in":"query","name":"sharedFlow","required":true,"schema":{"type":"string"},"description":"Name of the shared flow."},"from":{"name":"from","in":"query","description":"Start of the time period to analyze, inclusive. Specify the time in the ISO format: `yyyy-mm-ddThh:mm:ssZ`. For example: `2018-07-29T00:13:00Z`.","required":true,"schema":{"type":"string"}},"to":{"name":"to","in":"query","description":"End of the time period to analyze, exclusive. Specify the time in the ISO format: `yyyy-mm-ddThh:mm:ssZ`. For example: `2018-07-29T00:13:00Z`.","required":true,"schema":{"type":"string"}},"groupBy":{"name":"groupBy","in":"query","description":"When getting the traffic information grouped by a given resource, set this value to one of the following:\n\n* `NORTHBOUND_PROXY`: Traffic from clients to a proxy.\n* `SOUTHBOUND_TARGET`: Traffic from a proxy to a target.\n* `REGION`: Traffic by region.\n* `DEV_APP`: Traffic by developer application.\n* `VHOST`: Traffic by virtual host.\n\nWhen getting the timeseries data for a fault code based on a resource grouping, set this value to `PROXY`.","required":true,"schema":{"type":"string"}},"sortBy":{"name":"sortBy","in":"query","description":"One of the following values:\n\n* `TRAFFIC_ASC`: Sort by ascending traffic totals.\n* `TRAFFIC_DESC`: Sort by descending traffic totals.\n* `LAST_MODIFIED`: Sort by last modified date.\n* `PROXY`: Sort by proxy name.\n* `TRAFFIC_MANAGEMENT`: Sort by traffic management policy inclusion.\n* `SECURITY`: Sort by security policy inclusion.\n* `EXTENSIONS`: Sort by extensions policy inclusion.\n* `VHOST_DEFAULT`: Sort by whether the default vhost is enabled.\n* `VHOST_SECURE`:Sort by whether a secure vhost is enabled.","required":true,"schema":{"type":"string","default":"TRAFFIC_ASC","enum":["TRAFFIC_ASC","TRAFFIC_DESC","LAST_MODIFIED","PROXY","TRAFFIC_MANAGEMENT","SECURITY","EXTENSIONS","VHOST_DEFAULT","VHOST_SECURE"]}},"topn":{"name":"topn","in":"query","description":"Number of values from the top, sorted by HTTP requests.","schema":{"type":"integer","format":"int64","default":3}},"topN":{"name":"topN","in":"query","description":"Number of results to return.","schema":{"type":"integer","format":"int64","default":3}},"interval":{"name":"interval","in":"query","description":"The size of the buckets that the data comes back in, in minutes.","schema":{"type":"integer","format":"int64","default":60}},"intervalfs":{"name":"interval","in":"query","description":"Specifies the time interval, in minutes, used to group the fault code data. By default, the value is set to 5 minutes so that the fault code data is grouped by 5 minute intervals. The minimum interval is 1 minute.","schema":{"type":"integer","format":"int64","default":60}},"filters.proxy":{"name":"filters.proxy","in":"query","description":"Proxy to filter results by.","schema":{"type":"string"}},"filters.region":{"name":"filters.region","in":"query","description":"Region to filter results by.","schema":{"type":"string"}},"filters.target":{"name":"filters.target","in":"query","description":"Target server to filter results by.","schema":{"type":"string"}},"filters.devapp":{"name":"filters.devapp","in":"query","description":"Developer app to filter results by. Use the following structure: <code><i>appname</i>(<i>appId</i>)</code>. To get a list of app IDs, see <a href=\"/docs/developer-apps/1/routes/organizations/%7Borg_name%7D/developers/%7Bdeveloper_email%7D/apps/get\">List all apps</a> and use the `expand=true` query parameter.","schema":{"type":"string"}},"proxy.names":{"name":"proxy.names","in":"query","description":"Name of an API proxy. If omitted, this API returns traffic data for all proxies in the organization and environment.","schema":{"type":"string"}},"region":{"name":"region","in":"query","description":"Region to filter results by.","schema":{"type":"string"}},"revision":{"name":"revision","in":"query","description":"Shared flow revision.","schema":{"type":"string"}},"log.type":{"name":"log.type","in":"query","description":"Type of log activity to return. Valid values include: `ALL` (default), `UI`, and `API`.","schema":{"type":"string"}},"page.size":{"name":"page.size","in":"query","description":"Number of results to return per page of results. The maximum value is 5000.\n\nTo obtain the first page of results, specify only the `page.size` query parameter. Each page of results contains the `nextPageToken` property. Pass the value of `nextPageToken` on each subsequent request.","schema":{"type":"integer"}},"page.pageToken":{"name":"page.size","in":"query","description":"Page of results to return.\n\nTo obtain the first page of results, specify only the `page.size` query parameter. The result object of the first page of results contains the `nextPageToken` property. Pass the value of `nextPageToken` on the second request to return the second page of results.\n\nEach results object contains a new value for `nextPageToken` that identifies the next page of the results to return.","schema":{"type":"integer"}},"email":{"name":"email","in":"query","description":"Email address of the user.","schema":{"type":"string"}}}}}
/ security / overview / faultcode
/ security / overview / policies
/ security / overview / proxies
/ security / overview / traffic / environments
/ security / overview / traffic / envbyregion
/ security / overview / traffic / resource
/ security / overview / traffic / total
/ security / configuration / flow
/ security / configuration / sharedflows
/ security / configuration / sharedflows / detail
/ security / configuration / proxy
/ security / configuration / proxy / flow
/ security / configuration / proxy / policies
/ security / configuration / targets
/ security / runtime / proxy
/ security / runtime / target
/ security / runtime / devapp
/ security / runtime / devapp / proxy
/ security / runtime / faultcode / timeseries
/ security / runtime / faultcode / resource
/ security / runtime / faultcode / summary
/ security / runtime / traffic
/ security / users / summary
/ security / users / activity
Deployments OpenAPI	{"openapi":"3.0.0","servers":[{"url":"https://api.enterprise.apigee.com/v1"}],"info":{"title":"Deployments","description":"Manage API proxy and shared flow deployments.","version":"1.0"},"security":[{"Basic":[]},{"OAuth":[]}],"paths":{"/organizations/{org_name}/apis/{api_name}/deployments":{"get":{"tags":["Deployments","API Proxy"],"summary":"Get API proxy deployment details","description":"Gets details for all deployments of the API proxy across all environments (test, prod, and so on).","operationId":"getAPIProxyDeploymentDetails","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/api_name"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeploymentDetails"},"example":{"environment":[{"name":"test","revision":[{"configuration":{"basePath":"/","steps":[]},"name":"1","server":[],"state":"deployed"}]}],"name":"hotels","organization":"myorg"}}}},"400":{"description":"Bad request"}}}},"/organizations/{org_name}/sharedflows/{sharedflow_name}/deployments":{"get":{"tags":["Deployments","Shared Flows"],"summary":"Get shared flow deployment details","description":"Gets details for all deployments of the shared flows across all environments (test, prod, and so on).","operationId":"getSharedFlowDeploymentDetails","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/sharedflow_name"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeploymentDetails"},"example":{"environment":[{"name":"test","revision":[{"configuration":{"basePath":"/","steps":[]},"name":"1","server":[],"state":"deployed"}]}],"name":"mySharedFlow","organization":"myorg"}}}},"400":{"description":"Bad request"}}}},"/organizations/{org_name}/apis/{api_name}/revisions/{revision_number}/deployments":{"post":{"tags":["Deployments"],"summary":"Force undeployment of API proxy","description":"Forces the undeployment of an API proxy. This may be necessary if the API proxy is partially deployed and you need to undeploy and then redeploy it.\n\nBecause multiple revisions of the same API proxy can be deployed in the same environment if the base paths are different, you must specify the revision number of the API proxy.\n\nSee also <a href=\"/docs/deployments/1/routes/organizations/%7Borg_name%7D/environments/%7Benv_name%7D/apis/%7Bapi_name%7D/revisions/%7Brevision_number%7D/deployments/delete\">Undeploy an API proxy revision</a>.","operationId":"forceAPIProxyUndeploy","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/api_name"},{"$ref":"#/components/parameters/revision_number"},{"$ref":"#/components/parameters/action"},{"$ref":"#/components/parameters/env"},{"$ref":"#/components/parameters/force"},{"$ref":"#/components/parameters/content-type"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIProxyRevisionDeploymentDetailsEnv"},"example":{"aPIProxy":"restaurantproxy","configuration":{"basePath":"/","steps":[]},"environment":"test","name":"1","organization":"myorg","revision":"1","server":[],"state":"deployed"}}}},"400":{"description":"Bad request"}}},"get":{"tags":["Deployments"],"summary":"Get API proxy revision deployments","description":"Gets deployment details for a specific revision of an API proxy.\n\n**Note:** On Edge for Private Cloud, you can troubleshoot deployment status on a router or message processor (MP) by noting its ID and checking your server logs. You may need to restart the router or MP that has the deployment issue.","operationId":"getAPIProxyRevisionDeployments","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/api_name"},{"$ref":"#/components/parameters/revision_number"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIProxyRevisionDeployments"},"example":{"aPIProxy":"hotels","environment":[{"configuration":{"basePath":"/","steps":[]},"name":"test","server":[],"state":"deployed"}],"name":"1","organization":"myorg"}}}},"400":{"description":"Bad request"}}}},"/organizations/{org_name}/deployments":{"get":{"tags":["Deployments"],"summary":"Get all API proxy deployments for all environments in an organization","description":"Lists all API proxies that are deployed for all environments in an organization.","operationId":"getDeployments","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/includeServerStatus"},{"$ref":"#/components/parameters/includeApiConfig"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIProxyDeploymentsOrg"},"example":{"environment":[{"aPIProxy":[{"name":"weather","revision":[{"configuration":{"basePath":"/","steps":[]},"name":"5","server":[],"state":"deployed"}]}]},{"aPIProxy":[{"name":"hotels","revision":[{"configuration":{"basePath":"/","steps":[]},"name":"1","server":[],"state":"deployed"}]}],"name":"test"}],"name":"myorg"}}}},"400":{"description":"Bad request"}}}},"/organizations/{org_name}/environments/{env_name}/apis/{api_name}/revisions/{revision_number}/deployments":{"post":{"tags":["Deployments"],"summary":"Deploy API proxy","description":"Deploys a revision of an API proxy to an environment in an organization.\n\nFor seamless deployment with zero downtime, set the `override` parameter to `true`. In this case, the new revision is deployed fully before the existing revision is undeployed. If the deployment of the new revision fails, the existing revision remains deployed. See <a href=\"https://docs.apigee.com/api-platform/deploy/deploy-api-proxies-using-management-api#seamless\">Seamless deployment (zero downtime)</a>.\n\nYou cannot invoke an API proxy until it has been deployed to an environment. After an API proxy revision is deployed, it cannot be edited. The size limit of an API proxy bundle is 15 MB.\n\n**About API proxies that use shared flows**\n\nApigee Edge does not validate the dependencies between <a href=\"https://docs.apigee.com/api-platform/fundamentals/shared-flows\">shared flows</a> and API proxies at deployment time. For example, if the <a href=\"https://docs.apigee.com/api-platform/reference/policies/flow-callout-policy\">Flow Callout policy</a> in an API proxy references a shared flow that either doesn't exist or isn't deployed, the API proxy deployment still succeeds. At runtime, when Edge checks the dependency if validation fails Edge throws an API proxy error with a 500 HTTP status code.","operationId":"deployAPIProxy","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/env_name"},{"$ref":"#/components/parameters/api_name"},{"$ref":"#/components/parameters/revision_number"},{"$ref":"#/components/parameters/delay"},{"$ref":"#/components/parameters/override"},{"$ref":"#/components/parameters/content-type"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIProxyRevisionDeploymentDetailsEnv"},"example":{"aPIProxy":"restaurantproxy","configuration":{"basePath":"/","steps":[]},"environment":"test","name":"1","organization":"myorg","revision":"1","server":[],"state":"deployed"}}}},"400":{"description":"Bad request"}}},"get":{"tags":["Deployments"],"summary":"Get deployment details for an API proxy revision in an environment","description":"Gets deployment details for a specific revision of an API proxy.\n\n**Note**: On Edge for Private Cloud, you can troubleshoot deployment status on a router or message processor by noting the router or message processor ID and checking your server logs. You may need to restart the router or message processor that has a deployment issue.","operationId":"getAPIProxyRevisionDeploymentsEnv","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/env_name"},{"$ref":"#/components/parameters/api_name"},{"$ref":"#/components/parameters/revision_number"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIProxyRevisionDeploymentDetailsEnv"},"example":{"aPIProxy":"restaurantproxy","configuration":{"basePath":"/","steps":[]},"environment":"test","name":"1","organization":"myorg","revision":"1","server":[],"state":"deployed"}}}},"400":{"description":"Bad request"}}},"delete":{"tags":["Deployments"],"summary":"Undeploy an API proxy revision in an environment","description":"Undeploys an API proxy revision from an environment.\n\nBecause multiple revisions of the same API proxy can be deployed in the same environment if the base paths are different, you must specify the revision number of the API proxy.\n\nSee also <a href=\"/docs/deployments/1/routes/organizations/%7Borg_name%7D/apis/%7Bapi_name%7D/revisions/%7Brevision_number%7D/deployments/post\">Force undeployment of an API proxy</a> to force the undeployment of an API proxy.","operationId":"deleteAPIProxyRevisionDeploymentsEnv","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/env_name"},{"$ref":"#/components/parameters/api_name"},{"$ref":"#/components/parameters/revision_number"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIProxyRevisionDeploymentDetailsEnv"},"example":{"aPIProxy":"restaurantproxy","configuration":{"basePath":"/","steps":[]},"environment":"test","name":"1","organization":"myorg","revision":"1","server":[],"state":"deployed"}}}},"400":{"description":"Bad request"}}}},"/organizations/{org_name}/environments/{env_name}/sharedflows/{sharedflow_name}/revisions/{revision_number}/deployments":{"post":{"tags":["Deployments","Shared Flows"],"summary":"Deploy shared flow","description":"Deploys a revision of a shared flow to an environment in an organization.\n\nFor seamless deployment with zero downtime, set the `override` parameter to `true`. In this case, the new revision is deployed fully before the existing revision is undeployed. If the deployment of the new revision fails, the existing revision remains deployed. See <a href=\"https://docs.apigee.com/api-platform/deploy/deploy-api-proxies-using-management-api#seamless\">Seamless deployment (zero downtime)</a>.\n\nIf you experience HTTP 500 errors during deployment, consider using the `override` parameter to deploy the shared flow in place of a revision currently deployed.\n\nThe size limit of a shared flow bundle is 15 MBs.","operationId":"deploySharedFlow","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/env_name"},{"$ref":"#/components/parameters/sharedflow_name"},{"$ref":"#/components/parameters/revision_number"},{"$ref":"#/components/parameters/delay"},{"$ref":"#/components/parameters/override"},{"$ref":"#/components/parameters/content-type"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SharedFlowRevisionDeploymentDetails"},"example":{"environment":"test","name":"1","organization":"myorg","revision":"1","server":[],"sharedFlow":"mySharedFlow","state":"deployed"}}}},"400":{"description":"Bad request"}}},"get":{"tags":["Deployments","Shared Flows"],"summary":"Get deployment details for a shared flow revision in an environment","description":"Gets deployment details for a specific revision of a shared flow.\n\n**Note**: On Edge for Private Cloud, you can troubleshoot deployment status on a router or message processor by noting the router or message processor ID and checking your server logs. You may need to restart the router or message processor that has a deployment issue.","operationId":"getSharedFlowRevisionDeploymentsEnv","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/env_name"},{"$ref":"#/components/parameters/sharedflow_name"},{"$ref":"#/components/parameters/revision_number"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SharedFlowRevisionDeploymentDetails"},"example":{"environment":"test","name":"1","organization":"myorg","revision":"1","server":[],"sharedFlow":"mySharedFlow","state":"deployed"}}}},"400":{"description":"Bad request"}}},"delete":{"tags":["Deployments","Shared Flows"],"summary":"Undeploy a shared flow revision in an environment","description":"Undeploys a shared flow revision from an environment.\n\nBecause multiple revisions of the same shared flow can be deployed in the same environment if the base paths are different, you must specify the revision number of the shared flow.","operationId":"deleteSharedFlowRevisionDeploymentsEnv","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/env_name"},{"$ref":"#/components/parameters/sharedflow_name"},{"$ref":"#/components/parameters/revision_number"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SharedFlowRevisionDeploymentDetails"},"example":{"environment":"test","name":"1","organization":"myorg","revision":"1","server":[],"sharedFlow":"mySharedFlow","state":"undeployed"}}}},"400":{"description":"Bad request"}}}},"/organizations/{org_name}/environments/{env_name}/apis/{api_name}/deployments":{"get":{"tags":["Environment","API Proxy","Deployment"],"summary":"Get deployment details for an API proxy in an environment","description":"Gets deployment details for an API proxy in an environment.","operationId":"getAPIProxyDeploymentEnv","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/env_name"},{"$ref":"#/components/parameters/api_name"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIProxyDeploymentDetailsEnv"},"example":{"environment":"test","name":"hotels","organization":"myorg","revision":[{"configuration":{"basePath":"/","steps":[]},"name":"1","server":[],"state":"deployed"}]}}}},"400":{"description":"Bad request"}}}},"/organizations/{org_name}/environments/{env_name}/deployments":{"get":{"tags":["Environment","API Proxy","Deployment"],"summary":"Get API proxy deployments for an environment","description":"Lists all API proxies that are deployed to the specified environment.\nThe `server` information is used by Apigee support to identify servers that support the API proxy deployment.","operationId":"getAPIProxyDeploymentsEnv","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/env_name"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIProxyDeploymentsEnv"},"example":{"aPIProxy":[{"name":"hotels","revision":[{"configuration":{"basePath":"/","steps":[]},"name":"1","server":[],"state":"deployed"}]}],"name":"test","organization":"myorg"}}}},"400":{"description":"Bad request"}}}}},"components":{"securitySchemes":{"Basic":{"type":"http","scheme":"basic","description":"Multi-factor authentication is not supported."},"OAuth":{"type":"apiKey","name":"Authorization","in":"header","description":"For OAuth, enter the following in the Key field: Bearer %your-token% (see https://docs.apigee.com/api-platform/system-administration/using-oauth2#get-the-tokens)"}},"parameters":{"org_name":{"in":"path","name":"org_name","required":true,"schema":{"type":"string"},"description":"Organization name."},"env_name":{"in":"path","name":"env_name","required":true,"schema":{"type":"string"},"description":"Environment name."},"api_name":{"in":"path","name":"api_name","required":true,"schema":{"type":"string"},"description":"API proxy name."},"sharedflow_name":{"in":"path","name":"sharedflow_name","required":true,"schema":{"type":"string"},"description":"Shared flow name."},"revision_number":{"in":"path","name":"revision_number","required":true,"schema":{"type":"string"},"description":"Revision number."},"delay":{"in":"query","name":"delay","required":false,"schema":{"type":"number"},"description":"Time interval, in seconds, to wait before undeploying the currently deployed API proxy revision. Use this setting in conjunction with `override` parameter to minimize the impact of deployment on in-flight transactions and the occurrence of 502 Bad Gateway or 504 Gateway Timeout errors. Negative values are treated as 0."},"override":{"in":"query","name":"override","required":false,"schema":{"type":"boolean"},"description":"Flag that specifies whether to force the deployment of the new revision over the currently deployed revision. Set this parameter to `true` to provide seamless deployment. In this case, the existing revision remains deployed until the new revision is fully deployed. Use in conjunction with the `delay` parameter to control undeployment and minimize the impact on in-flight transaction. If set to `false`, you must undeploy the currently deployed revision before deploying the new revision."},"includeServerStatus":{"in":"query","name":"includeServerStatus","required":false,"schema":{"type":"boolean"},"description":"Flag that specifies whether to include server information. The `server` information is used by Apigee support to identify servers that support the API proxy deployment. Set this value to `false` to omit server information. Defaults to `true`."},"includeApiConfig":{"in":"query","name":"includeApiConfig","required":false,"schema":{"type":"boolean"},"description":"Flag that specifies whether to include configuration information. Set this value to `false` to omit configuration information. Defaults to `true`."},"action":{"in":"query","name":"action","required":true,"schema":{"type":"string"},"description":"Set to `undeploy`."},"env":{"in":"query","name":"env","required":true,"schema":{"type":"string"},"description":"Environment in which the API proxy is deployed."},"force":{"in":"query","name":"force","required":true,"schema":{"type":"boolean"},"description":"Set to `true` to force undeployment. Defaults to `false`."},"content-type":{"in":"header","name":"Content-type","required":true,"schema":{"type":"string"},"description":"Must be set to `application/x-www-form-urlencoded`."}},"schemas":{"APIProxyDeployments":{"description":"API proxy deployments.","type":"object","properties":{"environment":{"description":"Environment details.","type":"array","items":{"type":"string"}},"name":{"description":"Name of the API proxy.","type":"string"},"organization":{"description":"Name of the organization.","type":"string"}}},"APIProxyRevisionDeployments":{"description":"API proxy revision deployments.","type":"object","properties":{"aPIProxy":{"description":"Name of the API proxy"},"environment":{"description":"API proxy deployment details in the environment.","type":"array","items":{"type":"object","properties":{"configuration":{"type":"object","properties":{"basePath":{"type":"string","description":"Basepath of the API proxy revision."},"steps":{"type":"array","items":{"type":"string"}}}},"name":{"type":"string","description":"Revision of the API proxy."},"server":{"type":"array","description":"Used by Apigee support to identify servers that support the API proxy or shared flow deployment.","items":{"type":"object","properties":{"pod":{"type":"object","description":"Pod details.","properties":{"name":{"type":"string","description":"Pod name."},"region":{"type":"string","description":"Pod region."}}},"status":{"type":"string","description":"Deployment status."},"type":{"type":"array","description":"Pod type.","items":{"type":"string"}},"uUID":{"type":"string","description":"Server ID."}}}},"state":{"type":"string","description":"Deployment status, such as `deployed`."}}}},"name":{"description":"Revision of the API proxy.","type":"string"},"organization":{"description":"Name of the organization.","type":"string"}}},"DeploymentDetails":{"description":"API proxy or shared flow deployment details.","type":"object","properties":{"environment":{"description":"API proxy or shared flow deployment details in the environment.","type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Name of the environment."},"revision":{"type":"array","description":"Revision details.","items":{"type":"object","properties":{"configuration":{"type":"object","properties":{"basePath":{"type":"string","description":"Basepath of the API proxy or shared flow revision."},"steps":{"type":"array","items":{"type":"string"}}}},"name":{"type":"string","description":"Revision of the API proxy or shared flow."},"server":{"type":"array","description":"Used by Apigee support to identify servers that support the API proxy or shared flow deployment.","items":{"type":"object","properties":{"pod":{"type":"object","description":"Pod details.","properties":{"name":{"type":"string","description":"Pod name."},"region":{"type":"string","description":"Pod region."}}},"status":{"type":"string","description":"Deployment status."},"type":{"type":"array","description":"Pod type.","items":{"type":"string"}},"uUID":{"type":"string","description":"Server ID."}}}},"state":{"type":"string","description":"Deployment status, such as `deployed`."}}}}}}},"name":{"description":"Name of the API proxy or shared flow.","type":"string"},"organization":{"description":"Name of the organization.","type":"string"}}},"APIProxyDeploymentDetailsEnv":{"description":"API proxy deployment details in an environment.","type":"object","properties":{"environment":{"description":"Name of the environment.","type":"string"},"revision":{"type":"array","description":"Revision details.","items":{"type":"object","properties":{"configuration":{"type":"object","properties":{"basePath":{"type":"string","description":"Basepath of the API proxy revision."},"steps":{"type":"array","items":{"type":"string"}}}},"name":{"type":"string","description":"Revision of the API proxy."},"server":{"type":"array","description":"Used by Apigee support to identify servers that support the API proxy or shared flow deployment.","items":{"type":"object","properties":{"pod":{"type":"object","description":"Pod details.","properties":{"name":{"type":"string","description":"Pod name."},"region":{"type":"string","description":"Pod region."}}},"status":{"type":"string","description":"Deployment status."},"type":{"type":"array","description":"Pod type.","items":{"type":"string"}},"uUID":{"type":"string","description":"Server ID."}}}},"state":{"type":"string","description":"Deployment status, such as `deployed`."}}}},"name":{"description":"Name of the API proxy.","type":"string"},"organization":{"description":"Name of the organization.","type":"string"}}},"APIProxyRevisionDeploymentDetails":{"description":"API proxy revision deployment details in an environment.","type":"object","properties":{"environment":{"description":"API proxy revision deployment details in the environment.","type":"array","items":{"type":"object","properties":{"configuration":{"type":"object","properties":{"basePath":{"type":"string","description":"Basepath of the API proxy revision."},"steps":{"type":"array","items":{"type":"string"}}}},"name":{"type":"string","description":"Revision of the API proxy."},"server":{"type":"array","description":"Used by Apigee support to identify servers that support the API proxy or shared flow deployment.","items":{"type":"object","properties":{"pod":{"type":"object","description":"Pod details.","properties":{"name":{"type":"string","description":"Pod name."},"region":{"type":"string","description":"Pod region."}}},"status":{"type":"string","description":"Deployment status."},"type":{"type":"array","description":"Pod type.","items":{"type":"string"}},"uUID":{"type":"string","description":"Server ID."}}}},"state":{"type":"string","description":"Deployment status, such as `deployed` or `undeployed`."}}}},"name":{"description":"Name of the API proxy.","type":"string"},"organization":{"description":"Name of the organization.","type":"string"}}},"APIProxyRevisionDeploymentDetailsEnv":{"description":"API proxy revision deployment details in an environment.","type":"object","properties":{"aPIProxy":{"type":"string","description":"Name of the API proxy."},"configuration":{"type":"object","properties":{"basePath":{"type":"string","description":"Basepath of the API proxy revision."},"steps":{"type":"array","items":{"type":"string"}}}},"environment":{"type":"string","description":"Name of the environment."},"name":{"type":"string","description":"Revision of the API proxy."},"organization":{"type":"string","description":"Name of the organization."},"revision":{"type":"string","description":"Revision of the API proxy."},"server":{"type":"array","description":"Used by Apigee support to identify servers that support the API proxy or shared flow deployment.","items":{"type":"object","properties":{"pod":{"type":"object","description":"Pod details.","properties":{"name":{"type":"string","description":"Pod name."},"region":{"type":"string","description":"Pod region."}}},"status":{"type":"string","description":"Deployment status."},"type":{"type":"array","description":"Pod type.","items":{"type":"string"}},"uUID":{"type":"string","description":"Server ID."}}}},"state":{"type":"string","description":"Deployment status, such as `deployed` or `undeployed`."}}},"SharedFlowRevisionDeploymentDetails":{"description":"Shared flow revision deployment details in an environment.","type":"object","properties":{"environment":{"type":"string","description":"Name of the environment."},"name":{"type":"string","description":"Revision of the shared flow."},"organization":{"type":"string","description":"Name of the organization."},"revision":{"type":"string","description":"Revision of the shared flow."},"server":{"type":"array","description":"Used by Apigee support to identify servers that support the API proxy or shared flow deployment.","items":{"type":"object","properties":{"pod":{"type":"object","description":"Pod details.","properties":{"name":{"type":"string","description":"Pod name."},"region":{"type":"string","description":"Pod region."}}},"status":{"type":"string","description":"Deployment status."},"type":{"type":"array","description":"Pod type.","items":{"type":"string"}},"uUID":{"type":"string","description":"Server ID."}}}},"sharedFlow":{"type":"string","description":"Name of the shared flow."},"state":{"type":"string","description":"Deployment status, such as `deployed` or `undeployed`."}}},"SharedFlowRevisionDeploymentDetailsEnv":{"description":"Shared flow revision deployed environment details.","type":"object","properties":{"environment":{"type":"array","description":"Environment details.","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment name."},"server":{"type":"array","description":"Used by Apigee support to identify servers that support the API proxy or shared flow deployment.","items":{"type":"object","properties":{"pod":{"type":"object","description":"Pod details.","properties":{"name":{"type":"string","description":"Pod name."},"region":{"type":"string","description":"Pod region."}}},"status":{"type":"string","description":"Deployment status."},"type":{"type":"array","description":"Pod type.","items":{"type":"string"}},"uUID":{"type":"string","description":"Server ID."}}}},"state":{"type":"string","description":"Deployment status, such as `deployed` or `undeployed`."}}}},"name":{"type":"string","description":"Revision of the shared flow."},"organization":{"type":"string","description":"Name of the organization."},"sharedFlow":{"type":"string","description":"Name of the shared flow."}}},"APIProxyDeploymentsEnv":{"description":"API proxy deployments in an environment.","type":"object","properties":{"aPIProxy":{"description":"API proxy name and revision details.","type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Name of the API proxy."},"revision":{"type":"array","description":"Revision details.","items":{"type":"object","properties":{"configuration":{"type":"object","properties":{"basePath":{"type":"string","description":"Basepath of the API proxy revision."},"steps":{"type":"array","items":{"type":"string"}}}},"name":{"type":"string","description":"Revision of the API proxy."},"server":{"type":"array","description":"Used by Apigee support to identify servers that support the API proxy or shared flow deployment.","items":{"type":"object","properties":{"pod":{"type":"object","description":"Pod details.","properties":{"name":{"type":"string","description":"Pod name."},"region":{"type":"string","description":"Pod region."}}},"status":{"type":"string","description":"Deployment status."},"type":{"type":"array","description":"Pod type.","items":{"type":"string"}},"uUID":{"type":"string","description":"Server ID."}}}},"state":{"type":"string","description":"Deployment status, such as `deployed` or `undeployed`."}}}}}}},"name":{"description":"Name of the API proxy.","type":"string"},"organization":{"description":"Name of the organization.","type":"string"}}},"APIProxyDeploymentsOrg":{"description":"API proxy deployment details for an organization.","type":"object","properties":{"environment":{"description":"Name of the environment.","type":"array","items":{"type":"object","properties":{"aPIProxy":{"description":"API proxy name and revision details.","type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Name of the API proxy."},"revision":{"type":"array","description":"Revision details.","items":{"type":"object","properties":{"configuration":{"type":"object","properties":{"basePath":{"type":"string","description":"Basepath of the API proxy revision."},"steps":{"type":"array","items":{"type":"string"}}}},"name":{"type":"string","description":"Revision of the API proxy."},"server":{"type":"array","description":"Used by Apigee support to identify servers that support the API proxy or shared flow deployment.","items":{"type":"object","properties":{"pod":{"type":"object","description":"Pod details.","properties":{"name":{"type":"string","description":"Pod name."},"region":{"type":"string","description":"Pod region."}}},"status":{"type":"string","description":"Deployment status."},"type":{"type":"array","description":"Pod type.","items":{"type":"string"}},"uUID":{"type":"string","description":"Server ID."}}}},"state":{"type":"string","description":"Deployment status, such as `deployed` or `undeployed`."}}}}}}},"name":{"type":"string","description":"Name of the environment."}}}},"name":{"type":"string","description":"Name of the organization."}}}}}}
/ organizations / {org_name} / apis / {api_name} / deployments
/ organizations / {org_name} / sharedflows / {sharedflow_name} / deployments
/ organizations / {org_name} / apis / {api_name} / revisions / {revision_number} / deployments
/ organizations / {org_name} / deployments
/ organizations / {org_name} / environments / {env_name} / apis / {api_name} / revisions / {revision_number} / deployments
/ organizations / {org_name} / environments / {env_name} / sharedflows / {sharedflow_name} / revisions / {revision_number} / deployments
/ organizations / {org_name} / environments / {env_name} / apis / {api_name} / deployments
/ organizations / {org_name} / environments / {env_name} / deployments
Company Developers API OpenAPI	{"openapi":"3.0.0","servers":[{"url":"https://api.enterprise.apigee.com/v1"}],"info":{"title":"Company Developers API","description":"Associate developers with a company. \nThe company developer creates apps on behalf of the company. Any apps created by a company developer are associated with the company and known as \"company apps.\" A developer must exist before you can associate them with a company.\n\nWhen you add a developer to a company, you specify the developer's email and assign the developer a role. Company developer roles are enforced by the client app that you build using the API, not by Apigee. Therefore, when you retrieve a list of company apps on behalf of a developer, it is your code that checks the developer's role and displays the capabilities appropriate for that role. You typically create an admin role to allow a company developer to add other developers, delete company apps, and so on. Company developers are mapped to developers in your organization using the developer email as a key. The mapping associates the developer with the company and adds a role. The company developer entity simply stores an email address and a role while the organization developer entity that it maps to can have a wide variety of attributes defined.","version":"1.0"},"security":[{"Basic":[]},{"OAuth":[]}],"paths":{"/organizations/{org_name}/companies/{company_name}/developers":{"post":{"tags":["Company Developer"],"summary":"Add or update company developers","description":"Adds a developer to a company, or updates an existing developer in the company.\n\nOptionally, you can assign a role to the developer, though it is not required. You can create roles for your partners, such as administrator or application developer. Those roles can then be assigned to specific partner employees.\n\nWhen updating an existing developer, specify both the developer's email and role (if applicable).","operationId":"addUpdateCompanyDevelopers","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/company_name"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/companyDevelopers"},"example":{"developer":[{"email":"ahamilton@example.com","role":"myrole"}]}}}},"400":{"description":"Bad request"}},"requestBody":{"description":"Add or update a company developer.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/companyDevelopers"},"example":{"developer":[{"email":"ahamilton@example.com","role":"myrole"}]}}}}},"get":{"tags":["Company Developer"],"summary":"List developers in company","description":"Lists developers in a company.","operationId":"listDevelopersCompany","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/company_name"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/companyDevelopers"},"example":{"developer":[{"email":"ahamilton@example.com","role":"myrole"}]}}}},"400":{"description":"Bad request"}}}},"/organizations/{org_name}/companies/{company_name}/developers/{developer_email}":{"delete":{"tags":["Company Developer"],"summary":"Remove developer from company","description":"Removes a developer from a company.","operationId":"removeDeveloperCompany","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/company_name"},{"$ref":"#/components/parameters/developer_email"}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad request"}}}}},"components":{"securitySchemes":{"Basic":{"type":"http","scheme":"basic","description":"Multi-factor authentication is not supported."},"OAuth":{"type":"apiKey","name":"Authorization","in":"header","description":"For OAuth, enter the following in the Key field: Bearer %your-token% (see https://docs.apigee.com/api-platform/system-administration/using-oauth2#get-the-tokens)"}},"parameters":{"org_name":{"in":"path","name":"org_name","required":true,"schema":{"type":"string"},"description":"Organization name."},"company_name":{"in":"path","name":"company_name","required":true,"schema":{"type":"string"},"description":"Company name."},"developer_email":{"in":"path","name":"developer_email","required":true,"schema":{"type":"string"},"description":"Email address of the developer."}},"schemas":{"companyDevelopers":{"description":"Company.","type":"object","properties":{"developer":{"type":"array","description":"List of developers in a company.","items":{"type":"object","properties":{"email":{"type":"string","description":"Email address of the developer."},"role":{"type":"string","description":"Role that may be used for access control to app information by a client, but which is not enforced by Apigee."}}}}}}}}}
/ organizations / {org_name} / companies / {company_name} / developers
/ organizations / {org_name} / companies / {company_name} / developers / {developer_email}
Resource files API OpenAPI	{"openapi":"3.0.0","servers":[{"url":"https://api.enterprise.apigee.com/v1"}],"info":{"title":"Resource files API","description":"Manage files containing executable code or definitions used by API policies to enable custom behavior and extensibility. \n\nResource files are executable code or other types of assets (for example XSLT) that are used by API proxies at runtime. Resource files can be stored at one of three levels:\n* **API proxy**: Available to any policies in an API proxy.\n* **Environment**: Available to any policies in any API proxy deployed in the environment.\n* **Organization**: Available to any API proxy deployed in any environment in an organization.\n\nResource files are resolved by name. Apigee Edge resolves resource files from most specific (API proxy) to the most general (organization). This enables you to store generic code that provides utility processing at the organization level. This provides for greater maintainability, since generic code is not repeated across multiple API proxies. A good example of code that might be scoped to the organization is a library to do Base64 encoding.\n\nFor more information, see <a href=\"https://docs.apigee.com/api-platform/develop/resource-files\">Manage resources</a>.","version":"1.0"},"security":[{"Basic":[]},{"OAuth":[]}],"paths":{"/organizations/{org_name}/apis/{api_name}/revisions/{revision_number}/resourcefiles":{"post":{"tags":["Resource Files"],"summary":"Import a resource file for an API","description":"Imports and creates a resource file for an API proxy revision.\n\n**Note**: **Currently, you cannot import a resource file using the Try this API panel**.\n\nYou can import the resource file by passing the contents in the request body or by uploading it from a file on your local machine. \n\nFor example, the following curl call imports a resource file by passing its contents in the request body. In this case, set the `Content-type` to `application/octet-stream`.\n\n```\ncurl https://api.enterprise.apigee.com/v1/organizations/myorg/apis/helloworld/revisions/1/resourcefiles?name=pathSetter.js&type=jsc \\\n -X POST \\\n -H \"Content-type: application/octet-stream\" \\\n -d 'request.headers[\"RequestPath\"] = context.getVariable(\"proxy.basepath\");' \\\n -u email:password\n\n```\n\nThe following curl call shows how to upload the resources as a file from your local machine. In this case, set the `Content-type` to `multipart/form-data`. It's important to use `-F` for the binary upload in curl in order for the environment- or organization-scoped JavaScript files to be accessible by the JavaScript policy.\n\n```\ncurl https://api.enterprise.apigee.com/v1/organizations/myorg/apis/helloworld/revisions/1/resourcefiles?name=pathSetter.js&type=jsc \\\n -X POST \\\n -H \"Content-type:multipart/form-data\" \\\n -F file=@pathSetter.js \\\n -u email:password\n\n``` \n\nFor more information, see <a href=\"https://docs.apigee.com/api-platform/develop/resource-files\">Manage resources</a>.","operationId":"importResourceFileAPI","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/api_name"},{"$ref":"#/components/parameters/revision_number"}],"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceFile"},"example":{"name":"pathSetter.js","type":"jsc"}}}},"400":{"description":"Bad request"}},"requestBody":{"description":"Body of the resource file.","content":{"application/octet-stream":{"schema":{"type":"string"}},"multipart/form-data":{"schema":{"type":"string","format":"binary"}}}}},"get":{"tags":["Resource Files"],"summary":"List resource files in an API","description":"Lists resource files in an API proxy revision. For more information, see <a href=\"https://docs.apigee.com/api-platform/develop/resource-files\">Manage resources</a>.","operationId":"listResourceFilesAPI","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/api_name"},{"$ref":"#/components/parameters/revision_number"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"resourceFile":{"type":"array","items":{"$ref":"#/components/schemas/ResourceFile"}}}},"example":{"resourceFile":[{"name":"pathSetter.js","type":"jsc"}]}}}},"400":{"description":"Bad request"}}}},"/organizations/{org_name}/apis/{api_name}/revisions/{revision_number}/resourcefiles/{resource_type}/{resource_name}":{"put":{"tags":["Resource Files"],"summary":"Update a resource file in an API","description":"Updates a resource file in an API proxy revision.\n\n**Note**: **Currently, you cannot update a resource file using the Try this API panel**.\n\nYou can update the resource file by passing the contents in the request body or by uploading it from a file on your local machine. \n\nFor example, the following curl call updates a resource file by passing its contents in the request body. In this case, set the `Content-type` to `application/octet-stream`.\n\n```\ncurl https://api.enterprise.apigee.com/v1/organizations/myorg/apis/helloworld/revisions/1/resourcefiles/jsc/pathSetter.js \\\n -X PUT \\\n -H \"Content-type: application/octet-stream\" \\\n -d 'request.headers[\"RequestPath\"] = context.getVariable(\"proxy.basepath\");' \\\n -u email:password\n\n```\n\nThe following curl call shows how to upload the resources as a file from your local machine. In this case, set the `Content-type` to `multipart/form-data`. It's important to use `-F` for the binary upload in curl in order for the environment- or organization-scoped JavaScript files to be accessible by the JavaScript policy.\n\n```\ncurl https://api.enterprise.apigee.com/v1/organizations/myorg/apis/helloworld/revisions/1/resourcefiles/jsc/pathSetter.js \\\n -X PUT \\\n -H \"Content-type:multipart/form-data\" \\\n -F file=@pathSetter.js \\\n -u email:password\n\n``` \n\nFor more information, see <a href=\"https://docs.apigee.com/api-platform/develop/resource-files\">Manage resources</a>.","operationId":"updateResourceFileAPI","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/api_name"},{"$ref":"#/components/parameters/revision_number"},{"$ref":"#/components/parameters/resource_type"},{"$ref":"#/components/parameters/resource_name"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceFile"},"example":{"name":"pathSetter.js","type":"jsc"}}}},"400":{"description":"Bad request"}},"requestBody":{"description":"Body of the resource file.","content":{"application/octet-stream":{"schema":{"type":"string"}},"multipart/form-data":{"schema":{"type":"string","format":"binary"}}}}},"delete":{"tags":["Resource Files"],"summary":"Delete a resource file from an API","description":"Deletes a resource file from an API proxy revision. For more information, see <a href=\"https://docs.apigee.com/api-platform/develop/resource-files\">Manage resources</a>.","operationId":"deleteResourceFileAPI","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/api_name"},{"$ref":"#/components/parameters/revision_number"},{"$ref":"#/components/parameters/resource_type"},{"$ref":"#/components/parameters/resource_name"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceFile"},"example":{"name":"pathSetter.js","type":"jsc"}}}},"400":{"description":"Bad request"}}},"get":{"tags":["Resource Files"],"summary":"Get a resource file in an API","description":"Gets a resource file in an API proxy revision. For more information, see <a href=\"https://docs.apigee.com/api-platform/develop/resource-files\">Manage resources</a>.","operationId":"getResourceFileAPI","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/api_name"},{"$ref":"#/components/parameters/revision_number"},{"$ref":"#/components/parameters/resource_type"},{"$ref":"#/components/parameters/resource_name"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"string"}}}},"400":{"description":"Bad request"}}}},"/organizations/{org_name}/environments/{env_name}/resourcefiles":{"post":{"tags":["Resource Files"],"summary":"Import a resource file for an environment","description":"Imports and creates a resource file for an environment.\n\n**Note**: **Currently, you cannot import a resource file using the Try this API panel**.\n\nYou can import the resource file by passing the contents in the request body or by uploading it from a file on your local machine. \n\nFor example, the following curl call imports a resource file by passing its contents in the request body. In this case, set the `Content-type` to `application/octet-stream`.\n\n```\ncurl https://api.enterprise.apigee.com/v1/organizations/myorg/environments/test/resourcefiles?name=pathSetter.js&type=jsc \\\n -X POST \\\n -H \"Content-type: application/octet-stream\" \\\n -d 'request.headers[\"RequestPath\"] = context.getVariable(\"proxy.basepath\");' \\\n -u email:password\n\n```\n\nThe following curl call shows how to upload the resources as a file from your local machine. In this case, set the `Content-type` to `multipart/form-data`. It's important to use `-F` for the binary upload in curl in order for the environment- or organization-scoped JavaScript files to be accessible by the JavaScript policy.\n\n```\ncurl https://api.enterprise.apigee.com/v1/organizations/myorg/environments/test/resourcefiles?name=pathSetter.js&type=jsc \\\n -X POST \\\n -H \"Content-type:multipart/form-data\" \\\n -F file=@pathSetter.js \\\n -u email:password\n\n``` \n\nFor more information, see <a href=\"https://docs.apigee.com/api-platform/develop/resource-files\">Manage resources</a>.","operationId":"importResourceFileEnv","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/env_name"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceFile"},"example":{"name":"pathSetter.js","type":"jsc"}}}},"400":{"description":"Bad request"}},"requestBody":{"description":"Body of the resource file.","content":{"application/octet-stream":{"schema":{"type":"string"}},"multipart/form-data":{"schema":{"type":"string","format":"binary"}}}}},"get":{"tags":["Resource Files"],"summary":"List resource files in an environment","description":"Lists resource files in an environment. For more information, see <a href=\"https://docs.apigee.com/api-platform/develop/resource-files\">Manage resources</a>.","operationId":"listResourceFilesEnv","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/env_name"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"resourceFile":{"type":"array","items":{"$ref":"#/components/schemas/ResourceFile"}}}},"example":{"resourceFile":[{"name":"pathSetter.js","type":"jsc"}]}}}},"400":{"description":"Bad request"}}}},"/organizations/{org_name}/environments/{env_name}/resourcefiles/{resource_type}/{resource_name}":{"put":{"tags":["Resource Files"],"summary":"Update a resource file in an environment","description":"Updates a resource file in an environment.\n\n**Note**: **Currently, you cannot update a resource file using the Try this API panel**.\n\nYou can update the resource file by passing the contents in the request body or by uploading it from a file on your local machine. \n\nFor example, the following curl call updates a resource file by passing its contents in the request body. In this case, set the `Content-type` to `application/octet-stream`.\n\n```\ncurl https://api.enterprise.apigee.com/v1/organizations/myorg/environments/test/resourcefiles/jsc/pathSetter.js \\\n -X PUT \\\n -H \"Content-type: application/octet-stream\" \\\n -d 'request.headers[\"RequestPath\"] = context.getVariable(\"proxy.basepath\");' \\\n -u email:password\n\n```\n\nThe following curl call shows how to upload the resources as a file from your local machine. In this case, set the `Content-type` to `multipart/form-data`. It's important to use `-F` for the binary upload in curl in order for the environment- or organization-scoped JavaScript files to be accessible by the JavaScript policy.\n\n```\ncurl https://api.enterprise.apigee.com/v1/organizations/myorg/environments/test/resourcefiles?name=pathSetter.js&type=jsc \\\n -X PUT \\\n -H \"Content-type:multipart/form-data\" \\\n -F file=@pathSetter.js \\\n -u email:password\n\n``` \n\nFor more information, see <a href=\"https://docs.apigee.com/api-platform/develop/resource-files\">Manage resources</a>.","operationId":"updateResourceFileEnv","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/env_name"},{"$ref":"#/components/parameters/resource_type"},{"$ref":"#/components/parameters/resource_name"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceFile"},"example":{"name":"pathSetter.js","type":"jsc"}}}},"400":{"description":"Bad request"}},"requestBody":{"description":"Body of the resource file.","content":{"application/octet-stream":{"schema":{"type":"string"}},"multipart/form-data":{"schema":{"type":"string","format":"binary"}}}}},"delete":{"tags":["Resource Files"],"summary":"Delete a resource file from an environment","description":"Deletes a resource file from an environment. For more information, see <a href=\"https://docs.apigee.com/api-platform/develop/resource-files\">Manage resources</a>.","operationId":"deleteResourceFileEnv","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/env_name"},{"$ref":"#/components/parameters/resource_type"},{"$ref":"#/components/parameters/resource_name"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceFile"},"example":{"name":"pathSetter.js","type":"jsc"}}}},"400":{"description":"Bad request"}}},"get":{"tags":["Resource Files"],"summary":"Get a resource file in an environment","description":"Gets the contents of a resource file in an environment. For more information, see <a href=\"https://docs.apigee.com/api-platform/develop/resource-files\">Manage resources</a>.","operationId":"getResourceFileEnv","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/env_name"},{"$ref":"#/components/parameters/resource_type"},{"$ref":"#/components/parameters/resource_name"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"string"},"example":"request.headers[\"RequestPath\"] = context.getVariable(\"proxy.basepath\");"}}},"400":{"description":"Bad request"}}}},"/organizations/{org_name}/resourcefiles":{"get":{"tags":["Resource Files"],"summary":"List resource files in an organization","description":"Lists resource files in an organization. For more information, see <a href=\"https://docs.apigee.com/api-platform/develop/resource-files\">Manage resources</a>.","operationId":"listResourceFilesOrg","parameters":[{"$ref":"#/components/parameters/org_name"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"resourceFile":{"type":"array","items":{"$ref":"#/components/schemas/ResourceFile"}}}},"example":{"resourceFile":[{"name":"pathSetter.js","type":"jsc"}]}}}},"400":{"description":"Bad request"}}},"post":{"tags":["Resource Files"],"summary":"Import a resource file for an organization","description":"Imports and creates a resource file for an organization.\n\n**Note**: **Currently, you cannot import a resource file using the Try this API panel**.\n\nYou can import the resource file by passing the contents in the request body or by uploading it from a file on your local machine. \n\nFor example, the following curl call imports a resource file by passing its contents in the request body. In this case, set the `Content-type` to `application/octet-stream`.\n\n```\ncurl https://api.enterprise.apigee.com/v1/organizations/myorg/resourcefiles?name=pathSetter.js&type=jsc \\\n -X POST \\\n -H \"Content-type: application/octet-stream\" \\\n -d 'request.headers[\"RequestPath\"] = context.getVariable(\"proxy.basepath\");' \\\n -u email:password\n\n```\n\nThe following curl call shows how to upload the resources as a file from your local machine. In this case, set the `Content-type` to `multipart/form-data`. It's important to use `-F` for the binary upload in curl in order for the environment- or organization-scoped JavaScript files to be accessible by the JavaScript policy.\n\n```\ncurl https://api.enterprise.apigee.com/v1/organizations/myorg/resourcefiles?name=pathSetter.js&type=jsc \\\n -X POST \\\n -H \"Content-type:multipart/form-data\" \\\n -F file=@pathSetter.js \\\n -u email:password\n\n``` \n\nFor more information, see <a href=\"https://docs.apigee.com/api-platform/develop/resource-files\">Manage resources</a>.","operationId":"importResourceFileOrg","parameters":[{"$ref":"#/components/parameters/org_name"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceFile"},"example":{"name":"pathSetter.js","type":"jsc"}}}},"400":{"description":"Bad request"}},"requestBody":{"description":"Body of the resource file.","content":{"application/octet-stream":{"schema":{"type":"string"}},"multipart/form-data":{"schema":{"type":"string","format":"binary"}}}}}},"/organizations/{org_name}/resourcefiles/{resource_type}/{resource_name}":{"get":{"tags":["Resource Files"],"summary":"Get a resource file in an organization","description":"Gets a resource file in an organization. For more information, see <a href=\"https://docs.apigee.com/api-platform/develop/resource-files\">Manage resources</a>.","operationId":"getResourceFileOrg","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/resource_type"},{"$ref":"#/components/parameters/resource_name"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"string"}}}},"400":{"description":"Bad request"}}},"put":{"tags":["Resource Files"],"summary":"Update a resource file in an organization","description":"Updates a resource file in an organization.\n\n**Note**: **Currently, you cannot update a resource file using the Try this API panel**.\n\nYou can update the resource file by passing the contents in the request body or by uploading it from a file on your local machine. \n\nFor example, the following curl call updates a resource file by passing its contents in the request body. In this case, set the `Content-type` to `application/octet-stream`.\n\n```\ncurl https://api.enterprise.apigee.com/v1/organizations/myorg/resourcefiles/jsc/pathSetter.js \\\n -X PUT \\\n -H \"Content-type: application/octet-stream\" \\\n -d 'request.headers[\"RequestPath\"] = context.getVariable(\"proxy.basepath\");' \\\n -u email:password\n\n```\n\nThe following curl call shows how to upload the resources as a file from your local machine. In this case, set the `Content-type` to `multipart/form-data`. It's important to use `-F` for the binary upload in curl in order for the environment- or organization-scoped JavaScript files to be accessible by the JavaScript policy.\n\n```\ncurl https://api.enterprise.apigee.com/v1/organizations/myorg/resourcefiles/jsc/pathSetter.js \\\n -X PUT \\\n -H \"Content-type:multipart/form-data\" \\\n -F file=@pathSetter.js \\\n -u email:password\n\n``` \n\nFor more information, see <a href=\"https://docs.apigee.com/api-platform/develop/resource-files\">Manage resources</a>.","operationId":"updateResourceFileAPI","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/api_name"},{"$ref":"#/components/parameters/revision_number"},{"$ref":"#/components/parameters/resource_type"},{"$ref":"#/components/parameters/resource_name"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceFile"},"example":{"name":"pathSetter.js","type":"jsc"}}}},"400":{"description":"Bad request"}},"requestBody":{"description":"Body of the resource file.","content":{"application/octet-stream":{"schema":{"type":"string"}},"multipart/form-data":{"schema":{"type":"string","format":"binary"}}}}},"delete":{"tags":["Resource Files"],"summary":"Delete a resource file from an organization","description":"Deletes a resource file from an organization. For more information, see <a href=\"https://docs.apigee.com/api-platform/develop/resource-files\">Manage resources</a>.","operationId":"deleteResourceFileOrg","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/resource_type"},{"$ref":"#/components/parameters/resource_name"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceFile"},"example":{"name":"pathSetter.js","type":"jsc"}}}},"400":{"description":"Bad request"}}}}},"components":{"securitySchemes":{"Basic":{"type":"http","scheme":"basic","description":"Multi-factor authentication is not supported."},"OAuth":{"type":"apiKey","name":"Authorization","in":"header","description":"For OAuth, enter the following in the Key field: Bearer %your-token% (see https://docs.apigee.com/api-platform/system-administration/using-oauth2#get-the-tokens)"}},"parameters":{"org_name":{"in":"path","name":"org_name","required":true,"schema":{"type":"string"},"description":"Organization name."},"env_name":{"in":"path","name":"env_name","required":true,"schema":{"type":"string"},"description":"Environment name."},"api_name":{"in":"path","name":"api_name","required":true,"schema":{"type":"string"},"description":"API proxy name."},"revision_number":{"in":"path","name":"revision_number","required":true,"schema":{"type":"string"},"description":"API proxy revision."},"resource_name":{"in":"path","name":"resource_name","required":true,"schema":{"type":"string"},"description":"Resource name."},"resource_type":{"in":"path","name":"resource_type","required":true,"schema":{"type":"string"},"description":"Resource type."},"name":{"in":"query","name":"name","required":true,"schema":{"type":"string"},"description":"Name of the resource including the file type extension."},"type":{"in":"query","name":"type","required":true,"schema":{"type":"string"},"description":"Resource type. Valid values include `jsc`, `java`, `py`, `node`, `xsl`, `wsdl`, and `xsd`."}},"schemas":{"ResourceFile":{"description":"Resource file details.","properties":{"name":{"type":"string","description":"Name of the resource file."},"type":{"type":"string","description":"Type of the resource file."}}}}}}
/ organizations / {org_name} / apis / {api_name} / revisions / {revision_number} / resourcefiles
/ organizations / {org_name} / apis / {api_name} / revisions / {revision_number} / resourcefiles / {resource_type} / {resource_name}
/ organizations / {org_name} / environments / {env_name} / resourcefiles
/ organizations / {org_name} / environments / {env_name} / resourcefiles / {resource_type} / {resource_name}
/ organizations / {org_name} / resourcefiles
/ organizations / {org_name} / resourcefiles / {resource_type} / {resource_name}
Shared flows and flow hooks API OpenAPI	{"openapi":"3.0.0","servers":[{"url":"https://api.enterprise.apigee.com/v1"}],"info":{"title":"Shared flows and flow hooks API","description":"Manage shared flows and flow hooks. For more information, see:\n* <a href=\"https://docs.apigee.com/api-platform/fundamentals/shared-flows\">Reusable shared flows</a>\n* <a href=\"https://docs.apigee.com/api-platform/fundamentals/flow-hooks\">Attaching a shared flow using a flow hook</a>.","version":"1.0"},"security":[{"Basic":[]},{"OAuth":[]}],"paths":{"/organizations/{org_name}/sharedflows":{"post":{"tags":["Shared flows"],"summary":"Import a shared flow","description":"Imports a ZIP-formatted shared flow configuration bundle from a local machine to an Edge organization. If the shared flow already exists, this API creates a new revision of it. If the shared flow does not exist, this API creates it.\n\n**Notes**:\n\n* **Currently, you cannot import a shared flow using the Try this API panel**.\n* By default, shared flow configurations are not validated on import.\n\nOnce imported, the shared flow revision must be deployed before it can be accessed at runtime.\n\nFor example, the following curl call imports a shared flow configuration bundle:\n\n```\ncurl \"https://api.enterprise.apigee.com/v1/organizations/{org_name}/sharedflows?action=import&name=example\" \\\n -X POST \\\n -H Content-Type=\"multipart/form-data\"\n -F \"file=@shareflow.zip\" \\\n -u email:password\n\n```","operationId":"importSharedFlow","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/action"},{"$ref":"#/components/parameters/name"}],"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SharedFlowRevision"},"example":{"basepaths":[],"configurationVersion":{"majorVersion":4,"minorVersion":0},"contextInfo":"Revision null of application -NA-, in organization -NA-","createdAt":1472699641914,"createdBy":"ahamilton@example.com","description":"Shared flow used to verify API key.","displayName":"My shared flow","entityMetaDataAsProperties":{"bundle_type":"zip","lastModifiedBy":"ahamilton@example.com","createdBy":"ahamilton@example.com","lastModifiedAt":"1560888800458","subType":"null","createdAt":"1472699641914"},"lastModifiedAt":1560888800458,"lastModifiedBy":"ahamilton@example.com","manifestVersion\"":"SHA-512:46eac8e4f4xxxxxxxxxxx","name":"mySharedFlow","policies":["Verify-API-Key"],"proxies":[],"resourceFiles":{"resourceFile":[]},"resources":[],"revision":"1","sharedFlows":["default"],"spec":"","targetServers":[],"targets":[],"type":"Application"}}}},"400":{"description":"Bad request"}},"requestBody":{"description":"Shared flow configuration.","content":{"multipart/form-data":{"schema":{"type":"string","format":"binary"}}}}},"get":{"tags":["Shared flows"],"summary":"List shared flows","description":"Lists the shared flows in an organization.","operationId":"listSharedFlows","parameters":[{"$ref":"#/components/parameters/org_name"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"type":"string","description":"Shared flow name."}}}}},"400":{"description":"Bad request"}}}},"/organizations/{org_name}/sharedflows/{sharedflow_name}":{"delete":{"tags":["Shared Flows"],"summary":"Delete shared flow","description":"Deletes shared flow and all associated policies, resources, and revisions. You must undeploy the shared flow before deleting it.","operationId":"deleteSharedFlow","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/sharedflow_name"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SharedFlowRevision"},"example":{"basepaths":[],"configurationVersion":{"majorVersion":4,"minorVersion":0},"contextInfo":"Revision null of application -NA-, in organization -NA-","createdAt":1472699641914,"createdBy":"ahamilton@example.com","description":"Shared flow used to verify API key.","displayName":"My shared flow","entityMetaDataAsProperties":{"bundle_type":"zip","lastModifiedBy":"ahamilton@example.com","createdBy":"ahamilton@example.com","lastModifiedAt":"1560888800458","subType":"null","createdAt":"1472699641914"},"lastModifiedAt":1560888800458,"lastModifiedBy":"ahamilton@example.com","manifestVersion\"":"SHA-512:46eac8e4f4xxxxxxxxxxx","name":"mySharedFlow","policies":["Verify-API-Key"],"proxies":[],"resourceFiles":{"resourceFile":[]},"resources":[],"revision":"1","sharedFlows":["default"],"spec":"","targetServers":[],"targets":[],"type":"Application"}}}},"400":{"description":"Bad request"}}},"get":{"tags":["Shared Flows"],"summary":"Get shared flow","description":"Gets a shared flow including a list of existing revisions.","operationId":"getSharedFlow","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/sharedflow_name"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SharedFlow"},"example":{"metaData":{"createdAt":1537811449596,"createdBy":"ahamilton@example.com","lastModifiedAt":1537811449596,"lastModifiedBy":"ahamilton@example.com"},"name":"mySharedFlow","revision":["1","2"]}}}},"400":{"description":"Bad request"}}}},"/organizations/{org_name}/sharedflows/{sharedflow_name}/revisions":{"get":{"tags":["Shared Flow"],"summary":"List shared flow revisions","description":"List all revisions for a shared flow.","operationId":"listSharedFlowRevisions","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/sharedflow_name"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"type":"string","description":"Shared flow revision."}}}}},"400":{"description":"Bad request"}}}},"/organizations/{org_name}/sharedflows/{sharedflow_name}/revisions/{revision_number}":{"get":{"tags":["Shared Flow"],"summary":"Export a shared flow revision","description":"Exports the shared flow configuration for the specified revision as a zip file.\n\n**Note**: **Currently, you cannot import a shared flow using the Try this API panel**.\n\nSet the `format` query parameter to `bundle`. If you are using curl, specify `-o filename.zip` to save the output to a file; otherwise, it displays to `stdout`. Then, develop the shared flow configuration locally and <a href=\"/docs/shared-flows/1/routes/organizations/%7Borg_name%7D/sharedflows/post\">import</a> the updated shared flow configuration revision.","operationId":"getAPIProxyRevision","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/sharedflow_name"},{"$ref":"#/components/parameters/revision_number"},{"$ref":"#/components/parameters/format"}],"responses":{"200":{"description":"OK","content":{"application/octet-stream":{"schema":{"type":"string","format":"binary"}}}},"400":{"description":"Bad request"}}}},"/organizations/{org_name}/environments/{env_name}/flowhooks/{flow_hook}":{"put":{"tags":["Shared Flows","Flow Hooks"],"summary":"Attach a shared flow to a flow hook.","description":"Attaches a shared flow to the specified flow hook. Valid values for flow hook include:\n\n* `PreProxyFlowHook`\n* `PreTargetFlowHook`\n* `PostTargetFlowHook`\n* `PostProxyFlowHook`\n\nFor more information, see see <a href=\"https://docs.apigee.com/api-platform/fundamentals/flow-hooks\">Attaching a shared flow using a flow hook</a> and <a href=\"https://docs.apigee.com/api-platform/fundamentals/shared-flows\">Reusable shared flows</a>.","operationId":"attachFlowHook","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/env_name"},{"$ref":"#/components/parameters/flow_hook"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FlowHook"},"example":{"continueOnError":true,"sharedFlow":"mySharedFlow","state":"deployed"}}}},"400":{"description":"Bad request"}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"FlowHook":{"type":"object","properties":{"SharedFlow":{"type":"string","description":"Shared flow to attach to the flow hook."}}}},"example":{"FlowHook":{"SharedFlow":"mySharedFlow"}}}},"application/xml":{"schema":{"type":"object","properties":{"FlowHook":{"type":"object","properties":{"SharedFlow":{"type":"string","description":"Shared flow to attach to the flow hook."}}}},"example":{"FlowHook":{"SharedFlow":"mySharedFlow"}}}}}}},"get":{"tags":["Shared Flows","Flow Hooks"],"summary":"Get the shared flow attached to a flow hook","description":"Gets the shared flow attached to a flow hook. Valid values for flow hook include:\n\n* `PreProxyFlowHook`\n* `PreTargetFlowHook`\n* `PostTargetFlowHook`\n* `PostProxyFlowHook`\n\nOnly one shared flow at a time can be attached to a flow hook. \n\nFor more information, see see <a href=\"https://docs.apigee.com/api-platform/fundamentals/flow-hooks\">Attaching a shared flow using a flow hook</a> and <a href=\"https://docs.apigee.com/api-platform/fundamentals/shared-flows\">Reusable shared flows</a>.","operationId":"getSharedFlowAttachedFlowHook","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/env_name"},{"$ref":"#/components/parameters/flow_hook"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FlowHook"},"example":{"continueOnError":true,"sharedFlow":"mySharedFlow"}}}},"400":{"description":"Bad request"}}},"delete":{"tags":["Shared Flows","Flow Hooks"],"summary":"Detach a shared flow to a flow hook.","description":"Detaches a shared flow from the specified flow hook. Valid values for flow hook include:\n\n* `PreProxyFlowHook`\n* `PreTargetFlowHook`\n* `PostTargetFlowHook`\n* `PostProxyFlowHook`\nIf no shared flow is attached, this will not return an error. Only one shared flow at a time can be attached to a flow hook. \n\nFor more information, see see <a href=\"https://docs.apigee.com/api-platform/fundamentals/flow-hooks\">Attach a shared flow using a flow hook</a> and <a href=\"https://docs.apigee.com/api-platform/fundamentals/shared-flows\">Reusable shared flows</a>.","operationId":"detachFlowHook","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/env_name"},{"$ref":"#/components/parameters/flow_hook"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FlowHook"},"example":{"continueOnError":true,"sharedFlow":"mySharedFlow","state":"undeployed"}}}},"400":{"description":"Bad request"}}}}},"components":{"securitySchemes":{"Basic":{"type":"http","scheme":"basic","description":"Multi-factor authentication is not supported."},"OAuth":{"type":"apiKey","name":"Authorization","in":"header","description":"For OAuth, enter the following in the Key field: Bearer %your-token% (see https://docs.apigee.com/api-platform/system-administration/using-oauth2#get-the-tokens)"}},"parameters":{"org_name":{"in":"path","name":"org_name","required":true,"schema":{"type":"string"},"description":"Organization name."},"sharedflow_name":{"in":"path","name":"sharedflow_name","required":true,"schema":{"type":"string"},"description":"Shared flow name."},"revision_number":{"in":"path","name":"revision_number","required":true,"schema":{"type":"string"},"description":"Revision number."},"env_name":{"in":"path","name":"env_name","required":true,"schema":{"type":"string"},"description":"Environment name."},"flow_hook":{"in":"path","name":"flow_hook","required":true,"schema":{"type":"string"},"description":"Flow hook name. Specify one of the following flowhook locations: `PreProxyFlowHook`, `PreTargetFlowHook`, `PostTargetFlowHook`, `PostProxyFlowHook`"},"action":{"in":"query","name":"action","required":true,"schema":{"type":"string"},"description":"Set to `import` to import the shared flow configuration."},"name":{"in":"query","name":"name","required":true,"schema":{"type":"string"},"description":"Name for the imported shared flow."},"format":{"in":"query","name":"format","required":true,"schema":{"type":"string"},"description":"Format used when downloading the shared flow configuration revision. Set to `bundle` to download the shared flow configuration revision as a zip file."}},"schemas":{"SharedFlow":{"description":"Shared flow metadata and revisions.","type":"object","properties":{"metadata":{"description":"Shared flow metadata.","type":"object","properties":{"createdAt":{"description":"Time when the shared flow was created in milliseconds since epoch.","type":"integer"},"createdBy":{"type":"string","description":"Email address of developer that created the shared flow."},"lastModifiedAt":{"description":"Time when the shared flow was last modified in milliseconds since epoch.","type":"integer"},"lastModifiedBy":{"description":"Email address of developer that last modified the shared flow.","type":"string"}}},"name":{"description":"Name of the shared flow.","type":"string"},"revision":{"description":"Revisions defined for the shared flow.","type":"array","items":{"type":"string","description":"Revision number."}}}},"SharedFlowRevision":{"description":"Shared flow revision.","type":"object","properties":{"basepaths":{"description":"Base paths for the shared flow.","type":"array","items":{"type":"string"}},"configurationVersion":{"description":"Version of the shared flow configuration schema to which this shared flow conforms. This setting may be used in the future to track the evolution of the shared flow format.","type":"object","properties":{"majorVersion":{"description":"Major version of the shared flow configuration schema. The only supported value is '4'.","type":"integer"},"minorVersion":{"description":"Minor version of the shared flow configuration schema. The only supported value is '0'.","type":"integer"}}},"contextInfo":{"type":"string","description":"Revision number, app name, and organization for the shared flow."},"createdAt":{"description":"Time when the shared flow revision was created in milliseconds since epoch.","type":"integer"},"createdBy":{"description":"Email address of developer that created the shared flow.","type":"string"},"description":{"type":"string","description":"Description of the shared flow."},"displayName":{"type":"string","description":"Display name for the shared flow."},"entityMetaDataAsProperties":{"description":"Kev-value map of metadata describing the shared flow revision.","type":"object","properties":{"bundle_type":{"description":"Type of bundle. Set to `zip`.","type":"string"},"createdAt":{"description":"Time when the shared flow revision was created in milliseconds since epoch.","type":"string"},"createdBy":{"description":"Email address of developer that created the shared flow.","type":"string"},"lastModifiedAt":{"description":"Time when the shared flow version was last modified in milliseconds since epoch.","type":"string"},"lastModifiedBy":{"description":"Email address of developer that last modified the shared flow.","type":"string"},"subType":{"description":"Set to `null`.","type":"string"}}},"lastModifiedAt":{"description":"Time when the shared flow version was last modified in milliseconds since epoch.","type":"integer"},"lastModifiedBy":{"description":"Email address of developer that last modified the shared flow.","type":"string"},"manifestVersion":{"description":"Manifest version of the bundle.","type":"string"},"name":{"description":"Name of the shared flow.","type":"string"},"policies":{"description":"List of policies included in the shared flow revision.","type":"array","items":{"type":"string","description":"Policy name."}},"proxies":{"description":"List of API proxy names included in the shared flow revision.","type":"array","items":{"type":"string","description":"API proxy name."}},"resourceFiles":{"description":"Resource files included with the shared flow revision.","type":"object","properties":{"resourceFile":{"description":"Resource files included with the shared flow revision.","type":"array","items":{"description":"Resource filename.","type":"object","properties":{"name":{"description":"Name of the resource file.","type":"string"},"type":{"description":"Type of resource file.","type":"string"}}}}}},"resources":{"description":"List of resources included in the shared flow revision, formatted as `{type}://{name}`.","type":"array","items":{"type":"string","description":"Resource name."}},"sharedFlows":{"description":"List of shared flows included in the shared flow revision.","type":"array","items":{"type":"string","description":"Shared flow name."}},"spec":{"description":"OpenAPI Specification. For shared flows, this value is null.","type":"string"},"targetServers":{"description":"List of TargetServers referenced in any TargetEndpoints of the shared flow. Typically, this element is included only when the shared flow was created using the Edge UI. This is a 'manifest' setting designed to provide visibility into the contents of the shared flow.","type":"array","items":{"type":"string","description":"TargetServer name."}},"targets":{"description":"List of targets included in the shared flow revision.","type":"array","items":{"type":"string","description":"Target name."}},"type":{"description":"Set to `Application`.","type":"string"}}},"FlowHook":{"description":"Flow hook attachment details.","type":"object","properties":{"continueOnError":{"type":"string","description":"Flag that specifies whether execution should continue if the flow hook throws an exception."},"sharedFlow":{"type":"string","description":"Shared flow attached to the flow hook. Omitted if no shared flow is attached."},"state":{"type":"string","description":"Displays the updated deployment status of the flow hook, such as `deployed` or `undeployed`. Only displays when attaching to or detaching from a flow hook."}}}}}}
/ organizations / {org_name} / sharedflows
/ organizations / {org_name} / sharedflows / {sharedflow_name}
/ organizations / {org_name} / sharedflows / {sharedflow_name} / revisions
/ organizations / {org_name} / sharedflows / {sharedflow_name} / revisions / {revision_number}
/ organizations / {org_name} / environments / {env_name} / flowhooks / {flow_hook}
Users API OpenAPI	{"openapi":"3.0.0","servers":[{"url":"https://api.enterprise.apigee.com/v1"}],"info":{"title":"Users API","description":"Manage the users in your organization.","version":"1.0"},"security":[{"Basic":[]},{"OAuth":[]}],"paths":{"/users":{"get":{"tags":["Users"],"summary":"List global users","description":"Lists global users.\n\n**Notes**:\n* **Apigee Edge for Private Cloud only**. If you are using Apigee Edge for Public Cloud, contact <a href=\"https://cloud.google.com/apigee/support\">Apigee Support</a> for assistance.\n* **This API cannot be executed using the Try this API panel**.\n\nSee <a href=\"https://docs.apigee.com/api-platform/system-administration/about-global-users\">About global users</a> for more on Edge users, user types, and user roles.","operationId":"listUsers","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}}},"400":{"description":"Bad request"}}},"post":{"tags":["Users"],"summary":"Create user","description":"Creates a global user.\n\n**Notes**:\n* **Apigee Edge for Private Cloud only**. If you are using Apigee Edge for Public Cloud, contact <a href=\"https://cloud.google.com/apigee/support\">Apigee Support</a> for assistance.\n* **This API cannot be executed using the Try this API panel**.\n\nAfter you create the user in an organization, you must assign the user to a role in an organization. Roles determine the access rights of the user on Edge. The user cannot sign in to the Edge UI, and does not appear in the list of users in the Edge UI, until you assign it to a role in an organization. See <a href=\"/docs/user-roles-api/1/routes/organizations/%7Borg_name%7D/userroles/%7Brole_name%7D/users/post\">Add a user to a role</a>.\n\nSee <a href=\"https://docs.apigee.com/api-platform/system-administration/about-global-users\">About global users</a> for more on Edge users, user types, and user roles.","operationId":"createUser","parameters":[],"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/User"},"example":{"firstName":"Alex","lastName":"Hamilton","password":"mypassword","emailId":"ahamilton@example.com"}}}},"400":{"description":"Bad request"}}}},"/users/{user_email}":{"put":{"tags":["Users"],"summary":"Update user","description":"Updates a user.\n\n**Notes**:\n* **Apigee Edge for Private Cloud only**. If you are using Apigee Edge for Public Cloud, contact <a href=\"https://cloud.google.com/apigee/support\">Apigee Support</a> for assistance.\n* **This API cannot be executed using the Try this API panel**.\n\nWhen calling this API:\n\n* You must pass first name, last name, and email address to the call, even if you are not changing the values.\n* The password is the only optional property. Only specify password when you want to change the user's password.\n\nTo view the current information about a user, see Get user.\n\nSee <a href=\"https://docs.apigee.com/api-platform/system-administration/about-global-users\">About global users</a> for more on Edge users, user types, and user roles.","operationId":"updateUser","parameters":[{"$ref":"#/components/parameters/user_email"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/User"},"example":{"firstName":"Alex","lastName":"Hamilton","password":"mypassword","emailId":"ahamilton@example.com"}}}},"400":{"description":"Bad request"}}},"get":{"tags":["Users"],"summary":"Get user","description":"Gets user details.\n\n**Notes**:\n* **Apigee Edge for Private Cloud only**. If you are using Apigee Edge for Public Cloud, contact <a href=\"https://cloud.google.com/apigee/support\">Apigee Support</a> for assistance.\n* **This API cannot be executed using the Try this API panel**.\n\nSee <a href=\"https://docs.apigee.com/api-platform/system-administration/about-global-users\">About global users</a> for more on Edge users, user types, and user roles.","operationId":"getUser","parameters":[{"$ref":"#/components/parameters/user_email"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/User"},"example":{"firstName":"Alex","lastName":"Hamilton","password":"mypassword","emailId":"ahamilton@example.com"}}}},"400":{"description":"Bad request"}}},"delete":{"tags":["Users"],"summary":"Delete User","description":"Deletes a user.\n\n**Notes**:\n* **Apigee Edge for Private Cloud only**. If you are using Apigee Edge for Public Cloud, contact <a href=\"https://cloud.google.com/apigee/support\">Apigee Support</a> for assistance.\n* **This API cannot be executed using the Try this API panel**.\n\nSee <a href=\"https://docs.apigee.com/api-platform/system-administration/about-global-users\">About global users</a> for more on Edge users, user types, and user roles.","operationId":"deleteUser","parameters":[{"$ref":"#/components/parameters/user_email"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/User"},"example":{"firstName":"Alex","lastName":"Hamilton","password":"mypassword","emailId":"ahamilton@example.com"}}}},"400":{"description":"Bad request"}}}},"/users/{user_email}/status":{"post":{"tags":["Users"],"summary":"Unlock a user","description":"Unlocks a user.\n\n**Notes**:\n* **Apigee Edge for Private Cloud only**. If you are using Apigee Edge for Public Cloud, contact <a href=\"https://cloud.google.com/apigee/support\">Apigee Support</a> for assistance.\n* **This API cannot be executed using the Try this API panel**.\n\nA user’s account may be locked due to attributes set in the password policy. A user with the `sysadmin` Apigee role assigned can use this API to unlock the user’s account.\n\nSee <a href=\"https://docs.apigee.com/api-platform/system-administration/about-global-users\">About global users</a> for more on Edge users, user types, and user roles.","operationId":"unlockUser","parameters":[{"$ref":"#/components/parameters/user_email"},{"$ref":"#/components/parameters/action"}],"responses":{"200":{"description":"OK"},"400":{"description":"Bad request"}}}}},"components":{"securitySchemes":{"Basic":{"type":"http","scheme":"basic","description":"Multi-factor authentication is not supported."},"OAuth":{"type":"apiKey","name":"Authorization","in":"header","description":"For OAuth, enter the following in the Key field: Bearer %your-token% (see https://docs.apigee.com/api-platform/system-administration/using-oauth2#get-the-tokens)"}},"parameters":{"org_name":{"in":"path","name":"org_name","required":true,"schema":{"type":"string"},"description":"Organization name."},"user_email":{"in":"path","name":"user_email","required":true,"schema":{"type":"string"},"description":"User email address."},"action":{"in":"query","name":"action","required":true,"schema":{"type":"string"},"description":"Set to `unlock`."}},"schemas":{"User":{"description":"User details.","type":"object","required":["firstName","lastName","password","emailId"],"properties":{"firstName":{"description":"First name of user.","type":"string"},"lastName":{"description":"Last name of user.","type":"string"},"password":{"type":"string","description":"Password of user."},"emailId":{"description":"Email address of user.","type":"string"}}}}}}
/ users
/ users / {user_email}
/ users / {user_email} / status
App keys: Developer OpenAPI	{"openapi":"3.0.0","servers":[{"url":"https://api.enterprise.apigee.com/v1"}],"info":{"title":"App keys: Developer","description":"Manage consumer credentials for apps associated with individual developers.\n\nCredential pairs consisting of consumer key and consumer secret are provisioned by Apigee Edge to apps for specific API products. Apigee Edge maintains the relationship between consumer keys and API products, enabling API products to be added to and removed from consumer keys. A single consumer key can be used to access multiple API products. Keys may be manually or automatically approved for API products--how they are issued depends on the API product configuration. A key must approved and approved for an API product to be capable of accessing any of the URIs defined in the API product.","version":"1.0"},"security":[{"Basic":[]},{"OAuth":[]}],"paths":{"/organizations/{org_name}/developers/{developer_email}/apps/{app_name}/keys/create":{"post":{"tags":["Developer","Developer App","Consumer Key"],"summary":"Create a consumer key and secret","description":"Creates a custom consumer key and secret for a developer app. This is particularly useful if you want to migrate existing consumer keys/secrets to Edge from another system.\n\nAfter creating the consumer key and secret, associate the key with an API product, as described in Add API Product to Key.\n\nConsumer keys and secrets can contain letters, numbers, underscores, and hyphens. No other special characters are allowed.\n\n**Note**: Be aware of the following size limits on API keys. By staying within these limits, you help avoid service disruptions.\n\n* Consumer key (API key) size: 2 KB\n* Consumer secret size: 2 KB\n\nIf a consumer key and secret already exist, you can either keep them or delete them, as described in Delete Key for a Developer App.\n\nIn addition, you can use this API if you have existing API keys and secrets that you want to copy into Edge from another system. For more information, see <a href=\"https://docs.apigee.com/developer-services/content/import-existing-consumer-keys-and-secrets\">Import existing consumer keys and secrets</a>.","operationId":"createDevAppKey","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/developer_email"},{"$ref":"#/components/parameters/app_name"}],"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Keys"},"example":{"apiProducts":[{"apiproduct":"Hotels","status":"approved"}],"attributes":[{"name":"attribute1","value":"value1"}],"consumerKey":"<consumerKey>","consumerSecret":"<consumerSecret>","expiresAt":-1,"issuedAt":1523971974806,"scopes":["scope1","scope2"],"status":"approved"}}}},"400":{"description":"Bad request"}},"requestBody":{"description":"Consumer key and secret.","content":{"application/json":{"schema":{"type":"object","properties":{"consumerKey":{"description":"Consumer key.","type":"string"},"consumerSecret":{"description":"Consumer secret.","type":"string"}}},"example":{"consumerKey":"<consumerKey>","consumerSecret":"<consumerSecret>"}}}}}},"/organizations/{org_name}/developers/{developer_email}/apps/{app_name}/keys/{consumer_key}":{"get":{"tags":["Developer","Developer App","Consumer Key"],"summary":"Get key details for a developer app","operationId":"getDevAppKey","description":"Gets details for a consumer key for a developer app, including the key and secret value, associated API products, and other information.","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/developer_email"},{"$ref":"#/components/parameters/app_name"},{"$ref":"#/components/parameters/consumer_key"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Keys"},"example":{"apiProducts":[{"apiproduct":"Hotels","status":"approved"}],"attributes":[{"name":"attribute1","value":"value1"}],"consumerKey":"<consumerKey>","consumerSecret":"<consumerSecret>","expiresAt":-1,"issuedAt":1523971974806,"scopes":["scope1","scope2"],"status":"approved"}}}},"400":{"description":"Bad request"}}},"post":{"tags":["Developer","Developer App","Consumer Key"],"description":"Enables you to perform one of the following tasks:\n\n* Add an API product to a developer app key, enabling the app that holds the key to access the API resources bundled in the API product. You can also use this API to add attributes to the key. You must include all existing attributes, whether or not you are updating them, as well as any new attributes that you are adding. After adding the API product, you can use the same key to access all API products associated with the app.\n\n* Approve or revoke a specific consumer key for an app. Call the API with the `action` query parameter set to `approve` or `revoke` (with no request body) and set the `Content-type` header to `application/octet-stream`. If successful, the HTTP status code for success is: `204 No Content` **Currently, this action cannot be executed using the Try this API panel**.\n\n\n You can approve a consumer key that is currently revoked or pending. Once approved, the app can use the consumer key to access APIs. Revoking a consumer key renders it unusable for the app to use to access an API.\n\n\n **Note**: Any access tokens associated with a revoked app key will remain active. However, Apigee Edge checks the status of the app key and if set to `revoked` it will not allow API calls to go through.","summary":"Approve or revoke, or add an API product to a specific key for a developer app","operationId":"approveRevokeDevAppKey","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/developer_email"},{"$ref":"#/components/parameters/app_name"},{"$ref":"#/components/parameters/consumer_key"},{"$ref":"#/components/parameters/action"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Keys"},"example":{"apiProducts":[{"apiproduct":"Hotels","status":"approved"}],"attributes":[{"name":"attribute1","value":"value1"}],"consumerKey":"<consumerKey>","consumerSecret":"<consumerSecret>","expiresAt":-1,"issuedAt":1523971974806,"scopes":["scope1","scope2"],"status":"approved"}}}},"204":{"description":"No content"},"400":{"description":"Bad request"}},"requestBody":{"description":"List of API products and attributes.","content":{"application/json":{"schema":{"type":"object","properties":{"apiProducts":{"type":"array","description":"List of API products associated with an API key. Required when adding an API product to a key.","items":{"type":"string"}},"attributes":{"type":"array","description":"List of attributes associated with an API key.","items":{"type":"object","properties":{"name":{"type":"string","description":"Name of the custom attribute."},"value":{"type":"string","description":"Value of the custom attribute."}}}}}},"example":{"apiProducts":["Hotels","Restaurants"],"attributes":[{"name":"attribute1","value":"value1"}]}}}}},"put":{"tags":["Developer","Developer App","Consumer Key"],"description":"Updates the allowed OAuth scopes associated with an app.\n\n**Note**: Specify the complete list of scopes to apply. The specified list replaces the existing scopes on the app. Therefore, to add a scope, you must specify all of the existing scopes along with the added scope.\n\nThis API does not change the list of scopes in the API product(s) included in the app; rather, it sets allowed list of scopes in the scopes element under the `apiProducts` element in the attributes of the app.\n\n**Important**: The specified scopes must already exist on the API product(s) associated with the app. You can't arbitrarily add a scope that does not already exist in an API product. For example, if the app has one API product with these scopes: READ, WRITE. You can't use this API to add a new scope, such as DELETE (unless the app has another product with that scope). If you do this, you'll get a 400 Bad Request error. For example:\n```\n{\n \"code\": \"keymanagement.service.InvalidScopes\",\n \"message\": \"Invalid scopes. Scopes must be contained in [READ, WRITE]\",\n \"contexts\": []\n\n}\n```\nIt would be allowed to remove one or both of the existing scopes, and later add one or both back.","summary":"Updates the allowed OAuth scopes associated with an app","operationId":"updateAllowedOAuthScopes","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/developer_email"},{"$ref":"#/components/parameters/app_name"},{"$ref":"#/components/parameters/consumer_key"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Keys"},"example":{"apiProducts":[{"apiproduct":"Hotels","status":"approved"}],"attributes":[{"name":"attribute1","value":"value1"}],"consumerKey":"<consumerKey>","consumerSecret":"<consumerSecret>","expiresAt":-1,"issuedAt":1523971974806,"scopes":["scope1","scope2"],"status":"approved"}}}},"400":{"description":"Bad request"}},"requestBody":{"description":"List of OAuth scopes.","content":{"application/json":{"schema":{"properties":{"scopes":{"description":"List of OAuth scopes.","type":"array","items":{"type":"string"}}}}}}}},"delete":{"tags":["Developer App Keys"],"description":"Deletes a consumer key that belongs to an app, and removes all API products associated with the app. Once deleted, the consumer key cannot be used to access any APIs.\n\nAfter you delete a consumer key, you may want to:\n\n* <a href=\"https://docs-edgeapis.apigee.io/docs/edge-apis-developer-app-keys/1/routes/organizations/%7Borg_name%7D/developers/%7Bdeveloper_email%7D/apps/%7Bapp_name%7D/keys/create/post\">Create a new consumer key and secret</a> for the developer app, and subsequently <a href=\"https://docs-edgeapis.apigee.io/docs/edge-apis-developer-app-keys/1/routes/organizations/%7Borg_name%7D/developers/%7Bdeveloper_email%7D/apps/%7Bapp_name%7D/keys/%7Bconsumer_key%7D/post\">add an API product to the key</a>.\n\n* <a href=\"https://docs-edgeapis.apigee.io/docs/developer-apps/1/routes/organizations/%7Borg_name%7D/developers/%7Bdeveloper_email%7D/apps/%7Bapp_name%7D/delete\">Delete the developer app</a>, if it is no longer required.","summary":"Delete key for a developer app","operationId":"deleteDevAppKey","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/developer_email"},{"$ref":"#/components/parameters/app_name"},{"$ref":"#/components/parameters/consumer_key"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Keys"},"example":{"apiProducts":[{"apiproduct":"Hotels","status":"approved"}],"attributes":[{"name":"attribute1","value":"value1"}],"consumerKey":"<consumerKey>","consumerSecret":"<consumerSecret>","expiresAt":-1,"issuedAt":1523971974806,"scopes":["scope1","scope2"],"status":"approved"}}}},"400":{"description":"Bad request"}}}},"/organizations/{org_name}/developers/{developer_email}/apps/{app_name}/keys/{consumer_key}/apiproducts/{apiproduct_name}":{"post":{"tags":["Developer","Developer App","Consumer Key"],"description":"Approves or revokes an API product for an API key.\nCall the API with the `action` query parameter set to `approve` or `revoke` (with no request body) and set the `Content-type` header to `application/octet-stream`. If successful, the HTTP status code for success is: `204 No Content`\n\nTo consume API resources defined in an API product, an app's consumer key must be approved and it must also be approved for that specific API product.\n\n**Notes**:\n* The API product must already be associated with the app.\n\n* Any access tokens associated with a revoked app key will remain active. However, Apigee Edge checks the status of the app key and if set to `revoked` it will not allow API calls to go through.\n\n* * **This API cannot be executed using the Try this API panel**.","summary":"Approve or Revoke API Product for an API Key","operationId":"approveRevokeAPIProductForDevAppKey","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/developer_email"},{"$ref":"#/components/parameters/app_name"},{"$ref":"#/components/parameters/consumer_key"},{"$ref":"#/components/parameters/apiproduct_name"},{"$ref":"#/components/parameters/action"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Keys"},"example":{"apiProducts":[{"apiproduct":"Hotels","status":"approved"}],"attributes":[{"name":"attribute1","value":"value1"}],"consumerKey":"<consumerKey>","consumerSecret":"<consumerSecret>","expiresAt":-1,"issuedAt":1523971974806,"scopes":["scope1","scope2"],"status":"approved"}}}},"400":{"description":"Bad request"}}},"delete":{"tags":["Developer App Keys"],"description":"Removes an API product from an app's consumer key, and thereby renders the app unable to access the API resources defined in that API product.\n\nNote that the consumer key itself still exists after this call. Only the association of the key with the API product is removed.","summary":"Remove API []roduct for a specific ley","operationId":"removeAPIProductForDevAppKey","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/developer_email"},{"$ref":"#/components/parameters/app_name"},{"$ref":"#/components/parameters/consumer_key"},{"$ref":"#/components/parameters/apiproduct_name"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Keys"},"example":{"apiProducts":[{"apiproduct":"Hotels","status":"approved"}],"attributes":[{"name":"attribute1","value":"value1"}],"consumerKey":"<consumerKey>","consumerSecret":"<consumerSecret>","expiresAt":-1,"issuedAt":1523971974806,"scopes":["scope1","scope2"],"status":"approved"}}}},"400":{"description":"Bad request"}}}}},"components":{"securitySchemes":{"Basic":{"type":"http","scheme":"basic","description":"Multi-factor authentication is not supported."},"OAuth":{"type":"apiKey","name":"Authorization","in":"header","description":"For OAuth, enter the following in the Key field: Bearer %your-token% (see https://docs.apigee.com/api-platform/system-administration/using-oauth2#get-the-tokens)"}},"parameters":{"org_name":{"in":"path","name":"org_name","required":true,"schema":{"type":"string"},"description":"Organization name."},"developer_email":{"in":"path","name":"developer_email","required":true,"schema":{"type":"string"},"description":"Email address of the developer."},"app_name":{"in":"path","name":"app_name","required":true,"schema":{"type":"string"},"description":"Application name."},"consumer_key":{"in":"path","name":"consumer_key","required":true,"schema":{"type":"string"},"description":"Consumer key."},"apiproduct_name":{"in":"path","name":"apiproduct_name","required":true,"schema":{"type":"string"},"description":"API product name."},"action":{"in":"query","name":"action","required":false,"schema":{"type":"string"},"description":"Set to `approve` or `revoke`."}},"schemas":{"Keys":{"description":"Consumer key and secret.","type":"object","properties":{"apiProducts":{"type":"array","description":"List of API products associated with an API key. Required when adding an API product to a key.","items":{"type":"object","properties":{"apiproduct":{"type":"string","description":"Name of the API product."},"status":{"type":"string","description":"Status of the API product. Valid values include `approved` or `revoked`."}}}},"attributes":{"type":"array","description":"List of attributes associated with an API key.","items":{"type":"object","properties":{"name":{"type":"string","description":"Name of the custom attribute."},"value":{"type":"string","description":"Value of the custom attribute."}}}},"consumerKey":{"description":"Consumer key.","type":"string"},"consumerSecret":{"description":"Consumer secret.","type":"string"},"expiresAt":{"type":"integer","description":"Time at which the consumer key and secret expire in milliseconds since epoch. Set to -1 to never expire."},"issuedAt":{"type":"integer","description":"Time at which the consumer key and secret were issues in millisenconds since epoch."},"scopes":{"type":"array","description":"List of OAuth scopes.","items":{"type":"string"}},"status":{"type":"string","description":"Status of the API key. Valid values include `approved` or `revoked`."}}}}}}
/ organizations / {org_name} / developers / {developer_email} / apps / {app_name} / keys / create
/ organizations / {org_name} / developers / {developer_email} / apps / {app_name} / keys / {consumer_key}
/ organizations / {org_name} / developers / {developer_email} / apps / {app_name} / keys / {consumer_key} / apiproducts / {apiproduct_name}
Organizations API OpenAPI	{"openapi":"3.0.0","servers":[{"url":"https://api.enterprise.apigee.com/v1"}],"info":{"title":"Organizations API","description":"Manage organizations. The base entity for an account on Apigee Edge, an organization is a container for all managed entities, including APIs, API products, developers, apps, environments, and so on.","version":"1.0"},"security":[{"Basic":[]},{"OAuth":[]}],"paths":{"/organizations":{"get":{"tags":["Organization"],"summary":"List organizations","description":"Lists all organizations. \n\n**Notes**: \n* **Apigee Edge for Private Cloud only**. If you are using Apigee Edge for Public Cloud, contact Apigee Support for assistance. \n* **This API cannot be executed using the Try this API panel**.","operationId":"listOrganizations","parameters":[],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}}},"400":{"description":"Bad request"}}},"post":{"tags":["Organization"],"summary":"Create an organization","description":"Creates an organization. \n\n**Notes**: \n* **Apigee Edge for Private Cloud only**. If you are using Apigee Edge for Public Cloud, contact Apigee Support for assistance. \n* **This API cannot be executed using the Try this API panel**.\n\nAfter you create the organization, you must: \n\n* <a href=\"/docs/organizations/1/routes/organizations/%7Borg_name%7D/pods/post\">Associate the organization with a pod</a>\n* Add an organization administrator\n\nEdge provides scripts and other tools that you can use as an alternative to making API calls directly. For example, for Edge 4.16.05 and later, see <a href=\"https://docs.apigee.com/private-cloud/latest/creating-organization-environment-and-virtual-host\">Creating an organization, environment, and virtual host</a>.","operationId":"createOrganization","parameters":[],"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Organization"},"example":{"createdAt":1394486446988,"createdBy":"noreply_admin@apigee.com","displayName":"myorg","environments":["prod","test","portal"],"lastModifiedAt":1590113466345,"lastModifiedBy":"admin@example.com","name":"mmyorg","properties":{"property":[{"name":"features.isCpsEnabled","value":"true"},{"name":"subscriptionType","value":"enterprise"}]},"type":"paid"}}}},"400":{"description":"Bad request"}},"requestBody":{"description":"Organization details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrganizationRequest"},"example":{"displayName":"myorg","environments":["prod","test","portal"],"name":"myorg","properties":{"property":[{"name":"features.isCpsEnabled","value":"true"},{"name":"subscriptionType","value":"enterprise"}]},"type":"paid"}}}}}},"/organizations/{org_name}":{"post":{"tags":["Organization"],"summary":"Update organization properties","description":"Updates organization properties. \n\n**Notes**: \n* **Apigee Edge for Private Cloud only**. If you are using Apigee Edge for Public Cloud, contact Apigee Support for assistance. \n* **This API cannot be executed using the Try this API panel**.\n\nSome Edge functionality is controlled by properties set on an organization. For example, when defining resource paths in API products, you can change the way Edge treats a single forward slash (/) by setting an organization property.\n\n**Caution**: When updating properties, you must pass all existing properties to the API, even if they are not being changed. If you omit existing properties from the payload in this API call, the properties are removed. To get the current list of properties for the environment, use the Get organization API. \n\nIf you attempt to set a property but it doesn't appear in the response payload, then the property must be set by a user in the system administrator role. For Apigee Edg for Public Cloud, contact Apigee Support for assistance with setting properties requiring system administrator role. \n\nSome properties in your organization are reserved and unchangable. For example:\n\n* `features.isMonetizationEnabled` - Monetization is a paid feature. You can't modify this value.\n\nWhen you update other organization properties, you must include any existing reserved properties and their current values in order for this update call to succeed.\n\nAvailable properties are described in the relevant sections of the Edge documentation.","operationId":"updateOrganizationProperties","parameters":[{"$ref":"#/components/parameters/org_name"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Organization"},"example":{"createdAt":1394486446988,"createdBy":"noreply_admin@apigee.com","displayName":"myorg","environments":["prod","test","portal"],"lastModifiedAt":1590113466345,"lastModifiedBy":"admin@example.com","name":"mmyorg","properties":{"property":[{"name":"subscriptionType","value":"enterprise"}]},"type":"paid"}}}},"400":{"description":"Bad request"}},"requestBody":{"description":"Organization details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrganizationProperties"},"example":{"properties":{"property":[{"name":"subscriptionType","value":"enterprise"}]}}}}}},"delete":{"tags":["Organization"],"summary":"Delete an organization","description":"Deletes an organization.\n\n**Notes**: \n* **Apigee Edge for Private Cloud only**. If you are using Apigee Edge for Public Cloud, contact Apigee Support for assistance. \n* **This API cannot be executed using the Try this API panel**.\n\nYou can only delete an organization after you have:\n\n* Deleted all virtual hosts in all environments in the organization\n* <a href=\"/docs/environments/1/routes/organizations/%7Borg_name%7D/environments/%7Benv_name%7D/delete\">Deleted all environments in the organization</a>\n* <a href=\"/docs/organizations/1/routes/organizations/%7Borg_name%7D/pods/post\">Disassociated the organization from all pods</a>","operationId":"deleteOrganization","parameters":[{"$ref":"#/components/parameters/org_name"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Organization"},"example":{"createdAt":1394486446988,"createdBy":"noreply_admin@apigee.com","displayName":"myorg","environments":["prod","test","portal"],"lastModifiedAt":1590113466345,"lastModifiedBy":"admin@example.com","name":"mmyorg","properties":{"property":[{"name":"features.isCpsEnabled","value":"true"},{"name":"subscriptionType","value":"enterprise"}]},"type":"paid"}}}},"400":{"description":"Bad request"}}},"get":{"tags":["Organization"],"summary":"Get organization","description":"Gets the profile of a specific organization.\n\nAn organization is the base container for all objects in an API provider's account on Apigee Edge. An organization contains API proxies, API products, apps, and developers, and the other entities. A user account is required for each organization for which you may be a member. (Most users will have an account in only one organization.) You pass in your credentials and the name of your organization with each API request you submit.\n\nIn the response, the value of the type property is \"trial\" if you are requesting information about an organization associated with a free developer account, and \"paid\" for a paid account. ","operationId":"getOrganization","parameters":[{"$ref":"#/components/parameters/org_name"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Organization"},"example":{"createdAt":1394486446988,"createdBy":"noreply_admin@apigee.com","displayName":"myorg","environments":["prod","test","portal"],"lastModifiedAt":1590113466345,"lastModifiedBy":"admin@example.com","name":"mmyorg","properties":{"property":[{"name":"features.isCpsEnabled","value":"true"},{"name":"subscriptionType","value":"enterprise"}]},"type":"paid"}}}},"400":{"description":"Bad request"}}}},"/organizations/{org_name}/pods":{"post":{"tags":["Organization","Pods"],"summary":"Associate or disassociate an organization and a pod","description":"Associates or disassociates an organization and a pod. \n\n**Notes**: \n* **Apigee Edge for Private Cloud only**. If you are using Apigee Edge for Public Cloud, contact Apigee Support for assistance. \n* **This API cannot be executed using the Try this API panel**.\n\nBy default, the name of the region is `dc-1` and the name of the pod is `gateway`. This names are set by the following properties in the Edge config file when you installed Edge:\n\n```\nMP_POD=gateway\nREGION=dc-1 \n```\n\nTo associate a pod, pass the following string: `region={region_name}&pod={pod_name}`\n\nTo disassociate a pod, pass the following string: `region={region_name}&pod={pod_name}&action=remove`\n\nFor more information, see the Edge installation instructions. ","operationId":"associatePod","parameters":[{"$ref":"#/components/parameters/org_name"}],"responses":{"200":{"description":"OK"},"400":{"description":"Bad request"}},"requestBody":{"description":"Pod details.","content":{"application/x-www-form-urlencoded":{"schema":{"type":"string"}}}}},"get":{"tags":["Organization","Pods"],"summary":"List pods associated with an organization","description":"Lists the pods associated with an organization. \n\n**Notes**: \n* **Apigee Edge for Private Cloud only**. If you are using Apigee Edge for Public Cloud, contact Apigee Support for assistance. \n* **This API cannot be executed using the Try this API panel**.","operationId":"getPods","parameters":[{"$ref":"#/components/parameters/org_name"}],"responses":{"200":{"description":"OK"},"400":{"description":"Bad request"}}}}},"components":{"securitySchemes":{"Basic":{"type":"http","scheme":"basic","description":"Multi-factor authentication is not supported."},"OAuth":{"type":"apiKey","name":"Authorization","in":"header","description":"For OAuth, enter the following in the Key field: Bearer %your-token% (see https://docs.apigee.com/api-platform/system-administration/using-oauth2#get-the-tokens)"}},"parameters":{"org_name":{"in":"path","name":"org_name","required":true,"schema":{"type":"string"},"description":"Organization name."}},"schemas":{"Organization":{"description":"Organization details.","type":"object","required":["name"],"properties":{"createdAt":{"format":"int32","description":"Output only. Time the organization was created in milliseconds since epoch.","type":"integer"},"createdBy":{"description":"Output only. Email address of the admin that created the organization.","type":"string"},"displayName":{"description":"Name of the organization used in the UI. Required when creating an organization.","type":"string"},"environments":{"description":"List of environments defined for the organization. ","type":"array","items":{"type":"string"}},"lastModifiedAt":{"format":"int32","description":"Output only. Time the organization was last modified in milliseconds since epoch.","type":"integer"},"lastModifiedBy":{"description":"Output only. Email of admin that last modified the organization.","type":"string"},"name":{"description":"Name of the organization. The organization name must contain lowercase letters only; it should not contain spaces, underscores, or periods.","type":"string"},"properties":{"description":"List of properties that can be used to customize the organization. ","type":"object","properties":{"property":{"description":"Organization property names and values.","type":"array","items":{"type":"object","properties":{"name":{"description":"Name of property.","type":"string"},"value":{"description":"Set to `\"true\"` to enable or `\"false\"` to disable the property.","type":"string"}}}}}},"type":{"description":"Type of subscription. Valid values are `paid` and `trial`. When creating an organization, set to `paid`. Required when creating an organization.","type":"string"}}},"OrganizationProperties":{"description":"Organization properties update request.","type":"object","properties":{"properties":{"description":"List of properties that can be used to customize the organization. ","type":"object","properties":{"property":{"description":"Organization property names and values.","type":"array","items":{"type":"object","properties":{"name":{"description":"Name of property.","type":"string"},"value":{"description":"Set to `\"true\"` to enable or `\"false\"` to disable the property.","type":"string"}}}}}}}},"OrganizationRequest":{"description":"Organization request.","type":"object","required":["name"],"properties":{"displayName":{"description":"Name of the organization used in the UI. Required when creating an organization.","type":"string"},"environments":{"description":"List of environments defined for the organization. ","type":"array","items":{"type":"string"}},"name":{"description":"Name of the organization. The organization name must contain lowercase letters only; it should not contain spaces, underscores, or periods.","type":"string"},"properties":{"description":"List of properties that can be used to customize the organization. ","type":"object","properties":{"property":{"description":"Organization property names and values.","type":"array","items":{"type":"object","properties":{"name":{"description":"Name of property.","type":"string"},"value":{"description":"Value of the property. For boolean property values, `true` to enable or `false` to disable the property.","type":"string"}}}}}},"type":{"description":"Type of subscription. Valid values are `paid` and `trial`. When creating an organization, set to `paid`. Required when creating an organization.","type":"string"}}}}}}
/ organizations
/ organizations / {org_name}
/ organizations / {org_name} / pods
OAuth 1.0a verifiers API OpenAPI	{"openapi":"3.0.0","servers":[{"url":"https://api.enterprise.apigee.com/v1"}],"info":{"title":"OAuth 1.0a verifiers API","description":"Manage OAuth verification codes. An OAuth 1.0 verifier is a verification code tied to the request token. Both the OAuth verifier and request token must be provided in exchange for an access token. ","version":"1.0"},"security":[{"Basic":[]},{"OAuth":[]}],"paths":{"/organizations/{org_name}/oauth1/verifiers":{"get":{"tags":["OAuth 1.0a"],"summary":"List OAuth 1.0a verifier code","description":"Lists OAuth 1.0a verifier codes and details for each verifier in an organization.","operationId":"listOAuth10RequestTokens","parameters":[{"$ref":"#/components/parameters/org_name"}],"responses":{"200":{"description":"OK"},"400":{"description":"Bad request"}}}},"/organizations/{org_name}/oauth1/verifiers/{verifier_code}":{"delete":{"tags":["OAuth 1.0a"],"summary":"Delete OAuth 1.0a verifier code","description":"Deletes an OAuth 1.0a verifier code.","operationId":"deleteAuth10RequestToken","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/verifier_code"}],"responses":{"200":{"description":"OK"},"400":{"description":"Bad request"}}},"post":{"tags":["OAuth 1.0a"],"summary":"Approve or revoke OAuth 1.0a verifier code","description":"Approve or revoke an OAuth 1.0a verfier code.","operationId":"ApproveRevokeUpdateOAuth10RequestTokes","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/verifier_code"}],"responses":{"200":{"description":"OK"},"400":{"description":"Bad request"}}},"get":{"tags":["OAuth 1.0a"],"summary":"Get OAuth 1.0a verifier code","description":"Gets details for an OAuth 1.0a verifier code","operationId":"getOAuth10RequestToken","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/verifier_code"}],"responses":{"200":{"description":"OK"},"400":{"description":"Bad request"}}}}},"components":{"securitySchemes":{"Basic":{"type":"http","scheme":"basic","description":"Multi-factor authentication is not supported."},"OAuth":{"type":"apiKey","name":"Authorization","in":"header","description":"For OAuth, enter the following in the Key field: Bearer %your-token% (see https://docs.apigee.com/api-platform/system-administration/using-oauth2#get-the-tokens)"}},"parameters":{"org_name":{"in":"path","name":"org_name","required":true,"schema":{"type":"string"},"description":"Organization name."},"verifier_code":{"in":"path","name":"verifier_code","required":true,"schema":{"type":"string"},"description":"Verifier code."}}}}
/ organizations / {org_name} / oauth1 / verifiers
/ organizations / {org_name} / oauth1 / verifiers / {verifier_code}
Developer apps API OpenAPI	{"openapi":"3.0.0","servers":[{"url":"https://api.enterprise.apigee.com/v1"}],"info":{"title":"Developer apps API","description":"Manage developers that register apps.","version":"1.0"},"security":[{"Basic":[]},{"OAuth":[]}],"paths":{"/organizations/{org_name}/developers/{developer_email}/apps":{"post":{"tags":["Developer","Developer App"],"summary":"Create developer app","description":"Creates an app associated with a developer, associates the app with an API product, and auto-generates an API key for the app to use in calls to API proxies inside the API product.\n\nThe name is the unique ID of the app that you can use in Edge API calls. The `DisplayName` (set with an attribute) is what appears in the Edge UI. If you don't provide a `DisplayName`, the name is used.\n\nThe `keyExpiresIn` property sets the expiration on the API key. If you don't set a value or set the value to `-1`, the API key never expires.\n\n**Ensure optimal API product and app security**\n\nAn organization-level property, `features.keymanagement.disable.unbounded.permissions`, strengthens the security of API products in verifying API calls. When the property is set to `true`, the following features are enforced.\n\n* **App creation**: When creating a developer or company app, the Edge API requires that the app be associated with an API product. (The Edge UI already enforces this.)\n\n\n* **API product configuration**: To create or update an API product, the API product must include at least one API proxy or a resource path in its definition.\n\n* **Runtime security**: API calls are rejected by an API product in the following situations:\n\n * An API product doesn't include at least one API proxy or resource path. \n\n * If the `flow.resource.name` variable in the message doesn't include a resource path that the API product can evaluate.\n\n * If the app making the API call isn't associated with an API product.\n\n\n**Note:** Setting this organization property requires system administrator privileges. Edge for Private Cloud system administrators can add this property when <a href=\"/docs/organizations/1/routes/organizations/%7Borg_name%7D/post\">updating organization properties</a>. If you are an Edge for Public Cloud user, contact Apigee Support to set the organization property.","operationId":"createDeveloperApp","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/developer_email"}],"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeveloperApp"},"example":{"appFamily":"default","appId":"123abc-456-def","attributes":[{"name":"ADMIN_EMAIL","value":"admin@example.com"},{"name":"DisplayName","value":"My App"},{"name":"Notes","value":"Notes for developer app"},{"name":"MINT_BILLING_TYPE","value":"POSTPAID"}],"callbackUrl":"example.com","createdAt":1568312504191,"createdBy":"ahamilton@example.com","credentials":[{"apiProducts":[{"apiproduct":"myproduct","status":"approved"}],"attributes":[],"consumerKey":"F91jQrfX6CKhyEheXFBL3gxxxxx","consumerSecret":"TLbUJFyzOlLxxxx","expiresAt":-1,"issuedAt":1568312504682,"scopes":[],"status":"approved"}],"developerId":"1234-abcd","lastModifiedAt":1568313405903,"lastModifiedBy":"ahamilton@example.com","name":"myapp","scopes":[],"status":"approved"}}}},"400":{"description":"Bad request"}},"requestBody":{"description":"Developer app details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeveloperAppRequest"},"example":{"apiProducts":["myProduct"],"attributes":[{"name":"ADMIN_EMAIL","value":"admin@example.com"},{"name":"DisplayName","value":"My App"},{"name":"Notes","value":"Notes for developer app"},{"name":"MINT_BILLING_TYPE","value":"POSTPAID"}],"callbackUrl":"example.com","name":"myapp","scopes":[],"status":"approved"}}}}},"get":{"tags":["Developer","Developer App"],"summary":"List developer apps","description":"Lists all apps created by a developer in an organization. Optionally, you can expand the response to include the profile for each app.\n\nWith Apigee Edge for Public Cloud:\n* A maximum of 100 developer apps are returned per API call.\n* You can paginate the list of developer apps returned using the `startKey` and `count` query parameters.","operationId":"listDeveloperApps","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/developer_email"},{"$ref":"#/components/parameters/expand"},{"$ref":"#/components/parameters/count"},{"$ref":"#/components/parameters/startKey"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}}},"400":{"description":"Bad request"}}}},"/organizations/{org_name}/developers/{developer_email}/apps/{app_name}":{"get":{"tags":["Developer","Developer App"],"summary":"Get developer app details","description":"Gets the profile of a specific developer app.","operationId":"getDeveloperApp","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/developer_email"},{"$ref":"#/components/parameters/app_name"},{"$ref":"#/components/parameters/query"},{"$ref":"#/components/parameters/entity"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeveloperApp"},"example":{"appFamily":"default","appId":"123abc-456-def","attributes":[{"name":"ADMIN_EMAIL","value":"admin@example.com"},{"name":"DisplayName","value":"My App"},{"name":"Notes","value":"Notes for developer app"},{"name":"MINT_BILLING_TYPE","value":"POSTPAID"}],"callbackUrl":"example.com","createdAt":1568312504191,"createdBy":"ahamilton@example.com","credentials":[{"apiProducts":[{"apiproduct":"myproduct","status":"approved"}],"attributes":[],"consumerKey":"F91jQrfX6CKhyEheXFBL3gxxxxx","consumerSecret":"TLbUJFyzOlLxxxx","expiresAt":-1,"issuedAt":1568312504682,"scopes":[],"status":"approved"}],"developerId":"1234-abcd","lastModifiedAt":1568313405903,"lastModifiedBy":"ahamilton@example.com","name":"myapp","scopes":[],"status":"approved"}}}},"400":{"description":"Bad request"}}},"put":{"tags":["Developer","Developer App"],"summary":"Update developer app","description":"Updates an existing developer app.\n\nYou can add an app to an API product with this API, which automatically generates an API key for the app to use when calling APIs in the product. (Alternatively, you can <a href=\"/docs/developer-app-keys/1/routes/organizations/%7Borg_name%7D/developers/%7Bdeveloper_email%7D/apps/%7Bapp_name%7D/keys/%7Bconsumer_key%7D/post\">add an API product to an existing key</a>.)\n\n**Note**: You must include all current attribute, API product, and callback values in the payload along with any changes you want to make; otherwise, the existing values are removed. To display the current values, <a href=\"/docs/developer-apps/1/routes/organizations/%7Borg_name%7D/developers/%7Bdeveloper_email%7D/apps/%7Bapp_name%7D/get\">get the developer app profile</a>. You cannot update the scopes associated with the app by using this API. Instead, use Update app scope API.\n\n**Apigee Edge for Public Cloud only**: OAuth access tokens and Key Management Service (KMS) entities (apps, developers, and API products) are cached for 180 seconds (current default). Any custom attributes associated with these entities also get cached for at least 180 seconds after the entity is accessed at runtime. Therefore, an `ExpiresIn` element on the OAuthV2 policy won't be able to expire an access token in less than 180 seconds.","operationId":"udpateDeveloperApp","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/developer_email"},{"$ref":"#/components/parameters/app_name"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeveloperApp"},"example":{"appFamily":"default","appId":"123abc-456-def","attributes":[{"name":"ADMIN_EMAIL","value":"admin@example.com"},{"name":"DisplayName","value":"My App"},{"name":"Notes","value":"Notes for developer app"},{"name":"MINT_BILLING_TYPE","value":"POSTPAID"}],"callbackUrl":"example.com","createdAt":1568312504191,"createdBy":"ahamilton@example.com","credentials":[{"apiProducts":[{"apiproduct":"myproduct","status":"approved"}],"attributes":[],"consumerKey":"F91jQrfX6CKhyEheXFBL3gxxxxx","consumerSecret":"TLbUJFyzOlLxxxx","expiresAt":-1,"issuedAt":1568312504682,"scopes":[],"status":"approved"}],"developerId":"1234-abcd","lastModifiedAt":1568313405903,"lastModifiedBy":"ahamilton@example.com","name":"myapp","scopes":[],"status":"approved"}}}},"400":{"description":"Bad request"}},"requestBody":{"description":"Developer app details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeveloperAppRequest"},"example":{"apiProducts":["myProduct"],"attributes":[{"name":"ADMIN_EMAIL","value":"admin@example.com"},{"name":"DisplayName","value":"My App"},{"name":"Notes","value":"Notes for developer app"},{"name":"MINT_BILLING_TYPE","value":"POSTPAID"}],"callbackUrl":"example.com","name":"myapp","scopes":[],"status":"approved"}}}}},"delete":{"tags":["Developer","Developer App"],"summary":"Delete developer app","description":"Deletes a developer app.\n\nWith Apigee Edge for Public Cloud, deletion of the developer app and associated artifacts happens asynchronously. The developer app is deleted immediately, but the resources associated with that developer app, such as app keys or access tokens, may take anywhere from a few seconds to a few minutes to be automatically deleted.","operationId":"deleteDeveloperApp","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/developer_email"},{"$ref":"#/components/parameters/app_name"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeveloperApp"},"example":{"appFamily":"default","appId":"123abc-456-def","attributes":[{"name":"ADMIN_EMAIL","value":"admin@example.com"},{"name":"DisplayName","value":"My App"},{"name":"Notes","value":"Notes for developer app"},{"name":"MINT_BILLING_TYPE","value":"POSTPAID"}],"callbackUrl":"example.com","createdAt":1568312504191,"createdBy":"ahamilton@example.com","credentials":[{"apiProducts":[{"apiproduct":"myproduct","status":"approved"}],"attributes":[],"consumerKey":"F91jQrfX6CKhyEheXFBL3gxxxxx","consumerSecret":"TLbUJFyzOlLxxxx","expiresAt":-1,"issuedAt":1568312504682,"scopes":[],"status":"approved"}],"developerId":"1234-abcd","lastModifiedAt":1568313405903,"lastModifiedBy":"ahamilton@example.com","name":"myapp","scopes":[],"status":"approved"}}}},"400":{"description":"Bad request"}}},"post":{"tags":["Developer","Developer App"],"summary":"Approve, revoke, or generate API key for developer app","description":"Approves, revokes, or generates an API key for a developer app. \n\nTo approve or revoke the API key for a developer app, set `status` to `approve` or `revoke` in the request body. \n\n**Note**: As a convenience, you can call the API with the `action` query parameter set to `approve` or `revoke` (with no request body) and set the `Content-type` header to `application/octet-stream`. In this case, the HTTP status code for success is: `204 No Content`\n\nTo generate a new consumer key and consumer secret for the developer app, pass the required details, such as API products, in the request body. Rather than replace an existing key, the API generates a new key. \n\nFor example, if you're using API key rotation, you can generate new keys with expiration times that overlap keys that will be out of rotation when they expire. You might also generate a new key/secret if the security of the original key/secret is compromised. After the new API key is generated, multiple key pairs will be associated with a single app. Each key pair has an independent status (revoked or approved) and an independent expiration time. Any non-expired, approved key can be used in an API call. You should revoke an API key that has been compromised.\n\n**Note**: You must include all current attribute and callback values in the payload; otherwise, the existing values are removed.\n\nIf you want to set the consumer key and consumer secret rather than having Edge generate them randomly, see <a href=\"https://docs.apigee.com/api-platform/publish/import-existing-consumer-keys-and-secrets\">Import existing consumer keys and secrets</a>. (However, that API does not let you set an expiration time.)","operationId":"approveRevokeGenerateAPIKey","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/developer_email"},{"$ref":"#/components/parameters/app_name"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeveloperApp"},"example":{"appFamily":"default","appId":"123abc-456-def","attributes":[{"name":"ADMIN_EMAIL","value":"admin@example.com"},{"name":"DisplayName","value":"My App"},{"name":"Notes","value":"Notes for developer app"},{"name":"MINT_BILLING_TYPE","value":"POSTPAID"}],"callbackUrl":"example.com","createdAt":1568312504191,"createdBy":"ahamilton@example.com","credentials":[{"apiProducts":[{"apiproduct":"myproduct","status":"approved"}],"attributes":[],"consumerKey":"F91jQrfX6CKhyEheXFBL3gxxxxx","consumerSecret":"TLbUJFyzOlLxxxx","expiresAt":-1,"issuedAt":1568312504682,"scopes":[],"status":"approved"}],"developerId":"1234-abcd","lastModifiedAt":1568313405903,"lastModifiedBy":"ahamilton@example.com","name":"myapp","scopes":[],"status":"approved"}}}},"400":{"description":"Bad request"}},"requestBody":{"description":"Developer app details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeveloperApp","example":{"appFamily":"default","appId":"123abc-456-def","attributes":[{"name":"ADMIN_EMAIL","value":"admin@example.com"},{"name":"DisplayName","value":"My App"},{"name":"Notes","value":"Notes for developer app"},{"name":"MINT_BILLING_TYPE","value":"POSTPAID"}],"callbackUrl":"example.com","createdAt":1568312504191,"createdBy":"ahamilton@example.com","credentials":[{"apiProducts":[{"apiproduct":"myproduct","status":"approved"}],"attributes":[],"consumerKey":"F91jQrfX6CKhyEheXFBL3gxxxxx","consumerSecret":"TLbUJFyzOlLxxxx","expiresAt":-1,"issuedAt":1568312504682,"scopes":[],"status":"approved"}],"developerId":"1234-abcd","lastModifiedAt":1568313405903,"lastModifiedBy":"ahamilton@example.com","name":"myapp","scopes":[],"status":"approved"}}}}}}},"/organizations/{org_name}/developers/{developer_email}/apps/{app_name}/attributes":{"post":{"tags":["Developer","Developer App"],"summary":"Update app attributes","description":"Updates app attributes.\n\nThis API replaces the current list of attributes with the attributes specified in the request body. This lets you update existing attributes, add new attributes, or delete existing attributes by omitting them from the request body.\n\n**Apigee Edge for Public Cloud only**: OAuth access tokens and Key Management Service (KMS) entities (apps, developers, and API products) are cached for 180 seconds (current default). Any custom attributes associated with these entities also get cached for at least 180 seconds after the entity is accessed at runtime. Therefore, an `ExpiresIn` element on the OAuthV2 policy won't be able to expire an access token in less than 180 seconds.","operationId":"updateDeveloperAppAttributes","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/developer_email"},{"$ref":"#/components/parameters/app_name"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Attributes"},"example":{"attribute":[{"name":"ADMIN_EMAIL","value":"admin@example.com"},{"name":"DisplayName","value":"My App"}]}}}},"400":{"description":"Bad request"}},"requestBody":{"description":"Developer app attributes.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Attributes"},"example":{"attribute":[{"name":"ADMIN_EMAIL","value":"admin@example.com"},{"name":"DisplayName","value":"My App"}]}}}}},"get":{"tags":["Developer","Developer App"],"summary":"Get developer app attributes","description":"Gets developer app attributes and their values.","operationId":"getDeveloperAppAttributes","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/developer_email"},{"$ref":"#/components/parameters/app_name"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Attributes"},"example":{"attribute":[{"name":"ADMIN_EMAIL","value":"admin@example.com"},{"name":"DisplayName","value":"My App"}]}}}},"400":{"description":"Bad request"}}}},"/organizations/{org_name}/developers/{developer_email}/apps/{app_name}/attributes/{attribute_name}":{"post":{"tags":["Developer","Developer App"],"summary":"Update an App Attribute","description":"Updates a developer app attribute. \n\n**Apigee Edge for Public Cloud only**: OAuth access tokens and Key Management Service (KMS) entities (apps, developers, and API products) are cached for 180 seconds (current default). Any custom attributes associated with these entities also get cached for at least 180 seconds after the entity is accessed at runtime. Therefore, an `ExpiresIn` element on the OAuthV2 policy won't be able to expire an access token in less than 180 seconds.","operationId":"updateDeveloperAppAttribute","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/developer_email"},{"$ref":"#/components/parameters/app_name"},{"$ref":"#/components/parameters/attribute_name"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Attribute"},"example":{"name":"DisplayName","value":"My App"}}}},"400":{"description":"Bad request"}},"requestBody":{"description":"Developer app attribute.","content":{"application/json":{"schema":{"properties":{"value":{"type":"string","description":"Value of attribute."}}},"example":{"name":"DisplayName","value":"MyApp"}}}}},"delete":{"tags":["Developer","Developer App"],"summary":"Delete app attribute","description":"Deletes a developer app attribute.","operationId":"deleteDeveloperAppAttribute","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/developer_email"},{"$ref":"#/components/parameters/app_name"},{"$ref":"#/components/parameters/attribute_name"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Attribute"},"example":{"name":"DisplayName","value":"My App"}}}},"400":{"description":"Bad request"}}},"get":{"tags":["Developer","Developer App"],"summary":"Get developer app attribute","description":"Gets a developer app attribute.","operationId":"getDeveloperAppAttribute","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/developer_email"},{"$ref":"#/components/parameters/app_name"},{"$ref":"#/components/parameters/attribute_name"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Attribute"},"example":{"name":"DisplayName","value":"My App"}}}},"400":{"description":"Bad request"}}}}},"components":{"securitySchemes":{"Basic":{"type":"http","scheme":"basic","description":"Multi-factor authentication is not supported."},"OAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"parameters":{"org_name":{"in":"path","name":"org_name","required":true,"schema":{"type":"string"},"description":"Organization name."},"developer_email":{"in":"path","name":"developer_email","required":true,"schema":{"type":"string"},"description":"Email address for the developer."},"app_name":{"in":"path","name":"app_name","required":true,"schema":{"type":"string"},"description":"Name of the application."},"attribute_name":{"in":"path","name":"attribute_name","required":true,"schema":{"type":"string"},"description":"Name of the attribute."},"count":{"in":"query","name":"count","required":false,"schema":{"type":"integer"},"description":"**Apigee Edge for Public Cloud only**. Number of developer apps to return in the API call. The limit is 100. Use with the `startKey` parameter to provide more targeted filtering."},"keyStatus":{"in":"query","name":"keyStatus","required":false,"schema":{"type":"string"},"description":"**Apigee Edge for Private Cloud only**. Filter list to apps with specific key status. Valid values include `approved`, `pending`, or `revoked`."},"expand":{"in":"query","name":"expand","required":false,"schema":{"type":"boolean"},"description":"Flag that specifies whether to view expanded details for each app. Set to `true` to view expanded details. Defaults to `false`. Not applicable if you use the `count` or `startKey` query parameters."},"startKey":{"in":"query","name":"startKey","required":false,"schema":{"type":"string"},"description":"**Apigee Edge for Public Cloud only**. ID of the app from which to start displaying the list of apps.\n\nFor example, if the unfiltered list includes the following app names:\n\n```\n\"developerApp1\",\n\"developerApp2\",\n\"developerApp3\"\n```\n\nIf you set the `startKey` to `developerApp2`, the list will include:\n\n```\n\"developerApp2\",\n\"developerApp3\"\n```"},"query":{"in":"query","name":"query","required":false,"schema":{"type":"string"},"description":"**Apigee Edge for Private Cloud**: Set to `count` and use in conjuction with `entity` to return number of API resources that have been approved for access by a developer app."},"entity":{"in":"query","name":"entity","required":false,"schema":{"type":"string"},"description":"**Apigee Edge for Private Cloud**: Set to `apiresources` and use in conjuction with `count` to return number of API resources that have been approved for access by a developer app."}},"schemas":{"DeveloperApp":{"description":"Developer app details.","type":"object","required":["name"],"properties":{"appFamily":{"description":"Output only. App family.","type":"string"},"apiProducts":{"description":"List of API products to which the app is associated (when creating or updating an app). The name of the API product is the name returned when you <a href=\"/docs/api-products/1/routes/organizations/%7Borg_name%7D/apiproducts/get\">list API products</a>. For example, if the Display Name of the API product in the Edge UI is `Premium API Product`, then the name is `premium-api-product` (all lowercase with spaces replaced by hyphens). You can add API products later when you <a href=\"/docs/developer-apps/1/routes/organizations/%7Borg_name%7D/developers/%7Bdeveloper_email%7D/apps/%7Bapp_name%7D/put\">update the developer app</a>. Existing API products are listed in the `credentials` array.","type":"array","items":{"type":"string"}},"appId":{"description":"Output only. ID of the app.","type":"string"},"attributes":{"description":"List of attributes used for customizing profile information or for app-specific processing. With Apigee Edge for Public Cloud, the custom attribute limit is 18. Note the folowing:\n\n* `DisplayName` is an attribute that provides the app name in the Edge UI. This can be different from the name (unique ID) of the app.\n* `Notes` attribute lets you add notes about the developer app.\n* Any other arbitrary name/value pairs you create are included as custom attributes.","type":"array","items":{"$ref":"#/components/schemas/Attribute"}},"callbackUrl":{"description":"Callback URL used by OAuth 2.0 authorization servers to communicate authorization codes back to apps. See the OAuth 2.0 documentation for more details.","type":"string"},"createdAt":{"format":"int32","description":"Output only. Time the app was created in milliseconds since epoch.","type":"integer"},"createdBy":{"description":"Output only. Email address of the developer that created the app.","type":"string"},"credentials":{"description":"Output only. Set of credentials for the app. Credentials are API key/secret pairs associated with API products.","type":"array","items":{"type":"object","properties":{"apiProducts":{"description":"Name and status of API products associated with the app.","type":"array","items":{"type":"object","$ref":"#/components/schemas/APIProductRef"}},"attributes":{"description":"List of attributes.","type":"array","items":{"$ref":"#/components/schemas/Attribute"}},"consumerKey":{"description":"Consumer API key.","type":"string"},"consumerSecret":{"description":"Consumer secret.","type":"string"},"expiresAt":{"description":"Time the credentials expire in milliseconds since epoch.","format":"int32","type":"integer"},"issuedAt":{"format":"int32","description":"Time the credentials were issued in milliseconds since epoch.","type":"integer"},"scopes":{"description":"OAuth scopes.","type":"array","items":{"type":"string"}},"status":{"description":"Status of the credentials.","type":"string"}}}},"developerId":{"description":"Output only. ID of the developer.","type":"string"},"keyExpiresIn":{"type":"integer","format":"int32","description":"Lifetime of the consumer key that will be generated for the developer app, in milliseconds. The default value, `-1`, indicates an infinite validity period. Once set, the expiration can't be updated."},"lastModifiedAt":{"format":"int32","description":"Output only. Last modified time as milliseconds since epoch.","type":"integer"},"lastModifiedBy":{"description":"Output only. Email of developer that last modified the app.","type":"string"},"name":{"description":"Name of the developer app. Required when creating a developer app; not required when updating a developer app. \n\nThe name is used to uniquely identify the app for this organization and developer. Names must begin with an alphanumeric character and can contain letters, numbers, spaces, and the following characters: `. _ # - $ %`. While you can use spaces in the name, we recommend that you use camel case, underscores, or hyphens instead. Otherwise, you will have to URL-encode the app name when you need to include it in the URL of other Edge API calls. See the <a href=\"https://docs.apigee.com/api-platform/reference/naming-guidelines\">naming restrictions</a>. ","type":"string"},"scopes":{"description":"Scopes to apply to the app. The specified scope names must already exist on the API product that you associate with the app.","type":"array","items":{"type":"string"}},"status":{"description":"Status of the credential.","type":"string"}}},"DeveloperAppRequest":{"description":"Developer app request.","type":"object","required":["name"],"properties":{"apiProducts":{"description":"List of API products to which the app is associated (when creating or updating an app). The name of the API product is the name returned when you <a href=\"/docs/api-products/1/routes/organizations/%7Borg_name%7D/apiproducts/get\">list API products</a>. For example, if the Display Name of the API product in the Edge UI is `Premium API Product`, then the name is `premium-api-product` (all lowercase with spaces replaced by hyphens). You can add API products later when you <a href=\"/docs/developer-apps/1/routes/organizations/%7Borg_name%7D/developers/%7Bdeveloper_email%7D/apps/%7Bapp_name%7D/put\">update the developer app</a>. Existing API products are listed in the `credentials` array.","type":"array","items":{"type":"string"}},"attributes":{"description":"List of attributes used for customizing profile information or for app-specific processing. With Apigee Edge for Public Cloud, the custom attribute limit is 18. Note the folowing:\n\n* `DisplayName` is an attribute that provides the app name in the Edge UI. This can be different from the name (unique ID) of the app.\n* `Notes` attribute lets you add notes about the developer app.\n* Any other arbitrary name/value pairs you create are included as custom attributes.","type":"array","items":{"$ref":"#/components/schemas/Attribute"}},"callbackUrl":{"description":"Callback URL used by OAuth 2.0 authorization servers to communicate authorization codes back to apps. See the OAuth 2.0 documentation for more details.","type":"string"},"keyExpiresIn":{"type":"integer","format":"int32","description":"Lifetime of the consumer key that will be generated for the developer app, in milliseconds. The default value, `-1`, indicates an infinite validity period. Once set, the expiration can't be updated."},"name":{"description":"Name of the developer app. Required when creating a developer app; not required when updating a developer app. \n\nThe name is used to uniquely identify the app for this organization and developer. Names must begin with an alphanumeric character and can contain letters, numbers, spaces, and the following characters: `. _ # - $ %`. While you can use spaces in the name, we recommend that you use camel case, underscores, or hyphens instead. Otherwise, you will have to URL-encode the app name when you need to include it in the URL of other Edge API calls. See the <a href=\"https://docs.apigee.com/api-platform/reference/naming-guidelines\">naming restrictions</a>. ","type":"string"},"scopes":{"description":"Scopes to apply to the app. The specified scope names must already exist on the API product that you associate with the app.","type":"array","items":{"type":"string"}},"status":{"description":"Status of the credential.","type":"string"}}},"Attributes":{"description":"Developer app attributes.","type":"object","properties":{"attribute":{"type":"array","items":{"$ref":"#/components/schemas/Attribute"}}}},"Attribute":{"description":"Developer app attribute name and value.","type":"object","properties":{"name":{"description":"Name of attribute.","type":"string"},"value":{"description":"Value of attribute.","type":"string"}}},"APIProductRef":{"description":"API product information.","type":"object","properties":{"apiproduct":{"description":"Name of API product.","type":"string"},"status":{"description":"Status of API product.","type":"string"}}}}}}
/ organizations / {org_name} / developers / {developer_email} / apps
/ organizations / {org_name} / developers / {developer_email} / apps / {app_name}
/ organizations / {org_name} / developers / {developer_email} / apps / {app_name} / attributes
/ organizations / {org_name} / developers / {developer_email} / apps / {app_name} / attributes / {attribute_name}
OAuth 1.0a Access Tokens API OpenAPI	{"openapi":"3.0.0","servers":[{"url":"https://api.enterprise.apigee.com/v1"}],"info":{"title":"OAuth 1.0a Access Tokens API","description":"Manage OAuth 1.0a access tokens.","version":"1.0"},"security":[{"Basic":[]},{"OAuth":[]}],"paths":{"/organizations/{org_name}/oauth1/accesstokens":{"get":{"tags":["OAuth 1.0a"],"summary":"Get OAuth 1.0a access token count","description":"Gets the OAuth 1.0a access token count in an organization.","operationId":"getOAuth10aAccessTokenCount","parameters":[{"$ref":"#/components/parameters/org_name"}],"responses":{"200":{"description":"OK"},"400":{"description":"Bad request"}}}},"/organizations/{org_name}/oauth1/accesstokens/{access_token}":{"delete":{"tags":["OAuth 1.0a"],"summary":"Delete OAuth 1.0a access token","description":"Deletes the specified OAuth 1.0a access token.","operationId":"deleteOAuth10aAccessToken","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/access_token"}],"responses":{"200":{"description":"OK"},"400":{"description":"Bad request"}}},"post":{"tags":["OAuth 1.0a"],"summary":"Approve, revoke, or update an OAuth 1.0a access token","description":"Enables you to perform one of the following tasks:\n\n* Approve or revoke the specified access token by setting the `action` query parameter to `approve` or `revoke`.\n* Update the attributes for the specified access token. The `scope` property is required. Only specify other properties if you want to update them.","operationId":"updateOAuth10aAccessToken","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/access_token"},{"$ref":"#/components/parameters/action"}],"responses":{"200":{"description":"OK"},"400":{"description":"Bad request"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessTokenAttributes"}}}}},"get":{"tags":["OAuth 1.0a"],"summary":"Get OAuth 1.0a access token","description":"Gets details for an OAuth 1.0 access token.\n\n**DEPRECATED**: This API is deprecated and will be removed from Apigee Edge in a future release. ","operationId":"getOAuth10aAccessToken","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/access_token"}],"responses":{"200":{"description":"OK"},"400":{"description":"Bad request"}}}},"/organizations/{org_name}/developers/{developer_email}/apps/{app_name}/oauth1accesstokens":{"get":{"tags":["OAuth 1.0a"],"summary":"Get OAuth 1.0 access tokens count for a developer app","description":"Gets the OAuth 1.0 access tokens count for the specified developer app.","operationId":"getOAuth10aAccessTokenCountDevApp","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/developer_email"},{"$ref":"#/components/parameters/app_name"}],"responses":{"200":{"description":"OK"},"400":{"description":"Bad request"}}}},"/organizations/{org_name}/developers/{developer_email}/apps/{app_name}/keys/{consumer_key}/oauth1accesstokens":{"get":{"tags":["OAuth 1.0a"],"summary":"Get OAuth 1.0a access token count for a developer app key","description":"Gets the OAuth 1.0a access tokens count for the specified developer app key.","operationId":"getOAuth10aAccessTokenCountDevAppKey","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/developer_email"},{"$ref":"#/components/parameters/app_name"},{"$ref":"#/components/parameters/consumer_key"}],"responses":{"200":{"description":"OK"},"400":{"description":"Bad request"}}}}},"components":{"securitySchemes":{"Basic":{"type":"http","scheme":"basic","description":"Multi-factor authentication is not supported."},"OAuth":{"type":"apiKey","name":"Authorization","in":"header","description":"For OAuth, enter the following in the Key field: Bearer %your-token% (see https://docs.apigee.com/api-platform/system-administration/using-oauth2#get-the-tokens)"}},"parameters":{"org_name":{"in":"path","name":"org_name","required":true,"schema":{"type":"string"},"description":"Organization name."},"access_token":{"in":"path","name":"access_token","required":true,"schema":{"type":"string"},"description":"Access token."},"developer_email":{"in":"path","name":"developer_email","required":true,"schema":{"type":"string"},"description":"Email address of the developer."},"app_name":{"in":"path","name":"app_name","required":true,"schema":{"type":"string"},"description":"Name of the developer application."},"consumer_key":{"in":"path","name":"consumer_key","required":true,"schema":{"type":"string"},"description":"Consumer key."},"action":{"in":"query","name":"action","required":false,"schema":{"type":"string"},"description":"Set to `approve` or `revoke`."}},"schemas":{"AccessTokenAttributes":{"description":"Update access token attributes.","type":"object","properties":{"attributes":{"description":"Attributes used to extend the default profile.","type":"array","items":{"$ref":"#/components/schemas/NameValue"}},"scope":{"description":"List of scopes associated with the access token, validated at runtime against scopes defined in API product.","type":"string"}}},"NameValue":{"description":"Name/value attribute pairs.","type":"object","properties":{"name":{"description":"Name of attribute.","type":"string"},"value":{"description":"Value of attribute.","type":"string"}}}}}}
/ organizations / {org_name} / oauth1 / accesstokens
/ organizations / {org_name} / oauth1 / accesstokens / {access_token}
/ organizations / {org_name} / developers / {developer_email} / apps / {app_name} / oauth1accesstokens
/ organizations / {org_name} / developers / {developer_email} / apps / {app_name} / keys / {consumer_key} / oauth1accesstokens
OAuth 2.0 Access Tokens API OpenAPI	{"openapi":"3.0.0","servers":[{"url":"https://api.enterprise.apigee.com/v1"}],"info":{"title":"OAuth 2.0 Access Tokens API","description":"Apigee Edge uses access tokens to define a user's permissions for modifying and using a specific API. When you apply OAuth 2.0 to the API, Edge checks the request for an access token. If an access token is present, and the API is within the scope of the access token, you are allowed to access the API. \nPrerequisites to use this API call are:\n\n* The API provider has created an organization.\n* You are a registered developer.\n* You have created an app.\n* You have a valid consumer key.\n* An access token has been generated.","version":"1.0"},"security":[{"Basic":[]},{"OAuth":[]}],"paths":{"/organizations/{org_name}/oauth2/accesstokens/{access_token}":{"delete":{"tags":["OAuth 2.0"],"summary":"Delete OAuth 2.0 access token","description":"Deletes the specified OAuth 2.0 access token.","operationId":"deleteOAuth2AccessToken","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/access_token"}],"responses":{"200":{"description":"OK"},"400":{"description":"Bad request"}}},"post":{"tags":["OAuth 2.0"],"summary":"Approve, revoke, or update an OAuth 2.0 access token","description":"Enables you to perform one of the following tasks:\n* **Approve or revoke an OAuth 2.0 access token**. Set the `action` query parameter to `approve` or `revoke`, respectively. Optionally, set the `cascade` query parameter to `true` to cause refresh tokens associated with the access token to be affected by the same action. \n* **Update the OAuth 2.0 access token attributes**. Pass the attribute details in the request body. Only attributes specified in the request body are updated. Any other existing attributes are not affected.","operationId":"updateOAuth2AccessToken","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/access_token"},{"$ref":"#/components/parameters/action"},{"$ref":"#/components/parameters/cascade"}],"responses":{"200":{"description":"OK"},"400":{"description":"Bad request"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessTokenAttributes"}}}}},"get":{"tags":["OAuth 2.0"],"summary":"Get OAuth 2.0 access token","description":"Gets details for an OAuth 2.0 access token. ","operationId":"getOAuth20AccessToken","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/access_token"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessTokenDetails"}}}},"400":{"description":"Bad request"}}}},"/organizations/{org_name}/oauth2/revoke":{"post":{"tags":["OAuth 2.0"],"summary":"Revoke OAuth2 access token by end user or app ID","description":"Revokes OAuth2 access tokens associated by specifying the end user ID, developer app ID, or both. \n\n**Notes**:\n\n* This API is available to **Apigee Edge Enterprise plans only**. \n* This feature must be enabled, as described in <a href=\"https://docs.apigee.com/api-platform/security/oauth/enable-retrieval-and-revocation-oauth-20-access-tokens-end-user-id-app-id-or-both\">Enable retrieval and revocation of OAuth 2.0 access tokens by end user ID, app id, or both</a>.\n* You must HTML-encode the end user ID and app ID when you pass them in this API. \n* This API requires the `orgadmin` or `opsadmin` role.\n\nIf you use this API to revoke an access token, the associated refresh token will be revoked if the `cascade` parameter is set to `true`. Otherwise, the refresh token status will be unchanged.\n\nWhen your API request has been successfully sent, the API returns the HTTP status code `202 Accepted` and the response displays the number of OAuth 2.0 tokens that were submitted for revocation. The `202 Accepted` status does not mean that the revocation has been completed. For example, you may do a `GET` for access tokens after performing a revoke and see an OAuth 2.0 access token that should have been revoked. This may just mean that the revocation process is still in-progress. The processing time depends on the number of access tokens being revoked.\n\n**Revoke by app ID**\n\nAll OAuth2 access tokens generated by Edge include the ID of the developer app associated with the token, and you can revoke tokens based on that ID using this API. To get a list of developer app IDs for a specific developer, see <a href=\"/docs/developer-apps/1/routes/organizations/%7Borg_name%7D/developers/%7Bdeveloper_email%7D/apps/get\">List developer apps</a>. To find tokens based on developer app ID, see <a href=\"/docs/oauth-20-access-tokens-api/1/routes/organizations/%7Borg_name%7D/oauth2/search/get\">Get OAuth2 access token by end user or app ID</a>. \n\n**Revoke by end user ID**\n\nIn some cases, you may wish to revoke tokens associated with the ID of the user to whom they were issued (the actual user of the client app). This ID has to be present in the token. Adding an end user ID to an access token requires some preliminary setup in the OAuthV2 policy that generates the token. For details, see <a href=\"https://docs.apigee.com/api-platform/security/oauth/enable-retrieval-and-revocation-oauth-20-access-tokens-end-user-id-app-id-or-both\">Enable retrieval and revocation of OAuth 2.0 access tokens by end user ID, app id, or both</a>. You can use another API to search for tokens based on end user ID. See <a href=\"/docs/oauth-20-access-tokens-api/1/routes/organizations/%7Borg_name%7D/oauth2/search/get\">Get OAuth2 access token by end user or app ID</a>. \n\nFor example, you may wish to provide a way for users to revoke their own access tokens. ","operationId":"revokeOAuth20AccessTokenEndUserAppId","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/enduser"},{"$ref":"#/components/parameters/app"},{"$ref":"#/components/parameters/cascade"}],"responses":{"202":{"description":"Accepted","content":{"application/json":{"schema":{"type":"integer"}}}},"400":{"description":"Bad request"}}}},"/organizations/{org_name}/oauth2/search":{"get":{"tags":["OAuth 2.0"],"summary":"Get OAuth2 Access Token by End User or App ID","description":"Gets an OAuth2 access token by end user ID, developer app ID, or both. \n\n**Notes**:\n\n* This API is available to **Apigee Edge Enterprise plans only**.\n* For information on enabling this feature, see <a href=\"https://docs.apigee.com/api-platform/security/oauth/enable-retrieval-and-revocation-oauth-20-access-tokens-end-user-id-app-id-or-both\">Enable retrieval and revocation of OAuth 2.0 access tokens by end user ID, app id, or both</a>.\n* This API requires the `orgadmin` or `opsadmin` role.\n\n**Search by app ID**\n\nAll OAuth2 access tokens generated by Edge include the ID of the developer app associated with the token, and you can search for tokens based on that ID using this API. To get a list of developer app IDs for a specific developer, see <a href=\"/docs/developer-apps/1/routes/organizations/%7Borg_name%7D/developers/%7Bdeveloper_email%7D/apps/get\">List developer apps</a>.\n\n**Search by end user ID**\n\nIn some cases, you may wish to search for tokens based on the ID of the user to whom the token was issued (the actual user of the client app). This ID has to be available as a flow variable when the token is generated by the OAuthV2 policy. You can pass this ID as a query parameter or in a header with the access token request, or you can retrieve it from an external identity provider, as may be the case with the password grant type. \n\nFor example, you may wish to provide a way for users to discover which third-party apps they've authorized and to revoke their own access tokens for those apps. To search for tokens by user, you must first configure the OAuthV2 policy to insert a user ID into the token when it is created. This setup is described in <a href=\"https://docs.apigee.com/api-platform/security/oauth/enable-retrieval-and-revocation-oauth-20-access-tokens-end-user-id-app-id-or-both\">Enable retrieval and revocation of OAuth 2.0 access tokens by end user ID, app id, or both</a>.\n\n**Use start and next to navigate through multiple pages of results**\n\nWhen the number of access tokens returned exceeds the `limit` defined in the query parameters, you will have multiple \"pages,\" or lists, of access token results to scroll through. Use the `start` query parameter and `next` response payload element to navigate through the results.\n\nFor example, let's say your first call returns the following response payload:\n\n```\n{\n \"list\" : [ \"0XXX0wX4vX43lXXXX4f8e3504oXX\", \"0oXzhtXdXX8kXgeXv22zv7bXXdj4\", \n (...+8 more)],\n \"meta\" : {\n \"limit\" : 10,\n \"next\" : \"3gwbXXX2thXXzX7XXdyOblXtXyXX\",\n \"query\" : {\n \"endUser\" : \"{enduser}\"\n },\n \"start\" : \"\",\n \"totalResults\" : 100\n }\n}\n```\nNote that the request limited the results returned per page to 10 and that the total number of results is 100. You need a way to navigate through nine more pages of results to see all 100 results.\n\nTo do this, make another call with the `next` value in the output above as the `start` query parameter. The request URL may look something like this:\n```\nhttps://api.enterprise.apigee.com/v1/organizations/{org-name}/oauth2/search?enduser={enduser}&start=3gwbXXX2thXXzX7XXdyOblXtXyXX&limit=10\n```\nSee the response payload below:\n\n``` {\n \"list\" : [ \"3gwbXXX2thXXzX7XXdyOblXtXyXX\", \"482XXv8XfXiouXvcXq6geXXkXXXX\", \n (...+8 more)],\n \"meta\" : {\n \"limit\" : 10,\n \"next\" : \"Xa8mXidgXXtXXXcXnX8XXeXgXX6X\",\n \"query\" : {\n \"endUser\" : \"{enduser}\"\n },\n \"start\" : \"3gwbXXX2thXXzX7XXdyXblXtXyXX\",\n \"totalResults\" : 100\n \n }\n}\n```\nNote that this next page of 10 results shown above starts with the access token requested by the `start` parameter. To see the next 10 results, make the same call, just using the `next` value in the output above as the start value as shown in bold below:\n\n``` https://api.enterprise.apigee.com/v1/organizations/{org-name}/oauth2/search?enduser={enduser}&start=Xa8mXidgXXtXXXcXnX8XXeXgXX6X&limit=10 ```\n\nYou can page through each set of results by repeating this pattern of calls.\n\n**Response error details**\n\nThe following describes common errors and what they mean.\n\n* `keymanagement.service.app_id_not_found`: An app ID provided in the query parameters was not found.\n* `parameters_missing`: An end user ID provided in the query parameters was not found.\n* `InvalidValueForLimitParam`: The `limit` value provided in the query parameters exceeds the value of the `oauth_max_search_limit` property defined in your `keymanagement.properties` files for your management server and message processor.\n* `UnsupportedOperationRevoke`: If this feature isn't <a href=\"https://docs.apigee.com/api-platform/security/oauth/enable-retrieval-and-revocation-oauth-20-access-tokens-end-user-id-app-id-or-both\">enabled</a>, you'll get an `UnsupportedOperationRevoke` error.","operationId":"getOAuth2AccessTokenEndUserAppId","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/enduser"},{"$ref":"#/components/parameters/app"},{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/start"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessToken"}}}},"400":{"description":"Bad"}}}}},"components":{"securitySchemes":{"Basic":{"type":"http","scheme":"basic","description":"Multi-factor authentication is not supported."},"OAuth":{"type":"apiKey","name":"Authorization","in":"header","description":"For OAuth, enter the following in the Key field: Bearer %your-token% (see https://docs.apigee.com/api-platform/system-administration/using-oauth2#get-the-tokens)"}},"parameters":{"org_name":{"in":"path","name":"org_name","required":true,"schema":{"type":"string"},"description":"Organization name."},"access_token":{"in":"path","name":"access_token","required":true,"schema":{"type":"string"},"description":"Access token. "},"developer_email":{"in":"path","name":"developer_email","required":true,"schema":{"type":"string"},"description":"Email address of the developer."},"app_name":{"in":"path","name":"app_name","required":true,"schema":{"type":"string"},"description":"App name."},"action":{"in":"query","name":"action","required":false,"schema":{"type":"string"},"description":"Set to `approve` or `revoke`."},"cascade":{"in":"query","name":"cascade","required":false,"schema":{"type":"string"},"description":"Flag that specifies whether the refresh token associated with the access token is also approved or revoked. Set to `true` to approve or revoke the refresh token. Defaults to `false`."},"enduser":{"in":"query","name":"enduser","required":false,"schema":{"type":"string"},"description":"ID of the end user for which you want to get or revoke OAuth 2.0 access tokens. This value is not required, but you must query by either `enduser` or `app`."},"app":{"in":"query","name":"app","required":false,"schema":{"type":"string"},"description":"ID of the developer app for which you want to get or revoke OAuth 2.0 access tokens. This value is not required, but you must query by either `enduser` or `app`."},"limit":{"in":"query","name":"limit","required":false,"schema":{"type":"string"},"description":"Number of OAuth2 access token results you want to display per page of results. Defaults to `10`.\n\n**Note**: You cannot retrieve more results that the number defined by the `oauth_max_search_limit` property in your `keymanagement.properties` files for your management server and message processor."},"start":{"in":"query","name":"start","required":false,"schema":{"type":"string"},"description":"Access token from which to start displaying. When the number of access tokens returned exceeds the limit value, use `start` to navigate the multiple pages, or lists of results."}},"schemas":{"AccessTokenAttributes":{"description":"Update access token attributes.","type":"object","properties":{"attributes":{"description":"Attributes used to extend the default profile.","type":"array","items":{"$ref":"#/components/schemas/NameValue"}},"scope":{"description":"List of scopes associated with the access token, validated at runtime against scopes defined in API product.","type":"string"}}},"NameValue":{"description":"Name/value attribute pairs.","type":"object","properties":{"name":{"description":"Name of attribute.","type":"string"},"value":{"description":"Value of attribute.","type":"string"}}},"AccessToken":{"description":"Access token.","type":"object","properties":{"list":{"type":"array","description":"List of OAuth 2.0 access codes for the end user ID or app ID defined in the request.","items":{"type":"string"}},"meta":{"type":"object","description":"Search metadata","properties":{"limit":{"type":"integer","description":"Total number of results included."},"next":{"type":"string","description":"When the number of access tokens returned exceeds the limit defined in the query parameters, this property displays the value of the next access token to be displayed in the list. Use this value to navigate through multiple \"pages,\" or lists of results."},"query":{"type":"object","description":"Query details."},"start":{"type":"string","description":"Access token from which to start displaying content."},"totalResults":{"type":"string","description":"Total number of OAuth2 access codes associated with the specified end user ID or app ID."}}}}},"AccessTokenDetails":{"description":"Access token details.","type":"object","properties":{"apiproducts":{"type":"array","description":"List of API products associated with the OAuth 2.0 access token.","items":{"type":"string"}},"app":{"type":"string","description":"App."},"appId":{"type":"string","description":"App ID."},"attributes":{"type":"array","description":"List of attributes used to extend the default profile.","items":{"type":"string"}},"clientId":{"type":"string","description":"Client ID."},"createdAt":{"type":"integer","description":"Time at which the OAuth 2.0 access token was created in milliseconds since epoch."},"expiresAt":{"type":"integer","description":"Time at which the OAuth 2.0 access token expires in milliseconds since epoch."},"grantType":{"type":"string","description":"OAuth 2.0 grant type."},"issuedAt":{"type":"integer","description":"Time at which the OAuth 2.0 access token was issued in milliseconds since epoch."},"lastModifiedAt":{"type":"integer","description":"Time at which the OAuth 2.0 access token was last modified in milliseconds since epoch."},"refreshCount":{"type":"integer","description":"OAuth 2.0 token refresh count."},"scope":{"type":"string","description":"Scope associated with the access token, validated at runtime against scopes defined in API product."},"status":{"type":"string","description":"Status of the OAuth 2.0 access token."},"token":{"type":"string","description":"Token value."},"tokenType":{"type":"string","description":"Token type."}}}}}}
/ organizations / {org_name} / oauth2 / accesstokens / {access_token}
/ organizations / {org_name} / oauth2 / revoke
/ organizations / {org_name} / oauth2 / search
Companies API OpenAPI	{"openapi":"3.0.0","servers":[{"url":"https://api.enterprise.apigee.com/v1"}],"info":{"title":"Companies API","description":"Manage companies in an organization.\n\nA company is a collection of developers managed as a single entity. A company can be any grouping that is appropriate to your organization, for example, business unit, product line, or division. Grouping developers into companies is useful when your goal is to work with multiple developers associated under a single corporate entity for billing purposes, for example.\n\nCompanies are optional. It not required that the developers in your organization are associated with a company. Note that a developer is always a single entity, uniquely identified by the email element.","version":"1.0"},"security":[{"Basic":[]},{"OAuth":[]}],"paths":{"/organizations/{org_name}/companies":{"post":{"tags":["Company"],"summary":"Create company","description":"Creates a company in an organization.\n\nThe company is always created with a status of `active`. To set the status explicitly, see <a href=\"/docs/companies/1/routes/organizations/%7Borg_name%7D/companies/%7Bcompany_name%7D/put\">Update a company</a>.\n\nTo set the company's billing type (`PREPAID` or `POSTPAID`), make sure the organization profile is configured to support your setting (for example, set to accept `BOTH`). See <a href=\"https://docs.apigee.com/monetization/content/edit-organization-profile\">Edit the organization profile</a>.\n\nFor a list of attributes that are supported for monetization, see <a href=\"https://docs.apigee.com/api-platform/publish/adding-developers-your-api-product#monetization-attributes\">Configuring monetization attibutes</a>.","operationId":"createCompany","parameters":[{"$ref":"#/components/parameters/org_name"}],"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Company"},"example":{"apps":[],"name":"altostrat","displayName":"Altostrat","organization":"myorg","status":"active","attributes":[{"name":"ADMIN_EMAIL","value":"admin@example.com"},{"name":"MINT_BILLING_TYPE","value":"POSTPAID"}],"createdAt":1395455596595,"createdBy":"admin@altostrat.com","lastModifiedAt":1395455596595,"lastModifiedBy":"admin@altostrat.com"}}}},"400":{"description":"Bad request"}},"requestBody":{"description":"Company configuration.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompanyRequest"},"example":{"name":"altostrat","displayName":"Altostrat","attributes":[{"name":"ADMIN_EMAIL","value":"admin@example.com"},{"name":"MINT_BILLING_TYPE","value":"POSTPAID"}]}}}}},"get":{"tags":["Company"],"summary":"List companies","description":"Lists all companies in an organization. Optionally, you can return an expanded list of companies, displaying a full profile for each company in the organization.\n\n**With Apigee Edge for Public Cloud**:\n* The maximum number of companies returned is **1000**.\n* You can paginate the list of companies returned using the `startKey` and `count` query parameters","operationId":"listCompanies","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/expand"},{"$ref":"#/components/parameters/startKey"},{"$ref":"#/components/parameters/count"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"oneOf":[{"type":"array","items":{"type":"string"}},{"$ref":"#/components/schemas/Companies"}]},"example":["company","company2"]}}},"400":{"description":"Bad request"}}}},"/organizations/{org_name}/companies/{company_name}":{"get":{"tags":["Company"],"summary":"Get company details","description":"Gets company details.","operationId":"getCompany","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/company_name"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Company"},"example":{"apps":[],"name":"altostrat","displayName":"Altostrat","organization":"myorg","status":"active","attributes":[{"name":"ADMIN_EMAIL","value":"admin@example.com"},{"name":"MINT_BILLING_TYPE","value":"POSTPAID"}],"createdAt":1395455596595,"createdBy":"admin@altostrat.com","lastModifiedAt":1395455596595,"lastModifiedBy":"admin@altostrat.com"}}}},"400":{"description":"Bad request"}}},"delete":{"tags":["Company"],"summary":"Delete company","description":"Deletes a company.","operationId":"deleteCompany","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/company_name"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Company"},"example":{"apps":[],"name":"altostrat","displayName":"Altostrat","organization":"myorg","status":"active","attributes":[{"name":"ADMIN_EMAIL","value":"admin@example.com"},{"name":"MINT_BILLING_TYPE","value":"POSTPAID"}],"createdAt":1395455596595,"createdBy":"admin@altostrat.com","lastModifiedAt":1395455596595,"lastModifiedBy":"admin@altostrat.com"}}}},"400":{"description":"Bad request"}}},"put":{"tags":["Company"],"summary":"Update a company.","description":"Updates an existing company.\n\nSend the complete company record as a payload with any changes you want to make. For a list of attributes that are supported for monetization, see <a href=\"https://docs.apigee.com/api-platform/publish/adding-developers-your-api-product#monetization-attributes\">Configuring monetization attibutes</a>.\n\nTo update the status of a company, set the `action` query parameter to `active` or `inactive` and `Content-type` to `application/octet-stream`. If you set the status to `inactive`, you cannot access the developers and apps associated with the company. In this case, the API returns a `204: No Content` status.\n\n**Notes**:\n* You cannot update the status of a company by passing the value in the request body.\n* Currently, updating the status of a company cannot be executed using the **Try this API panel**.\n\nIf you want to change the company's billing type (`PREPAID` or `POSTPAID`), make sure the organization profile is configured to support your setting (for example, set to accept `BOTH`). See <a href=\"https://docs.apigee.com/monetization/content/edit-organization-profile\">Edit the organization profile</a>.","operationId":"updateCompany","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/company_name"},{"$ref":"#/components/parameters/action"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Company"},"example":{"apps":[],"name":"altostrat","displayName":"Altostrat","organization":"myorg","status":"active","attributes":[{"name":"ADMIN_EMAIL","value":"admin@example.com"},{"name":"MINT_BILLING_TYPE","value":"POSTPAID"}],"createdAt":1395455596595,"createdBy":"admin@altostrat.com","lastModifiedAt":1395455596595,"lastModifiedBy":"admin@altostrat.com"}}}},"204":{"description":"No Content (status update)"},"400":{"description":"Bad request"}},"requestBody":{"description":"Updated company configuration.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompanyRequest"},"example":{"name":"altostrat","displayName":"Altostrat","attributes":[{"name":"ADMIN_EMAIL","value":"admin@example.com"},{"name":"MINT_BILLING_TYPE","value":"POSTPAID"}]}}}}}}},"components":{"securitySchemes":{"Basic":{"type":"http","scheme":"basic","description":"Multi-factor authentication is not supported."},"OAuth":{"type":"apiKey","name":"Authorization","in":"header","description":"For OAuth, enter the following in the Key field: Bearer %your-token% (see https://docs.apigee.com/api-platform/system-administration/using-oauth2#get-the-tokens)"}},"parameters":{"org_name":{"in":"path","name":"org_name","required":true,"schema":{"type":"string"},"description":"Organization name."},"company_name":{"in":"path","name":"company_name","required":true,"schema":{"type":"string"},"description":"Company name."},"action":{"in":"query","name":"action","required":false,"schema":{"type":"string"},"description":"Set to `active` or `inactive`."},"expand":{"in":"query","name":"expand","required":false,"schema":{"type":"boolean"},"description":"Flag that specifies whether to expand details. Set to `true` to expand details. Defaults to `false`."},"count":{"in":"query","name":"count","required":false,"schema":{"type":"string"},"description":"**Apigee Edge for Public Cloud only**: Number of companies to return in the list. The maximum limit is **1000**. Use with the `startkey` to provide more targeted filtering."},"startKey":{"in":"query","name":"startKey","required":false,"schema":{"type":"string"},"description":"**Apigee Edge for Public Cloud only**. Name of the company from which to start displaying the list of companies.\n\nFor example, if the an unfiltered list returns:\n\n```\ncompany1\ncompany2\ncompany3\n```\n\nIf your `startKey` is `company1`, the returned list will be:\n\n```\ncompany2\ncompany3\n```"}},"schemas":{"Companies":{"description":"List of companies.","type":"object","properties":{"company":{"type":"array","items":{"$ref":"#/components/schemas/Company"}}}},"Company":{"description":"Company.","type":"object","properties":{"apps":{"type":"array","description":"Output only. Apps associated with the company.","items":{"type":"string"}},"name":{"description":"Name of the company. Required when creating a company.\n**Notes**:\n* Company names must use a unique sequence of characters, regardless of case. For example, if you create a company named `CompanyA` and subsequently attempt to create a company named `companya`, an error is thrown.\n* Do not set the company name to `0` (number or string). This value is not supported and will cause unexpected results.\nSee <a href=\"https://docs.apigee.com/api-platform/reference/naming-guidelines\">naming restrictions</a>.","type":"string"},"displayName":{"type":"string","description":"Display name for the company."},"organization":{"type":"string","description":"Output only. Organization name."},"status":{"type":"string","description":"Output only. Status of the company. Valid values are `active` or `inactive`. Defaults to `active` when creating the company. To change the value, see Update a company."},"attributes":{"type":"array","description":"Name/value formatted attributes used to extend the default company profile.\n**Note**: With Apigee Edge for Public Cloud, the custom attribute limit is 18.","items":{"type":"object","properties":{"name":{"type":"string","description":"Name of the attribute."},"value":{"type":"string","description":"Value of the attribute."}}}},"createdAt":{"description":"Output only. Time when the company was last modified in seconds since epoch.","type":"integer"},"lastModifiedAt":{"description":"Output only. Time when the company was last modified in seconds since epoch.","type":"integer"},"lastModifiedBy":{"description":"Output only. Email address of developer that last modified the company.","type":"string"}}},"CompanyRequest":{"description":"Company.","type":"object","properties":{"name":{"description":"Name of the company. See <a href=\"https://docs.apigee.com/api-platform/reference/naming-guidelines\">naming restrictions</a>. Required when creating a company.","type":"string"},"displayName":{"type":"string","description":"Display name for the company."},"attributes":{"type":"array","description":"Name/value formatted attributes used to extend the default company profile.\n**Note**: With Apigee Edge for Public Cloud, the custom attribute limit is 18.","items":{"type":"object","properties":{"name":{"type":"string","description":"Name of the attribute."},"value":{"type":"string","description":"Value of the attribute."}}}}}}}}}
/ organizations / {org_name} / companies
/ organizations / {org_name} / companies / {company_name}
Caches API OpenAPI	{"openapi":"3.0.0","servers":[{"url":"https://api.enterprise.apigee.com/v1"}],"info":{"title":"Caches API","description":"A cache is a lightweight persistence store that can be used by policies or code executing on Apigee Edge. To support data segregation, cache resources are scoped to environments. For more information, see <a href=\"https://docs.apigee.com/api-platform/cache/manage-caches-environment\">Creating and editing an environment cache</a>.","version":"0.0.1"},"security":[{"basic":[]},{"oauth2":[]}],"paths":{"/organizations/{org_name}/environments/{env_name}/caches":{"get":{"tags":["Cache"],"summary":"List caches in an environment","description":"Lists caches in an environment.","operationId":"listCaches","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/env_name"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}}},"400":{"description":"Bad request"}}},"post":{"tags":["Cache"],"summary":"Create a cache in an environment","description":"Creates a cache in an environment.\nCaches are created per environment. For data segregation, a cache created in 'test', for example, cannot be accessed by API proxies deployed in 'prod'.\nTo create a cache with the default settings, pass an empty request body.","operationId":"createCache","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/env_name"},{"$ref":"#/components/parameters/name"}],"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Cache"}}}},"400":{"description":"Bad request"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Cache"}}},"description":"Cache details."}}},"/organizations/{org_name}/environments/{env_name}/caches/{cache_name}":{"put":{"tags":["Cache"],"summary":"Update a cache in an environment","description":"Updates a cache in an environment.\nYou must specify the complete definition of the cache, including the properties that you want to change and the ones that retain their current value. Any properties omitted from the request body are reset to their default value. Get information about the cache to view the current value of all properties, then pass the full set and change only those that you want to update.","operationId":"updateCache","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/env_name"},{"$ref":"#/components/parameters/cache_name"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Cache"}}}},"400":{"description":"Bad request"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Cache"}}},"description":"Cache details."}},"delete":{"tags":["Cache"],"summary":"Delete a cache","description":"Deletes a cache.","operationId":"deleteCache","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/env_name"},{"$ref":"#/components/parameters/cache_name"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Cache"}}}},"400":{"description":"Bad request"}}},"get":{"tags":["Cache"],"summary":"Get information about a cache","description":"Gets information about a cache.","operationId":"getCache","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/env_name"},{"$ref":"#/components/parameters/cache_name"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Cache"}}}},"400":{"description":"Bad request"}}}},"/organizations/{org_name}/environments/{env_name}/caches/{cache_name}/entries":{"post":{"tags":["Cache"],"summary":"Clear all cache entries","description":"Clears all cache entries.","operationId":"clearCacheEntries","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/env_name"},{"$ref":"#/components/parameters/cache_name"},{"$ref":"#/components/parameters/action"}],"responses":{"200":{"description":"OK","content":{"application/octet-stream":{"schema":{"$ref":"#/components/schemas/ClearCache"}}}},"400":{"description":"Bad request"}}}},"/organizations/{org_name}/environments/{env_name}/caches/{cache_name}/entries/{entry}":{"post":{"tags":["Cache"],"summary":"Clear a cache entry","description":"Clears a cache entry, which is identified by the full CacheKey prefix and value. For more on cache keys, see <a href=\"https://docs.apigee.com/api-platform/reference/policies/working-cachekeys\">Working with cache keys</a>.\n\nTo learn how to clear a cache using policies, see <a href=\"https://docs.apigee.com/docs/api-services/reference/optimize-performance-using-cache\">Example: General purpose caching</a>.\n\nTo use the API call, specify the complete **CacheKey** (any Prefix and KeyFragments) and the value of the entry that you want to clear.\n\nFor example, for the following Cache entry:\n\n```\napifactory__test__cacheforecast__8__default__12797282\n```\nClear the cache entry with the following endpoint:\n\n```\nhttps://api.enterprise.apigee.com/v1/organization/apifactory/environment/test/caches/cacheforecast/entries/apifactory__test__cacheforecast__8__default__1279728?action=clear\n```\n\nCacheKey is specified in the Cache or ResponseCache policy responsible for interacting with the specified Cache resource.","operationId":"clearCacheEntry","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/env_name"},{"$ref":"#/components/parameters/cache_name"},{"$ref":"#/components/parameters/entry"}],"responses":{"200":{"description":"OK"},"400":{"description":"Bad request"}}}}},"components":{"securitySchemes":{"basic":{"type":"http","scheme":"basic"},"oauth2":{"type":"oauth2","description":"<a href=\"https://docs.apigee.com/api-platform/system-administration/management-api-tokens\">Get an OAuth2 token</a>.","flows":{"password":{"tokenUrl":"https://login.apigee.com/oauth/token"}}}},"parameters":{"org_name":{"in":"path","name":"org_name","required":true,"schema":{"type":"string"},"description":"Name of organization."},"env_name":{"in":"path","name":"env_name","required":true,"schema":{"type":"string"},"description":"Name of environment."},"cache_name":{"in":"path","name":"cache_name","required":true,"schema":{"type":"string"},"description":"Name of cache. Restrict the characters used in the name to the following: A-Za-z0-9._\\-$ %."},"entry":{"in":"path","name":"entry","required":true,"schema":{"type":"string"},"description":"Name of cache entry."},"name":{"in":"query","name":"name","required":true,"schema":{"type":"string"},"description":"Name of the cache."},"action":{"in":"query","name":"action","required":true,"schema":{"type":"string"},"description":"Action to take against the entries in the specified cache. The only valid value is 'clear'."}},"schemas":{"Cache":{"description":"Cache details.","type":"object","properties":{"compression":{"description":"Deprecated. Size threshold above which cache entries will be compressed. If not specified, compression is disabled.","type":"object","properties":{"minimumSizeInKB":{"description":"Size threshold, in KBs, above which cache entries will be compressed.","type":"integer"}}},"description":{"description":"Description of the cache resource.","type":"string"},"diskSizeInMB":{"description":"Deprecated. This value is ignored. Disk space used for the cache in MBs.","type":"integer","default":0},"distributed":{"description":"Output only. Flag that specifies whether the cache is distributed.","type":"string","default":true},"expirySettings":{"description":"Enables different expiration mechanisms to be applied to entries in the cache. Cache entries can be expired a certain number of seconds after creation, at a specific time of day each day, or on a specific date.","type":"object","properties":{"expirySetting":{"type":"object","properties":{"value":{"type":"string","description":"Specified as `ss`, `hh:mm:ss`, or `mm-dd-yyyy`."}},"description":"Set to one of the following: `timeoutInSec`, `timeOfDay` or `expiryDate`."},"valuesNull":{"type":"boolean","description":"The Populate cache policy also lets you set expiry settings. The `valuesNull` property controls which expiry settings are applied for each entry.\n\n* If `valuesNull = false` (default), expiry settings in the PopulateCache policy are used.\n\n* If `valuesNull = true`, expiry settings in the PopulateCache policy are ignored.","default":false}}},"inMemorySizeInKB":{"description":"Deprecated. This value is ignored. Size threshold, in KBs, above which cache entries will be compressed.","type":"integer","default":0},"maxElementsInMemory":{"description":"Deprecated. Maximum number of entries the cache keeps in memory. Upon reaching the maximum limit the entries are evicted using the LRU algorithm.","type":"integer","default":0},"maxElementsOnDisk":{"description":"Deprecated. This value is ignored. Upon reaching the max limit the entries are evicted using the LRU algorithm.","type":"integer","default":0},"name":{"description":"Output only. Name of cache.","type":"string"},"overflowToDisk":{"description":"Flag that specifies to overflow the in-memory cache to disk.","type":"string","default":false},"persistent":{"description":"Deprecated. This value is ignored. Use expirySettings.","type":"boolean","default":false},"skipCacheIfElementSizeInKBExceeds":{"description":"Size limit, in KBs, for cache entries. Data exceeding the limit will not be cached.","type":"integer"}},"example":{"description":"My cache","diskSizeInMB":0,"distributed":true,"expirySettings":{"expiryDate":{"value":"09-18-2021"},"valuesNull":"true"},"inMemorySizeInKB":0,"maxElementsInMemory":0,"maxElementsOnDisk":0,"name":"mycache","overflowToDisk":false,"persistent":false,"skipCacheIfElementSizeInKBExceeds":1000}},"ClearCache":{"description":"Clear cache.","type":"object","properties":{"action":{"description":"Action. Set to `ClearCacheEntries`."},"resourceName":{"description":"Name of cache."}}}}}}
/ organizations / {org_name} / environments / {env_name} / caches
/ organizations / {org_name} / environments / {env_name} / caches / {cache_name}
/ organizations / {org_name} / environments / {env_name} / caches / {cache_name} / entries
/ organizations / {org_name} / environments / {env_name} / caches / {cache_name} / entries / {entry}
Data masks API OpenAPI	{"openapi":"3.0.0","servers":[{"url":"https://api.enterprise.apigee.com/v1"}],"info":{"title":"Data masks API","description":"Filter data from trace sessions. \n\nApigee Edge enables developers to capture message content to enable runtime debugging of APIs calls. In many cases, API traffic contains sensitive data, such as credit cards or personally identifiable health information (PHI) that needs to filtered out of the captured message content. Mask configurations enable you to specify data that will be filtered out of trace sessions. Masking configurations can be set globally (at the organization-level) or locally (at the API proxy level).","version":"1.0"},"security":[{"Basic":[]},{"OAuth":[]}],"paths":{"/organizations/{org_name}/apis/{api_name}/maskconfigs":{"get":{"tags":["Mask Config"],"summary":"List data masks defined for an API proxy","description":"Lists data masks defined for an API Proxy.","operationId":"listDataMasks","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/api_name"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"type":"string","description":"Data masks."}}}}},"400":{"description":"bad input parameter"}}},"post":{"tags":["Mask Config"],"summary":"Create data mask for an API proxy","description":"Creates a data mask for an API proxy.\n\nYou can capture message content to assist in runtime debugging of APIs calls. In many cases, API traffic contains sensitive data, such as credit cards or personally identifiable health information (PHI) that needs to filtered out of the captured message content.\n\nData masks enable you to specify data that will be filtered out of trace sessions. Data masking is only enabled when a trace session (also called a *debug* session) is enabled for an API proxy. If no trace session are enabled on an API proxy, then the data will not be masked.\n\nMask configurations enable you to identify sensitive data in the following sources:\n\n* **XML payloads**: Using `XPath`, identify XML elements to be filtered from request or response message payloads.\n* **JSON payloads**: Using `JSONPath`, identify JSON properties to be filtered from request or response message payloads.\n* **Flow variables**: Specify a list of variables that should be masked in debug output.\n\nTo understand the structure of a data mask and examples of calling the API, see <a href=\"https://docs.apigee.com/api-platform/security/data-masking#maskingsensitivedata\">Data masking and hiding</a>.","operationId":"createDataMaskAPIProxy","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/api_name"}],"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataMask"},"example":{"namespaces":[{"_prefix":"myco","__text":"http://example.com"}],"xPathsRequest":"-'/myco:Greeting/myco:User'","xPathsResponse":"-'/myco:Greeting/myco:User'","jSONPathsRequest":"-'$.store.book[*].author'","JSONPathsResponse":"-'$.store.book[*].author'","XPathsFault":"-'/myco:Greeting/myco:User'","jSONPathsFault":"-'$.store.book[*].author'","variables":["request.header.user-agent","request.formparam.password"],"name":"default"}}}},"400":{"description":"Bad request"}},"requestBody":{"content":{"application/xml":{"schema":{"$ref":"#/components/schemas/DataMaskXML"},"example":{"MaskDataConfiguration":{"Namespaces":{"Namespace":{"_prefix":"myco","__text":"http://example.com"}},"XPathsRequest":{"XPathRequest":"/myco:Greeting/myco:User"},"XPathsResponse":{"XPathResponse":"/myco:Greeting/myco:User"},"JSONPathsRequest":{"JSONPathRequest":"$.store.book[*].author"},"JSONPathsResponse":{"JSONPathResponse":"$.store.book[*].author"},"XPathsFault":{"XPathFault":"/myco:Greeting/myco:User"},"JSONPathsFault":{"JSONPathFault":"$.store.book[*].author"},"Variables":{"Variable":["request.header.user-agent","request.formparam.password"]},"_name":"default"}}},"application/json":{"schema":{"$ref":"#/components/schemas/DataMask"},"example":{"namespaces":[{"_prefix":"myco","__text":"http://example.com"}],"xPathsRequest":"-'/myco:Greeting/myco:User'","xPathsResponse":"-'/myco:Greeting/myco:User'","jSONPathsRequest":"-'$.store.book[*].author'","JSONPathsResponse":"-'$.store.book[*].author'","XPathsFault":"-'/myco:Greeting/myco:User'","jSONPathsFault":"-'$.store.book[*].author'","variables":["request.header.user-agent","request.formparam.password"],"name":"default"}}}}}},"/organizations/{org_name}/apis/{api_name}/maskconfigs/{maskconfig_name}":{"get":{"tags":["Mask Config"],"summary":"Get data mask defined for an API proxy","description":"Gets the details for a data mask defined for an API proxy.","operationId":"GetDataMaskDetailsAPIProxy","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/api_name"},{"$ref":"#/components/parameters/maskconfig_name"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataMask"},"example":{"namespaces":[{"_prefix":"myco","__text":"http://example.com"}],"xPathsRequest":"-'/myco:Greeting/myco:User'","xPathsResponse":"-'/myco:Greeting/myco:User'","jSONPathsRequest":"-'$.store.book[*].author'","JSONPathsResponse":"-'$.store.book[*].author'","XPathsFault":"-'/myco:Greeting/myco:User'","jSONPathsFault":"-'$.store.book[*].author'","variables":["request.header.user-agent","request.formparam.password"],"name":"default"}}}},"400":{"description":"bad input parameter"}}},"delete":{"tags":["Mask Config"],"summary":"Delete data mask defined for an API proxy","description":"Deletes a data mask defined for an API Proxy.","operationId":"DeleteDataMaskAPIProxy","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/api_name"},{"$ref":"#/components/parameters/maskconfig_name"}],"responses":{"204":{"description":"No Content"},"400":{"description":"bad input parameter"}}}},"/organizations/{org_name}/maskconfigs":{"get":{"tags":["Mask Config"],"summary":"List data masks defined for an organization","description":"Lists data masks defined for an organization.","operationId":"ListDataMarkOrg","parameters":[{"$ref":"#/components/parameters/org_name"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"type":"string","description":"Data masks."}}}}},"400":{"description":"bad input parameter"}}},"post":{"tags":["Mask Config"],"summary":"Create data mask for an organization","description":"Creates a data mask for an organization.\n\nYou can capture message content to assist in runtime debugging of APIs calls. In many cases, API traffic contains sensitive data, such as credit cards or personally identifiable health information (PHI) that needs to filtered out of the captured message content.\n\nData masks enable you to specify data that will be filtered out of trace sessions. Data masking is only enabled when a trace session (also called a *debug* session) is enabled for an API proxy. If no trace session are enabled on an API proxy, then the data will not be masked.\n\nMask configurations enable you to identify sensitive data in the following sources:\n\n* **XML payloads**: Using `XPath`, identify XML elements to be filtered from request or response message payloads.\n* **JSON payloads**: Using `JSONPath`, identify JSON properties to be filtered from request or response message payloads.\n* **Flow variables**: Specify a list of variables that should be masked in debug output.\n\nTo understand the structure of a data mask and examples of calling the API, see <a href=\"https://docs.apigee.com/api-platform/security/data-masking#maskingsensitivedata\">Data masking and hiding</a>.","operationId":"createDataMaskOrg","parameters":[{"$ref":"#/components/parameters/org_name"}],"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataMask"},"example":{"namespaces":[{"_prefix":"myco","__text":"http://example.com"}],"xPathsRequest":"-'/myco:Greeting/myco:User'","xPathsResponse":"-'/myco:Greeting/myco:User'","jSONPathsRequest":"-'$.store.book[*].author'","JSONPathsResponse":"-'$.store.book[*].author'","XPathsFault":"-'/myco:Greeting/myco:User'","jSONPathsFault":"-'$.store.book[*].author'","variables":["request.header.user-agent","request.formparam.password"],"name":"default"}}}},"400":{"description":"Bad request"}},"requestBody":{"content":{"application/xml":{"schema":{"$ref":"#/components/schemas/DataMaskXML"},"example":{"MaskDataConfiguration":{"Namespaces":{"Namespace":{"_prefix":"myco","__text":"http://example.com"}},"XPathsRequest":{"XPathRequest":"/myco:Greeting/myco:User"},"XPathsResponse":{"XPathResponse":"/myco:Greeting/myco:User"},"JSONPathsRequest":{"JSONPathRequest":"$.store.book[*].author"},"JSONPathsResponse":{"JSONPathResponse":"$.store.book[*].author"},"XPathsFault":{"XPathFault":"/myco:Greeting/myco:User"},"JSONPathsFault":{"JSONPathFault":"$.store.book[*].author"},"Variables":{"Variable":["request.header.user-agent","request.formparam.password"]},"_name":"default"}}},"application/json":{"schema":{"$ref":"#/components/schemas/DataMask"},"example":{"namespaces":[{"_prefix":"myco","__text":"http://example.com"}],"xPathsRequest":"-'/myco:Greeting/myco:User'","xPathsResponse":"-'/myco:Greeting/myco:User'","jSONPathsRequest":"-'$.store.book[*].author'","JSONPathsResponse":"-'$.store.book[*].author'","XPathsFault":"-'/myco:Greeting/myco:User'","jSONPathsFault":"-'$.store.book[*].author'","variables":["request.header.user-agent","request.formparam.password"],"name":"default"}}}}}},"/organizations/{org_name}/maskconfigs/{maskconfig_name}":{"get":{"tags":["Mask Config"],"summary":"Get data mask defined for an organization","description":"Gets the details for a data mask defined for an organization.","operationId":"getDataMaskOrg","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/maskconfig_name"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataMask"},"example":{"namespaces":[{"_prefix":"myco","__text":"http://example.com"}],"xPathsRequest":"-'/myco:Greeting/myco:User'","xPathsResponse":"-'/myco:Greeting/myco:User'","jSONPathsRequest":"-'$.store.book[*].author'","JSONPathsResponse":"-'$.store.book[*].author'","XPathsFault":"-'/myco:Greeting/myco:User'","jSONPathsFault":"-'$.store.book[*].author'","variables":["request.header.user-agent","request.formparam.password"],"name":"default"}}}},"400":{"description":"bad input parameter"}}},"delete":{"tags":["Mask Config"],"summary":"Delete data mask defined for an organization","description":"Deletes a data mask defined for an organization.","operationId":"deleteDataMaskOrg","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/maskconfig_name"}],"responses":{"204":{"description":"No Content"},"400":{"description":"bad input parameter"}}}}},"components":{"securitySchemes":{"Basic":{"type":"http","scheme":"basic","description":"Multi-factor authentication is not supported."},"OAuth":{"type":"apiKey","name":"Authorization","in":"header","description":"For OAuth, enter the following in the Key field: Bearer %your-token% (see https://docs.apigee.com/api-platform/system-administration/using-oauth2#get-the-tokens)"}},"parameters":{"org_name":{"in":"path","name":"org_name","required":true,"schema":{"type":"string"},"description":"Name of organization."},"api_name":{"in":"path","name":"api_name","required":true,"schema":{"type":"string"},"description":"Name of API proxy."},"maskconfig_name":{"in":"path","name":"maskconfig_name","required":true,"schema":{"type":"string"},"description":"Name of data mask."}},"schemas":{"DataMask":{"type":"object","description":"Data mask configuraiton.","properties":{"jSONPathsFault":{"type":"array","description":"List of JSON expressions that will be evaluated against JSON payloads (if any) in the error flow (which executes if a fault is thrown at any point in the flow). Any JSONPaths that successfully resolve will result in the value of the JSON property being masked.","items":{"type":"string"}},"jSONPathsRequest":{"type":"array","description":"List of JSONPath expressions that will be evaluated against JSON payloads (if any) in the request path. Any JSONPaths that successfully resolve will result in the value of the JSON property being masked.","items":{"type":"string"}},"jSONPathsResponse":{"type":"array","description":"List of JSONPath expressions that will be evaluated against JSON payloads (if any) in the request path. Any JSONPaths that successfully resolve will result in the value of the JSON property being masked.","items":{"type":"string"}},"name":{"type":"string","description":"Name of the data mask."},"namespaces":{"type":"array","description":"Namespace. Only required if an XPATH definition defines a namespace in the XML payload. For example: `myco=\"http://example.com`","items":{"type":"object","properties":{"prefix":{"type":"string","description":"Prefix value, if defined."},"text":{"type":"string","description":"Namespace value."}}}},"variables":{"type":"array","description":"List of variables (either pre-defined or custom) with values that will be masked. For a list of default variables, see <a href=\"https://docs.apigee.com/api-platform/reference/variables-reference\">Variables reference</a>.\n \n \n**Note**: When you specify the `request.content`, `response.content`, or `message.content` flow variables, the request/response body is also masked.","items":{"type":"string"}},"xPathsFault":{"type":"array","description":"List of XPath expressions that will be evaluated against XML payloads (if any) in the error flow (which executes if a fault is thrown at any point in the flow). Any XPaths that successfully resolve will result in the value of the XML element being masked.","items":{"type":"string"}},"xPathsRequest":{"type":"array","description":"List of XPath expressions that will be evaluated against XML payloads (if any) in the request path. Any XPaths that successfully resolve will result in the value of the XML element being masked.","items":{"type":"string"}},"xPathsResponse":{"type":"array","description":"List of XPath expressions that will be evaluated against XML payloads (if any) in the response path. Any XPaths that successfully resolve will result in the value of the XML element being masked.","items":{"type":"string"}}}},"DataMaskXML":{"type":"object","description":"Data mask configuraiton.","properties":{"MaskDataConfiguration":{"type":"object","properties":{"Namespaces":{"type":"object","description":"List of namespaces. Only required if an XPATH definition defines a namespace in the XML payload. For example: `myco=\"http://example.com` properties:\n Namespace:\n type: object\n description: Namespace details.\n properties:\n _prefix:\n type: string\n description: Prefix value, if defined.\n __text: \n type: string\n description: Namespace value.\n _name: \n type: string\n description: Name of the data mask."},"XPathsRequest":{"type":"object","description":"List of XPath expressions that will be evaluated against XML payloads (if any) in the request path. Any XPaths that successfully resolve will result in the value of the XML element being masked.","properties":{"XPathsRequest":{"type":"string","description":"XPath expression that will be evaluated against XML payloads (if any) in the request path."}}},"XPathsResponse":{"type":"object","description":"List of XPath expressions that will be evaluated against XML payloads (if any) in the response path. Any XPaths that successfully resolve will result in the value of the XML element being masked.","properties":{"XPathsResponse":{"type":"string","description":"XPath expression that will be evaluated against XML payloads (if any) in the response path."}}},"JSONPathsRequest":{"type":"object","description":"List of JSONPath expressions that will be evaluated against JSON payloads (if any) in the request path. Any JSONPaths that successfully resolve will result in the value of the JSON property being masked.","properties":{"JSONPathsRequest":{"type":"string","description":"JSONPath expression that will be evaluated against JSON payloads (if any) in the request path."}}},"JSONPathsResponse":{"type":"object","description":"List of JSONPath expressions that will be evaluated against JSON payloads (if any) in the request path. Any JSONPaths that successfully resolve will result in the value of the JSON property being masked.","properties":{"JSONPathsResponse":{"type":"string","description":"JSONPath expression that will be evaluated against JSON payloads (if any) in the request path."}}},"XPathsFault":{"type":"object","description":"List of XPath expressions that will be evaluated against XML payloads (if any) in the error flow (which executes if a fault is thrown at any point in the flow). Any XPaths that successfully resolve will result in the value of the XML element being masked.","properties":{"XPathsFault":{"type":"string","description":"XPath expression that will be evaluated against XML payloads (if any) in the error flow (which executes if a fault is thrown at any point in the flow)."}}},"JSONPathsFault":{"type":"object","description":"List of JSON expressions that will be evaluated against JSON payloads (if any) in the error flow (which executes if a fault is thrown at any point in the flow). Any JSONPaths that successfully resolve will result in the value of the JSON property being masked.","properties":{"JSONPathsFault":{"type":"string","description":"JSON expressions that will be evaluated against JSON payloads (if any) in the error flow (which executes if a fault is thrown at any point in the flow)."}}},"Variables":{"type":"object","description":"List of variables (either pre-defined or custom) with values that will be masked. For a list of default variables, see <a href=\"https://docs.apigee.com/api-platform/reference/variables-reference\">Variables reference</a>.\n\n**Note**: When you specify the `request.content`, `response.content`, or `message.content` flow variables, the request/response body is also masked.","properties":{"Variable":{"type":"array","description":"Variable details.","items":{"type":"string"}}}}}}}}}}}
/ organizations / {org_name} / apis / {api_name} / maskconfigs
/ organizations / {org_name} / apis / {api_name} / maskconfigs / {maskconfig_name}
/ organizations / {org_name} / maskconfigs
/ organizations / {org_name} / maskconfigs / {maskconfig_name}
API products API OpenAPI	{"openapi":"3.0.0","servers":[{"url":"https://api.enterprise.apigee.com/v1"}],"info":{"title":"API products API","description":"An API product consists of a list of API resources (URIs) and custom metadata required by the API provider. API products enable you to bundle and distribute your APIs to multiple developer groups simultaneously without having to modify code. API products provide the basis for access control in Apigee, as they provide control over the set of API resources that apps are allowed to consume.\nAs part of the app provisioning workflow, developers select from a list of API products. This selection of an API product is usually made in the context of a developer portal. The developer app is provisioned with a key and secret (generated by and stored on Apigee Edge) that enable the app to access the URIs bundled in the selected API product. To access API resources bundled in an API product, the app must present the API key issued by Apigee Edge. Apigee Edge will resolve the key that is presented against an API product, and then check associated API resources and quota settings.\nThe API supports multiple API products per app key, which enables app developers to consume multiple API products without requiring multiple keys. Also, a key can be 'promoted' from one API product to another. This enables you to promote developers from 'free' to 'premium' API products seamlessly and without user interruption.\nFor more information, see <a href=\"https://docs.apigee.com/api-platform/publish/what-api-product\">What is an API product?</a>.","version":"1.0"},"security":[{"Basic":[]},{"OAuth":[]}],"paths":{"/organizations/{org_name}/apiproducts":{"post":{"tags":["API Product"],"summary":"Create API product","description":"Creates an API product in an organization. You create API products after you have proxied backend services using API proxies.\n\nAn API product is a collection of API resources combined with quota settings and metadata that you can use to deliver customized and productized API bundles to your developer community. This metadata may include the scope, environments, API proxies, and extensible profile.\n\nAPI products enable you to repackage APIs on-the-fly, without having to do any additional coding or configuration.\n\nApigee recommends that you start with a simple API product including only required elements. Then provision credentials to apps to enable them to start testing your APIs. Once you have authentication and authorization working against a simple API product, you can iterate to create finer-grained API products, defining different sets of API resources for each API product.\n\n**Warning:**\n* If you don't specify an API proxy in the request body, any app associated with the API product can make calls to any API in your entire organization. \n* If you don't specify an environment in the request body, the API product allows access to all environments. \nFor more information, see <a href=\"https://docs.apigee.com/api-platform/publish/create-api-products\">Manage API products</a>.\n\n**Ensure optimal API product and app security**\n\nAn organization-level property, `features.keymanagement.disable.unbounded.permissions`, strengthens the security of API products in verifying API calls. When the property is set to `true`, the following features are enforced.\n\n* **App creation**: When creating a developer or company app, the Edge API requires that the app be associated with an API product. (The Edge UI already enforces this.)\n\n\n* **API product configuration**: To create or update an API product, the API product must include at least one API proxy or a resource path in its definition.\n\n* **Runtime security**: API calls are rejected by an API product in the following situations:\n\n * An API product doesn't include at least one API proxy or resource path. \n\n * If the `flow.resource.name` variable in the message doesn't include a resource path that the API product can evaluate.\n\n * If the app making the API call isn't associated with an API product.\n\n\n**Note:** Setting this organization property requires system administrator privileges. Edge for Private Cloud system administrators can add this property when <a href=\"/docs/organizations/1/routes/organizations/%7Borg_name%7D/post\">updating organization properties</a>. If you are an Edge for Public Cloud user, contact Apigee Support to set the organization property.","operationId":"createAPIProduct","parameters":[{"$ref":"#/components/parameters/org_name"}],"responses":{"201":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIProduct"},"example":{"apiResources":["/"],"approvalType":"auto","attributes":[{"name":"access","value":"public"}],"createdAt":1576006010770,"createdBy":"ahamilton@example.com","description":"My API product","displayName":"My API product","environments":["test"],"lastModifiedAt":1586780529100,"lastModifiedBy":"ahamilton@example.com","name":"myapiproduct","proxies":["myproxy","myproxy2"],"scopes":[]}}}},"400":{"description":"Bad request"}},"requestBody":{"description":"API product request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIProductRequest"},"example":{"apiResources":["/"],"approvalType":"auto","attributes":[{"name":"access","value":"public"}],"description":"My API product","displayName":"My API product","environments":["test"],"name":"myapiproduct","proxies":["myproxy","myproxy2"],"scopes":[]}}}}},"get":{"tags":["API Product"],"summary":"List API products","description":"Lists API products for an organization.\nFilter the list by passing an `attributename` and `attibutevalue`.\nWith Apigee Edge for Public Cloud:\n* The limit on the number of API products returned is 1000.\n* Paginate the list of API products returned using the `startKey` and `count` query parameters.","operationId":"listAPIProducts","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/attributename"},{"$ref":"#/components/parameters/attributevalue"},{"$ref":"#/components/parameters/expand"},{"$ref":"#/components/parameters/count"},{"$ref":"#/components/parameters/startKey"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"description":"API product name.","type":"string"}},"example":["API product 1","API product 2"]}}},"400":{"description":"Bad request"}}}},"/organizations/{org_name}/apiproducts/{apiproduct_name}":{"get":{"tags":["API Product"],"summary":"Get API product","description":"Gets configuration details for an API product.\n\nThe API product name required in the request URL is the internal name of the product, not the display name. While they may be the same, it depends on whether the API product was created via the UI or API. <a href=\"/docs/api-products/1/routes/organizations/%7Borg_name%7D/apiproducts/get\">View the list of API products</a> to verify the internal name.\n\nWith Apigee Edge for Public Cloud:\n* The limit on the number of entities returned is 100.\n* Paginate the list of API products returned using the `startkey` and `count` query parameters.","operationId":"getAPIProduct","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/apiproduct_name"},{"$ref":"#/components/parameters/query"},{"$ref":"#/components/parameters/entity"},{"$ref":"#/components/parameters/startkey"},{"$ref":"#/components/parameters/count-apps"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIProduct"},"example":{"apiResources":["/"],"approvalType":"auto","attributes":[{"name":"access","value":"public"}],"createdAt":1576006010770,"createdBy":"ahamilton@example.com","description":"My API product","displayName":"My API product","environments":["test"],"lastModifiedAt":1586780529100,"lastModifiedBy":"ahamilton@example.com","name":"myapiproduct","proxies":["myproxy","myproxy2"],"scopes":[]}}}},"400":{"description":"Bad request"}}},"put":{"tags":["API Product"],"summary":"Update API product","description":"Updates an existing API product.\n\n**Note**: You must include all required values, whether or not you are updating them, as well as any optional values that you are updating.\n\nThe API product name required in the request URL is the internal name of the product, not the display name. While they may be the same, it depends on whether the API product was created via UI or API. <a href=\"/docs/api-products/1/routes/organizations/%7Borg_name%7D/apiproducts/get\">View the list of API products</a> to verify the internal name.\n\n**Apigee Edge for Public Cloud only**: OAuth access tokens and Key Management Service (KMS) entities (apps, developers, and API products) are cached for 180 seconds (current default). Any custom attributes associated with these entities also get cached for at least 180 seconds after the entity is accessed at runtime. Therefore, an `ExpiresIn` element on the OAuthV2 policy won't be able to expire an access token in less than 180 seconds.","operationId":"updateAPIProduct","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/apiproduct_name"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIProduct"},"example":{"apiResources":["/"],"approvalType":"auto","attributes":[{"name":"access","value":"public"}],"createdAt":1576006010770,"createdBy":"ahamilton@example.com","description":"My API product","displayName":"My API product","environments":["test"],"lastModifiedAt":1586780529100,"lastModifiedBy":"ahamilton@example.com","name":"myapiproduct","proxies":["myproxy","myproxy2"],"scopes":[]}}}},"400":{"description":"Bad request"}},"requestBody":{"description":"API product request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIProductRequest"},"example":{"apiResources":["/"],"approvalType":"auto","attributes":[{"name":"access","value":"public"}],"description":"My API product","displayName":"My API product","environments":["test"],"proxies":["myproxy","myproxy2"],"scopes":[]}}}}},"delete":{"tags":["API Product"],"summary":"Delete API product","description":"Deletes an API product from an organization.\n\nDeleting an API product will cause app requests to the resource URIs defined in the API product to fail. Ensure that you create a new API product to serve existing apps, unless your intention is to disable access to the resources defined in the API product.\n\nThe API product name required in the request URL is the internal name of the product, not the display name. While they may be the same, it depends on whether the API product was created via the UI or API. <a href=\"/docs/api-products/1/routes/organizations/%7Borg_name%7D/apiproducts/get\">View the list of API products</a> to verify the internal name.","operationId":"deleteAPIProduct","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/apiproduct_name"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIProduct"},"example":{"apiResources":["/"],"approvalType":"auto","attributes":[{"name":"access","value":"public"}],"createdAt":1576006010770,"createdBy":"ahamilton@example.com","description":"My API product","displayName":"My API product","environments":["test"],"lastModifiedAt":1586780529100,"lastModifiedBy":"ahamilton@example.com","name":"myapiproduct","proxies":["myproxy","myproxy2"],"scopes":[]}}}},"400":{"description":"Bad request"}}}},"/organizations/{org_name}/apiproducts/{apiproduct_name}/attributes":{"post":{"tags":["API Product"],"summary":"Update all API product attributes","description":"Updates or creates API product attributes. This API **replaces** the current list of attributes with the attributes specified in the request body. In this way, you can update existing attributes, add new attributes, or delete existing attributes by omitting them from the request body.\n\n**Apigee Edge for Public Cloud only**: OAuth access tokens and Key Management Service (KMS) entities (apps, developers, and API products) are cached for 180 seconds (current default). Any custom attributes associated with these entities also get cached for at least 180 seconds after the entity is accessed at runtime. Therefore, an `ExpiresIn` element on the OAuthV2 policy won't be able to expire an access token in less than 180 seconds.","operationId":"updateAPIProductAttributes","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/apiproduct_name"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Attributes"},"example":{"attribute":[{"name":"access","value":"public"}]}}}},"400":{"description":"Bad request"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Attributes"},"example":{"attribute":[{"name":"access","value":"public"}]}}},"description":"API product attributes."}},"get":{"tags":["API Product"],"summary":"List API product attributes","description":"Lists all API product attributes.","operationId":"listAPIProductAttributes","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/apiproduct_name"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Attributes"},"example":{"attribute":[{"name":"access","value":"public"}]}}}},"400":{"description":"Bad request"}}}},"/organizations/{org_name}/apiproducts/{apiproduct_name}/attributes/{attribute_name}":{"post":{"tags":["API Product"],"summary":"Update API product attribute","description":"Updates the value of an API product attribute.\n\n**Apigee Edge for Public Cloud only**: OAuth access tokens and Key Management Service (KMS) entities (apps, developers, and API products) are cached for 180 seconds (current default). Any custom attributes associated with these entities also get cached for at least 180 seconds after the entity is accessed at runtime. Therefore, an `ExpiresIn` element on the OAuthV2 policy won't be able to expire an access token in less than 180 seconds.","operationId":"updateAPIProductAttribute","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/apiproduct_name"},{"$ref":"#/components/parameters/attribute_name"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Attribute"},"example":{"name":"access","value":"public"}}}},"400":{"description":"Bad request"}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"value":{"type":"string","description":"Value for the API product attribute."}}}}},"description":"API product details."}},"delete":{"tags":["API Product"],"summary":"Delete API product attribute","description":"Deletes an API product attribute.","operationId":"deleteAPIProductAttribute","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/apiproduct_name"},{"$ref":"#/components/parameters/attribute_name"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Attribute"},"example":{"name":"access","value":"public"}}}},"400":{"description":"Bad request"}}},"get":{"tags":["API Product"],"summary":"Get API product attribute","description":"Gets the value of an API product attribute.","operationId":"getAPIProductAttribute","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/apiproduct_name"},{"$ref":"#/components/parameters/attribute_name"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Attribute"},"example":{"name":"access","value":"public"}}}},"400":{"description":"Bad request"}}}}},"components":{"securitySchemes":{"Basic":{"type":"http","scheme":"basic","description":"Multi-factor authentication is not supported."},"OAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"parameters":{"org_name":{"in":"path","name":"org_name","required":true,"schema":{"type":"string"},"description":"Organization name."},"apiproduct_name":{"in":"path","name":"apiproduct_name","required":true,"schema":{"type":"string"},"description":"API product name."},"attribute_name":{"in":"path","name":"attribute_name","required":true,"schema":{"type":"string"},"description":"Name of an attribute defined in the API product profile."},"attributename":{"in":"query","name":"attributename","required":false,"schema":{"type":"string"},"description":"Name of an attribute defined in the API product profile on which you want to filter the list."},"attributevalue":{"in":"query","name":"attributevalue","required":false,"schema":{"type":"string"},"description":"Value of the attribute."},"count":{"in":"query","name":"count","required":false,"schema":{"type":"integer"},"description":"**Apigee Edge for Public Cloud only**. Number of API products to return in the API call. The limit is 1000."},"count-apps":{"in":"query","name":"count","required":false,"schema":{"type":"integer"},"description":"**Apigee Edge for Public Cloud only**. Valid when `entity` is set to `apps`. Number of apps to return in the API call. The limit is 100."},"expand":{"in":"query","name":"expand","required":false,"schema":{"type":"boolean"},"description":"Flag that specifies whether to view expanded details about each API product. Set to `true` to view expanded details. Defaults to `false`."},"startKey":{"in":"query","name":"startKey","required":false,"schema":{"type":"string"},"description":"**Apigee Edge for Public Cloud only**. Name of an API product from which to start displaying the list of API products. For example, if you're returning 50 API products at a time (using the count query parameter), you can view products 50-99 by entering the name of the 50th API product. The API product name is case sensitive."},"startkey":{"in":"query","name":"startkey","required":false,"schema":{"type":"string"},"description":"**Apigee Edge for Public Cloud only**. Valid when `entity` is set to `apps`. Name of an app from which to start displaying the list of apps. For example, if you're returning 50 apps at a time (using the count query parameter), you can view apps 50-99 by entering the name of the 50th app. The app name is case sensitive."},"query":{"in":"query","name":"query","required":false,"schema":{"type":"string"},"description":"Set to `list` to list the entities specified by the `entity` query parameter."},"entity":{"in":"query","name":"entity","required":false,"schema":{"type":"string"},"description":"Specify the type of entity for which you want to get a count or list, as defined by the `query` parameter. Valid values include: `keys`, `apps`, `developers`, or `companies`. With Apigee Edge for Public Cloud, the `developers` and `entity` types are not supported."}},"schemas":{"APIProduct":{"description":"API product details.","type":"object","properties":{"apiResources":{"type":"array","items":{"description":"API resource, such as `/forecastrss`.","type":"string"},"description":"Comma-separated list of API resources to be bundled in the API product.\n\nBy default, the resource paths are mapped from the `proxy.pathsuffix` variable which is defined as the URI fragment following the ProxyEndpoint base path. For example, if the `apiResources` element is defined to be `/forecastrss` and the base path defined for the API proxy is `/weather`, then only requests to `/weather/forecastrss` are permitted by the API product.\n\nYou can select a specific path, or you can select all subpaths with a wildcard (/** and /*). The double asterisk wildcard indicates that all sub-URIs are included. A single asterisk indicates that only URIs one level down are included. By default, / supports the same resources as /** as plus the base path defined by the API proxy. For example, if the base path of the API proxy is `/v1/weatherapikey`, then the API product supports requests to `/v1/weatherapikey` and to any sub-URIs, such as `/v1/weatherapikey/forecastrss`, `/v1/weatherapikey/region/CA`, and so on.\n\nFor more information, see:\n* <a href=\"https://docs.apigee.com/api-platform/publish/create-api-products\">Manage API products</a> for more information about managing API products and setting this value.\n* <a href=\"https://docs.apigee.com/api-platform/monetization/create-transaction-recording-policy#api\">Managing a transaction recording policy using the API</a> for information about setting this value when creating a transaction recording policy for monetization."},"approvalType":{"description":"Flag that specifies how API keys are approved to access the APIs defined by the API product. If set to `manual`, the consumer key is generated and returned in \"pending\" state. In this case, the API keys won't work until they have been explicitly approved. If set to `auto`, the consumer key is generated and returned in \"approved\" state and can be used immediately.\n\n**Note**: Typically, `auto` is used to provide access to free or trial API products that provide limited quota or capabilities.","type":"string","enum":["auto","manual"]},"attributes":{"description":"Array of attributes that may be used to extend the default API product profile with customer-specific metadata. With Edge for Public Cloud, you can specify a maximum of 18 attributes. Use this property to specify the access level of the API product as either `public`, `private`, or `internal`. Only products marked `public` are available to developers in the Apigee developer portal. For example, you can set a product to `internal` while it is in development and then change access to `public` when it is ready to release on the portal. API products marked as `private` do not appear on the portal but can be accessed by external developers.\n\nFor monetization, you can use the attributes field to:\n* <a href=\"https://docs.apigee.com/api-platform/monetization/create-transaction-recording-policy#spectrpsuccessapi\">Specify transaction success criteria</a>\n* <a href=\"https://docs.apigee.com/api-platform/monetization/create-transaction-recording-policy#spectrpcaapi\">Specify custom attributes</a> on which you base rate plan charges</a>","type":"array","items":{"$ref":"#/components/schemas/Attribute"}},"createdAt":{"description":"Output only. Creation date specified as milliseconds since epoch.","type":"integer","readOnly":true},"createdBy":{"description":"Output only. Email address of the user that created the API product.","type":"string","readOnly":true},"description":{"description":"Description of the API product. Include key information about the API product.","type":"string"},"displayName":{"description":"Name to be displayed in the UI or developer portal to developers registering for API access.","type":"string"},"environments":{"description":"Comma-separated list of environment names to which the API product is bound. Requests to environments that are not listed are rejected. By specifying one or more environments, you can bind the resources listed in the API product to a specific environment, preventing developers from accessing those resources through API proxies deployed in another environment. This setting is used, for example, to prevent resources associated with API proxies in `prod` from being accessed by API proxies deployed in `test`.","type":"array","items":{"description":"Environment.","type":"string"}},"lastModifiedAt":{"description":"Output only. Last modified date specified as milliseconds since epoch.","type":"integer","readOnly":true},"lastModifiedBy":{"description":"Output only. Email address of the user that last modified the API product.","type":"string","readOnly":true},"name":{"description":"Internal name of the API Product. Valid characters include: `A-Z0-9._\\-$ %`.\n\n**Notes**:\n* The name is required when creating an API product. It cannot be edited when <a href=\"/docs/api-products/1/routes/organizations/%7Borg_name%7D/apiproducts/%7Bapiproduct_name%7D/put\">updating the API product</a>.\n* API product names must be unique within your organization.\n* For Monetization organizations, API product names must use a unique sequence of characters, regardless of case. For example, if you create an API product named `APIProductA` and subsequently attempt to create a company named `apiproducta`, an error is thrown.","type":"string"},"proxies":{"description":"Comma-separated list of API proxy names to which this API product is bound. By specifying API proxies, you can associate resources in the API product with specific API proxies, preventing developers from accessing those resources through other API proxies. Requests to API proxies not listed are rejected.\n\n**Note**: The API proxy names must already exist in the specified environment as they will be validated upon creation.","type":"array","items":{"description":"API proxy name.","type":"string"}},"quota":{"description":"Number of request messages permitted per app by this API product for the specified `quotaInterval` and `quotaTimeUnit`. For example, a `quota` of 50, for a `quotaInterval` of 12 and a `quotaTimeUnit` of hours means 50 requests are allowed every 12 hours.","type":"string"},"quotaInterval":{"description":"Time interval over which the number of request messages is calculated.","type":"string"},"quotaTimeUnit":{"description":"Time unit defined for the `quotaInterval`.","type":"string","enum":["minute","hour","day","month"]},"scopes":{"description":"Comma-separated list of OAuth scopes that are validated at runtime. Apigee Edge validates that the scopes in any access token presented match the scopes defined in the OAuth policy assoicated with the API product.","type":"array","items":{"description":"OAuth scope.","type":"string"}}}},"APIProductRequest":{"description":"API product request.","type":"object","required":["displayName","approvalType"],"properties":{"apiResources":{"type":"array","items":{"description":"API resource, such as `/forecastrss`.","type":"string"},"description":"Comma-separated list of API resources to be bundled in the API product.\n\nBy default, the resource paths are mapped from the `proxy.pathsuffix` variable which is defined as the URI fragment following the ProxyEndpoint base path. For example, if the `apiResources` element is defined to be `/forecastrss` and the base path defined for the API proxy is `/weather`, then only requests to `/weather/forecastrss` are permitted by the API product.\n\nYou can select a specific path, or you can select all subpaths with a wildcard (/** and /*). The double asterisk wildcard indicates that all sub-URIs are included. A single asterisk indicates that only URIs one level down are included. By default, / supports the same resources as /** as plus the base path defined by the API proxy. For example, if the base path of the API proxy is `/v1/weatherapikey`, then the API product supports requests to `/v1/weatherapikey` and to any sub-URIs, such as `/v1/weatherapikey/forecastrss`, `/v1/weatherapikey/region/CA`, and so on.\n\nFor more information, see:\n* <a href=\"https://docs.apigee.com/api-platform/publish/create-api-products\">Manage API products</a> for more information about managing API products and setting this value.\n* <a href=\"https://docs.apigee.com/api-platform/monetization/create-transaction-recording-policy#api\">Managing a transaction recording policy using the API</a> for information about setting this value when creating a transaction recording policy for monetization."},"approvalType":{"description":"Flag that specifies how API keys are approved to access the APIs defined by the API product. If set to `manual`, the consumer key is generated and returned in \"pending\" state. In this case, the API keys won't work until they have been explicitly approved. If set to `auto`, the consumer key is generated and returned in \"approved\" state and can be used immediately.\n\n**Note**: Typically, `auto` is used to provide access to free or trial API products that provide limited quota or capabilities.","type":"string","enum":["auto","manual"]},"attributes":{"description":"Array of attributes that may be used to extend the default API product profile with customer-specific metadata. With Edge for Public Cloud, you can specify a maximum of 18 attributes. Use this property to specify the access level of the API product as either `public`, `private`, or `internal`. Only products marked `public` are available to developers in the Apigee developer portal. For example, you can set a product to `internal` while it is in development and then change access to `public` when it is ready to release on the portal. API products marked as `private` do not appear on the portal but can be accessed by external developers.\n\nFor monetization, you can use the attributes field to:\n* <a href=\"https://docs.apigee.com/api-platform/monetization/create-transaction-recording-policy#spectrpsuccessapi\">Specify transaction success criteria</a>\n* <a href=\"https://docs.apigee.com/api-platform/monetization/create-transaction-recording-policy#spectrpcaapi\">Specify custom attributes</a> on which you base rate plan charges</a>","type":"array","items":{"$ref":"#/components/schemas/Attribute"}},"description":{"description":"Description of the API product. Include key information about the API product.","type":"string"},"displayName":{"description":"Name to be displayed in the UI or developer portal to developers registering for API access.","type":"string"},"environments":{"description":"Comma-separated list of environment names to which the API product is bound. Requests to environments that are not listed are rejected. By specifying one or more environments, you can bind the resources listed in the API product to a specific environment, preventing developers from accessing those resources through API proxies deployed in another environment. This setting is used, for example, to prevent resources associated with API proxies in `prod` from being accessed by API proxies deployed in `test`.","type":"array","items":{"description":"Environment.","type":"string"}},"name":{"description":"Internal name of the API Product. Valid characters include: `A-Z0-9._\\-$ %`.\n\n**Note**: The name is required when creating an API product. It cannot be edited when <a href=\"/docs/api-products/1/routes/organizations/%7Borg_name%7D/apiproducts/%7Bapiproduct_name%7D/put\">updating the API product</a>.","type":"string"},"proxies":{"description":"Comma-separated list of API proxy names to which this API product is bound. By specifying API proxies, you can associate resources in the API product with specific API proxies, preventing developers from accessing those resources through other API proxies. Requests to API proxies not listed are rejected.\n\n**Note**: The API proxy names must already exist in the specified environment as they will be validated upon creation.","type":"array","items":{"description":"API proxy name.","type":"string"}},"quota":{"description":"Number of request messages permitted per app by this API product for the specified `quotaInterval` and `quotaTimeUnit`. For example, a `quota` of 50, for a `quotaInterval` of 12 and a `quotaTimeUnit` of hours means 50 requests are allowed every 12 hours.","type":"string"},"quotaInterval":{"description":"Time interval over which the number of request messages is calculated.","type":"string"},"quotaTimeUnit":{"description":"Time unit defined for the `quotaInterval`.","type":"string","enum":["minute","hour","day","month"]},"scopes":{"description":"Comma-separated list of OAuth scopes that are validated at runtime. Apigee Edge validates that the scopes in any access token presented match the scopes defined in the OAuth policy assoicated with the API product.","type":"array","items":{"description":"OAuth scope.","type":"string"}}}},"Attributes":{"description":"API product attributes.","properties":{"attribute":{"type":"array","items":{"$ref":"#/components/schemas/Attribute"}}}},"Attribute":{"description":"API product attribute name and value.","properties":{"name":{"description":"Name of attribute.","type":"string"},"value":{"description":"Value of attribute.","type":"string"}}}}}}
/ organizations / {org_name} / apiproducts
/ organizations / {org_name} / apiproducts / {apiproduct_name}
/ organizations / {org_name} / apiproducts / {apiproduct_name} / attributes
/ organizations / {org_name} / apiproducts / {apiproduct_name} / attributes / {attribute_name}
User roles API OpenAPI	{"openapi":"3.0.0","servers":[{"url":"https://api.enterprise.apigee.com/v1"}],"info":{"title":"User roles API","description":"Manage role-based access in Apigee Edge. User roles form the basis of role-based access in Apigee Edge.\n\nUsers are associated with one or more user roles. Each user role defines a set of permissions (GET, PUT, DELETE) on RBAC resources (defined by URI paths).\n\nA user role is scoped to an organization.\n\nUpdated: 01/25/21","version":"1.0"},"security":[{"Basic":[]},{"OAuth":[]}],"paths":{"/organizations/{org_name}/userroles":{"get":{"tags":["User Roles"],"summary":"List roles in an organization","description":"Lists roles available to all users in an organization.","operationId":"listUserRoles","parameters":[{"$ref":"#/components/parameters/org_name"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}}},"400":{"description":"Bad request"}}},"post":{"tags":["User Roles"],"summary":"Create roles in an organization","description":"Creates one or more user roles in an organization.\n\nAfter you create the role, you can use the following APIs to add permissions to the role:\n\n* <a href=\"/docs/user-roles/1/routes/organizations/%7Borg_name%7D/userroles/%7Brole_name%7D/resourcepermissions/post\">Add permissions for multiple resources to a role</a> \n* <a href=\"/docs/user-roles/1/routes/organizations/%7Borg_name%7D/userroles/%7Brole_name%7D/permissions/post\">Add permissions for a resource to a role</a>\n\nRole names <a href=\"https://docs.apigee.com/advisory/naming-and-input-error-advisories#VALIDATION_ERR_ROLENAME\">cannot contain special characters</a>.","operationId":"createRole","parameters":[{"$ref":"#/components/parameters/org_name"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"role":{"type":"array","description":"Role names.","items":{"type":"object","properties":{"name":{"type":"string","description":"Name of the role."}}}}}},"example":{"role":[{"name":"role1"},{"name":"role2"}]}}}},"400":{"description":"Bad request"}},"requestBody":{"description":"Role names.","content":{"application/json":{"schema":{"type":"object","properties":{"role":{"type":"array","description":"Role names.","items":{"type":"object","properties":{"name":{"type":"string","description":"Name of the role."}}}}}},"example":{"role":[{"name":"role1"},{"name":"role2"}]}}}}}},"/organizations/{org_name}/userroles/{role_name}":{"get":{"tags":["User Roles"],"summary":"Get role","description":"Gets the name of a user role. If you want to view permissions for the role, see <a href=\"/docs/user-roles/1/routes/organizations/%7Borg_name%7D/userroles/%7Brole_name%7D/permissions/get\">List permissions for resources associated with a role</a>.","operationId":"getRole","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/role_name"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"properties":{"name":{"type":"string","description":"Name of the role."}}},"example":{"name":"mycustomrole"}}}},"400":{"description":"Bad request"}}},"delete":{"tags":["User Roles"],"summary":"Delete role","description":"Deletes a role from an organization.\n\nRoles can only be deleted when no users are assigned to the role. See <a href=\"/docs/user-roles/1/routes/organizations/%7Borg_name%7D/userroles/%7Brole_name%7D/users/%7Buser_email%7D/delete\">Remove a user from a role.","operationId":"deleteRole","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/role_name"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"properties":{"name":{"type":"string","description":"Name of the role."}}},"example":{"name":"mycustomrole"}}}},"400":{"description":"Bad request"}}}},"/organizations/{org_name}/userroles/{role_name}/users":{"get":{"tags":["User Roles"],"summary":"List users assigned to a role","description":"Lists the users assigned to a role.","operationId":"listUsersAssignedToRole","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/role_name"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","description":"Users assigned to a role.","items":{"type":"string"}}}}},"400":{"description":"Bad request"}}},"post":{"tags":["User Roles"],"summary":"Add a user to a role","description":"Adds a user to a role.\n\n**Note**: **This API cannot be executed using the Try this API panel**. For an example using curl, see <a href=\"https://docs.apigee.com/api-platform/system-administration/understanding-roles#assigningrolestoauser-assigningrolestouserswiththeedgeapi\" >Assigning roles to users with the Edge API</a>.\n\nSpecify a custom role or one of the following <a href=\"https://docs.apigee.com/api-platform/system-administration/edge-built-roles\">built-in roles</a>:\n\n* Organization administrator: `orgadmin`\n* Read-only organization administrator (Cloud only): `readonlyadmin`\n* Operations administrator: `opsadmin`\n* Business user: `businessuser`\n* User: `user`","operationId":"addUserToRole","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/role_name"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserRoles"},"example":{"emailId":"ahamilton@example.com","firstName":"Alex","lastName":"Hamilton","roles":{"role":[{"name":"user","organization":"myorg"},{"name":"mycustomrole","organization":"myrog"}]}}}}},"400":{"description":"Bad request"}},"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"Email address of the user."}}}}}}}},"/organizations/{org_name}/userroles/{role_name}/users/{user_email}":{"delete":{"tags":["User Roles"],"summary":"Remove user from role","description":"Removes a user from the specified role.","operationId":"removeUserFromRole","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/role_name"},{"$ref":"#/components/parameters/user_email"}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad request"}}},"get":{"tags":["User Roles"],"summary":"Verify user roles","description":"Verifies roles to which user is assigned.","operationId":"verifyUserRoles","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/role_name"},{"$ref":"#/components/parameters/user_email"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/User"},"example":{"emailId":"ahamilton@example.com","firstName":"Alex","lastName":"Hamilton"}}}},"400":{"description":"Bad request"}}}},"/organizations/{org_name}/userroles/{role_name}/resourcepermissions":{"post":{"tags":["User Roles","Permissions"],"summary":"Add permissions for multiple resources to a role","description":"Adds permissions for multiple resources to a role.","operationId":"addMultipleResourcePermissionsForResource","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/role_name"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourcePermissions"},"example":{"resourcePermission":[{"path":"/applications","permissions":["put","get","delete"]},{"path":"/apiproducts","permissions":["put","get","delete"]}]}}}},"400":{"description":"Bad request"}},"requestBody":{"description":"Role names.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourcePermissions"},"example":{"resourcePermission":[{"path":"/applications","permissions":["put","get","delete"]},{"path":"/apiproducts","permissions":["put","get","delete"]}]}}}}}},"/organizations/{org_name}/userroles/{role_name}/permissions":{"post":{"tags":["User Roles","Permissions"],"summary":"Add permissions for a resource to role","description":"Adds permissions for a resource to a role.\n\nIn Apigee Edge, user roles are assigned different permissions to view (`GET`), create or update (`PUT`), or delete (`DELETE`) resources in an organization; for example, modifying API proxies, creating custom reports, and so on. Users in a particular role are limited to the permissions added to the role.\n\nA permission consists of a set of verbs (`get`, `put`, and/or `delete`) and a resource path. For example, to allow a user role to view the API proxies in an organization, the role must have the following permission:\n\n```\n{\n \"path\" : \"/applications\",\n \"permissions\" : [\"get\"]\n}\n```\nTo be able to list and create an API proxy:\n\n```\n{\n \"path\" : \"/applications\",\n \"permissions\" : [\"get\", \"put\"]\n}\n```\nFor a complete list of the available resource paths and verbs, see <a href=\"https://docs.apigee.com/api-platform/system-administration/permissions\">Permissions reference</a>.\n\n\nYou can use the `*` wildcard in the URI pattern to indicate any value; for example, to include either the `test` or `prod` environment in the resource path: `/environments/*/cache`. For more information and examples on using the API to add permissions, see <a href=\"https://docs.apigee.com/api-platform/system-administration/managing-roles-api\">Creating roles with the API</a>.\n\nThis API does not remove any existing permissions in the role. To remove a permsission, see <a href=\"/docs/user-roles/1/routes/organizations/%7Borg_name%7D/userroles/%7Brole_name%7D/permissions/%7Bpermission%7D/delete\">Delete permission for a resource in a role</a>.","operationId":"addResourcePermissionsToRole","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/role_name"}],"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourcePermission"},"example":{"path":"/applications","permissions":["put","get","delete"]}}}},"400":{"description":"Bad request"}},"requestBody":{"description":"Role names.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourcePermission"},"example":{"path":"/applications","permissions":["put","get","delete"]}}}}},"get":{"tags":["User Roles","Permissions"],"summary":"List permissions for resources associated with a role","description":"Lists permissions for resources associated with the specified role.\n\nTo display information for a single resource, set the `path` query parameter to the name of the resource, such as `/applications`. For example:\n\n```\n{\n \"organization\" : \"myorg\",\n \"path\" : \"/applications\",\n \"permissions\" : [\n \"delete\",\n \"get\",\n \"put\"\n ]\n}\n``` \n\nIf you omit the `path` query parameter, then permissions for all resources associated with a role are returned.","operationId":"listPermissionsForResourcesAssoicatedRole","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/role_name"},{"$ref":"#/components/parameters/path"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourcePermissions"},"example":{"resourcePermission":[{"organization":"myorg","path":"/applications","permissions":["delete","get","put"]}]}}}},"400":{"description":"Bad request"}}}},"/organizations/{org_name}/userroles/{role_name}/permissions/{permission}":{"delete":{"tags":["User Roles","Permissions"],"summary":"Delete permission for resource","description":"Deletes a permission for a resource in the role specified. Permissions are case sensitive. Specify the permission as `get`, `put`, or `delete`.","operationId":"deletePermissionForResource","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/role_name"},{"$ref":"#/components/parameters/permission"},{"$ref":"#/components/parameters/path"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourcePermission"},"example":{"path":"/applications","permissions":["delete"]}}}},"400":{"description":"Bad request"}}},"get":{"tags":["User Roles","Permissions"],"summary":"Verify user role permission for resource","description":"Verifies that a user role's permission exists for a specific resource. Returns a value of `true` or `false`.","operationId":"verifyUserRolePermissionForResource","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/role_name"},{"$ref":"#/components/parameters/permission"},{"$ref":"#/components/parameters/path"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"properties":{"value":{"type":"string","description":"Boolean value that specifies whether the permission exists for the resource in the role."}}},"example":{"value":true}}}},"400":{"description":"Bad request"}}}}},"components":{"securitySchemes":{"Basic":{"type":"http","scheme":"basic","description":"Multi-factor authentication is not supported."},"OAuth":{"type":"apiKey","name":"Authorization","in":"header","description":"For OAuth, enter the following in the Key field: Bearer %your-token% (see https://docs.apigee.com/api-platform/system-administration/using-oauth2#get-the-tokens)"}},"parameters":{"org_name":{"in":"path","name":"org_name","required":true,"schema":{"type":"string"},"description":"Organization name."},"role_name":{"in":"path","name":"role_name","required":true,"schema":{"type":"string"},"description":"Role name."},"user_email":{"in":"path","name":"user_email","required":true,"schema":{"type":"string"},"description":"Email address of the user."},"permission":{"in":"path","name":"permission","required":true,"schema":{"type":"string"},"description":"Permission."},"id":{"in":"query","name":"id","required":true,"schema":{"type":"string"},"description":"Email address of the user."},"path":{"in":"query","name":"path","required":false,"schema":{"type":"string"},"description":"Resource path. For example: `/applications`"}},"schemas":{"UserRoles":{"description":"List of roles assigned to user.","type":"object","properties":{"emailId":{"type":"string","description":"Email address of the user."},"firstName":{"type":"string","description":"First name of user."},"lastName":{"type":"string","description":"Last name of user."},"roles":{"type":"array","description":"List of roles.","items":{"type":"object","properties":{"name":{"type":"string","description":"Name of the role."},"organization":{"type":"string","description":"Name of the organization."}}}}}},"User":{"description":"List of roles assigned to user.","type":"object","properties":{"emailId":{"type":"string","description":"Email address of the user."},"firstName":{"type":"string","description":"First name of user."},"lastName":{"type":"string","description":"Last name of user."}}},"ResourcePermissions":{"description":"Permissions for all resources.","type":"object","properties":{"resourcePermission":{"type":"array","items":{"type":"object","properties":{"org":{"type":"string","description":"Output only. Organization name."},"path":{"type":"string","description":"Resource path. See <a href=\"https://docs.apigee.com/api-platform/system-administration/permissions\">Permissions reference</a>"},"permissions":{"type":"array","description":"List of permissions, such as `get`, `put`, or `delete`.","items":{"type":"string"}}}}}}},"ResourcePermission":{"description":"Permissions for resource.","type":"object","properties":{"path":{"type":"string","description":"Resource path. See <a href=\"https://docs.apigee.com/api-platform/system-administration/permissions\">Permissions reference</a>"},"permissions":{"type":"array","description":"List of permissions, such as `get`, `put`, or `delete`.","items":{"type":"string"}}}}}}}
/ organizations / {org_name} / userroles
/ organizations / {org_name} / userroles / {role_name}
/ organizations / {org_name} / userroles / {role_name} / users
/ organizations / {org_name} / userroles / {role_name} / users / {user_email}
/ organizations / {org_name} / userroles / {role_name} / resourcepermissions
/ organizations / {org_name} / userroles / {role_name} / permissions
/ organizations / {org_name} / userroles / {role_name} / permissions / {permission}
Company apps API OpenAPI	{"openapi":"3.0.0","servers":[{"url":"https://api.enterprise.apigee.com/v1"}],"info":{"title":"Company apps API","description":"A consumer/client app associated with a company entity. For more information,\n see <a href=\"https://docs.apigee.com/api-platform/publish/creating-apps-surface-your-api\">Register apps and manage API keys</a>.","version":"1.0"},"security":[{"Basic":[]},{"OAuth":[]}],"paths":{"/organizations/{org_name}/companies/{company_name}/apps":{"post":{"tags":["Company","Company App"],"summary":"Create company app","description":"Creates an app associated with a company, associates the app with an API product, and auto-generates an API key for the app to use in calls to API proxies inside the API product. You must create a profile for the company in your organization before you can register apps that are associated with the company.\n\n**Ensure optimal API product and app security**\n\nAn organization-level property, `features.keymanagement.disable.unbounded.permissions`, strengthens the security of API products in verifying API calls. When the property is set to `true`, the following features are enforced.\n\n* **App creation**: When creating a developer or company app, the Edge API requires that the app be associated with an API product. (The Edge UI already enforces this.)\n\n\n* **API product configuration**: To create or update an API product, the API product must include at least one API proxy or a resource path in its definition.\n\n* **Runtime security**: API calls are rejected by an API product in the following situations:\n\n * An API product doesn't include at least one API proxy or resource path. \n\n * If the `flow.resource.name` variable in the message doesn't include a resource path that the API product can evaluate.\n\n * If the app making the API call isn't associated with an API product.\n\n\n**Note:** Setting this organization property requires system administrator rights. Edge for Private Cloud system administrators can make add this property on their own with the Update organization properties API. If you are an Edge for Public Cloud user and the previously described restrictions are not in place, contact Apigee Support to set the organization property for you.","operationId":"createCompanyApp","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/company_name"}],"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompanyApp"},"example":{"appFamily":"default","appId":"123abc-456-def","attributes":[{"name":"ADMIN_EMAIL","value":"admin@example.com"},{"name":"MINT_BILLING_TYPE","value":"POSTPAID"}],"callbackUrl":"example.com","companyName":"Acme","createdAt":1568312504191,"createdBy":"ahamilton@example.com","credentials":[{"apiProducts":[{"apiproduct":"myproduct","status":"approved"}],"attributes":[],"consumerKey":"F91jQrfX6CKhyEheXFBL3gxxxxx","consumerSecret":"TLbUJFyzOlLxxxx","expiresAt":-1,"issuedAt":1568312504682,"scopes":[],"status":"approved"}],"lastModifiedAt":1568313405903,"lastModifiedBy":"ahamilton@example.com","name":"myapp","scopes":[],"status":"approved"}}}},"400":{"description":"Bad request"}},"requestBody":{"description":"Company app request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompanyAppRequest"},"example":{"apiproducts":["myproduct"],"attributes":[{"name":"ADMIN_EMAIL","value":"admin@example.com"},{"name":"MINT_BILLING_TYPE","value":"POSTPAID"}],"callbackUrl":"example.com","name":"myapp","scopes":[],"status":"approved"}}}}},"get":{"tags":["Company","Company App"],"summary":"List company apps","description":"Lists company apps in an organization. Optionally, you can expand the response to include the profile for each app.\n\nWith Apigee Edge for Public Cloud:\n* A maximum of 100 company apps are returned per API call.\n* You can paginate the list of company apps returned using the `startKey` and `count` query parameters.","operationId":"listCompanyApps","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/company_name"},{"$ref":"#/components/parameters/expand"},{"$ref":"#/components/parameters/keyStatus"},{"$ref":"#/components/parameters/count"},{"$ref":"#/components/parameters/startKey"}],"responses":{"200":{"content":{"application/json":{"schema":{"oneOf":[{"type":"array","items":{"type":"string"}},{"$ref":"#/components/schemas/CompanyApps"}]}}},"description":"OK"},"400":{"description":"Bad request"}}}},"/organizations/{org_name}/companies/{company_name}/apps/{app_name}":{"post":{"tags":["Company","Company App"],"summary":"Approve or revoke a company app","description":"Sets the API key status of a company app to `approved` or `revoked`.\nIf a company app is revoked, none of its API keys are valid for API calls, even though the keys themselves still display an \"Approved\" status.\nThe HTTP status code for success is: `204 No Content`.","operationId":"approveRevokeCompanyApp","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/company_name"},{"$ref":"#/components/parameters/app_name"},{"$ref":"#/components/parameters/action"}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad request"}}},"delete":{"tags":["Company","Company App"],"summary":"Delete company app","description":"Deletes a company app.","operationId":"deleteCompanyApp","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/company_name"},{"$ref":"#/components/parameters/app_name"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompanyApp"},"example":{"appFamily":"default","appId":"123abc-456-def","attributes":[{"name":"ADMIN_EMAIL","value":"admin@example.com"},{"name":"MINT_BILLING_TYPE","value":"POSTPAID"}],"callbackUrl":"example.com","companyName":"Acme","createdAt":1568312504191,"createdBy":"ahamilton@example.com","credentials":[{"apiProducts":[{"apiproduct":"myproduct","status":"approved"}],"attributes":[],"consumerKey":"F91jQrfX6CKhyEheXFBL3gxxxxx","consumerSecret":"TLbUJFyzOlLxxxx","expiresAt":-1,"issuedAt":1568312504682,"scopes":[],"status":"approved"}],"lastModifiedAt":1568313405903,"lastModifiedBy":"ahamilton@example.com","name":"myapp","scopes":[],"status":"approved"}}}},"400":{"description":"Bad request"}}},"put":{"tags":["Company","Company App"],"summary":"Update company app","description":"Updates an existing company app.\n**Note**: You must include all current attribute, API product, and callback values in the payload along with any changes you want to make; otherwise, the existing values are removed. To display the current values, see Get the company app API.","operationId":"","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/company_name"},{"$ref":"#/components/parameters/app_name"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompanyApp"},"example":{"appFamily":"default","appId":"123abc-456-def","attributes":[{"name":"ADMIN_EMAIL","value":"admin@example.com"},{"name":"MINT_BILLING_TYPE","value":"POSTPAID"}],"callbackUrl":"example.com","companyName":"Acme","createdAt":1568312504191,"createdBy":"ahamilton@example.com","credentials":[{"apiProducts":[{"apiproduct":"myproduct","status":"approved"}],"attributes":[],"consumerKey":"F91jQrfX6CKhyEheXFBL3gxxxxx","consumerSecret":"TLbUJFyzOlLxxxx","expiresAt":-1,"issuedAt":1568312504682,"scopes":[],"status":"approved"}],"lastModifiedAt":1568313405903,"lastModifiedBy":"ahamilton@example.com","name":"myapp","scopes":[],"status":"approved"}}}},"400":{"description":"Bad request"}},"requestBody":{"description":"Company app details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompanyAppRequest"},"example":{"apiproducts":["myproduct"],"attributes":[{"name":"ADMIN_EMAIL","value":"admin@example.com"},{"name":"MINT_BILLING_TYPE","value":"POSTPAID"}],"callbackUrl":"example.com","name":"myapp","scopes":[],"status":"approved"}}}}},"get":{"tags":["Company","Company App"],"summary":"Get company app","description":"Gets the profile for a company app.","operationId":"getCompanyApp","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/company_name"},{"$ref":"#/components/parameters/app_name"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompanyApp"},"example":{"appFamily":"default","appId":"123abc-456-def","attributes":[{"name":"ADMIN_EMAIL","value":"admin@example.com"},{"name":"MINT_BILLING_TYPE","value":"POSTPAID"}],"callbackUrl":"example.com","companyName":"Acme","createdAt":1568312504191,"createdBy":"ahamilton@example.com","credentials":[{"apiProducts":[{"apiproduct":"myproduct","status":"approved"}],"attributes":[],"consumerKey":"F91jQrfX6CKhyEheXFBL3gxxxxx","consumerSecret":"TLbUJFyzOlLxxxx","expiresAt":-1,"issuedAt":1568312504682,"scopes":[],"status":"approved"}],"lastModifiedAt":1568313405903,"lastModifiedBy":"ahamilton@example.com","name":"myapp","scopes":[],"status":"approved"}}}},"400":{"description":"Bad request"}}}}},"components":{"securitySchemes":{"Basic":{"type":"http","scheme":"basic","description":"Multi-factor authentication is not supported."},"OAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"parameters":{"org_name":{"in":"path","name":"org_name","required":true,"schema":{"type":"string"},"description":"Name of the organization."},"company_name":{"in":"path","name":"company_name","required":true,"schema":{"type":"string"},"description":"Name of the company."},"app_name":{"in":"path","name":"app_name","required":true,"schema":{"type":"string"},"description":"Name of the application."},"action":{"in":"query","name":"action","required":true,"schema":{"type":"string"},"description":"Action to perform. Valid values include `approved` or `revoked`."},"count":{"in":"query","name":"count","required":false,"schema":{"type":"integer"},"description":"**Apigee Edge for Public Cloud only**. Number of company apps to return in the API call. The limit is 100. Required if you specify `startKey`."},"keyStatus":{"in":"query","name":"keyStatus","required":false,"schema":{"type":"string"},"description":"**Apigee Edge for Private Cloud only**. Filter list to apps with specific key status. Valid values include `approved`, `pending`, or `revoked`."},"expand":{"in":"query","name":"expand","required":false,"schema":{"type":"boolean"},"description":"Flag that specifies whether to view expanded details for each app. Set to `true` to view expanded details. Defaults to `false`. Not applicable if you use the `count` or `startKey` query parameters."},"startKey":{"in":"query","name":"startKey","required":false,"schema":{"type":"string"},"description":"**Apigee Edge for Public Cloud only**. ID of the app from which to start displaying the list of apps.\n\n\n\nFor example, if the unfiltered list includes the following app names:\n\n```\n\"companyApp1\",\n\"companyApp2\",\n\"companyApp3\"\n```\n\nIf you set the `startKey` to `companyApp2`, the list will include:\n\n```\n\"companyrApp2\",\n\"companyApp3\"\n```"}},"schemas":{"CompanyApps":{"description":"List of company app details.","type":"object","properties":{"app":{"type":"array","items":{"$ref":"#/components/schemas/CompanyApp"}}}},"CompanyApp":{"description":"Company app details.","type":"object","properties":{"appFamily":{"description":"Output only. App family.","type":"string"},"appId":{"description":"Output only. ID of the app.","type":"string"},"attributes":{"description":"List of attributes used for customizing profile information or for app-specific processing. With Apigee Edge for Public Cloud, the custom attribute limit is 18.","type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"value":{"type":"string"}}}},"callbackUrl":{"description":"Callback URL used by OAuth 2.0 authorization servers to communicate authorization codes back to apps.","type":"string"},"companyName":{"description":"Output only. Name of the company.","type":"string"},"createdAt":{"format":"int32","description":"Output only. Time the app was created in milliseconds since epoch.","type":"integer"},"createdBy":{"description":"Output only. Email address of the developer that created the app.","type":"string"},"credentials":{"description":"Output only. Set of credentials for the app. Credentials are API key/secret pairs associated with API products.","type":"array","items":{"type":"object","properties":{"apiProducts":{"description":"List of API products.","type":"array","items":{"type":"string"}},"attributes":{"description":"List of attributes.","type":"array","items":{"type":"string"}},"consumerKey":{"description":"Consumer API key.","type":"string"},"consumerSecret":{"description":"Consumer secret.","type":"string"},"expiresAt":{"description":"Time the credentials expire in milliseconds since epoch.","format":"int32","type":"integer"},"issuedAt":{"format":"int32","description":"Time the credentials were issued in milliseconds since epoch.","type":"integer"},"scopes":{"description":"OAuth scopes.","type":"array","items":{"type":"string"}},"status":{"description":"Status of the credentials.","type":"string"}}}},"lastModifiedAt":{"format":"int32","description":"Output only. Last modified time as milliseconds since epoch.","type":"integer"},"lastModifiedBy":{"description":"Output only. Email of developer that last modified the app.","type":"string"},"name":{"description":"Name of the company app. Required when creating a company app; not required when updating a company app. The name becomes the unique ID of the app for this organization and company. Names must begin with an alphanumeric character and can contain letters, numbers, spaces, and the following characters: `. _ # - $ %`. While you can use spaces in the name, we recommend that you use camel case, underscores, or hyphens instead. Otherwise, you will have to URL encode the app name when you need to include it in the URL of other Edge API calls.","type":"string"},"scopes":{"description":"Scopes to apply to the app. The specified scope names must already exist on the API product that you associate with the app.","type":"array","items":{"type":"string"}},"status":{"description":"Status of the credential.","type":"string"}}},"CompanyAppRequest":{"description":"Company app request.","type":"object","properties":{"apiProducts":{"description":"List of API products to which the app is associated (when creating or updating an app). The name of the API product is the name returned when you <a href=\"/docs/api-products/1/routes/organizations/%7Borg_name%7D/apiproducts/get\">list API products</a>. For example, if the Display Name of the API product in the Edge UI is `Premium API Product`, then the name is `premium-api-product` (all lowercase with spaces replaced by hyphens). You can add API products later when you <a href=\"/docs/developer-apps/1/routes/organizations/%7Borg_name%7D/developers/%7Bdeveloper_email%7D/apps/%7Bapp_name%7D/put\">update the developer app</a>. Existing API products are listed in the `credentials` array.","type":"array","items":{"type":"string"}},"attributes":{"description":"List of attributes used for customizing profile information or for app-specific processing. With Apigee Edge for Public Cloud, the custom attribute limit is 18.","type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"value":{"type":"string"}}}},"callbackUrl":{"description":"Callback URL used by OAuth 2.0 authorization servers to communicate authorization codes back to apps.","type":"string"},"keyExpiresIn":{"type":"integer","format":"int32","description":"Lifetime of the consumer key that will be generated for the developer app, in milliseconds. The default value, `-1`, indicates an infinite validity period. Once set, the expiration can't be updated."},"name":{"description":"Name of the company app. Required when creating a company app; not required when updating a company app. The name becomes the unique ID of the app for this organization and company. Names must begin with an alphanumeric character and can contain letters, numbers, spaces, and the following characters: `. _ # - $ %`. While you can use spaces in the name, we recommend that you use camel case, underscores, or hyphens instead. Otherwise, you will have to URL encode the app name when you need to include it in the URL of other Edge API calls.","type":"string"},"scopes":{"description":"Scopes to apply to the app. The specified scope names must already exist on the API product that you associate with the app.","type":"array","items":{"type":"string"}},"status":{"description":"Status of the credential.","type":"string"}}}}}}
/ organizations / {org_name} / companies / {company_name} / apps
/ organizations / {org_name} / companies / {company_name} / apps / {app_name}
Extensions API OpenAPI	{"openapi":"3.0.1","info":{"title":"Extensions API","description":"Add, update, and configure extensions in your Apigee organization. \n\nExtensions enable you to integrate external resources into your API proxies. For example, you could integrate Google Cloud Platform services such as Google Cloud Storage. At run time, an API proxy uses the extension to exchange requests and responses with the external resource.\n\nNote that you must authenticate with this API using an OAuth token; basic authentication is not supported. For more about retrieving a token, see <a href=\"https://docs.apigee.com/api-platform/system-administration/using-gettoken\">Using get_token</a>.","version":"1.0"},"servers":[{"url":"https://api.enterprise.apigee.com/"}],"security":[{"OAuth":[]}],"paths":{"/v1/organizations/{org}/environments/{env}/extensions":{"get":{"tags":["Extensions"],"summary":"Get a collection of extensions","description":"Gets a collection of extensions. \nYou can divide the collection into pages of a particular size with the `size` parameter. Navigate the pages by following links in the `next` and `previous` properties.\n\n**Notes**: \n\n* You must be an organization administrator to call this API.\n* **This API cannot be executed using the Try this API panel**.","parameters":[{"$ref":"#/components/parameters/org"},{"$ref":"#/components/parameters/env"},{"$ref":"#/components/parameters/size"},{"$ref":"#/components/parameters/name"},{"$ref":"#/components/parameters/nameLike"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExtensionCollectionResponse"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"post":{"tags":["Extensions"],"summary":"Creates a new extension","description":"Creates a new extension by configuring an instance of an installed extension and adding it to the specified organization. After you create the extension, use the Update an extension to deploy it.\n\n**Notes**: \n\n* You must be an organization administrator to call this API.\n* **This API cannot be executed using the Try this API panel**.\n\nThis API requires that you pass the package name and version number of the extension. Use the Get public extension packages API to get all available packages and versions.","operationId":"createExtension","parameters":[{"$ref":"#/components/parameters/org"},{"$ref":"#/components/parameters/env"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Extension"}}},"required":true},"responses":{"201":{"description":"Created","headers":{"Etag":{"description":"Etag implemented according to RFC 5789","schema":{"type":"string"}},"Location":{"description":"Location of created resource. as per https://tools.ietf.org/html/rfc7231#section-7.1.2","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExtensionResponse"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"delete":{"tags":["Extensions"],"summary":"Delete all extensions in an environment","description":"Deletes all extensions in an environment.\n**Note**: **This API cannot be executed using the Try this API panel**.","operationId":"deleteAllExtensionsOrg","parameters":[{"$ref":"#/components/parameters/org"},{"$ref":"#/components/parameters/env"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/v1/organizations/{org}/environments/{env}/extensions/{id}":{"get":{"tags":["Extensions"],"summary":"Get an extension","description":"Gets an extension. \n\n**Note**: **This API cannot be executed using the Try this API panel**.\n\nWhen you get a collection of extensions, each item in the collection includes a `self` property with a URL pointing to the item, including its ID. Pass that ID value in this request.","operationId":"getExtension","parameters":[{"$ref":"#/components/parameters/org"},{"$ref":"#/components/parameters/env"},{"$ref":"#/components/parameters/id"}],"responses":{"200":{"description":"OK","headers":{"Etag":{"description":"Etag implemented according to RFC 5789","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExtensionResponse"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"delete":{"tags":["Extensions"],"summary":"Deletes an extension","description":"Deletes an extension. \n\n**Note**: **This API cannot be executed using the Try this API panel**.\n\nWhen you retrieve a list of extensions, each extension in the collection includes a `self` property with a URL to the extension, including its ID. Use that ID value in this request.","operationId":"deleteExtension","parameters":[{"$ref":"#/components/parameters/org"},{"$ref":"#/components/parameters/env"},{"$ref":"#/components/parameters/id"}],"responses":{"200":{"description":"OK","content":{}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"patch":{"tags":["Extensions"],"summary":"Updates an extension","description":"Updates an extension. \n\n**Note**: **This API cannot be executed using the Try this API panel**.\n\nWhen you retrieve a list of extensions, each extension in the collection includes a self property with a URL to the extension, including its ID. Use the ID value in that URL to complete the URL here.\n\nTo deploy the an extension, specify `{state:\"DEPLOYED\"}` in the body. The state property can take the following values:\n\n* `DEPLOYED`\n* `UNDEPLOYED`\n\nWhen you set state `UNDEPLOYED`, you cannot update `name`, `packageName`, `version`, or `configuration`. You can only specify `description`, `credentials`, and `state`.\n\nEach extension type defines the properties that you can set in the configuration object. For more on each extension type, see <a href=\"https://docs.apigee.com/api-platform/reference/extensions/reference-overview-extensions\">Extensions reference overview</a>. For example, when the cponfiguration object for the <a href=\"https://docs.apigee.com/api-platform/reference/extensions/google-stackdriver-logging/google-stackdriver-logging-extension-137\">Google Stackdriver Logging Extension</a> is: `{\"projectId\": \"gcp_project_name\"}`\n\n**Note**: You must be an organization administrator to call this API.","operationId":"updateExtension","parameters":[{"$ref":"#/components/parameters/org"},{"$ref":"#/components/parameters/env"},{"$ref":"#/components/parameters/id"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Extension"}}},"required":false},"responses":{"200":{"description":"OK","headers":{"Etag":{"description":"Etag implemented according to RFC 5789","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExtensionOutput"}}}}},"x-codegen-request-body-name":"extension"}},"/v1/organizations/{org}/environments/{env}/extensions/{id}/logs":{"get":{"tags":["Extensions"],"summary":"Get the logs of a deployed extension","description":"Gets the logs of a deployed extension. When you get a collection, each item in the collection includes a `self` property with a URL to the item, including its ID.\n\n**Note**: **This API cannot be executed using the Try this API panel**.","operationId":"getLogsExtension","parameters":[{"$ref":"#/components/parameters/org"},{"$ref":"#/components/parameters/env"},{"$ref":"#/components/parameters/id"},{"$ref":"#/components/parameters/size"},{"$ref":"#/components/parameters/token"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExtensionLogsResponse"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/extensionpackages":{"get":{"tags":["Extensions"],"summary":"Get public extension packages","description":"Gets public extension packages using the query parameters to search for specific values. To get a list of all extension packages, don't specify any search values. When you get a collection, each item in the collection includes a `self` property with a URL to the item, including its ID. You can use that ID to retrieve details for a specific extension.\n\n**Note**: **This API cannot be executed using the Try this API panel**.","operationId":"getPublicExtensionPackages","parameters":[{"$ref":"#/components/parameters/nameq"},{"$ref":"#/components/parameters/description"},{"$ref":"#/components/parameters/keywords"},{"$ref":"#/components/parameters/size"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExtensionPackagesResponse"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/extensionpackages/{name}/{version}":{"get":{"tags":["Extensions"],"summary":"Get the permalink for the specified extension package","description":"Gets the permalink for the specified extension package.\n\n**Note**: **This API cannot be executed using the Try this API panel**.","operationId":"getPermalinkExtension","parameters":[{"$ref":"#/components/parameters/name"},{"$ref":"#/components/parameters/version"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExtensionPackageOutput"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}}},"components":{"securitySchemes":{"OAuth":{"type":"apiKey","name":"Authorization","in":"header","description":"For OAuth, enter the following in the Key field: Bearer %your-token% To get a token, see https://docs.apigee.com/api-platform/system-administration/using-oauth2#get-the-tokens"}},"parameters":{"org":{"name":"org","in":"path","description":"Organization name.","required":true,"schema":{"type":"string"}},"env":{"name":"env","in":"path","description":"Environment name.","required":true,"schema":{"type":"string"}},"id":{"name":"id","in":"path","description":"Unique identifier for the extension. To get the extension ID, see xxx. The ID is the last part of the `self` property of each extension.","required":true,"schema":{"type":"string"}},"name":{"name":"name","in":"path","description":"Extension package name.","required":true,"schema":{"type":"string"}},"version":{"name":"version","in":"path","description":"Extension package version.","required":true,"schema":{"type":"string"}},"size":{"name":"size","in":"query","description":"Number of entries to include in a page.","required":false,"schema":{"type":"integer","default":25}},"nameq":{"name":"name","in":"query","description":"Exact name of an extension to query for.","required":false,"schema":{"type":"string"}},"nameLike":{"name":"nameLike","in":"query","required":false,"description":"Name prefix to filter extensions by.","schema":{"type":"string"}},"token":{"name":"token","in":"query","description":"Next page token retrieved from the response of previous logs request.","schema":{"type":"string"}},"description":{"name":"description","in":"query","description":"Value to search for in extension descriptions.","schema":{"type":"string"}},"keywords":{"name":"keywords","in":"query","description":"A comma-separated list of keywords to search for in extension keyword properties.","schema":{"type":"string"}}},"schemas":{"ExtensionCollectionResponse":{"allOf":[{"$ref":"#/components/schemas/APIResponse"},{"$ref":"#/components/schemas/CollectionResponse"},{"required":["contents"],"type":"object","properties":{"contents":{"type":"array","items":{"$ref":"#/components/schemas/ExtensionResponse"}}}}]},"ExtensionPackagesCollectionResponse":{"allOf":[{"$ref":"#/components/schemas/APIResponse"},{"$ref":"#/components/schemas/CollectionResponse"},{"required":["contents"],"type":"object","properties":{"contents":{"type":"array","items":{"$ref":"#/components/schemas/ExtensionPackage"}}}}]},"ExtensionResponse":{"allOf":[{"$ref":"#/components/schemas/ExtensionOutput"}]},"ExtensionPackageOutput":{"allOf":[{"$ref":"#/components/schemas/APIResponse"},{"$ref":"#/components/schemas/ExtensionPackage"}]},"ExtensionOutput":{"allOf":[{"$ref":"#/components/schemas/Extension"},{"$ref":"#/components/schemas/APIResponse"},{"type":"object","properties":{"etag":{"type":"string","description":"TODO"},"created":{"type":"string","description":"Timestamp indicating when this item was created on the system."},"updated":{"type":"string","description":"Timestamp indicating when this item was last updated on the system."},"createdBy":{"type":"string","description":"Username for the user who created this item on the system."},"updatedBy":{"type":"string","description":"Username for the user who last updated this item on the system."},"credentialsCheckSum":{"type":"string","description":"A checksum representing the credentials given to an extension for authenticating with the extension\\'s external resource."},"regions":{"type":"array","description":"A list of regions the Extension is deployed to.","items":{"type":"string"}}}}]},"ExtensionLogsResponse":{"allOf":[{"$ref":"#/components/schemas/APIResponse"},{"$ref":"#/components/schemas/CollectionResponse"},{"type":"object","properties":{"contents":{"type":"array","items":{"$ref":"#/components/schemas/ExtensionLogEntry"}}}}]},"ExtensionPackagesResponse":{"allOf":[{"$ref":"#/components/schemas/APIResponse"},{"$ref":"#/components/schemas/CollectionResponse"},{"type":"object","properties":{"contents":{"type":"array","items":{"$ref":"#/components/schemas/ExtensionPackage"}}}}]},"Extension":{"required":["name","packageName","version"],"type":"object","properties":{"name":{"type":"string","description":"Name of the extension."},"description":{"type":"string","description":"Description of the extension."},"packageName":{"type":"string","description":"Name of the extension package that this extension is configured from."},"version":{"type":"string","description":"Version number for this extension."},"configuration":{"type":"object","properties":{},"description":"JSON describing configuration properties and values for this extension."},"credentials":{"type":"string","description":"base64 encoded string containing the credentials to be used by the deployed extension. Input only."},"state":{"type":"string","description":"The extension's deployment state on the system.","default":"UNDEPLOYED","enum":["DEPLOYED","UNDEPLOYED","DEPLOYING","UNDEPLOYING","ERROR"]},"tenant":{"type":"string","description":"Tenant name."}}},"ExtensionLogEntry":{"required":["textPayload","timestamp"],"type":"object","properties":{"textPayload":{"type":"string","description":"The log message."},"timestamp":{"type":"string","description":"The log entry\\'s timestamp."}}},"ExtensionPackage":{"required":["actions","license","packageName","publishDate","version"],"type":"object","properties":{"actions":{"type":"array","description":"An array of objects describing actions this extension supports, including each action's main path, along with input and output properties (if any).","items":{"type":"object","properties":{}}},"author":{"type":"object","description":"Authors.","properties":{"name":{"description":"Name of author.","type":"string"}}},"bugs":{"type":"object","description":"Authors.","properties":{"url":{"description":"Name of author.","type":"string"}}},"configuration":{"type":"object","description":"Configuration details.","properties":{"display_name":{"description":"Display name for the extension package.","type":"string"},"name":{"description":"Name of the extension package.","type":"string"},"type":{"description":"Type.","type":"string"},"validators":{"type":"array","description":"An array of validators for this extension package.","items":{"type":"string"}}}},"contributors":{"type":"object","description":"Contributors.","properties":{"name":{"description":"Name of author.","type":"string"}}},"description":{"type":"string","description":"A brief description of what the extension does."},"display_name":{"type":"string","description":"Display name for the extension package."},"dist":{"type":"object","properties":{"sha512sum":{"type":"string","description":"Checksum for validating the distribution."},"tarball":{"type":"string","description":"URL of the extension package distribution file."}},"description":"URL of the extension package distribution file, along with a checksum for validating the distribution."},"engines":{"type":"object","properties":{"node":{"type":"string","description":"Node type."}},"description":"Node types."},"homepage":{"type":"string","description":"Home page of the extension package."},"icon":{"type":"string","description":"URL to the icon."},"keywords":{"type":"array","description":"An array of keywords to use when searching for this extension package.","items":{"type":"string"}},"kind":{"type":"string","description":"Set to `extensionpackage`."},"license":{"type":"string","description":"The open source license under which this extension\\'s source code is protected, such as `Apache-2.0`."},"name":{"type":"string","description":"Name of the extension package."},"packageName":{"type":"string","description":"Name of this extension."},"released":{"type":"string","description":"Date and time the extension package was released."},"repository":{"type":"object","description":"Configuration details.","properties":{"type":{"description":"Type of repository.","type":"string"},"url":{"type":"string","description":"URL of the repository."}}},"scripts":{"type":"object","description":"Configuration details.","properties":{"test":{"description":"Test script.","type":"string"},"main":{"type":"string","description":"Main script."}}},"spec_version":{"type":"string","description":"Version of the associated OpenAPI Specification."},"version":{"type":"string","description":"Version of this extension package."}}},"APIResponse":{"required":["kind","self"],"type":"object","properties":{"self":{"type":"string","description":"URL for specifying this collection item in API requests."},"kind":{"type":"string","description":"The kind of item this is, such as extension, extensionpackage, or page (as for a collection of extensions)."}}},"CollectionResponse":{"type":"object","properties":{"pageOf":{"type":"string","description":"A link to the resource the page represents"},"totalPages":{"type":"integer","description":"Total number of pages returned."},"total":{"type":"integer","description":"Total number of items returned."},"next":{"type":"string","description":"A link to the next page in the collection, if applicable. For logs, this is just a token to be included on a subsequent request."},"previous":{"type":"string","description":"A link to the previous page in the collection, if applicable."},"first":{"type":"string","description":"A link to the first page in the collection."}}},"ErrorResponse":{"required":["messageID","messageText"],"type":"object","properties":{"messageID":{"type":"string","description":"Unique ID of the message."},"messageText":{"type":"string","description":"The message text."},"documentation":{"type":"string","description":"Further information to use in resolving the error."}}}}}}
/ v1 / organizations / {org} / environments / {env} / extensions
/ v1 / organizations / {org} / environments / {env} / extensions / {id}
/ v1 / organizations / {org} / environments / {env} / extensions / {id} / logs
/ extensionpackages
/ extensionpackages / {name} / {version}
Debug Sessions API OpenAPI	{"openapi":"3.0.0","servers":[{"url":"https://api.enterprise.apigee.com/v1"}],"info":{"title":"Debug Sessions API","description":"Create debug sessions in Apigee Edge to record specified messages and associated pipeline processing metadata for debugging purposes.","version":"1.0"},"security":[{"Basic":[]},{"OAuth":[]}],"paths":{"/organizations/{org_name}/environments/{env_name}/apis/{api_name}/revisions/{revision_number}/debugsessions":{"get":{"tags":["Debug Sessions"],"summary":"List debug sessions","description":"Lists debug sessions that were created either by using the <a href=\"https://apidocs.apigee.com/docs/debug-sessions/1/routes/organizations/%7Borg_name%7D/environments/%7Benv_name%7D/apis/%7Bapi_name%7D/revisions/%7Brevision_number%7D/debugsessions/post\">Create debug session API</a> or the <a href=\"https://docs.apigee.com/api-platform/debug/using-trace-tool-0\">Trace tool</a> in the Edge UI.","operationId":"listDebugSessions","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/env_name"},{"$ref":"#/components/parameters/api_name"},{"$ref":"#/components/parameters/revision_number"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"type":"string","description":"Debug session name."}}}}},"400":{"description":"Bad request"}}},"post":{"tags":["Debug Sessions"],"summary":"Create a debug session","description":"Creates a debug session.\n\nA debug session records detailed information on messages, flow processing, and policy execution during processing by an API proxy.\n\nThe data returned in the debug session is a single XML or JSON representation of all debug data for each message exchange. The debug data is the same as that used to generate the <a href=\"https://docs.apigee.com/api-platform/debug/using-trace-tool-0\">Trace view</a> in the Edge UI.\n\nA debug session captures a maximum of 20 messages or records for a maximum of 10 minutes (by default), whichever comes first.\n\nDebugging involves the following steps:\n\n1. Start a debug session by creating a debug session.\n2. Send a message for that deployed API proxy.\n3. Retrieve the debug data associated with the debug session. The data can be fetched by issuing a `GET` call on the session.\n4. Close the debug session. (Closing the debug session discards all the associated data).\n\nWhen creating a debug session, you can set a filter that captures only API calls with specific query parameters and/or HTTP headers. Filtering is particularly useful for troubleshooting. \n\nFor example, if you wanted to capture only API calls with an `Accept: application/json` header, you'd create a debug session with that filter. Filtering API calls in a debug session is particularly useful for root-case analysis to target specific calls that may be causing problems.\n\nThe filter is set using by appending the filter details as a query parameter to the API call. The query parameters begin with either header_ or qparam_ to indicate a header or query parameter. For example:\n\n* **header_name=value**: Captures only calls that contain the specific header and value. Header name and value must be URL encoded. For example: `header_Accept=application%2Fjson`\n\n* **qparam_name=value**: Captures only calls that contain the specific query parameter and value. Query parameter name and value must be URL encoded. For example: `qparam_user=john%20doe`\n\nIf you use multiple headers and/or query parameters in the filter, all conditions must be met in order for API call to be captured. Here's how the previous two examples would be combined into a single filter:\n\n`header_Accept=application%2Fjson&qparam_user=john%20doe`\n\nThe filter query parameters are combined with the query parameters you set in the fields below.","operationId":"createDebugSession","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/env_name"},{"$ref":"#/components/parameters/api_name"},{"$ref":"#/components/parameters/revision_number"},{"$ref":"#/components/parameters/session"},{"$ref":"#/components/parameters/timeout"}],"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"type":"string","description":"Debug session name."}}}},"400":{"description":"Bad request"}}}},"/organizations/{org_name}/environments/{env_name}/apis/{api_name}/revisions/{revision_number}/debugsessions/{session_name}":{"delete":{"tags":["Debug Sessions"],"summary":"Delete debug session","description":"Deletes a debug session.","operationId":"deleteDebugSession","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/env_name"},{"$ref":"#/components/parameters/api_name"},{"$ref":"#/components/parameters/revision_number"},{"$ref":"#/components/parameters/session_name"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"string","description":"Debug session name."}}}},"400":{"description":"Bad request"}}}},"/organizations/{org_name}/environments/{env_name}/apis/{api_name}/revisions/{revision_number}/debugsessions/{session_name}/data":{"get":{"tags":["Debug Sessions"],"summary":"Get debug session transaction IDs","description":"Gets transaction IDs for a debug session that was created either by using the <a href=\"https://apidocs.apigee.com/docs/debug-sessions/1/routes/organizations/%7Borg_name%7D/environments/%7Benv_name%7D/apis/%7Bapi_name%7D/revisions/%7Brevision_number%7D/debugsessions/post\">Create debug session API</a> or the <a href=\"https://docs.apigee.com/api-platform/debug/using-trace-tool-0\">Trace tool</a> in the Edge UI.\n\nEach item in the returned list is the unique ID for a debug session transaction associated with a single request to the API proxy specified.\n\nUse the <a href=\"https://apidocs.apigee.com/docs/debug-sessions/1/routes/organizations/%7Borg_name%7D/environments/%7Benv_name%7D/apis/%7Bapi_name%7D/revisions/%7Brevision_number%7D/debugsessions/%7Bsession_name%7D/data/%7Btransaction_id%7D/get\">Get debug session transaction data API</a> to retrieve the raw debug data for the transaction.","operationId":"getDebugSessionTransactionIDs","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/env_name"},{"$ref":"#/components/parameters/api_name"},{"$ref":"#/components/parameters/revision_number"},{"$ref":"#/components/parameters/session_name"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"type":"string","description":"Debug session transaction IDs."}}}}},"400":{"description":"Bad request"}}}},"/organizations/{org_name}/environments/{env_name}/apis/{api_name}/revisions/{revision_number}/debugsessions/{session_name}/data/{transaction_id}":{"get":{"tags":["Debug Sessions"],"summary":"Get debug session transaction data","description":"Gets debug session transaction data. To get a list of transaction IDs, see Get debug session transaction IDs. \n\nThe debug data returned by this APl is the same debug data that populates the Trace tool in the Edge management UI. For more information on the Trace tool, see <a href=\"https://docs.apigee.com/api-platform/debug/using-trace-tool-0\">Using the Trace tool</a>.","operationId":"getDebugSessionTransactionData","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/env_name"},{"$ref":"#/components/parameters/api_name"},{"$ref":"#/components/parameters/revision_number"},{"$ref":"#/components/parameters/session_name"},{"$ref":"#/components/parameters/transaction_id"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DebugSession"},"example":{"completed":true,"point":[{"id":"Paused","results":[]},{"id":"Resumed","results":[]},{"id":"StateChange","results":[{"ActionResult":"DebugInfo","properties":{"property":[{"name":"To","value":"REQ_HEADERS_PARSED"},{"name":"From","value":"REQ_START"}]},"timestamp":"08-09-15 14:44:03:825"}]}]}}}},"400":{"description":"Bad request"}}}}},"components":{"securitySchemes":{"Basic":{"type":"http","scheme":"basic","description":"Multi-factor authentication is not supported."},"OAuth":{"type":"apiKey","name":"Authorization","in":"header","description":"For OAuth, enter the following in the Key field: Bearer %your-token% (see https://docs.apigee.com/api-platform/system-administration/using-oauth2#get-the-tokens)"}},"parameters":{"org_name":{"in":"path","name":"org_name","required":true,"schema":{"type":"string"},"description":"Organization name."},"env_name":{"in":"path","name":"env_name","required":true,"schema":{"type":"string"},"description":"Environment name."},"api_name":{"in":"path","name":"api_name","required":true,"schema":{"type":"string"},"description":"API proxy name."},"revision_number":{"in":"path","name":"revision_number","required":true,"schema":{"type":"string"},"description":"Revision number."},"session_name":{"in":"path","name":"session_name","required":true,"schema":{"type":"string"},"description":"Debug session name."},"transaction_id":{"in":"path","name":"transaction_id","required":true,"schema":{"type":"string"},"description":"ID of the transaction."},"session":{"in":"query","name":"session","required":true,"schema":{"type":"string"},"description":"Debug session name."},"timeout":{"in":"query","name":"timeout","required":false,"schema":{"type":"string"},"description":"Time in seconds after which the particular session should be discarded. Defaults to 600 seconds."}},"schemas":{"DebugSession":{"description":"Debug sessions transaction details.","type":"object","properties":{"completed":{"description":"Flag that specifies whether the transcation completed.","type":"boolean"},"point":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"For example, `Paused` or `Resumed`."},"results":{"type":"array","items":{"type":"object","properties":{"ActionResult":{"type":"string","description":"Action information, such as `DebugInfo`."},"properties":{"type":"object","properties":{"property":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"value":{"type":"string"}}}}}},"timestamp":{"type":"string","description":"Timestamp of the transaction."}}}}}}}}}}}}
/ organizations / {org_name} / environments / {env_name} / apis / {api_name} / revisions / {revision_number} / debugsessions
/ organizations / {org_name} / environments / {env_name} / apis / {api_name} / revisions / {revision_number} / debugsessions / {session_name}
/ organizations / {org_name} / environments / {env_name} / apis / {api_name} / revisions / {revision_number} / debugsessions / {session_name} / data
/ organizations / {org_name} / environments / {env_name} / apis / {api_name} / revisions / {revision_number} / debugsessions / {session_name} / data / {transaction_id}
OAuth 2.0 Authorization Codes API OpenAPI	{"openapi":"3.0.0","servers":[{"url":"https://api.enterprise.apigee.com/v1"}],"info":{"title":"OAuth 2.0 Authorization Codes API","description":"Manage OAuth 2.0 authorization codes.","version":"1.0"},"security":[{"Basic":[]},{"OAuth":[]}],"paths":{"/organizations/{org_name}/oauth2/authorizationcodes":{"get":{"tags":["OAuth 2.0"],"summary":"List OAuth 2.0 authorization codes","description":"Lists OAuth 2.0 authorization codes in an organization.","operationId":"listOAuth20AuthCodes","parameters":[{"$ref":"#/components/parameters/org_name"}],"responses":{"200":{"description":"OK"},"400":{"description":"Bad request"}}}},"/organizations/{org_name}/oauth2/authorizationcodes/{authorization_code}":{"get":{"tags":["OAuth 2.0"],"summary":"Get OAuth 2.0 authorization code","description":"Gets details for the specified OAuth 2.0 authorization code.","operationId":"getOAuth20AuthCode","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/authorization_code"}],"responses":{"200":{"description":"OK"},"400":{"description":"Bad request"}}},"delete":{"tags":["OAuth 2.0"],"summary":"Delete OAuth 2.0 authorization code","description":"Deletes the specified OAuth 2.0 authorization code.","operationId":"deleteOAuth20AuthCode","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/authorization_code"}],"responses":{"200":{"description":"OK"},"400":{"description":"Bad request"}}}}},"components":{"securitySchemes":{"Basic":{"type":"http","scheme":"basic","description":"Multi-factor authentication is not supported."},"OAuth":{"type":"apiKey","name":"Authorization","in":"header","description":"For OAuth, enter the following in the Key field: Bearer %your-token% (see https://docs.apigee.com/api-platform/system-administration/using-oauth2#get-the-tokens)"}},"parameters":{"org_name":{"in":"path","name":"org_name","required":true,"schema":{"type":"string"},"description":"Organization name."},"authorization_code":{"in":"path","name":"authorization_code","required":true,"schema":{"type":"string"},"description":"Authorization code."}}}}
/ organizations / {org_name} / oauth2 / authorizationcodes
/ organizations / {org_name} / oauth2 / authorizationcodes / {authorization_code}
Developers API OpenAPI	{"openapi":"3.0.0","servers":[{"url":"https://api.enterprise.apigee.com/v1"}],"info":{"title":"Developers API","description":"Developers must register with an organization on Apigee Edge. After they are registered, developers register their apps, choose the APIs they want to use, and receive the unique API credentials (consumer keys and secrets) needed to access your APIs.","version":"1.0"},"security":[{"Basic":[]},{"OAuth":[]}],"paths":{"/organizations/{org_name}/developers":{"get":{"tags":["Developer"],"summary":"List developers","description":"Lists all developers in an organization by email address. This call does not list any company developers who are a part of the organization.\n\nTo get the developers associated with a specific app, specify the name of the app using the `app` query parameter.\n\nWith Apigee Edge for Public Cloud:\n\n* The limit on the number of developers returned is 1000.\n* Paginate the list of developers returned using the `startKey` and `count` query parameters.","operationId":"listDevelopers","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/expand"},{"$ref":"#/components/parameters/count"},{"$ref":"#/components/parameters/startKey"},{"$ref":"#/components/parameters/app"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"oneOf":[{"type":"array","items":{"type":"string"}},{"$ref":"#/components/schemas/Developers"}]},"example":["developer1","developer2"]}}},"400":{"description":"Bad request"}}},"post":{"tags":["Developer"],"summary":"Create developer","description":"Creates a profile for a developer in an organization. After the developer is created, they can register an app and receive an API key.\n\nThe developer is always created with a status of `active`. To set the status explicitly, use the <a href=\"/docs/developers/1/routes/organizations/%7Borg_name%7D/developers/%7Bdeveloper_email%7D/post\">Set developer status API</a>.\n\nWhen creating a developer, you can define one or more monetization attributes as custom attributes. For more information about the monetization attributes, see <a href=\"https://docs.apigee.com/api-platform/publish/adding-developers-your-api-product#monetization-attributes\">Configuring monetization attributes</a>. For example:\n\n\n```\n{\n \"email\" : \"developer_email\",\n \"firstName\" : \"first_name\",\n \"lastName\" : \"last_name\",\n \"userName\" : \"user_name\",\n \"attributes\" : [{\n \"name\": \"MINT_BILLING_TYPE\",\n \"value\": \"one of PREPAID | POSTPAID\"\n }]\n}\n```","operationId":"createDeveloper","parameters":[{"$ref":"#/components/parameters/org_name"}],"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Developer"},"example":{"apps":["app1","app2"],"companies":[],"email":"ahamilton@example.com","developerId":"4707ceee-1234-abcd","firstName":"Alex","lastName":"Hamilton","userName":"ahamilton@example.com","organizationName":"myorg","status":"active","attributes":[{"name":"ADMIN_EMAIL","value":"admin@example.com"}],"createdAt":1486474235912,"createdBy":"admin@example.com","lastModifiedAt":1486474783590,"lastModifiedBy":"admin@example.com"}}}},"400":{"description":"Bad request"}},"requestBody":{"description":"Developer details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeveloperRequest"},"example":{"email":"ahamilton@example.com","firstName":"Alex","lastName":"Hamilton","userName":"ahamilton@example.com","attributes":[{"name":"ADMIN_EMAIL","value":"admin@example.com"}]}}}}}},"/organizations/{org_name}/developers/{developer_email}":{"get":{"tags":["Developer"],"summary":"Get developer","description":"Gets the profile for a developer by email address. With Apigee Edge for Public Cloud, the response includes only the first 100 apps.","operationId":"getDeveloper","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/developer_email"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Developer"},"example":{"apps":["app1","app2"],"companies":[],"email":"ahamilton@example.com","developerId":"4707ceee-1234-abcd","firstName":"Alex","lastName":"Hamilton","userName":"ahamilton@example.com","organizationName":"myorg","status":"active","attributes":[{"name":"ADMIN_EMAIL","value":"admin@example.com"}],"createdAt":1486474235912,"createdBy":"admin@example.com","lastModifiedAt":1486474783590,"lastModifiedBy":"admin@example.com"}}}},"400":{"description":"Bad request"}}},"delete":{"tags":["Developer"],"summary":"Delete developer","description":"Deletes a developer from an organization. All apps and API keys associated with the developer are also removed from the organization.\n\n**Note**: To avoid permanently deleting developers and their artifacts, consider deactivating developers instead using the <a href=\"/docs/developers/1/routes/organizations/%7Borg_name%7D/developers/%7Bdeveloper_email%7D/post\">Set developer status API</a>.\n\nWith Apigee Edge for Public Cloud, deletion of the developer and associated artifacts happens asynchronously. The developer is deleted immediately, but the resources associated with that developer, such as apps, may take anywhere from a few seconds to a few minutes to be deleted.","operationId":"deleteDeveloper","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/developer_email"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Developer"},"example":{"apps":["app1","app2"],"companies":[],"email":"ahamilton@example.com","developerId":"4707ceee-1234-abcd","firstName":"Alex","lastName":"Hamilton","userName":"ahamilton@example.com","organizationName":"myorg","status":"active","attributes":[{"name":"ADMIN_EMAIL","value":"admin@example.com"}],"createdAt":1486474235912,"createdBy":"admin@example.com","lastModifiedAt":1486474783590,"lastModifiedBy":"admin@example.com"}}}},"400":{"description":"Bad request"}}},"post":{"tags":["Developer"],"summary":"Set developer status","description":"Sets a developer's status to `active` or `inactive` for a specific organization. Run this API for each organization where you want to change the developer's status.\n\nBy default, the status of a developer is set to `active`. If you set a developer's status to `inactive`, the API keys assigned to the developer's apps are no longer valid even though keys continue to show a status of \"Approved\". Inactive developers can still sign in to the developer portal and create apps; however, the new keys that get created won't be valid until the developer is set to `active`.\n\nThe HTTP status code for success is: `204 No Content`","operationId":"setDeveloperStatus","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/developer_email"},{"$ref":"#/components/parameters/action"}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad request"}}},"put":{"tags":["Developer"],"summary":"Update developer","description":"Update an existing developer profile.\n\nTo add new values or update existing values, submit the new or updated portion of the developer profile along with the rest of the existing developer profile, even if no values are changing.\n\nTo delete attributes from a developer profile, submit the entire profile without the attributes that you want to delete.\n\n**Apigee Edge for Public Cloud only**: OAuth access tokens and Key Management Service (KMS) entities (apps, developers, and API products) are cached for 180 seconds (current default). Any custom attributes associated with these entities also get cached for at least 180 seconds after the entity is accessed at runtime. Therefore, an ExpiresIn element on the OAuthV2 policy won't be able to expire an access token in less than 180 seconds.","operationId":"updateDeveloper","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/developer_email"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Developer"},"example":{"apps":["app1","app2"],"companies":[],"email":"ahamilton@example.com","developerId":"4707ceee-1234-abcd","firstName":"Alex","lastName":"Hamilton","userName":"ahamilton@example.com","organizationName":"myorg","status":"active","attributes":[{"name":"ADMIN_EMAIL","value":"admin@example.com"}],"createdAt":1486474235912,"createdBy":"admin@example.com","lastModifiedAt":1486474783590,"lastModifiedBy":"admin@example.com"}}}},"400":{"description":"Bad request"}},"requestBody":{"description":"Developer details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeveloperRequest"},"example":{"email":"ahamilton@example.com","firstName":"Alex","lastName":"Hamilton","userName":"ahamilton@example.com","attributes":[{"name":"ADMIN_EMAIL","value":"admin@example.com"}]}}}}}},"/organizations/{org_name}/developers/{developer_email}/attributes":{"get":{"tags":["Developer"],"summary":"Get developer attributes","description":"Gets developer attributes and their values.","operationId":"getDeveloperAttributes","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/developer_email"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Attributes"},"example":{"attribute":[{"name":"ADMIN_EMAIL","value":"admin@example.com"}]}}}},"400":{"description":"Bad request"}}},"post":{"tags":["Developer"],"summary":"Update developer attributes","description":"Updates or creates developer attributes.\n\nThis API replaces the current list of attributes with the attributes specified in the request body. This lets you update existing attributes, add new attributes, or delete existing attributes by omitting them from the request body.\n\n**Apigee Edge for Public Cloud only**: OAuth access tokens and Key Management Service (KMS) entities (apps, developers, and API products) are cached for 180 seconds (current default). Any custom attributes associated with these entities also get cached for at least 180 seconds after the entity is accessed at runtime. Therefore, an ExpiresIn element on the OAuthV2 policy won't be able to expire an access token in less than 180 seconds.","operationId":"updateDeveloperAttributes","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/developer_email"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Attributes"},"example":{"attribute":[{"name":"ADMIN_EMAIL","value":"admin@example.com"}]}}}},"400":{"description":"Bad request"}},"requestBody":{"description":"Developer attributes.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Attributes"},"example":{"attribute":[{"name":"ADMIN_EMAIL","value":"admin@example.com"}]}}}}}},"/organizations/{org_name}/developers/{developer_email}/attributes/{attribute_name}":{"get":{"tags":["Developer"],"summary":"Get developer attribute","description":"Gets the value of a developer attribute.","operationId":"getDeveloperAttribute","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/developer_email"},{"$ref":"#/components/parameters/attribute_name"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Attribute"},"example":{"name":"ADMIN_EMAIL","value":"admin@example.com"}}}},"400":{"description":"Bad request"}}},"delete":{"tags":["Developer"],"summary":"Delete developer attribute","description":"Deletes a developer attribute.","operationId":"deleteDeveloperAttribute","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/developer_email"},{"$ref":"#/components/parameters/attribute_name"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Attribute"},"example":{"name":"ADMIN_EMAIL","value":"admin@example.com"}}}},"400":{"description":"Bad request"}}},"post":{"tags":["Developer"],"summary":"Update developer attribute","description":"Update the value of a developer attribute.\n\n**Apigee Edge for Public Cloud only**: OAuth access tokens and Key Management Service (KMS) entities (apps, developers, and API products) are cached for 180 seconds (current default). Any custom attributes associated with these entities also get cached for at least 180 seconds after the entity is accessed at runtime. Therefore, an ExpiresIn element on the OAuthV2 policy won't be able to expire an access token in less than 180 seconds.","operationId":"updateDeveloperAttribute","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/developer_email"},{"$ref":"#/components/parameters/attribute_name"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Attribute"},"example":{"name":"ADMIN_EMAIL","value":"admin@example.com"}}}},"400":{"description":"Bad request"}},"requestBody":{"description":"Developer attribute.","content":{"application/json":{"schema":{"type":"object","properties":{"value":{"type":"string","description":"Value of attribute."}}},"example":{"value":"admin@example.com"}}}}}}},"components":{"securitySchemes":{"Basic":{"type":"http","scheme":"basic"},"OAuth":{"type":"apiKey","name":"Authorization","in":"header"}},"parameters":{"org_name":{"in":"path","name":"org_name","required":true,"schema":{"type":"string"},"description":"Organization name."},"developer_email":{"in":"path","name":"developer_email","required":true,"schema":{"type":"string"},"description":"Email address for the developer."},"attribute_name":{"in":"path","name":"attribute_name","required":true,"schema":{"type":"string"},"description":"Name of the attribute."},"action":{"in":"query","name":"action","required":true,"schema":{"type":"string"},"description":"Status of developer. Set to `active` or `inactive`."},"app":{"in":"query","name":"app","required":false,"schema":{"type":"string"},"description":"Name of the app for which you want to return associated developers."},"count":{"in":"query","name":"count","required":false,"schema":{"type":"integer"},"description":"**Apigee Edge for Public Cloud only**. Number of developers to return in the API call. The limit is 1000. Use with the `startKey` parameter to provide more targeted filtering."},"expand":{"in":"query","name":"expand","required":false,"schema":{"type":"boolean"},"description":"Flag that specifies whether to view expanded details for each developer. Set to `true` to view expanded details. Defaults to `false`."},"startKey":{"in":"query","name":"startKey","required":false,"schema":{"type":"string"},"description":"**Apigee Edge for Public Cloud only**. Email of a developer from which to start displaying the list of developers.\n\nFor example, if the an unfiltered list returns:\n\n```\nwestley@example.com\nfezzik@example.com\nbuttercup@example.com\n```\n\nIf your `startKey` is `fezzik@example.com`, the returned list will be:\n\n```\nfezzik@example.com\nbuttercup@example.com\n```"}},"schemas":{"Developers":{"description":"List of developer details.","type":"object","properties":{"developer":{"type":"array","items":{"$ref":"#/components/schemas/Developer"}}},"example":{"developer":[{"apps":["app1","app2"],"companies":[],"email":"ahamilton@example.com","developerId":"4707ceee-1234-abcd","firstName":"Alex","lastName":"Hamilton","userName":"ahamilton@example.com","organizationName":"myorg","status":"active","attributes":[{"name":"ADMIN_EMAIL","value":"admin@example.com"}],"createdAt":1486474235912,"createdBy":"admin@example.com","lastModifiedAt":1486474783590,"lastModifiedBy":"admin@excample.com"}]}},"Developer":{"description":"Developer details.","type":"object","properties":{"apps":{"description":"Output only. List of apps associated with the developer.","type":"array","items":{"type":"string"}},"attributes":{"description":"List of attributes that can be used to extend the default developer profile. With Apigee Edge for Public Cloud, the custom attribute limit is 18.","type":"array","items":{"$ref":"#/components/schemas/Attribute"}},"companies":{"description":"Output only. List of companies associated with the developer.","type":"array","items":{"type":"string"}},"createdAt":{"format":"int","description":"Output only. Time the developer was created in milliseconds since epoch.","type":"integer"},"createdBy":{"description":"Output only. Email address of the developer that created the developer.","type":"string"},"developerId":{"description":"ID of the developer. Generated internally by Apigee and not guaranteed to stay consistent over time.","type":"string"},"email":{"description":"Email address of the developer. This value is used to uniquely identify the developer in Apigee Edge.","type":"string"},"firstName":{"description":"First name of the developer.","type":"string"},"lastName":{"description":"Last name of the developer.","type":"string"},"lastModifiedAt":{"format":"int","description":"Output only. Last modified time as milliseconds since epoch.","type":"integer"},"lastModifiedBy":{"description":"Output only. Email of developer that last modified the app.","type":"string"},"organizationName":{"description":"Output only. Name of the organization associated with the developer.","type":"string"},"status":{"description":"Status of the developer. Valid values are `active` and `inactive`."},"userName":{"description":"Username. Not used by Apigee.","type":"string"}}},"DeveloperRequest":{"description":"Developer request.","type":"object","required":["email","firstName","lastName","userName"],"properties":{"attributes":{"description":"List of attributes that can be used to extend the default developer profile. With Apigee Edge for Public Cloud, the custom attribute limit is 18.","type":"array","items":{"$ref":"#/components/schemas/Attribute"}},"email":{"description":"Email address of the developer. This value is used to uniquely identify the developer in Apigee Edge.","type":"string"},"firstName":{"description":"First name of the developer.","type":"string"},"lastName":{"description":"Last name of the developer.","type":"string"},"userName":{"description":"Username. Not used by Apigee.","type":"string"}}},"Attributes":{"description":"Developer attributes.","type":"object","properties":{"attribute":{"type":"array","items":{"$ref":"#/components/schemas/Attribute"}}}},"Attribute":{"description":"Developer attribute name and value.","type":"object","properties":{"name":{"description":"Name of attribute.","type":"string"},"value":{"description":"Value of attribute.","type":"string"}}}}}}
/ organizations / {org_name} / developers
/ organizations / {org_name} / developers / {developer_email}
/ organizations / {org_name} / developers / {developer_email} / attributes
/ organizations / {org_name} / developers / {developer_email} / attributes / {attribute_name}
API Proxies API OpenAPI	{"openapi":"3.0.0","servers":[{"url":"https://api.enterprise.apigee.com/v1"}],"info":{"title":"API Proxies API","description":"Manage API proxies.\nYou expose APIs on Apigee Edge by implementing API proxies. API proxies decouple the app-facing API from your backend services, shielding those apps from backend code changes. As you make backend changes to your services, apps continue to call the same API without any interruption.\nFor more information, see <a href=\"https://docs.apigee.com/api-platform/fundamentals/understanding-apis-and-api-proxies\">Understanding APIs and API proxies</a>.","version":"1.0"},"security":[{"Basic":[]},{"OAuth":[]}],"paths":{"/organizations/{org_name}/apis":{"post":{"tags":["API Proxy"],"summary":"Create an API proxy","description":"Creates an API Proxy using one of the methods described below. The API proxy created will not be accessible at runtime until it is deployed to an environment.\n* Create an API proxy by setting the `name` field to the name of an API proxy in the request body. Typically, you\n then export the API proxy configuration bundle to your local machine for development, as described in <a href=\"/docs/api-proxies/1/routes/organizations/%7Borg_name%7D/apis/%7Bapi_name%7D/revisions/%7Brevision_number%7D/get\">Get an API proxy revision</a>, and import the updated API proxy configuration bundle.\n\n* Import an API proxy configuration bundle stored as a zip file on your local machine to your organization on Edge by doing the following:\n\n * Set the `action` query parameter to `import`.\n * Set the `Content-Type` header to `multipart/form-data`.\n * Pass as a file the name of the API proxy configuration bundle stored in zip format on your local machine.\n \n \n**Note**: **Currently, you cannot import an API proxy configuration bundle using the Try this API pane.** \n \n \nFor example, the following curl call imports an API proxy configuration bundle:\n\n``` curl \"https://api.enterprise.apigee.com/v1/organizations/{org-name}/apis?action=import&name=example\" \\\n -X POST \\\n -H Content-Type=\"multipart/form-data\"\n -F \"file=@apiproxy.zip\" \\\n -u email:password \n \n```\n\nWhen importing an API proxy:\n* If the API proxy does not exist, it will be created. If the API proxy exists, then a new revision is created.\n* To validate the API proxy configuration bundle before importing, set the `validate` query parameter to `true`.\n* To validate the API proxy configuration bundle only without importing it, set the `action` query parameter to `validate`.\nInvalid API proxy configurations are rejected, and a list of validation errors is returned to the client.","operationId":"createAPIProxy","parameters":[{"$ref":"#/components/parameters/org_name"}],"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIProxyRevision"},"example":{"basepaths":["/mock-target-api"],"configurationVersion":{"majorVersion":4,"minorVersion":0},"contextInfo":"Revision 1 of application Mock-Target-API, in organization docs","createdAt":1472699641914,"createdBy":"ahamilton@example.com","description":"OpenAPI Specification for the Apigee mock target service endpoint.","displayName":"Mock-Target-API","entityMetaDataAsProperties":{"bundle_type":"zip","lastModifiedBy":"ahamilton@example.com","createdBy":"ahamilton@example.com","lastModifiedAt":"1560888800458","subType":"null","createdAt":"1472699641914"},"lastModifiedAt":1560888800458,"lastModifiedBy":"ahamilton@example.com","manifestVersion":"SHA-512:a52ece20111x12xjajke1i34","name":"Mock-Target-API","policies":["Assign-Message-1","Extract-Variables-1","Verify-API-Key-1"],"proxies":["default"],"proxyEndpoints":["default"],"resourceFiles":{"resourceFile":[{"name":"association.json","type":"openapi"}]},"resources":["openapi://association.json"],"revision":"1","sharedFlows":[],"spec":"https://raw.githubusercontent.com/apigee/api-platform-samples/master/default-proxies/helloworld/openapi/mocktarget.yaml","targetEndpoints":["default"],"targetServers":[],"targets":["default"],"type":"Application"}}}},"400":{"description":"Bad request"}},"requestBody":{"description":"API proxy configuration.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIProxyRequest"}},"multipart/form-data":{"schema":{"type":"string","format":"binary"}}}}},"get":{"tags":["API Proxy"],"summary":"List API proxies","description":"Lists the names of all API proxies in an organization. The names returned correspond to the names defined in the configuration files for each API proxy.\n\nPaginate the results using the `count` and `startKey` query parameters. \n\nFor example, the first call includes `count` to specify the number of elements to return:\n\n```\ncurl 'https://api.enterprise.apigee.com/v1/organizations/{org_name}/apis?count=5' \\\n -X GET \\\n -u email:password \n```\nIn this example, the call returns an array containing the first five APIs defined in the organization:\n\n``` [ \"API_1\", \"API_2\", \"API_3\", \"API_4\", \"API_5\" ] ```\n\nThen, call the API again and specify both `count` and `startKey`, where `startKey` specifies the last array element from the previous call:\n\n```\ncurl \"https://api.enterprise.apigee.com/v1/organizations/{org_name}/apis?count=5&startKey=API_5\" \\\n -X GET \\\n -u email:password\n```\n\nThis call returns an array containing the next five APIs defined in the organization, starting with `API_5`:\n\n``` [ \"API_5\", \"API_6\", \"API_7\", \"API_8\", \"API_9\" ] ```","operationId":"listAPIProxies","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/count"},{"$ref":"#/components/parameters/startKey"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"type":"string","description":"API proxy name."}}}}},"400":{"description":"Bad request"}}}},"/organizations/{org_name}/apis/{api_name}":{"delete":{"tags":["API Proxy"],"summary":"Delete API proxy","description":"Deletes an API proxy and all associated endpoints, policies, resources, and revisions. The API proxy must be undeployed before you can delete it.","operationId":"deleteAPIProxy","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/api_name"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIProxyRevision"},"example":{"basepaths":["/mock-target-api"],"configurationVersion":{"majorVersion":4,"minorVersion":0},"contextInfo":"Revision 1 of application Mock-Target-API, in organization docs","createdAt":1472699641914,"createdBy":"ahamilton@example.com","description":"OpenAPI Specification for the Apigee mock target service endpoint.","displayName":"Mock-Target-API","entityMetaDataAsProperties":{"bundle_type":"zip","lastModifiedBy":"ahamilton@example.com","createdBy":"ahamilton@example.com","lastModifiedAt":"1560888800458","subType":"null","createdAt":"1472699641914"},"lastModifiedAt":1560888800458,"lastModifiedBy":"ahamilton@example.com","manifestVersion":"SHA-512:a52ece20111x12xjajke1i34","name":"Mock-Target-API","policies":["Assign-Message-1","Extract-Variables-1","Verify-API-Key-1"],"proxies":["default"],"proxyEndpoints":["default"],"resourceFiles":{"resourceFile":[{"name":"association.json","type":"openapi"}]},"resources":["openapi://association.json"],"revision":"1","sharedFlows":[],"spec":"https://raw.githubusercontent.com/apigee/api-platform-samples/master/default-proxies/helloworld/openapi/mocktarget.yaml","targetEndpoints":["default"],"targetServers":[],"targets":["default"],"type":"Application"}}}},"400":{"description":"Bad request"}}},"get":{"tags":["API Proxy"],"summary":"Get API proxy","description":"Gets an API proxy including a list of existing revisions.","operationId":"getAPIProxy","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/api_name"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIProxy"},"example":{"metaData":{"createdAt":1472699641914,"createdBy":"ahamilton@example.com","lastModifiedAt":1560950346500,"lastModifiedBy":"ahamilton@example.com","subType":"null"},"name":"Mock-Target-API","revision":["1","2"]}}}},"400":{"description":"Bad request"}}}},"/organizations/{org_name}/apis/{api_name}/revisions":{"get":{"tags":["API Proxy"],"summary":"List API proxy revisions","description":"List all revisions for an API proxy.","operationId":"listAPIProxyRevisions","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/api_name"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"type":"string","description":"API proxy revision."}}}}},"400":{"description":"Bad request"}}}},"/organizations/{org_name}/apis/{api_name}/revisions/{revision_number}":{"get":{"tags":["API Proxy"],"summary":"Get or export an API proxy revision","description":"Gets or exports the API proxy revision.\n\nTo export the API proxy configuration for the specified revision as a zip file, set the `format` query parameter to `bundle`. If you are using curl, specify `-o filename.zip` to save the output to a file; otherwise, it displays to `stdout`. Then, develop the API proxy configuration locally and upload the updated API proxy configuration revision.","operationId":"getAPIProxyRevision","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/api_name"},{"$ref":"#/components/parameters/revision_number"},{"$ref":"#/components/parameters/format"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIProxyRevision"},"example":{"basepaths":["/mock-target-api"],"configurationVersion":{"majorVersion":4,"minorVersion":0},"contextInfo":"Revision 1 of application Mock-Target-API, in organization docs","createdAt":1472699641914,"createdBy":"ahamilton@example.com","description":"OpenAPI Specification for the Apigee mock target service endpoint.","displayName":"Mock-Target-API","entityMetaDataAsProperties":{"bundle_type":"zip","lastModifiedBy":"ahamilton@example.com","createdBy":"ahamilton@example.com","lastModifiedAt":"1560888800458","subType":"null","createdAt":"1472699641914"},"lastModifiedAt":1560888800458,"lastModifiedBy":"ahamilton@example.com","manifestVersion":"SHA-512:a52ece20111x12xjajke1i34","name":"Mock-Target-API","policies":["Assign-Message-1","Extract-Variables-1","Verify-API-Key-1"],"proxies":["default"],"proxyEndpoints":["default"],"resourceFiles":{"resourceFile":[{"name":"association.json","type":"openapi"}]},"resources":["openapi://association.json"],"revision":"1","sharedFlows":[],"spec":"https://raw.githubusercontent.com/apigee/api-platform-samples/master/default-proxies/helloworld/openapi/mocktarget.yaml","targetEndpoints":["default"],"targetServers":[],"targets":["default"],"type":"Application"}},"application/octet-stream":{"schema":{"type":"string","format":"binary"}}}},"400":{"description":"Bad request"}}},"post":{"tags":["API Proxy"],"summary":"Update API proxy revision","description":"Updates an existing revison of an API proxy by uploading an API proxy configuration bundle as a zip file from your local machine.\n\n**Note**: **Currently, you cannot execute this API using the Try this API panel**. \n\n\n**If the API proxy revision is deployed**, the API undeploys the revision, updates it, and then redeploys it. **If the API proxy revision is not deployed**, the API updates the revision but does not deploy it.\n\n**CAUTION**: The API proxy is immediately updated in all environments where it is deployed.\n\nFor example, the following example updates revision 3 of the hotels API proxy:\n\n```\ncurl \"https://api.enterprise.apigee.com/v1/organizations/apigeedocs/apis/hotels/revisions/3\" \\\n -X POST \\\n -H \"Content-Type: multipart/form-data\" \\\n -F \"file=@file_name.zip\" \\\n -u email:password \n```","operationId":"updateAPIProxyRevision","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/api_name"},{"$ref":"#/components/parameters/revision_number"},{"$ref":"#/components/parameters/validate"}],"responses":{"200":{"description":"OK"},"400":{"description":"Bad request"}},"requestBody":{"description":"API proxy configuration (zip file).","content":{"application/octet-stream":{"schema":{"type":"string","format":"binary"}},"multipart/form-data":{"schema":{"type":"string","format":"binary"}}}}},"delete":{"tags":["API Proxy"],"summary":"Delete API proxy revision","description":"Deletes an API proxy revision and all policies, resources, endpoints, and revisions associated with it. The API proxy revision must be undeployed before you can delete it.","operationId":"deleteAPIProxyRevision","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/api_name"},{"$ref":"#/components/parameters/revision_number"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIProxyRevision"},"example":{"basepaths":["/mock-target-api"],"configurationVersion":{"majorVersion":4,"minorVersion":0},"contextInfo":"Revision 1 of application Mock-Target-API, in organization docs","createdAt":1472699641914,"createdBy":"ahamilton@example.com","description":"OpenAPI Specification for the Apigee mock target service endpoint.","displayName":"Mock-Target-API","entityMetaDataAsProperties":{"bundle_type":"zip","lastModifiedBy":"ahamilton@example.com","createdBy":"ahamilton@example.com","lastModifiedAt":"1560888800458","subType":"null","createdAt":"1472699641914"},"lastModifiedAt":1560888800458,"lastModifiedBy":"ahamilton@example.com","manifestVersion":"SHA-512:a52ece20111x12xjajke1i34","name":"Mock-Target-API","policies":["Assign-Message-1","Extract-Variables-1","Verify-API-Key-1"],"proxies":["default"],"proxyEndpoints":["default"],"resourceFiles":{"resourceFile":[{"name":"association.json","type":"openapi"}]},"resources":["openapi://association.json"],"revision":"1","sharedFlows":[],"spec":"https://raw.githubusercontent.com/apigee/api-platform-samples/master/default-proxies/helloworld/openapi/mocktarget.yaml","targetEndpoints":["default"],"targetServers":[],"targets":["default"],"type":"Application"}}}},"400":{"description":"Bad request"}}}},"/organizations/{org_name}/apis/{api_name}/revisions/{revision_number}/npm":{"get":{"tags":["API Proxy"],"summary":"Lists npm dependencies for an API proxy.","description":"Gets npm dependencies for an API proxy.","operationId":"listAPIProxynpmDependencies","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/api_name"},{"$ref":"#/components/parameters/revision_number"}],"responses":{"200":{"description":"OK"},"400":{"description":"Bad request"}}},"post":{"tags":["API Proxy"],"summary":"Manage Node packaged modules","description":"**Note**: **Currently, you cannot execute this API using the Try this API panel**.\n\nRuns the specified npm command for an API proxy deployed on Apigee Edge. Calling this API is equivalent to executing an npm command in the `resources/node` directory of the API proxy.\n\nValid npm commands that you can execute with this API are:\n* `install`\n* `update`\n* `outdated`\n* `dedupe`\n* `prune`\n* `verbose` (directs npm to produce more output)\n* `ls` (default if no query param is specified)\n\nPass npm commands in the request body using the following format: `command={npm-command}`. For example, enter the following command to install known dependencies for the API's package directory (`resources/node`): `command=install`.\n\nDo not specify an arbitrary published Node.js package name with this API. For example, this command will fail: `command=install async`\n\nWith the exception of `ls` and `outdated`, the commands replace `node_modules.zip` and any other zip file with the prefix `node_modules` in the `resources/node` directory with new files that contains the updated dependencies.\n\nFor more information about the individual npm commands, see the <a href=\"https://docs.npmjs.com/cli\">npm documentation</a>.\n\nNote the following:\n\n* When you are installing modules that are used from JavaScript within an API proxy, you must deploy (or re-deploy) the API proxy after the modules are installed. Otherwise, JavaScript code in the API proxy might not be able to find the required modules.\n\n* By default, this API does not install dependencies in `package.json` that are listed as `devDependencies`. Node.js module authors use `devDependencies` to denote modules that are required for testing and development but not to run the module. You can override the default behavior by passing the `production=false` parameter. \n\nThe following command installs all dependencies for the `resources/node` directory and sets `production=false`.\n\n```\ncurl http://host:port/v1/organizations/ORG/apis/API/revisions/REV/npm -d 'command=install&production=false'\n```\n\n\nThe following command returns a list of Node.js dependencies.\n\n```\ncurl http://host:port/v1/organizations/ORG/apis/API/revisions/REV/npm -d 'command=ls'\n```","operationId":"managedNodePackagedModules","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/api_name"},{"$ref":"#/components/parameters/revision_number"},{"$ref":"#/components/parameters/verbose"}],"requestBody":{"description":"npm commands to execute.","content":{"application/x-www-form-urlencoded":{"schema":{"type":"string"}}}},"responses":{"200":{"description":"OK"},"400":{"description":"Bad request"}}}}},"components":{"securitySchemes":{"Basic":{"type":"http","scheme":"basic","description":"Multi-factor authentication is not supported."},"OAuth":{"type":"apiKey","name":"Authorization","in":"header","description":"For OAuth, enter the following in the Key field: Bearer %your-token% (see https://docs.apigee.com/api-platform/system-administration/using-oauth2#get-the-tokens)"}},"parameters":{"org_name":{"in":"path","name":"org_name","required":true,"schema":{"type":"string"},"description":"Organization name."},"api_name":{"in":"path","name":"api_name","required":true,"schema":{"type":"string"},"description":"API proxy name."},"revision_number":{"in":"path","name":"revision_number","required":true,"schema":{"type":"string"},"description":"Revision number."},"action":{"in":"query","name":"action","required":false,"schema":{"type":"string"},"description":"Action to perform when importing an API proxy configuration. Set this parameter to one of the following values:\n* `import` to import the API proxy configuration.\n* `validate` to validate the API proxy configuration without importing it."},"name":{"in":"query","name":"name","required":true,"schema":{"type":"string"},"description":"Name of the API proxy for which you are importing the API proxy configuration."},"validate":{"in":"query","name":"validate","required":false,"schema":{"type":"string"},"description":"Flag that specifies whether to validate the API proxy configuration before importing it. Apigee recommends that you set this value to `true`."},"count":{"in":"query","name":"count","required":false,"schema":{"type":"integer"},"description":"Number of API proxies to return in the API call. The limit is 100. Required if you specify `startKey`."},"startKey":{"in":"query","name":"startKey","required":false,"schema":{"type":"string"},"description":"Name of the API proxy from which to start displaying the list of API proxies. For example, if you are returning 50 API proxies at a time (using the count query parameter), you can view API proxies 50-99 by entering the name of the 50th API proxy. The API proxy name is case sensitive."},"format":{"in":"query","name":"format","required":false,"schema":{"type":"string"},"description":"Format used when exporting the API proxy configuration revision. Set to `bundle` to export the API proxy configuration revision as a zip file."},"verbose":{"in":"query","name":"verbose","required":false,"schema":{"type":"boolean","default":false},"description":"Flag that specifies whether the output will include additional information from npm on which API calls were made to the registry. Set to `true` to include additional information."},"Accept":{"in":"header","name":"Accept","required":false,"schema":{"type":"string","default":"application/xml"},"description":"Format used to get the API proxy configuration revision details. Valid values include: `application/xml` or `application/json`"},"Content-Type":{"in":"header","name":"Content-Type","required":false,"schema":{"type":"string"},"description":"Request content type. When creating an API proxy, set to `application/json`. When importing an API proxy configuration, set to `multipart/form-data`."}},"schemas":{"APIProxyRequest":{"description":"API proxy request.","type":"object","required":["name"],"properties":{"name":{"description":"Name of the API proxy. Restrict the characters used to: `A-Za-z0-9._-`","type":"string"}}},"APIProxyRevision":{"description":"API proxy revision.","type":"object","required":["name"],"properties":{"basepaths":{"description":"Base URL of the API proxy.","type":"string"},"configurationVersion":{"description":"Version of the API proxy configuration schema to which this API proxy conforms. This setting may be used in the future to track the evolution of the API proxy format.","type":"object","properties":{"majorVersion":{"description":"Major version of the API proxy configuration schema. The only supported value is '4'.","type":"integer"},"minorVersion":{"description":"Minor version of the API proxy configuration schema. The only supported value is '0'.","type":"integer"}}},"contextInfo":{"type":"string","description":"Revision number, app name, and organization for the API proxy."},"createdAt":{"description":"Time when the API proxy revision was created in milliseconds since epoch.","type":"integer"},"createdBy":{"description":"Email address of developer that created the API proxy revision.","type":"string"},"description":{"description":"Description of the API proxy revision.","type":"string"},"displayName":{"description":"Human-readable name of the API proxy.","type":"string"},"entityMetaDataAsProperties":{"description":"Kev-value map of metadata describing the API proxy revision.","type":"object","properties":{"bundle_type":{"description":"Type of bundle. Set to `zip`.","type":"string"},"createdAt":{"description":"Time when the API proxy revision was created in milliseconds since epoch.","type":"string"},"createdBy":{"description":"Email address of developer that created the API proxy.","type":"string"},"lastModifiedAt":{"description":"Time when the API proxy version was last modified in milliseconds since epoch.","type":"string"},"lastModifiedBy":{"description":"Email address of developer that last modified the API proxy.","type":"string"},"subType":{"description":"Set to `null`.","type":"string"}}},"lastModifiedAt":{"description":"Time when the API proxy version was last modified in millisenconds since epoch.","type":"integer"},"lastModifiedBy":{"description":"Email address of developer that last modified the API proxy.","type":"string"},"manifestVersion":{"description":"Manifest version.","type":"string"},"name":{"description":"Name of the API proxy.","type":"string"},"policies":{"description":"List of policies included in the API proxy revision.","type":"array","items":{"type":"string","description":"Policy name."}},"proxies":{"description":"List of API proxy names included in the API proxy revision.","type":"array","items":{"type":"string","description":"API proxy name."}},"proxyEndpoints":{"description":"List of the ProxyEndpoints in the `/proxies` directory. Typically, this element is included only when the API proxy was created using the Edge UI. This is a 'manifest' setting designed to provide visibility into the contents of the API proxy.","type":"array","items":{"type":"string","description":"ProxyEndpoint name."}},"resourceFiles":{"description":"Resource files included with the API proxy revision.","type":"object","properties":{"resourceFile":{"description":"Resource files included with the API proxy revision.","type":"array","items":{"description":"Resource filename.","type":"object","properties":{"name":{"description":"Name of the resource file.","type":"string"},"type":{"description":"Type of resource file.","type":"string"}}}}}},"resources":{"description":"List of resources included in the API proxy revision, formatted as `{type}://{name}`.","type":"array","items":{"type":"string","description":"Resource name."}},"revision":{"description":"Revison of the API proxy.","type":"string"},"sharedFlows":{"description":"List of shared flows included in the API proxy revision.","type":"array","items":{"type":"string","description":"Shared flow name."}},"spec":{"description":"OpenAPI Specification that is associated with the API proxy. This value may be a URL or a path in the spec store or on GitHub, for example. If the API proxy was not created using an OpenAPI Specification, this value is null.","type":"string"},"targetEndpoints":{"description":"List of TargetEndpoints in the `/targets` directory of the API proxy. Typically, this element is included only when the API proxy was created using the Edge UI. This is a 'manifest' setting designed to provide visibility into the contents of the API proxy.","type":"array","items":{"type":"string","description":"TargetEndpoint name."}},"targetServers":{"description":"List of TargetServers referenced in any TargetEndpoints of the API proxy. Typically, this element is included only when the API proxy was created using the Edge UI. This is a 'manifest' setting designed to provide visibility into the contents of the API proxy.","type":"array","items":{"type":"string","description":"TargetServer name."}},"targets":{"description":"List of targets included in the API proxy revision.","type":"array","items":{"type":"string","description":"Target name."}},"type":{"description":"Set to `Application`.","type":"string"}}},"APIProxy":{"description":"API proxy metadata and revisions.","type":"object","properties":{"metaData":{"description":"API proxy metadata.","type":"object","properties":{"createdAt":{"description":"Time when the API proxy was created in milliseconds since epoch.","type":"integer"},"createdBy":{"type":"string","description":"Email address of developer that created the API proxy."},"lastModifiedAt":{"description":"Time when the API proxy was last modified in milliseconds since epoch.","type":"integer"},"lastModifiedBy":{"description":"Email address of developer that last modified the API proxy.","type":"string"},"subType":{"description":"Set to `null`.","type":"string"}}},"name":{"description":"Name of the API proxy.","type":"string"},"revision":{"description":"Revisions defined for the API proxy.","type":"array","items":{"type":"string","description":"Revision number."}}}}}}}
/ organizations / {org_name} / apis
/ organizations / {org_name} / apis / {api_name}
/ organizations / {org_name} / apis / {api_name} / revisions
/ organizations / {org_name} / apis / {api_name} / revisions / {revision_number}
/ organizations / {org_name} / apis / {api_name} / revisions / {revision_number} / npm
Mock Target API OpenAPI	{"openapi":"3.0.0","info":{"description":"OpenAPI Specification for the Apigee mock target service endpoint.","version":"1.0.0","title":"Mock Target API"},"paths":{"/":{"get":{"summary":"View personalized greeting","operationId":"View a personalized greeting","description":"View a personalized greeting for the specified or guest user.","parameters":[{"name":"user","in":"query","description":"Your user name.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"}}}},"/help":{"get":{"summary":"Get help","operationId":"Get help","description":"View help information about available resources in HTML format.","responses":{"200":{"description":"Success"}}}},"/user":{"get":{"summary":"View personalized greeting","operationId":"View personalized greeting","description":"View a personalized greeting for the specified or guest user.","parameters":[{"name":"user","in":"query","description":"Your user name.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"}}}},"/iloveapis":{"get":{"summary":"View API affirmation","operationId":"View API affirmation","description":"View API affirmation in HTML format.","responses":{"200":{"description":"Success"}}}},"/ip":{"get":{"summary":"View IP address","operationId":"View IP address","description":"View the IP address of the client in JSON format.","responses":{"200":{"description":"Success"}}}},"/xml":{"get":{"summary":"View XML response","operationId":"View XML response","description":"View a sample response in XML format.","responses":{"200":{"description":"Success"}}}},"/json":{"get":{"summary":"View JSON response","operationId":"View JSON response","description":"View a sample response in JSON format.","responses":{"200":{"description":"Success"}}}},"/echo":{"get":{"summary":"View request headers and body","operationId":"View request headers and body","description":"View the request headers and body in JSON format.","responses":{"200":{"description":"Success"}}},"post":{"summary":"Send request and view request headers and body","operationId":"Send request and view request headers and body","description":"Send a request and view the resulting request headers and body in JSON format. The request payload can be specified using one of the following formats: application/json, application/x-www-form-urlencoded, or application/xml.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/request-body"}}},"description":"Request payload in application/json, application/x-www-form-urlencoded, or application/xml format.","required":true},"responses":{"200":{"description":"Success"}}}},"/statuscode/{code}":{"get":{"summary":"View status code and message","operationId":"View status code and message","description":"View status code and message for the specified value.","parameters":[{"name":"code","in":"path","description":"HTTP status code.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"}}}},"/auth":{"get":{"security":[{"basicAuth":[]}],"summary":"Validate access using basic authentication","operationId":"Validate access using basic authentication","description":"Validate access using basic authentication.","responses":{"200":{"description":"Success"}}}}},"servers":[{"url":"http://mocktarget.apigee.net"},{"url":"https://mocktarget.apigee.net"}],"components":{"securitySchemes":{"basicAuth":{"type":"http","description":"HTTP Basic Authentication.","scheme":"basic"}},"schemas":{"request-body":{"properties":{"replace-me":{"type":"object","description":"Replace with request payload in application/json, application/x-www-form-urlencoded, or application/xml format."}}}}}}
/
/ help
/ user
/ iloveapis
/ ip
/ xml
/ json
/ echo
/ statuscode / {code}
/ auth
LDAP Resources API OpenAPI	{"openapi":"3.0.0","servers":[{"url":"https://api.enterprise.apigee.com/v1"}],"info":{"title":"LDAP Resources API","description":"Manage LDAP resources. See <a href=\"https://docs.apigee.com/api-platform/reference/policies/ldap-policy\">LDAP Policy</a>. Supported by **Apigee Edge for Private Cloud only**. ","version":"1.0"},"security":[{"Basic":[]},{"OAuth":[]}],"paths":{"/organizations/{org_name}/environments/{env_name}/ldapresources":{"get":{"tags":["LDAP"],"summary":"List LDAP resources","description":"Lists all LDAP resources associated with an <a href=\"https://docs.apigee.com/api-platform/reference/policies/ldap-policy\">LDAP policy</a>. For more information, see <a href=\"https://docs.apigee.com/private-cloud/latest/managing-ldap-resources\">Managing LDAP resources</a>.\n\n**Notes**:\n* **Apigee Edge for Private Cloud only**. \n* **This API cannot be executed using the Try this API panel**.","operationId":"listLDAPResources","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/env_name"}],"responses":{"200":{"description":"OK"},"400":{"description":"Bad request"}}},"post":{"tags":["LDAP"],"summary":"Create LDAP resource","description":"Creates an LDAP resource. For more information, see <a href=\"https://docs.apigee.com/private-cloud/latest/managing-ldap-resources\">Managing LDAP resources</a>.\n\n**Notes**:\n* **Apigee Edge for Private Cloud only**.\n* **This API cannot be executed using the Try this API panel**.","operationId":"createLDAPResource","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/env_name"}],"responses":{"200":{"description":"OK"},"400":{"description":"Bad request"}}}},"/organizations/{org_name}/environments/{env_name}/ldapresources/{ldap_name}":{"get":{"tags":["LDAP"],"summary":"Get LDAP resource","description":"Gets an LDAP resource associated with an <a href=\"https://docs.apigee.com/api-platform/reference/policies/ldap-policy\">LDAP policy</a>. For more information, see <a href=\"https://docs.apigee.com/private-cloud/latest/managing-ldap-resources\">Managing LDAP resources</a>.\n\n**Notes**:\n* **Apigee Edge for Private Cloud only**. \n* **This API cannot be executed using the Try this API panel**.","operationId":"getLDAPResource","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/env_name"},{"$ref":"#/components/parameters/ldap_name"}],"responses":{"200":{"description":"OK"},"400":{"description":"Bad request"}}},"delete":{"tags":["LDAP"],"summary":"Delete LDAP resource","description":"Deletes an LDAP resource associated with an <a href=\"https://docs.apigee.com/api-platform/reference/policies/ldap-policy\">LDAP policy</a>. For more information, see <a href=\"https://docs.apigee.com/private-cloud/latest/managing-ldap-resources\">Managing LDAP resources</a>.\n\n**Notes**:\n* **Apigee Edge for Private Cloud only**. \n* **This API cannot be executed using the Try this API panel**.","operationId":"deleteLDAPResource","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/env_name"},{"$ref":"#/components/parameters/ldap_name"}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad request"}}},"post":{"tags":["LDAP"],"summary":"Update LDAP resource","description":"Updates an LDAP resource associated with an <a href=\"https://docs.apigee.com/api-platform/reference/policies/ldap-policy\">LDAP policy</a>.\n\nYou must specify the complete description of the LDAP resource in the request body, not just the elements that you want to change. You can get the current LDAP resource properties, as described in <a href=\"https://docs-edgeapis.apigee.io/docs/ldap-resources/1/routes/organizations/%7Borg_name%7D/environments/%7Benv_name%7D/ldapresources/%7Bldap_name%7D/get\">Get LDAP resource</a>.\n\n\n For more information, see <a href=\"https://docs.apigee.com/private-cloud/latest/managing-ldap-resources\">Managing LDAP resources</a>.\n\n\n**Notes**:\n* **Apigee Edge for Private Cloud only**. \n* **This API cannot be executed using the Try this API panel**.","operationId":"updateLDAPResources","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/env_name"},{"$ref":"#/components/parameters/ldap_name"}],"responses":{"201":{"description":"Created"},"400":{"description":"Bad request"}}}}},"components":{"securitySchemes":{"Basic":{"type":"http","scheme":"basic","description":"Multi-factor authentication is not supported."},"OAuth":{"type":"apiKey","name":"Authorization","in":"header","description":"For OAuth, enter the following in the Key field: Bearer %your-token% (see https://docs.apigee.com/api-platform/system-administration/using-oauth2#get-the-tokens)"}},"parameters":{"org_name":{"in":"path","name":"org_name","required":true,"schema":{"type":"string"},"description":"Organization name."},"env_name":{"in":"path","name":"env_name","required":true,"schema":{"type":"string"},"description":"Environment name."},"ldap_name":{"in":"path","name":"ldap_name","required":true,"schema":{"type":"string"},"description":"LDAP resource name."}}}}
/ organizations / {org_name} / environments / {env_name} / ldapresources
/ organizations / {org_name} / environments / {env_name} / ldapresources / {ldap_name}
Key value maps API OpenAPI	{"openapi":"3.0.0","servers":[{"url":"https://api.enterprise.apigee.com/v1"}],"info":{"title":"Key value maps API","description":"Manage the Apigee Edge key value store for longer-term data persistence. Key value maps (KVMs) are collections of arbitrary name/value pairs (\"entries\") that can be accessed at runtime by API proxies, or for other custom runtime requirements. The API lets you perform CRUD operations on the key value store. \n\nYou can create and manage KVMs at multiple scopes:\n\n* **API proxy**: KVMs at the API proxy scope can be accessed only by the API proxy or a specific revision of the proxy.\n* **Environment**: KVMs at the environment scope can be accessed by any API proxy in the environment (such as `test` or `prod`). In the Edge UI, KVMs are configured at the environment scope (**APIs > Environments > Key Value Maps**).\n* **Organization**: KVMs at the organization scope can be accessed by all API proxies in all environments.\n\nAPI proxies interact with the key value store at runtime using policies. See <a href=\"https://docs.apigee.com/api-services/reference/key-value-map-operations-policy\">KeyValueMapOperations policy</a>.","version":"1.0"},"security":[{"Basic":[]},{"OAuth":[]}],"paths":{"/organizations/{org_name}/apis/{api_name}/keyvaluemaps":{"post":{"tags":["Key Value Map"],"summary":"Create key value map in an API proxy","description":"Creates a key value map (KVM) for an API proxy.\n\nA KVM is a simple structure for persistently storing name/value pairs as entries in a named map. The entries in a KVM can be retrieved at runtime by the <a href=\"https://docs.apigee.com/api-services/reference/key-value-map-operations-policy\">KeyValueMapOperations policy</a> or code running on Apigee Edge. Use KVMs for use cases such as profile-based access control, storing environment-specific data, to control application-specific behavior, and so on.\n\nYou can create an encrypted KVM by adding `\"encrypted\" : \"true\"` to the request payload. You update encrypted KVMs the same way you update non-encrypted KVMs.\n\nKVM names are case sensitive.\n\n**Note**: KVMs created at the API proxy <a href=\"https://docs.apigee.com/api-platform/cache/key-value-maps.html#scope\">scope</a> do not appear in the Edge UI. Only KVMs created at the environment scope apear in the Edge UI. To view the KVMs defined at the API proxy scope, see <a href=\"/docs/key-value-maps/1/routes/organizations/%7Borg_name%7D/apis/%7Bapi_name%7D/keyvaluemaps/get\">List key value maps for an API proxy</a>.\n\nFor information on retrieving KVMs, see <a href=\"https://docs.apigee.com/api-services/reference/key-value-map-operations-policy\">KeyValueMapOperations policy</a>.","operationId":"createKVMAPIProxy","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/api_name"}],"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/KVM"},"example":{"encrypted":true,"entry":[{"name":"keyname","value":"keyvalue"}],"name":"mykvm"}}}},"400":{"description":"Bad request"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KVM"},"example":{"encrypted":true,"entry":[{"name":"keyname","value":"keyvalue"}],"name":"mykvm"}}}}},"get":{"tags":["Key Value Map"],"summary":"List key value maps for an API proxy","description":"Lists the key value maps (KVMs) for an API proxy. ","operationId":"listKVMsAPIProxy","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/api_name"},{"$ref":"#/components/parameters/expand"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}}},"400":{"description":"Bad request"}}}},"/organizations/{org_name}/apis/{api_name}/keyvaluemaps/{map_name}":{"delete":{"tags":["Key Value Map"],"summary":"Delete key value map from an API proxy","description":"Deletes a key value map (KVM) from an API proxy. KVM names are case sensitive.","operationId":"deleteKVMAPIProxy","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/api_name"},{"$ref":"#/components/parameters/map_name"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/KVM"},"example":{"encrypted":true,"entry":[null],"name":"mykvm"}}}},"400":{"description":"Bad request"}}},"get":{"tags":["Key Value Map"],"summary":"Get key value map in an API proxy","description":"Gets a key value map (KVM) in an API proxy, including the keys and values. KVM names are case sensitive.\n\nWith **Apigee Edge for Public Cloud**, the maximum number of KVM entries returned is 1000. ","operationId":"getKVMAPIProxy","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/api_name"},{"$ref":"#/components/parameters/map_name"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/KVM"},"example":{"encrypted":true,"entry":[{"name":"keyname","value":"keyvalue"}],"name":"mykvm"}}}},"400":{"description":"Bad request"}}}},"/organizations/{org_name}/apis/{api_name}/keyvaluemaps/{map_name}/entries":{"post":{"tags":["Key Value Map"],"summary":"Create an entry in an API proxy-scoped KVM","description":"Creates an entry in an existing key value map (KVM) scoped to an API proxy.\n\nA key entry cannot be larger than 2 KB. KVM names are case sensitive.\n\n**Note**: **Apigee Edge for the Public Cloud only**.","operationId":"createKVMEntryAPIProxy","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/api_name"},{"$ref":"#/components/parameters/map_name"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Name of the entry."},"value":{"type":"string","description":"Value of the entry."}}},"example":{"name":"keyname","value":"keyvalue"}}}},"400":{"description":"Bad request"}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Name of the entry."},"value":{"type":"string","description":"Value of the entry."}}},"example":{"name":"keyname","value":"keyvalue"}}}}}},"/organizations/{org_name}/apis/{api_name}/keyvaluemaps/{map_name}/entries/{entry_name}":{"post":{"tags":["Key Value Map"],"summary":"Update an entry in an API proxy-scoped KVM","description":"Updates an entry in a key value map (KVM) scoped to an API proxy. \n\n**Note**: **Apigee Edge for the Public Cloud only**.\n\nA key cannot be larger than 2 KB. KVM names are case sensitive.\n\nThis method does not override the existing map. Instead, it updates the entries if they exist, or adds them if they do no exist. It can take several minutes before the new value is visible to runtime traffic.\n\nFor `entry_name`, use the key.","operationId":"updateKVMEntryAPIProxy","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/api_name"},{"$ref":"#/components/parameters/map_name"},{"$ref":"#/components/parameters/entry_name"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Name of the entry."},"value":{"type":"string","description":"Value of the entry."}}},"example":{"name":"keyname","value":"keyvalue"}}}},"400":{"description":"Bad request"}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Name of the entry."},"value":{"type":"string","description":"Value of the entry."}}},"example":{"name":"keyname","value":"keyvalue"}}}}},"get":{"tags":["Key Value Map"],"summary":"Get a key's value in an API proxy-scoped key value map","description":"Gets the value of a key in an API proxy-scoped key value map (KVM). KVM names are case sensitive.","operationId":"getKVMEntryAPIProxy","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/api_name"},{"$ref":"#/components/parameters/map_name"},{"$ref":"#/components/parameters/entry_name"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Name of the entry."},"value":{"type":"string","description":"Value of the entry."}}},"example":{"name":"keyname","value":"keyvalue"}}}},"400":{"description":"Bad request"}}},"delete":{"tags":["Key Value Map"],"summary":"Delete an entry from an API-proxy scoped key value map","description":"Deletes an entry from an API proxy-scoped key value map (KVM) along with its associated entries. KVM names are case sensitive.","operationId":"deleteKVMEntryAPIProxy","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/api_name"},{"$ref":"#/components/parameters/map_name"},{"$ref":"#/components/parameters/entry_name"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Name of the entry."},"value":{"type":"string","description":"Value of the entry."}}},"example":{"name":"keyname","value":"keyvalue"}}}},"400":{"description":"Bad request"}}}},"/organizations/{org_name}/apis/{api_name}/keyvaluemaps/{map_name}/keys":{"get":{"tags":["Key Value Map"],"summary":"List keys in an API proxy key value map","description":"Lists keys in a key value map (KVM) scoped to an API proxy. KVM names are case sensitive.\n\n**Note**: **Apigee Edge for Public Cloud only**.\n\n* By default, the maximum number of keys returned is 100. You can increase this to a maximum of 1000 using the count query parameter.\n* Paginate the list of keys returned using the `startkey` and `count` query parameters.\n* You can also create and manage environment-scoped key value maps in the management UI. For more information, see <a href=\"https://docs.apigee.com/docs/api-services/content/creating-and-editing-environment-keyvalue-maps\">Creating and editing environment key value maps</a>.","operationId":"listKeysKVMAPIProxy","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/api_name"},{"$ref":"#/components/parameters/map_name"},{"$ref":"#/components/parameters/count"},{"$ref":"#/components/parameters/startkey"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}}},"400":{"description":"Bad request"}}}},"/organizations/{org_name}/apis/{api_name}/revisions/{revision_number}/keyvaluemaps":{"post":{"tags":["Key Value Map"],"summary":"Create key value map in an API proxy revision","description":"Creates a key value map (KVM) scoped to an API proxy revision.\n\n**Note**: **Apigee Edge for Public Cloud only**.","operationId":"createKVMAPIProxyRevision","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/api_name"},{"$ref":"#/components/parameters/revision_number"}],"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/KVM"},"example":{"encrypted":true,"entry":[{"name":"keyname","value":"keyvalue"}],"name":"mykvm"}}}},"400":{"description":"Bad request"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KVM"},"example":{"encrypted":true,"entry":[{"name":"keyname","value":"keyvalue"}],"name":"mykvm"}}}}}},"/organizations/{org_name}/apis/{api_name}/revisions/{revision_number}/keyvaluemaps/{map_name}/entries":{"post":{"tags":["Key Value Map"],"summary":"Create an entry in an API proxy revision-scoped KVM","description":"Creates an entry in an existing key value map (KVM) scoped to an API proxy revision. \n\n**Note**: **Apigee Edge for the Public Cloud only**.\n\nA key/entry-name cannot be larger than 2 KB. KVM names are case sensitive.","operationId":"createKVMEntryAPIProxyRevision","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/api_name"},{"$ref":"#/components/parameters/revision_number"},{"$ref":"#/components/parameters/map_name"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Name of the entry."},"value":{"type":"string","description":"Value of the entry."}}},"example":{"name":"keyname","value":"keyvalue"}}}},"400":{"description":"Bad request"}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Name of the entry."},"value":{"type":"string","description":"Value of the entry."}}},"example":{"name":"keyname","value":"keyvalue"}}}}}},"/organizations/{org_name}/apis/{api_name}/revisions/{revision_number}/keyvaluemaps/{map_name}/entries/{entry_name}":{"post":{"tags":["Key Value Map"],"summary":"Update an entry in an API proxy revision-scoped KVM","description":"Updates an entry in a key value map (KVM) scoped to an API proxy revision. \n\n**Note**: **Apigee Edge for the Public Cloud only**.\n\nA key cannot be larger than 2 KB. KVM names are case sensitive.\n\nThis method does not override the existing map. Instead, it updates the entries if they exist, or adds them if they do not exist. It can take several minutes before the new value is visible to runtime traffic.\n\nFor `entry_name`, use the key.","operationId":"updateEntryAPIProxyRevision","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/api_name"},{"$ref":"#/components/parameters/revision_number"},{"$ref":"#/components/parameters/map_name"},{"$ref":"#/components/parameters/entry_name"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Name of the entry."},"value":{"type":"string","description":"Value of the entry."}}},"example":{"name":"keyname","value":"keyvalue"}}}},"400":{"description":"Bad request"}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Name of the entry."},"value":{"type":"string","description":"Value of the entry."}}},"example":{"name":"keyname","value":"keyvalue"}}}}}},"/organizations/{org_name}/apis/{api_name}/revisions/{revision_number}/keyvaluemaps/{map_name}/keys":{"get":{"tags":["Key Value Map"],"summary":"List keys in an API proxy revision key value map","description":"Lists keys in a key value map (KVM) scoped to an API proxy revision. KVM names are case sensitive.\n\n**Note**: **Apigee Edge for Public Cloud only**.","operationId":"listKVMEntryAPIProxyRevision","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/api_name"},{"$ref":"#/components/parameters/revision_number"},{"$ref":"#/components/parameters/map_name"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}}},"400":{"description":"Bad request"}}}},"/organizations/{org_name}/environments/{env_name}/keyvaluemaps":{"post":{"tags":["Key Value Map"],"summary":"Create key value map in an environment","description":"Creates a key value map (KVM) in an environment.\n\nA KVM is a simple structure for persistently storing name/value pairs as entries in a named map. The entries in a KVM can be retrieved at runtime by the <a href=\"https://docs.apigee.com/api-services/reference/key-value-map-operations-policy\">KeyValueMapOperations policy</a> or code running on Apigee Edge. Use KVMs for use cases such as profile-based access control, storing environment-specific data, to control application-specific behavior, and so on.\n\nYou can create an encrypted KVM by adding `\"encrypted\" : \"true\"` to the request payload. You update encrypted KVMs the same way you update non-encrypted KVMs.\n\nKVM names are case sensitive.\n\n**Note**: You can also create and manage environment-scoped KMVs in the Edge UI. For more information, see <a href=\"https://docs.apigee.com/api-services/content/creating-and-editing-environment-keyvalue-maps\">Creating and editing environment key value maps</a>.\n\nFor information on retrieving KVMs, see <a href=\"https://docs.apigee.com/api-services/reference/key-value-map-operations-policy\">KeyValueMapOperations policy</a>.","operationId":"createKVMEnv","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/env_name"}],"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/KVM"},"example":{"encrypted":true,"entry":[{"name":"keyname","value":"keyvalue"}],"name":"mykvm"}}}},"400":{"description":"Bad request"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KVM"},"example":{"encrypted":true,"entry":[{"name":"keyname","value":"keyvalue"}],"name":"mykvm"}}}}},"get":{"tags":["Key Value Map"],"summary":"List key value maps in an Environment","description":"Lists the key value maps (KVMs) for an environment. \n\n**Note**: You can also create and manage environment-scoped KVMs in the Edge UI. For more information, see <a href=\"https://docs.apigee.com/api-platform/cache/creating-and-editing-environment-keyvalue-maps\">Creating and editing environment key value maps</a>.","operationId":"listKVMsEnv","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/env_name"},{"$ref":"#/components/parameters/expand"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}}},"400":{"description":"Bad request"}}}},"/organizations/{org_name}/environments/{env_name}/keyvaluemaps/{map_name}":{"get":{"tags":["Key Value Map"],"summary":"Get key value map in an environment","description":"Gets a key value map (KVM) in an API proxy by name, along with the keys and values. KVM names are case sensitive.\n\n**Note**: With Apigee Edge for Public Cloud, the maximum number of KVM entries returned is 1000. \n\nYou can also create and manage environment-scoped KVMs in the Edge UI. For more information, see <a href=\"https://docs.apigee.com/docs/api-services/content/creating-and-editing-environment-keyvalue-maps\">Creating and editing environment key value maps</a>.","operationId":"getKVMEnv","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/env_name"},{"$ref":"#/components/parameters/map_name"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/KVM"},"example":{"encrypted":true,"entry":[{"name":"keyname","value":"keyvalue"}],"name":"mykvm"}}}},"400":{"description":"Bad request"}}},"delete":{"tags":["Key Value Map"],"summary":"Delete key value map from an environment","description":"Deletes a key value map (KVM) and all associated entries from an environment. KVM names are case sensitive.\n\n**Note**: You can also create and manage environment-scoped key value maps in the Edge UI. For more information, see <a href=\"https://docs.apigee.com/docs/api-services/content/creating-and-editing-environment-keyvalue-maps\">Creating and editing environment key value maps</a>.","operationId":"deleteKVMEnv","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/env_name"},{"$ref":"#/components/parameters/map_name"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/KVM"},"example":{"encrypted":true,"entry":[null],"name":"mykvm"}}}},"400":{"description":"Bad request"}}},"post":{"tags":["Key Value Map"],"summary":"Update key value map in an environment","description":"Updates an existing key value map (KVM) in an environment. \n\nThis API does not override the existing map. Instead, this method updates the entries if they exist or adds them if not. It can take several minutes before the new value is visible to runtime traffic.\n\n**Notes**: \n* **Apigee Edge for Private Cloud only**. For Apigee Edge for Public Cloud use Update an entry in an environment-scoped KVM.\n* You can also create and manage environment-scoped key value maps in the Edge UI. For more information, see <a href=\"https://docs.apigee.com/docs/api-services/content/creating-and-editing-environment-keyvalue-maps\">Creating and editing environment key value maps</a>.","operationId":"updateKVMEnv","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/env_name"},{"$ref":"#/components/parameters/map_name"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/KVM"},"example":{"encrypted":true,"entry":[{"name":"keyname","value":"keyvalue"}],"name":"mykvm"}}}},"400":{"description":"Bad request"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KVM"},"example":{"encrypted":true,"entry":[{"name":"keyname","value":"keyvalue"}],"name":"mykvm"}}}}}},"/organizations/{org_name}/environments/{env_name}/keyvaluemaps/{map_name}/entries":{"post":{"tags":["Key Value Map"],"summary":"Create an entry in an environment-scoped KVM","description":"Creates an entry in an existing key value map (KVM) scoped to an environment.\n\nA key/entry-name cannot be larger than 2 KB. KVM names are case sensitive.\n\n**Notes**: \n* **Apigee Edge for the Public Cloud only**.\n* You can also create and manage environment-scoped key value maps in the Edge UI. For more information, see <a href=\"https://docs.apigee.com/docs/api-services/content/creating-and-editing-environment-keyvalue-maps\">Creating and editing environment key value maps</a>.","operationId":"createEntryKVMEnv","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/env_name"},{"$ref":"#/components/parameters/map_name"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Name of the entry."},"value":{"type":"string","description":"Value of the entry."}}},"example":{"name":"keyname","value":"keyvalue"}}}},"400":{"description":"Bad request"}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Name of the entry."},"value":{"type":"string","description":"Value of the entry."}}},"example":{"name":"keyname","value":"keyvalue"}}}}}},"/organizations/{org_name}/environments/{env_name}/keyvaluemaps/{map_name}/entries/{entry_name}":{"post":{"tags":["Key Value Map"],"summary":"Update an entry in an environment-scoped KVM","description":"Updates an entry in a key value map scoped to an environment. \n\n**Notes**: \n\n* **Apigee Edge for the Public Cloud only**.\n\n* You can also create and manage environment-scoped key value maps in the management UI. For more information, see <a href=\"https://docs.apigee.com/docs/api-services/content/creating-and-editing-environment-keyvalue-maps\">Creating and editing environment key value maps</a>.\n\nA key cannot be larger than 2 KB. KVM names are case sensitive.\n\nThis method does not override the existing map. Instead, it updates the entries if they exist, or adds them if they do not exist. It can take several minutes before the new value is visible to runtime traffic.\n\nFor `entry_name`, use the key.","operationId":"updateEntryKVMEnv","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/env_name"},{"$ref":"#/components/parameters/map_name"},{"$ref":"#/components/parameters/entry_name"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Name of the entry."},"value":{"type":"string","description":"Value of the entry."}}},"example":{"name":"keyname","value":"keyvalue"}}}},"400":{"description":"Bad request"}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Name of the entry."},"value":{"type":"string","description":"Value of the entry."}}},"example":{"name":"keyname","value":"keyvalue"}}}}},"delete":{"tags":["Key Value Map"],"summary":"Delete an entry from an environment-scoped key value map","description":"Deletes an entry from an environment-scoped key value map (KVM) along with associated entries. KVM names are case sensitive.\n\n**Note**: You can also create and manage environment-scoped key value maps in the management UI. For more information, see <a href=\"https://docs.apigee.com/docs/api-services/content/creating-and-editing-environment-keyvalue-maps\">Creating and editing environment key value maps</a>.","operationId":"deleteEntryKVMEnv","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/env_name"},{"$ref":"#/components/parameters/map_name"},{"$ref":"#/components/parameters/entry_name"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Name of the entry."},"value":{"type":"string","description":"Value of the entry."}}},"example":{"name":"keyname","value":"keyvalue"}}}},"400":{"description":"Bad request"}}},"get":{"tags":["Key Value Map"],"summary":"Get a the value of a key in an environment-scoped key value map","description":"Get a key's value in an environment-scoped key value map","operationId":"getKeyKVMEnv","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/env_name"},{"$ref":"#/components/parameters/map_name"},{"$ref":"#/components/parameters/entry_name"}],"responses":{"200":{"description":"OK"},"400":{"description":"Bad request"}}}},"/organizations/{org_name}/environments/{env_name}/keyvaluemaps/{map_name}/keys":{"get":{"tags":["Key Value Map"],"summary":"List keys in an environment-scoped key value map","description":"Lists keys in a key value map (KVM) scoped to an environment. KVM names are case sensitive.\n\n**Notes**: \n\n* **Apigee Edge for Public Cloud only**.\n* By default, the maximum number of keys returned is 100. You can increase this to a maximum of 1000 using the count query parameter.\n* Paginate the list of keys returned using the `startkey` and `count` query parameters.\n* You can also create and manage environment-scoped key value maps in the management UI. For more information, see <a href=\"https://docs.apigee.com/docs/api-services/content/creating-and-editing-environment-keyvalue-maps\">Creating and editing environment key value maps</a>.","operationId":"listKeysKMVEnv","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/env_name"},{"$ref":"#/components/parameters/map_name"},{"$ref":"#/components/parameters/count"},{"$ref":"#/components/parameters/startkey"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}}},"400":{"description":"Bad request"}}}},"/organizations/{org_name}/keyvaluemaps":{"post":{"tags":["Key Value Map"],"summary":"Create key value map in an organization","description":"Creates a key value map (KVM) in an organization.\n\nA KVM is a simple structure for persistently storing name/value pairs as entries in a named map. The entries in a KVM can be retrieved at runtime by the <a href=\"https://docs.apigee.com/api-services/reference/key-value-map-operations-policy\">KeyValueMapOperations policy</a> or code running on Apigee Edge. Use KVMs for use cases such as profile-based access control, storing environment-specific data, to control application-specific behavior, and so on.\n\nYou can create an encrypted KVM by adding `\"encrypted\" : \"true\"` to the request payload. You update encrypted KVMs the same way you update non-encrypted KVMs.\n\nKVM names are case sensitive.\n\n**Note**: KVMs created at the organization <a href=\"https://docs.apigee.com/api-platform/cache/key-value-maps.html#scope\">scope</a> do not appear in the Edge UI. Only KVMs created at the environment scope apear in the Edge UI. To see the KVMs defined at the organization scope, use the List KVMs for an organization API.\n\nFor information on retrieving KVMs, see <a href=\"https://docs.apigee.com/api-services/reference/key-value-map-operations-policy\">KeyValueMapOperations policy</a>.","operationId":"createKVMOrg","parameters":[{"$ref":"#/components/parameters/org_name"}],"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/KVM"},"example":{"encrypted":true,"entry":[{"name":"keyname","value":"keyvalue"}],"name":"mykvm"}}}},"400":{"description":"Bad request"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KVM"},"example":{"encrypted":true,"entry":[{"name":"keyname","value":"keyvalue"}],"name":"mykvm"}}}}},"get":{"tags":["Key Value Map"],"summary":"List key value maps in an organization","description":"Lists key value maps in an organization.","operationId":"listKVMsOrg","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/expand"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}}},"400":{"description":"Bad request"}}}},"/organizations/{org_name}/keyvaluemaps/{map_name}":{"get":{"tags":["Key Value Map"],"summary":"Get key value map in an organization","description":"Gets a key value map in an organization.","operationId":"getKVMOrg","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/map_name"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/KVM"},"example":{"encrypted":true,"entry":[{"name":"keyname","value":"keyvalue"}],"name":"mykvm"}}}},"400":{"description":"Bad request"}}},"post":{"tags":["Key Value Map"],"summary":"Update key value map in an organization","description":"Updates an existing key value map (KVM) in an environment. \n\nThis API does not override the existing map. Instead, this method updates the entries if they exist or adds them if not. It can take several minutes before the new value is visible to runtime traffic.\n\n**Note**: **Apigee Edge for the Private Cloud only**. For Apigee Edge for the Cloud, update map entries individually instead of in bulk. See Update an entry in an organization-scoped KVM.","operationId":"updateKVMOrg","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/map_name"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/KVM"},"example":{"encrypted":true,"entry":[{"name":"keyname","value":"keyvalue"}],"name":"mykvm"}}}},"400":{"description":"Bad request"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KVM"},"example":{"encrypted":true,"entry":[{"name":"keyname","value":"keyvalue"}],"name":"mykvm"}}}}},"delete":{"tags":["Key Value Map"],"summary":"Delete key value map from an organization","description":"Deletes a key value map (KVM) and all associated entries from an organization. KVM names are case sensitive.","operationId":"deleteKVMOrg","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/map_name"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/KVM"},"example":{"encrypted":true,"entry":[null],"name":"mykvm"}}}},"400":{"description":"Bad request"}}}},"/organizations/{org_name}/keyvaluemaps/{map_name}/entries":{"post":{"tags":["Key Value Map"],"summary":"Create a key value entry in an organization-scoped KVM","description":"Creates an entry in an existing key value map (KVM) scoped to an organization.\n\nA key/entry-name cannot be larger than 2 KB. KVM names are case sensitive.\n\n**Note**: **Apigee Edge for the Public Cloud only**.","operationId":"createEntryKVMOrg","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/map_name"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Name of the entry."},"value":{"type":"string","description":"Value of the entry."}}},"example":{"name":"keyname","value":"keyvalue"}}}},"400":{"description":"Bad request"}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Name of the entry."},"value":{"type":"string","description":"Value of the entry."}}},"example":{"name":"keyname","value":"keyvalue"}}}}}},"/organizations/{org_name}/keyvaluemaps/{map_name}/entries/{entry_name}":{"delete":{"tags":["Key Value Map"],"summary":"Delete an entry from an organization-scoped KVM","description":"Deletes an entry from an organization-scoped key value map (KVM). KVM names are case sensitive.","operationId":"deleteEntryKVMOrg","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/map_name"},{"$ref":"#/components/parameters/entry_name"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Name of the entry."},"value":{"type":"string","description":"Value of the entry."}}},"example":{"name":"keyname","value":"keyvalue"}}}},"400":{"description":"Bad request"}}},"get":{"tags":["Key Value Map"],"summary":"Get the value of a key in an organization-scoped key value map","description":"Gets the value of a key in an organization-scoped key value map (KVM). KVM names are case sensitive.","operationId":"getKeyKVMOrg","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/map_name"},{"$ref":"#/components/parameters/entry_name"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Name of the entry."},"value":{"type":"string","description":"Value of the entry."}}},"example":{"name":"keyname","value":"keyvalue"}}}},"400":{"description":"Bad request"}}},"post":{"tags":["Key Value Map"],"summary":"Update an entry in an organization-scoped KVM","description":"Updates an entry in a key value map scoped to an organization. \n\n**Note**: **Apigee Edge for the Public Cloud only**.\n\nA key cannot be larger than 2 KB. KVM names are case sensitive.\n\nThis method does not override the existing map. Instead, it updates the entries if they exist, or adds them if they do not exist. It can take several minutes before the new value is visible to runtime traffic.\n\nFor `entry_name`, use the key.","operationId":"updateEntryKVMOrg","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/map_name"},{"$ref":"#/components/parameters/entry_name"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Name of the entry."},"value":{"type":"string","description":"Value of the entry."}}},"example":{"name":"keyname","value":"keyvalue"}}}},"400":{"description":"Bad request"}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Name of the entry."},"value":{"type":"string","description":"Value of the entry."}}},"example":{"name":"keyname","value":"keyvalue"}}}}}},"/organizations/{org_name}/keyvaluemaps/{map_name}/keys":{"get":{"tags":["Key Value Map"],"summary":"List keys in an organization key value map","description":"Lists keys in a key value map (KVM) scoped to an organization. KVM names are case sensitive.\n\n**Note**: **Apigee Edge for Public Cloud only**.\n* By default, the maximum number of keys returned is 100. You can increase this to a maximum of 1000 using the count query parameter.\n* Paginate the list of keys returned using the `startkey` and `count` query parameters.\n* You can also create and manage environment-scoped key value maps in the management UI. For more information, see <a href=\"https://docs.apigee.com/docs/api-services/content/creating-and-editing-environment-keyvalue-maps\">Creating and editing environment key value maps</a>.","operationId":"listKeysKVMOrg","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/map_name"},{"$ref":"#/components/parameters/count"},{"$ref":"#/components/parameters/startkey"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}}},"400":{"description":"Bad request"}}}}},"components":{"securitySchemes":{"Basic":{"type":"http","scheme":"basic","description":"Multi-factor authentication is not supported."},"OAuth":{"type":"apiKey","name":"Authorization","in":"header","description":"For OAuth, enter the following in the Key field: Bearer %your-token% (see https://docs.apigee.com/api-platform/system-administration/using-oauth2#get-the-tokens)"}},"parameters":{"org_name":{"in":"path","name":"org_name","required":true,"schema":{"type":"string"},"description":"Organization name."},"env_name":{"in":"path","name":"env_name","required":true,"schema":{"type":"string"},"description":"Environment name."},"api_name":{"in":"path","name":"api_name","required":true,"schema":{"type":"string"},"description":"API proxy name."},"revision_number":{"in":"path","name":"revision_number","required":true,"schema":{"type":"string"},"description":"API proxy revision number."},"map_name":{"in":"path","name":"map_name","required":true,"schema":{"type":"string"},"description":"Key value map name."},"entry_name":{"in":"path","name":"entry_name","required":true,"schema":{"type":"string"},"description":"Name of the key for the key/value pair."},"expand":{"in":"query","name":"expand","required":false,"schema":{"type":"boolean"},"description":"Set to `true` to expand the view of the response. <b>Note</b>: This parameter only applies to Apigee Edge for Private Cloud. It has no effect in Apigee Edge for Public Cloud."},"startkey":{"in":"query","name":"startkey","required":false,"schema":{"type":"string"},"description":"Returns a list of keys starting with the specified key. For example, if an unfiltered list\nincludes:\n\n - `mykey_12`\n - `mykey_products`\n - `ab_test_key`\n - `user_status`\n \nIf the startkey is `mykey_products`, the returned list will be:\n\n - `ab_test_key`\n - `user_status`\n \nFor pagination, start with an empty or missing `startkey`, and then use the last returned value to get the next page of (up to) `count` keys. Repeat until you get an empty array.\n\nNote: `/keyvaluemaps/{map_name}/keys` is the only way to get every entry when `/keyvaluemaps/{map_name}` exceeds the 1000 maximim entries returned.\nThe order of keys is stable but does not match the literal key or insertion order. If you add a new entry, the new key can appear anywhere.\n"},"count":{"in":"query","name":"count","required":false,"schema":{"type":"integer"},"description":"Number of keys to return. By default, the maximum number of keys returned is 100. You can increase this to a maximum of 1000 using the `count` query parameter. Use with the `startkey` parameter to provide more targeted filtering or pagination."}},"schemas":{"KVMs":{"type":"array","description":"KVM entries.","items":{"$ref":"#/components/schemas/KVM"}},"KVM":{"description":"KVM entry details.","type":"object","required":["name","entry"],"properties":{"name":{"description":"Name of the KVM. Valid characters include: `A-Z0-9._\\-$ %`","type":"string"},"encrypted":{"description":"Flag that specifies whether the KVM is encrypted. Defaults to `false`.","type":"boolean"},"entry":{"type":"array","description":"Name/value pairs for the KVM entry that define the data to be stored. Valid characters include: `A-Z0-9._\\-$ %`","items":{"type":"object","properties":{"name":{"type":"string","description":"KVM entry name."},"value":{"type":"string","description":"KVM entry value."}}}}}}}}}
/ organizations / {org_name} / apis / {api_name} / keyvaluemaps
/ organizations / {org_name} / apis / {api_name} / keyvaluemaps / {map_name}
/ organizations / {org_name} / apis / {api_name} / keyvaluemaps / {map_name} / entries
/ organizations / {org_name} / apis / {api_name} / keyvaluemaps / {map_name} / entries / {entry_name}
/ organizations / {org_name} / apis / {api_name} / keyvaluemaps / {map_name} / keys
/ organizations / {org_name} / apis / {api_name} / revisions / {revision_number} / keyvaluemaps
/ organizations / {org_name} / apis / {api_name} / revisions / {revision_number} / keyvaluemaps / {map_name} / entries
/ organizations / {org_name} / apis / {api_name} / revisions / {revision_number} / keyvaluemaps / {map_name} / entries / {entry_name}
/ organizations / {org_name} / apis / {api_name} / revisions / {revision_number} / keyvaluemaps / {map_name} / keys
/ organizations / {org_name} / environments / {env_name} / keyvaluemaps
/ organizations / {org_name} / environments / {env_name} / keyvaluemaps / {map_name}
/ organizations / {org_name} / environments / {env_name} / keyvaluemaps / {map_name} / entries
/ organizations / {org_name} / environments / {env_name} / keyvaluemaps / {map_name} / entries / {entry_name}
/ organizations / {org_name} / environments / {env_name} / keyvaluemaps / {map_name} / keys
/ organizations / {org_name} / keyvaluemaps
/ organizations / {org_name} / keyvaluemaps / {map_name}
/ organizations / {org_name} / keyvaluemaps / {map_name} / entries
/ organizations / {org_name} / keyvaluemaps / {map_name} / entries / {entry_name}
/ organizations / {org_name} / keyvaluemaps / {map_name} / keys
Apps API OpenAPI	{"openapi":"3.0.0","info":{"title":"Apps API","version":"1.0","description":"Apps are API consumers registered with an API provider's organization. Apps are registered with an\n organization to obtain credentials that enable access to one or more API products (or a set of URIs).\n The default app profile can be extended by using custom attributes. Apps can be associated with\n developers (as developer apps) or with companies (company apps)."},"servers":[{"url":"https://api.enterprise.apigee.com/v1"}],"security":[{"Basic":[]},{"OAuth":[]}],"paths":{"/organizations/{org_name}/apps":{"get":{"summary":"List apps in an organization","description":"Lists apps in an organization. Filter the list of apps by app status, type, or family.","operationId":"listApps","tags":["App"],"parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/apptype"},{"$ref":"#/components/parameters/expand"},{"$ref":"#/components/parameters/rows"},{"$ref":"#/components/parameters/startKey"},{"$ref":"#/components/parameters/status"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"oneOf":[{"type":"array","items":{"type":"string"}},{"$ref":"#/components/schemas/Apps"}]},"example":["app","app2"]}}},"400":{"description":"Bad request"}}}},"/organizations/{org_name}/apps/{app_id}":{"get":{"summary":"Get app in an organization","description":"Gets an app in an organization.","operationId":"getApp","tags":["App"],"parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/app_id"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/App"},"example":{"apiProducts":[],"appFamily":"default","appId":"0207d728-0c74-458b-a97b-c0627a7ee079","attributes":[{"name":"DisplayName","value":"MyApp"}],"callbackUrl":"","createdAt":1450367690169,"createdBy":"ahamilton@example.com","credentials":[{"apiProducts":[{"apiproduct":"MyProduct","status":"approved"}],"attributes":[],"consumerKey":"Wf4GKmDwroHY10obg4LbMwXYxxxx","consumerSecret":"9BTxjuWG0fxxxxx","expiresAt":-1,"issuedAt":1450367690196,"scopes":[],"status":"approved"}],"developerId":"e0150b7c-47e8-4461-9670-edbaa3fde236","lastModifiedAt":1450367690169,"lastModifiedBy":"ahamilton@example.com","name":"MyApp","scopes":[],"status":"approved"}}}},"400":{"description":"Bad request"}}}}},"components":{"schemas":{"Apps":{"description":"List of app details.","type":"object","properties":{"app":{"type":"array","items":{"$ref":"#/components/schemas/App"}}}},"App":{"title":"App","description":"App details.","type":"object","properties":{"apiProducts":{"description":"List of API products associated with the app.","type":"array","items":{"type":"string"}},"appFamily":{"description":"App family.","type":"string"},"appId":{"description":"ID of the app.","type":"string"},"attributes":{"description":"List of attributes. With Apigee Edge for Public Cloud, the custom attribute limit is 18.","type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"value":{"type":"string"}}}},"callbackUrl":{"description":"Callback URL used by OAuth 2.0 authorization servers to communicate authorization codes back to apps.","type":"string"},"companyName":{"description":"Name of the company that owns the app, if applicable.","type":"string"},"createdAt":{"format":"int32","description":"Output only. Time the app was created in milliseconds since epoch.","type":"integer"},"createdBy":{"description":"Output only. Email address of the developer that created the app.","type":"string"},"credentials":{"description":"Output only. Set of credentials for the app. Credentials are API key/secret pairs associated with API products.","type":"array","items":{"type":"object","properties":{"apiProducts":{"type":"array","items":{"type":"object","properties":{"apiproduct":{"type":"string"},"status":{"type":"string"}}}},"attributes":{"type":"array","items":{"type":"object"}},"consumerKey":{"type":"string"},"consumerSecret":{"type":"string"},"expiresAt":{"format":"int32","type":"integer"},"issuedAt":{"format":"int32","type":"integer"},"scopes":{"type":"array","items":{"type":"object"}},"status":{"type":"string"}}}},"developerId":{"description":"ID of the developer.","type":"string"},"lastModifiedAt":{"format":"int32","description":"Output only. Last modified time as milliseconds since epoch.","type":"integer"},"lastModifiedBy":{"description":"Output only. Email of developer that last modified the app.","type":"string"},"name":{"description":"Name of the app.","type":"string"},"scopes":{"description":"Scopes to apply to the app. The specified scope names must already exist on the API product that you associate with the app.","type":"array","items":{"type":"string"}},"status":{"description":"Status of the credential.","type":"string"}}}},"parameters":{"org_name":{"name":"org_name","description":"Organization name.","schema":{"type":"string"},"in":"path","required":true},"app_id":{"name":"app_id","description":"App ID.","schema":{"type":"string"},"in":"path","required":true},"status":{"name":"status","description":"Status of the apps that you want to view. Valid values include `approved` or `revoked`.","schema":{"type":"string"},"in":"query","required":false},"apptype":{"name":"apptype","description":"Type of the apps that you want to view. Valid values include `company` or `developer`.","schema":{"type":"string"},"in":"query","required":false},"appfamily":{"name":"appfamily","description":"Name of the app family.","schema":{"type":"string"},"in":"query","required":false},"includeCred":{"name":"includeCred","description":"Flag that specifies whether to include the consumer key and secret for each app profile. Set\n to `true` to include the consumer key and secret.","schema":{"type":"boolean"},"in":"query","required":false},"expand":{"name":"expand","description":"Flag that specifies whether to view expanded details for each app. Set to `true` to view expanded details.","schema":{"type":"boolean"},"in":"query","required":false},"startKey":{"name":"startKey","description":"**Apigee Edge for Public Cloud only**. ID of the app from which to start displaying the list of apps. For example, if the unfiltered list includes the following app names:\n\n```\n\"ddce5dff-d0b7-4c91-9be1-ac586ea99a8e\",\n\"e8fd6a3d-f88c-462e-a4ec-41cf886f12b7\",\n\"f1360a60-d927-42ff-8c86-1466e6546b39\"\n```\nIf you set the `startKey` to `e8fd6a3d-f88c-462e-a4ec-41cf886f12b7`, the list will include:\n```\n\"e8fd6a3d-f88c-462e-a4ec-41cf886f12b7\",\n\"f1360a60-d927-42ff-8c86-1466e6546b39\"\n```","schema":{"type":"string"},"in":"query","required":false},"rows":{"name":"rows","description":"**Apigee Edge for Public Cloud only**. Number of apps to return. Required if you specify `startKey`.\n\nWith **Apigee Edge for Public Cloud**, the maximum number of entities returned is 1000. With **Apigee Edge for Private Cloud**, the maximum number of entities returned is 10,000.","schema":{"type":"integer"},"in":"query","required":false}},"securitySchemes":{"Basic":{"type":"http","scheme":"basic","description":"Multi-factor authentication is not supported."},"OAuth":{"type":"apiKey","name":"Authorization","in":"header","description":"For OAuth, enter the following in the Key field: Bearer %your-token% (see https://docs.apigee.com/api-platform/system-administration/using-oauth2#get-the-tokens)"}}}}
/ organizations / {org_name} / apps
/ organizations / {org_name} / apps / {app_id}
Virtual hosts API OpenAPI	{"openapi":"3.0.0","servers":[{"url":"https://api.enterprise.apigee.com/v1"}],"info":{"title":"Virtual hosts API","description":"Manage virtual hosts. Virtual hosts let multiple domain names connect to the same host. A virtual host on Edge defines the domains and ports on which an API proxy is exposed, and, by extension, the URL that apps use to access an API proxy. A virtual host also defines whether the API proxy is accessed by using the HTTP protocol, or by the encrypted HTTPS protocol.","version":"1.0"},"security":[{"Basic":[]},{"OAuth":[]}],"paths":{"/organizations/{org_name}/environments/{env_name}/virtualhosts/{virtualhost_name}/sslinfo":{"post":{"tags":["Virtual Host"],"summary":"Update TLS configuration for a virtual host","description":"**DEPRECATED**: This API is being deprecated and will be removed in a future release.\n\nCloud customers can now create and update a virtual host, not just modify the TLS properties of the virtual host. Therefore, this API has been deprecated. Cloud customers can now use the following APIs with virtual hosts:\n* <a href=\"/docs/virtual-hosts/1/routes/organizations/%7Borg_name%7D/environments/%7Benv_name%7D/virtualhosts/%7Bvirtualhost_name%7D/get\">Get a virtual host</a>\n* <a href=\"/docs/virtual-hosts/1/routes/organizations/%7Borg_name%7D/environments/%7Benv_name%7D/virtualhosts/%7Bvirtualhost_name%7D/put\">Update a virtual host</a>\nSee <a href=\"https://docs.apigee.com/api-platform/fundamentals/virtual-hosts\">About virtual hosts</a> for more.\n\nUpdate the TLS configuration properties for a virtual host for Edge in the Cloud. For example, enable one-way or two-way TLS or specify the keystore/truststore used by the virtual host.\n\nOnly paid Edge Cloud accounts can make modifications to the TLS configuration of virtual hosts. Edge trial accounts cannot modify the TLS configuration of virtual hosts. Trial accounts must upgrade to a paid account to enable this feature.","operationId":"updateTLSConfigVirtualHost","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/env_name"},{"$ref":"#/components/parameters/virtualhost_name"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VirtualHost"}}}},"400":{"description":"Bad request"}},"requestBody":{"description":"SSL information.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SSLInfo"}},"application/xml":{"schema":{"$ref":"#/components/schemas/SSLInfo"}}},"required":true}}},"/organizations/{org_name}/environments/{env_name}/virtualhosts":{"post":{"tags":["Virtual Host"],"summary":"Create a virtual host","description":"Creates a virtual host.\n\nVirtual hosts let multiple domain names connect to the same host. A virtual host on Edge defines the domains and ports on which an API proxy is exposed, and, by extension, the URL that apps use to access an API proxy. A virtual host also defines whether the API proxy is accessed by using the HTTP protocol, or by the encrypted HTTPS protocol.\n\nThe request body content used to create a virtual host depends on whether you are using Edge for the Cloud or Edge for the Private Cloud. If you are using Edge for the Private Cloud, then it also depends on which version of Edge for the Private Cloud you are using. For a complete list of all options for the request body, see <a href=\"https://docs.apigee.com/api-platform/fundamentals/virtual-host-property-reference\">Virtual host property reference</a>.\n\nFor example, a subset of request body properties are valid only for specific Edge for Private Cloud versions, as follows:\n\n* `ciphers` and `protocols` properties are valid on Edge for Private Cloud version 4.15.07 and earlier\n* `properties` array is valid on Edge for Private Cloud version 4.17.01 and later\n* `baseUrl` property is valid on Edge for Private Cloud version 4.17.05 and later\n* `retryOptions` and `listenOptions` properties are valid on Edge for Private Cloud version 4.18.01 and later\n\n**Note**: As of Edge for Private Cloud version 4.16.01, you must create a host alias when you create a virtual host. Also, the combination of host alias name and port number for the virtual host must be unique for all virtual hosts in the Edge installation.\n\nFor a general introduction to creating virtual hosts, see <a href=\"https://docs.apigee.com/api-platform/fundamentals/virtual-hosts\">About virtual hosts</a>. For information about your specific version of Edge, see:\n* <a href=\"https://docs.apigee.com/api-platform/fundamentals/configuring-virtual-hosts-cloud\">Configuring virtual hosts for the Cloud</a>\n* <a href=\"https://docs.apigee.com/api-platform/fundamentals/configuring-virtual-hosts-private-cloud\">Configuring virtual hosts for the Private Cloud</a>\nSee <a href=\"https://docs.apigee.com/api-platform/fundamentals/virtual-host-property-reference\">Virtual host property reference</a> for complete information on setting all virtual host values.\n\n**Updating a proxy to use the new virtual host**\n\nWhen you create a new API proxy, Edge automatically configures its ProxyEndpoint to use all available virtual hosts. If you create a new API proxy that should not be accessible over a particular virtual host, then you must edit the API proxy to remove that virtual host from its ProxyEndpoint.\n\nIf you created any API proxies before requesting the virtual host, then you must edit the API proxy to add the new virtual hosts to its ProxyEndpoint. Otherwise, the API proxy is not accessible by the virtual host.\nSee <a href=\"https://docs.apigee.com/api-platform/fundamentals/virtual-hosts#configuringanapiproxytouseavirtualhost\">Configuring an API proxy to use a virtual host</a>.","operationId":"createVirtualHost","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/env_name"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VirtualHost"}}}},"400":{"description":"Bad request"}},"requestBody":{"description":"Virtual host information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VirtualHost"}},"application/xml":{"schema":{"$ref":"#/components/schemas/VirtualHost"}}},"required":true}},"get":{"tags":["Virtual Host"],"summary":"List virtual hosts","description":"Lists all virtual hosts in an environment. By default, two virtual hosts are available for each environment: `default` and `secure`","operationId":"listVirtualHosts","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/env_name"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}}},"400":{"description":"Bad request"}}}},"/organizations/{org_name}/environments/{env_name}/virtualhosts/{virtualhost_name}":{"get":{"tags":["Virtual Host"],"summary":"Get virtual host","description":"Gets a virtual host. \n\nEvery environment has at least one virtual host that defines the HTTP settings for connection with the Apigee organization. All API proxies in an environment share the same virtual hosts. By default, two virtual hosts are available for each environment: `default` and `secure`.","operationId":"getVirtualHost","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/env_name"},{"$ref":"#/components/parameters/virtualhost_name"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VirtualHost"}}}},"400":{"description":"Bad request"}}},"put":{"tags":["Virtual Host"],"summary":"Update a virtual host","description":"Updates a virtual host.\n\nYou must specify the complete description of the virtual host in the request body, not just the elements that you want to change. You can get the current virtual host properties, as described in <a href=\"/docs/virtual-hosts/1/routes/organizations/%7Borg_name%7D/environments/%7Benv_name%7D/virtualhosts/%7Bvirtualhost_name%7D/get\">Get a virtual host</a>.\n\nThe request body used to create a virtual host depends on whether you are using Edge for the Cloud or Edge for the Private Cloud. If you are using Edge for the Private Cloud, then it also depends on which version of Edge for the Private Cloud you are using. For a complete list of all options for the request body, see <a href=\"https://docs.apigee.com/api-platform/fundamentals/virtual-host-property-reference\">Virtual host property reference</a>.\n\nFor example, a subset of request body properties are valid only for specific Edge for Private Cloud versions, as follows:\n\n* `ciphers` and `protocols` properties are valid on Edge for Private Cloud version 4.15.07 and earlier\n* `properties` array is valid on Edge for Private Cloud version 4.17.01 and later\n* `baseUrl` property is valid on Edge for Private Cloud version 4.17.05 and later\n* `retryOptions` and `listenOptions` properties are valid on Edge for Private Cloud version 4.18.01 and later\n\n**Note**: As of Edge for Private Cloud version 4.16.01, you must create a host alias when you create a virtual host. Also, the combination of host alias name and port number for the virtual host must be unique for all virtual hosts in the Edge installation.\n\nFor a general introduction to creating virtual hosts, see <a href=\"https://docs.apigee.com/api-platform/fundamentals/virtual-hosts\">About virtual hosts</a>. For information about your specific version of Edge, see:\n* <a href=\"https://docs.apigee.com/api-platform/fundamentals/configuring-virtual-hosts-cloud\">Configuring virtual hosts for the Cloud</a>\n* <a href=\"https://docs.apigee.com/api-platform/fundamentals/configuring-virtual-hosts-private-cloud\">Configuring virtual hosts for the Private Cloud</a>\n\nFor complete information on setting all virtual host values, see <a href=\"https://docs.apigee.com/api-platform/fundamentals/virtual-host-property-reference\">Virtual host property reference</a>.","operationId":"updateVirtualHost","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/env_name"},{"$ref":"#/components/parameters/virtualhost_name"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VirtualHost"}}}},"400":{"description":"Bad request"}},"requestBody":{"description":"Virtual host information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VirtualHost"}},"application/xml":{"schema":{"$ref":"#/components/schemas/VirtualHost"}}}}},"delete":{"tags":["Virtual Host"],"summary":"Delete a virtual host","description":"Deletes a virtual host.\n\nBefore you can delete a virtual host from an environment, you must update any API proxies that reference the virtual host to remove the reference. See <a href=\"https://docs.apigee.com/api-platform/fundamentals/virtual-hosts\">About virtual hosts</a> for more.","operationId":"deleteVirtualHost","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/env_name"},{"$ref":"#/components/parameters/virtualhost_name"}],"responses":{"200":{"description":"OK"},"400":{"description":"Bad request"}}}}},"components":{"securitySchemes":{"Basic":{"type":"http","scheme":"basic"},"OAuth":{"type":"apiKey","name":"Authorization","in":"header","description":"For OAuth, enter the following in the Key field: Bearer %your-token% To get a token, see https://docs.apigee.com/api-platform/system-administration/using-oauth2#get-the-tokens"}},"parameters":{"org_name":{"in":"path","name":"org_name","required":true,"schema":{"type":"string"},"description":"Organization name."},"env_name":{"in":"path","name":"env_name","required":true,"schema":{"type":"string"},"description":"Environment name."},"virtualhost_name":{"in":"path","name":"virtualhost_name","required":true,"schema":{"type":"string"},"description":"Virtual host name."}},"schemas":{"VirtualHost":{"type":"object","description":"Virtual host details. See also <a href=\"https://docs.apigee.com/api-platform/fundamentals/virtual-host-property-reference\">Virtual host property reference</a>.","properties":{"hostAliases":{"type":"array","description":"List of host aliases. \n\nA host alias provides the publicly visible DNS name of the virtual host on the Router and optionally includes the port number. The combination of host alias name and port number for the virtual host must be unique for all virtual hosts in the Edge installation. That means multiple virtual hosts can use the same port number if they have different host aliases.\n\nYou must create a DNS entry and CNAME record that matches the host alias, and the host alias must match the string that the client passes in the `Host` header. \n\nThe port number in `HostAliases` is optional. If you specify the port as part of the host alias, you must also specify the same port by using the `Port` element. Or, you can specify two `HostAliases` elements, one with the port number and one without. \n\nYou can have multiple `HostAlias` definitions in the same virtual host definition, corresponding to multiple DNS entries for the virtual host, but not for multiple ports. If you want multiple ports, create multiple virtual host definitions with different ports. \n\nYou can include the `*` wildcard character in the host alias. The `*` wildcard character can only be at the start (preceding the first `.`) of the host alias, and cannot be mixed with other characters. For example `*.example.com`. The TLS cert for the virtual host must have a matching wildcard in the CN name of the cert. For example, `*.example.com`. Using a wildcard in a virtual host alias lets API proxies handle calls addressed to multiple subdomains such as `alpha.example.com`, `beta.example.com`, or `live.example.com`. Using a wildcard alias also helps you use fewer virtual hosts per environment to stay within product limits, since a virtual host with a wild card counts as only one virtual host.\n\n**For Cloud**: If you have an existing virtual host that uses a port other than `443`, you cannot add or remove a host alias. \n\n**For Private Cloud**: If you are setting the host alias by using the IP addresses of your Routers, and not DNS entries, add a separate host alias for each Router, specifying the IP address of each Router and port of the virtual host.","items":{"type":"string"}},"interfaces":{"type":"array","description":"**Edge for Private Cloud only.** \n\nList of network interfaces that you want the `port` to be bound to. If you omit this element, the `port` is bound on all interfaces.","items":{"type":"string"}},"listenOptions":{"type":"array","description":"**Private Cloud 4.18.01 and later and for Edge Cloud by contacting <a href=\"https://cloud.google.com/apigee/support\">Apigee Support</a>.**\n\n If you use an ELB in TCP pass-thru mode to handle requests to the Edge Routers, the Router treats the IP address of the ELB as the client IP instead of the actual client IP. If the Router requires the true client IP, enable `proxy_protocol` on the ELB so that it passes the client IP in the TCP packet. On the Router, you must also set the `listenOption` on the virtual host to `proxy_protocol`. Because the ELB is in TCP pass-thru mode, you typically terminate TLS on the Router. Therefore, you usually only configure the virtual host to use proxy_protocol when you also configure it to use TLS.\n \n \n The default value for `listenOptions` is an empty string. To later unset `listenOptions`, update the virtual host and omit the `listenOptions` property from the payload.","items":{"type":"string"}},"name":{"type":"string","description":"Virtual host name. Valid values include: `A-Z0-9._\\-$%`"},"port":{"type":"string","description":"Port number used by the virtual host. Ensure that the port is open on the Edge Router.\n\nIf you specify a port in a `hostAliases` element, then the port number specified by `port` must match it.\n\n**For Cloud**: You must specify port `443` when creating a virtual host. If omitted, by default the port is set to `443`. If you have an existing virtual host that uses a port other than `443`, you cannot change the port.\n\n**For Private Cloud releases 4.16.01 through 4.17.05**: When creating a virtual host, you specify the Router port used by the virtual host. For example, port `9001`. By default, the Router runs as the user `apigee` which does not have access to privileged ports, typically ports `1024` and below. If you want to create a virtual host that binds the Router to a protected port then you have to configure the Router to run as a user with access to those ports. See <a href=\"https://docs.apigee.com/private-cloud/latest/setting-virtual-host\">Setting up a virtual host</a> for more.\n\n**For Private Cloud releases prior to 4.16.01**: A Router can listen to only one HTTPS connection per virtual host, on a specific port, with the specified cert. Therefore, multiple virtual hosts cannot use the same port number if TLS termination occurs on the Router at the specified port."},"baseUrl":{"type":"string","description":"Base URL that overrides the URL displayed by the Edge UI for an API proxy deployed to the virtual host. Useful when you have an external load balancer in front of the Edge Routers. See <a href=\"https://docs.apigee.com/api-platform/system-administration/creating-virtual-host\">Configuring TLS access to an API for the Private Cloud</a> for more.\n\nThe value of BaseUrl must include the protocol (that is, `http://` or `https://`)."},"oCSPStapling":{"type":"string","description":"Flag that specifies whether the OCSP (Online Certificate Status Protocol) client is enabled. The OSCP sends a status request to an OCSP responder to determine if the TLS certificate is valid. The response indicates if the TLS certificate is valid and not revoked.\n\nWhen enabled, OCSP stapling allows Edge, acting as the TLS server for one-way TLS, to query the OCSP responder directly and then cache the response. Edge then returns this response to the TLS client, or staples it, as part of TLS handshaking. See <a href=\"https://www.digicert.com/enabling-ocsp-stapling.htm\">Enable OCSP Stapling on Your Server</a> for more.\n\n\n TLS must be enabled to enable OCSP stapling. Set to `on` to enable. Defaults to `off`."},"retryOptions":{"type":"array","description":"**Edge for Public Cloud and Edge for Private Cloud 4.18.01 and later**.\nConfiguration that determines how the Router reacts for this virtual host when the Message Processor goes down.\n \n \nYou can specify multiple values. Valid values include:\n \n \n* `off`: Disables retry and the virtual host returns a failure code upon a request.\n \n* `http_599`(Default): If the Router receives an `HTTP 599` response from the Message Processor, the Router forwards the request to the next Message Processor. `HTTP 599` is a special response code that is generated by a Message Processor when it is being shut down. The Message Processor tries to complete all existing requests, but for any new requests it responds with `HTTP 599` to signal to the Router to retry the request on the next Message Processor.\n \n* `error`: If an error occurred while establishing a connection with the Message Processor, passing a request to it, or reading the response header from it, the Router forwards the request to the next Message Processor.\n \n* `timeout`: If a timeout occurs while establishing a connection with the Message Processor, passing a request to it, or reading the response header from it, the Router forwards the request to the next Message Processor.\n \n* `invalid_header`: If the Message Processor returned an empty or invalid response, the Router forwards the request to the next Message Processor.\n \n* `http_XXX`: If the Message Processor returned a response with HTTP code `XXX`, the Router forwards the request to the next Message Processor.\n \n \nIf you specify multiple values, the Router uses a logical OR to combine them.","items":{"type":"string"}},"sSLInfo":{"type":"object","description":"SSL information.","items":{"$ref":"#/components/schemas/SSLInfo"}},"useBuiltInFreeTrailCert":{"type":"string","description":"**Edge for Public Cloud only.**\n\nFlag that specifies whether to use the Apigee freetrial cert and key. If you have a paid Edge for Cloud account and do not yet have a TLS cert and key, you can create a virtual host that uses the Apigee freetrial cert and key. That means you can create the virtual host without first creating a keystore.\n\nThe Apigee freetrial cert is defined for a domain of `*.apigee.net`. Therefore, the `HostAlias` of the virtual host must also be in the form `*.apigee.net`.\n\nSee <a href=\"https://docs.apigee.com/api-platform/fundamentals/configuring-virtual-hosts-cloud#creatingavirtualhost\">Defining a virtual host that uses the Apigee freetrial cert and key</a>."},"propagateTLSInformation":{"type":"object","description":"**Edge for Public Cloud only (Alpha).**","properties":{"ConnectionProperties":{"type":"string","description":"Flag that specifies whether to enable the capture of TLS connection information by Edge. This information will be made available as flow variables in an API proxy. See <a href=\"https://docs.apigee.com/api-platform/system-administration/tls-vars\">Accessing TLS connection information in an API proxy</a> for more."},"ClientProperties":{"type":"string","description":"Flag that specifies whether to enable the capture of client cert details captured by Edge in two-way TLS. This information will be made available as flow variables in an API proxy. See <a href=\"https://docs.apigee.com/api-platform/system-administration/tls-vars\">Accessing TLS connection information in an API proxy</a> for more."}}},"properties":{"type":"object","description":"**Edge Cloud and for Private Cloud 4.17.01 and later.** \nList of properties.","properties":{"Property":{"type":"array","description":"Property name and value. For a list of valid properties, see <a href=\"https://docs.apigee.com/api-platform/fundamentals/virtual-host-property-reference#virtualhostconfigurationproperties\">Virtual host configuration properties</a>.","items":{"type":"object","properties":{"_name":{"type":"string","description":"Property name."},"__text":{"type":"string","description":"Property value."}}}}}}}},"SSLInfo":{"type":"object","description":"SSL information.","properties":{"ciphers":{"type":"array","description":"**Edge for Private Cloud version 4.15.07 and earlier only.**\n\nSpecifies the ciphers supported by the virtual host. If no ciphers are specified, then all ciphers available for the JVM will be permitted.\n\nTo restrict ciphers, add the following elements: `TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA` and `TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256`","items":{"type":"string"}},"clientAuthEnabled":{"type":"string","description":"Flag that specifies whether to enable two-way, or client, TLS between Edge (server) and the app (client) making the request. Enabling two-way TLS requires that you set up a truststore on Edge that contains the cert from the TLS client."},"enabled":{"type":"string","description":"Flag that specifies whether to enable one-way TLS/SSL. You must have defined a keystore containing the cert and private key.\n\n**For Edge for Public Cloud**:\n\n* You must have a cert signed by a trusted entity, such as Symantec or VeriSign. You cannot use a self-signed cert, or leaf certificates signed by a self-signed CA.\n* If your existing virtual host is configured to use a port other than `443`, you cannot change the TLS setting. That means you cannot change the TLS setting from enabled to disabled, or from disabled to enabled."},"ignoreValidationErrors":{"type":"string","description":"Flag that specifies whether to ignore TLS certificate errors. This is similar to the `-k` option to curl.\n\nThis option is valid when configuring TLS for Target Servers and Target Endpoints, and when configuring virtual hosts that use 2-way TLS.\n\nWhen used with a target endpoint/target server, if the backend system uses SNI and returns a cert with a subject Distinguished Name (DN) that does not match the hostname, there is no way to ignore the error and the connection fails."},"keyAlias":{"type":"string","description":"Alias specified when you uploaded the cert and private key to the keystore. You must specify the alias name literally; you cannot use a reference. See <a href=\"https://docs.apigee.com/api-platform/system-administration/options-configuring-tls\">Options for configuring TLS</a> for more."},"keyStore":{"type":"string","description":"Name of the keystore on Edge. Apigee recommends that you use a reference to specify the keystore name so that you can change the keystore without having to restart Routers. See <a href=\"https://docs.apigee.com/api-platform/system-administration/options-configuring-tls\">Options for configuring TLS</a> for more."},"protocols":{"type":"array","description":"**Edge for Private Cloud version 4.15.07 and earlier only.**\n\nSpecifies the protocols supported by the virtual host. If no protocols are specified, then all protocols available for the JVM will be permitted.\n\nTo restrict protocols, add the following elements: `TLSv1`, `TLSv1.2`, and `SSLv2Hello`","items":{"type":"string"}},"trustStore":{"type":"string","description":"Name of the truststore on Edge that contains the certificate or certificate chain used for two-way TLS. Required if `clientAuthEnabled` is `true`.\n\nApigee recommends that you use a reference to specify the truststore name so that you can change the truststore without having to restart Routers. See <a href=\"https://docs.apigee.com/api-platform/system-administration/options-configuring-tls\">Options for configuring TLS</a> for more."}}}}}}
/ organizations / {org_name} / environments / {env_name} / virtualhosts / {virtualhost_name} / sslinfo
/ organizations / {org_name} / environments / {env_name} / virtualhosts
/ organizations / {org_name} / environments / {env_name} / virtualhosts / {virtualhost_name}
Stats API OpenAPI	{"openapi":"3.0.0","servers":[{"url":"https://api.enterprise.apigee.com/v1"}],"info":{"title":"Stats API","description":"Access metrics collected by Apigee Edge that measure API consumption and performance that are used to build Analytics reports.","version":"1.0"},"security":[{"Basic":[]},{"OAuth":[]}],"paths":{"/organizations/{org_name}/environments/{env_name}/stats/{dimension_name}":{"get":{"tags":["Analytics"],"summary":"Get metrics organized by dimensions","description":"Gets metrics, groups them by dimensions, and filters the results. If you are using <a href=\"https://docs.apigee.com/api-platform/microgateway/edge-microgateway-home\">Edge Microgateway</a> with the analytics plugin enabled (default), API calls to Edge Microgateway are included in results.\n\nFor examples using this API, see <a href=\"https://docs.apigee.com/analytics-services/reference/analytics-command-reference\">Analytics command reference</a>.\n\n**Notes:** \n* **Data delay interval**: After API calls are made to API proxies, it may take up to 10 minutes for the data to appear in dashboards, custom reports, and management API calls.\n* You can use the `_optimized=js` query parameter to optimize the JSON in the response so that it is less verbose, as described in this <a href=\"https://community.apigee.com/articles/2621/querying-analytics-apis-in-apigee-edge.html\">community article</a>. However, the `_optimized` query parameter has not been fully tested and its performance cannot be guaranteed.\n\n**Metrics**\n\nThe types of metrics you can retrieve (specifid by the `select` query parameter) include traffic, message counts, API call latency, response size, and cache hits and counts. See <a href=\"https://docs.apigee.com/api-platform/analytics/analytics-reference#metrics\">Metrics</a> for more information and for a list of functions (`sum, avg, min, max`) supported by each metric.\n\nFor example, to get the average request size for your APIs, set the select query param as: `select=avg(request_size)`\n\n**Note**: If you want to use the `app_count`, `developer_count`, or `user_count` metric, you cannot set an aggregation function.\n\n**Dimensions**: \n\nDimensions let you view metrics in meaningful groups. For example, instead of looking at total API traffic in your organization, you can see API traffic for each API proxy, for each app, for each developer, and more.\n\nFor each dimension, you construct a request by adding the desired dimension in the URL after /stats. For example, to group metrics by API proxies, you'd use: `/stats/apiproxy`\n\nYou can specify multiple dimensions to the API, separated by commas. To group metrics by API proxy and target response code combinations, you'd comma-separate dimensions in the URL: `/stats/apiproxy,target_response_code`\n\nFor a description of all supported dimensions, see <a href=\"https://docs.apigee.com/api-platform/analytics/analytics-reference#dimensions\">Dimensions</a>. You can also include your own custom dimensions, as described in <a href=\"https://docs.apigee.com/analytics-services/content/analyze-api-message-content-using-custom-analytics\">Analyze API message content using custom analytics</a>.\n\nHere's an example that shows how to get the average response time (metric) for all API proxies (dimension) in an environment: `/stats/apiproxy?select=avg(total_response_time)`\n\n**Filters**\n\nYou can also apply filters to limit the data that's returned. For example, if you're getting message counts grouped by API proxies, you can add a filter that returns only metrics for API proxies that return 4xx or 5xx status codes. Use any available dimensions or metrics to build your filters.\n\nFor more information on filters and the operators you can use, see <a href=\"https://docs.apigee.com/api-platform/analytics/analytics-reference#filters\">filters</a>.\n\n**Metrics API quotas**\n\nApigee Edge enforces a quota on the API calls. The quota is based on the backend system that handles the call:\n\n\n* Postgres: limited to 40 calls per minute.\n* BigQuery: limited to 12 calls per minute.\n\nIf you exceed the call quota, this API returns an HTTP 429 response.\n\nDetermine the backend system that handles the call by examining the response object. Every response object contains a metaData property that lists service that handled the call in the Source property. For example, for Postgres:\n```\n{\n ...\n \"metaData\": {\n \"errors\": [],\n \"notices\": [\n \"Source:Postgres\",\n \"Table used: xxxxxx.yyyyy\",\n \"query served by:111-222-333\"\n ]\n }\n}\n``` \n\nFor BigQuery, the Source property is: `\"Source:Big Query\"`","operationId":"getMetricsByDimension","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/env_name"},{"$ref":"#/components/parameters/dimension_name"},{"$ref":"#/components/parameters/select"},{"$ref":"#/components/parameters/timeRange"},{"$ref":"#/components/parameters/timeUnit"},{"$ref":"#/components/parameters/sortby"},{"$ref":"#/components/parameters/sort"},{"$ref":"#/components/parameters/topk"},{"$ref":"#/components/parameters/filter"},{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/offset"},{"$ref":"#/components/parameters/tsAscending"},{"$ref":"#/components/parameters/tzo"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Metrics"}}}},"400":{"description":"Bad request"}}}},"/organizations/{org_name}/environments/{env_name}/stats":{"get":{"tags":["Analytics"],"summary":"Get metrics","description":"Get metrics per time interval for an organization and environment. If you are using <a href=\"https://docs.apigee.com/api-platform/microgateway/edge-microgateway-home\">Edge Microgateway</a> with the analytics plugin enabled (default), API calls to Edge Microgateway are included in the count.\n\n**If you have multiple organizations and environments**, make this API call for each one and add them to get the total number of calls per time interval for your API program.\n\nTo convert the JSON response to a CSV format for use in spreadsheets, use a tool like <a href=\"https://json-csv.com/\">https://json-csv.com/</a>\n\nFor more granular metrics, use the <a href=\"/docs/stats/1/routes/organizations/%7Borg_name%7D/environments/%7Benv_name%7D/stats/%7Bdimension_name%7D/get\">Get metrics organized by dimensions API</a>. For more information on the analytics management API, see <a href=\"https://docs.apigee.com/api-platform/analytics/use-analytics-api-measure-api-program-performance\">Use the metrics APIs</a>.\n\nYou can also try the <a href=\"https://github.com/DinoChiesa/ApigeeEdge-API-Traffic-Summarizer\">API Traffic Summarizer tool</a> to get and graph traffic data by API proxy over a specific time range.\n\n**Metrics**\n\nThe types of metrics you can retrieve (specifid by the `select` query parameter) include traffic, message counts, API call latency, response size, and cache hits and counts. See <a href=\"https://docs.apigee.com/api-platform/analytics/analytics-reference#metrics\">Metrics</a> for more information and for a list of functions (`sum, avg, min, max`) supported by each metric.\n\nFor example, to get the average request size for your APIs, set the select query param as: `select=avg(request_size)`\n\nTo get metrics for the sum of policy errors, transactions per second, and the average request size, set the select query param as: `select=sum(policy_error),tps,avg(request_size)`\n\n**Metrics API quotas**\n\nApigee Edge enforces a quota on the API calls. The quota is based on the backend system that handles the call:\n\n* Postgres: limited to 40 calls per minute.\n* BigQuery: limited to 12 calls per minute.\n\nIf you exceed the call quota, this API returns an HTTP 429 response.\n\nDetermine the backend system that handles the call by examining the response object. Every response object contains a metaData property that lists service that handled the call in the Source property. For example, for Postgres:\n```\n{\n ...\n \"metaData\": {\n \"errors\": [],\n \"notices\": [\n \"Source:Postgres\",\n \"Table used: xxxxxx.yyyyy\",\n \"query served by:111-222-333\"\n ]\n }\n}\n``` \n\nFor BigQuery, the Source property is: `\"Source:Big Query\"`","operationId":"getMetrics","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/env_name"},{"$ref":"#/components/parameters/select"},{"$ref":"#/components/parameters/timeRange"},{"$ref":"#/components/parameters/timeUnit"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Metrics"}}}},"400":{"description":"Bad request"}}}},"/organizations/{org_name}/stats/preferences/reports/dailysummaryreport":{"get":{"tags":["Analytics"],"summary":"Subscribe to or unsubscribe from Analytics Report","description":"Subscribe to (`optin=true`) or unsubscribe from (`optin=false`) daily analytics reports. You must be an organization administrator.\n\nOn success, this API returns an HTML-formatted response.\n\n**Note**: Summary reports are currently available only for environments named `prod` or `production`.\nFor more information, see <a href=\"https://docs.apigee.com/analytics-services/content/subscribe-daily-analytics-emails\">Subscribe to daily analytics emails</a>.","operationId":"subscribeUnsubscribeAnalyticsReport","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/optin"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"string"}}}},"400":{"description":"Bad request"}}}},"/organizations/{org_name}/stats/preferences/reports/dailysummaryreport/users":{"get":{"tags":["Analytics"],"summary":"Get List of Subscribed and Unsubscribed Users","description":"Gets a list of subscribed and unsubscribed users for the daily analytics report.\n\n**Notes**:\n* **Apigee Edge for Private Cloud only**. If you are using Apigee Edge for Public Cloud, contact Apigee Support for assistance.\n* **This API cannot be executed using the Try this API panel**.\n\nBy default, all organization administrators are automatically subscribed to receive daily analytics summary reports through email. \nA value of `\"optout\": 1` in the response corresponds to the user having opted out, meaning unsubscribed.","operationId":"getSubscribedUnsubscribedUsers","parameters":[{"$ref":"#/components/parameters/org_name"}],"responses":{"200":{"description":"OK"},"400":{"description":"Bad request"}}}}},"components":{"securitySchemes":{"Basic":{"type":"http","scheme":"basic","description":"Multi-factor authentication is not supported."},"OAuth":{"type":"apiKey","name":"Authorization","in":"header","description":"For OAuth, enter the following in the Key field: Bearer %your-token% (see https://docs.apigee.com/api-platform/system-administration/using-oauth2#get-the-tokens)"}},"parameters":{"org_name":{"in":"path","name":"org_name","required":true,"schema":{"type":"string"},"description":"Organization name."},"env_name":{"in":"path","name":"env_name","required":true,"schema":{"type":"string"},"description":"Environment name."},"dimension_name":{"in":"path","name":"dimension_name","required":true,"schema":{"type":"string"},"description":"Dimension name."},"select":{"in":"query","name":"select","required":true,"schema":{"type":"string"},"description":"Designates one or more metrics to be aggregated for the report. See <a href=\"https://docs.apigee.com/api-platform/analytics/analytics-reference#metrics\">Metrics</a> for more information and for a list of functions (`sum, avg, min, max`) supported by each metric.\nFollowing are examples of supported metrics and aggregate functions:\n\n* `sum(ax_cache_executed)`\n* `avg|min|max(ax_cache_l1_count)`\n* `sum(cache_hit)`\n* `sum(is_error)`\n* `sum(message_count)`\n* `sum(policy_error)`\n* `avg|min|max(request_processing_latency)`\n* `sum|avg|min|max(request_size)`\n* `avg|min|max(response_processing_latency)`\n* `sum|avg|min|max(response_size)`\n* `sum(target_error)`\n* `sum|avg|min|max(target_response_time)`\n* `sum|avg|min|max(total_response_time)`\n* `tps (Currently must use with another metric)`\n\nSeparate more than one metric with a comma. For example: `sum(message_count),tps`"},"timeRange":{"in":"query","name":"timeRange","required":true,"schema":{"type":"string"},"description":"UTC start and end time for the desired interval. The date format is `MM/DD/YYYY HH:MM`. For example, `03/01/2016 00:00~03/31/2016 23:59` returns data for the month of March 2016.\n\nIf you make a request using the Try this API panel, it automatically URL-encodes the space character before `HH:MM`. However, if you are entering the time range in a cur command from the command line, manually insert `%20` for the space character, in the form: `MM/DD/YYYY%20HH:MM~MM/DD/YYYY%20HH:MM`. (You can expand the Try this API panel to view the curl command.)\n\nBy default, the `timeRange` parameter specifies a UTC start and end time. To change the time zone from UTC to a different time zone, use the `tzo` parameter to set the offset, in minutes, from UTC to the desired time zone.\n\n**Notes**: \n\n* If you have high API traffic, report generation will be faster if you use smaller time ranges, such as 2 or 3 hours.\n* It takes at least 10 minutes after an API call for Edge analytics to register it.\n* Do not use 24:00 as the time because it wraps around to 00:00. Use 23:59 instead.\n* Data older than six months from the current date is not accessible by default. If you want to access data older than six months, contact <a href=\"https://cloud.google.com/apigee/support\">Apigee Support</a>.\n* If you set `timeUnit` to `second`, the `timeRange` cannot be longer than one hour."},"timeUnit":{"in":"query","name":"timeUnit","required":false,"schema":{"type":"string"},"description":"**When getting metrics per time interval**: Specify a value to return counts in time intervals. Valid values include `second`, `minute`, `hour`, `day`, or `week`. Leave blank to return the total number of API calls. The Epoch timestamp in milliseconds that is returned is the start time of each interval.\n\n**When getting metrics by dimension**: Set to `second`, `minute`, `hour`, `day`, `week`, `month`, `quarter`, `year`, `decade`, `century`, or `millennium`.\n\n**Note**: `second` is not supported for Edge for the Private Cloud."},"sortby":{"in":"query","name":"sortby","required":false,"schema":{"type":"string"},"description":"Sort results by a specific metric when two or more metrics are specified. For example, when you include the `metricssum(message_count),sum(is_error) `, use a `sortby` of `sum(message_count)` to sort the results by message count."},"sort":{"in":"query","name":"sort","required":false,"schema":{"type":"string"},"description":"Sort in ascending (`ASC`) or descending (`DESC`) order."},"topk":{"in":"query","name":"topk","required":false,"schema":{"type":"string"},"description":"Specify the `top k` results to return. For example, to return the top 5 results `topk=5`."},"filter":{"in":"query","name":"filter","required":false,"schema":{"type":"string"},"description":"Enable drill-down on specific dimension values. Don't add the word `filter`, and close value in parenthesis `()`. For example: `(response_status_code gt 500 and response_status_code lt 599)`. When using the Try this API panel, spaces are automatically encoded."},"limit":{"in":"query","name":"limit","required":false,"schema":{"type":"string"},"description":"Set the limit for the number of entries returned by the API. The default limit is 1000 entries. If you expect your query to return more than 1000 entries, then set the limit appropriately. Otherwise, your query returns a maximum of 1000 entries."},"offset":{"in":"query","name":"offset","required":false,"schema":{"type":"string"},"description":"Use with `limit` to enable pagination of results. For example, to display results 11-20, set limit to `10` and offset to `10`.\n\n**Note**: Edge ignores the offset parameter on queries that process raw fact data. For these \"fact\" queries, Edge uses Big Data (Apache Spark), which processes data using a parallel map-reduce technique. You can tell if the Spark query engine was used to process a query when you see something like the following in the response:\n\n `\"notices\" : [ \"query served by:d62441a4-0951-4b90-abd3-318e86c23cf6\", \"Spark engine used\" ]`"},"tsAscending":{"in":"query","name":"tsAscending","required":false,"schema":{"type":"string"},"description":"Flag that specifies the order in which to list timestamps. Set to `true` to list timestamps in ascending order. Recommend setting this value to `true` if you are using `sortby` with `sort=DESC`."},"tzo":{"in":"query","name":"tzo","required":false,"schema":{"type":"string"},"description":"By default, the `timeRange` parameter specifies a UTC start and end time. To change the time zone from UTC to a different time zone, use the `tzo` parameter to set the offset, in minutes, from UTC to the desired time zone. For example, to change the time zone to EST, set `tzo` to `-240`. For California, in the PST timezone, set the offset to `-480` minutes. For Bangalore, in the IST timezone, set the offset to `330` minutes."},"optin":{"in":"query","name":"optin","required":true,"schema":{"type":"string"},"description":"Flag that specifies whether to subscribe to (`true`) or unsubscribe from (`false) daily summary reports."}},"schemas":{"Metrics":{"description":"Metric details.","type":"object","properties":{"environments":{"type":"array","description":"Environment details.","items":{"type":"object","properties":{"dimensions":{"type":"array","description":"Dimension details.","items":{"type":"object","properties":{"metrics":{"type":"array","description":"List of metrics.","items":{"type":"object","properties":{"name":{"type":"string","description":"Metric details."},"values":{"type":"array","items":{"type":"object","properties":{"timestamp":{"type":"string","description":"Timestamp in millieseconds since epoch."},"value":{"type":"string","description":"Value of metric."}}}}}}},"name":{"type":"string","description":"Dimension name."}}}},"name":{"type":"string","description":"Environment name."}}}}}}}}}
/ organizations / {org_name} / environments / {env_name} / stats / {dimension_name}
/ organizations / {org_name} / environments / {env_name} / stats
/ organizations / {org_name} / stats / preferences / reports / dailysummaryreport
/ organizations / {org_name} / stats / preferences / reports / dailysummaryreport / users
Audits API OpenAPI	{"openapi":"3.0.0","servers":[{"url":"https://api.enterprise.apigee.com/v1"}],"info":{"title":"Audits API","description":"View audit logs that provide access to the actions (create, update, delete) executed on entities managed by Apigee Edge.","version":"1.0"},"security":[{"Basic":[]},{"OAuth":[]}],"paths":{"/audits/organizations/{org_name}":{"get":{"tags":["Audit"],"summary":"List audit entries for an organization","description":"Lists audit entries for management operations for an organization.\n\nFor API proxy revisions, deploy and undeploy actions are recorded as `CREATE` operations. You can distinguish between them by examining the requestUri element in the output.\n\nFor every call made to the API, Apigee Edge logs an audit record. This API enables you to obtain a record of all API calls made against entities in an organization. The audit logs provide access to the actions (create, read, update, delete) executed on organizations.\n\nIf there are no audit entries, this API returns an empty array.\n\nIf you omit the `timeline`, `startTime`, and `endTime` query parameters, the default is to use `timeline=today`.","operationId":"listAudits","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/expand"},{"$ref":"#/components/parameters/timeline"},{"$ref":"#/components/parameters/startTime"},{"$ref":"#/components/parameters/endTime"},{"$ref":"#/components/parameters/rows"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Audits"},"example":{"auditRecord":[{"operation":"UPDATE","request":"ahamilton@example.com","requestUri":"/v1/organizations/myorg/userroles/orgadmin/users","responseCode":200,"timeStamp":1602682379741,"user":"admin@example.com"},{"operation":"CREATE","request":"''myorg''","requestUri":"/v1/organizations/myorg/apiproducts/myproduct","responseCode":201,"timeStamp":1602682379741,"user":"admin@example.com"}]}}}},"400":{"description":"Bad request"}}}},"/audits/organizations/{org_name}/apiproducts":{"get":{"tags":["Audit"],"summary":"List audit entries for all API products in an organization","description":"Lists audit entries for management operations for all API products in an organization.\n\nFor every call made to the API, Apigee Edge logs an audit record. This API enables you to obtain a record of all API calls made against API products in an organization. The audit logs provide access to the actions (create, read, update, delete) executed on organizations.\n\nIf there are no audit entries, or if the entity does not exist, this API returns an empty array.\n\nIf you omit the `timeline`, `startTime`, and `endTime` query parameters, the default is to use `timeline=today`.","operationId":"listAuditsAPIProducts","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/expand"},{"$ref":"#/components/parameters/timeline"},{"$ref":"#/components/parameters/startTime"},{"$ref":"#/components/parameters/endTime"},{"$ref":"#/components/parameters/rows"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Audits"},"example":{"auditRecord":[{"operation":"CREATE","request":"''myorg''","requestUri":"/v1/organizations/myorg/apiproducts/myproduct","responseCode":201,"timeStamp":1602682379741,"user":"admin@example.com"}]}}}},"400":{"description":"Bad request"}}}},"/audits/organizations/{org_name}/apiproducts/{apiproduct_name}":{"get":{"tags":["Audit"],"summary":"List audit entries for an API product","description":"Lists audit entries for management operations for an API product in an organization.\n\nFor every call made to the API, Apigee Edge logs an audit record. This API enables you to obtain a record of all API calls made against the specified API product in an organization. The audit logs provide access to the actions (create, read, update, delete) executed on organizations.\n\nIf there are no audit entries, or if the entity does not exist, this API returns an empty array.\n\nIf you omit the `timeline`, `startTime`, and `endTime` query parameters, the default is to use `timeline=today`.","operationId":"listAuditsAPIProduct'","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/apiproduct_name"},{"$ref":"#/components/parameters/expand"},{"$ref":"#/components/parameters/timeline"},{"$ref":"#/components/parameters/startTime"},{"$ref":"#/components/parameters/endTime"},{"$ref":"#/components/parameters/rows"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Audits"},"example":{"auditRecord":[{"operation":"CREATE","request":"''myorg''","requestUri":"/v1/organizations/myorg/apiproducts/myproduct","responseCode":201,"timeStamp":1602682379741,"user":"admin@example.com"}]}}}},"400":{"description":"Bad request"}}}},"/audits/organizations/{org_name}/apis":{"get":{"tags":["Audit"],"summary":"List audit entries for all API proxies","description":"Lists audit entries for management operations for all API proxies in an organization.\n\nFor every call made to the API, Apigee Edge logs an audit record. This API enables you to obtain a record of all API calls made against API proxies in an organization. The audit logs provide access to the actions (create, read, update, delete) executed on organizations.\n\nIf there are no audit entries, or if the entity does not exist, this API returns an empty array.\n\nIf you omit the `timeline`, `startTime`, and `endTime` query parameters, the default is to use `timeline=today`.","operationId":"listAuditsAPIProxies","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/expand"},{"$ref":"#/components/parameters/timeline"},{"$ref":"#/components/parameters/startTime"},{"$ref":"#/components/parameters/endTime"},{"$ref":"#/components/parameters/rows"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Audits"},"example":{"auditRecord":[{"operation":"CREATE","request":"''myorg''","requestUri":"/v1/organizations/myorg/apis/myapi?action=import","responseCode":201,"timeStamp":1602682379741,"user":"admin@example.com"}]}}}},"400":{"description":"Bad request"}}}},"/audits/organizations/{org_name}/apis/{api_name}":{"get":{"tags":["Audit"],"summary":"List audit entries for an API proxy","description":"Lists audit entries for management operations for an API proxy in an organization\n\nFor API proxy revisions, deploy and undeploy actions are recorded as CREATE operations. You can distinguish between them by examining the requestUri element in the output.\n\nFor every call made to the API, Apigee Edge logs an audit record. This API enables you to obtain a record of all API calls made against the specified API proxy in an organization. The audit logs provide access to the actions (create, read, update, delete) executed on organizations.\n\nIf there are no audit entries, or if the entity does not exist, this API returns an empty array.\n\nIf you omit the `timeline`, `startTime`, and `endTime` query parameters, the default is to use `timeline=today`.","operationId":"listAuditsAPIProxy","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/api_name"},{"$ref":"#/components/parameters/expand"},{"$ref":"#/components/parameters/timeline"},{"$ref":"#/components/parameters/startTime"},{"$ref":"#/components/parameters/endTime"},{"$ref":"#/components/parameters/rows"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Audits"},"example":{"auditRecord":[{"operation":"CREATE","request":"''myorg''","requestUri":"/v1/organizations/myorg/apis/myapi?action=import","responseCode":201,"timeStamp":1602682379741,"user":"admin@example.com"}]}}}},"400":{"description":"Bad request"}}}},"/audits/organizations/{org_name}/developers":{"get":{"tags":["Audit"],"summary":"List audit entries for all developers in an organization","description":"Lists audit entries for management operations for all developers in an organization.\n\nFor every call made to the API, Apigee Edge logs an audit record. This API enables you to obtain a record of all API calls made against developers in an organization. The audit logs provide access to the actions (create, read, update, delete) executed on organizations.\n\nIf there are no audit entries, or if the entity does not exist, this API returns an empty array.\n\nIf you omit the `timeline`, `startTime`, and `endTime` query parameters, the default is to use `timeline=today`.","operationId":"listAuditsDevelopers","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/expand"},{"$ref":"#/components/parameters/timeline"},{"$ref":"#/components/parameters/startTime"},{"$ref":"#/components/parameters/endTime"},{"$ref":"#/components/parameters/rows"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Audits"},"example":{"auditRecord":[{"operation":"CREATE","request":"''r7zxB0C8n0OJdoUdbT0u6hD1eKOvC5m8''","requestUri":"/v1/organizations/myorg/developers/ahamilton@example.com/apps/myapp/keys/r7zxB0C8n0OJdoUdbT0u6hD1eKOvC5m8?action=approve","responseCode":"204","timeStamp":1601665880689,"user":"admin@example.com"}]}}}},"400":{"description":"Bad request"}}}},"/audits/organizations/{org_name}/developers/{developer_email}":{"get":{"tags":["Audit"],"summary":"List audit entries for a developer","description":"Lists audit entries for management operations for a developer in an organization.\n\nFor every call made to the API, Apigee Edge logs an audit record. This API enables you to obtain a record of all API calls made against the specified developer in an organization. The audit logs provide access to the actions (create, read, update, delete) executed on organizations.\n\nIf there are no audit entries, or if the entity does not exist, this API returns an empty array.\n\nIf you omit the `timeline`, `startTime`, and `endTime` query parameters, the default is to use `timeline=today`.","operationId":"listAuditsDeveloper","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/developer_email"},{"$ref":"#/components/parameters/expand"},{"$ref":"#/components/parameters/timeline"},{"$ref":"#/components/parameters/startTime"},{"$ref":"#/components/parameters/endTime"},{"$ref":"#/components/parameters/rows"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Audits"},"example":{"auditRecord":[{"operation":"CREATE","request":"''r7zxB0C8n0OJdoUdbT0u6hD1eKOvC5m8''","requestUri":"/v1/organizations/myorg/developers/ahamilton@example.com/apps/testapp/keys/r7zxB0C8n0OJdoUdbT0u6hD1eKOvC5m8?action=approve","responseCode":"204","timeStamp":1601665880689,"user":"admin@example.com"}]}}}},"400":{"description":"Bad request"}}}},"/audits/organizations/{org_name}/developers/{developer_email}/apps":{"get":{"tags":["Audit"],"summary":"List audit entries for all developer apps","description":"Lists audit entries for management operations for all developer apps in an organization.\n\nFor every call made to the API, Apigee Edge logs an audit record. This API enables you to obtain a record of all API calls made against developer apps in an organization. The audit logs provide access to the actions (create, read, update, delete) executed on organizations.\n\nIf there are no audit entries, or if the entity does not exist, this API returns an empty array.\n\nIf you omit the `timeline`, `startTime`, and `endTime` query parameters, the default is to use `timeline=today`.","operationId":"listAuditsDeveloperApps","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/developer_email"},{"$ref":"#/components/parameters/expand"},{"$ref":"#/components/parameters/timeline"},{"$ref":"#/components/parameters/startTime"},{"$ref":"#/components/parameters/endTime"},{"$ref":"#/components/parameters/rows"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Audits"},"example":{"auditRecord":[{"operation":"UPDATE","request":"''r7zxB0C8n0OJdoUdbT0u6hD1eKOvC5m8''","requestUri":"/v1/organizations/docs/developers/4707ceee-4cc7-47c9-a180-f4932bd7f2c2/apps/myapp/keys/uconqa19Mi1TAJlCKGHAP3kmpht4nKPr","responseCode":200,"timeStamp":1602682379741,"user":"admin@example.com"}]}}}},"400":{"description":"Bad request"}}}},"/audits/organizations/{org_name}/developers/{developer_email}/apps/{app_name}":{"get":{"tags":["Audit"],"summary":"List audit entries for a developer app","description":"Lists audit entries for management operations for an app in an organization.\n\nFor every call made to the API, Apigee Edge logs an audit record. This API enables you to obtain a record of all API calls made against the specified app in an organization. The audit logs provide access to the actions (create, read, update, delete) executed on organizations.\n\nIf there are no audit entries, or if the entity does not exist, this API returns an empty array.\n\nIf you omit the `timeline`, `startTime`, and `endTime` query parameters, the default is to use `timeline=today`.","operationId":"listAuditsDeveloperApp","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/developer_email"},{"$ref":"#/components/parameters/app_name"},{"$ref":"#/components/parameters/expand"},{"$ref":"#/components/parameters/timeline"},{"$ref":"#/components/parameters/startTime"},{"$ref":"#/components/parameters/endTime"},{"$ref":"#/components/parameters/rows"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Audits"},"example":{"auditRecord":[{"operation":"UPDATE","request":"''r7zxB0C8n0OJdoUdbT0u6hD1eKOvC5m8''","requestUri":"/v1/organizations/docs/developers/4707ceee-4cc7-47c9-a180-f4932bd7f2c2/apps/myapp/keys/uconqa19Mi1TAJlCKGHAP3kmpht4nKPr","responseCode":200,"timeStamp":1602682379741,"user":"admin@example.com"}]}}}},"400":{"description":"Bad request"}}}},"/audits/organizations/{org_name}/sharedflows":{"get":{"tags":["Audit"],"summary":"List audit entries for all shared flows","description":"Lists audit entries for management operations for all shared flows in an organization.\n\nFor every call made to the API, Apigee Edge logs an audit record. This API enables you to obtain a record of all API calls made against shared flows in an organization. The audit logs provide access to the actions (create, read, update, delete) executed on organizations.\n\nIf there are no audit entries, or if the entity does not exist, this API returns an empty array.\n\nIf you omit the `timeline`, `startTime`, and `endTime` query parameters, the default is to use `timeline=today`.\n\nFor more about shared flows, see <a href=\"https://docs.apigee.com/api-platform/fundamentals/shared-flows\">Reusable shared flows</a>. For information about listing audit entires for a specific shared flow, see <a href=\"https://docs-edgeapis.apigee.io/docs/audits/1/routes/audits/organizations/%7Borg_name%7D/sharedflows/%7Bsharedflow_name%7D/get\">List audit entries for a shared flow</a>.","operationId":"listAuditsDeveloperApps","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/expand"},{"$ref":"#/components/parameters/timeline"},{"$ref":"#/components/parameters/startTime"},{"$ref":"#/components/parameters/endTime"},{"$ref":"#/components/parameters/rows"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Audits"},"example":{"auditRecord":[{"operation":"UPDATE","request":"''r7zxB0C8n0OJdoUdbT0u6hD1eKOvC5m8''","requestUri":"/v1/organizations/docs/developers/4707ceee-4cc7-47c9-a180-f4932bd7f2c2/apps/myapp/keys/uconqa19Mi1TAJlCKGHAP3kmpht4nKPr","responseCode":200,"timeStamp":1602682379741,"user":"admin@example.com"}]}}}},"400":{"description":"Bad request"}}}},"/audits/organizations/{org_name}/sharedflows/{sharedflow_name}":{"get":{"tags":["Audit"],"summary":"List audit entries for a shared flow","description":"Lists audit entries for management operations for a shared flow in an organization.\n\nFor every call made to the API, Apigee Edge logs an audit record. This API enables you to obtain a record of all API calls made against the specified app in an organization. The audit logs provide access to the actions (create, read, update, delete) executed on organizations.\n\nIf there are no audit entries, or if the entity does not exist, this API returns an empty array.\n\nIf you omit the `timeline`, `startTime`, and `endTime` query parameters, the default is to use `timeline=today`.\n\nFor more about shared flows, see <a href=\"https://docs.apigee.com/api-platform/fundamentals/shared-flows\">Reusable shared flows</a>.","operationId":"listAuditsDeveloperApp","parameters":[{"$ref":"#/components/parameters/org_name"},{"$ref":"#/components/parameters/sharedflow_name"},{"$ref":"#/components/parameters/expand"},{"$ref":"#/components/parameters/timeline"},{"$ref":"#/components/parameters/startTime"},{"$ref":"#/components/parameters/endTime"},{"$ref":"#/components/parameters/rows"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Audits"},"example":{"auditRecord":[{"operation":"UPDATE","request":"''r7zxB0C8n0OJdoUdbT0u6hD1eKOvC5m8''","requestUri":"/v1/organizations/docs/developers/4707ceee-4cc7-47c9-a180-f4932bd7f2c2/apps/myapp/keys/uconqa19Mi1TAJlCKGHAP3kmpht4nKPr","responseCode":200,"timeStamp":1602682379741,"user":"admin@example.com"}]}}}},"400":{"description":"Bad request"}}}},"/audits/users/{user_email}":{"get":{"tags":["Audit"],"summary":"List audit entries for a user","description":"Lists audit entries for management operations for a user.\n\nFor every call made to the API, Apigee Edge logs an audit record. This API enables you to obtain a record of all API calls made against the specified user. The audit logs provide access to the actions (create, read, update, delete) executed on the user.\n\nIf there are no audit entries, or if the entity does not exist, this API returns an empty array.\n\nIf you omit the `timeline`, `startTime`, and `endTime` query parameters, the default is to use `timeline=today`.\n\n**Notes**:\n* **Apigee Edge for Private Cloud only**. If you are using Apigee Edge for Public Cloud, contact <a href=\"https://cloud.google.com/apigee/support\">Apigee Support</a> for assistance.\n* **This API cannot be executed using the Try this API panel**.","operationId":"ListAuditsUser","parameters":[{"$ref":"#/components/parameters/user_email"},{"$ref":"#/components/parameters/expand"},{"$ref":"#/components/parameters/timeline"},{"$ref":"#/components/parameters/startTime"},{"$ref":"#/components/parameters/endTime"},{"$ref":"#/components/parameters/rows"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Audits"},"example":{"auditRecord":[{"operation":"UPDATE","request":"ahamilton@example.com","requestUri":"/v1/organizations/docs/userroles/orgadmin/users","responseCode":200,"timeStamp":1602682379741,"user":"admin@example.com"}]}}}},"400":{"description":"Bad request"}}}}},"components":{"securitySchemes":{"Basic":{"type":"http","scheme":"basic","description":"Multi-factor authentication is not supported."},"OAuth":{"type":"apiKey","name":"Authorization","in":"header","description":"For OAuth, enter the following in the Key field: Bearer %your-token%"}},"parameters":{"org_name":{"in":"path","name":"org_name","required":true,"schema":{"type":"string"},"description":"Organization name."},"apiproduct_name":{"in":"path","name":"apiproduct_name","required":true,"schema":{"type":"string"},"description":"API product name."},"api_name":{"in":"path","name":"api_name","required":true,"schema":{"type":"string"},"description":"API proxy name."},"developer_email":{"in":"path","name":"developer_email","required":true,"schema":{"type":"string"},"description":"Email address of developer."},"app_name":{"in":"path","name":"app_name","required":true,"schema":{"type":"string"},"description":"App name."},"user_email":{"in":"path","name":"user_email","required":true,"schema":{"type":"string"},"description":"Email address of user."},"sharedflow_name":{"in":"path","name":"sharedflow_name","required":true,"schema":{"type":"string"},"description":"Shared flow name."},"expand":{"in":"query","name":"expand","required":false,"schema":{"type":"string"},"description":"Flag that specifies whether or not to expand the audit entry. Set to `true` to expand the audit entry. Defaults to `true`."},"timeline":{"in":"query","name":"timeline","required":false,"schema":{"type":"string"},"description":"Filters results by the specified time interval. Valid values are `today`, `week`, or `month`. If you specify `timeline`, don't specify `startTime` or `endTime`. If you omit the `timeline`, `startTime`, and `endTime` query parameters, the default is `timeline=today`."},"startTime":{"in":"query","name":"startTime","required":false,"schema":{"type":"string"},"description":"End date/time from up to which audit entries should be returned in milliseconds since epoch. (Add \"000\" to the end of normal epoch time to get milliseconds.) Specify `startTime` by itself or with `endTime` to specify a range. Don't specify with `timeline`."},"endTime":{"in":"query","name":"endTime","required":false,"schema":{"type":"string"},"description":"Start date/time from which audit entries should be returned in milliseconds since epoch. (Add \"000\" to the end of normal epoch time to get milliseconds.) Specify `endTime` by itself or with `startTime` to specify a range. Don't specify with `timeline`."},"rows":{"in":"query","name":"rows","required":false,"schema":{"type":"string"},"description":"Limit on the total number of audit entries to be returned when you specify either `startTime` or `endTime`."}},"schemas":{"Audits":{"type":"array","description":"Audit entries.","items":{"$ref":"#/components/schemas/Audit"}},"Audit":{"description":"Audit entry details.","type":"object","properties":{"operation":{"description":"Operation performed, such as `CREATE`, `UPDATE`, or `DELETE`.","type":"string"},"request":{"description":"Request entity.","type":"string"},"requestUri":{"type":"string","description":"URL of the request."},"responseCode":{"description":"Status code of the response, such as `200`.","type":"string"},"timestamp":{"description":"Timestamp for the log in seconds since epoch.","type":"string"},"user":{"description":"Email address of user assoicated with the log.","type":"string"}}}}}}
/ audits / organizations / {org_name}
/ audits / organizations / {org_name} / apiproducts
/ audits / organizations / {org_name} / apiproducts / {apiproduct_name}
/ audits / organizations / {org_name} / apis
/ audits / organizations / {org_name} / apis / {api_name}
/ audits / organizations / {org_name} / developers
/ audits / organizations / {org_name} / developers / {developer_email}
/ audits / organizations / {org_name} / developers / {developer_email} / apps
/ audits / organizations / {org_name} / developers / {developer_email} / apps / {app_name}
/ audits / organizations / {org_name} / sharedflows
/ audits / organizations / {org_name} / sharedflows / {sharedflow_name}
/ audits / users / {user_email}
No API Resources

(Product) (Docs)

---

{"class":["gateway"],"properties":{"name":"Apigee X","provider":"Google Cloud","slug":"apigee-x","rating":1,"license":"Proprietary","status":"Pending Review","researchDate":"2021-10","description":"The Apigee X platform is a newer release than the [Apigee Edge](../apigee-edge/) platform. It is a SaaS-only delivery with a few different policy options than what's provided by Apigee Edge.\n","platformCapabilities":["Design","Gateway","Analytics","Monetization","Monitoring","Portal","Threat Protection"],"gatewayCapabilities":["Custom Code Execution","Protocol Transformation","Versioning","Traffic Management","Mediation","OpenAPI Integration"],"customCodeSupport":["Java","JavaScript","Node.js","Python"],"upstreamProtocols":["HTTP/1.1","GraphQL"],"downstreamProtocols":["HTTP/1.1","gRPC","GraphQL"],"deliveryModels":["SaaS"],"policies":[{"category":"Traffic Management","capabilities":["Cache Lookup","Cache Invalidation","Cache Population","Cache Target Response","Quota","Quota Reset","Spike Arrest"]},{"category":"Mediation","capabilities":["Platform Data Lookup","Request Transformation","Response Transformation","CORS","Context Persistence","GraphQL","Custom Data Storage","JSON to XML","XML to JSON","SOAP Validation","OpenAPI Validation","Custom Exception Handling","XSL Tranformations","Monetization Limits"]},{"category":"Security","capabilities":["IP Access Rules","Basic Authentication","API Key","OAuth 2.0","OAuth 1.0","HMAC","JSON Threat Protection","XML Threat Protection","JWS","JWT","Message Inspection","SAML Assertion"]},{"category":"Extensions","capabilities":["Data Collection","HTTP Callout","gRPC Callout","Java","JavaScript","Python","Message Logging","Statistics Collection"]}]},"links":[{"rel":["urn:gateway:product"],"title":"Product","href":"https://cloud.google.com/apigee"},{"rel":["urn:gateway:docs"],"title":"Documentation","href":"https://cloud.google.com/apigee/docs/api-platform/get-started/what-apigee"},{"rel":["urn:gateway:logo"],"title":"Logo","href":"/images/gateways/apigee-x.svg"},{"rel":["urn:gateway:related"],"title":"Apigee Edge","href":"../apigee-edge"},{"rel":["urn:gateway:screenshot"],"title":"Screenshot","href":"https://kinlane-productions2.s3.amazonaws.com/api-gateways/apigee-x.png"}]}

Apigee X

The Apigee X platform is a newer release than the [Apigee Edge](../apigee-edge/) platform. It is a SaaS-only delivery with a few different policy options than what's provided by Apigee Edge.

Platform Capabilities

These are the wider capabilities beyond the gateway they offer.

• Design
• Gateway
• Analytics
• Monetization
• Monitoring
• Portal
• Threat Protection

Gateway Capabilities

These are the capabilities the gateway supports.

• Custom Code Execution
• Protocol Transformation
• Versioning
• Traffic Management
• Mediation
• OpenAPI Integration

Upstream Protocols

The different protocols they support upstream.

• HTTP/1.1
• GraphQL

Downtream Protocols

The different protocols they support downstream.

• HTTP/1.1
• gRPC
• GraphQL

Custom Code

If they offer plugin, extension, and custom coding options.

• Java
• JavaScript
• Node.js
• Python

Delivery Models

These are they ways you can deliver this solution.

• SaaS

Policies

These are the policies available across the gateway capabilities.

Traffic Management

• Cache Lookup
• Cache Invalidation
• Cache Population
• Cache Target Response
• Quota
• Quota Reset
• Spike Arrest

Mediation

• Platform Data Lookup
• Request Transformation
• Response Transformation
• CORS
• Context Persistence
• GraphQL
• Custom Data Storage
• JSON to XML
• XML to JSON
• SOAP Validation
• OpenAPI Validation
• Custom Exception Handling
• XSL Tranformations
• Monetization Limits

Security

• IP Access Rules
• Basic Authentication
• API Key
• OAuth 2.0
• OAuth 1.0
• HMAC
• JSON Threat Protection
• XML Threat Protection
• JWS
• JWT
• Message Inspection
• SAML Assertion

Extensions

• Data Collection
• HTTP Callout
• gRPC Callout
• Java
• JavaScript
• Python
• Message Logging
• Statistics Collection

API Resources

Apigee Registry API OpenAPI	{"openapi":"3.1.0","info":{"title":"Apigee Registry API","description":"","contact":{},"version":"v1"},"jsonSchemaDialect":"https://json-schema.org/draft/2020-12/schema","servers":[{"url":"https://apigeeregistry.googleapis.com/","variables":{}}],"paths":{"/v1/{resource}:getIamPolicy":{"get":{"tags":["artifacts"],"summary":"GetIamPolicyV1GetIamPolicyByResource","description":"Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.","operationId":"GetIamPolicyV1GetIamPolicyByResource","parameters":[{"name":"upload_protocol","in":"query","description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"quotaUser","in":"query","description":"Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"alt","in":"query","description":"Data format for response. (Acceptable values are: \"json\", \"media\", \"proto\")","style":"form","explode":true,"schema":{"type":"string","default":"json"}},{"name":"fields","in":"query","description":"Selector specifying which fields to include in a partial response.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"access_token","in":"query","description":"OAuth access token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"key","in":"query","description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"callback","in":"query","description":"JSONP","style":"form","explode":true,"schema":{"type":"string"}},{"name":"prettyPrint","in":"query","description":"Returns response with indentations and line breaks.","style":"form","explode":true,"schema":{"type":"boolean","default":true}},{"name":"uploadType","in":"query","description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"oauth_token","in":"query","description":"OAuth 2.0 token for the current user.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"$.xgafv","in":"query","description":"V1 error format. (Acceptable values are: \"1\", \"2\")","style":"form","explode":true,"schema":{"type":"string","default":"1"}},{"name":"options.requestedPolicyVersion","in":"query","description":"Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).","style":"form","explode":true,"schema":{"type":"integer","contentEncoding":"int32"}},{"name":"resource","in":"path","description":"REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.","required":true,"style":"simple","schema":{"pattern":"^projects/[^/]+/locations/[^/]+/artifacts/[^/]+$","type":"string"}}],"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Policy"}}}}},"deprecated":false,"security":[{"httpBearer":["https://www.googleapis.com/auth/cloud-platform"]}]},"parameters":[]},"/v1/{name}":{"delete":{"tags":["artifacts"],"summary":"DeleteV1ByName","description":"Removes a specified artifact.","operationId":"DeleteV1ByName","parameters":[{"name":"upload_protocol","in":"query","description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"quotaUser","in":"query","description":"Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"alt","in":"query","description":"Data format for response. (Acceptable values are: \"json\", \"media\", \"proto\")","style":"form","explode":true,"schema":{"type":"string","default":"json"}},{"name":"fields","in":"query","description":"Selector specifying which fields to include in a partial response.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"access_token","in":"query","description":"OAuth access token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"key","in":"query","description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"callback","in":"query","description":"JSONP","style":"form","explode":true,"schema":{"type":"string"}},{"name":"prettyPrint","in":"query","description":"Returns response with indentations and line breaks.","style":"form","explode":true,"schema":{"type":"boolean","default":true}},{"name":"uploadType","in":"query","description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"oauth_token","in":"query","description":"OAuth 2.0 token for the current user.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"$.xgafv","in":"query","description":"V1 error format. (Acceptable values are: \"1\", \"2\")","style":"form","explode":true,"schema":{"type":"string","default":"1"}},{"name":"name","in":"path","description":"Required. The name of the artifact to delete. Format: `{parent}/artifacts/*`","required":true,"style":"simple","schema":{"pattern":"^projects/[^/]+/locations/[^/]+/artifacts/[^/]+$","type":"string"}}],"responses":{"200":{"description":"","headers":{},"content":{"text/plain":{"schema":{"type":"object","contentMediaType":"text/plain"}}}}},"deprecated":false,"security":[{"httpBearer":["https://www.googleapis.com/auth/cloud-platform"]}]},"put":{"tags":["artifacts"],"summary":"ReplaceArtifactV1ByName","description":"Used to replace a specified artifact.","operationId":"ReplaceArtifactV1ByName","parameters":[{"name":"upload_protocol","in":"query","description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"quotaUser","in":"query","description":"Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"alt","in":"query","description":"Data format for response. (Acceptable values are: \"json\", \"media\", \"proto\")","style":"form","explode":true,"schema":{"type":"string","default":"json"}},{"name":"fields","in":"query","description":"Selector specifying which fields to include in a partial response.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"access_token","in":"query","description":"OAuth access token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"key","in":"query","description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"callback","in":"query","description":"JSONP","style":"form","explode":true,"schema":{"type":"string"}},{"name":"prettyPrint","in":"query","description":"Returns response with indentations and line breaks.","style":"form","explode":true,"schema":{"type":"boolean","default":true}},{"name":"uploadType","in":"query","description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"oauth_token","in":"query","description":"OAuth 2.0 token for the current user.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"$.xgafv","in":"query","description":"V1 error format. (Acceptable values are: \"1\", \"2\")","style":"form","explode":true,"schema":{"type":"string","default":"1"}},{"name":"name","in":"path","description":"Resource name.","required":true,"style":"simple","schema":{"pattern":"^projects/[^/]+/locations/[^/]+/artifacts/[^/]+$","type":"string"}}],"requestBody":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Artifact"}}},"required":true},"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Artifact"}}}}},"deprecated":false,"security":[{"httpBearer":["https://www.googleapis.com/auth/cloud-platform"]}]},"get":{"tags":["artifacts"],"summary":"GetV1ByName","description":"Returns a specified artifact.","operationId":"GetV1ByName","parameters":[{"name":"upload_protocol","in":"query","description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"quotaUser","in":"query","description":"Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"alt","in":"query","description":"Data format for response. (Acceptable values are: \"json\", \"media\", \"proto\")","style":"form","explode":true,"schema":{"type":"string","default":"json"}},{"name":"fields","in":"query","description":"Selector specifying which fields to include in a partial response.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"access_token","in":"query","description":"OAuth access token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"key","in":"query","description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"callback","in":"query","description":"JSONP","style":"form","explode":true,"schema":{"type":"string"}},{"name":"prettyPrint","in":"query","description":"Returns response with indentations and line breaks.","style":"form","explode":true,"schema":{"type":"boolean","default":true}},{"name":"uploadType","in":"query","description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"oauth_token","in":"query","description":"OAuth 2.0 token for the current user.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"$.xgafv","in":"query","description":"V1 error format. (Acceptable values are: \"1\", \"2\")","style":"form","explode":true,"schema":{"type":"string","default":"1"}},{"name":"name","in":"path","description":"Required. The name of the artifact to retrieve. Format: `{parent}/artifacts/*`","required":true,"style":"simple","schema":{"pattern":"^projects/[^/]+/locations/[^/]+/artifacts/[^/]+$","type":"string"}}],"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Artifact"}}}}},"deprecated":false,"security":[{"httpBearer":["https://www.googleapis.com/auth/cloud-platform"]}]},"patch":{"tags":["deployments"],"summary":"PatchV1ByName","description":"Used to modify a specified deployment.","operationId":"PatchV1ByName","parameters":[{"name":"upload_protocol","in":"query","description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"quotaUser","in":"query","description":"Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"alt","in":"query","description":"Data format for response. (Acceptable values are: \"json\", \"media\", \"proto\")","style":"form","explode":true,"schema":{"type":"string","default":"json"}},{"name":"fields","in":"query","description":"Selector specifying which fields to include in a partial response.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"access_token","in":"query","description":"OAuth access token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"key","in":"query","description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"callback","in":"query","description":"JSONP","style":"form","explode":true,"schema":{"type":"string"}},{"name":"prettyPrint","in":"query","description":"Returns response with indentations and line breaks.","style":"form","explode":true,"schema":{"type":"boolean","default":true}},{"name":"uploadType","in":"query","description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"oauth_token","in":"query","description":"OAuth 2.0 token for the current user.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"$.xgafv","in":"query","description":"V1 error format. (Acceptable values are: \"1\", \"2\")","style":"form","explode":true,"schema":{"type":"string","default":"1"}},{"name":"allowMissing","in":"query","description":"If set to true, and the deployment is not found, a new deployment will be created. In this situation, `update_mask` is ignored.","style":"form","explode":true,"schema":{"type":"boolean"}},{"name":"name","in":"path","description":"Resource name.","required":true,"style":"simple","schema":{"pattern":"^projects/[^/]+/locations/[^/]+/apis/[^/]+/deployments/[^/]+$","type":"string"}},{"name":"updateMask","in":"query","description":"The list of fields to be updated. If omitted, all fields are updated that are set in the request message (fields set to default values are ignored). If an asterisk \"*\" is specified, all fields are updated, including fields that are unspecified/default in the request.","style":"form","explode":true,"schema":{"type":"string"}}],"requestBody":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiDeployment"}}},"required":true},"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiDeployment"}}}}},"deprecated":false,"security":[{"httpBearer":["https://www.googleapis.com/auth/cloud-platform"]}]},"parameters":[]},"/v1/{resource}:setIamPolicy":{"post":{"tags":["artifacts"],"summary":"SetIamPolicyV1SetIamPolicyByResource","description":"Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.","operationId":"SetIamPolicyV1SetIamPolicyByResource","parameters":[{"name":"upload_protocol","in":"query","description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"quotaUser","in":"query","description":"Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"alt","in":"query","description":"Data format for response. (Acceptable values are: \"json\", \"media\", \"proto\")","style":"form","explode":true,"schema":{"type":"string","default":"json"}},{"name":"fields","in":"query","description":"Selector specifying which fields to include in a partial response.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"access_token","in":"query","description":"OAuth access token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"key","in":"query","description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"callback","in":"query","description":"JSONP","style":"form","explode":true,"schema":{"type":"string"}},{"name":"prettyPrint","in":"query","description":"Returns response with indentations and line breaks.","style":"form","explode":true,"schema":{"type":"boolean","default":true}},{"name":"uploadType","in":"query","description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"oauth_token","in":"query","description":"OAuth 2.0 token for the current user.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"$.xgafv","in":"query","description":"V1 error format. (Acceptable values are: \"1\", \"2\")","style":"form","explode":true,"schema":{"type":"string","default":"1"}},{"name":"resource","in":"path","description":"REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.","required":true,"style":"simple","schema":{"pattern":"^projects/[^/]+/locations/[^/]+/artifacts/[^/]+$","type":"string"}}],"requestBody":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SetIamPolicyRequest"}}},"required":true},"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Policy"}}}}},"deprecated":false,"security":[{"httpBearer":["https://www.googleapis.com/auth/cloud-platform"]}]},"parameters":[]},"/v1/{name}:getContents":{"get":{"tags":["artifacts"],"summary":"GetContentsV1GetContentsByName","description":"Returns the contents of a specified artifact. If artifacts are stored with GZip compression, the default behavior is to return the artifact uncompressed (the mime_type response field indicates the exact format returned).","operationId":"GetContentsV1GetContentsByName","parameters":[{"name":"upload_protocol","in":"query","description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"quotaUser","in":"query","description":"Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"alt","in":"query","description":"Data format for response. (Acceptable values are: \"json\", \"media\", \"proto\")","style":"form","explode":true,"schema":{"type":"string","default":"json"}},{"name":"fields","in":"query","description":"Selector specifying which fields to include in a partial response.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"access_token","in":"query","description":"OAuth access token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"key","in":"query","description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"callback","in":"query","description":"JSONP","style":"form","explode":true,"schema":{"type":"string"}},{"name":"prettyPrint","in":"query","description":"Returns response with indentations and line breaks.","style":"form","explode":true,"schema":{"type":"boolean","default":true}},{"name":"uploadType","in":"query","description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"oauth_token","in":"query","description":"OAuth 2.0 token for the current user.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"$.xgafv","in":"query","description":"V1 error format. (Acceptable values are: \"1\", \"2\")","style":"form","explode":true,"schema":{"type":"string","default":"1"}},{"name":"name","in":"path","description":"Required. The name of the artifact whose contents should be retrieved. Format: `{parent}/artifacts/*`","required":true,"style":"simple","schema":{"pattern":"^projects/[^/]+/locations/[^/]+/artifacts/[^/]+$","type":"string"}}],"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HttpBody"}}}}},"deprecated":false,"security":[{"httpBearer":["https://www.googleapis.com/auth/cloud-platform"]}]},"parameters":[]},"/v1/{parent}/artifacts":{"post":{"tags":["artifacts"],"summary":"CreateV1ArtifactsByParent","description":"Creates a specified artifact.","operationId":"CreateV1ArtifactsByParent","parameters":[{"name":"upload_protocol","in":"query","description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"quotaUser","in":"query","description":"Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"alt","in":"query","description":"Data format for response. (Acceptable values are: \"json\", \"media\", \"proto\")","style":"form","explode":true,"schema":{"type":"string","default":"json"}},{"name":"fields","in":"query","description":"Selector specifying which fields to include in a partial response.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"access_token","in":"query","description":"OAuth access token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"key","in":"query","description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"callback","in":"query","description":"JSONP","style":"form","explode":true,"schema":{"type":"string"}},{"name":"prettyPrint","in":"query","description":"Returns response with indentations and line breaks.","style":"form","explode":true,"schema":{"type":"boolean","default":true}},{"name":"uploadType","in":"query","description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"oauth_token","in":"query","description":"OAuth 2.0 token for the current user.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"$.xgafv","in":"query","description":"V1 error format. (Acceptable values are: \"1\", \"2\")","style":"form","explode":true,"schema":{"type":"string","default":"1"}},{"name":"artifactId","in":"query","description":"Required. The ID to use for the artifact, which will become the final component of the artifact's resource name. This value should be 4-63 characters, and valid characters are /a-z-/. Following AIP-162, IDs must not have the form of a UUID.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"parent","in":"path","description":"Required. The parent, which owns this collection of artifacts. Format: `{parent}`","required":true,"style":"simple","schema":{"pattern":"^projects/[^/]+/locations/[^/]+$","type":"string"}}],"requestBody":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Artifact"}}},"required":true},"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Artifact"}}}}},"deprecated":false,"security":[{"httpBearer":["https://www.googleapis.com/auth/cloud-platform"]}]},"get":{"tags":["artifacts"],"summary":"ListV1ArtifactsByParent","description":"Returns matching artifacts.","operationId":"ListV1ArtifactsByParent","parameters":[{"name":"upload_protocol","in":"query","description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"quotaUser","in":"query","description":"Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"alt","in":"query","description":"Data format for response. (Acceptable values are: \"json\", \"media\", \"proto\")","style":"form","explode":true,"schema":{"type":"string","default":"json"}},{"name":"fields","in":"query","description":"Selector specifying which fields to include in a partial response.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"access_token","in":"query","description":"OAuth access token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"key","in":"query","description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"callback","in":"query","description":"JSONP","style":"form","explode":true,"schema":{"type":"string"}},{"name":"prettyPrint","in":"query","description":"Returns response with indentations and line breaks.","style":"form","explode":true,"schema":{"type":"boolean","default":true}},{"name":"uploadType","in":"query","description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"oauth_token","in":"query","description":"OAuth 2.0 token for the current user.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"$.xgafv","in":"query","description":"V1 error format. (Acceptable values are: \"1\", \"2\")","style":"form","explode":true,"schema":{"type":"string","default":"1"}},{"name":"pageSize","in":"query","description":"The maximum number of artifacts to return. The service may return fewer than this value. If unspecified, at most 50 values will be returned. The maximum is 1000; values above 1000 will be coerced to 1000.","style":"form","explode":true,"schema":{"type":"integer","contentEncoding":"int32"}},{"name":"pageToken","in":"query","description":"A page token, received from a previous `ListArtifacts` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListArtifacts` must match the call that provided the page token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"orderBy","in":"query","description":"A comma-separated list of fields, e.g. \"foo,bar\" Fields can be sorted in descending order using the \"desc\" identifier, e.g. \"foo desc,bar\"","style":"form","explode":true,"schema":{"type":"string"}},{"name":"filter","in":"query","description":"An expression that can be used to filter the list. Filters use the Common Expression Language and can refer to all message fields except contents.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"parent","in":"path","description":"Required. The parent, which owns this collection of artifacts. Format: `{parent}`","required":true,"style":"simple","schema":{"pattern":"^projects/[^/]+/locations/[^/]+$","type":"string"}}],"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListArtifactsResponse"}}}}},"deprecated":false,"security":[{"httpBearer":["https://www.googleapis.com/auth/cloud-platform"]}]},"parameters":[]},"/v1/{resource}:testIamPermissions":{"post":{"tags":["artifacts"],"summary":"TestIamPermissionsV1TestIamPermissionsByResource","description":"Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.","operationId":"TestIamPermissionsV1TestIamPermissionsByResource","parameters":[{"name":"upload_protocol","in":"query","description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"quotaUser","in":"query","description":"Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"alt","in":"query","description":"Data format for response. (Acceptable values are: \"json\", \"media\", \"proto\")","style":"form","explode":true,"schema":{"type":"string","default":"json"}},{"name":"fields","in":"query","description":"Selector specifying which fields to include in a partial response.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"access_token","in":"query","description":"OAuth access token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"key","in":"query","description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"callback","in":"query","description":"JSONP","style":"form","explode":true,"schema":{"type":"string"}},{"name":"prettyPrint","in":"query","description":"Returns response with indentations and line breaks.","style":"form","explode":true,"schema":{"type":"boolean","default":true}},{"name":"uploadType","in":"query","description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"oauth_token","in":"query","description":"OAuth 2.0 token for the current user.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"$.xgafv","in":"query","description":"V1 error format. (Acceptable values are: \"1\", \"2\")","style":"form","explode":true,"schema":{"type":"string","default":"1"}},{"name":"resource","in":"path","description":"REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.","required":true,"style":"simple","schema":{"pattern":"^projects/[^/]+/locations/[^/]+/artifacts/[^/]+$","type":"string"}}],"requestBody":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TestIamPermissionsRequest"}}},"required":true},"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TestIamPermissionsResponse"}}}}},"deprecated":false,"security":[{"httpBearer":["https://www.googleapis.com/auth/cloud-platform"]}]},"parameters":[]},"/v1/{parent}/deployments":{"post":{"tags":["deployments"],"summary":"CreateV1DeploymentsByParent","description":"Creates a specified deployment.","operationId":"CreateV1DeploymentsByParent","parameters":[{"name":"upload_protocol","in":"query","description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"quotaUser","in":"query","description":"Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"alt","in":"query","description":"Data format for response. (Acceptable values are: \"json\", \"media\", \"proto\")","style":"form","explode":true,"schema":{"type":"string","default":"json"}},{"name":"fields","in":"query","description":"Selector specifying which fields to include in a partial response.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"access_token","in":"query","description":"OAuth access token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"key","in":"query","description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"callback","in":"query","description":"JSONP","style":"form","explode":true,"schema":{"type":"string"}},{"name":"prettyPrint","in":"query","description":"Returns response with indentations and line breaks.","style":"form","explode":true,"schema":{"type":"boolean","default":true}},{"name":"uploadType","in":"query","description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"oauth_token","in":"query","description":"OAuth 2.0 token for the current user.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"$.xgafv","in":"query","description":"V1 error format. (Acceptable values are: \"1\", \"2\")","style":"form","explode":true,"schema":{"type":"string","default":"1"}},{"name":"parent","in":"path","description":"Required. The parent, which owns this collection of deployments. Format: `projects/*/locations/*/apis/*`","required":true,"style":"simple","schema":{"pattern":"^projects/[^/]+/locations/[^/]+/apis/[^/]+$","type":"string"}},{"name":"apiDeploymentId","in":"query","description":"Required. The ID to use for the deployment, which will become the final component of the deployment's resource name. This value should be 4-63 characters, and valid characters are /a-z-/. Following AIP-162, IDs must not have the form of a UUID.","style":"form","explode":true,"schema":{"type":"string"}}],"requestBody":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiDeployment"}}},"required":true},"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiDeployment"}}}}},"deprecated":false,"security":[{"httpBearer":["https://www.googleapis.com/auth/cloud-platform"]}]},"get":{"tags":["deployments"],"summary":"ListV1DeploymentsByParent","description":"Returns matching deployments.","operationId":"ListV1DeploymentsByParent","parameters":[{"name":"upload_protocol","in":"query","description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"quotaUser","in":"query","description":"Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"alt","in":"query","description":"Data format for response. (Acceptable values are: \"json\", \"media\", \"proto\")","style":"form","explode":true,"schema":{"type":"string","default":"json"}},{"name":"fields","in":"query","description":"Selector specifying which fields to include in a partial response.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"access_token","in":"query","description":"OAuth access token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"key","in":"query","description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"callback","in":"query","description":"JSONP","style":"form","explode":true,"schema":{"type":"string"}},{"name":"prettyPrint","in":"query","description":"Returns response with indentations and line breaks.","style":"form","explode":true,"schema":{"type":"boolean","default":true}},{"name":"uploadType","in":"query","description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"oauth_token","in":"query","description":"OAuth 2.0 token for the current user.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"$.xgafv","in":"query","description":"V1 error format. (Acceptable values are: \"1\", \"2\")","style":"form","explode":true,"schema":{"type":"string","default":"1"}},{"name":"parent","in":"path","description":"Required. The parent, which owns this collection of deployments. Format: `projects/*/locations/*/apis/*`","required":true,"style":"simple","schema":{"pattern":"^projects/[^/]+/locations/[^/]+/apis/[^/]+$","type":"string"}},{"name":"orderBy","in":"query","description":"A comma-separated list of fields, e.g. \"foo,bar\" Fields can be sorted in descending order using the \"desc\" identifier, e.g. \"foo desc,bar\"","style":"form","explode":true,"schema":{"type":"string"}},{"name":"filter","in":"query","description":"An expression that can be used to filter the list. Filters use the Common Expression Language and can refer to all message fields.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"pageToken","in":"query","description":"A page token, received from a previous `ListApiDeployments` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListApiDeployments` must match the call that provided the page token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"pageSize","in":"query","description":"The maximum number of deployments to return. The service may return fewer than this value. If unspecified, at most 50 values will be returned. The maximum is 1000; values above 1000 will be coerced to 1000.","style":"form","explode":true,"schema":{"type":"integer","contentEncoding":"int32"}}],"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListApiDeploymentsResponse"}}}}},"deprecated":false,"security":[{"httpBearer":["https://www.googleapis.com/auth/cloud-platform"]}]},"parameters":[]},"/v1/{name}:listRevisions":{"get":{"tags":["deployments"],"summary":"ListRevisionsV1ListRevisionsByName","description":"Lists all revisions of a deployment. Revisions are returned in descending order of revision creation time.","operationId":"ListRevisionsV1ListRevisionsByName","parameters":[{"name":"upload_protocol","in":"query","description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"quotaUser","in":"query","description":"Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"alt","in":"query","description":"Data format for response. (Acceptable values are: \"json\", \"media\", \"proto\")","style":"form","explode":true,"schema":{"type":"string","default":"json"}},{"name":"fields","in":"query","description":"Selector specifying which fields to include in a partial response.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"access_token","in":"query","description":"OAuth access token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"key","in":"query","description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"callback","in":"query","description":"JSONP","style":"form","explode":true,"schema":{"type":"string"}},{"name":"prettyPrint","in":"query","description":"Returns response with indentations and line breaks.","style":"form","explode":true,"schema":{"type":"boolean","default":true}},{"name":"uploadType","in":"query","description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"oauth_token","in":"query","description":"OAuth 2.0 token for the current user.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"$.xgafv","in":"query","description":"V1 error format. (Acceptable values are: \"1\", \"2\")","style":"form","explode":true,"schema":{"type":"string","default":"1"}},{"name":"pageToken","in":"query","description":"The page token, received from a previous ListApiDeploymentRevisions call. Provide this to retrieve the subsequent page.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"name","in":"path","description":"Required. The name of the deployment to list revisions for.","required":true,"style":"simple","schema":{"pattern":"^projects/[^/]+/locations/[^/]+/apis/[^/]+/deployments/[^/]+$","type":"string"}},{"name":"pageSize","in":"query","description":"The maximum number of revisions to return per page.","style":"form","explode":true,"schema":{"type":"integer","contentEncoding":"int32"}}],"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListApiDeploymentRevisionsResponse"}}}}},"deprecated":false,"security":[{"httpBearer":["https://www.googleapis.com/auth/cloud-platform"]}]},"parameters":[]},"/v1/{name}:deleteRevision":{"delete":{"tags":["deployments"],"summary":"DeleteRevisionV1DeleteRevisionByName","description":"Deletes a revision of a deployment.","operationId":"DeleteRevisionV1DeleteRevisionByName","parameters":[{"name":"upload_protocol","in":"query","description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"quotaUser","in":"query","description":"Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"alt","in":"query","description":"Data format for response. (Acceptable values are: \"json\", \"media\", \"proto\")","style":"form","explode":true,"schema":{"type":"string","default":"json"}},{"name":"fields","in":"query","description":"Selector specifying which fields to include in a partial response.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"access_token","in":"query","description":"OAuth access token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"key","in":"query","description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"callback","in":"query","description":"JSONP","style":"form","explode":true,"schema":{"type":"string"}},{"name":"prettyPrint","in":"query","description":"Returns response with indentations and line breaks.","style":"form","explode":true,"schema":{"type":"boolean","default":true}},{"name":"uploadType","in":"query","description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"oauth_token","in":"query","description":"OAuth 2.0 token for the current user.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"$.xgafv","in":"query","description":"V1 error format. (Acceptable values are: \"1\", \"2\")","style":"form","explode":true,"schema":{"type":"string","default":"1"}},{"name":"name","in":"path","description":"Required. The name of the deployment revision to be deleted, with a revision ID explicitly included. Example: `projects/sample/locations/global/apis/petstore/deployments/prod@c7cfa2a8`","required":true,"style":"simple","schema":{"pattern":"^projects/[^/]+/locations/[^/]+/apis/[^/]+/deployments/[^/]+$","type":"string"}}],"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiDeployment"}}}}},"deprecated":false,"security":[{"httpBearer":["https://www.googleapis.com/auth/cloud-platform"]}]},"parameters":[]},"/v1/{name}:rollback":{"post":{"tags":["deployments"],"summary":"RollbackV1RollbackByName","description":"Sets the current revision to a specified prior revision. Note that this creates a new revision with a new revision ID.","operationId":"RollbackV1RollbackByName","parameters":[{"name":"upload_protocol","in":"query","description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"quotaUser","in":"query","description":"Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"alt","in":"query","description":"Data format for response. (Acceptable values are: \"json\", \"media\", \"proto\")","style":"form","explode":true,"schema":{"type":"string","default":"json"}},{"name":"fields","in":"query","description":"Selector specifying which fields to include in a partial response.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"access_token","in":"query","description":"OAuth access token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"key","in":"query","description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"callback","in":"query","description":"JSONP","style":"form","explode":true,"schema":{"type":"string"}},{"name":"prettyPrint","in":"query","description":"Returns response with indentations and line breaks.","style":"form","explode":true,"schema":{"type":"boolean","default":true}},{"name":"uploadType","in":"query","description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"oauth_token","in":"query","description":"OAuth 2.0 token for the current user.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"$.xgafv","in":"query","description":"V1 error format. (Acceptable values are: \"1\", \"2\")","style":"form","explode":true,"schema":{"type":"string","default":"1"}},{"name":"name","in":"path","description":"Required. The deployment being rolled back.","required":true,"style":"simple","schema":{"pattern":"^projects/[^/]+/locations/[^/]+/apis/[^/]+/deployments/[^/]+$","type":"string"}}],"requestBody":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RollbackApiDeploymentRequest"}}},"required":true},"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiDeployment"}}}}},"deprecated":false,"security":[{"httpBearer":["https://www.googleapis.com/auth/cloud-platform"]}]},"parameters":[]},"/v1/{name}:tagRevision":{"post":{"tags":["deployments"],"summary":"TagRevisionV1TagRevisionByName","description":"Adds a tag to a specified revision of a deployment.","operationId":"TagRevisionV1TagRevisionByName","parameters":[{"name":"upload_protocol","in":"query","description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"quotaUser","in":"query","description":"Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"alt","in":"query","description":"Data format for response. (Acceptable values are: \"json\", \"media\", \"proto\")","style":"form","explode":true,"schema":{"type":"string","default":"json"}},{"name":"fields","in":"query","description":"Selector specifying which fields to include in a partial response.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"access_token","in":"query","description":"OAuth access token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"key","in":"query","description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"callback","in":"query","description":"JSONP","style":"form","explode":true,"schema":{"type":"string"}},{"name":"prettyPrint","in":"query","description":"Returns response with indentations and line breaks.","style":"form","explode":true,"schema":{"type":"boolean","default":true}},{"name":"uploadType","in":"query","description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"oauth_token","in":"query","description":"OAuth 2.0 token for the current user.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"$.xgafv","in":"query","description":"V1 error format. (Acceptable values are: \"1\", \"2\")","style":"form","explode":true,"schema":{"type":"string","default":"1"}},{"name":"name","in":"path","description":"Required. The name of the deployment to be tagged, including the revision ID.","required":true,"style":"simple","schema":{"pattern":"^projects/[^/]+/locations/[^/]+/apis/[^/]+/deployments/[^/]+$","type":"string"}}],"requestBody":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TagApiDeploymentRevisionRequest"}}},"required":true},"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiDeployment"}}}}},"deprecated":false,"security":[{"httpBearer":["https://www.googleapis.com/auth/cloud-platform"]}]},"parameters":[]},"/v1/{parent}/specs":{"get":{"tags":["specs"],"summary":"ListV1SpecsByParent","description":"Returns matching specs.","operationId":"ListV1SpecsByParent","parameters":[{"name":"upload_protocol","in":"query","description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"quotaUser","in":"query","description":"Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"alt","in":"query","description":"Data format for response. (Acceptable values are: \"json\", \"media\", \"proto\")","style":"form","explode":true,"schema":{"type":"string","default":"json"}},{"name":"fields","in":"query","description":"Selector specifying which fields to include in a partial response.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"access_token","in":"query","description":"OAuth access token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"key","in":"query","description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"callback","in":"query","description":"JSONP","style":"form","explode":true,"schema":{"type":"string"}},{"name":"prettyPrint","in":"query","description":"Returns response with indentations and line breaks.","style":"form","explode":true,"schema":{"type":"boolean","default":true}},{"name":"uploadType","in":"query","description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"oauth_token","in":"query","description":"OAuth 2.0 token for the current user.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"$.xgafv","in":"query","description":"V1 error format. (Acceptable values are: \"1\", \"2\")","style":"form","explode":true,"schema":{"type":"string","default":"1"}},{"name":"orderBy","in":"query","description":"A comma-separated list of fields, e.g. \"foo,bar\" Fields can be sorted in descending order using the \"desc\" identifier, e.g. \"foo desc,bar\"","style":"form","explode":true,"schema":{"type":"string"}},{"name":"filter","in":"query","description":"An expression that can be used to filter the list. Filters use the Common Expression Language and can refer to all message fields except contents.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"pageSize","in":"query","description":"The maximum number of specs to return. The service may return fewer than this value. If unspecified, at most 50 values will be returned. The maximum is 1000; values above 1000 will be coerced to 1000.","style":"form","explode":true,"schema":{"type":"integer","contentEncoding":"int32"}},{"name":"parent","in":"path","description":"Required. The parent, which owns this collection of specs. Format: `projects/*/locations/*/apis/*/versions/*`","required":true,"style":"simple","schema":{"pattern":"^projects/[^/]+/locations/[^/]+/apis/[^/]+/versions/[^/]+$","type":"string"}},{"name":"pageToken","in":"query","description":"A page token, received from a previous `ListApiSpecs` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListApiSpecs` must match the call that provided the page token.","style":"form","explode":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListApiSpecsResponse"}}}}},"deprecated":false,"security":[{"httpBearer":["https://www.googleapis.com/auth/cloud-platform"]}]},"post":{"tags":["specs"],"summary":"CreateV1SpecsByParent","description":"Creates a specified spec.","operationId":"CreateV1SpecsByParent","parameters":[{"name":"upload_protocol","in":"query","description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"quotaUser","in":"query","description":"Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"alt","in":"query","description":"Data format for response. (Acceptable values are: \"json\", \"media\", \"proto\")","style":"form","explode":true,"schema":{"type":"string","default":"json"}},{"name":"fields","in":"query","description":"Selector specifying which fields to include in a partial response.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"access_token","in":"query","description":"OAuth access token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"key","in":"query","description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"callback","in":"query","description":"JSONP","style":"form","explode":true,"schema":{"type":"string"}},{"name":"prettyPrint","in":"query","description":"Returns response with indentations and line breaks.","style":"form","explode":true,"schema":{"type":"boolean","default":true}},{"name":"uploadType","in":"query","description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"oauth_token","in":"query","description":"OAuth 2.0 token for the current user.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"$.xgafv","in":"query","description":"V1 error format. (Acceptable values are: \"1\", \"2\")","style":"form","explode":true,"schema":{"type":"string","default":"1"}},{"name":"parent","in":"path","description":"Required. The parent, which owns this collection of specs. Format: `projects/*/locations/*/apis/*/versions/*`","required":true,"style":"simple","schema":{"pattern":"^projects/[^/]+/locations/[^/]+/apis/[^/]+/versions/[^/]+$","type":"string"}},{"name":"apiSpecId","in":"query","description":"Required. The ID to use for the spec, which will become the final component of the spec's resource name. This value should be 4-63 characters, and valid characters are /a-z-/. Following AIP-162, IDs must not have the form of a UUID.","style":"form","explode":true,"schema":{"type":"string"}}],"requestBody":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiSpec"}}},"required":true},"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiSpec"}}}}},"deprecated":false,"security":[{"httpBearer":["https://www.googleapis.com/auth/cloud-platform"]}]},"parameters":[]},"/v1/{parent}/versions":{"post":{"tags":["versions"],"summary":"CreateV1VersionsByParent","description":"Creates a specified version.","operationId":"CreateV1VersionsByParent","parameters":[{"name":"upload_protocol","in":"query","description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"quotaUser","in":"query","description":"Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"alt","in":"query","description":"Data format for response. (Acceptable values are: \"json\", \"media\", \"proto\")","style":"form","explode":true,"schema":{"type":"string","default":"json"}},{"name":"fields","in":"query","description":"Selector specifying which fields to include in a partial response.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"access_token","in":"query","description":"OAuth access token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"key","in":"query","description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"callback","in":"query","description":"JSONP","style":"form","explode":true,"schema":{"type":"string"}},{"name":"prettyPrint","in":"query","description":"Returns response with indentations and line breaks.","style":"form","explode":true,"schema":{"type":"boolean","default":true}},{"name":"uploadType","in":"query","description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"oauth_token","in":"query","description":"OAuth 2.0 token for the current user.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"$.xgafv","in":"query","description":"V1 error format. (Acceptable values are: \"1\", \"2\")","style":"form","explode":true,"schema":{"type":"string","default":"1"}},{"name":"apiVersionId","in":"query","description":"Required. The ID to use for the version, which will become the final component of the version's resource name. This value should be 1-63 characters, and valid characters are /a-z-/. Following AIP-162, IDs must not have the form of a UUID.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"parent","in":"path","description":"Required. The parent, which owns this collection of versions. Format: `projects/*/locations/*/apis/*`","required":true,"style":"simple","schema":{"pattern":"^projects/[^/]+/locations/[^/]+/apis/[^/]+$","type":"string"}}],"requestBody":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiVersion"}}},"required":true},"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiVersion"}}}}},"deprecated":false,"security":[{"httpBearer":["https://www.googleapis.com/auth/cloud-platform"]}]},"get":{"tags":["versions"],"summary":"ListV1VersionsByParent","description":"Returns matching versions.","operationId":"ListV1VersionsByParent","parameters":[{"name":"upload_protocol","in":"query","description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"quotaUser","in":"query","description":"Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"alt","in":"query","description":"Data format for response. (Acceptable values are: \"json\", \"media\", \"proto\")","style":"form","explode":true,"schema":{"type":"string","default":"json"}},{"name":"fields","in":"query","description":"Selector specifying which fields to include in a partial response.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"access_token","in":"query","description":"OAuth access token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"key","in":"query","description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"callback","in":"query","description":"JSONP","style":"form","explode":true,"schema":{"type":"string"}},{"name":"prettyPrint","in":"query","description":"Returns response with indentations and line breaks.","style":"form","explode":true,"schema":{"type":"boolean","default":true}},{"name":"uploadType","in":"query","description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"oauth_token","in":"query","description":"OAuth 2.0 token for the current user.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"$.xgafv","in":"query","description":"V1 error format. (Acceptable values are: \"1\", \"2\")","style":"form","explode":true,"schema":{"type":"string","default":"1"}},{"name":"orderBy","in":"query","description":"A comma-separated list of fields, e.g. \"foo,bar\" Fields can be sorted in descending order using the \"desc\" identifier, e.g. \"foo desc,bar\"","style":"form","explode":true,"schema":{"type":"string"}},{"name":"filter","in":"query","description":"An expression that can be used to filter the list. Filters use the Common Expression Language and can refer to all message fields.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"pageSize","in":"query","description":"The maximum number of versions to return. The service may return fewer than this value. If unspecified, at most 50 values will be returned. The maximum is 1000; values above 1000 will be coerced to 1000.","style":"form","explode":true,"schema":{"type":"integer","contentEncoding":"int32"}},{"name":"parent","in":"path","description":"Required. The parent, which owns this collection of versions. Format: `projects/*/locations/*/apis/*`","required":true,"style":"simple","schema":{"pattern":"^projects/[^/]+/locations/[^/]+/apis/[^/]+$","type":"string"}},{"name":"pageToken","in":"query","description":"A page token, received from a previous `ListApiVersions` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListApiVersions` must match the call that provided the page token.","style":"form","explode":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListApiVersionsResponse"}}}}},"deprecated":false,"security":[{"httpBearer":["https://www.googleapis.com/auth/cloud-platform"]}]},"parameters":[]},"/v1/{parent}/apis":{"post":{"tags":["apis"],"summary":"CreateV1ApisByParent","description":"Creates a specified API.","operationId":"CreateV1ApisByParent","parameters":[{"name":"upload_protocol","in":"query","description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"quotaUser","in":"query","description":"Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"alt","in":"query","description":"Data format for response. (Acceptable values are: \"json\", \"media\", \"proto\")","style":"form","explode":true,"schema":{"type":"string","default":"json"}},{"name":"fields","in":"query","description":"Selector specifying which fields to include in a partial response.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"access_token","in":"query","description":"OAuth access token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"key","in":"query","description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"callback","in":"query","description":"JSONP","style":"form","explode":true,"schema":{"type":"string"}},{"name":"prettyPrint","in":"query","description":"Returns response with indentations and line breaks.","style":"form","explode":true,"schema":{"type":"boolean","default":true}},{"name":"uploadType","in":"query","description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"oauth_token","in":"query","description":"OAuth 2.0 token for the current user.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"$.xgafv","in":"query","description":"V1 error format. (Acceptable values are: \"1\", \"2\")","style":"form","explode":true,"schema":{"type":"string","default":"1"}},{"name":"apiId","in":"query","description":"Required. The ID to use for the API, which will become the final component of the API's resource name. This value should be 4-63 characters, and valid characters are /a-z-/. Following AIP-162, IDs must not have the form of a UUID.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"parent","in":"path","description":"Required. The parent, which owns this collection of APIs. Format: `projects/*/locations/*`","required":true,"style":"simple","schema":{"pattern":"^projects/[^/]+/locations/[^/]+$","type":"string"}}],"requestBody":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Api"}}},"required":true},"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Api"}}}}},"deprecated":false,"security":[{"httpBearer":["https://www.googleapis.com/auth/cloud-platform"]}]},"get":{"tags":["apis"],"summary":"ListV1ApisByParent","description":"Returns matching APIs.","operationId":"ListV1ApisByParent","parameters":[{"name":"upload_protocol","in":"query","description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"quotaUser","in":"query","description":"Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"alt","in":"query","description":"Data format for response. (Acceptable values are: \"json\", \"media\", \"proto\")","style":"form","explode":true,"schema":{"type":"string","default":"json"}},{"name":"fields","in":"query","description":"Selector specifying which fields to include in a partial response.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"access_token","in":"query","description":"OAuth access token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"key","in":"query","description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"callback","in":"query","description":"JSONP","style":"form","explode":true,"schema":{"type":"string"}},{"name":"prettyPrint","in":"query","description":"Returns response with indentations and line breaks.","style":"form","explode":true,"schema":{"type":"boolean","default":true}},{"name":"uploadType","in":"query","description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"oauth_token","in":"query","description":"OAuth 2.0 token for the current user.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"$.xgafv","in":"query","description":"V1 error format. (Acceptable values are: \"1\", \"2\")","style":"form","explode":true,"schema":{"type":"string","default":"1"}},{"name":"parent","in":"path","description":"Required. The parent, which owns this collection of APIs. Format: `projects/*/locations/*`","required":true,"style":"simple","schema":{"pattern":"^projects/[^/]+/locations/[^/]+$","type":"string"}},{"name":"pageSize","in":"query","description":"The maximum number of APIs to return. The service may return fewer than this value. If unspecified, at most 50 values will be returned. The maximum is 1000; values above 1000 will be coerced to 1000.","style":"form","explode":true,"schema":{"type":"integer","contentEncoding":"int32"}},{"name":"filter","in":"query","description":"An expression that can be used to filter the list. Filters use the Common Expression Language and can refer to all message fields.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"orderBy","in":"query","description":"A comma-separated list of fields, e.g. \"foo,bar\" Fields can be sorted in descending order using the \"desc\" identifier, e.g. \"foo desc,bar\"","style":"form","explode":true,"schema":{"type":"string"}},{"name":"pageToken","in":"query","description":"A page token, received from a previous `ListApis` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListApis` must match the call that provided the page token.","style":"form","explode":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListApisResponse"}}}}},"deprecated":false,"security":[{"httpBearer":["https://www.googleapis.com/auth/cloud-platform"]}]},"parameters":[]},"/v1/{parent}/instances":{"post":{"tags":["instances"],"summary":"CreateV1InstancesByParent","description":"Provisions instance resources for the Registry.","operationId":"CreateV1InstancesByParent","parameters":[{"name":"upload_protocol","in":"query","description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"quotaUser","in":"query","description":"Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"alt","in":"query","description":"Data format for response. (Acceptable values are: \"json\", \"media\", \"proto\")","style":"form","explode":true,"schema":{"type":"string","default":"json"}},{"name":"fields","in":"query","description":"Selector specifying which fields to include in a partial response.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"access_token","in":"query","description":"OAuth access token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"key","in":"query","description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"callback","in":"query","description":"JSONP","style":"form","explode":true,"schema":{"type":"string"}},{"name":"prettyPrint","in":"query","description":"Returns response with indentations and line breaks.","style":"form","explode":true,"schema":{"type":"boolean","default":true}},{"name":"uploadType","in":"query","description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"oauth_token","in":"query","description":"OAuth 2.0 token for the current user.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"$.xgafv","in":"query","description":"V1 error format. (Acceptable values are: \"1\", \"2\")","style":"form","explode":true,"schema":{"type":"string","default":"1"}},{"name":"parent","in":"path","description":"Required. Parent resource of the Instance, of the form: `projects/*/locations/*`","required":true,"style":"simple","schema":{"pattern":"^projects/[^/]+/locations/[^/]+$","type":"string"}},{"name":"instanceId","in":"query","description":"Required. Identifier to assign to the Instance. Must be unique within scope of the parent resource.","style":"form","explode":true,"schema":{"type":"string"}}],"requestBody":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Instance"}}},"required":true},"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Operation"}}}}},"deprecated":false,"security":[{"httpBearer":["https://www.googleapis.com/auth/cloud-platform"]}]},"parameters":[]},"/v1/{name}/operations":{"get":{"tags":["operations"],"summary":"ListV1OperationsByName","description":"Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services to override the binding to use different resource name schemes, such as `users/*/operations`. To override the binding, API services can add a binding such as `\"/v1/{name=users/*}/operations\"` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.","operationId":"ListV1OperationsByName","parameters":[{"name":"upload_protocol","in":"query","description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"quotaUser","in":"query","description":"Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"alt","in":"query","description":"Data format for response. (Acceptable values are: \"json\", \"media\", \"proto\")","style":"form","explode":true,"schema":{"type":"string","default":"json"}},{"name":"fields","in":"query","description":"Selector specifying which fields to include in a partial response.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"access_token","in":"query","description":"OAuth access token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"key","in":"query","description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"callback","in":"query","description":"JSONP","style":"form","explode":true,"schema":{"type":"string"}},{"name":"prettyPrint","in":"query","description":"Returns response with indentations and line breaks.","style":"form","explode":true,"schema":{"type":"boolean","default":true}},{"name":"uploadType","in":"query","description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"oauth_token","in":"query","description":"OAuth 2.0 token for the current user.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"$.xgafv","in":"query","description":"V1 error format. (Acceptable values are: \"1\", \"2\")","style":"form","explode":true,"schema":{"type":"string","default":"1"}},{"name":"pageToken","in":"query","description":"The standard list page token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"name","in":"path","description":"The name of the operation's parent resource.","required":true,"style":"simple","schema":{"pattern":"^projects/[^/]+/locations/[^/]+$","type":"string"}},{"name":"pageSize","in":"query","description":"The standard list page size.","style":"form","explode":true,"schema":{"type":"integer","contentEncoding":"int32"}},{"name":"filter","in":"query","description":"The standard list filter.","style":"form","explode":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListOperationsResponse"}}}}},"deprecated":false,"security":[{"httpBearer":["https://www.googleapis.com/auth/cloud-platform"]}]},"parameters":[]},"/v1/{name}:cancel":{"post":{"tags":["operations"],"summary":"CancelV1CancelByName","description":"Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.","operationId":"CancelV1CancelByName","parameters":[{"name":"upload_protocol","in":"query","description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"quotaUser","in":"query","description":"Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"alt","in":"query","description":"Data format for response. (Acceptable values are: \"json\", \"media\", \"proto\")","style":"form","explode":true,"schema":{"type":"string","default":"json"}},{"name":"fields","in":"query","description":"Selector specifying which fields to include in a partial response.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"access_token","in":"query","description":"OAuth access token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"key","in":"query","description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"callback","in":"query","description":"JSONP","style":"form","explode":true,"schema":{"type":"string"}},{"name":"prettyPrint","in":"query","description":"Returns response with indentations and line breaks.","style":"form","explode":true,"schema":{"type":"boolean","default":true}},{"name":"uploadType","in":"query","description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"oauth_token","in":"query","description":"OAuth 2.0 token for the current user.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"$.xgafv","in":"query","description":"V1 error format. (Acceptable values are: \"1\", \"2\")","style":"form","explode":true,"schema":{"type":"string","default":"1"}},{"name":"name","in":"path","description":"The name of the operation resource to be cancelled.","required":true,"style":"simple","schema":{"pattern":"^projects/[^/]+/locations/[^/]+/operations/[^/]+$","type":"string"}}],"requestBody":{"description":"","content":{"text/plain":{"schema":{"type":"object","contentMediaType":"text/plain"}}},"required":true},"responses":{"200":{"description":"","headers":{},"content":{"text/plain":{"schema":{"type":"object","contentMediaType":"text/plain"}}}}},"deprecated":false,"security":[{"httpBearer":["https://www.googleapis.com/auth/cloud-platform"]}]},"parameters":[]},"/v1/{name}/locations":{"get":{"tags":["locations"],"summary":"ListV1LocationsByName","description":"Lists information about the supported locations for this service.","operationId":"ListV1LocationsByName","parameters":[{"name":"upload_protocol","in":"query","description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"quotaUser","in":"query","description":"Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"alt","in":"query","description":"Data format for response. (Acceptable values are: \"json\", \"media\", \"proto\")","style":"form","explode":true,"schema":{"type":"string","default":"json"}},{"name":"fields","in":"query","description":"Selector specifying which fields to include in a partial response.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"access_token","in":"query","description":"OAuth access token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"key","in":"query","description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"callback","in":"query","description":"JSONP","style":"form","explode":true,"schema":{"type":"string"}},{"name":"prettyPrint","in":"query","description":"Returns response with indentations and line breaks.","style":"form","explode":true,"schema":{"type":"boolean","default":true}},{"name":"uploadType","in":"query","description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"oauth_token","in":"query","description":"OAuth 2.0 token for the current user.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"$.xgafv","in":"query","description":"V1 error format. (Acceptable values are: \"1\", \"2\")","style":"form","explode":true,"schema":{"type":"string","default":"1"}},{"name":"pageSize","in":"query","description":"The maximum number of results to return. If not set, the service selects a default.","style":"form","explode":true,"schema":{"type":"integer","contentEncoding":"int32"}},{"name":"pageToken","in":"query","description":"A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"filter","in":"query","description":"A filter to narrow down results to a preferred subset. The filtering language accepts strings like `\"displayName=tokyo\"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).","style":"form","explode":true,"schema":{"type":"string"}},{"name":"name","in":"path","description":"The resource that owns the locations collection, if applicable.","required":true,"style":"simple","schema":{"pattern":"^projects/[^/]+$","type":"string"}}],"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListLocationsResponse"}}}}},"deprecated":false,"security":[{"httpBearer":["https://www.googleapis.com/auth/cloud-platform"]}]},"parameters":[]}},"components":{"schemas":{"ListLocationsResponse":{"title":"ListLocationsResponse","type":"object","properties":{"locations":{"type":"array","items":{"$ref":"#/components/schemas/Location"},"description":"A list of locations that matches the specified filter in the request."},"nextPageToken":{"type":"string","description":"The standard List next-page token."}},"description":"The response message for Locations.ListLocations."},"ApiVersion":{"title":"ApiVersion","type":"object","properties":{"name":{"type":"string","description":"Resource name."},"labels":{"type":"object","additionalProperties":{"type":"string"},"description":"Labels attach identifying metadata to resources. Identifying metadata can be used to filter list operations. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one resource (System labels are excluded). See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with `apigeeregistry.googleapis.com/` and cannot be changed."},"description":{"type":"string","description":"A detailed description."},"createTime":{"type":"string","description":"Output only. Creation timestamp."},"annotations":{"type":"object","additionalProperties":{"type":"string"},"description":"Annotations attach non-identifying metadata to resources. Annotation keys and values are less restricted than those of labels, but should be generally used for small values of broad interest. Larger, topic- specific metadata should be stored in Artifacts."},"state":{"type":"string","description":"A user-definable description of the lifecycle phase of this API version. Format: free-form, but we expect single words that describe API maturity, e.g., \"CONCEPT\", \"DESIGN\", \"DEVELOPMENT\", \"STAGING\", \"PRODUCTION\", \"DEPRECATED\", \"RETIRED\"."},"displayName":{"type":"string","description":"Human-meaningful name."},"updateTime":{"type":"string","description":"Output only. Last update timestamp."}},"description":"Describes a particular version of an API. ApiVersions are what consumers actually use."},"TagApiDeploymentRevisionRequest":{"title":"TagApiDeploymentRevisionRequest","type":"object","properties":{"tag":{"type":"string","description":"Required. The tag to apply. The tag should be at most 40 characters, and match `a-z{3,39}`."}},"description":"Request message for TagApiDeploymentRevision."},"ListApiVersionsResponse":{"title":"ListApiVersionsResponse","type":"object","properties":{"apiVersions":{"type":"array","items":{"$ref":"#/components/schemas/ApiVersion"},"description":"The versions from the specified publisher."},"nextPageToken":{"type":"string","description":"A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages."}},"description":"Response message for ListApiVersions."},"Api":{"title":"Api","type":"object","properties":{"description":{"type":"string","description":"A detailed description."},"name":{"type":"string","description":"Resource name."},"annotations":{"type":"object","additionalProperties":{"type":"string"},"description":"Annotations attach non-identifying metadata to resources. Annotation keys and values are less restricted than those of labels, but should be generally used for small values of broad interest. Larger, topic- specific metadata should be stored in Artifacts."},"availability":{"type":"string","description":"A user-definable description of the availability of this service. Format: free-form, but we expect single words that describe availability, e.g., \"NONE\", \"TESTING\", \"PREVIEW\", \"GENERAL\", \"DEPRECATED\", \"SHUTDOWN\"."},"updateTime":{"type":"string","description":"Output only. Last update timestamp."},"labels":{"type":"object","additionalProperties":{"type":"string"},"description":"Labels attach identifying metadata to resources. Identifying metadata can be used to filter list operations. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores, and dashes. International characters are allowed. No more than 64 user labels can be associated with one resource (System labels are excluded). See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with `apigeeregistry.googleapis.com/` and cannot be changed."},"displayName":{"type":"string","description":"Human-meaningful name."},"recommendedVersion":{"type":"string","description":"The recommended version of the API. Format: `projects/{project}/locations/{location}/apis/{api}/versions/{version}`"},"recommendedDeployment":{"type":"string","description":"The recommended deployment of the API. Format: `projects/{project}/locations/{location}/apis/{api}/deployments/{deployment}`"},"createTime":{"type":"string","description":"Output only. Creation timestamp."}},"description":"A top-level description of an API. Produced by producers and are commitments to provide services."},"TagApiSpecRevisionRequest":{"title":"TagApiSpecRevisionRequest","type":"object","properties":{"tag":{"type":"string","description":"Required. The tag to apply. The tag should be at most 40 characters, and match `a-z{3,39}`."}},"description":"Request message for TagApiSpecRevision."},"TestIamPermissionsResponse":{"title":"TestIamPermissionsResponse","type":"object","properties":{"permissions":{"type":"array","items":{"type":"string"},"description":"A subset of `TestPermissionsRequest.permissions` that the caller is allowed."}},"description":"Response message for `TestIamPermissions` method."},"SetIamPolicyRequest":{"title":"SetIamPolicyRequest","type":"object","properties":{"policy":{"allOf":[{"$ref":"#/components/schemas/Policy"},{"description":"An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { \"bindings\": [ { \"role\": \"roles/resourcemanager.organizationAdmin\", \"members\": [ \"user:mike@example.com\", \"group:admins@example.com\", \"domain:google.com\", \"serviceAccount:my-project-id@appspot.gserviceaccount.com\" ] }, { \"role\": \"roles/resourcemanager.organizationViewer\", \"members\": [ \"user:eve@example.com\" ], \"condition\": { \"title\": \"expirable access\", \"description\": \"Does not grant access after Sep 2020\", \"expression\": \"request.time < timestamp('2020-10-01T00:00:00.000Z')\", } } ], \"etag\": \"BwWWja0YfJA=\", \"version\": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/)."}]}},"description":"Request message for `SetIamPolicy` method."},"Expr":{"title":"Expr","type":"object","properties":{"description":{"type":"string","description":"Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI."},"title":{"type":"string","description":"Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression."},"location":{"type":"string","description":"Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file."},"expression":{"type":"string","description":"Textual representation of an expression in Common Expression Language syntax."}},"description":"Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: \"Summary size limit\" description: \"Determines if a summary is less than 100 chars\" expression: \"document.summary.size() < 100\" Example (Equality): title: \"Requestor is owner\" description: \"Determines if requestor is the document owner\" expression: \"document.owner == request.auth.claims.email\" Example (Logic): title: \"Public documents\" description: \"Determine whether the document should be publicly visible\" expression: \"document.type != 'private' && document.type != 'internal'\" Example (Data Manipulation): title: \"Notification string\" description: \"Create a notification string with a timestamp.\" expression: \"'New message received at ' + string(document.create_time)\" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information."},"Artifact":{"title":"Artifact","type":"object","properties":{"updateTime":{"type":"string","description":"Output only. Last update timestamp."},"createTime":{"type":"string","description":"Output only. Creation timestamp."},"sizeBytes":{"type":"integer","description":"Output only. The size of the artifact in bytes. If the artifact is gzipped, this is the size of the uncompressed artifact.","contentEncoding":"int32"},"contents":{"type":"string","description":"Input only. The contents of the artifact. Provided by API callers when artifacts are created or replaced. To access the contents of an artifact, use GetArtifactContents."},"hash":{"type":"string","description":"Output only. A SHA-256 hash of the artifact's contents. If the artifact is gzipped, this is the hash of the uncompressed artifact."},"mimeType":{"type":"string","description":"A content type specifier for the artifact. Content type specifiers are Media Types (https://en.wikipedia.org/wiki/Media_type) with a possible \"schema\" parameter that specifies a schema for the stored information. Content types can specify compression. Currently only GZip compression is supported (indicated with \"+gzip\")."},"name":{"type":"string","description":"Resource name."}},"description":"Artifacts of resources. Artifacts are unique (single-value) per resource and are used to store metadata that is too large or numerous to be stored directly on the resource. Since artifacts are stored separately from parent resources, they should generally be used for metadata that is needed infrequently, i.e., not for display in primary views of the resource but perhaps displayed or downloaded upon request. The `ListArtifacts` method allows artifacts to be quickly enumerated and checked for presence without downloading their (potentially-large) contents."},"Instance":{"title":"Instance","type":"object","properties":{"stateMessage":{"type":"string","description":"Output only. Extra information of Instance.State if the state is `FAILED`."},"name":{"type":"string","description":"Format: `projects/*/locations/*/instance`. Currently only `locations/global` is supported."},"createTime":{"type":"string","description":"Output only. Creation timestamp."},"state":{"allOf":[{"$ref":"#/components/schemas/State"},{"description":"Output only. The current state of the Instance."}]},"updateTime":{"type":"string","description":"Output only. Last update timestamp."},"config":{"allOf":[{"$ref":"#/components/schemas/Config"},{"description":"Available configurations to provision an Instance."}]}},"description":"An Instance represents the instance resources of the Registry. Currently, only one instance is allowed for each project."},"OperationMetadata":{"title":"OperationMetadata","type":"object","properties":{"target":{"type":"string","description":"Server-defined resource path for the target of the operation."},"statusMessage":{"type":"string","description":"Human-readable status of the operation, if any."},"verb":{"type":"string","description":"Name of the verb executed by the operation."},"cancellationRequested":{"type":"boolean","description":"Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`."},"endTime":{"type":"string","description":"The time the operation finished running."},"apiVersion":{"type":"string","description":"API version used to start the operation."},"createTime":{"type":"string","description":"The time the operation was created."}},"description":"Represents the metadata of the long-running operation."},"ApiSpec":{"title":"ApiSpec","type":"object","properties":{"revisionUpdateTime":{"type":"string","description":"Output only. Last update timestamp: when the represented revision was last modified."},"filename":{"type":"string","description":"A possibly-hierarchical name used to refer to the spec from other specs."},"name":{"type":"string","description":"Resource name."},"createTime":{"type":"string","description":"Output only. Creation timestamp; when the spec resource was created."},"description":{"type":"string","description":"A detailed description."},"revisionId":{"type":"string","description":"Output only. Immutable. The revision ID of the spec. A new revision is committed whenever the spec contents are changed. The format is an 8-character hexadecimal string."},"revisionCreateTime":{"type":"string","description":"Output only. Revision creation timestamp; when the represented revision was created."},"mimeType":{"type":"string","description":"A style (format) descriptor for this spec that is specified as a Media Type (https://en.wikipedia.org/wiki/Media_type). Possible values include `application/vnd.apigee.proto`, `application/vnd.apigee.openapi`, and `application/vnd.apigee.graphql`, with possible suffixes representing compression types. These hypothetical names are defined in the vendor tree defined in RFC6838 (https://tools.ietf.org/html/rfc6838) and are not final. Content types can specify compression. Currently only GZip compression is supported (indicated with \"+gzip\")."},"labels":{"type":"object","additionalProperties":{"type":"string"},"description":"Labels attach identifying metadata to resources. Identifying metadata can be used to filter list operations. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one resource (System labels are excluded). See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with `apigeeregistry.googleapis.com/` and cannot be changed."},"sourceUri":{"type":"string","description":"The original source URI of the spec (if one exists). This is an external location that can be used for reference purposes but which may not be authoritative since this external resource may change after the spec is retrieved."},"hash":{"type":"string","description":"Output only. A SHA-256 hash of the spec's contents. If the spec is gzipped, this is the hash of the uncompressed spec."},"contents":{"type":"string","description":"Input only. The contents of the spec. Provided by API callers when specs are created or updated. To access the contents of a spec, use GetApiSpecContents."},"sizeBytes":{"type":"integer","description":"Output only. The size of the spec file in bytes. If the spec is gzipped, this is the size of the uncompressed spec.","contentEncoding":"int32"},"annotations":{"type":"object","additionalProperties":{"type":"string"},"description":"Annotations attach non-identifying metadata to resources. Annotation keys and values are less restricted than those of labels, but should be generally used for small values of broad interest. Larger, topic- specific metadata should be stored in Artifacts."}},"description":"Describes a version of an API in a structured way. ApiSpecs provide formal descriptions that consumers can use to use a version. ApiSpec resources are intended to be fully-resolved descriptions of an ApiVersion. When specs consist of multiple files, these should be bundled together (e.g., in a zip archive) and stored as a unit. Multiple specs can exist to provide representations in different API description formats. Synchronization of these representations would be provided by tooling and background services."},"HttpBody":{"title":"HttpBody","type":"object","properties":{"data":{"type":"string","description":"The HTTP request/response body as raw binary."},"extensions":{"type":"array","items":{},"description":"Application specific response metadata. Must be set in the first response for streaming APIs."},"contentType":{"type":"string","description":"The HTTP Content-Type header value specifying the content type of the body."}},"description":"Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page. This message can be used both in streaming and non-streaming API methods in the request as well as the response. It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body. Example: message GetResourceRequest { // A unique request id. string request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; } service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } Example with streaming methods: service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); } Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged."},"RollbackApiSpecRequest":{"title":"RollbackApiSpecRequest","type":"object","properties":{"revisionId":{"type":"string","description":"Required. The revision ID to roll back to. It must be a revision of the same spec. Example: `c7cfa2a8`"}},"description":"Request message for RollbackApiSpec."},"ApiDeployment":{"title":"ApiDeployment","type":"object","properties":{"accessGuidance":{"type":"string","description":"Text briefly describing how to access the endpoint. Changes to this value will not affect the revision."},"createTime":{"type":"string","description":"Output only. Creation timestamp; when the deployment resource was created."},"revisionCreateTime":{"type":"string","description":"Output only. Revision creation timestamp; when the represented revision was created."},"description":{"type":"string","description":"A detailed description."},"labels":{"type":"object","additionalProperties":{"type":"string"},"description":"Labels attach identifying metadata to resources. Identifying metadata can be used to filter list operations. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one resource (System labels are excluded). See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with `apigeeregistry.googleapis.com/` and cannot be changed."},"endpointUri":{"type":"string","description":"The address where the deployment is serving. Changes to this value will update the revision."},"revisionId":{"type":"string","description":"Output only. Immutable. The revision ID of the deployment. A new revision is committed whenever the deployment contents are changed. The format is an 8-character hexadecimal string."},"annotations":{"type":"object","additionalProperties":{"type":"string"},"description":"Annotations attach non-identifying metadata to resources. Annotation keys and values are less restricted than those of labels, but should be generally used for small values of broad interest. Larger, topic- specific metadata should be stored in Artifacts."},"externalChannelUri":{"type":"string","description":"The address of the external channel of the API (e.g., the Developer Portal). Changes to this value will not affect the revision."},"revisionUpdateTime":{"type":"string","description":"Output only. Last update timestamp: when the represented revision was last modified."},"intendedAudience":{"type":"string","description":"Text briefly identifying the intended audience of the API. Changes to this value will not affect the revision."},"apiSpecRevision":{"type":"string","description":"The full resource name (including revision ID) of the spec of the API being served by the deployment. Changes to this value will update the revision. Format: `apis/{api}/deployments/{deployment}`"},"name":{"type":"string","description":"Resource name."},"displayName":{"type":"string","description":"Human-meaningful name."}},"description":"Describes a service running at particular address that provides a particular version of an API. ApiDeployments have revisions which correspond to different configurations of a single deployment in time. Revision identifiers should be updated whenever the served API spec or endpoint address changes."},"ListOperationsResponse":{"title":"ListOperationsResponse","type":"object","properties":{"operations":{"type":"array","items":{"$ref":"#/components/schemas/Operation"},"description":"A list of operations that matches the specified filter in the request."},"nextPageToken":{"type":"string","description":"The standard List next-page token."}},"description":"The response message for Operations.ListOperations."},"Operation":{"title":"Operation","type":"object","properties":{"name":{"type":"string","description":"The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`."},"metadata":{"type":"object","additionalProperties":{},"description":"Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any."},"error":{"description":"The error result of the operation in case of failure or cancellation."},"done":{"type":"boolean","description":"If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available."},"response":{"type":"object","additionalProperties":{},"description":"The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`."}},"description":"This resource represents a long-running operation that is the result of a network API call."},"Binding":{"title":"Binding","type":"object","properties":{"condition":{"allOf":[{"$ref":"#/components/schemas/Expr"},{"description":"Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: \"Summary size limit\" description: \"Determines if a summary is less than 100 chars\" expression: \"document.summary.size() < 100\" Example (Equality): title: \"Requestor is owner\" description: \"Determines if requestor is the document owner\" expression: \"document.owner == request.auth.claims.email\" Example (Logic): title: \"Public documents\" description: \"Determine whether the document should be publicly visible\" expression: \"document.type != 'private' && document.type != 'internal'\" Example (Data Manipulation): title: \"Notification string\" description: \"Create a notification string with a timestamp.\" expression: \"'New message received at ' + string(document.create_time)\" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information."}]},"members":{"type":"array","items":{"type":"string"},"description":"Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`."},"role":{"type":"string","description":"Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`."}},"description":"Associates `members`, or principals, with a `role`."},"Policy":{"title":"Policy","type":"object","properties":{"bindings":{"type":"array","items":{},"description":"Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`."},"version":{"type":"integer","description":"Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).","contentEncoding":"int32"},"etag":{"type":"string","description":"`etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost."}},"description":"An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { \"bindings\": [ { \"role\": \"roles/resourcemanager.organizationAdmin\", \"members\": [ \"user:mike@example.com\", \"group:admins@example.com\", \"domain:google.com\", \"serviceAccount:my-project-id@appspot.gserviceaccount.com\" ] }, { \"role\": \"roles/resourcemanager.organizationViewer\", \"members\": [ \"user:eve@example.com\" ], \"condition\": { \"title\": \"expirable access\", \"description\": \"Does not grant access after Sep 2020\", \"expression\": \"request.time < timestamp('2020-10-01T00:00:00.000Z')\", } } ], \"etag\": \"BwWWja0YfJA=\", \"version\": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/)."},"ListApiDeploymentsResponse":{"title":"ListApiDeploymentsResponse","type":"object","properties":{"apiDeployments":{"type":"array","items":{"$ref":"#/components/schemas/ApiDeployment"},"description":"The deployments from the specified publisher."},"nextPageToken":{"type":"string","description":"A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages."}},"description":"Response message for ListApiDeployments."},"Location":{"title":"Location","type":"object","properties":{"displayName":{"type":"string","description":"The friendly name for this location, typically a nearby city name. For example, \"Tokyo\"."},"locationId":{"type":"string","description":"The canonical id for this location. For example: `\"us-east1\"`."},"labels":{"type":"object","additionalProperties":{"type":"string"},"description":"Cross-service attributes for the location. For example {\"cloud.googleapis.com/region\": \"us-east1\"}"},"name":{"type":"string","description":"Resource name for the location, which may vary between implementations. For example: `\"projects/example-project/locations/us-east1\"`"},"metadata":{"type":"object","additionalProperties":{},"description":"Service-specific metadata. For example the available capacity at the given location."}},"description":"A resource that represents Google Cloud Platform location."},"Status":{"title":"Status","type":"object","properties":{"details":{"type":"array","items":{},"description":"A list of messages that carry the error details. There is a common set of message types for APIs to use."},"code":{"type":"integer","description":"The status code, which should be an enum value of google.rpc.Code.","contentEncoding":"int32"},"message":{"type":"string","description":"A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client."}},"description":"The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors)."},"ListApisResponse":{"title":"ListApisResponse","type":"object","properties":{"apis":{"type":"array","items":{"$ref":"#/components/schemas/Api"},"description":"The APIs from the specified publisher."},"nextPageToken":{"type":"string","description":"A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages."}},"description":"Response message for ListApis."},"RollbackApiDeploymentRequest":{"title":"RollbackApiDeploymentRequest","type":"object","properties":{"revisionId":{"type":"string","description":"Required. The revision ID to roll back to. It must be a revision of the same deployment. Example: `c7cfa2a8`"}},"description":"Request message for RollbackApiDeployment."},"ListApiDeploymentRevisionsResponse":{"title":"ListApiDeploymentRevisionsResponse","type":"object","properties":{"nextPageToken":{"type":"string","description":"A token that can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages."},"apiDeployments":{"type":"array","items":{"$ref":"#/components/schemas/ApiDeployment"},"description":"The revisions of the deployment."}},"description":"Response message for ListApiDeploymentRevisionsResponse."},"ListApiSpecRevisionsResponse":{"title":"ListApiSpecRevisionsResponse","type":"object","properties":{"nextPageToken":{"type":"string","description":"A token that can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages."},"apiSpecs":{"type":"array","items":{"$ref":"#/components/schemas/ApiSpec"},"description":"The revisions of the spec."}},"description":"Response message for ListApiSpecRevisionsResponse."},"Config":{"title":"Config","type":"object","properties":{"location":{"type":"string","description":"Output only. The GCP location where the Instance resides."},"cmekKeyName":{"type":"string","description":"Required. The Customer Managed Encryption Key (CMEK) used for data encryption. The CMEK name should follow the format of `projects/([^/]+)/locations/([^/]+)/keyRings/([^/]+)/cryptoKeys/([^/]+)`, where the `location` must match InstanceConfig.location."}},"description":"Available configurations to provision an Instance."},"ListArtifactsResponse":{"title":"ListArtifactsResponse","type":"object","properties":{"artifacts":{"type":"array","items":{"$ref":"#/components/schemas/Artifact"},"description":"The artifacts from the specified publisher."},"nextPageToken":{"type":"string","description":"A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages."}},"description":"Response message for ListArtifacts."},"ListApiSpecsResponse":{"title":"ListApiSpecsResponse","type":"object","properties":{"nextPageToken":{"type":"string","description":"A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages."},"apiSpecs":{"type":"array","items":{"$ref":"#/components/schemas/ApiSpec"},"description":"The specs from the specified publisher."}},"description":"Response message for ListApiSpecs."},"TestIamPermissionsRequest":{"title":"TestIamPermissionsRequest","type":"object","properties":{"permissions":{"type":"array","items":{"type":"string"},"description":"The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions)."}},"description":"Request message for `TestIamPermissions` method."},"State":{"title":"State","enum":["STATE_UNSPECIFIED","INACTIVE","CREATING","ACTIVE","UPDATING","DELETING","FAILED"],"type":"string","description":"Output only. The current state of the Instance."}},"securitySchemes":{"httpBearer":{"type":"http","scheme":"bearer"}}},"security":[{"httpBearer":[]}],"tags":[{"name":"artifacts","description":""},{"name":"runtime","description":""},{"name":"deployments","description":""},{"name":"specs","description":""},{"name":"versions","description":""},{"name":"apis","description":""},{"name":"instances","description":""},{"name":"operations","description":""},{"name":"locations","description":""}]}
/ v1 / {resource}:getIamPolicy
/ v1 / {name}
/ v1 / {resource}:setIamPolicy
/ v1 / {name}:getContents
/ v1 / {parent} / artifacts
/ v1 / {resource}:testIamPermissions
/ v1 / {parent} / deployments
/ v1 / {name}:listRevisions
/ v1 / {name}:deleteRevision
/ v1 / {name}:rollback
/ v1 / {name}:tagRevision
/ v1 / {parent} / specs
/ v1 / {parent} / versions
/ v1 / {parent} / apis
/ v1 / {parent} / instances
/ v1 / {name} / operations
/ v1 / {name}:cancel
/ v1 / {name} / locations
Apigee API OpenAPI	{"openapi":"3.1.0","info":{"title":"Apigee API","description":"Use the Apigee API to programmatically develop and manage APIs with a set of RESTful operations. Develop and secure API proxies, deploy and undeploy API proxy revisions, monitor APIs, configure environments, manage users, and more. Note: This product is available as a free trial for a time period of 60 days.","contact":{},"version":"v1"},"jsonSchemaDialect":"https://json-schema.org/draft/2020-12/schema","servers":[{"url":"https://apigee.googleapis.com/","variables":{}}],"paths":{"/v1/{project}:provisionOrganization":{"post":{"tags":["projects"],"summary":"ProvisionOrganizationV1ProvisionOrganizationByProject","description":"Provisions a new Apigee organization with a functioning runtime. This is the standard way to create trial organizations for a free Apigee trial.","operationId":"ProvisionOrganizationV1ProvisionOrganizationByProject","parameters":[{"name":"callback","in":"query","description":"JSONP","style":"form","explode":true,"schema":{"type":"string"}},{"name":"key","in":"query","description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"alt","in":"query","description":"Data format for response. (Acceptable values are: \"json\", \"media\", \"proto\")","style":"form","explode":true,"schema":{"type":"string","default":"json"}},{"name":"uploadType","in":"query","description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"upload_protocol","in":"query","description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"Selector specifying which fields to include in a partial response.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"access_token","in":"query","description":"OAuth access token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"$.xgafv","in":"query","description":"V1 error format. (Acceptable values are: \"1\", \"2\")","style":"form","explode":true,"schema":{"type":"string","default":"1"}},{"name":"quotaUser","in":"query","description":"Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"prettyPrint","in":"query","description":"Returns response with indentations and line breaks.","style":"form","explode":true,"schema":{"type":"boolean","default":true}},{"name":"oauth_token","in":"query","description":"OAuth 2.0 token for the current user.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"project","in":"path","description":"Required. Name of the GCP project with which to associate the Apigee organization.","required":true,"style":"simple","schema":{"pattern":"^projects/[^/]+$","type":"string"}}],"requestBody":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudApigeeV1ProvisionOrganizationRequest"}}},"required":true},"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleLongrunningOperation"}}}}},"deprecated":false,"security":[{"httpBearer":["https://www.googleapis.com/auth/cloud-platform"]}]},"parameters":[]},"/v1/{name}":{"get":{"tags":["issuers"],"summary":"ListV1ByName","description":"Lists hybrid services and its trusted issuers service account ids. This api is authenticated and unauthorized(allow all the users) and used by runtime authn-authz service to query control plane's issuer service account ids.","operationId":"ListV1ByName","parameters":[{"name":"callback","in":"query","description":"JSONP","style":"form","explode":true,"schema":{"type":"string"}},{"name":"key","in":"query","description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"alt","in":"query","description":"Data format for response. (Acceptable values are: \"json\", \"media\", \"proto\")","style":"form","explode":true,"schema":{"type":"string","default":"json"}},{"name":"uploadType","in":"query","description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"upload_protocol","in":"query","description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"Selector specifying which fields to include in a partial response.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"access_token","in":"query","description":"OAuth access token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"$.xgafv","in":"query","description":"V1 error format. (Acceptable values are: \"1\", \"2\")","style":"form","explode":true,"schema":{"type":"string","default":"1"}},{"name":"quotaUser","in":"query","description":"Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"prettyPrint","in":"query","description":"Returns response with indentations and line breaks.","style":"form","explode":true,"schema":{"type":"boolean","default":true}},{"name":"oauth_token","in":"query","description":"OAuth 2.0 token for the current user.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"name","in":"path","description":"Required. Must be of the form `hybrid/issuers`.","required":true,"style":"simple","schema":{"pattern":"^hybrid/issuers$","type":"string"}}],"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudApigeeV1ListHybridIssuersResponse"}}}}},"deprecated":false,"security":[{"httpBearer":["https://www.googleapis.com/auth/cloud-platform"]}]},"delete":{"tags":["attachments"],"summary":"DeleteV1ByName","description":"Deletes an environment group attachment.","operationId":"DeleteV1ByName","parameters":[{"name":"callback","in":"query","description":"JSONP","style":"form","explode":true,"schema":{"type":"string"}},{"name":"key","in":"query","description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"alt","in":"query","description":"Data format for response. (Acceptable values are: \"json\", \"media\", \"proto\")","style":"form","explode":true,"schema":{"type":"string","default":"json"}},{"name":"uploadType","in":"query","description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"upload_protocol","in":"query","description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"Selector specifying which fields to include in a partial response.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"access_token","in":"query","description":"OAuth access token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"$.xgafv","in":"query","description":"V1 error format. (Acceptable values are: \"1\", \"2\")","style":"form","explode":true,"schema":{"type":"string","default":"1"}},{"name":"quotaUser","in":"query","description":"Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"prettyPrint","in":"query","description":"Returns response with indentations and line breaks.","style":"form","explode":true,"schema":{"type":"boolean","default":true}},{"name":"oauth_token","in":"query","description":"OAuth 2.0 token for the current user.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"name","in":"path","description":"Required. Name of the environment group attachment to delete in the following format: `organizations/{org}/envgroups/{envgroup}/attachments/{attachment}`.","required":true,"style":"simple","schema":{"pattern":"^organizations/[^/]+/envgroups/[^/]+/attachments/[^/]+$","type":"string"}}],"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleLongrunningOperation"}}}}},"deprecated":false,"security":[{"httpBearer":["https://www.googleapis.com/auth/cloud-platform"]}]},"patch":{"tags":["envgroups"],"summary":"PatchV1ByName","description":"Updates an environment group.","operationId":"PatchV1ByName","parameters":[{"name":"callback","in":"query","description":"JSONP","style":"form","explode":true,"schema":{"type":"string"}},{"name":"key","in":"query","description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"alt","in":"query","description":"Data format for response. (Acceptable values are: \"json\", \"media\", \"proto\")","style":"form","explode":true,"schema":{"type":"string","default":"json"}},{"name":"uploadType","in":"query","description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"upload_protocol","in":"query","description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"Selector specifying which fields to include in a partial response.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"access_token","in":"query","description":"OAuth access token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"$.xgafv","in":"query","description":"V1 error format. (Acceptable values are: \"1\", \"2\")","style":"form","explode":true,"schema":{"type":"string","default":"1"}},{"name":"quotaUser","in":"query","description":"Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"prettyPrint","in":"query","description":"Returns response with indentations and line breaks.","style":"form","explode":true,"schema":{"type":"boolean","default":true}},{"name":"oauth_token","in":"query","description":"OAuth 2.0 token for the current user.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"name","in":"path","description":"Required. Name of the environment group to update in the format: `organizations/{org}/envgroups/{envgroup}.","required":true,"style":"simple","schema":{"pattern":"^organizations/[^/]+/envgroups/[^/]+$","type":"string"}},{"name":"updateMask","in":"query","description":"List of fields to be updated.","style":"form","explode":true,"schema":{"type":"string"}}],"requestBody":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudApigeeV1EnvironmentGroup"}}},"required":true},"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleLongrunningOperation"}}}}},"deprecated":false,"security":[{"httpBearer":["https://www.googleapis.com/auth/cloud-platform"]}]},"post":{"tags":["attributes"],"summary":"UpdateDeveloperAttributeV1ByName","description":"Updates a developer attribute. **Note**: OAuth access tokens and Key Management Service (KMS) entities (apps, developers, and API products) are cached for 180 seconds (default). Any custom attributes associated with these entities are cached for at least 180 seconds after the entity is accessed at runtime. Therefore, an `ExpiresIn` element on the OAuthV2 policy won't be able to expire an access token in less than 180 seconds.","operationId":"UpdateDeveloperAttributeV1ByName","parameters":[{"name":"callback","in":"query","description":"JSONP","style":"form","explode":true,"schema":{"type":"string"}},{"name":"key","in":"query","description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"alt","in":"query","description":"Data format for response. (Acceptable values are: \"json\", \"media\", \"proto\")","style":"form","explode":true,"schema":{"type":"string","default":"json"}},{"name":"uploadType","in":"query","description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"upload_protocol","in":"query","description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"Selector specifying which fields to include in a partial response.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"access_token","in":"query","description":"OAuth access token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"$.xgafv","in":"query","description":"V1 error format. (Acceptable values are: \"1\", \"2\")","style":"form","explode":true,"schema":{"type":"string","default":"1"}},{"name":"quotaUser","in":"query","description":"Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"prettyPrint","in":"query","description":"Returns response with indentations and line breaks.","style":"form","explode":true,"schema":{"type":"boolean","default":true}},{"name":"oauth_token","in":"query","description":"OAuth 2.0 token for the current user.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"name","in":"path","description":"Required. Name of the developer attribute. Use the following structure in your request: `organizations/{org}/developers/{developer_email}/attributes/{attribute}`","required":true,"style":"simple","schema":{"pattern":"^organizations/[^/]+/developers/[^/]+/attributes/[^/]+$","type":"string"}}],"requestBody":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudApigeeV1Attribute"}}},"required":true},"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudApigeeV1Attribute"}}}}},"deprecated":false,"security":[{"httpBearer":["https://www.googleapis.com/auth/cloud-platform"]}]},"put":{"tags":["apiproducts"],"summary":"UpdateV1ByName","description":"Updates an existing API product. You must include all required values, whether or not you are updating them, as well as any optional values that you are updating. The API product name required in the request URL is the internal name of the product, not the display name. While they may be the same, it depends on whether the API product was created via UI or API. View the list of API products to identify their internal names.","operationId":"UpdateV1ByName","parameters":[{"name":"callback","in":"query","description":"JSONP","style":"form","explode":true,"schema":{"type":"string"}},{"name":"key","in":"query","description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"alt","in":"query","description":"Data format for response. (Acceptable values are: \"json\", \"media\", \"proto\")","style":"form","explode":true,"schema":{"type":"string","default":"json"}},{"name":"uploadType","in":"query","description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"upload_protocol","in":"query","description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"Selector specifying which fields to include in a partial response.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"access_token","in":"query","description":"OAuth access token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"$.xgafv","in":"query","description":"V1 error format. (Acceptable values are: \"1\", \"2\")","style":"form","explode":true,"schema":{"type":"string","default":"1"}},{"name":"quotaUser","in":"query","description":"Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"prettyPrint","in":"query","description":"Returns response with indentations and line breaks.","style":"form","explode":true,"schema":{"type":"boolean","default":true}},{"name":"oauth_token","in":"query","description":"OAuth 2.0 token for the current user.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"name","in":"path","description":"Required. Name of the API product. Use the following structure in your request: `organizations/{org}/apiproducts/{apiproduct}`","required":true,"style":"simple","schema":{"pattern":"^organizations/[^/]+/apiproducts/[^/]+$","type":"string"}}],"requestBody":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudApigeeV1ApiProduct"}}},"required":true},"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudApigeeV1ApiProduct"}}}}},"deprecated":false,"security":[{"httpBearer":["https://www.googleapis.com/auth/cloud-platform"]}]},"parameters":[]},"/v1/{parent}/attachments":{"get":{"tags":["attachments"],"summary":"ListV1AttachmentsByParent","description":"Lists all attachments of an environment group.","operationId":"ListV1AttachmentsByParent","parameters":[{"name":"callback","in":"query","description":"JSONP","style":"form","explode":true,"schema":{"type":"string"}},{"name":"key","in":"query","description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"alt","in":"query","description":"Data format for response. (Acceptable values are: \"json\", \"media\", \"proto\")","style":"form","explode":true,"schema":{"type":"string","default":"json"}},{"name":"uploadType","in":"query","description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"upload_protocol","in":"query","description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"Selector specifying which fields to include in a partial response.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"access_token","in":"query","description":"OAuth access token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"$.xgafv","in":"query","description":"V1 error format. (Acceptable values are: \"1\", \"2\")","style":"form","explode":true,"schema":{"type":"string","default":"1"}},{"name":"quotaUser","in":"query","description":"Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"prettyPrint","in":"query","description":"Returns response with indentations and line breaks.","style":"form","explode":true,"schema":{"type":"boolean","default":true}},{"name":"oauth_token","in":"query","description":"OAuth 2.0 token for the current user.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"pageToken","in":"query","description":"Page token, returned by a previous ListEnvironmentGroupAttachments call, that you can use to retrieve the next page.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"pageSize","in":"query","description":"Maximum number of environment group attachments to return. The page size defaults to 25.","style":"form","explode":true,"schema":{"type":"integer","contentEncoding":"int32"}},{"name":"parent","in":"path","description":"Required. Name of the environment group in the following format: `organizations/{org}/envgroups/{envgroup}`.","required":true,"style":"simple","schema":{"pattern":"^organizations/[^/]+/envgroups/[^/]+$","type":"string"}}],"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudApigeeV1ListEnvironmentGroupAttachmentsResponse"}}}}},"deprecated":false,"security":[{"httpBearer":["https://www.googleapis.com/auth/cloud-platform"]}]},"post":{"tags":["attachments"],"summary":"CreateV1AttachmentsByParent","description":"Creates a new attachment of an environment to an environment group.","operationId":"CreateV1AttachmentsByParent","parameters":[{"name":"callback","in":"query","description":"JSONP","style":"form","explode":true,"schema":{"type":"string"}},{"name":"key","in":"query","description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"alt","in":"query","description":"Data format for response. (Acceptable values are: \"json\", \"media\", \"proto\")","style":"form","explode":true,"schema":{"type":"string","default":"json"}},{"name":"uploadType","in":"query","description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"upload_protocol","in":"query","description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"Selector specifying which fields to include in a partial response.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"access_token","in":"query","description":"OAuth access token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"$.xgafv","in":"query","description":"V1 error format. (Acceptable values are: \"1\", \"2\")","style":"form","explode":true,"schema":{"type":"string","default":"1"}},{"name":"quotaUser","in":"query","description":"Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"prettyPrint","in":"query","description":"Returns response with indentations and line breaks.","style":"form","explode":true,"schema":{"type":"boolean","default":true}},{"name":"oauth_token","in":"query","description":"OAuth 2.0 token for the current user.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"parent","in":"path","description":"Required. EnvironmentGroup under which to create the attachment in the following format: `organizations/{org}/envgroups/{envgroup}`.","required":true,"style":"simple","schema":{"pattern":"^organizations/[^/]+/envgroups/[^/]+$","type":"string"}}],"requestBody":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudApigeeV1EnvironmentGroupAttachment"}}},"required":true},"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleLongrunningOperation"}}}}},"deprecated":false,"security":[{"httpBearer":["https://www.googleapis.com/auth/cloud-platform"]}]},"parameters":[]},"/v1/{parent}/envgroups":{"post":{"tags":["envgroups"],"summary":"CreateV1EnvgroupsByParent","description":"Creates a new environment group.","operationId":"CreateV1EnvgroupsByParent","parameters":[{"name":"callback","in":"query","description":"JSONP","style":"form","explode":true,"schema":{"type":"string"}},{"name":"key","in":"query","description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"alt","in":"query","description":"Data format for response. (Acceptable values are: \"json\", \"media\", \"proto\")","style":"form","explode":true,"schema":{"type":"string","default":"json"}},{"name":"uploadType","in":"query","description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"upload_protocol","in":"query","description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"Selector specifying which fields to include in a partial response.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"access_token","in":"query","description":"OAuth access token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"$.xgafv","in":"query","description":"V1 error format. (Acceptable values are: \"1\", \"2\")","style":"form","explode":true,"schema":{"type":"string","default":"1"}},{"name":"quotaUser","in":"query","description":"Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"prettyPrint","in":"query","description":"Returns response with indentations and line breaks.","style":"form","explode":true,"schema":{"type":"boolean","default":true}},{"name":"oauth_token","in":"query","description":"OAuth 2.0 token for the current user.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"parent","in":"path","description":"Required. Name of the organization in which to create the environment group in the following format: `organizations/{org}`.","required":true,"style":"simple","schema":{"pattern":"^organizations/[^/]+$","type":"string"}},{"name":"name","in":"query","description":"ID of the environment group. Overrides any ID in the environment_group resource.","style":"form","explode":true,"schema":{"type":"string"}}],"requestBody":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudApigeeV1EnvironmentGroup"}}},"required":true},"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleLongrunningOperation"}}}}},"deprecated":false,"security":[{"httpBearer":["https://www.googleapis.com/auth/cloud-platform"]}]},"get":{"tags":["envgroups"],"summary":"ListV1EnvgroupsByParent","description":"Lists all environment groups.","operationId":"ListV1EnvgroupsByParent","parameters":[{"name":"callback","in":"query","description":"JSONP","style":"form","explode":true,"schema":{"type":"string"}},{"name":"key","in":"query","description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"alt","in":"query","description":"Data format for response. (Acceptable values are: \"json\", \"media\", \"proto\")","style":"form","explode":true,"schema":{"type":"string","default":"json"}},{"name":"uploadType","in":"query","description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"upload_protocol","in":"query","description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"Selector specifying which fields to include in a partial response.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"access_token","in":"query","description":"OAuth access token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"$.xgafv","in":"query","description":"V1 error format. (Acceptable values are: \"1\", \"2\")","style":"form","explode":true,"schema":{"type":"string","default":"1"}},{"name":"quotaUser","in":"query","description":"Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"prettyPrint","in":"query","description":"Returns response with indentations and line breaks.","style":"form","explode":true,"schema":{"type":"boolean","default":true}},{"name":"oauth_token","in":"query","description":"OAuth 2.0 token for the current user.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"pageToken","in":"query","description":"Page token, returned from a previous ListEnvironmentGroups call, that you can use to retrieve the next page.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"parent","in":"path","description":"Required. Name of the organization for which to list environment groups in the following format: `organizations/{org}`.","required":true,"style":"simple","schema":{"pattern":"^organizations/[^/]+$","type":"string"}},{"name":"pageSize","in":"query","description":"Maximum number of environment groups to return. The page size defaults to 25.","style":"form","explode":true,"schema":{"type":"integer","contentEncoding":"int32"}}],"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudApigeeV1ListEnvironmentGroupsResponse"}}}}},"deprecated":false,"security":[{"httpBearer":["https://www.googleapis.com/auth/cloud-platform"]}]},"parameters":[]},"/v1/{parent}/hostQueries":{"get":{"tags":["hostQueries"],"summary":"ListV1HostQueriesByParent","description":"Return a list of Asynchronous Queries at host level.","operationId":"ListV1HostQueriesByParent","parameters":[{"name":"callback","in":"query","description":"JSONP","style":"form","explode":true,"schema":{"type":"string"}},{"name":"key","in":"query","description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"alt","in":"query","description":"Data format for response. (Acceptable values are: \"json\", \"media\", \"proto\")","style":"form","explode":true,"schema":{"type":"string","default":"json"}},{"name":"uploadType","in":"query","description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"upload_protocol","in":"query","description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"Selector specifying which fields to include in a partial response.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"access_token","in":"query","description":"OAuth access token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"$.xgafv","in":"query","description":"V1 error format. (Acceptable values are: \"1\", \"2\")","style":"form","explode":true,"schema":{"type":"string","default":"1"}},{"name":"quotaUser","in":"query","description":"Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"prettyPrint","in":"query","description":"Returns response with indentations and line breaks.","style":"form","explode":true,"schema":{"type":"boolean","default":true}},{"name":"oauth_token","in":"query","description":"OAuth 2.0 token for the current user.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"dataset","in":"query","description":"Filter response list by dataset. Example: `api`, `mint`","style":"form","explode":true,"schema":{"type":"string"}},{"name":"submittedBy","in":"query","description":"Filter response list by user who submitted queries.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"inclQueriesWithoutReport","in":"query","description":"Flag to include asynchronous queries that don't have a report denifition.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"from","in":"query","description":"Filter response list by returning asynchronous queries that created after this date time. Time must be in ISO date-time format like '2011-12-03T10:15:30Z'.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"parent","in":"path","description":"Required. The parent resource name. Must be of the form `organizations/{org}`.","required":true,"style":"simple","schema":{"pattern":"^organizations/[^/]+$","type":"string"}},{"name":"envgroupHostname","in":"query","description":"Required. Filter response list by hostname.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"status","in":"query","description":"Filter response list by asynchronous query status.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"to","in":"query","description":"Filter response list by returning asynchronous queries that created before this date time. Time must be in ISO date-time format like '2011-12-03T10:16:30Z'.","style":"form","explode":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudApigeeV1ListAsyncQueriesResponse"}}}}},"deprecated":false,"security":[{"httpBearer":["https://www.googleapis.com/auth/cloud-platform"]}]},"post":{"tags":["hostQueries"],"summary":"CreateV1HostQueriesByParent","description":"Submit a query at host level to be processed in the background. If the submission of the query succeeds, the API returns a 201 status and an ID that refer to the query. In addition to the HTTP status 201, the `state` of \"enqueued\" means that the request succeeded.","operationId":"CreateV1HostQueriesByParent","parameters":[{"name":"callback","in":"query","description":"JSONP","style":"form","explode":true,"schema":{"type":"string"}},{"name":"key","in":"query","description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"alt","in":"query","description":"Data format for response. (Acceptable values are: \"json\", \"media\", \"proto\")","style":"form","explode":true,"schema":{"type":"string","default":"json"}},{"name":"uploadType","in":"query","description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"upload_protocol","in":"query","description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"Selector specifying which fields to include in a partial response.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"access_token","in":"query","description":"OAuth access token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"$.xgafv","in":"query","description":"V1 error format. (Acceptable values are: \"1\", \"2\")","style":"form","explode":true,"schema":{"type":"string","default":"1"}},{"name":"quotaUser","in":"query","description":"Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"prettyPrint","in":"query","description":"Returns response with indentations and line breaks.","style":"form","explode":true,"schema":{"type":"boolean","default":true}},{"name":"oauth_token","in":"query","description":"OAuth 2.0 token for the current user.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"parent","in":"path","description":"Required. The parent resource name. Must be of the form `organizations/{org}`.","required":true,"style":"simple","schema":{"pattern":"^organizations/[^/]+$","type":"string"}}],"requestBody":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudApigeeV1Query"}}},"required":true},"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudApigeeV1AsyncQuery"}}}}},"deprecated":false,"security":[{"httpBearer":["https://www.googleapis.com/auth/cloud-platform"]}]},"parameters":[]},"/v1/{parent}/apicategories":{"get":{"tags":["apicategories"],"summary":"ListV1ApicategoriesByParent","description":"Lists the categories on the portal.","operationId":"ListV1ApicategoriesByParent","parameters":[{"name":"callback","in":"query","description":"JSONP","style":"form","explode":true,"schema":{"type":"string"}},{"name":"key","in":"query","description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"alt","in":"query","description":"Data format for response. (Acceptable values are: \"json\", \"media\", \"proto\")","style":"form","explode":true,"schema":{"type":"string","default":"json"}},{"name":"uploadType","in":"query","description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"upload_protocol","in":"query","description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"Selector specifying which fields to include in a partial response.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"access_token","in":"query","description":"OAuth access token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"$.xgafv","in":"query","description":"V1 error format. (Acceptable values are: \"1\", \"2\")","style":"form","explode":true,"schema":{"type":"string","default":"1"}},{"name":"quotaUser","in":"query","description":"Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"prettyPrint","in":"query","description":"Returns response with indentations and line breaks.","style":"form","explode":true,"schema":{"type":"boolean","default":true}},{"name":"oauth_token","in":"query","description":"OAuth 2.0 token for the current user.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"parent","in":"path","description":"Required. Name of the portal. Use the following structure in your request: `organizations/{org}/sites/{site}`","required":true,"style":"simple","schema":{"pattern":"^organizations/[^/]+/sites/[^/]+$","type":"string"}}],"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudApigeeV1ListApiCategoriesResponse"}}}}},"deprecated":false,"security":[{"httpBearer":["https://www.googleapis.com/auth/cloud-platform"]}]},"post":{"tags":["apicategories"],"summary":"CreateV1ApicategoriesByParent","description":"Creates a new category on the portal.","operationId":"CreateV1ApicategoriesByParent","parameters":[{"name":"callback","in":"query","description":"JSONP","style":"form","explode":true,"schema":{"type":"string"}},{"name":"key","in":"query","description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"alt","in":"query","description":"Data format for response. (Acceptable values are: \"json\", \"media\", \"proto\")","style":"form","explode":true,"schema":{"type":"string","default":"json"}},{"name":"uploadType","in":"query","description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"upload_protocol","in":"query","description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"Selector specifying which fields to include in a partial response.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"access_token","in":"query","description":"OAuth access token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"$.xgafv","in":"query","description":"V1 error format. (Acceptable values are: \"1\", \"2\")","style":"form","explode":true,"schema":{"type":"string","default":"1"}},{"name":"quotaUser","in":"query","description":"Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"prettyPrint","in":"query","description":"Returns response with indentations and line breaks.","style":"form","explode":true,"schema":{"type":"boolean","default":true}},{"name":"oauth_token","in":"query","description":"OAuth 2.0 token for the current user.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"parent","in":"path","description":"Required. Name of the portal. Use the following structure in your request: `organizations/{org}/sites/{site}`","required":true,"style":"simple","schema":{"pattern":"^organizations/[^/]+/sites/[^/]+$","type":"string"}}],"requestBody":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudApigeeV1ApiCategoryData"}}},"required":true},"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudApigeeV1ApiCategory"}}}}},"deprecated":false,"security":[{"httpBearer":["https://www.googleapis.com/auth/cloud-platform"]}]},"parameters":[]},"/v1/{name}:credit":{"post":{"tags":["balance"],"summary":"CreditV1CreditByName","description":"Credits the account balance for the developer.","operationId":"CreditV1CreditByName","parameters":[{"name":"callback","in":"query","description":"JSONP","style":"form","explode":true,"schema":{"type":"string"}},{"name":"key","in":"query","description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"alt","in":"query","description":"Data format for response. (Acceptable values are: \"json\", \"media\", \"proto\")","style":"form","explode":true,"schema":{"type":"string","default":"json"}},{"name":"uploadType","in":"query","description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"upload_protocol","in":"query","description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"Selector specifying which fields to include in a partial response.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"access_token","in":"query","description":"OAuth access token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"$.xgafv","in":"query","description":"V1 error format. (Acceptable values are: \"1\", \"2\")","style":"form","explode":true,"schema":{"type":"string","default":"1"}},{"name":"quotaUser","in":"query","description":"Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"prettyPrint","in":"query","description":"Returns response with indentations and line breaks.","style":"form","explode":true,"schema":{"type":"boolean","default":true}},{"name":"oauth_token","in":"query","description":"OAuth 2.0 token for the current user.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"name","in":"path","description":"Required. Account balance for the developer. Use the following structure in your request: `organizations/{org}/developers/{developer}/balance`","required":true,"style":"simple","schema":{"pattern":"^organizations/[^/]+/developers/[^/]+/balance$","type":"string"}}],"requestBody":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudApigeeV1CreditDeveloperBalanceRequest"}}},"required":true},"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudApigeeV1DeveloperBalance"}}}}},"deprecated":false,"security":[{"httpBearer":["https://www.googleapis.com/auth/cloud-platform"]}]},"parameters":[]},"/v1/{name}:adjust":{"post":{"tags":["balance"],"summary":"AdjustV1AdjustByName","description":"Adjust the prepaid balance for the developer. This API will be used in scenarios where the developer has been under-charged or over-charged.","operationId":"AdjustV1AdjustByName","parameters":[{"name":"callback","in":"query","description":"JSONP","style":"form","explode":true,"schema":{"type":"string"}},{"name":"key","in":"query","description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"alt","in":"query","description":"Data format for response. (Acceptable values are: \"json\", \"media\", \"proto\")","style":"form","explode":true,"schema":{"type":"string","default":"json"}},{"name":"uploadType","in":"query","description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"upload_protocol","in":"query","description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"Selector specifying which fields to include in a partial response.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"access_token","in":"query","description":"OAuth access token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"$.xgafv","in":"query","description":"V1 error format. (Acceptable values are: \"1\", \"2\")","style":"form","explode":true,"schema":{"type":"string","default":"1"}},{"name":"quotaUser","in":"query","description":"Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"prettyPrint","in":"query","description":"Returns response with indentations and line breaks.","style":"form","explode":true,"schema":{"type":"boolean","default":true}},{"name":"oauth_token","in":"query","description":"OAuth 2.0 token for the current user.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"name","in":"path","description":"Required. Account balance for the developer. Use the following structure in your request: `organizations/{org}/developers/{developer}/balance`","required":true,"style":"simple","schema":{"pattern":"^organizations/[^/]+/developers/[^/]+/balance$","type":"string"}}],"requestBody":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudApigeeV1AdjustDeveloperBalanceRequest"}}},"required":true},"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudApigeeV1DeveloperBalance"}}}}},"deprecated":false,"security":[{"httpBearer":["https://www.googleapis.com/auth/cloud-platform"]}]},"parameters":[]},"/v1/{parent}/attributes":{"get":{"tags":["attributes"],"summary":"ListV1AttributesByParent","description":"Returns a list of all developer attributes.","operationId":"ListV1AttributesByParent","parameters":[{"name":"callback","in":"query","description":"JSONP","style":"form","explode":true,"schema":{"type":"string"}},{"name":"key","in":"query","description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"alt","in":"query","description":"Data format for response. (Acceptable values are: \"json\", \"media\", \"proto\")","style":"form","explode":true,"schema":{"type":"string","default":"json"}},{"name":"uploadType","in":"query","description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"upload_protocol","in":"query","description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"Selector specifying which fields to include in a partial response.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"access_token","in":"query","description":"OAuth access token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"$.xgafv","in":"query","description":"V1 error format. (Acceptable values are: \"1\", \"2\")","style":"form","explode":true,"schema":{"type":"string","default":"1"}},{"name":"quotaUser","in":"query","description":"Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"prettyPrint","in":"query","description":"Returns response with indentations and line breaks.","style":"form","explode":true,"schema":{"type":"boolean","default":true}},{"name":"oauth_token","in":"query","description":"OAuth 2.0 token for the current user.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"parent","in":"path","description":"Required. Email address of the developer for which attributes are being listed. Use the following structure in your request: `organizations/{org}/developers/{developer_email}`","required":true,"style":"simple","schema":{"pattern":"^organizations/[^/]+/developers/[^/]+$","type":"string"}}],"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudApigeeV1Attributes"}}}}},"deprecated":false,"security":[{"httpBearer":["https://www.googleapis.com/auth/cloud-platform"]}]},"post":{"tags":["developers"],"summary":"AttributesV1AttributesByParent","description":"Updates developer attributes. This API replaces the existing attributes with those specified in the request. Add new attributes, and include or exclude any existing attributes that you want to retain or remove, respectively. The custom attribute limit is 18. **Note**: OAuth access tokens and Key Management Service (KMS) entities (apps, developers, and API products) are cached for 180 seconds (default). Any custom attributes associated with these entities are cached for at least 180 seconds after the entity is accessed at runtime. Therefore, an `ExpiresIn` element on the OAuthV2 policy won't be able to expire an access token in less than 180 seconds.","operationId":"AttributesV1AttributesByParent","parameters":[{"name":"callback","in":"query","description":"JSONP","style":"form","explode":true,"schema":{"type":"string"}},{"name":"key","in":"query","description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"alt","in":"query","description":"Data format for response. (Acceptable values are: \"json\", \"media\", \"proto\")","style":"form","explode":true,"schema":{"type":"string","default":"json"}},{"name":"uploadType","in":"query","description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"upload_protocol","in":"query","description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"Selector specifying which fields to include in a partial response.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"access_token","in":"query","description":"OAuth access token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"$.xgafv","in":"query","description":"V1 error format. (Acceptable values are: \"1\", \"2\")","style":"form","explode":true,"schema":{"type":"string","default":"1"}},{"name":"quotaUser","in":"query","description":"Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"prettyPrint","in":"query","description":"Returns response with indentations and line breaks.","style":"form","explode":true,"schema":{"type":"boolean","default":true}},{"name":"oauth_token","in":"query","description":"OAuth 2.0 token for the current user.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"parent","in":"path","description":"Required. Email address of the developer for which attributes are being updated. Use the following structure in your request: `organizations/{org}/developers/{developer_email}`","required":true,"style":"simple","schema":{"pattern":"^organizations/[^/]+/developers/[^/]+$","type":"string"}}],"requestBody":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudApigeeV1Attributes"}}},"required":true},"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudApigeeV1Attributes"}}}}},"deprecated":false,"security":[{"httpBearer":["https://www.googleapis.com/auth/cloud-platform"]}]},"parameters":[]},"/v1/{name}/attributes":{"post":{"tags":["apiproducts"],"summary":"AttributesV1AttributesByName","description":"Updates or creates API product attributes. This API **replaces** the current list of attributes with the attributes specified in the request body. In this way, you can update existing attributes, add new attributes, or delete existing attributes by omitting them from the request body. **Note**: OAuth access tokens and Key Management Service (KMS) entities (apps, developers, and API products) are cached for 180 seconds (current default). Any custom attributes associated with entities also get cached for at least 180 seconds after entity is accessed during runtime. In this case, the `ExpiresIn` element on the OAuthV2 policy won't be able to expire an access token in less than 180 seconds.","operationId":"AttributesV1AttributesByName","parameters":[{"name":"callback","in":"query","description":"JSONP","style":"form","explode":true,"schema":{"type":"string"}},{"name":"key","in":"query","description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"alt","in":"query","description":"Data format for response. (Acceptable values are: \"json\", \"media\", \"proto\")","style":"form","explode":true,"schema":{"type":"string","default":"json"}},{"name":"uploadType","in":"query","description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"upload_protocol","in":"query","description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"Selector specifying which fields to include in a partial response.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"access_token","in":"query","description":"OAuth access token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"$.xgafv","in":"query","description":"V1 error format. (Acceptable values are: \"1\", \"2\")","style":"form","explode":true,"schema":{"type":"string","default":"1"}},{"name":"quotaUser","in":"query","description":"Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"prettyPrint","in":"query","description":"Returns response with indentations and line breaks.","style":"form","explode":true,"schema":{"type":"boolean","default":true}},{"name":"oauth_token","in":"query","description":"OAuth 2.0 token for the current user.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"name","in":"path","description":"Required. Name of the API product. Use the following structure in your request: `organizations/{org}/apiproducts/{apiproduct}`","required":true,"style":"simple","schema":{"pattern":"^organizations/[^/]+/apiproducts/[^/]+$","type":"string"}}],"requestBody":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudApigeeV1Attributes"}}},"required":true},"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudApigeeV1Attributes"}}}}},"deprecated":false,"security":[{"httpBearer":["https://www.googleapis.com/auth/cloud-platform"]}]},"parameters":[]},"/v1/{parent}/apiproducts":{"get":{"tags":["apiproducts"],"summary":"ListV1ApiproductsByParent","description":"Lists all API product names for an organization. Filter the list by passing an `attributename` and `attibutevalue`. The maximum number of API products returned is 1000. You can paginate the list of API products returned using the `startKey` and `count` query parameters.","operationId":"ListV1ApiproductsByParent","parameters":[{"name":"callback","in":"query","description":"JSONP","style":"form","explode":true,"schema":{"type":"string"}},{"name":"key","in":"query","description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"alt","in":"query","description":"Data format for response. (Acceptable values are: \"json\", \"media\", \"proto\")","style":"form","explode":true,"schema":{"type":"string","default":"json"}},{"name":"uploadType","in":"query","description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"upload_protocol","in":"query","description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"Selector specifying which fields to include in a partial response.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"access_token","in":"query","description":"OAuth access token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"$.xgafv","in":"query","description":"V1 error format. (Acceptable values are: \"1\", \"2\")","style":"form","explode":true,"schema":{"type":"string","default":"1"}},{"name":"quotaUser","in":"query","description":"Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"prettyPrint","in":"query","description":"Returns response with indentations and line breaks.","style":"form","explode":true,"schema":{"type":"boolean","default":true}},{"name":"oauth_token","in":"query","description":"OAuth 2.0 token for the current user.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"startKey","in":"query","description":"Gets a list of API products starting with a specific API product in the list. For example, if you're returning 50 API products at a time (using the `count` query parameter), you can view products 50-99 by entering the name of the 50th API product in the first API (without using `startKey`). Product name is case sensitive.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"count","in":"query","description":"Enter the number of API products you want returned in the API call. The limit is 1000.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"expand","in":"query","description":"Flag that specifies whether to expand the results. Set to `true` to get expanded details about each API.","style":"form","explode":true,"schema":{"type":"boolean"}},{"name":"parent","in":"path","description":"Required. Name of the organization. Use the following structure in your request: `organizations/{org}`","required":true,"style":"simple","schema":{"pattern":"^organizations/[^/]+$","type":"string"}},{"name":"attributevalue","in":"query","description":"Value of the attribute used to filter the search.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"attributename","in":"query","description":"Name of the attribute used to filter the search.","style":"form","explode":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudApigeeV1ListApiProductsResponse"}}}}},"deprecated":false,"security":[{"httpBearer":["https://www.googleapis.com/auth/cloud-platform"]}]},"post":{"tags":["apiproducts"],"summary":"CreateV1ApiproductsByParent","description":"Creates an API product in an organization. You create API products after you have proxied backend services using API proxies. An API product is a collection of API resources combined with quota settings and metadata that you can use to deliver customized and productized API bundles to your developer community. This metadata can include: - Scope - Environments - API proxies - Extensible profile API products enable you repackage APIs on the fly, without having to do any additional coding or configuration. Apigee recommends that you start with a simple API product including only required elements. You then provision credentials to apps to enable them to start testing your APIs. After you have authentication and authorization working against a simple API product, you can iterate to create finer-grained API products, defining different sets of API resources for each API product. **WARNING:** - If you don't specify an API proxy in the request body, *any* app associated with the product can make calls to *any* API in your entire organization. - If you don't specify an environment in the request body, the product allows access to all environments. For more information, see What is an API product?","operationId":"CreateV1ApiproductsByParent","parameters":[{"name":"callback","in":"query","description":"JSONP","style":"form","explode":true,"schema":{"type":"string"}},{"name":"key","in":"query","description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"alt","in":"query","description":"Data format for response. (Acceptable values are: \"json\", \"media\", \"proto\")","style":"form","explode":true,"schema":{"type":"string","default":"json"}},{"name":"uploadType","in":"query","description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"upload_protocol","in":"query","description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"Selector specifying which fields to include in a partial response.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"access_token","in":"query","description":"OAuth access token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"$.xgafv","in":"query","description":"V1 error format. (Acceptable values are: \"1\", \"2\")","style":"form","explode":true,"schema":{"type":"string","default":"1"}},{"name":"quotaUser","in":"query","description":"Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"prettyPrint","in":"query","description":"Returns response with indentations and line breaks.","style":"form","explode":true,"schema":{"type":"boolean","default":true}},{"name":"oauth_token","in":"query","description":"OAuth 2.0 token for the current user.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"parent","in":"path","description":"Required. Name of the organization in which the API product will be created. Use the following structure in your request: `organizations/{org}`","required":true,"style":"simple","schema":{"pattern":"^organizations/[^/]+$","type":"string"}}],"requestBody":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudApigeeV1ApiProduct"}}},"required":true},"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudApigeeV1ApiProduct"}}}}},"deprecated":false,"security":[{"httpBearer":["https://www.googleapis.com/auth/cloud-platform"]}]},"parameters":[]},"/v1/{parent}/keys/create":{"post":{"tags":["create"],"summary":"CreateV1KeysCreateByParent","description":"Creates a custom consumer key and secret for a developer app. This is particularly useful if you want to migrate existing consumer keys and secrets to Apigee from another system. Consumer keys and secrets can contain letters, numbers, underscores, and hyphens. No other special characters are allowed. To avoid service disruptions, a consumer key and secret should not exceed 2 KBs each. **Note**: When creating the consumer key and secret, an association to API products will not be made. Therefore, you should not specify the associated API products in your request. Instead, use the UpdateDeveloperAppKey API to make the association after the consumer key and secret are created. If a consumer key and secret already exist, you can keep them or delete them using the DeleteDeveloperAppKey API.","operationId":"CreateV1KeysCreateByParent","parameters":[{"name":"callback","in":"query","description":"JSONP","style":"form","explode":true,"schema":{"type":"string"}},{"name":"key","in":"query","description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"alt","in":"query","description":"Data format for response. (Acceptable values are: \"json\", \"media\", \"proto\")","style":"form","explode":true,"schema":{"type":"string","default":"json"}},{"name":"uploadType","in":"query","description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"upload_protocol","in":"query","description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"Selector specifying which fields to include in a partial response.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"access_token","in":"query","description":"OAuth access token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"$.xgafv","in":"query","description":"V1 error format. (Acceptable values are: \"1\", \"2\")","style":"form","explode":true,"schema":{"type":"string","default":"1"}},{"name":"quotaUser","in":"query","description":"Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"prettyPrint","in":"query","description":"Returns response with indentations and line breaks.","style":"form","explode":true,"schema":{"type":"boolean","default":true}},{"name":"oauth_token","in":"query","description":"OAuth 2.0 token for the current user.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"parent","in":"path","description":"Parent of the developer app key. Use the following structure in your request: `organizations/{org}/developers/{developer_email}/apps`","required":true,"style":"simple","schema":{"pattern":"^organizations/[^/]+/developers/[^/]+/apps/[^/]+$","type":"string"}}],"requestBody":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudApigeeV1DeveloperAppKey"}}},"required":true},"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudApigeeV1DeveloperAppKey"}}}}},"deprecated":false,"security":[{"httpBearer":["https://www.googleapis.com/auth/cloud-platform"]}]},"parameters":[]},"/v1/{parent}/keys":{"post":{"tags":["keys"],"summary":"CreateV1KeysByParent","description":"Creates a custom consumer key and secret for a developer app. This is particularly useful if you want to migrate existing consumer keys and secrets to Apigee from another system. Consumer keys and secrets can contain letters, numbers, underscores, and hyphens. No other special characters are allowed. To avoid service disruptions, a consumer key and secret should not exceed 2 KBs each. **Note**: When creating the consumer key and secret, an association to API products will not be made. Therefore, you should not specify the associated API products in your request. Instead, use the UpdateDeveloperAppKey API to make the association after the consumer key and secret are created. If a consumer key and secret already exist, you can keep them or delete them using the DeleteDeveloperAppKey API.","operationId":"CreateV1KeysByParent","parameters":[{"name":"callback","in":"query","description":"JSONP","style":"form","explode":true,"schema":{"type":"string"}},{"name":"key","in":"query","description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"alt","in":"query","description":"Data format for response. (Acceptable values are: \"json\", \"media\", \"proto\")","style":"form","explode":true,"schema":{"type":"string","default":"json"}},{"name":"uploadType","in":"query","description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"upload_protocol","in":"query","description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"Selector specifying which fields to include in a partial response.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"access_token","in":"query","description":"OAuth access token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"$.xgafv","in":"query","description":"V1 error format. (Acceptable values are: \"1\", \"2\")","style":"form","explode":true,"schema":{"type":"string","default":"1"}},{"name":"quotaUser","in":"query","description":"Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"prettyPrint","in":"query","description":"Returns response with indentations and line breaks.","style":"form","explode":true,"schema":{"type":"boolean","default":true}},{"name":"oauth_token","in":"query","description":"OAuth 2.0 token for the current user.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"parent","in":"path","description":"Parent of the developer app key. Use the following structure in your request: `organizations/{org}/developers/{developer_email}/apps`","required":true,"style":"simple","schema":{"pattern":"^organizations/[^/]+/developers/[^/]+/apps/[^/]+$","type":"string"}}],"requestBody":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudApigeeV1DeveloperAppKey"}}},"required":true},"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudApigeeV1DeveloperAppKey"}}}}},"deprecated":false,"security":[{"httpBearer":["https://www.googleapis.com/auth/cloud-platform"]}]},"parameters":[]},"/v1/{parent}/apps":{"get":{"tags":["apps"],"summary":"ListV1AppsByParent","description":"Lists all apps created by a developer in an Apigee organization. Optionally, you can request an expanded view of the developer apps. A maximum of 100 developer apps are returned per API call. You can paginate the list of deveoper apps returned using the `startKey` and `count` query parameters.","operationId":"ListV1AppsByParent","parameters":[{"name":"callback","in":"query","description":"JSONP","style":"form","explode":true,"schema":{"type":"string"}},{"name":"key","in":"query","description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"alt","in":"query","description":"Data format for response. (Acceptable values are: \"json\", \"media\", \"proto\")","style":"form","explode":true,"schema":{"type":"string","default":"json"}},{"name":"uploadType","in":"query","description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"upload_protocol","in":"query","description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"Selector specifying which fields to include in a partial response.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"access_token","in":"query","description":"OAuth access token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"$.xgafv","in":"query","description":"V1 error format. (Acceptable values are: \"1\", \"2\")","style":"form","explode":true,"schema":{"type":"string","default":"1"}},{"name":"quotaUser","in":"query","description":"Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"prettyPrint","in":"query","description":"Returns response with indentations and line breaks.","style":"form","explode":true,"schema":{"type":"boolean","default":true}},{"name":"oauth_token","in":"query","description":"OAuth 2.0 token for the current user.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"expand","in":"query","description":"Optional. Specifies whether to expand the results. Set to `true` to expand the results. This query parameter is not valid if you use the `count` or `startKey` query parameters.","style":"form","explode":true,"schema":{"type":"boolean"}},{"name":"shallowExpand","in":"query","description":"Optional. Specifies whether to expand the results in shallow mode. Set to `true` to expand the results in shallow mode.","style":"form","explode":true,"schema":{"type":"boolean"}},{"name":"startKey","in":"query","description":"**Note**: Must be used in conjunction with the `count` parameter. Name of the developer app from which to start displaying the list of developer apps. For example, if you're returning 50 developer apps at a time (using the `count` query parameter), you can view developer apps 50-99 by entering the name of the 50th developer app. The developer app name is case sensitive.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"count","in":"query","description":"Number of developer apps to return in the API call. Use with the `startKey` parameter to provide more targeted filtering. The limit is 1000.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"parent","in":"path","description":"Required. Name of the developer. Use the following structure in your request: `organizations/{org}/developers/{developer_email}`","required":true,"style":"simple","schema":{"pattern":"^organizations/[^/]+/developers/[^/]+$","type":"string"}}],"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudApigeeV1ListDeveloperAppsResponse"}}}}},"deprecated":false,"security":[{"httpBearer":["https://www.googleapis.com/auth/cloud-platform"]}]},"post":{"tags":["apps"],"summary":"CreateV1AppsByParent","description":"Creates an app associated with a developer. This API associates the developer app with the specified API product and auto-generates an API key for the app to use in calls to API proxies inside that API product. The `name` is the unique ID of the app that you can use in API calls. The `DisplayName` (set as an attribute) appears in the UI. If you don't set the `DisplayName` attribute, the `name` appears in the UI.","operationId":"CreateV1AppsByParent","parameters":[{"name":"callback","in":"query","description":"JSONP","style":"form","explode":true,"schema":{"type":"string"}},{"name":"key","in":"query","description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"alt","in":"query","description":"Data format for response. (Acceptable values are: \"json\", \"media\", \"proto\")","style":"form","explode":true,"schema":{"type":"string","default":"json"}},{"name":"uploadType","in":"query","description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"upload_protocol","in":"query","description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"Selector specifying which fields to include in a partial response.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"access_token","in":"query","description":"OAuth access token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"$.xgafv","in":"query","description":"V1 error format. (Acceptable values are: \"1\", \"2\")","style":"form","explode":true,"schema":{"type":"string","default":"1"}},{"name":"quotaUser","in":"query","description":"Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"prettyPrint","in":"query","description":"Returns response with indentations and line breaks.","style":"form","explode":true,"schema":{"type":"boolean","default":true}},{"name":"oauth_token","in":"query","description":"OAuth 2.0 token for the current user.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"parent","in":"path","description":"Required. Name of the developer. Use the following structure in your request: `organizations/{org}/developers/{developer_email}`","required":true,"style":"simple","schema":{"pattern":"^organizations/[^/]+/developers/[^/]+$","type":"string"}}],"requestBody":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudApigeeV1DeveloperApp"}}},"required":true},"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudApigeeV1DeveloperApp"}}}}},"deprecated":false,"security":[{"httpBearer":["https://www.googleapis.com/auth/cloud-platform"]}]},"parameters":[]},"/v1/{parent}/subscriptions":{"get":{"tags":["subscriptions"],"summary":"ListV1SubscriptionsByParent","description":"Lists all API product subscriptions for a developer.","operationId":"ListV1SubscriptionsByParent","parameters":[{"name":"callback","in":"query","description":"JSONP","style":"form","explode":true,"schema":{"type":"string"}},{"name":"key","in":"query","description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"alt","in":"query","description":"Data format for response. (Acceptable values are: \"json\", \"media\", \"proto\")","style":"form","explode":true,"schema":{"type":"string","default":"json"}},{"name":"uploadType","in":"query","description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"upload_protocol","in":"query","description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"Selector specifying which fields to include in a partial response.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"access_token","in":"query","description":"OAuth access token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"$.xgafv","in":"query","description":"V1 error format. (Acceptable values are: \"1\", \"2\")","style":"form","explode":true,"schema":{"type":"string","default":"1"}},{"name":"quotaUser","in":"query","description":"Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"prettyPrint","in":"query","description":"Returns response with indentations and line breaks.","style":"form","explode":true,"schema":{"type":"boolean","default":true}},{"name":"oauth_token","in":"query","description":"OAuth 2.0 token for the current user.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"parent","in":"path","description":"Required. Email address of the developer. Use the following structure in your request: `organizations/{org}/developers/{developer_email}`","required":true,"style":"simple","schema":{"pattern":"^organizations/[^/]+/developers/[^/]+$","type":"string"}},{"name":"count","in":"query","description":"Number of API product subscriptions to return in the API call. Use with `startKey` to provide more targeted filtering. Defaults to 100. The maximum limit is 1000.","style":"form","explode":true,"schema":{"type":"integer","contentEncoding":"int32"}},{"name":"startKey","in":"query","description":"Name of the API product subscription from which to start displaying the list of subscriptions. If omitted, the list starts from the first item. For example, to view the API product subscriptions from 51-150, set the value of `startKey` to the name of the 51st subscription and set the value of `count` to 100.","style":"form","explode":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudApigeeV1ListDeveloperSubscriptionsResponse"}}}}},"deprecated":false,"security":[{"httpBearer":["https://www.googleapis.com/auth/cloud-platform"]}]},"post":{"tags":["subscriptions"],"summary":"CreateV1SubscriptionsByParent","description":"Creates a subscription to an API product. ","operationId":"CreateV1SubscriptionsByParent","parameters":[{"name":"callback","in":"query","description":"JSONP","style":"form","explode":true,"schema":{"type":"string"}},{"name":"key","in":"query","description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"alt","in":"query","description":"Data format for response. (Acceptable values are: \"json\", \"media\", \"proto\")","style":"form","explode":true,"schema":{"type":"string","default":"json"}},{"name":"uploadType","in":"query","description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"upload_protocol","in":"query","description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"Selector specifying which fields to include in a partial response.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"access_token","in":"query","description":"OAuth access token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"$.xgafv","in":"query","description":"V1 error format. (Acceptable values are: \"1\", \"2\")","style":"form","explode":true,"schema":{"type":"string","default":"1"}},{"name":"quotaUser","in":"query","description":"Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"prettyPrint","in":"query","description":"Returns response with indentations and line breaks.","style":"form","explode":true,"schema":{"type":"boolean","default":true}},{"name":"oauth_token","in":"query","description":"OAuth 2.0 token for the current user.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"parent","in":"path","description":"Required. Email address of the developer that is purchasing a subscription to the API product. Use the following structure in your request: `organizations/{org}/developers/{developer_email}`","required":true,"style":"simple","schema":{"pattern":"^organizations/[^/]+/developers/[^/]+$","type":"string"}}],"requestBody":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudApigeeV1DeveloperSubscription"}}},"required":true},"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudApigeeV1DeveloperSubscription"}}}}},"deprecated":false,"security":[{"httpBearer":["https://www.googleapis.com/auth/cloud-platform"]}]},"parameters":[]},"/v1/{name}:expire":{"post":{"tags":["subscriptions"],"summary":"ExpireV1ExpireByName","description":"Expires an API product subscription immediately.","operationId":"ExpireV1ExpireByName","parameters":[{"name":"callback","in":"query","description":"JSONP","style":"form","explode":true,"schema":{"type":"string"}},{"name":"key","in":"query","description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"alt","in":"query","description":"Data format for response. (Acceptable values are: \"json\", \"media\", \"proto\")","style":"form","explode":true,"schema":{"type":"string","default":"json"}},{"name":"uploadType","in":"query","description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"upload_protocol","in":"query","description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"Selector specifying which fields to include in a partial response.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"access_token","in":"query","description":"OAuth access token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"$.xgafv","in":"query","description":"V1 error format. (Acceptable values are: \"1\", \"2\")","style":"form","explode":true,"schema":{"type":"string","default":"1"}},{"name":"quotaUser","in":"query","description":"Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"prettyPrint","in":"query","description":"Returns response with indentations and line breaks.","style":"form","explode":true,"schema":{"type":"boolean","default":true}},{"name":"oauth_token","in":"query","description":"OAuth 2.0 token for the current user.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"name","in":"path","description":"Required. Name of the API product subscription. Use the following structure in your request: `organizations/{org}/developers/{developer_email}/subscriptions/{subscription}`","required":true,"style":"simple","schema":{"pattern":"^organizations/[^/]+/developers/[^/]+/subscriptions/[^/]+$","type":"string"}}],"requestBody":{"description":"","content":{"text/plain":{"schema":{"type":"object","contentMediaType":"text/plain"}}},"required":true},"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudApigeeV1DeveloperSubscription"}}}}},"deprecated":false,"security":[{"httpBearer":["https://www.googleapis.com/auth/cloud-platform"]}]},"parameters":[]},"/v1/{parent}/developers":{"post":{"tags":["developers"],"summary":"CreateV1DevelopersByParent","description":"Creates a developer. Once created, the developer can register an app and obtain an API key. At creation time, a developer is set as `active`. To change the developer status, use the SetDeveloperStatus API.","operationId":"CreateV1DevelopersByParent","parameters":[{"name":"callback","in":"query","description":"JSONP","style":"form","explode":true,"schema":{"type":"string"}},{"name":"key","in":"query","description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"alt","in":"query","description":"Data format for response. (Acceptable values are: \"json\", \"media\", \"proto\")","style":"form","explode":true,"schema":{"type":"string","default":"json"}},{"name":"uploadType","in":"query","description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"upload_protocol","in":"query","description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"Selector specifying which fields to include in a partial response.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"access_token","in":"query","description":"OAuth access token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"$.xgafv","in":"query","description":"V1 error format. (Acceptable values are: \"1\", \"2\")","style":"form","explode":true,"schema":{"type":"string","default":"1"}},{"name":"quotaUser","in":"query","description":"Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"prettyPrint","in":"query","description":"Returns response with indentations and line breaks.","style":"form","explode":true,"schema":{"type":"boolean","default":true}},{"name":"oauth_token","in":"query","description":"OAuth 2.0 token for the current user.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"parent","in":"path","description":"Required. Name of the Apigee organization in which the developer is created. Use the following structure in your request: `organizations/{org}`.","required":true,"style":"simple","schema":{"pattern":"^organizations/[^/]+$","type":"string"}}],"requestBody":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudApigeeV1Developer"}}},"required":true},"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudApigeeV1Developer"}}}}},"deprecated":false,"security":[{"httpBearer":["https://www.googleapis.com/auth/cloud-platform"]}]},"get":{"tags":["developers"],"summary":"ListV1DevelopersByParent","description":"Lists all developers in an organization by email address. By default, the response does not include company developers. Set the `includeCompany` query parameter to `true` to include company developers. **Note**: A maximum of 1000 developers are returned in the response. You paginate the list of developers returned using the `startKey` and `count` query parameters.","operationId":"ListV1DevelopersByParent","parameters":[{"name":"callback","in":"query","description":"JSONP","style":"form","explode":true,"schema":{"type":"string"}},{"name":"key","in":"query","description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"alt","in":"query","description":"Data format for response. (Acceptable values are: \"json\", \"media\", \"proto\")","style":"form","explode":true,"schema":{"type":"string","default":"json"}},{"name":"uploadType","in":"query","description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"upload_protocol","in":"query","description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"Selector specifying which fields to include in a partial response.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"access_token","in":"query","description":"OAuth access token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"$.xgafv","in":"query","description":"V1 error format. (Acceptable values are: \"1\", \"2\")","style":"form","explode":true,"schema":{"type":"string","default":"1"}},{"name":"quotaUser","in":"query","description":"Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"prettyPrint","in":"query","description":"Returns response with indentations and line breaks.","style":"form","explode":true,"schema":{"type":"boolean","default":true}},{"name":"oauth_token","in":"query","description":"OAuth 2.0 token for the current user.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"startKey","in":"query","description":"**Note**: Must be used in conjunction with the `count` parameter. Email address of the developer from which to start displaying the list of developers. For example, if the an unfiltered list returns: ``` westley@example.com fezzik@example.com buttercup@example.com ``` and your `startKey` is `fezzik@example.com`, the list returned will be ``` fezzik@example.com buttercup@example.com ```","style":"form","explode":true,"schema":{"type":"string"}},{"name":"parent","in":"path","description":"Required. Name of the Apigee organization. Use the following structure in your request: `organizations/{org}`.","required":true,"style":"simple","schema":{"pattern":"^organizations/[^/]+$","type":"string"}},{"name":"count","in":"query","description":"Optional. Number of developers to return in the API call. Use with the `startKey` parameter to provide more targeted filtering. The limit is 1000.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"ids","in":"query","description":"Optional. List of IDs to include, separated by commas.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"app","in":"query","description":"Optional. List only Developers that are associated with the app. Note that start_key, count are not applicable for this filter criteria.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"expand","in":"query","description":"Specifies whether to expand the results. Set to `true` to expand the results. This query parameter is not valid if you use the `count` or `startKey` query parameters.","style":"form","explode":true,"schema":{"type":"boolean"}},{"name":"includeCompany","in":"query","description":"Flag that specifies whether to include company details in the response.","style":"form","explode":true,"schema":{"type":"boolean"}}],"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudApigeeV1ListOfDevelopersResponse"}}}}},"deprecated":false,"security":[{"httpBearer":["https://www.googleapis.com/auth/cloud-platform"]}]},"parameters":[]},"/v1/{parent}/deployments":{"get":{"tags":["deployments"],"summary":"ListV1DeploymentsByParent","description":"Lists all deployments of API proxies or shared flows.","operationId":"ListV1DeploymentsByParent","parameters":[{"name":"callback","in":"query","description":"JSONP","style":"form","explode":true,"schema":{"type":"string"}},{"name":"key","in":"query","description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"alt","in":"query","description":"Data format for response. (Acceptable values are: \"json\", \"media\", \"proto\")","style":"form","explode":true,"schema":{"type":"string","default":"json"}},{"name":"uploadType","in":"query","description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"upload_protocol","in":"query","description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"Selector specifying which fields to include in a partial response.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"access_token","in":"query","description":"OAuth access token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"$.xgafv","in":"query","description":"V1 error format. (Acceptable values are: \"1\", \"2\")","style":"form","explode":true,"schema":{"type":"string","default":"1"}},{"name":"quotaUser","in":"query","description":"Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"prettyPrint","in":"query","description":"Returns response with indentations and line breaks.","style":"form","explode":true,"schema":{"type":"boolean","default":true}},{"name":"oauth_token","in":"query","description":"OAuth 2.0 token for the current user.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"parent","in":"path","description":"Required. Name of the organization for which to return deployment information in the following format: `organizations/{org}`","required":true,"style":"simple","schema":{"pattern":"^organizations/[^/]+$","type":"string"}},{"name":"sharedFlows","in":"query","description":"Optional. Flag that specifies whether to return shared flow or API proxy deployments. Set to `true` to return shared flow deployments; set to `false` to return API proxy deployments. Defaults to `false`.","style":"form","explode":true,"schema":{"type":"boolean"}}],"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudApigeeV1ListDeploymentsResponse"}}}}},"deprecated":false,"security":[{"httpBearer":["https://www.googleapis.com/auth/cloud-platform"]}]},"parameters":[]},"/v1/{name}/deployments:generateDeployChangeReport":{"post":{"tags":["deployments"],"summary":"GenerateDeployChangeReportV1DeploymentsGenerateDeployChangeReport","description":"Generates a report for a dry run analysis of a DeployApiProxy request without committing the deployment. In addition to the standard validations performed when adding deployments, additional analysis will be done to detect possible traffic routing changes that would result from this deployment being created. Any potential routing conflicts or unsafe changes will be reported in the response. This routing analysis is not performed for a non-dry-run DeployApiProxy request. For a request path `organizations/{org}/environments/{env}/apis/{api}/revisions/{rev}/deployments:generateDeployChangeReport`, two permissions are required: * `apigee.deployments.create` on the resource `organizations/{org}/environments/{env}` * `apigee.proxyrevisions.deploy` on the resource `organizations/{org}/apis/{api}/revisions/{rev}`","operationId":"GenerateDeployChangeReportV1DeploymentsGenerateDeployChangeReport","parameters":[{"name":"callback","in":"query","description":"JSONP","style":"form","explode":true,"schema":{"type":"string"}},{"name":"key","in":"query","description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"alt","in":"query","description":"Data format for response. (Acceptable values are: \"json\", \"media\", \"proto\")","style":"form","explode":true,"schema":{"type":"string","default":"json"}},{"name":"uploadType","in":"query","description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"upload_protocol","in":"query","description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"Selector specifying which fields to include in a partial response.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"access_token","in":"query","description":"OAuth access token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"$.xgafv","in":"query","description":"V1 error format. (Acceptable values are: \"1\", \"2\")","style":"form","explode":true,"schema":{"type":"string","default":"1"}},{"name":"quotaUser","in":"query","description":"Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"prettyPrint","in":"query","description":"Returns response with indentations and line breaks.","style":"form","explode":true,"schema":{"type":"boolean","default":true}},{"name":"oauth_token","in":"query","description":"OAuth 2.0 token for the current user.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"name","in":"path","description":"Name of the API proxy revision deployment in the following format: `organizations/{org}/environments/{env}/apis/{api}/revisions/{rev}`","required":true,"style":"simple","schema":{"pattern":"^organizations/[^/]+/environments/[^/]+/apis/[^/]+/revisions/[^/]+$","type":"string"}},{"name":"override","in":"query","description":"Flag that specifies whether to force the deployment of the new revision over the currently deployed revision by overriding conflict checks.","style":"form","explode":true,"schema":{"type":"boolean"}}],"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudApigeeV1DeploymentChangeReport"}}}}},"deprecated":false,"security":[{"httpBearer":["https://www.googleapis.com/auth/cloud-platform"]}]},"parameters":[]},"/v1/{name}/deployments:generateUndeployChangeReport":{"post":{"tags":["deployments"],"summary":"GenerateUndeployChangeReportV1DeploymentsGenerateUndeployChangeReport","description":"Generates a report for a dry run analysis of an UndeployApiProxy request without committing the undeploy. In addition to the standard validations performed when removing deployments, additional analysis will be done to detect possible traffic routing changes that would result from this deployment being removed. Any potential routing conflicts or unsafe changes will be reported in the response. This routing analysis is not performed for a non-dry-run UndeployApiProxy request. For a request path `organizations/{org}/environments/{env}/apis/{api}/revisions/{rev}/deployments:generateUndeployChangeReport`, two permissions are required: * `apigee.deployments.delete` on the resource `organizations/{org}/environments/{env}` * `apigee.proxyrevisions.undeploy` on the resource `organizations/{org}/apis/{api}/revisions/{rev}`","operationId":"GenerateUndeployChangeReportV1DeploymentsGenerateUndeployChangeReport","parameters":[{"name":"callback","in":"query","description":"JSONP","style":"form","explode":true,"schema":{"type":"string"}},{"name":"key","in":"query","description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"alt","in":"query","description":"Data format for response. (Acceptable values are: \"json\", \"media\", \"proto\")","style":"form","explode":true,"schema":{"type":"string","default":"json"}},{"name":"uploadType","in":"query","description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"upload_protocol","in":"query","description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"Selector specifying which fields to include in a partial response.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"access_token","in":"query","description":"OAuth access token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"$.xgafv","in":"query","description":"V1 error format. (Acceptable values are: \"1\", \"2\")","style":"form","explode":true,"schema":{"type":"string","default":"1"}},{"name":"quotaUser","in":"query","description":"Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"prettyPrint","in":"query","description":"Returns response with indentations and line breaks.","style":"form","explode":true,"schema":{"type":"boolean","default":true}},{"name":"oauth_token","in":"query","description":"OAuth 2.0 token for the current user.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"name","in":"path","description":"Name of the API proxy revision deployment in the following format: `organizations/{org}/environments/{env}/apis/{api}/revisions/{rev}`","required":true,"style":"simple","schema":{"pattern":"^organizations/[^/]+/environments/[^/]+/apis/[^/]+/revisions/[^/]+$","type":"string"}}],"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudApigeeV1DeploymentChangeReport"}}}}},"deprecated":false,"security":[{"httpBearer":["https://www.googleapis.com/auth/cloud-platform"]}]},"parameters":[]},"/v1/{name}/deployments":{"get":{"tags":["revisions"],"summary":"GetDeploymentsV1DeploymentsByName","description":"Gets the deployment of an API proxy revision and actual state reported by runtime pods.","operationId":"GetDeploymentsV1DeploymentsByName","parameters":[{"name":"callback","in":"query","description":"JSONP","style":"form","explode":true,"schema":{"type":"string"}},{"name":"key","in":"query","description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"alt","in":"query","description":"Data format for response. (Acceptable values are: \"json\", \"media\", \"proto\")","style":"form","explode":true,"schema":{"type":"string","default":"json"}},{"name":"uploadType","in":"query","description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"upload_protocol","in":"query","description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"Selector specifying which fields to include in a partial response.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"access_token","in":"query","description":"OAuth access token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"$.xgafv","in":"query","description":"V1 error format. (Acceptable values are: \"1\", \"2\")","style":"form","explode":true,"schema":{"type":"string","default":"1"}},{"name":"quotaUser","in":"query","description":"Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"prettyPrint","in":"query","description":"Returns response with indentations and line breaks.","style":"form","explode":true,"schema":{"type":"boolean","default":true}},{"name":"oauth_token","in":"query","description":"OAuth 2.0 token for the current user.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"name","in":"path","description":"Required. Name representing an API proxy revision in an environment in the following format: `organizations/{org}/environments/{env}/apis/{api}/revisions/{rev}`","required":true,"style":"simple","schema":{"pattern":"^organizations/[^/]+/environments/[^/]+/apis/[^/]+/revisions/[^/]+$","type":"string"}}],"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudApigeeV1Deployment"}}}}},"deprecated":false,"security":[{"httpBearer":["https://www.googleapis.com/auth/cloud-platform"]}]},"post":{"tags":["revisions"],"summary":"DeployV1DeploymentsByName","description":"Deploys a revision of an API proxy. If another revision of the same API proxy revision is currently deployed, set the `override` parameter to `true` to have this revision replace the currently deployed revision. You cannot invoke an API proxy until it has been deployed to an environment. After you deploy an API proxy revision, you cannot edit it. To edit the API proxy, you must create and deploy a new revision. For a request path `organizations/{org}/environments/{env}/apis/{api}/revisions/{rev}/deployments`, two permissions are required: * `apigee.deployments.create` on the resource `organizations/{org}/environments/{env}` * `apigee.proxyrevisions.deploy` on the resource `organizations/{org}/apis/{api}/revisions/{rev}` ","operationId":"DeployV1DeploymentsByName","parameters":[{"name":"callback","in":"query","description":"JSONP","style":"form","explode":true,"schema":{"type":"string"}},{"name":"key","in":"query","description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"alt","in":"query","description":"Data format for response. (Acceptable values are: \"json\", \"media\", \"proto\")","style":"form","explode":true,"schema":{"type":"string","default":"json"}},{"name":"uploadType","in":"query","description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"upload_protocol","in":"query","description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"Selector specifying which fields to include in a partial response.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"access_token","in":"query","description":"OAuth access token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"$.xgafv","in":"query","description":"V1 error format. (Acceptable values are: \"1\", \"2\")","style":"form","explode":true,"schema":{"type":"string","default":"1"}},{"name":"quotaUser","in":"query","description":"Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"prettyPrint","in":"query","description":"Returns response with indentations and line breaks.","style":"form","explode":true,"schema":{"type":"boolean","default":true}},{"name":"oauth_token","in":"query","description":"OAuth 2.0 token for the current user.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"override","in":"query","description":"Flag that specifies whether the new deployment replaces other deployed revisions of the API proxy in the environment. Set `override` to `true` to replace other deployed revisions. By default, `override` is `false` and the deployment is rejected if other revisions of the API proxy are deployed in the environment.","style":"form","explode":true,"schema":{"type":"boolean"}},{"name":"sequencedRollout","in":"query","description":"Flag that specifies whether to enable sequenced rollout. If set to `true`, the routing rules for this deployment and the environment changes to add the deployment will be rolled out in a safe order. This reduces the risk of downtime that could be caused by changing the environment group's routing before the new destination for the affected traffic is ready to receive it. This should only be necessary if the new deployment will be capturing traffic from another environment under a shared environment group or if traffic will be rerouted to a different environment due to a base path removal. The [GenerateDeployChangeReport API](GenerateDeployChangeReport) may be used to examine routing changes before issuing the deployment request, and its response will indicate if a sequenced rollout is recommended for the deployment.","style":"form","explode":true,"schema":{"type":"boolean"}},{"name":"name","in":"path","description":"Required. Name of the API proxy revision deployment in the following format: `organizations/{org}/environments/{env}/apis/{api}/revisions/{rev}`","required":true,"style":"simple","schema":{"pattern":"^organizations/[^/]+/environments/[^/]+/apis/[^/]+/revisions/[^/]+$","type":"string"}},{"name":"serviceAccount","in":"query","description":"Google Cloud IAM service account. The service account represents the identity of the deployed proxy, and determines what permissions it has. The format must be `{ACCOUNT_ID}@{PROJECT}.iam.gserviceaccount.com`.","style":"form","explode":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudApigeeV1Deployment"}}}}},"deprecated":false,"security":[{"httpBearer":["https://www.googleapis.com/auth/cloud-platform"]}]},"delete":{"tags":["revisions"],"summary":"UndeployV1DeploymentsByName","description":"Undeploys an API proxy revision from an environment. For a request path `organizations/{org}/environments/{env}/apis/{api}/revisions/{rev}/deployments`, two permissions are required: * `apigee.deployments.delete` on the resource `organizations/{org}/environments/{env}` * `apigee.proxyrevisions.undeploy` on the resource `organizations/{org}/apis/{api}/revisions/{rev}`","operationId":"UndeployV1DeploymentsByName","parameters":[{"name":"callback","in":"query","description":"JSONP","style":"form","explode":true,"schema":{"type":"string"}},{"name":"key","in":"query","description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"alt","in":"query","description":"Data format for response. (Acceptable values are: \"json\", \"media\", \"proto\")","style":"form","explode":true,"schema":{"type":"string","default":"json"}},{"name":"uploadType","in":"query","description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"upload_protocol","in":"query","description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"Selector specifying which fields to include in a partial response.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"access_token","in":"query","description":"OAuth access token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"$.xgafv","in":"query","description":"V1 error format. (Acceptable values are: \"1\", \"2\")","style":"form","explode":true,"schema":{"type":"string","default":"1"}},{"name":"quotaUser","in":"query","description":"Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"prettyPrint","in":"query","description":"Returns response with indentations and line breaks.","style":"form","explode":true,"schema":{"type":"boolean","default":true}},{"name":"oauth_token","in":"query","description":"OAuth 2.0 token for the current user.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"sequencedRollout","in":"query","description":"Flag that specifies whether to enable sequenced rollout. If set to `true`, the environment group routing rules corresponding to this deployment will be removed before removing the deployment from the runtime. This is likely to be a rare use case; it is only needed when the intended effect of undeploying this proxy is to cause the traffic it currently handles to be rerouted to some other existing proxy in the environment group. The [GenerateUndeployChangeReport API](GenerateUndeployChangeReport) may be used to examine routing changes before issuing the undeployment request, and its response will indicate if a sequenced rollout is recommended for the undeployment.","style":"form","explode":true,"schema":{"type":"boolean"}},{"name":"name","in":"path","description":"Required. Name of the API proxy revision deployment in the following format: `organizations/{org}/environments/{env}/apis/{api}/revisions/{rev}`","required":true,"style":"simple","schema":{"pattern":"^organizations/[^/]+/environments/[^/]+/apis/[^/]+/revisions/[^/]+$","type":"string"}}],"responses":{"200":{"description":"","headers":{},"content":{"text/plain":{"schema":{"type":"object","contentMediaType":"text/plain"}}}}},"deprecated":false,"security":[{"httpBearer":["https://www.googleapis.com/auth/cloud-platform"]}]},"parameters":[]},"/v1/{parent}/sharedflows":{"post":{"tags":["sharedflows"],"summary":"CreateV1SharedflowsByParent","description":"Uploads a ZIP-formatted shared flow configuration bundle to an organization. If the shared flow already exists, this creates a new revision of it. If the shared flow does not exist, this creates it. Once imported, the shared flow revision must be deployed before it can be accessed at runtime. The size limit of a shared flow bundle is 15 MB.","operationId":"CreateV1SharedflowsByParent","parameters":[{"name":"callback","in":"query","description":"JSONP","style":"form","explode":true,"schema":{"type":"string"}},{"name":"key","in":"query","description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"alt","in":"query","description":"Data format for response. (Acceptable values are: \"json\", \"media\", \"proto\")","style":"form","explode":true,"schema":{"type":"string","default":"json"}},{"name":"uploadType","in":"query","description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"upload_protocol","in":"query","description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"Selector specifying which fields to include in a partial response.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"access_token","in":"query","description":"OAuth access token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"$.xgafv","in":"query","description":"V1 error format. (Acceptable values are: \"1\", \"2\")","style":"form","explode":true,"schema":{"type":"string","default":"1"}},{"name":"quotaUser","in":"query","description":"Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"prettyPrint","in":"query","description":"Returns response with indentations and line breaks.","style":"form","explode":true,"schema":{"type":"boolean","default":true}},{"name":"oauth_token","in":"query","description":"OAuth 2.0 token for the current user.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"parent","in":"path","description":"Required. The name of the parent organization under which to create the shared flow. Must be of the form: `organizations/{organization_id}`","required":true,"style":"simple","schema":{"pattern":"^organizations/[^/]+$","type":"string"}},{"name":"action","in":"query","description":"Required. Must be set to either `import` or `validate`.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"name","in":"query","description":"Required. The name to give the shared flow","style":"form","explode":true,"schema":{"type":"string"}}],"requestBody":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleApiHttpBody"}}},"required":true},"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudApigeeV1SharedFlowRevision"}}}}},"deprecated":false,"security":[{"httpBearer":["https://www.googleapis.com/auth/cloud-platform"]}]},"get":{"tags":["sharedflows"],"summary":"ListV1SharedflowsByParent","description":"Lists all shared flows in the organization.","operationId":"ListV1SharedflowsByParent","parameters":[{"name":"callback","in":"query","description":"JSONP","style":"form","explode":true,"schema":{"type":"string"}},{"name":"key","in":"query","description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"alt","in":"query","description":"Data format for response. (Acceptable values are: \"json\", \"media\", \"proto\")","style":"form","explode":true,"schema":{"type":"string","default":"json"}},{"name":"uploadType","in":"query","description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"upload_protocol","in":"query","description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"Selector specifying which fields to include in a partial response.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"access_token","in":"query","description":"OAuth access token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"$.xgafv","in":"query","description":"V1 error format. (Acceptable values are: \"1\", \"2\")","style":"form","explode":true,"schema":{"type":"string","default":"1"}},{"name":"quotaUser","in":"query","description":"Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"prettyPrint","in":"query","description":"Returns response with indentations and line breaks.","style":"form","explode":true,"schema":{"type":"boolean","default":true}},{"name":"oauth_token","in":"query","description":"OAuth 2.0 token for the current user.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"includeMetaData","in":"query","description":"Indicates whether to include shared flow metadata in the response.","style":"form","explode":true,"schema":{"type":"boolean"}},{"name":"includeRevisions","in":"query","description":"Indicates whether to include a list of revisions in the response.","style":"form","explode":true,"schema":{"type":"boolean"}},{"name":"parent","in":"path","description":"Required. The name of the parent organization under which to get shared flows. Must be of the form: `organizations/{organization_id}`","required":true,"style":"simple","schema":{"pattern":"^organizations/[^/]+$","type":"string"}}],"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudApigeeV1ListSharedFlowsResponse"}}}}},"deprecated":false,"security":[{"httpBearer":["https://www.googleapis.com/auth/cloud-platform"]}]},"parameters":[]},"/v1/{name}:activate":{"post":{"tags":["natAddresses"],"summary":"ActivateV1ActivateByName","description":"Activates the NAT address. The Apigee instance can now use this for Internet egress traffic. **Note:** Not supported for Apigee hybrid.","operationId":"ActivateV1ActivateByName","parameters":[{"name":"callback","in":"query","description":"JSONP","style":"form","explode":true,"schema":{"type":"string"}},{"name":"key","in":"query","description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"alt","in":"query","description":"Data format for response. (Acceptable values are: \"json\", \"media\", \"proto\")","style":"form","explode":true,"schema":{"type":"string","default":"json"}},{"name":"uploadType","in":"query","description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"upload_protocol","in":"query","description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"Selector specifying which fields to include in a partial response.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"access_token","in":"query","description":"OAuth access token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"$.xgafv","in":"query","description":"V1 error format. (Acceptable values are: \"1\", \"2\")","style":"form","explode":true,"schema":{"type":"string","default":"1"}},{"name":"quotaUser","in":"query","description":"Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"prettyPrint","in":"query","description":"Returns response with indentations and line breaks.","style":"form","explode":true,"schema":{"type":"boolean","default":true}},{"name":"oauth_token","in":"query","description":"OAuth 2.0 token for the current user.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"name","in":"path","description":"Required. Name of the nat address. Use the following structure in your request: `organizations/{org}/instances/{instances}/natAddresses/{nataddress}``","required":true,"style":"simple","schema":{"pattern":"^organizations/[^/]+/instances/[^/]+/natAddresses/[^/]+$","type":"string"}}],"requestBody":{"description":"","content":{"text/plain":{"schema":{"type":"object","contentMediaType":"text/plain"}}},"required":true},"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleLongrunningOperation"}}}}},"deprecated":false,"security":[{"httpBearer":["https://www.googleapis.com/auth/cloud-platform"]}]},"parameters":[]},"/v1/{parent}/natAddresses":{"post":{"tags":["natAddresses"],"summary":"CreateV1NatAddressesByParent","description":"Creates a NAT address. The address is created in the RESERVED state and a static external IP address will be provisioned. At this time, the instance will not use this IP address for Internet egress traffic. The address can be activated for use once any required firewall IP whitelisting has been completed. **Note:** Not supported for Apigee hybrid.","operationId":"CreateV1NatAddressesByParent","parameters":[{"name":"callback","in":"query","description":"JSONP","style":"form","explode":true,"schema":{"type":"string"}},{"name":"key","in":"query","description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"alt","in":"query","description":"Data format for response. (Acceptable values are: \"json\", \"media\", \"proto\")","style":"form","explode":true,"schema":{"type":"string","default":"json"}},{"name":"uploadType","in":"query","description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"upload_protocol","in":"query","description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"Selector specifying which fields to include in a partial response.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"access_token","in":"query","description":"OAuth access token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"$.xgafv","in":"query","description":"V1 error format. (Acceptable values are: \"1\", \"2\")","style":"form","explode":true,"schema":{"type":"string","default":"1"}},{"name":"quotaUser","in":"query","description":"Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"prettyPrint","in":"query","description":"Returns response with indentations and line breaks.","style":"form","explode":true,"schema":{"type":"boolean","default":true}},{"name":"oauth_token","in":"query","description":"OAuth 2.0 token for the current user.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"parent","in":"path","description":"Required. Name of the instance. Use the following structure in your request: `organizations/{org}/instances/{instance}`","required":true,"style":"simple","schema":{"pattern":"^organizations/[^/]+/instances/[^/]+$","type":"string"}}],"requestBody":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudApigeeV1NatAddress"}}},"required":true},"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleLongrunningOperation"}}}}},"deprecated":false,"security":[{"httpBearer":["https://www.googleapis.com/auth/cloud-platform"]}]},"get":{"tags":["natAddresses"],"summary":"ListV1NatAddressesByParent","description":"Lists the NAT addresses for an Apigee instance. **Note:** Not supported for Apigee hybrid.","operationId":"ListV1NatAddressesByParent","parameters":[{"name":"callback","in":"query","description":"JSONP","style":"form","explode":true,"schema":{"type":"string"}},{"name":"key","in":"query","description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"alt","in":"query","description":"Data format for response. (Acceptable values are: \"json\", \"media\", \"proto\")","style":"form","explode":true,"schema":{"type":"string","default":"json"}},{"name":"uploadType","in":"query","description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"upload_protocol","in":"query","description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"Selector specifying which fields to include in a partial response.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"access_token","in":"query","description":"OAuth access token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"$.xgafv","in":"query","description":"V1 error format. (Acceptable values are: \"1\", \"2\")","style":"form","explode":true,"schema":{"type":"string","default":"1"}},{"name":"quotaUser","in":"query","description":"Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"prettyPrint","in":"query","description":"Returns response with indentations and line breaks.","style":"form","explode":true,"schema":{"type":"boolean","default":true}},{"name":"oauth_token","in":"query","description":"OAuth 2.0 token for the current user.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"pageToken","in":"query","description":"Page token, returned from a previous ListNatAddresses call, that you can use to retrieve the next page of content.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"parent","in":"path","description":"Required. Name of the instance. Use the following structure in your request: `organizations/{org}/instances/{instance}`","required":true,"style":"simple","schema":{"pattern":"^organizations/[^/]+/instances/[^/]+$","type":"string"}},{"name":"pageSize","in":"query","description":"Maximum number of natAddresses to return. Defaults to 25.","style":"form","explode":true,"schema":{"type":"integer","contentEncoding":"int32"}}],"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudApigeeV1ListNatAddressesResponse"}}}}},"deprecated":false,"security":[{"httpBearer":["https://www.googleapis.com/auth/cloud-platform"]}]},"parameters":[]},"/v1/{parent}/canaryevaluations":{"post":{"tags":["canaryevaluations"],"summary":"CreateV1CanaryevaluationsByParent","description":"Creates a new canary evaluation for an organization.","operationId":"CreateV1CanaryevaluationsByParent","parameters":[{"name":"callback","in":"query","description":"JSONP","style":"form","explode":true,"schema":{"type":"string"}},{"name":"key","in":"query","description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"alt","in":"query","description":"Data format for response. (Acceptable values are: \"json\", \"media\", \"proto\")","style":"form","explode":true,"schema":{"type":"string","default":"json"}},{"name":"uploadType","in":"query","description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"upload_protocol","in":"query","description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"Selector specifying which fields to include in a partial response.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"access_token","in":"query","description":"OAuth access token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"$.xgafv","in":"query","description":"V1 error format. (Acceptable values are: \"1\", \"2\")","style":"form","explode":true,"schema":{"type":"string","default":"1"}},{"name":"quotaUser","in":"query","description":"Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"prettyPrint","in":"query","description":"Returns response with indentations and line breaks.","style":"form","explode":true,"schema":{"type":"boolean","default":true}},{"name":"oauth_token","in":"query","description":"OAuth 2.0 token for the current user.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"parent","in":"path","description":"Required. Name of the organization. Use the following structure in your request: `organizations/{org}/instances/{instance}`.","required":true,"style":"simple","schema":{"pattern":"^organizations/[^/]+/instances/[^/]+$","type":"string"}}],"requestBody":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudApigeeV1CanaryEvaluation"}}},"required":true},"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleLongrunningOperation"}}}}},"deprecated":false,"security":[{"httpBearer":["https://www.googleapis.com/auth/cloud-platform"]}]},"parameters":[]},"/v1/{parent}/instances":{"post":{"tags":["instances"],"summary":"CreateV1InstancesByParent","description":"Creates an Apigee runtime instance. The instance is accessible from the authorized network configured on the organization. **Note:** Not supported for Apigee hybrid.","operationId":"CreateV1InstancesByParent","parameters":[{"name":"callback","in":"query","description":"JSONP","style":"form","explode":true,"schema":{"type":"string"}},{"name":"key","in":"query","description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"alt","in":"query","description":"Data format for response. (Acceptable values are: \"json\", \"media\", \"proto\")","style":"form","explode":true,"schema":{"type":"string","default":"json"}},{"name":"uploadType","in":"query","description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"upload_protocol","in":"query","description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"Selector specifying which fields to include in a partial response.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"access_token","in":"query","description":"OAuth access token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"$.xgafv","in":"query","description":"V1 error format. (Acceptable values are: \"1\", \"2\")","style":"form","explode":true,"schema":{"type":"string","default":"1"}},{"name":"quotaUser","in":"query","description":"Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"prettyPrint","in":"query","description":"Returns response with indentations and line breaks.","style":"form","explode":true,"schema":{"type":"boolean","default":true}},{"name":"oauth_token","in":"query","description":"OAuth 2.0 token for the current user.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"parent","in":"path","description":"Required. Name of the organization. Use the following structure in your request: `organizations/{org}`.","required":true,"style":"simple","schema":{"pattern":"^organizations/[^/]+$","type":"string"}}],"requestBody":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudApigeeV1Instance"}}},"required":true},"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleLongrunningOperation"}}}}},"deprecated":false,"security":[{"httpBearer":["https://www.googleapis.com/auth/cloud-platform"]}]},"get":{"tags":["instances"],"summary":"ListV1InstancesByParent","description":"Lists all Apigee runtime instances for the organization. **Note:** Not supported for Apigee hybrid.","operationId":"ListV1InstancesByParent","parameters":[{"name":"callback","in":"query","description":"JSONP","style":"form","explode":true,"schema":{"type":"string"}},{"name":"key","in":"query","description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"alt","in":"query","description":"Data format for response. (Acceptable values are: \"json\", \"media\", \"proto\")","style":"form","explode":true,"schema":{"type":"string","default":"json"}},{"name":"uploadType","in":"query","description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"upload_protocol","in":"query","description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"Selector specifying which fields to include in a partial response.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"access_token","in":"query","description":"OAuth access token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"$.xgafv","in":"query","description":"V1 error format. (Acceptable values are: \"1\", \"2\")","style":"form","explode":true,"schema":{"type":"string","default":"1"}},{"name":"quotaUser","in":"query","description":"Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"prettyPrint","in":"query","description":"Returns response with indentations and line breaks.","style":"form","explode":true,"schema":{"type":"boolean","default":true}},{"name":"oauth_token","in":"query","description":"OAuth 2.0 token for the current user.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"pageToken","in":"query","description":"Page token, returned from a previous ListInstances call, that you can use to retrieve the next page of content.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"pageSize","in":"query","description":"Maximum number of instances to return. Defaults to 25.","style":"form","explode":true,"schema":{"type":"integer","contentEncoding":"int32"}},{"name":"parent","in":"path","description":"Required. Name of the organization. Use the following structure in your request: `organizations/{org}`.","required":true,"style":"simple","schema":{"pattern":"^organizations/[^/]+$","type":"string"}}],"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudApigeeV1ListInstancesResponse"}}}}},"deprecated":false,"security":[{"httpBearer":["https://www.googleapis.com/auth/cloud-platform"]}]},"parameters":[]},"/v1/{instance}:reportStatus":{"post":{"tags":["instances"],"summary":"ReportStatusV1ReportStatusByInstance","description":"Reports the latest status for a runtime instance.","operationId":"ReportStatusV1ReportStatusByInstance","parameters":[{"name":"callback","in":"query","description":"JSONP","style":"form","explode":true,"schema":{"type":"string"}},{"name":"key","in":"query","description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"alt","in":"query","description":"Data format for response. (Acceptable values are: \"json\", \"media\", \"proto\")","style":"form","explode":true,"schema":{"type":"string","default":"json"}},{"name":"uploadType","in":"query","description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"upload_protocol","in":"query","description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"Selector specifying which fields to include in a partial response.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"access_token","in":"query","description":"OAuth access token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"$.xgafv","in":"query","description":"V1 error format. (Acceptable values are: \"1\", \"2\")","style":"form","explode":true,"schema":{"type":"string","default":"1"}},{"name":"quotaUser","in":"query","description":"Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"prettyPrint","in":"query","description":"Returns response with indentations and line breaks.","style":"form","explode":true,"schema":{"type":"boolean","default":true}},{"name":"oauth_token","in":"query","description":"OAuth 2.0 token for the current user.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"instance","in":"path","description":"The name of the instance reporting this status. For SaaS the request will be rejected if no instance exists under this name. Format is organizations/{org}/instances/{instance}","required":true,"style":"simple","schema":{"pattern":"^organizations/[^/]+/instances/[^/]+$","type":"string"}}],"requestBody":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudApigeeV1ReportInstanceStatusRequest"}}},"required":true},"responses":{"200":{"description":"","headers":{},"content":{"text/plain":{"schema":{"type":"object","contentMediaType":"text/plain"}}}}},"deprecated":false,"security":[{"httpBearer":["https://www.googleapis.com/auth/cloud-platform"]}]},"parameters":[]},"/v1/{profileEnvironment}:computeEnvironmentScores":{"post":{"tags":["environments"],"summary":"ComputeEnvironmentScoresV1ComputeEnvironmentScores","description":"ComputeEnvironmentScores calculates scores for requested time range for the specified security profile and environment.","operationId":"ComputeEnvironmentScoresV1ComputeEnvironmentScores","parameters":[{"name":"callback","in":"query","description":"JSONP","style":"form","explode":true,"schema":{"type":"string"}},{"name":"key","in":"query","description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"alt","in":"query","description":"Data format for response. (Acceptable values are: \"json\", \"media\", \"proto\")","style":"form","explode":true,"schema":{"type":"string","default":"json"}},{"name":"uploadType","in":"query","description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"upload_protocol","in":"query","description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"Selector specifying which fields to include in a partial response.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"access_token","in":"query","description":"OAuth access token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"$.xgafv","in":"query","description":"V1 error format. (Acceptable values are: \"1\", \"2\")","style":"form","explode":true,"schema":{"type":"string","default":"1"}},{"name":"quotaUser","in":"query","description":"Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"prettyPrint","in":"query","description":"Returns response with indentations and line breaks.","style":"form","explode":true,"schema":{"type":"boolean","default":true}},{"name":"oauth_token","in":"query","description":"OAuth 2.0 token for the current user.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"profileEnvironment","in":"path","description":"Required. Name of organization and environment and profile id for which score needs to be computed. Format: organizations/{org}/securityProfiles/{profile}/environments/{env}","required":true,"style":"simple","schema":{"pattern":"^organizations/[^/]+/securityProfiles/[^/]+/environments/[^/]+$","type":"string"}}],"requestBody":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudApigeeV1ComputeEnvironmentScoresRequest"}}},"required":true},"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudApigeeV1ComputeEnvironmentScoresResponse"}}}}},"deprecated":false,"security":[{"httpBearer":["https://www.googleapis.com/auth/cloud-platform"]}]},"parameters":[]},"/v1/{parent}/environments":{"post":{"tags":["environments"],"summary":"CreateV1EnvironmentsByParent","description":"CreateSecurityProfileEnvironmentAssociation creates profile environment association i.e. attaches environment to security profile.","operationId":"CreateV1EnvironmentsByParent","parameters":[{"name":"callback","in":"query","description":"JSONP","style":"form","explode":true,"schema":{"type":"string"}},{"name":"key","in":"query","description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"alt","in":"query","description":"Data format for response. (Acceptable values are: \"json\", \"media\", \"proto\")","style":"form","explode":true,"schema":{"type":"string","default":"json"}},{"name":"uploadType","in":"query","description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"upload_protocol","in":"query","description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"Selector specifying which fields to include in a partial response.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"access_token","in":"query","description":"OAuth access token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"$.xgafv","in":"query","description":"V1 error format. (Acceptable values are: \"1\", \"2\")","style":"form","explode":true,"schema":{"type":"string","default":"1"}},{"name":"quotaUser","in":"query","description":"Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"prettyPrint","in":"query","description":"Returns response with indentations and line breaks.","style":"form","explode":true,"schema":{"type":"boolean","default":true}},{"name":"oauth_token","in":"query","description":"OAuth 2.0 token for the current user.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"parent","in":"path","description":"Required. Name of organization and security profile ID. Format: organizations/{org}/securityProfiles/{profile}","required":true,"style":"simple","schema":{"pattern":"^organizations/[^/]+/securityProfiles/[^/]+$","type":"string"}}],"requestBody":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudApigeeV1SecurityProfileEnvironmentAssociation"}}},"required":true},"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudApigeeV1SecurityProfileEnvironmentAssociation"}}}}},"deprecated":false,"security":[{"httpBearer":["https://www.googleapis.com/auth/cloud-platform"]}]},"parameters":[]},"/v1/{parent}:subscribe":{"post":{"tags":["environments"],"summary":"SubscribeV1SubscribeByParent","description":"Creates a subscription for the environment's Pub/Sub topic. The server will assign a random name for this subscription. The \"name\" and \"push_config\" must *not* be specified.","operationId":"SubscribeV1SubscribeByParent","parameters":[{"name":"callback","in":"query","description":"JSONP","style":"form","explode":true,"schema":{"type":"string"}},{"name":"key","in":"query","description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"alt","in":"query","description":"Data format for response. (Acceptable values are: \"json\", \"media\", \"proto\")","style":"form","explode":true,"schema":{"type":"string","default":"json"}},{"name":"uploadType","in":"query","description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"upload_protocol","in":"query","description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"Selector specifying which fields to include in a partial response.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"access_token","in":"query","description":"OAuth access token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"$.xgafv","in":"query","description":"V1 error format. (Acceptable values are: \"1\", \"2\")","style":"form","explode":true,"schema":{"type":"string","default":"1"}},{"name":"quotaUser","in":"query","description":"Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"prettyPrint","in":"query","description":"Returns response with indentations and line breaks.","style":"form","explode":true,"schema":{"type":"boolean","default":true}},{"name":"oauth_token","in":"query","description":"OAuth 2.0 token for the current user.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"parent","in":"path","description":"Required. Name of the environment. Use the following structure in your request: `organizations/{org}/environments/{env}`","required":true,"style":"simple","schema":{"pattern":"^organizations/[^/]+/environments/[^/]+$","type":"string"}}],"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudApigeeV1Subscription"}}}}},"deprecated":false,"security":[{"httpBearer":["https://www.googleapis.com/auth/cloud-platform"]}]},"parameters":[]},"/v1/{resource}:getIamPolicy":{"get":{"tags":["environments"],"summary":"GetIamPolicyV1GetIamPolicyByResource","description":"Gets the IAM policy on an environment. For more information, see [Manage users, roles, and permissions using the API](https://cloud.google.com/apigee/docs/api-platform/system-administration/manage-users-roles). You must have the `apigee.environments.getIamPolicy` permission to call this API.","operationId":"GetIamPolicyV1GetIamPolicyByResource","parameters":[{"name":"callback","in":"query","description":"JSONP","style":"form","explode":true,"schema":{"type":"string"}},{"name":"key","in":"query","description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"alt","in":"query","description":"Data format for response. (Acceptable values are: \"json\", \"media\", \"proto\")","style":"form","explode":true,"schema":{"type":"string","default":"json"}},{"name":"uploadType","in":"query","description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"upload_protocol","in":"query","description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"Selector specifying which fields to include in a partial response.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"access_token","in":"query","description":"OAuth access token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"$.xgafv","in":"query","description":"V1 error format. (Acceptable values are: \"1\", \"2\")","style":"form","explode":true,"schema":{"type":"string","default":"1"}},{"name":"quotaUser","in":"query","description":"Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"prettyPrint","in":"query","description":"Returns response with indentations and line breaks.","style":"form","explode":true,"schema":{"type":"boolean","default":true}},{"name":"oauth_token","in":"query","description":"OAuth 2.0 token for the current user.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"options.requestedPolicyVersion","in":"query","description":"Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).","style":"form","explode":true,"schema":{"type":"integer","contentEncoding":"int32"}},{"name":"resource","in":"path","description":"REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.","required":true,"style":"simple","schema":{"pattern":"^organizations/[^/]+/environments/[^/]+$","type":"string"}}],"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleIamV1Policy"}}}}},"deprecated":false,"security":[{"httpBearer":["https://www.googleapis.com/auth/cloud-platform"]}]},"parameters":[]},"/v1/{parent}:unsubscribe":{"post":{"tags":["environments"],"summary":"UnsubscribeV1UnsubscribeByParent","description":"Deletes a subscription for the environment's Pub/Sub topic.","operationId":"UnsubscribeV1UnsubscribeByParent","parameters":[{"name":"callback","in":"query","description":"JSONP","style":"form","explode":true,"schema":{"type":"string"}},{"name":"key","in":"query","description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"alt","in":"query","description":"Data format for response. (Acceptable values are: \"json\", \"media\", \"proto\")","style":"form","explode":true,"schema":{"type":"string","default":"json"}},{"name":"uploadType","in":"query","description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"upload_protocol","in":"query","description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"Selector specifying which fields to include in a partial response.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"access_token","in":"query","description":"OAuth access token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"$.xgafv","in":"query","description":"V1 error format. (Acceptable values are: \"1\", \"2\")","style":"form","explode":true,"schema":{"type":"string","default":"1"}},{"name":"quotaUser","in":"query","description":"Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"prettyPrint","in":"query","description":"Returns response with indentations and line breaks.","style":"form","explode":true,"schema":{"type":"boolean","default":true}},{"name":"oauth_token","in":"query","description":"OAuth 2.0 token for the current user.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"parent","in":"path","description":"Required. Name of the environment. Use the following structure in your request: `organizations/{org}/environments/{env}`","required":true,"style":"simple","schema":{"pattern":"^organizations/[^/]+/environments/[^/]+$","type":"string"}}],"requestBody":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudApigeeV1Subscription"}}},"required":true},"responses":{"200":{"description":"","headers":{},"content":{"text/plain":{"schema":{"type":"object","contentMediaType":"text/plain"}}}}},"deprecated":false,"security":[{"httpBearer":["https://www.googleapis.com/auth/cloud-platform"]}]},"parameters":[]},"/v1/{resource}:setIamPolicy":{"post":{"tags":["environments"],"summary":"SetIamPolicyV1SetIamPolicyByResource","description":"Sets the IAM policy on an environment, if the policy already exists it will be replaced. For more information, see [Manage users, roles, and permissions using the API](https://cloud.google.com/apigee/docs/api-platform/system-administration/manage-users-roles). You must have the `apigee.environments.setIamPolicy` permission to call this API.","operationId":"SetIamPolicyV1SetIamPolicyByResource","parameters":[{"name":"callback","in":"query","description":"JSONP","style":"form","explode":true,"schema":{"type":"string"}},{"name":"key","in":"query","description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"alt","in":"query","description":"Data format for response. (Acceptable values are: \"json\", \"media\", \"proto\")","style":"form","explode":true,"schema":{"type":"string","default":"json"}},{"name":"uploadType","in":"query","description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"upload_protocol","in":"query","description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"Selector specifying which fields to include in a partial response.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"access_token","in":"query","description":"OAuth access token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"$.xgafv","in":"query","description":"V1 error format. (Acceptable values are: \"1\", \"2\")","style":"form","explode":true,"schema":{"type":"string","default":"1"}},{"name":"quotaUser","in":"query","description":"Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"prettyPrint","in":"query","description":"Returns response with indentations and line breaks.","style":"form","explode":true,"schema":{"type":"boolean","default":true}},{"name":"oauth_token","in":"query","description":"OAuth 2.0 token for the current user.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"resource","in":"path","description":"REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.","required":true,"style":"simple","schema":{"pattern":"^organizations/[^/]+/environments/[^/]+$","type":"string"}}],"requestBody":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleIamV1SetIamPolicyRequest"}}},"required":true},"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleIamV1Policy"}}}}},"deprecated":false,"security":[{"httpBearer":["https://www.googleapis.com/auth/cloud-platform"]}]},"parameters":[]},"/v1/{resource}:testIamPermissions":{"post":{"tags":["environments"],"summary":"TestIamPermissionsV1TestIamPermissionsByResource","description":"Tests the permissions of a user on an environment, and returns a subset of permissions that the user has on the environment. If the environment does not exist, an empty permission set is returned (a NOT_FOUND error is not returned).","operationId":"TestIamPermissionsV1TestIamPermissionsByResource","parameters":[{"name":"callback","in":"query","description":"JSONP","style":"form","explode":true,"schema":{"type":"string"}},{"name":"key","in":"query","description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"alt","in":"query","description":"Data format for response. (Acceptable values are: \"json\", \"media\", \"proto\")","style":"form","explode":true,"schema":{"type":"string","default":"json"}},{"name":"uploadType","in":"query","description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"upload_protocol","in":"query","description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"Selector specifying which fields to include in a partial response.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"access_token","in":"query","description":"OAuth access token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"$.xgafv","in":"query","description":"V1 error format. (Acceptable values are: \"1\", \"2\")","style":"form","explode":true,"schema":{"type":"string","default":"1"}},{"name":"quotaUser","in":"query","description":"Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"prettyPrint","in":"query","description":"Returns response with indentations and line breaks.","style":"form","explode":true,"schema":{"type":"boolean","default":true}},{"name":"oauth_token","in":"query","description":"OAuth 2.0 token for the current user.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"resource","in":"path","description":"REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.","required":true,"style":"simple","schema":{"pattern":"^organizations/[^/]+/environments/[^/]+$","type":"string"}}],"requestBody":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleIamV1TestIamPermissionsRequest"}}},"required":true},"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleIamV1TestIamPermissionsResponse"}}}}},"deprecated":false,"security":[{"httpBearer":["https://www.googleapis.com/auth/cloud-platform"]}]},"parameters":[]},"/v1/{parent}/securityProfiles":{"get":{"tags":["securityProfiles"],"summary":"ListV1SecurityProfilesByParent","description":"ListSecurityProfiles lists all the security profiles associated with the org including attached and unattached profiles.","operationId":"ListV1SecurityProfilesByParent","parameters":[{"name":"callback","in":"query","description":"JSONP","style":"form","explode":true,"schema":{"type":"string"}},{"name":"key","in":"query","description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"alt","in":"query","description":"Data format for response. (Acceptable values are: \"json\", \"media\", \"proto\")","style":"form","explode":true,"schema":{"type":"string","default":"json"}},{"name":"uploadType","in":"query","description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"upload_protocol","in":"query","description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"Selector specifying which fields to include in a partial response.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"access_token","in":"query","description":"OAuth access token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"$.xgafv","in":"query","description":"V1 error format. (Acceptable values are: \"1\", \"2\")","style":"form","explode":true,"schema":{"type":"string","default":"1"}},{"name":"quotaUser","in":"query","description":"Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"prettyPrint","in":"query","description":"Returns response with indentations and line breaks.","style":"form","explode":true,"schema":{"type":"boolean","default":true}},{"name":"oauth_token","in":"query","description":"OAuth 2.0 token for the current user.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"pageToken","in":"query","description":"A page token, received from a previous `ListSecurityProfiles` call. Provide this to retrieve the subsequent page.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"parent","in":"path","description":"Required. For a specific organization, list of all the security profiles. Format: `organizations/{org}`","required":true,"style":"simple","schema":{"pattern":"^organizations/[^/]+$","type":"string"}},{"name":"pageSize","in":"query","description":"The maximum number of profiles to return. The service may return fewer than this value. If unspecified, at most 50 profiles will be returned.","style":"form","explode":true,"schema":{"type":"integer","contentEncoding":"int32"}}],"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudApigeeV1ListSecurityProfilesResponse"}}}}},"deprecated":false,"security":[{"httpBearer":["https://www.googleapis.com/auth/cloud-platform"]}]},"parameters":[]},"/v1/{name}:listRevisions":{"get":{"tags":["securityProfiles"],"summary":"ListRevisionsV1ListRevisionsByName","description":"ListSecurityProfileRevisions lists all the revisions of the security profile.","operationId":"ListRevisionsV1ListRevisionsByName","parameters":[{"name":"callback","in":"query","description":"JSONP","style":"form","explode":true,"schema":{"type":"string"}},{"name":"key","in":"query","description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"alt","in":"query","description":"Data format for response. (Acceptable values are: \"json\", \"media\", \"proto\")","style":"form","explode":true,"schema":{"type":"string","default":"json"}},{"name":"uploadType","in":"query","description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"upload_protocol","in":"query","description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"Selector specifying which fields to include in a partial response.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"access_token","in":"query","description":"OAuth access token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"$.xgafv","in":"query","description":"V1 error format. (Acceptable values are: \"1\", \"2\")","style":"form","explode":true,"schema":{"type":"string","default":"1"}},{"name":"quotaUser","in":"query","description":"Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"prettyPrint","in":"query","description":"Returns response with indentations and line breaks.","style":"form","explode":true,"schema":{"type":"boolean","default":true}},{"name":"oauth_token","in":"query","description":"OAuth 2.0 token for the current user.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"pageSize","in":"query","description":"The maximum number of profile revisions to return. The service may return fewer than this value. If unspecified, at most 50 revisions will be returned.","style":"form","explode":true,"schema":{"type":"integer","contentEncoding":"int32"}},{"name":"pageToken","in":"query","description":"A page token, received from a previous `ListSecurityProfileRevisions` call. Provide this to retrieve the subsequent page.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"name","in":"path","description":"Required. For a specific profile, list all the revisions. Format: `organizations/{org}/securityProfiles/{profile}`","required":true,"style":"simple","schema":{"pattern":"^organizations/[^/]+/securityProfiles/[^/]+$","type":"string"}}],"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudApigeeV1ListSecurityProfileRevisionsResponse"}}}}},"deprecated":false,"security":[{"httpBearer":["https://www.googleapis.com/auth/cloud-platform"]}]},"parameters":[]},"/v1/{parent}/hostSecurityReports":{"post":{"tags":["hostSecurityReports"],"summary":"CreateV1HostSecurityReportsByParent","description":"Submit a query at host level to be processed in the background. If the submission of the query succeeds, the API returns a 201 status and an ID that refer to the query. In addition to the HTTP status 201, the `state` of \"enqueued\" means that the request succeeded.","operationId":"CreateV1HostSecurityReportsByParent","parameters":[{"name":"callback","in":"query","description":"JSONP","style":"form","explode":true,"schema":{"type":"string"}},{"name":"key","in":"query","description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"alt","in":"query","description":"Data format for response. (Acceptable values are: \"json\", \"media\", \"proto\")","style":"form","explode":true,"schema":{"type":"string","default":"json"}},{"name":"uploadType","in":"query","description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"upload_protocol","in":"query","description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"Selector specifying which fields to include in a partial response.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"access_token","in":"query","description":"OAuth access token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"$.xgafv","in":"query","description":"V1 error format. (Acceptable values are: \"1\", \"2\")","style":"form","explode":true,"schema":{"type":"string","default":"1"}},{"name":"quotaUser","in":"query","description":"Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"prettyPrint","in":"query","description":"Returns response with indentations and line breaks.","style":"form","explode":true,"schema":{"type":"boolean","default":true}},{"name":"oauth_token","in":"query","description":"OAuth 2.0 token for the current user.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"parent","in":"path","description":"Required. The parent resource name. Must be of the form `organizations/{org}`.","required":true,"style":"simple","schema":{"pattern":"^organizations/[^/]+$","type":"string"}}],"requestBody":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudApigeeV1SecurityReportQuery"}}},"required":true},"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudApigeeV1SecurityReport"}}}}},"deprecated":false,"security":[{"httpBearer":["https://www.googleapis.com/auth/cloud-platform"]}]},"get":{"tags":["hostSecurityReports"],"summary":"ListV1HostSecurityReportsByParent","description":"Return a list of Security Reports at host level.","operationId":"ListV1HostSecurityReportsByParent","parameters":[{"name":"callback","in":"query","description":"JSONP","style":"form","explode":true,"schema":{"type":"string"}},{"name":"key","in":"query","description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"alt","in":"query","description":"Data format for response. (Acceptable values are: \"json\", \"media\", \"proto\")","style":"form","explode":true,"schema":{"type":"string","default":"json"}},{"name":"uploadType","in":"query","description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"upload_protocol","in":"query","description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"Selector specifying which fields to include in a partial response.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"access_token","in":"query","description":"OAuth access token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"$.xgafv","in":"query","description":"V1 error format. (Acceptable values are: \"1\", \"2\")","style":"form","explode":true,"schema":{"type":"string","default":"1"}},{"name":"quotaUser","in":"query","description":"Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"prettyPrint","in":"query","description":"Returns response with indentations and line breaks.","style":"form","explode":true,"schema":{"type":"boolean","default":true}},{"name":"oauth_token","in":"query","description":"OAuth 2.0 token for the current user.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"from","in":"query","description":"Filter response list by returning security reports that created after this date time. Time must be in ISO date-time format like '2011-12-03T10:15:30Z'.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"pageSize","in":"query","description":"The maximum number of security report to return in the list response.","style":"form","explode":true,"schema":{"type":"integer","contentEncoding":"int32"}},{"name":"dataset","in":"query","description":"Filter response list by dataset. Example: `api`, `mint`","style":"form","explode":true,"schema":{"type":"string"}},{"name":"submittedBy","in":"query","description":"Filter response list by user who submitted queries.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"to","in":"query","description":"Filter response list by returning security reports that created before this date time. Time must be in ISO date-time format like '2011-12-03T10:16:30Z'.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"pageToken","in":"query","description":"Token returned from the previous list response to fetch the next page.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"parent","in":"path","description":"Required. The parent resource name. Must be of the form `organizations/{org}`.","required":true,"style":"simple","schema":{"pattern":"^organizations/[^/]+$","type":"string"}},{"name":"envgroupHostname","in":"query","description":"Required. Filter response list by hostname.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"status","in":"query","description":"Filter response list by security report status.","style":"form","explode":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudApigeeV1ListSecurityReportsResponse"}}}}},"deprecated":false,"security":[{"httpBearer":["https://www.googleapis.com/auth/cloud-platform"]}]},"parameters":[]},"/v1/{name}/operations":{"get":{"tags":["operations"],"summary":"ListV1OperationsByName","description":"Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services to override the binding to use different resource name schemes, such as `users/*/operations`. To override the binding, API services can add a binding such as `\"/v1/{name=users/*}/operations\"` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.","operationId":"ListV1OperationsByName","parameters":[{"name":"callback","in":"query","description":"JSONP","style":"form","explode":true,"schema":{"type":"string"}},{"name":"key","in":"query","description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"alt","in":"query","description":"Data format for response. (Acceptable values are: \"json\", \"media\", \"proto\")","style":"form","explode":true,"schema":{"type":"string","default":"json"}},{"name":"uploadType","in":"query","description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"upload_protocol","in":"query","description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"Selector specifying which fields to include in a partial response.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"access_token","in":"query","description":"OAuth access token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"$.xgafv","in":"query","description":"V1 error format. (Acceptable values are: \"1\", \"2\")","style":"form","explode":true,"schema":{"type":"string","default":"1"}},{"name":"quotaUser","in":"query","description":"Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"prettyPrint","in":"query","description":"Returns response with indentations and line breaks.","style":"form","explode":true,"schema":{"type":"boolean","default":true}},{"name":"oauth_token","in":"query","description":"OAuth 2.0 token for the current user.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"name","in":"path","description":"The name of the operation's parent resource.","required":true,"style":"simple","schema":{"pattern":"^organizations/[^/]+$","type":"string"}},{"name":"filter","in":"query","description":"The standard list filter.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"pageToken","in":"query","description":"The standard list page token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"pageSize","in":"query","description":"The standard list page size.","style":"form","explode":true,"schema":{"type":"integer","contentEncoding":"int32"}}],"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleLongrunningListOperationsResponse"}}}}},"deprecated":false,"security":[{"httpBearer":["https://www.googleapis.com/auth/cloud-platform"]}]},"parameters":[]},"/v1/{parent}/datacollectors":{"get":{"tags":["datacollectors"],"summary":"ListV1DatacollectorsByParent","description":"Lists all data collectors.","operationId":"ListV1DatacollectorsByParent","parameters":[{"name":"callback","in":"query","description":"JSONP","style":"form","explode":true,"schema":{"type":"string"}},{"name":"key","in":"query","description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"alt","in":"query","description":"Data format for response. (Acceptable values are: \"json\", \"media\", \"proto\")","style":"form","explode":true,"schema":{"type":"string","default":"json"}},{"name":"uploadType","in":"query","description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"upload_protocol","in":"query","description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"Selector specifying which fields to include in a partial response.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"access_token","in":"query","description":"OAuth access token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"$.xgafv","in":"query","description":"V1 error format. (Acceptable values are: \"1\", \"2\")","style":"form","explode":true,"schema":{"type":"string","default":"1"}},{"name":"quotaUser","in":"query","description":"Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"prettyPrint","in":"query","description":"Returns response with indentations and line breaks.","style":"form","explode":true,"schema":{"type":"boolean","default":true}},{"name":"oauth_token","in":"query","description":"OAuth 2.0 token for the current user.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"pageToken","in":"query","description":"Page token, returned from a previous ListDataCollectors call, that you can use to retrieve the next page.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"pageSize","in":"query","description":"Maximum number of data collectors to return. The page size defaults to 25.","style":"form","explode":true,"schema":{"type":"integer","contentEncoding":"int32"}},{"name":"parent","in":"path","description":"Required. Name of the organization for which to list data collectors in the following format: `organizations/{org}`.","required":true,"style":"simple","schema":{"pattern":"^organizations/[^/]+$","type":"string"}}],"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudApigeeV1ListDataCollectorsResponse"}}}}},"deprecated":false,"security":[{"httpBearer":["https://www.googleapis.com/auth/cloud-platform"]}]},"post":{"tags":["datacollectors"],"summary":"CreateV1DatacollectorsByParent","description":"Creates a new data collector.","operationId":"CreateV1DatacollectorsByParent","parameters":[{"name":"callback","in":"query","description":"JSONP","style":"form","explode":true,"schema":{"type":"string"}},{"name":"key","in":"query","description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"alt","in":"query","description":"Data format for response. (Acceptable values are: \"json\", \"media\", \"proto\")","style":"form","explode":true,"schema":{"type":"string","default":"json"}},{"name":"uploadType","in":"query","description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"upload_protocol","in":"query","description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"Selector specifying which fields to include in a partial response.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"access_token","in":"query","description":"OAuth access token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"$.xgafv","in":"query","description":"V1 error format. (Acceptable values are: \"1\", \"2\")","style":"form","explode":true,"schema":{"type":"string","default":"1"}},{"name":"quotaUser","in":"query","description":"Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"prettyPrint","in":"query","description":"Returns response with indentations and line breaks.","style":"form","explode":true,"schema":{"type":"boolean","default":true}},{"name":"oauth_token","in":"query","description":"OAuth 2.0 token for the current user.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"parent","in":"path","description":"Required. Name of the organization in which to create the data collector in the following format: `organizations/{org}`.","required":true,"style":"simple","schema":{"pattern":"^organizations/[^/]+$","type":"string"}},{"name":"dataCollectorId","in":"query","description":"ID of the data collector. Overrides any ID in the data collector resource. Must be a string beginning with `dc_` that contains only letters, numbers, and underscores.","style":"form","explode":true,"schema":{"type":"string"}}],"requestBody":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudApigeeV1DataCollector"}}},"required":true},"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudApigeeV1DataCollector"}}}}},"deprecated":false,"security":[{"httpBearer":["https://www.googleapis.com/auth/cloud-platform"]}]},"parameters":[]},"/v1/{parent}/reports":{"post":{"tags":["reports"],"summary":"CreateV1ReportsByParent","description":"Creates a Custom Report for an Organization. A Custom Report provides Apigee Customers to create custom dashboards in addition to the standard dashboards which are provided. The Custom Report in its simplest form contains specifications about metrics, dimensions and filters. It is important to note that the custom report by itself does not provide an executable entity. The Edge UI converts the custom report definition into an analytics query and displays the result in a chart.","operationId":"CreateV1ReportsByParent","parameters":[{"name":"callback","in":"query","description":"JSONP","style":"form","explode":true,"schema":{"type":"string"}},{"name":"key","in":"query","description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"alt","in":"query","description":"Data format for response. (Acceptable values are: \"json\", \"media\", \"proto\")","style":"form","explode":true,"schema":{"type":"string","default":"json"}},{"name":"uploadType","in":"query","description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"upload_protocol","in":"query","description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"Selector specifying which fields to include in a partial response.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"access_token","in":"query","description":"OAuth access token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"$.xgafv","in":"query","description":"V1 error format. (Acceptable values are: \"1\", \"2\")","style":"form","explode":true,"schema":{"type":"string","default":"1"}},{"name":"quotaUser","in":"query","description":"Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"prettyPrint","in":"query","description":"Returns response with indentations and line breaks.","style":"form","explode":true,"schema":{"type":"boolean","default":true}},{"name":"oauth_token","in":"query","description":"OAuth 2.0 token for the current user.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"parent","in":"path","description":"Required. The parent organization name under which the Custom Report will be created. Must be of the form: `organizations/{organization_id}/reports`","required":true,"style":"simple","schema":{"pattern":"^organizations/[^/]+$","type":"string"}}],"requestBody":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudApigeeV1CustomReport"}}},"required":true},"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudApigeeV1CustomReport"}}}}},"deprecated":false,"security":[{"httpBearer":["https://www.googleapis.com/auth/cloud-platform"]}]},"get":{"tags":["reports"],"summary":"ListV1ReportsByParent","description":"Return a list of Custom Reports","operationId":"ListV1ReportsByParent","parameters":[{"name":"callback","in":"query","description":"JSONP","style":"form","explode":true,"schema":{"type":"string"}},{"name":"key","in":"query","description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"alt","in":"query","description":"Data format for response. (Acceptable values are: \"json\", \"media\", \"proto\")","style":"form","explode":true,"schema":{"type":"string","default":"json"}},{"name":"uploadType","in":"query","description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"upload_protocol","in":"query","description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"Selector specifying which fields to include in a partial response.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"access_token","in":"query","description":"OAuth access token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"$.xgafv","in":"query","description":"V1 error format. (Acceptable values are: \"1\", \"2\")","style":"form","explode":true,"schema":{"type":"string","default":"1"}},{"name":"quotaUser","in":"query","description":"Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"prettyPrint","in":"query","description":"Returns response with indentations and line breaks.","style":"form","explode":true,"schema":{"type":"boolean","default":true}},{"name":"oauth_token","in":"query","description":"OAuth 2.0 token for the current user.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"parent","in":"path","description":"Required. The parent organization name under which the API product will be listed `organizations/{organization_id}/reports`","required":true,"style":"simple","schema":{"pattern":"^organizations/[^/]+$","type":"string"}},{"name":"expand","in":"query","description":"Set to 'true' to get expanded details about each custom report.","style":"form","explode":true,"schema":{"type":"boolean"}}],"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudApigeeV1ListCustomReportsResponse"}}}}},"deprecated":false,"security":[{"httpBearer":["https://www.googleapis.com/auth/cloud-platform"]}]},"parameters":[]},"/v1/{parent}/entries":{"get":{"tags":["entries"],"summary":"ListV1EntriesByParent","description":"Lists key value entries for key values maps scoped to an organization, environment, or API proxy. **Note**: Supported for Apigee hybrid 1.8.x and higher.","operationId":"ListV1EntriesByParent","parameters":[{"name":"callback","in":"query","description":"JSONP","style":"form","explode":true,"schema":{"type":"string"}},{"name":"key","in":"query","description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"alt","in":"query","description":"Data format for response. (Acceptable values are: \"json\", \"media\", \"proto\")","style":"form","explode":true,"schema":{"type":"string","default":"json"}},{"name":"uploadType","in":"query","description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"upload_protocol","in":"query","description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"Selector specifying which fields to include in a partial response.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"access_token","in":"query","description":"OAuth access token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"$.xgafv","in":"query","description":"V1 error format. (Acceptable values are: \"1\", \"2\")","style":"form","explode":true,"schema":{"type":"string","default":"1"}},{"name":"quotaUser","in":"query","description":"Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"prettyPrint","in":"query","description":"Returns response with indentations and line breaks.","style":"form","explode":true,"schema":{"type":"boolean","default":true}},{"name":"oauth_token","in":"query","description":"OAuth 2.0 token for the current user.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"parent","in":"path","description":"Required. Scope as indicated by the URI in which to list key value maps. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}`.","required":true,"style":"simple","schema":{"pattern":"^organizations/[^/]+/keyvaluemaps/[^/]+$","type":"string"}},{"name":"pageToken","in":"query","description":"Optional. Page token. If provides, must be a valid key value entry returned from a previous call that can be used to retrieve the next page.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"pageSize","in":"query","description":"Optional. Maximum number of key value entries to return. If unspecified, at most 100 entries will be returned.","style":"form","explode":true,"schema":{"type":"integer","contentEncoding":"int32"}}],"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudApigeeV1ListKeyValueEntriesResponse"}}}}},"deprecated":false,"security":[{"httpBearer":["https://www.googleapis.com/auth/cloud-platform"]}]},"post":{"tags":["entries"],"summary":"CreateV1EntriesByParent","description":"Creates key value entries in a key value map scoped to an organization, environment, or API proxy. **Note**: Supported for Apigee hybrid 1.8.x and higher.","operationId":"CreateV1EntriesByParent","parameters":[{"name":"callback","in":"query","description":"JSONP","style":"form","explode":true,"schema":{"type":"string"}},{"name":"key","in":"query","description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"alt","in":"query","description":"Data format for response. (Acceptable values are: \"json\", \"media\", \"proto\")","style":"form","explode":true,"schema":{"type":"string","default":"json"}},{"name":"uploadType","in":"query","description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"upload_protocol","in":"query","description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"Selector specifying which fields to include in a partial response.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"access_token","in":"query","description":"OAuth access token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"$.xgafv","in":"query","description":"V1 error format. (Acceptable values are: \"1\", \"2\")","style":"form","explode":true,"schema":{"type":"string","default":"1"}},{"name":"quotaUser","in":"query","description":"Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"prettyPrint","in":"query","description":"Returns response with indentations and line breaks.","style":"form","explode":true,"schema":{"type":"boolean","default":true}},{"name":"oauth_token","in":"query","description":"OAuth 2.0 token for the current user.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"parent","in":"path","description":"Required. Scope as indicated by the URI in which to create the key value map entry. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}`.","required":true,"style":"simple","schema":{"pattern":"^organizations/[^/]+/keyvaluemaps/[^/]+$","type":"string"}}],"requestBody":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudApigeeV1KeyValueEntry"}}},"required":true},"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudApigeeV1KeyValueEntry"}}}}},"deprecated":false,"security":[{"httpBearer":["https://www.googleapis.com/auth/cloud-platform"]}]},"parameters":[]},"/v1/{parent}/keyvaluemaps":{"post":{"tags":["keyvaluemaps"],"summary":"CreateV1KeyvaluemapsByParent","description":"Creates a key value map in an organization.","operationId":"CreateV1KeyvaluemapsByParent","parameters":[{"name":"callback","in":"query","description":"JSONP","style":"form","explode":true,"schema":{"type":"string"}},{"name":"key","in":"query","description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"alt","in":"query","description":"Data format for response. (Acceptable values are: \"json\", \"media\", \"proto\")","style":"form","explode":true,"schema":{"type":"string","default":"json"}},{"name":"uploadType","in":"query","description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"upload_protocol","in":"query","description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"Selector specifying which fields to include in a partial response.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"access_token","in":"query","description":"OAuth access token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"$.xgafv","in":"query","description":"V1 error format. (Acceptable values are: \"1\", \"2\")","style":"form","explode":true,"schema":{"type":"string","default":"1"}},{"name":"quotaUser","in":"query","description":"Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"prettyPrint","in":"query","description":"Returns response with indentations and line breaks.","style":"form","explode":true,"schema":{"type":"boolean","default":true}},{"name":"oauth_token","in":"query","description":"OAuth 2.0 token for the current user.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"parent","in":"path","description":"Required. Name of the organization in which to create the key value map file. Use the following structure in your request: `organizations/{org}`","required":true,"style":"simple","schema":{"pattern":"^organizations/[^/]+$","type":"string"}}],"requestBody":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudApigeeV1KeyValueMap"}}},"required":true},"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudApigeeV1KeyValueMap"}}}}},"deprecated":false,"security":[{"httpBearer":["https://www.googleapis.com/auth/cloud-platform"]}]},"parameters":[]},"/v1/{parent}/apis":{"post":{"tags":["apis"],"summary":"CreateV1ApisByParent","description":"Creates an API proxy. The API proxy created will not be accessible at runtime until it is deployed to an environment. Create a new API proxy by setting the `name` query parameter to the name of the API proxy. Import an API proxy configuration bundle stored in zip format on your local machine to your organization by doing the following: * Set the `name` query parameter to the name of the API proxy. * Set the `action` query parameter to `import`. * Set the `Content-Type` header to `multipart/form-data`. * Pass as a file the name of API proxy configuration bundle stored in zip format on your local machine using the `file` form field. **Note**: To validate the API proxy configuration bundle only without importing it, set the `action` query parameter to `validate`. When importing an API proxy configuration bundle, if the API proxy does not exist, it will be created. If the API proxy exists, then a new revision is created. Invalid API proxy configurations are rejected, and a list of validation errors is returned to the client.","operationId":"CreateV1ApisByParent","parameters":[{"name":"callback","in":"query","description":"JSONP","style":"form","explode":true,"schema":{"type":"string"}},{"name":"key","in":"query","description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"alt","in":"query","description":"Data format for response. (Acceptable values are: \"json\", \"media\", \"proto\")","style":"form","explode":true,"schema":{"type":"string","default":"json"}},{"name":"uploadType","in":"query","description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"upload_protocol","in":"query","description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"Selector specifying which fields to include in a partial response.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"access_token","in":"query","description":"OAuth access token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"$.xgafv","in":"query","description":"V1 error format. (Acceptable values are: \"1\", \"2\")","style":"form","explode":true,"schema":{"type":"string","default":"1"}},{"name":"quotaUser","in":"query","description":"Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"prettyPrint","in":"query","description":"Returns response with indentations and line breaks.","style":"form","explode":true,"schema":{"type":"boolean","default":true}},{"name":"oauth_token","in":"query","description":"OAuth 2.0 token for the current user.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"parent","in":"path","description":"Required. Name of the organization in the following format: `organizations/{org}`","required":true,"style":"simple","schema":{"pattern":"^organizations/[^/]+$","type":"string"}},{"name":"validate","in":"query","description":"Ignored. All uploads are validated regardless of the value of this field. Maintained for compatibility with Apigee Edge API.","style":"form","explode":true,"schema":{"type":"boolean"}},{"name":"action","in":"query","description":"Action to perform when importing an API proxy configuration bundle. Set this parameter to one of the following values: * `import` to import the API proxy configuration bundle. * `validate` to validate the API proxy configuration bundle without importing it.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"name","in":"query","description":"Name of the API proxy. Restrict the characters used to: A-Za-z0-9._-","style":"form","explode":true,"schema":{"type":"string"}}],"requestBody":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleApiHttpBody"}}},"required":true},"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudApigeeV1ApiProxyRevision"}}}}},"deprecated":false,"security":[{"httpBearer":["https://www.googleapis.com/auth/cloud-platform"]}]},"get":{"tags":["apis"],"summary":"ListV1ApisByParent","description":"Lists the names of all API proxies in an organization. The names returned correspond to the names defined in the configuration files for each API proxy.","operationId":"ListV1ApisByParent","parameters":[{"name":"callback","in":"query","description":"JSONP","style":"form","explode":true,"schema":{"type":"string"}},{"name":"key","in":"query","description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"alt","in":"query","description":"Data format for response. (Acceptable values are: \"json\", \"media\", \"proto\")","style":"form","explode":true,"schema":{"type":"string","default":"json"}},{"name":"uploadType","in":"query","description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"upload_protocol","in":"query","description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"Selector specifying which fields to include in a partial response.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"access_token","in":"query","description":"OAuth access token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"$.xgafv","in":"query","description":"V1 error format. (Acceptable values are: \"1\", \"2\")","style":"form","explode":true,"schema":{"type":"string","default":"1"}},{"name":"quotaUser","in":"query","description":"Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"prettyPrint","in":"query","description":"Returns response with indentations and line breaks.","style":"form","explode":true,"schema":{"type":"boolean","default":true}},{"name":"oauth_token","in":"query","description":"OAuth 2.0 token for the current user.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"parent","in":"path","description":"Required. Name of the organization in the following format: `organizations/{org}`","required":true,"style":"simple","schema":{"pattern":"^organizations/[^/]+$","type":"string"}},{"name":"includeMetaData","in":"query","description":"Flag that specifies whether to include API proxy metadata in the response.","style":"form","explode":true,"schema":{"type":"boolean"}},{"name":"includeRevisions","in":"query","description":"Flag that specifies whether to include a list of revisions in the response.","style":"form","explode":true,"schema":{"type":"boolean"}}],"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudApigeeV1ListApiProxiesResponse"}}}}},"deprecated":false,"security":[{"httpBearer":["https://www.googleapis.com/auth/cloud-platform"]}]},"parameters":[]},"/v1/{parent}/analytics/datastores":{"post":{"tags":["datastores"],"summary":"CreateV1AnalyticsDatastoresByParent","description":"Create a Datastore for an org","operationId":"CreateV1AnalyticsDatastoresByParent","parameters":[{"name":"callback","in":"query","description":"JSONP","style":"form","explode":true,"schema":{"type":"string"}},{"name":"key","in":"query","description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"alt","in":"query","description":"Data format for response. (Acceptable values are: \"json\", \"media\", \"proto\")","style":"form","explode":true,"schema":{"type":"string","default":"json"}},{"name":"uploadType","in":"query","description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"upload_protocol","in":"query","description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"Selector specifying which fields to include in a partial response.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"access_token","in":"query","description":"OAuth access token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"$.xgafv","in":"query","description":"V1 error format. (Acceptable values are: \"1\", \"2\")","style":"form","explode":true,"schema":{"type":"string","default":"1"}},{"name":"quotaUser","in":"query","description":"Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"prettyPrint","in":"query","description":"Returns response with indentations and line breaks.","style":"form","explode":true,"schema":{"type":"boolean","default":true}},{"name":"oauth_token","in":"query","description":"OAuth 2.0 token for the current user.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"parent","in":"path","description":"Required. The parent organization name. Must be of the form `organizations/{org}`.","required":true,"style":"simple","schema":{"pattern":"^organizations/[^/]+$","type":"string"}}],"requestBody":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudApigeeV1Datastore"}}},"required":true},"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudApigeeV1Datastore"}}}}},"deprecated":false,"security":[{"httpBearer":["https://www.googleapis.com/auth/cloud-platform"]}]},"get":{"tags":["datastores"],"summary":"ListV1AnalyticsDatastoresByParent","description":"List Datastores","operationId":"ListV1AnalyticsDatastoresByParent","parameters":[{"name":"callback","in":"query","description":"JSONP","style":"form","explode":true,"schema":{"type":"string"}},{"name":"key","in":"query","description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"alt","in":"query","description":"Data format for response. (Acceptable values are: \"json\", \"media\", \"proto\")","style":"form","explode":true,"schema":{"type":"string","default":"json"}},{"name":"uploadType","in":"query","description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"upload_protocol","in":"query","description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"Selector specifying which fields to include in a partial response.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"access_token","in":"query","description":"OAuth access token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"$.xgafv","in":"query","description":"V1 error format. (Acceptable values are: \"1\", \"2\")","style":"form","explode":true,"schema":{"type":"string","default":"1"}},{"name":"quotaUser","in":"query","description":"Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"prettyPrint","in":"query","description":"Returns response with indentations and line breaks.","style":"form","explode":true,"schema":{"type":"boolean","default":true}},{"name":"oauth_token","in":"query","description":"OAuth 2.0 token for the current user.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"parent","in":"path","description":"Required. The parent organization name. Must be of the form `organizations/{org}`.","required":true,"style":"simple","schema":{"pattern":"^organizations/[^/]+$","type":"string"}},{"name":"targetType","in":"query","description":"Optional. TargetType is used to fetch all Datastores that match the type","style":"form","explode":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudApigeeV1ListDatastoresResponse"}}}}},"deprecated":false,"security":[{"httpBearer":["https://www.googleapis.com/auth/cloud-platform"]}]},"parameters":[]},"/v1/{parent}/analytics/datastores:test":{"post":{"tags":["datastores"],"summary":"TestV1AnalyticsDatastoresTestByParent","description":"Test if Datastore configuration is correct. This includes checking if credentials provided by customer have required permissions in target destination storage","operationId":"TestV1AnalyticsDatastoresTestByParent","parameters":[{"name":"callback","in":"query","description":"JSONP","style":"form","explode":true,"schema":{"type":"string"}},{"name":"key","in":"query","description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"alt","in":"query","description":"Data format for response. (Acceptable values are: \"json\", \"media\", \"proto\")","style":"form","explode":true,"schema":{"type":"string","default":"json"}},{"name":"uploadType","in":"query","description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"upload_protocol","in":"query","description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"Selector specifying which fields to include in a partial response.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"access_token","in":"query","description":"OAuth access token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"$.xgafv","in":"query","description":"V1 error format. (Acceptable values are: \"1\", \"2\")","style":"form","explode":true,"schema":{"type":"string","default":"1"}},{"name":"quotaUser","in":"query","description":"Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"prettyPrint","in":"query","description":"Returns response with indentations and line breaks.","style":"form","explode":true,"schema":{"type":"boolean","default":true}},{"name":"oauth_token","in":"query","description":"OAuth 2.0 token for the current user.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"parent","in":"path","description":"Required. The parent organization name Must be of the form `organizations/{org}`","required":true,"style":"simple","schema":{"pattern":"^organizations/[^/]+$","type":"string"}}],"requestBody":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudApigeeV1Datastore"}}},"required":true},"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudApigeeV1TestDatastoreResponse"}}}}},"deprecated":false,"security":[{"httpBearer":["https://www.googleapis.com/auth/cloud-platform"]}]},"parameters":[]},"/v1/{parent}/rateplans":{"get":{"tags":["rateplans"],"summary":"ListV1RateplansByParent","description":"Lists all the rate plans for an API product.","operationId":"ListV1RateplansByParent","parameters":[{"name":"callback","in":"query","description":"JSONP","style":"form","explode":true,"schema":{"type":"string"}},{"name":"key","in":"query","description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"alt","in":"query","description":"Data format for response. (Acceptable values are: \"json\", \"media\", \"proto\")","style":"form","explode":true,"schema":{"type":"string","default":"json"}},{"name":"uploadType","in":"query","description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"upload_protocol","in":"query","description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"Selector specifying which fields to include in a partial response.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"access_token","in":"query","description":"OAuth access token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"$.xgafv","in":"query","description":"V1 error format. (Acceptable values are: \"1\", \"2\")","style":"form","explode":true,"schema":{"type":"string","default":"1"}},{"name":"quotaUser","in":"query","description":"Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"prettyPrint","in":"query","description":"Returns response with indentations and line breaks.","style":"form","explode":true,"schema":{"type":"boolean","default":true}},{"name":"oauth_token","in":"query","description":"OAuth 2.0 token for the current user.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"parent","in":"path","description":"Required. Name of the API product. Use the following structure in your request: `organizations/{org}/apiproducts/{apiproduct}` Use `organizations/{org}/apiproducts/-` to return rate plans for all API products within the organization.","required":true,"style":"simple","schema":{"pattern":"^organizations/[^/]+/apiproducts/[^/]+$","type":"string"}},{"name":"expand","in":"query","description":"Flag that specifies whether to expand the results. Set to `true` to get expanded details about each API. Defaults to `false`.","style":"form","explode":true,"schema":{"type":"boolean"}},{"name":"startKey","in":"query","description":"Name of the rate plan from which to start displaying the list of rate plans. If omitted, the list starts from the first item. For example, to view the rate plans from 51-150, set the value of `startKey` to the name of the 51st rate plan and set the value of `count` to 100.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"state","in":"query","description":"State of the rate plans (`DRAFT`, `PUBLISHED`) that you want to display. (Acceptable values are: \"STATE_UNSPECIFIED\", \"DRAFT\", \"PUBLISHED\")","style":"form","explode":true,"schema":{"type":"string","default":"STATE_UNSPECIFIED"}},{"name":"count","in":"query","description":"Number of rate plans to return in the API call. Use with the `startKey` parameter to provide more targeted filtering. The maximum limit is 1000. Defaults to 100.","style":"form","explode":true,"schema":{"type":"integer","contentEncoding":"int32"}},{"name":"orderBy","in":"query","description":"Name of the attribute used for sorting. Valid values include: * `name`: Name of the rate plan. * `state`: State of the rate plan (`DRAFT`, `PUBLISHED`). * `startTime`: Time when the rate plan becomes active. * `endTime`: Time when the rate plan expires. **Note**: Not supported by Apigee at this time.","style":"form","explode":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudApigeeV1ListRatePlansResponse"}}}}},"deprecated":false,"security":[{"httpBearer":["https://www.googleapis.com/auth/cloud-platform"]}]},"post":{"tags":["rateplans"],"summary":"CreateV1RateplansByParent","description":"Create a rate plan that is associated with an API product in an organization. Using rate plans, API product owners can monetize their API products by configuring one or more of the following: - Billing frequency - Initial setup fees for using an API product - Payment funding model (postpaid only) - Fixed recurring or consumption-based charges for using an API product - Revenue sharing with developer partners An API product can have multiple rate plans associated with it but *only one* rate plan can be active at any point of time. **Note: From the developer's perspective, they purchase API products not rate plans.","operationId":"CreateV1RateplansByParent","parameters":[{"name":"callback","in":"query","description":"JSONP","style":"form","explode":true,"schema":{"type":"string"}},{"name":"key","in":"query","description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"alt","in":"query","description":"Data format for response. (Acceptable values are: \"json\", \"media\", \"proto\")","style":"form","explode":true,"schema":{"type":"string","default":"json"}},{"name":"uploadType","in":"query","description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"upload_protocol","in":"query","description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"Selector specifying which fields to include in a partial response.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"access_token","in":"query","description":"OAuth access token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"$.xgafv","in":"query","description":"V1 error format. (Acceptable values are: \"1\", \"2\")","style":"form","explode":true,"schema":{"type":"string","default":"1"}},{"name":"quotaUser","in":"query","description":"Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"prettyPrint","in":"query","description":"Returns response with indentations and line breaks.","style":"form","explode":true,"schema":{"type":"boolean","default":true}},{"name":"oauth_token","in":"query","description":"OAuth 2.0 token for the current user.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"parent","in":"path","description":"Required. Name of the API product that is associated with the rate plan. Use the following structure in your request: `organizations/{org}/apiproducts/{apiproduct}`","required":true,"style":"simple","schema":{"pattern":"^organizations/[^/]+/apiproducts/[^/]+$","type":"string"}}],"requestBody":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudApigeeV1RatePlan"}}},"required":true},"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudApigeeV1RatePlan"}}}}},"deprecated":false,"security":[{"httpBearer":["https://www.googleapis.com/auth/cloud-platform"]}]},"parameters":[]},"/v1/{parent}/references":{"post":{"tags":["references"],"summary":"CreateV1ReferencesByParent","description":"Creates a Reference in the specified environment.","operationId":"CreateV1ReferencesByParent","parameters":[{"name":"callback","in":"query","description":"JSONP","style":"form","explode":true,"schema":{"type":"string"}},{"name":"key","in":"query","description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"alt","in":"query","description":"Data format for response. (Acceptable values are: \"json\", \"media\", \"proto\")","style":"form","explode":true,"schema":{"type":"string","default":"json"}},{"name":"uploadType","in":"query","description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"upload_protocol","in":"query","description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"Selector specifying which fields to include in a partial response.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"access_token","in":"query","description":"OAuth access token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"$.xgafv","in":"query","description":"V1 error format. (Acceptable values are: \"1\", \"2\")","style":"form","explode":true,"schema":{"type":"string","default":"1"}},{"name":"quotaUser","in":"query","description":"Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"prettyPrint","in":"query","description":"Returns response with indentations and line breaks.","style":"form","explode":true,"schema":{"type":"boolean","default":true}},{"name":"oauth_token","in":"query","description":"OAuth 2.0 token for the current user.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"parent","in":"path","description":"Required. The parent environment name under which the Reference will be created. Must be of the form `organizations/{org}/environments/{env}`.","required":true,"style":"simple","schema":{"pattern":"^organizations/[^/]+/environments/[^/]+$","type":"string"}}],"requestBody":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudApigeeV1Reference"}}},"required":true},"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudApigeeV1Reference"}}}}},"deprecated":false,"security":[{"httpBearer":["https://www.googleapis.com/auth/cloud-platform"]}]},"parameters":[]},"/v1/{orgenv}/securityStats:queryTabularStats":{"post":{"tags":["securityStats"],"summary":"QueryTabularStatsV1SecurityStatsQueryTabularStatsByOrgenv","description":"Retrieve security statistics as tabular rows.","operationId":"QueryTabularStatsV1SecurityStatsQueryTabularStatsByOrgenv","parameters":[{"name":"callback","in":"query","description":"JSONP","style":"form","explode":true,"schema":{"type":"string"}},{"name":"key","in":"query","description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"alt","in":"query","description":"Data format for response. (Acceptable values are: \"json\", \"media\", \"proto\")","style":"form","explode":true,"schema":{"type":"string","default":"json"}},{"name":"uploadType","in":"query","description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"upload_protocol","in":"query","description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"Selector specifying which fields to include in a partial response.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"access_token","in":"query","description":"OAuth access token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"$.xgafv","in":"query","description":"V1 error format. (Acceptable values are: \"1\", \"2\")","style":"form","explode":true,"schema":{"type":"string","default":"1"}},{"name":"quotaUser","in":"query","description":"Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"prettyPrint","in":"query","description":"Returns response with indentations and line breaks.","style":"form","explode":true,"schema":{"type":"boolean","default":true}},{"name":"oauth_token","in":"query","description":"OAuth 2.0 token for the current user.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"orgenv","in":"path","description":"Required. Should be of the form organizations//environments/.","required":true,"style":"simple","schema":{"pattern":"^organizations/[^/]+/environments/[^/]+$","type":"string"}}],"requestBody":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudApigeeV1QueryTabularStatsRequest"}}},"required":true},"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudApigeeV1QueryTabularStatsResponse"}}}}},"deprecated":false,"security":[{"httpBearer":["https://www.googleapis.com/auth/cloud-platform"]}]},"parameters":[]},"/v1/{orgenv}/securityStats:queryTimeSeriesStats":{"post":{"tags":["securityStats"],"summary":"QueryTimeSeriesStatsV1SecurityStatsQueryTimeSeriesStats","description":"Retrieve security statistics as a collection of time series.","operationId":"QueryTimeSeriesStatsV1SecurityStatsQueryTimeSeriesStats","parameters":[{"name":"callback","in":"query","description":"JSONP","style":"form","explode":true,"schema":{"type":"string"}},{"name":"key","in":"query","description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"alt","in":"query","description":"Data format for response. (Acceptable values are: \"json\", \"media\", \"proto\")","style":"form","explode":true,"schema":{"type":"string","default":"json"}},{"name":"uploadType","in":"query","description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"upload_protocol","in":"query","description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"Selector specifying which fields to include in a partial response.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"access_token","in":"query","description":"OAuth access token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"$.xgafv","in":"query","description":"V1 error format. (Acceptable values are: \"1\", \"2\")","style":"form","explode":true,"schema":{"type":"string","default":"1"}},{"name":"quotaUser","in":"query","description":"Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"prettyPrint","in":"query","description":"Returns response with indentations and line breaks.","style":"form","explode":true,"schema":{"type":"boolean","default":true}},{"name":"oauth_token","in":"query","description":"OAuth 2.0 token for the current user.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"orgenv","in":"path","description":"Required. Should be of the form organizations//environments/.","required":true,"style":"simple","schema":{"pattern":"^organizations/[^/]+/environments/[^/]+$","type":"string"}}],"requestBody":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudApigeeV1QueryTimeSeriesStatsRequest"}}},"required":true},"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudApigeeV1QueryTimeSeriesStatsResponse"}}}}},"deprecated":false,"security":[{"httpBearer":["https://www.googleapis.com/auth/cloud-platform"]}]},"parameters":[]},"/v1/{parent}/queries":{"get":{"tags":["queries"],"summary":"ListV1QueriesByParent","description":"Return a list of Asynchronous Queries","operationId":"ListV1QueriesByParent","parameters":[{"name":"callback","in":"query","description":"JSONP","style":"form","explode":true,"schema":{"type":"string"}},{"name":"key","in":"query","description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"alt","in":"query","description":"Data format for response. (Acceptable values are: \"json\", \"media\", \"proto\")","style":"form","explode":true,"schema":{"type":"string","default":"json"}},{"name":"uploadType","in":"query","description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"upload_protocol","in":"query","description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"Selector specifying which fields to include in a partial response.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"access_token","in":"query","description":"OAuth access token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"$.xgafv","in":"query","description":"V1 error format. (Acceptable values are: \"1\", \"2\")","style":"form","explode":true,"schema":{"type":"string","default":"1"}},{"name":"quotaUser","in":"query","description":"Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"prettyPrint","in":"query","description":"Returns response with indentations and line breaks.","style":"form","explode":true,"schema":{"type":"boolean","default":true}},{"name":"oauth_token","in":"query","description":"OAuth 2.0 token for the current user.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"inclQueriesWithoutReport","in":"query","description":"Flag to include asynchronous queries that don't have a report denifition.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"dataset","in":"query","description":"Filter response list by dataset. Example: `api`, `mint`","style":"form","explode":true,"schema":{"type":"string"}},{"name":"to","in":"query","description":"Filter response list by returning asynchronous queries that created before this date time. Time must be in ISO date-time format like '2011-12-03T10:16:30Z'.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"from","in":"query","description":"Filter response list by returning asynchronous queries that created after this date time. Time must be in ISO date-time format like '2011-12-03T10:15:30Z'.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"status","in":"query","description":"Filter response list by asynchronous query status.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"parent","in":"path","description":"Required. The parent resource name. Must be of the form `organizations/{org}/environments/{env}`.","required":true,"style":"simple","schema":{"pattern":"^organizations/[^/]+/environments/[^/]+$","type":"string"}},{"name":"submittedBy","in":"query","description":"Filter response list by user who submitted queries.","style":"form","explode":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudApigeeV1ListAsyncQueriesResponse"}}}}},"deprecated":false,"security":[{"httpBearer":["https://www.googleapis.com/auth/cloud-platform"]}]},"post":{"tags":["queries"],"summary":"CreateV1QueriesByParent","description":"Submit a query to be processed in the background. If the submission of the query succeeds, the API returns a 201 status and an ID that refer to the query. In addition to the HTTP status 201, the `state` of \"enqueued\" means that the request succeeded.","operationId":"CreateV1QueriesByParent","parameters":[{"name":"callback","in":"query","description":"JSONP","style":"form","explode":true,"schema":{"type":"string"}},{"name":"key","in":"query","description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"alt","in":"query","description":"Data format for response. (Acceptable values are: \"json\", \"media\", \"proto\")","style":"form","explode":true,"schema":{"type":"string","default":"json"}},{"name":"uploadType","in":"query","description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"upload_protocol","in":"query","description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"Selector specifying which fields to include in a partial response.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"access_token","in":"query","description":"OAuth access token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"$.xgafv","in":"query","description":"V1 error format. (Acceptable values are: \"1\", \"2\")","style":"form","explode":true,"schema":{"type":"string","default":"1"}},{"name":"quotaUser","in":"query","description":"Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"prettyPrint","in":"query","description":"Returns response with indentations and line breaks.","style":"form","explode":true,"schema":{"type":"boolean","default":true}},{"name":"oauth_token","in":"query","description":"OAuth 2.0 token for the current user.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"parent","in":"path","description":"Required. The parent resource name. Must be of the form `organizations/{org}/environments/{env}`.","required":true,"style":"simple","schema":{"pattern":"^organizations/[^/]+/environments/[^/]+$","type":"string"}}],"requestBody":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudApigeeV1Query"}}},"required":true},"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudApigeeV1AsyncQuery"}}}}},"deprecated":false,"security":[{"httpBearer":["https://www.googleapis.com/auth/cloud-platform"]}]},"parameters":[]},"/v1/{parent}/debugsessions":{"post":{"tags":["debugsessions"],"summary":"CreateV1DebugsessionsByParent","description":"Creates a debug session for a deployed API Proxy revision.","operationId":"CreateV1DebugsessionsByParent","parameters":[{"name":"callback","in":"query","description":"JSONP","style":"form","explode":true,"schema":{"type":"string"}},{"name":"key","in":"query","description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"alt","in":"query","description":"Data format for response. (Acceptable values are: \"json\", \"media\", \"proto\")","style":"form","explode":true,"schema":{"type":"string","default":"json"}},{"name":"uploadType","in":"query","description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"upload_protocol","in":"query","description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"Selector specifying which fields to include in a partial response.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"access_token","in":"query","description":"OAuth access token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"$.xgafv","in":"query","description":"V1 error format. (Acceptable values are: \"1\", \"2\")","style":"form","explode":true,"schema":{"type":"string","default":"1"}},{"name":"quotaUser","in":"query","description":"Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"prettyPrint","in":"query","description":"Returns response with indentations and line breaks.","style":"form","explode":true,"schema":{"type":"boolean","default":true}},{"name":"oauth_token","in":"query","description":"OAuth 2.0 token for the current user.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"parent","in":"path","description":"Required. The resource name of the API Proxy revision deployment for which to create the DebugSession. Must be of the form `organizations/{organization}/environments/{environment}/apis/{api}/revisions/{revision}`.","required":true,"style":"simple","schema":{"pattern":"^organizations/[^/]+/environments/[^/]+/apis/[^/]+/revisions/[^/]+$","type":"string"}},{"name":"timeout","in":"query","description":"Optional. The time in seconds after which this DebugSession should end. A timeout specified in DebugSession will overwrite this value.","style":"form","explode":true,"schema":{"type":"string"}}],"requestBody":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudApigeeV1DebugSession"}}},"required":true},"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudApigeeV1DebugSession"}}}}},"deprecated":false,"security":[{"httpBearer":["https://www.googleapis.com/auth/cloud-platform"]}]},"get":{"tags":["debugsessions"],"summary":"ListV1DebugsessionsByParent","description":"Lists debug sessions that are currently active in the given API Proxy revision.","operationId":"ListV1DebugsessionsByParent","parameters":[{"name":"callback","in":"query","description":"JSONP","style":"form","explode":true,"schema":{"type":"string"}},{"name":"key","in":"query","description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"alt","in":"query","description":"Data format for response. (Acceptable values are: \"json\", \"media\", \"proto\")","style":"form","explode":true,"schema":{"type":"string","default":"json"}},{"name":"uploadType","in":"query","description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"upload_protocol","in":"query","description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"Selector specifying which fields to include in a partial response.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"access_token","in":"query","description":"OAuth access token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"$.xgafv","in":"query","description":"V1 error format. (Acceptable values are: \"1\", \"2\")","style":"form","explode":true,"schema":{"type":"string","default":"1"}},{"name":"quotaUser","in":"query","description":"Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"prettyPrint","in":"query","description":"Returns response with indentations and line breaks.","style":"form","explode":true,"schema":{"type":"boolean","default":true}},{"name":"oauth_token","in":"query","description":"OAuth 2.0 token for the current user.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"pageSize","in":"query","description":"Maximum number of debug sessions to return. The page size defaults to 25.","style":"form","explode":true,"schema":{"type":"integer","contentEncoding":"int32"}},{"name":"parent","in":"path","description":"Required. The name of the API Proxy revision deployment for which to list debug sessions. Must be of the form: `organizations/{organization}/environments/{environment}/apis/{api}/revisions/{revision}`.","required":true,"style":"simple","schema":{"pattern":"^organizations/[^/]+/environments/[^/]+/apis/[^/]+/revisions/[^/]+$","type":"string"}},{"name":"pageToken","in":"query","description":"Page token, returned from a previous ListDebugSessions call, that you can use to retrieve the next page.","style":"form","explode":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudApigeeV1ListDebugSessionsResponse"}}}}},"deprecated":false,"security":[{"httpBearer":["https://www.googleapis.com/auth/cloud-platform"]}]},"parameters":[]},"/v1/{name}/data":{"delete":{"tags":["debugsessions"],"summary":"DeleteDataV1DataByName","description":"Deletes the data from a debug session. This does not cancel the debug session or prevent further data from being collected if the session is still active in runtime pods.","operationId":"DeleteDataV1DataByName","parameters":[{"name":"callback","in":"query","description":"JSONP","style":"form","explode":true,"schema":{"type":"string"}},{"name":"key","in":"query","description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"alt","in":"query","description":"Data format for response. (Acceptable values are: \"json\", \"media\", \"proto\")","style":"form","explode":true,"schema":{"type":"string","default":"json"}},{"name":"uploadType","in":"query","description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"upload_protocol","in":"query","description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"Selector specifying which fields to include in a partial response.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"access_token","in":"query","description":"OAuth access token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"$.xgafv","in":"query","description":"V1 error format. (Acceptable values are: \"1\", \"2\")","style":"form","explode":true,"schema":{"type":"string","default":"1"}},{"name":"quotaUser","in":"query","description":"Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"prettyPrint","in":"query","description":"Returns response with indentations and line breaks.","style":"form","explode":true,"schema":{"type":"boolean","default":true}},{"name":"oauth_token","in":"query","description":"OAuth 2.0 token for the current user.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"name","in":"path","description":"Required. The name of the debug session to delete. Must be of the form: `organizations/{organization}/environments/{environment}/apis/{api}/revisions/{revision}/debugsessions/{debugsession}`.","required":true,"style":"simple","schema":{"pattern":"^organizations/[^/]+/environments/[^/]+/apis/[^/]+/revisions/[^/]+/debugsessions/[^/]+$","type":"string"}}],"responses":{"200":{"description":"","headers":{},"content":{"text/plain":{"schema":{"type":"object","contentMediaType":"text/plain"}}}}},"deprecated":false,"security":[{"httpBearer":["https://www.googleapis.com/auth/cloud-platform"]}]},"parameters":[]},"/v1/{parent}/aliases":{"post":{"tags":["aliases"],"summary":"CreateV1AliasesByParent","description":"Creates an alias from a key/certificate pair. The structure of the request is controlled by the `format` query parameter: - `keycertfile` - Separate PEM-encoded key and certificate files are uploaded. Set `Content-Type: multipart/form-data` and include the `keyFile`, `certFile`, and `password` (if keys are encrypted) fields in the request body. If uploading to a truststore, omit `keyFile`. - `pkcs12` - A PKCS12 file is uploaded. Set `Content-Type: multipart/form-data`, provide the file in the `file` field, and include the `password` field if the file is encrypted in the request body. - `selfsignedcert` - A new private key and certificate are generated. Set `Content-Type: application/json` and include CertificateGenerationSpec in the request body.","operationId":"CreateV1AliasesByParent","parameters":[{"name":"callback","in":"query","description":"JSONP","style":"form","explode":true,"schema":{"type":"string"}},{"name":"key","in":"query","description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"alt","in":"query","description":"Data format for response. (Acceptable values are: \"json\", \"media\", \"proto\")","style":"form","explode":true,"schema":{"type":"string","default":"json"}},{"name":"uploadType","in":"query","description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"upload_protocol","in":"query","description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"Selector specifying which fields to include in a partial response.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"access_token","in":"query","description":"OAuth access token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"$.xgafv","in":"query","description":"V1 error format. (Acceptable values are: \"1\", \"2\")","style":"form","explode":true,"schema":{"type":"string","default":"1"}},{"name":"quotaUser","in":"query","description":"Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"prettyPrint","in":"query","description":"Returns response with indentations and line breaks.","style":"form","explode":true,"schema":{"type":"boolean","default":true}},{"name":"oauth_token","in":"query","description":"OAuth 2.0 token for the current user.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"parent","in":"path","description":"Required. Name of the keystore. Use the following format in your request: `organizations/{org}/environments/{env}/keystores/{keystore}`.","required":true,"style":"simple","schema":{"pattern":"^organizations/[^/]+/environments/[^/]+/keystores/[^/]+$","type":"string"}},{"name":"ignoreNewlineValidation","in":"query","description":"Flag that specifies whether to ignore newline validation. If set to `true`, no error is thrown when the file contains a certificate chain with no newline between each certificate. Defaults to `false`.","style":"form","explode":true,"schema":{"type":"boolean"}},{"name":"format","in":"query","description":"Required. Format of the data. Valid values include: `selfsignedcert`, `keycertfile`, or `pkcs12`","style":"form","explode":true,"schema":{"type":"string"}},{"name":"alias","in":"query","description":"Alias for the key/certificate pair. Values must match the regular expression `[\\w\\s-.]{1,255}`. This must be provided for all formats except `selfsignedcert`; self-signed certs may specify the alias in either this parameter or the JSON body.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"_password","in":"query","description":"DEPRECATED: For improved security, specify the password in the request body instead of using the query parameter. To specify the password in the request body, set `Content-type: multipart/form-data` part with name `password`. Password for the private key file, if required.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"ignoreExpiryValidation","in":"query","description":"Flag that specifies whether to ignore expiry validation. If set to `true`, no expiry validation will be performed.","style":"form","explode":true,"schema":{"type":"boolean"}}],"requestBody":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleApiHttpBody"}}},"required":true},"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudApigeeV1Alias"}}}}},"deprecated":false,"security":[{"httpBearer":["https://www.googleapis.com/auth/cloud-platform"]}]},"parameters":[]},"/v1/{name}/csr":{"get":{"tags":["aliases"],"summary":"CsrV1CsrByName","description":"Generates a PKCS #10 Certificate Signing Request for the private key in an alias.","operationId":"CsrV1CsrByName","parameters":[{"name":"callback","in":"query","description":"JSONP","style":"form","explode":true,"schema":{"type":"string"}},{"name":"key","in":"query","description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"alt","in":"query","description":"Data format for response. (Acceptable values are: \"json\", \"media\", \"proto\")","style":"form","explode":true,"schema":{"type":"string","default":"json"}},{"name":"uploadType","in":"query","description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"upload_protocol","in":"query","description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"Selector specifying which fields to include in a partial response.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"access_token","in":"query","description":"OAuth access token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"$.xgafv","in":"query","description":"V1 error format. (Acceptable values are: \"1\", \"2\")","style":"form","explode":true,"schema":{"type":"string","default":"1"}},{"name":"quotaUser","in":"query","description":"Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"prettyPrint","in":"query","description":"Returns response with indentations and line breaks.","style":"form","explode":true,"schema":{"type":"boolean","default":true}},{"name":"oauth_token","in":"query","description":"OAuth 2.0 token for the current user.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"name","in":"path","description":"Required. Name of the alias. Use the following format in your request: `organizations/{org}/environments/{env}/keystores/{keystore}/aliases/{alias}`.","required":true,"style":"simple","schema":{"pattern":"^organizations/[^/]+/environments/[^/]+/keystores/[^/]+/aliases/[^/]+$","type":"string"}}],"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleApiHttpBody"}}}}},"deprecated":false,"security":[{"httpBearer":["https://www.googleapis.com/auth/cloud-platform"]}]},"parameters":[]},"/v1/{name}/certificate":{"get":{"tags":["aliases"],"summary":"GetCertificateV1CertificateByName","description":"Gets the certificate from an alias in PEM-encoded form.","operationId":"GetCertificateV1CertificateByName","parameters":[{"name":"callback","in":"query","description":"JSONP","style":"form","explode":true,"schema":{"type":"string"}},{"name":"key","in":"query","description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"alt","in":"query","description":"Data format for response. (Acceptable values are: \"json\", \"media\", \"proto\")","style":"form","explode":true,"schema":{"type":"string","default":"json"}},{"name":"uploadType","in":"query","description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"upload_protocol","in":"query","description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"Selector specifying which fields to include in a partial response.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"access_token","in":"query","description":"OAuth access token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"$.xgafv","in":"query","description":"V1 error format. (Acceptable values are: \"1\", \"2\")","style":"form","explode":true,"schema":{"type":"string","default":"1"}},{"name":"quotaUser","in":"query","description":"Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"prettyPrint","in":"query","description":"Returns response with indentations and line breaks.","style":"form","explode":true,"schema":{"type":"boolean","default":true}},{"name":"oauth_token","in":"query","description":"OAuth 2.0 token for the current user.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"name","in":"path","description":"Required. Name of the alias. Use the following format in your request: `organizations/{org}/environments/{env}/keystores/{keystore}/aliases/{alias}`.","required":true,"style":"simple","schema":{"pattern":"^organizations/[^/]+/environments/[^/]+/keystores/[^/]+/aliases/[^/]+$","type":"string"}}],"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleApiHttpBody"}}}}},"deprecated":false,"security":[{"httpBearer":["https://www.googleapis.com/auth/cloud-platform"]}]},"parameters":[]},"/v1/{parent}/keystores":{"post":{"tags":["keystores"],"summary":"CreateV1KeystoresByParent","description":"Creates a keystore or truststore. - Keystore: Contains certificates and their associated keys. - Truststore: Contains trusted certificates used to validate a server's certificate. These certificates are typically self-signed certificates or certificates that are not signed by a trusted CA.","operationId":"CreateV1KeystoresByParent","parameters":[{"name":"callback","in":"query","description":"JSONP","style":"form","explode":true,"schema":{"type":"string"}},{"name":"key","in":"query","description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"alt","in":"query","description":"Data format for response. (Acceptable values are: \"json\", \"media\", \"proto\")","style":"form","explode":true,"schema":{"type":"string","default":"json"}},{"name":"uploadType","in":"query","description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"upload_protocol","in":"query","description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"Selector specifying which fields to include in a partial response.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"access_token","in":"query","description":"OAuth access token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"$.xgafv","in":"query","description":"V1 error format. (Acceptable values are: \"1\", \"2\")","style":"form","explode":true,"schema":{"type":"string","default":"1"}},{"name":"quotaUser","in":"query","description":"Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"prettyPrint","in":"query","description":"Returns response with indentations and line breaks.","style":"form","explode":true,"schema":{"type":"boolean","default":true}},{"name":"oauth_token","in":"query","description":"OAuth 2.0 token for the current user.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"name","in":"query","description":"Optional. Name of the keystore. Overrides the value in Keystore.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"parent","in":"path","description":"Required. Name of the environment in which to create the keystore. Use the following format in your request: `organizations/{org}/environments/{env}`","required":true,"style":"simple","schema":{"pattern":"^organizations/[^/]+/environments/[^/]+$","type":"string"}}],"requestBody":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudApigeeV1Keystore"}}},"required":true},"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudApigeeV1Keystore"}}}}},"deprecated":false,"security":[{"httpBearer":["https://www.googleapis.com/auth/cloud-platform"]}]},"parameters":[]},"/v1/{parent}/overrides":{"post":{"tags":["overrides"],"summary":"CreateV1OverridesByParent","description":"Creates a trace configuration override. The response contains a system-generated UUID, that can be used to view, update, or delete the configuration override. Use the List API to view the existing trace configuration overrides.","operationId":"CreateV1OverridesByParent","parameters":[{"name":"callback","in":"query","description":"JSONP","style":"form","explode":true,"schema":{"type":"string"}},{"name":"key","in":"query","description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"alt","in":"query","description":"Data format for response. (Acceptable values are: \"json\", \"media\", \"proto\")","style":"form","explode":true,"schema":{"type":"string","default":"json"}},{"name":"uploadType","in":"query","description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"upload_protocol","in":"query","description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"Selector specifying which fields to include in a partial response.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"access_token","in":"query","description":"OAuth access token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"$.xgafv","in":"query","description":"V1 error format. (Acceptable values are: \"1\", \"2\")","style":"form","explode":true,"schema":{"type":"string","default":"1"}},{"name":"quotaUser","in":"query","description":"Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"prettyPrint","in":"query","description":"Returns response with indentations and line breaks.","style":"form","explode":true,"schema":{"type":"boolean","default":true}},{"name":"oauth_token","in":"query","description":"OAuth 2.0 token for the current user.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"parent","in":"path","description":"Required. Parent resource of the trace configuration override. Use the following structure in your request. \"organizations/*/environments/*/traceConfig\".","required":true,"style":"simple","schema":{"pattern":"^organizations/[^/]+/environments/[^/]+/traceConfig$","type":"string"}}],"requestBody":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudApigeeV1TraceConfigOverride"}}},"required":true},"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudApigeeV1TraceConfigOverride"}}}}},"deprecated":false,"security":[{"httpBearer":["https://www.googleapis.com/auth/cloud-platform"]}]},"get":{"tags":["overrides"],"summary":"ListV1OverridesByParent","description":"Lists all of the distributed trace configuration overrides in an environment.","operationId":"ListV1OverridesByParent","parameters":[{"name":"callback","in":"query","description":"JSONP","style":"form","explode":true,"schema":{"type":"string"}},{"name":"key","in":"query","description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"alt","in":"query","description":"Data format for response. (Acceptable values are: \"json\", \"media\", \"proto\")","style":"form","explode":true,"schema":{"type":"string","default":"json"}},{"name":"uploadType","in":"query","description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"upload_protocol","in":"query","description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"Selector specifying which fields to include in a partial response.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"access_token","in":"query","description":"OAuth access token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"$.xgafv","in":"query","description":"V1 error format. (Acceptable values are: \"1\", \"2\")","style":"form","explode":true,"schema":{"type":"string","default":"1"}},{"name":"quotaUser","in":"query","description":"Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"prettyPrint","in":"query","description":"Returns response with indentations and line breaks.","style":"form","explode":true,"schema":{"type":"boolean","default":true}},{"name":"oauth_token","in":"query","description":"OAuth 2.0 token for the current user.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"parent","in":"path","description":"Required. Parent resource of the trace configuration override. Use the following structure in your request: \"organizations/*/environments/*/traceConfig\".","required":true,"style":"simple","schema":{"pattern":"^organizations/[^/]+/environments/[^/]+/traceConfig$","type":"string"}},{"name":"pageToken","in":"query","description":"A page token, returned from a previous `ListTraceConfigOverrides` call. Token value that can be used to retrieve the subsequent page. When paginating, all other parameters provided to `ListTraceConfigOverrides` must match those specified in the call to obtain the page token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"pageSize","in":"query","description":"Maximum number of trace configuration overrides to return. If not specified, the maximum number returned is 25. The maximum number cannot exceed 100.","style":"form","explode":true,"schema":{"type":"integer","contentEncoding":"int32"}}],"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudApigeeV1ListTraceConfigOverridesResponse"}}}}},"deprecated":false,"security":[{"httpBearer":["https://www.googleapis.com/auth/cloud-platform"]}]},"parameters":[]},"/v1/{parent}/targetservers":{"post":{"tags":["targetservers"],"summary":"CreateV1TargetserversByParent","description":"Creates a TargetServer in the specified environment.","operationId":"CreateV1TargetserversByParent","parameters":[{"name":"callback","in":"query","description":"JSONP","style":"form","explode":true,"schema":{"type":"string"}},{"name":"key","in":"query","description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"alt","in":"query","description":"Data format for response. (Acceptable values are: \"json\", \"media\", \"proto\")","style":"form","explode":true,"schema":{"type":"string","default":"json"}},{"name":"uploadType","in":"query","description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"upload_protocol","in":"query","description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"Selector specifying which fields to include in a partial response.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"access_token","in":"query","description":"OAuth access token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"$.xgafv","in":"query","description":"V1 error format. (Acceptable values are: \"1\", \"2\")","style":"form","explode":true,"schema":{"type":"string","default":"1"}},{"name":"quotaUser","in":"query","description":"Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"prettyPrint","in":"query","description":"Returns response with indentations and line breaks.","style":"form","explode":true,"schema":{"type":"boolean","default":true}},{"name":"oauth_token","in":"query","description":"OAuth 2.0 token for the current user.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"parent","in":"path","description":"Required. The parent environment name under which the TargetServer will be created. Must be of the form `organizations/{org}/environments/{env}`.","required":true,"style":"simple","schema":{"pattern":"^organizations/[^/]+/environments/[^/]+$","type":"string"}},{"name":"name","in":"query","description":"Optional. The ID to give the TargetServer. This will overwrite the value in TargetServer.","style":"form","explode":true,"schema":{"type":"string"}}],"requestBody":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudApigeeV1TargetServer"}}},"required":true},"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudApigeeV1TargetServer"}}}}},"deprecated":false,"security":[{"httpBearer":["https://www.googleapis.com/auth/cloud-platform"]}]},"parameters":[]},"/v1/{parent}/archiveDeployments":{"get":{"tags":["archiveDeployments"],"summary":"ListV1ArchiveDeploymentsByParent","description":"Lists the ArchiveDeployments in the specified Environment.","operationId":"ListV1ArchiveDeploymentsByParent","parameters":[{"name":"callback","in":"query","description":"JSONP","style":"form","explode":true,"schema":{"type":"string"}},{"name":"key","in":"query","description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"alt","in":"query","description":"Data format for response. (Acceptable values are: \"json\", \"media\", \"proto\")","style":"form","explode":true,"schema":{"type":"string","default":"json"}},{"name":"uploadType","in":"query","description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"upload_protocol","in":"query","description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"Selector specifying which fields to include in a partial response.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"access_token","in":"query","description":"OAuth access token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"$.xgafv","in":"query","description":"V1 error format. (Acceptable values are: \"1\", \"2\")","style":"form","explode":true,"schema":{"type":"string","default":"1"}},{"name":"quotaUser","in":"query","description":"Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"prettyPrint","in":"query","description":"Returns response with indentations and line breaks.","style":"form","explode":true,"schema":{"type":"boolean","default":true}},{"name":"oauth_token","in":"query","description":"OAuth 2.0 token for the current user.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"parent","in":"path","description":"Required. Name of the Environment for which to list Archive Deployments in the format: `organizations/{org}/environments/{env}`.","required":true,"style":"simple","schema":{"pattern":"^organizations/[^/]+/environments/[^/]+$","type":"string"}},{"name":"filter","in":"query","description":"Optional. An optional query used to return a subset of Archive Deployments using the semantics defined in https://google.aip.dev/160.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"pageSize","in":"query","description":"Optional. Maximum number of Archive Deployments to return. If unspecified, at most 25 deployments will be returned.","style":"form","explode":true,"schema":{"type":"integer","contentEncoding":"int32"}},{"name":"pageToken","in":"query","description":"Optional. Page token, returned from a previous ListArchiveDeployments call, that you can use to retrieve the next page.","style":"form","explode":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudApigeeV1ListArchiveDeploymentsResponse"}}}}},"deprecated":false,"security":[{"httpBearer":["https://www.googleapis.com/auth/cloud-platform"]}]},"post":{"tags":["archiveDeployments"],"summary":"CreateV1ArchiveDeploymentsByParent","description":"Creates a new ArchiveDeployment.","operationId":"CreateV1ArchiveDeploymentsByParent","parameters":[{"name":"callback","in":"query","description":"JSONP","style":"form","explode":true,"schema":{"type":"string"}},{"name":"key","in":"query","description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"alt","in":"query","description":"Data format for response. (Acceptable values are: \"json\", \"media\", \"proto\")","style":"form","explode":true,"schema":{"type":"string","default":"json"}},{"name":"uploadType","in":"query","description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"upload_protocol","in":"query","description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"Selector specifying which fields to include in a partial response.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"access_token","in":"query","description":"OAuth access token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"$.xgafv","in":"query","description":"V1 error format. (Acceptable values are: \"1\", \"2\")","style":"form","explode":true,"schema":{"type":"string","default":"1"}},{"name":"quotaUser","in":"query","description":"Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"prettyPrint","in":"query","description":"Returns response with indentations and line breaks.","style":"form","explode":true,"schema":{"type":"boolean","default":true}},{"name":"oauth_token","in":"query","description":"OAuth 2.0 token for the current user.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"parent","in":"path","description":"Required. The Environment this Archive Deployment will be created in.","required":true,"style":"simple","schema":{"pattern":"^organizations/[^/]+/environments/[^/]+$","type":"string"}}],"requestBody":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudApigeeV1ArchiveDeployment"}}},"required":true},"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleLongrunningOperation"}}}}},"deprecated":false,"security":[{"httpBearer":["https://www.googleapis.com/auth/cloud-platform"]}]},"parameters":[]},"/v1/{name}:generateDownloadUrl":{"post":{"tags":["archiveDeployments"],"summary":"GenerateDownloadUrlV1GenerateDownloadUrlByName","description":"Generates a signed URL for downloading the original zip file used to create an Archive Deployment. The URL is only valid for a limited period and should be used within minutes after generation. Each call returns a new upload URL.","operationId":"GenerateDownloadUrlV1GenerateDownloadUrlByName","parameters":[{"name":"callback","in":"query","description":"JSONP","style":"form","explode":true,"schema":{"type":"string"}},{"name":"key","in":"query","description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"alt","in":"query","description":"Data format for response. (Acceptable values are: \"json\", \"media\", \"proto\")","style":"form","explode":true,"schema":{"type":"string","default":"json"}},{"name":"uploadType","in":"query","description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"upload_protocol","in":"query","description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"Selector specifying which fields to include in a partial response.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"access_token","in":"query","description":"OAuth access token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"$.xgafv","in":"query","description":"V1 error format. (Acceptable values are: \"1\", \"2\")","style":"form","explode":true,"schema":{"type":"string","default":"1"}},{"name":"quotaUser","in":"query","description":"Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"prettyPrint","in":"query","description":"Returns response with indentations and line breaks.","style":"form","explode":true,"schema":{"type":"boolean","default":true}},{"name":"oauth_token","in":"query","description":"OAuth 2.0 token for the current user.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"name","in":"path","description":"Required. The name of the Archive Deployment you want to download.","required":true,"style":"simple","schema":{"pattern":"^organizations/[^/]+/environments/[^/]+/archiveDeployments/[^/]+$","type":"string"}}],"requestBody":{"description":"","content":{"text/plain":{"schema":{"type":"object","contentMediaType":"text/plain"}}},"required":true},"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudApigeeV1GenerateDownloadUrlResponse"}}}}},"deprecated":false,"security":[{"httpBearer":["https://www.googleapis.com/auth/cloud-platform"]}]},"parameters":[]},"/v1/{parent}/archiveDeployments:generateUploadUrl":{"post":{"tags":["archiveDeployments"],"summary":"GenerateUploadUrlV1ArchiveDeploymentsGenerateUploadUrl","description":"Generates a signed URL for uploading an Archive zip file to Google Cloud Storage. Once the upload is complete, the signed URL should be passed to CreateArchiveDeployment. When uploading to the generated signed URL, please follow these restrictions: * Source file type should be a zip file. * Source file size should not exceed 1GB limit. * No credentials should be attached - the signed URLs provide access to the target bucket using internal service identity; if credentials were attached, the identity from the credentials would be used, but that identity does not have permissions to upload files to the URL. When making a HTTP PUT request, these two headers need to be specified: * `content-type: application/zip` * `x-goog-content-length-range: 0,1073741824` And this header SHOULD NOT be specified: * `Authorization: Bearer YOUR_TOKEN`","operationId":"GenerateUploadUrlV1ArchiveDeploymentsGenerateUploadUrl","parameters":[{"name":"callback","in":"query","description":"JSONP","style":"form","explode":true,"schema":{"type":"string"}},{"name":"key","in":"query","description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"alt","in":"query","description":"Data format for response. (Acceptable values are: \"json\", \"media\", \"proto\")","style":"form","explode":true,"schema":{"type":"string","default":"json"}},{"name":"uploadType","in":"query","description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"upload_protocol","in":"query","description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"Selector specifying which fields to include in a partial response.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"access_token","in":"query","description":"OAuth access token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"$.xgafv","in":"query","description":"V1 error format. (Acceptable values are: \"1\", \"2\")","style":"form","explode":true,"schema":{"type":"string","default":"1"}},{"name":"quotaUser","in":"query","description":"Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"prettyPrint","in":"query","description":"Returns response with indentations and line breaks.","style":"form","explode":true,"schema":{"type":"boolean","default":true}},{"name":"oauth_token","in":"query","description":"OAuth 2.0 token for the current user.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"parent","in":"path","description":"Required. The organization and environment to upload to.","required":true,"style":"simple","schema":{"pattern":"^organizations/[^/]+/environments/[^/]+$","type":"string"}}],"requestBody":{"description":"","content":{"text/plain":{"schema":{"type":"object","contentMediaType":"text/plain"}}},"required":true},"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudApigeeV1GenerateUploadUrlResponse"}}}}},"deprecated":false,"security":[{"httpBearer":["https://www.googleapis.com/auth/cloud-platform"]}]},"parameters":[]},"/v1/{parent}/resourcefiles/{type}/{name}":{"put":{"tags":["resourcefiles"],"summary":"UpdateV1ResourcefilesNameByParentAndType","description":"Updates a resource file. Specify the `Content-Type` as `application/octet-stream` or `multipart/form-data`. For more information about resource files, see [Resource files](https://cloud.google.com/apigee/docs/api-platform/develop/resource-files).","operationId":"UpdateV1ResourcefilesNameByParentAndType","parameters":[{"name":"callback","in":"query","description":"JSONP","style":"form","explode":true,"schema":{"type":"string"}},{"name":"key","in":"query","description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"alt","in":"query","description":"Data format for response. (Acceptable values are: \"json\", \"media\", \"proto\")","style":"form","explode":true,"schema":{"type":"string","default":"json"}},{"name":"uploadType","in":"query","description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"upload_protocol","in":"query","description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"Selector specifying which fields to include in a partial response.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"access_token","in":"query","description":"OAuth access token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"$.xgafv","in":"query","description":"V1 error format. (Acceptable values are: \"1\", \"2\")","style":"form","explode":true,"schema":{"type":"string","default":"1"}},{"name":"quotaUser","in":"query","description":"Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"prettyPrint","in":"query","description":"Returns response with indentations and line breaks.","style":"form","explode":true,"schema":{"type":"boolean","default":true}},{"name":"oauth_token","in":"query","description":"OAuth 2.0 token for the current user.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"name","in":"path","description":"Required. ID of the resource file to update. Must match the regular expression: [a-zA-Z0-9:/\\\\!@#$%^&{}\\[\\]()+\\-=,.~'` ]{1,255}","required":true,"style":"simple","schema":{"type":"string"}},{"name":"parent","in":"path","description":"Required. Name of the environment in the following format: `organizations/{org}/environments/{env}`.","required":true,"style":"simple","schema":{"pattern":"^organizations/[^/]+/environments/[^/]+$","type":"string"}},{"name":"type","in":"path","description":"Required. Resource file type. {{ resource_file_type }}","required":true,"style":"simple","schema":{"type":"string"}}],"requestBody":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleApiHttpBody"}}},"required":true},"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudApigeeV1ResourceFile"}}}}},"deprecated":false,"security":[{"httpBearer":["https://www.googleapis.com/auth/cloud-platform"]}]},"get":{"tags":["resourcefiles"],"summary":"GetV1ResourcefilesNameByParentAndType","description":"Gets the contents of a resource file. For more information about resource files, see [Resource files](https://cloud.google.com/apigee/docs/api-platform/develop/resource-files).","operationId":"GetV1ResourcefilesNameByParentAndType","parameters":[{"name":"callback","in":"query","description":"JSONP","style":"form","explode":true,"schema":{"type":"string"}},{"name":"key","in":"query","description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"alt","in":"query","description":"Data format for response. (Acceptable values are: \"json\", \"media\", \"proto\")","style":"form","explode":true,"schema":{"type":"string","default":"json"}},{"name":"uploadType","in":"query","description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"upload_protocol","in":"query","description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"Selector specifying which fields to include in a partial response.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"access_token","in":"query","description":"OAuth access token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"$.xgafv","in":"query","description":"V1 error format. (Acceptable values are: \"1\", \"2\")","style":"form","explode":true,"schema":{"type":"string","default":"1"}},{"name":"quotaUser","in":"query","description":"Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"prettyPrint","in":"query","description":"Returns response with indentations and line breaks.","style":"form","explode":true,"schema":{"type":"boolean","default":true}},{"name":"oauth_token","in":"query","description":"OAuth 2.0 token for the current user.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"type","in":"path","description":"Required. Resource file type. {{ resource_file_type }}","required":true,"style":"simple","schema":{"type":"string"}},{"name":"parent","in":"path","description":"Required. Name of the environment in the following format: `organizations/{org}/environments/{env}`.","required":true,"style":"simple","schema":{"pattern":"^organizations/[^/]+/environments/[^/]+$","type":"string"}},{"name":"name","in":"path","description":"Required. ID of the resource file. Must match the regular expression: [a-zA-Z0-9:/\\\\!@#$%^&{}\\[\\]()+\\-=,.~'` ]{1,255}","required":true,"style":"simple","schema":{"type":"string"}}],"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleApiHttpBody"}}}}},"deprecated":false,"security":[{"httpBearer":["https://www.googleapis.com/auth/cloud-platform"]}]},"delete":{"tags":["resourcefiles"],"summary":"DeleteV1ResourcefilesNameByParentAndType","description":"Deletes a resource file. For more information about resource files, see [Resource files](https://cloud.google.com/apigee/docs/api-platform/develop/resource-files).","operationId":"DeleteV1ResourcefilesNameByParentAndType","parameters":[{"name":"callback","in":"query","description":"JSONP","style":"form","explode":true,"schema":{"type":"string"}},{"name":"key","in":"query","description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"alt","in":"query","description":"Data format for response. (Acceptable values are: \"json\", \"media\", \"proto\")","style":"form","explode":true,"schema":{"type":"string","default":"json"}},{"name":"uploadType","in":"query","description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"upload_protocol","in":"query","description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"Selector specifying which fields to include in a partial response.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"access_token","in":"query","description":"OAuth access token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"$.xgafv","in":"query","description":"V1 error format. (Acceptable values are: \"1\", \"2\")","style":"form","explode":true,"schema":{"type":"string","default":"1"}},{"name":"quotaUser","in":"query","description":"Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"prettyPrint","in":"query","description":"Returns response with indentations and line breaks.","style":"form","explode":true,"schema":{"type":"boolean","default":true}},{"name":"oauth_token","in":"query","description":"OAuth 2.0 token for the current user.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"type","in":"path","description":"Required. Resource file type. {{ resource_file_type }}","required":true,"style":"simple","schema":{"type":"string"}},{"name":"name","in":"path","description":"Required. ID of the resource file to delete. Must match the regular expression: [a-zA-Z0-9:/\\\\!@#$%^&{}\\[\\]()+\\-=,.~'` ]{1,255}","required":true,"style":"simple","schema":{"type":"string"}},{"name":"parent","in":"path","description":"Required. Name of the environment in the following format: `organizations/{org}/environments/{env}`.","required":true,"style":"simple","schema":{"pattern":"^organizations/[^/]+/environments/[^/]+$","type":"string"}}],"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudApigeeV1ResourceFile"}}}}},"deprecated":false,"security":[{"httpBearer":["https://www.googleapis.com/auth/cloud-platform"]}]},"parameters":[]},"/v1/{parent}/resourcefiles/{type}":{"get":{"tags":["resourcefiles"],"summary":"ListEnvironmentResourcesV1ResourcefilesByParentAndType","description":"Lists all resource files, optionally filtering by type. For more information about resource files, see [Resource files](https://cloud.google.com/apigee/docs/api-platform/develop/resource-files).","operationId":"ListEnvironmentResourcesV1ResourcefilesByParentAndType","parameters":[{"name":"callback","in":"query","description":"JSONP","style":"form","explode":true,"schema":{"type":"string"}},{"name":"key","in":"query","description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"alt","in":"query","description":"Data format for response. (Acceptable values are: \"json\", \"media\", \"proto\")","style":"form","explode":true,"schema":{"type":"string","default":"json"}},{"name":"uploadType","in":"query","description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"upload_protocol","in":"query","description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"Selector specifying which fields to include in a partial response.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"access_token","in":"query","description":"OAuth access token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"$.xgafv","in":"query","description":"V1 error format. (Acceptable values are: \"1\", \"2\")","style":"form","explode":true,"schema":{"type":"string","default":"1"}},{"name":"quotaUser","in":"query","description":"Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"prettyPrint","in":"query","description":"Returns response with indentations and line breaks.","style":"form","explode":true,"schema":{"type":"boolean","default":true}},{"name":"oauth_token","in":"query","description":"OAuth 2.0 token for the current user.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"parent","in":"path","description":"Required. Name of the environment in which to list resource files in the following format: `organizations/{org}/environments/{env}`.","required":true,"style":"simple","schema":{"pattern":"^organizations/[^/]+/environments/[^/]+$","type":"string"}},{"name":"type","in":"path","description":"Optional. Type of resource files to list. {{ resource_file_type }}","required":true,"style":"simple","schema":{"type":"string"}}],"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudApigeeV1ListEnvironmentResourcesResponse"}}}}},"deprecated":false,"security":[{"httpBearer":["https://www.googleapis.com/auth/cloud-platform"]}]},"parameters":[]},"/v1/{parent}/resourcefiles":{"get":{"tags":["resourcefiles"],"summary":"ListV1ResourcefilesByParent","description":"Lists all resource files, optionally filtering by type. For more information about resource files, see [Resource files](https://cloud.google.com/apigee/docs/api-platform/develop/resource-files).","operationId":"ListV1ResourcefilesByParent","parameters":[{"name":"callback","in":"query","description":"JSONP","style":"form","explode":true,"schema":{"type":"string"}},{"name":"key","in":"query","description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"alt","in":"query","description":"Data format for response. (Acceptable values are: \"json\", \"media\", \"proto\")","style":"form","explode":true,"schema":{"type":"string","default":"json"}},{"name":"uploadType","in":"query","description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"upload_protocol","in":"query","description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"Selector specifying which fields to include in a partial response.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"access_token","in":"query","description":"OAuth access token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"$.xgafv","in":"query","description":"V1 error format. (Acceptable values are: \"1\", \"2\")","style":"form","explode":true,"schema":{"type":"string","default":"1"}},{"name":"quotaUser","in":"query","description":"Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"prettyPrint","in":"query","description":"Returns response with indentations and line breaks.","style":"form","explode":true,"schema":{"type":"boolean","default":true}},{"name":"oauth_token","in":"query","description":"OAuth 2.0 token for the current user.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"parent","in":"path","description":"Required. Name of the environment in which to list resource files in the following format: `organizations/{org}/environments/{env}`.","required":true,"style":"simple","schema":{"pattern":"^organizations/[^/]+/environments/[^/]+$","type":"string"}},{"name":"type","in":"query","description":"Optional. Type of resource files to list. {{ resource_file_type }}","style":"form","explode":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudApigeeV1ListEnvironmentResourcesResponse"}}}}},"deprecated":false,"security":[{"httpBearer":["https://www.googleapis.com/auth/cloud-platform"]}]},"post":{"tags":["resourcefiles"],"summary":"CreateV1ResourcefilesByParent","description":"Creates a resource file. Specify the `Content-Type` as `application/octet-stream` or `multipart/form-data`. For more information about resource files, see [Resource files](https://cloud.google.com/apigee/docs/api-platform/develop/resource-files).","operationId":"CreateV1ResourcefilesByParent","parameters":[{"name":"callback","in":"query","description":"JSONP","style":"form","explode":true,"schema":{"type":"string"}},{"name":"key","in":"query","description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"alt","in":"query","description":"Data format for response. (Acceptable values are: \"json\", \"media\", \"proto\")","style":"form","explode":true,"schema":{"type":"string","default":"json"}},{"name":"uploadType","in":"query","description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"upload_protocol","in":"query","description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"Selector specifying which fields to include in a partial response.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"access_token","in":"query","description":"OAuth access token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"$.xgafv","in":"query","description":"V1 error format. (Acceptable values are: \"1\", \"2\")","style":"form","explode":true,"schema":{"type":"string","default":"1"}},{"name":"quotaUser","in":"query","description":"Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"prettyPrint","in":"query","description":"Returns response with indentations and line breaks.","style":"form","explode":true,"schema":{"type":"boolean","default":true}},{"name":"oauth_token","in":"query","description":"OAuth 2.0 token for the current user.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"parent","in":"path","description":"Required. Name of the environment in which to create the resource file in the following format: `organizations/{org}/environments/{env}`.","required":true,"style":"simple","schema":{"pattern":"^organizations/[^/]+/environments/[^/]+$","type":"string"}},{"name":"type","in":"query","description":"Required. Resource file type. {{ resource_file_type }}","style":"form","explode":true,"schema":{"type":"string"}},{"name":"name","in":"query","description":"Required. Name of the resource file. Must match the regular expression: [a-zA-Z0-9:/\\\\!@#$%^&{}\\[\\]()+\\-=,.~'` ]{1,255}","style":"form","explode":true,"schema":{"type":"string"}}],"requestBody":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleApiHttpBody"}}},"required":true},"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudApigeeV1ResourceFile"}}}}},"deprecated":false,"security":[{"httpBearer":["https://www.googleapis.com/auth/cloud-platform"]}]},"parameters":[]},"/v1/{parent}/analytics/exports":{"get":{"tags":["exports"],"summary":"ListV1AnalyticsExportsByParent","description":"Lists the details and status of all analytics export jobs belonging to the parent organization and environment.","operationId":"ListV1AnalyticsExportsByParent","parameters":[{"name":"callback","in":"query","description":"JSONP","style":"form","explode":true,"schema":{"type":"string"}},{"name":"key","in":"query","description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"alt","in":"query","description":"Data format for response. (Acceptable values are: \"json\", \"media\", \"proto\")","style":"form","explode":true,"schema":{"type":"string","default":"json"}},{"name":"uploadType","in":"query","description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"upload_protocol","in":"query","description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"Selector specifying which fields to include in a partial response.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"access_token","in":"query","description":"OAuth access token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"$.xgafv","in":"query","description":"V1 error format. (Acceptable values are: \"1\", \"2\")","style":"form","explode":true,"schema":{"type":"string","default":"1"}},{"name":"quotaUser","in":"query","description":"Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"prettyPrint","in":"query","description":"Returns response with indentations and line breaks.","style":"form","explode":true,"schema":{"type":"boolean","default":true}},{"name":"oauth_token","in":"query","description":"OAuth 2.0 token for the current user.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"parent","in":"path","description":"Required. Names of the parent organization and environment. Must be of the form `organizations/{org}/environments/{env}`.","required":true,"style":"simple","schema":{"pattern":"^organizations/[^/]+/environments/[^/]+$","type":"string"}}],"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudApigeeV1ListExportsResponse"}}}}},"deprecated":false,"security":[{"httpBearer":["https://www.googleapis.com/auth/cloud-platform"]}]},"post":{"tags":["exports"],"summary":"CreateV1AnalyticsExportsByParent","description":"Submit a data export job to be processed in the background. If the request is successful, the API returns a 201 status, a URI that can be used to retrieve the status of the export job, and the `state` value of \"enqueued\".","operationId":"CreateV1AnalyticsExportsByParent","parameters":[{"name":"callback","in":"query","description":"JSONP","style":"form","explode":true,"schema":{"type":"string"}},{"name":"key","in":"query","description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"alt","in":"query","description":"Data format for response. (Acceptable values are: \"json\", \"media\", \"proto\")","style":"form","explode":true,"schema":{"type":"string","default":"json"}},{"name":"uploadType","in":"query","description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"upload_protocol","in":"query","description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"Selector specifying which fields to include in a partial response.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"access_token","in":"query","description":"OAuth access token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"$.xgafv","in":"query","description":"V1 error format. (Acceptable values are: \"1\", \"2\")","style":"form","explode":true,"schema":{"type":"string","default":"1"}},{"name":"quotaUser","in":"query","description":"Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"prettyPrint","in":"query","description":"Returns response with indentations and line breaks.","style":"form","explode":true,"schema":{"type":"boolean","default":true}},{"name":"oauth_token","in":"query","description":"OAuth 2.0 token for the current user.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"parent","in":"path","description":"Required. Names of the parent organization and environment. Must be of the form `organizations/{org}/environments/{env}`.","required":true,"style":"simple","schema":{"pattern":"^organizations/[^/]+/environments/[^/]+$","type":"string"}}],"requestBody":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudApigeeV1ExportRequest"}}},"required":true},"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudApigeeV1Export"}}}}},"deprecated":false,"security":[{"httpBearer":["https://www.googleapis.com/auth/cloud-platform"]}]},"parameters":[]},"/v1/{parent}/securityReports":{"post":{"tags":["securityReports"],"summary":"CreateV1SecurityReportsByParent","description":"Submit a report request to be processed in the background. If the submission succeeds, the API returns a 200 status and an ID that refer to the report request. In addition to the HTTP status 200, the `state` of \"enqueued\" means that the request succeeded.","operationId":"CreateV1SecurityReportsByParent","parameters":[{"name":"callback","in":"query","description":"JSONP","style":"form","explode":true,"schema":{"type":"string"}},{"name":"key","in":"query","description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"alt","in":"query","description":"Data format for response. (Acceptable values are: \"json\", \"media\", \"proto\")","style":"form","explode":true,"schema":{"type":"string","default":"json"}},{"name":"uploadType","in":"query","description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"upload_protocol","in":"query","description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"Selector specifying which fields to include in a partial response.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"access_token","in":"query","description":"OAuth access token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"$.xgafv","in":"query","description":"V1 error format. (Acceptable values are: \"1\", \"2\")","style":"form","explode":true,"schema":{"type":"string","default":"1"}},{"name":"quotaUser","in":"query","description":"Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"prettyPrint","in":"query","description":"Returns response with indentations and line breaks.","style":"form","explode":true,"schema":{"type":"boolean","default":true}},{"name":"oauth_token","in":"query","description":"OAuth 2.0 token for the current user.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"parent","in":"path","description":"Required. The parent resource name. Must be of the form `organizations/{org}/environments/{env}`.","required":true,"style":"simple","schema":{"pattern":"^organizations/[^/]+/environments/[^/]+$","type":"string"}}],"requestBody":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudApigeeV1SecurityReportQuery"}}},"required":true},"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudApigeeV1SecurityReport"}}}}},"deprecated":false,"security":[{"httpBearer":["https://www.googleapis.com/auth/cloud-platform"]}]},"get":{"tags":["securityReports"],"summary":"ListV1SecurityReportsByParent","description":"Return a list of Security Reports","operationId":"ListV1SecurityReportsByParent","parameters":[{"name":"callback","in":"query","description":"JSONP","style":"form","explode":true,"schema":{"type":"string"}},{"name":"key","in":"query","description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"alt","in":"query","description":"Data format for response. (Acceptable values are: \"json\", \"media\", \"proto\")","style":"form","explode":true,"schema":{"type":"string","default":"json"}},{"name":"uploadType","in":"query","description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"upload_protocol","in":"query","description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"Selector specifying which fields to include in a partial response.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"access_token","in":"query","description":"OAuth access token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"$.xgafv","in":"query","description":"V1 error format. (Acceptable values are: \"1\", \"2\")","style":"form","explode":true,"schema":{"type":"string","default":"1"}},{"name":"quotaUser","in":"query","description":"Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"prettyPrint","in":"query","description":"Returns response with indentations and line breaks.","style":"form","explode":true,"schema":{"type":"boolean","default":true}},{"name":"oauth_token","in":"query","description":"OAuth 2.0 token for the current user.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"parent","in":"path","description":"Required. The parent resource name. Must be of the form `organizations/{org}/environments/{env}`.","required":true,"style":"simple","schema":{"pattern":"^organizations/[^/]+/environments/[^/]+$","type":"string"}},{"name":"pageSize","in":"query","description":"The maximum number of security report to return in the list response.","style":"form","explode":true,"schema":{"type":"integer","contentEncoding":"int32"}},{"name":"submittedBy","in":"query","description":"Filter response list by user who submitted queries.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"from","in":"query","description":"Filter response list by returning security reports that created after this date time. Time must be in ISO date-time format like '2011-12-03T10:15:30Z'.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"dataset","in":"query","description":"Filter response list by dataset. Example: `api`, `mint`","style":"form","explode":true,"schema":{"type":"string"}},{"name":"to","in":"query","description":"Filter response list by returning security reports that created before this date time. Time must be in ISO date-time format like '2011-12-03T10:16:30Z'.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"status","in":"query","description":"Filter response list by security reports status.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"pageToken","in":"query","description":"Token returned from the previous list response to fetch the next page.","style":"form","explode":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudApigeeV1ListSecurityReportsResponse"}}}}},"deprecated":false,"security":[{"httpBearer":["https://www.googleapis.com/auth/cloud-platform"]}]},"parameters":[]},"/v1/{parent}/endpointAttachments":{"post":{"tags":["endpointAttachments"],"summary":"CreateV1EndpointAttachmentsByParent","description":"Creates an endpoint attachment. **Note:** Not supported for Apigee hybrid.","operationId":"CreateV1EndpointAttachmentsByParent","parameters":[{"name":"callback","in":"query","description":"JSONP","style":"form","explode":true,"schema":{"type":"string"}},{"name":"key","in":"query","description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"alt","in":"query","description":"Data format for response. (Acceptable values are: \"json\", \"media\", \"proto\")","style":"form","explode":true,"schema":{"type":"string","default":"json"}},{"name":"uploadType","in":"query","description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"upload_protocol","in":"query","description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"Selector specifying which fields to include in a partial response.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"access_token","in":"query","description":"OAuth access token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"$.xgafv","in":"query","description":"V1 error format. (Acceptable values are: \"1\", \"2\")","style":"form","explode":true,"schema":{"type":"string","default":"1"}},{"name":"quotaUser","in":"query","description":"Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"prettyPrint","in":"query","description":"Returns response with indentations and line breaks.","style":"form","explode":true,"schema":{"type":"boolean","default":true}},{"name":"oauth_token","in":"query","description":"OAuth 2.0 token for the current user.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"endpointAttachmentId","in":"query","description":"ID to use for the endpoint attachment. ID must start with a lowercase letter followed by up to 31 lowercase letters, numbers, or hyphens, and cannot end with a hyphen. The minimum length is 2.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"parent","in":"path","description":"Required. Organization the endpoint attachment will be created in.","required":true,"style":"simple","schema":{"pattern":"^organizations/[^/]+$","type":"string"}}],"requestBody":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudApigeeV1EndpointAttachment"}}},"required":true},"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleLongrunningOperation"}}}}},"deprecated":false,"security":[{"httpBearer":["https://www.googleapis.com/auth/cloud-platform"]}]},"get":{"tags":["endpointAttachments"],"summary":"ListV1EndpointAttachmentsByParent","description":"Lists the endpoint attachments in an organization.","operationId":"ListV1EndpointAttachmentsByParent","parameters":[{"name":"callback","in":"query","description":"JSONP","style":"form","explode":true,"schema":{"type":"string"}},{"name":"key","in":"query","description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"alt","in":"query","description":"Data format for response. (Acceptable values are: \"json\", \"media\", \"proto\")","style":"form","explode":true,"schema":{"type":"string","default":"json"}},{"name":"uploadType","in":"query","description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"upload_protocol","in":"query","description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"Selector specifying which fields to include in a partial response.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"access_token","in":"query","description":"OAuth access token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"$.xgafv","in":"query","description":"V1 error format. (Acceptable values are: \"1\", \"2\")","style":"form","explode":true,"schema":{"type":"string","default":"1"}},{"name":"quotaUser","in":"query","description":"Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"prettyPrint","in":"query","description":"Returns response with indentations and line breaks.","style":"form","explode":true,"schema":{"type":"boolean","default":true}},{"name":"oauth_token","in":"query","description":"OAuth 2.0 token for the current user.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"pageToken","in":"query","description":"Optional. Page token, returned from a previous `ListEndpointAttachments` call, that you can use to retrieve the next page.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"pageSize","in":"query","description":"Optional. Maximum number of endpoint attachments to return. If unspecified, at most 25 attachments will be returned.","style":"form","explode":true,"schema":{"type":"integer","contentEncoding":"int32"}},{"name":"parent","in":"path","description":"Required. Name of the organization for which to list endpoint attachments. Use the following structure in your request: `organizations/{org}`","required":true,"style":"simple","schema":{"pattern":"^organizations/[^/]+$","type":"string"}}],"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudApigeeV1ListEndpointAttachmentsResponse"}}}}},"deprecated":false,"security":[{"httpBearer":["https://www.googleapis.com/auth/cloud-platform"]}]},"parameters":[]},"/v1/{name}:setSyncAuthorization":{"post":{"tags":["organizations"],"summary":"SetSyncAuthorizationV1SetSyncAuthorizationByName","description":"Sets the permissions required to allow the Synchronizer to download environment data from the control plane. You must call this API to enable proper functioning of hybrid. Pass the ETag when calling `setSyncAuthorization` to ensure that you are updating the correct version. To get an ETag, call [getSyncAuthorization](getSyncAuthorization). If you don't pass the ETag in the call to `setSyncAuthorization`, then the existing authorization is overwritten indiscriminately. For more information, see [Configure the Synchronizer](https://cloud.google.com/apigee/docs/hybrid/latest/synchronizer-access). **Note**: Available to Apigee hybrid only.","operationId":"SetSyncAuthorizationV1SetSyncAuthorizationByName","parameters":[{"name":"callback","in":"query","description":"JSONP","style":"form","explode":true,"schema":{"type":"string"}},{"name":"key","in":"query","description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"alt","in":"query","description":"Data format for response. (Acceptable values are: \"json\", \"media\", \"proto\")","style":"form","explode":true,"schema":{"type":"string","default":"json"}},{"name":"uploadType","in":"query","description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"upload_protocol","in":"query","description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"Selector specifying which fields to include in a partial response.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"access_token","in":"query","description":"OAuth access token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"$.xgafv","in":"query","description":"V1 error format. (Acceptable values are: \"1\", \"2\")","style":"form","explode":true,"schema":{"type":"string","default":"1"}},{"name":"quotaUser","in":"query","description":"Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"prettyPrint","in":"query","description":"Returns response with indentations and line breaks.","style":"form","explode":true,"schema":{"type":"boolean","default":true}},{"name":"oauth_token","in":"query","description":"OAuth 2.0 token for the current user.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"name","in":"path","description":"Required. Name of the Apigee organization. Use the following structure in your request: `organizations/{org}`","required":true,"style":"simple","schema":{"pattern":"^organizations/[^/]+$","type":"string"}}],"requestBody":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudApigeeV1SyncAuthorization"}}},"required":true},"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudApigeeV1SyncAuthorization"}}}}},"deprecated":false,"security":[{"httpBearer":["https://www.googleapis.com/auth/cloud-platform"]}]},"parameters":[]},"/v1/{name}:getProjectMapping":{"get":{"tags":["organizations"],"summary":"GetProjectMappingV1GetProjectMappingByName","description":"Gets the project ID and region for an Apigee organization.","operationId":"GetProjectMappingV1GetProjectMappingByName","parameters":[{"name":"callback","in":"query","description":"JSONP","style":"form","explode":true,"schema":{"type":"string"}},{"name":"key","in":"query","description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"alt","in":"query","description":"Data format for response. (Acceptable values are: \"json\", \"media\", \"proto\")","style":"form","explode":true,"schema":{"type":"string","default":"json"}},{"name":"uploadType","in":"query","description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"upload_protocol","in":"query","description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"Selector specifying which fields to include in a partial response.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"access_token","in":"query","description":"OAuth access token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"$.xgafv","in":"query","description":"V1 error format. (Acceptable values are: \"1\", \"2\")","style":"form","explode":true,"schema":{"type":"string","default":"1"}},{"name":"quotaUser","in":"query","description":"Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"prettyPrint","in":"query","description":"Returns response with indentations and line breaks.","style":"form","explode":true,"schema":{"type":"boolean","default":true}},{"name":"oauth_token","in":"query","description":"OAuth 2.0 token for the current user.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"name","in":"path","description":"Required. Apigee organization name in the following format: `organizations/{org}`","required":true,"style":"simple","schema":{"pattern":"^organizations/[^/]+$","type":"string"}}],"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudApigeeV1OrganizationProjectMapping"}}}}},"deprecated":false,"security":[{"httpBearer":["https://www.googleapis.com/auth/cloud-platform"]}]},"parameters":[]},"/v1/{parent}":{"get":{"tags":["organizations"],"summary":"ListV1ByParent","description":"Lists the Apigee organizations and associated GCP projects that you have permission to access. See [Understanding organizations](https://cloud.google.com/apigee/docs/api-platform/fundamentals/organization-structure).","operationId":"ListV1ByParent","parameters":[{"name":"callback","in":"query","description":"JSONP","style":"form","explode":true,"schema":{"type":"string"}},{"name":"key","in":"query","description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"alt","in":"query","description":"Data format for response. (Acceptable values are: \"json\", \"media\", \"proto\")","style":"form","explode":true,"schema":{"type":"string","default":"json"}},{"name":"uploadType","in":"query","description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"upload_protocol","in":"query","description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"Selector specifying which fields to include in a partial response.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"access_token","in":"query","description":"OAuth access token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"$.xgafv","in":"query","description":"V1 error format. (Acceptable values are: \"1\", \"2\")","style":"form","explode":true,"schema":{"type":"string","default":"1"}},{"name":"quotaUser","in":"query","description":"Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"prettyPrint","in":"query","description":"Returns response with indentations and line breaks.","style":"form","explode":true,"schema":{"type":"boolean","default":true}},{"name":"oauth_token","in":"query","description":"OAuth 2.0 token for the current user.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"parent","in":"path","description":"Required. Use the following structure in your request: `organizations`","required":true,"style":"simple","schema":{"pattern":"^organizations$","type":"string"}}],"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudApigeeV1ListOrganizationsResponse"}}}}},"deprecated":false,"security":[{"httpBearer":["https://www.googleapis.com/auth/cloud-platform"]}]},"parameters":[]},"/v1/{name}:getSyncAuthorization":{"post":{"tags":["organizations"],"summary":"GetSyncAuthorizationV1GetSyncAuthorizationByName","description":"Lists the service accounts with the permissions required to allow the Synchronizer to download environment data from the control plane. An ETag is returned in the response to `getSyncAuthorization`. Pass that ETag when calling [setSyncAuthorization](setSyncAuthorization) to ensure that you are updating the correct version. If you don't pass the ETag in the call to `setSyncAuthorization`, then the existing authorization is overwritten indiscriminately. For more information, see [Configure the Synchronizer](https://cloud.google.com/apigee/docs/hybrid/latest/synchronizer-access). **Note**: Available to Apigee hybrid only.","operationId":"GetSyncAuthorizationV1GetSyncAuthorizationByName","parameters":[{"name":"callback","in":"query","description":"JSONP","style":"form","explode":true,"schema":{"type":"string"}},{"name":"key","in":"query","description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"alt","in":"query","description":"Data format for response. (Acceptable values are: \"json\", \"media\", \"proto\")","style":"form","explode":true,"schema":{"type":"string","default":"json"}},{"name":"uploadType","in":"query","description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"upload_protocol","in":"query","description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"Selector specifying which fields to include in a partial response.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"access_token","in":"query","description":"OAuth access token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"$.xgafv","in":"query","description":"V1 error format. (Acceptable values are: \"1\", \"2\")","style":"form","explode":true,"schema":{"type":"string","default":"1"}},{"name":"quotaUser","in":"query","description":"Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"prettyPrint","in":"query","description":"Returns response with indentations and line breaks.","style":"form","explode":true,"schema":{"type":"boolean","default":true}},{"name":"oauth_token","in":"query","description":"OAuth 2.0 token for the current user.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"name","in":"path","description":"Required. Name of the Apigee organization. Use the following structure in your request: `organizations/{org}`","required":true,"style":"simple","schema":{"pattern":"^organizations/[^/]+$","type":"string"}}],"requestBody":{"description":"","content":{"text/plain":{"schema":{"type":"object","contentMediaType":"text/plain"}}},"required":true},"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudApigeeV1SyncAuthorization"}}}}},"deprecated":false,"security":[{"httpBearer":["https://www.googleapis.com/auth/cloud-platform"]}]},"parameters":[]},"/v1/organizations":{"post":{"tags":["organizations"],"summary":"CreateV1Organizations","description":"Creates an Apigee organization. See [Create an Apigee organization](https://cloud.google.com/apigee/docs/api-platform/get-started/create-org).","operationId":"CreateV1Organizations","parameters":[{"name":"callback","in":"query","description":"JSONP","style":"form","explode":true,"schema":{"type":"string"}},{"name":"key","in":"query","description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"alt","in":"query","description":"Data format for response. (Acceptable values are: \"json\", \"media\", \"proto\")","style":"form","explode":true,"schema":{"type":"string","default":"json"}},{"name":"uploadType","in":"query","description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"upload_protocol","in":"query","description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"Selector specifying which fields to include in a partial response.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"access_token","in":"query","description":"OAuth access token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"$.xgafv","in":"query","description":"V1 error format. (Acceptable values are: \"1\", \"2\")","style":"form","explode":true,"schema":{"type":"string","default":"1"}},{"name":"quotaUser","in":"query","description":"Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"prettyPrint","in":"query","description":"Returns response with indentations and line breaks.","style":"form","explode":true,"schema":{"type":"boolean","default":true}},{"name":"oauth_token","in":"query","description":"OAuth 2.0 token for the current user.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"parent","in":"query","description":"Required. Name of the GCP project in which to associate the Apigee organization. Pass the information as a query parameter using the following structure in your request: `projects/`","style":"form","explode":true,"schema":{"type":"string"}}],"requestBody":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudApigeeV1Organization"}}},"required":true},"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleLongrunningOperation"}}}}},"deprecated":false,"security":[{"httpBearer":["https://www.googleapis.com/auth/cloud-platform"]}]},"parameters":[]},"/v1/{org}:setAddons":{"post":{"tags":["organizations"],"summary":"SetAddonsV1SetAddonsByOrg","description":"Configures the add-ons for the Apigee organization. The existing add-on configuration will be fully replaced.","operationId":"SetAddonsV1SetAddonsByOrg","parameters":[{"name":"callback","in":"query","description":"JSONP","style":"form","explode":true,"schema":{"type":"string"}},{"name":"key","in":"query","description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"alt","in":"query","description":"Data format for response. (Acceptable values are: \"json\", \"media\", \"proto\")","style":"form","explode":true,"schema":{"type":"string","default":"json"}},{"name":"uploadType","in":"query","description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"upload_protocol","in":"query","description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"Selector specifying which fields to include in a partial response.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"access_token","in":"query","description":"OAuth access token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"$.xgafv","in":"query","description":"V1 error format. (Acceptable values are: \"1\", \"2\")","style":"form","explode":true,"schema":{"type":"string","default":"1"}},{"name":"quotaUser","in":"query","description":"Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"prettyPrint","in":"query","description":"Returns response with indentations and line breaks.","style":"form","explode":true,"schema":{"type":"boolean","default":true}},{"name":"oauth_token","in":"query","description":"OAuth 2.0 token for the current user.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"org","in":"path","description":"Required. Name of the organization. Use the following structure in your request: `organizations/{org}`","required":true,"style":"simple","schema":{"pattern":"^organizations/[^/]+$","type":"string"}}],"requestBody":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudApigeeV1SetAddonsRequest"}}},"required":true},"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleLongrunningOperation"}}}}},"deprecated":false,"security":[{"httpBearer":["https://www.googleapis.com/auth/cloud-platform"]}]},"parameters":[]}},"components":{"schemas":{"GoogleIamV1AuditLogConfig":{"title":"GoogleIamV1AuditLogConfig","type":"object","properties":{"logType":{"allOf":[{"$ref":"#/components/schemas/LogType"},{"description":"The log type that this config enables."}]},"exemptedMembers":{"type":"array","items":{"type":"string"},"description":"Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members."}},"description":"Provides the configuration for logging a type of permissions. Example: { \"audit_log_configs\": [ { \"log_type\": \"DATA_READ\", \"exempted_members\": [ \"user:jose@example.com\" ] }, { \"log_type\": \"DATA_WRITE\" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging."},"GoogleCloudApigeeV1InstanceDeploymentStatusDeployedRoute":{"title":"GoogleCloudApigeeV1InstanceDeploymentStatusDeployedRoute","type":"object","properties":{"basepath":{"type":"string","description":"Base path in the routing table."},"percentage":{"type":"integer","description":"Percentage of ingress replicas reporting this route.","contentEncoding":"int32"},"envgroup":{"type":"string","description":"Environment group where this route is installed."},"environment":{"type":"string","description":"Destination environment. This will be empty if the route is not yet reported."}},"description":"Route deployed in the ingress routing table."},"GoogleTypeExpr":{"title":"GoogleTypeExpr","type":"object","properties":{"location":{"type":"string","description":"Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file."},"expression":{"type":"string","description":"Textual representation of an expression in Common Expression Language syntax."},"title":{"type":"string","description":"Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression."},"description":{"type":"string","description":"Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI."}},"description":"Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: \"Summary size limit\" description: \"Determines if a summary is less than 100 chars\" expression: \"document.summary.size() < 100\" Example (Equality): title: \"Requestor is owner\" description: \"Determines if requestor is the document owner\" expression: \"document.owner == request.auth.claims.email\" Example (Logic): title: \"Public documents\" description: \"Determine whether the document should be publicly visible\" expression: \"document.type != 'private' && document.type != 'internal'\" Example (Data Manipulation): title: \"Notification string\" description: \"Create a notification string with a timestamp.\" expression: \"'New message received at ' + string(document.create_time)\" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information."},"GoogleCloudApigeeV1RatePlan":{"title":"GoogleCloudApigeeV1RatePlan","type":"object","properties":{"revenueShareRates":{"type":"array","items":{"$ref":"#/components/schemas/GoogleCloudApigeeV1RevenueShareRange"},"description":"Details of the revenue sharing model."},"paymentFundingModel":{"allOf":[{"$ref":"#/components/schemas/PaymentFundingModel"},{"description":"DEPRECATED: This field is no longer supported and will eventually be removed when Apigee Hybrid 1.5/1.6 is no longer supported. Instead, use the `billingType` field inside `DeveloperMonetizationConfig` resource. Flag that specifies the billing account type, prepaid or postpaid."}]},"endTime":{"type":"string","description":"Time when the rate plan will expire in milliseconds since epoch. Set to 0 or `null` to indicate that the rate plan should never expire."},"lastModifiedAt":{"type":"string","description":"Output only. Time the rate plan was last modified in milliseconds since epoch."},"state":{"allOf":[{"$ref":"#/components/schemas/State"},{"description":"Current state of the rate plan (draft or published)."}]},"description":{"type":"string","description":"Description of the rate plan."},"createdAt":{"type":"string","description":"Output only. Time that the rate plan was created in milliseconds since epoch."},"consumptionPricingRates":{"type":"array","items":{"$ref":"#/components/schemas/GoogleCloudApigeeV1RateRange"},"description":"API call volume ranges and the fees charged when the total number of API calls is within a given range. The method used to calculate the final fee depends on the selected pricing model. For example, if the pricing model is `STAIRSTEP` and the ranges are defined as follows: ``` { \"start\": 1, \"end\": 100, \"fee\": 75 }, { \"start\": 101, \"end\": 200, \"fee\": 100 }, } ``` Then the following fees would be charged based on the total number of API calls (assuming the currency selected is `USD`): * 1 call costs $75 * 50 calls cost $75 * 150 calls cost $100 The number of API calls cannot exceed 200."},"revenueShareType":{"allOf":[{"$ref":"#/components/schemas/RevenueShareType"},{"description":"Method used to calculate the revenue that is shared with developers."}]},"fixedRecurringFee":{"allOf":[{"$ref":"#/components/schemas/GoogleTypeMoney"},{"description":"Represents an amount of money with its currency type."}]},"name":{"type":"string","description":"Output only. Name of the rate plan."},"setupFee":{"allOf":[{"$ref":"#/components/schemas/GoogleTypeMoney"},{"description":"Represents an amount of money with its currency type."}]},"apiproduct":{"type":"string","description":"Name of the API product that the rate plan is associated with."},"displayName":{"type":"string","description":"Display name of the rate plan."},"currencyCode":{"type":"string","description":"Currency to be used for billing. Consists of a three-letter code as defined by the [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) standard."},"consumptionPricingType":{"allOf":[{"$ref":"#/components/schemas/ConsumptionPricingType"},{"description":"Pricing model used for consumption-based charges."}]},"fixedFeeFrequency":{"type":"integer","description":"Frequency at which the fixed fee is charged.","contentEncoding":"int32"},"startTime":{"type":"string","description":"Time when the rate plan becomes active in milliseconds since epoch."},"billingPeriod":{"allOf":[{"$ref":"#/components/schemas/BillingPeriod"},{"description":"Frequency at which the customer will be billed."}]}},"description":"Rate plan details."},"GoogleCloudApigeeV1GraphQLOperation":{"title":"GoogleCloudApigeeV1GraphQLOperation","type":"object","properties":{"operation":{"type":"string","description":"GraphQL operation name. The name and operation type will be used to apply quotas. If no name is specified, the quota will be applied to all GraphQL operations irrespective of their operation names in the payload."},"operationTypes":{"type":"array","items":{"type":"string"},"description":"Required. GraphQL operation types. Valid values include `query` or `mutation`. **Note**: Apigee does not currently support `subscription` types."}},"description":"Represents the pairing of GraphQL operation types and the GraphQL operation name."},"GoogleCloudApigeeV1ResourceConfig":{"title":"GoogleCloudApigeeV1ResourceConfig","type":"object","properties":{"name":{"type":"string","description":"Resource name in the following format: `organizations/{org}/environments/{env}/resourcefiles/{type}/{file}/revisions/{rev}` Only environment-scoped resource files are supported."},"location":{"type":"string","description":"Location of the resource as a URI."}}},"GoogleCloudApigeeV1ListEnvironmentResourcesResponse":{"title":"GoogleCloudApigeeV1ListEnvironmentResourcesResponse","type":"object","properties":{"resourceFile":{"type":"array","items":{"$ref":"#/components/schemas/GoogleCloudApigeeV1ResourceFile"},"description":"List of resources files."}},"description":"Response for ListEnvironmentResources"},"GoogleCloudApigeeV1MetricAggregation":{"title":"GoogleCloudApigeeV1MetricAggregation","type":"object","properties":{"aggregation":{"allOf":[{"$ref":"#/components/schemas/Aggregation"},{"description":"Aggregation function associated with the metric."}]},"name":{"type":"string","description":"Name of the metric"},"order":{"allOf":[{"$ref":"#/components/schemas/Order"},{"description":"Ordering for this aggregation in the result. For time series this is ignored since the ordering of points depends only on the timestamp, not the values."}]}},"description":"The optionally aggregated metric to query with its ordering."},"GoogleCloudApigeeV1OrganizationProjectMapping":{"title":"GoogleCloudApigeeV1OrganizationProjectMapping","type":"object","properties":{"organization":{"type":"string","description":"Name of the Apigee organization."},"projectId":{"type":"string","description":"GCP project associated with the Apigee organization"},"location":{"type":"string","description":"Output only. The Google Cloud region where control plane data is located. For more information, see https://cloud.google.com/about/locations/."},"projectIds":{"type":"array","items":{"type":"string"},"description":"DEPRECATED: Use `project_id`. An Apigee Organization is mapped to a single project."}}},"GoogleCloudApigeeV1Subscription":{"title":"GoogleCloudApigeeV1Subscription","type":"object","properties":{"name":{"type":"string","description":"Full name of the Pub/Sub subcription. Use the following structure in your request: `subscription \"projects/foo/subscription/bar\"`"}},"description":"Pub/Sub subscription of an environment."},"GoogleCloudApigeeV1ListRatePlansResponse":{"title":"GoogleCloudApigeeV1ListRatePlansResponse","type":"object","properties":{"ratePlans":{"type":"array","items":{"$ref":"#/components/schemas/GoogleCloudApigeeV1RatePlan"},"description":"List of rate plans in an organization."},"nextStartKey":{"type":"string","description":"Value that can be sent as `startKey` to retrieve the next page of content. If this field is omitted, there are no subsequent pages."}},"description":"Response for ListRatePlans."},"GoogleCloudApigeeV1CustomReport":{"title":"GoogleCloudApigeeV1CustomReport","type":"object","properties":{"chartType":{"type":"string","description":"This field contains the chart type for the report"},"offset":{"type":"string","description":"Legacy field: not used. This field contains the offset for the data"},"organization":{"type":"string","description":"Output only. Organization name"},"fromTime":{"type":"string","description":"Legacy field: not used. Contains the from time for the report"},"environment":{"type":"string","description":"Output only. Environment name"},"metrics":{"type":"array","items":{"$ref":"#/components/schemas/GoogleCloudApigeeV1CustomReportMetric"},"description":"Required. This contains the list of metrics"},"createdAt":{"type":"string","description":"Output only. Unix time when the app was created json key: createdAt"},"displayName":{"type":"string","description":"This is the display name for the report"},"tags":{"type":"array","items":{"type":"string"},"description":"Legacy field: not used. This field contains a list of tags associated with custom report"},"toTime":{"type":"string","description":"Legacy field: not used. Contains the end time for the report"},"topk":{"type":"string","description":"Legacy field: not used. This field contains the top k parameter value for restricting the result"},"sortByCols":{"type":"array","items":{"type":"string"},"description":"Legacy field: not used much. Contains the list of sort by columns"},"lastModifiedAt":{"type":"string","description":"Output only. Modified time of this entity as milliseconds since epoch. json key: lastModifiedAt"},"lastViewedAt":{"type":"string","description":"Output only. Last viewed time of this entity as milliseconds since epoch"},"filter":{"type":"string","description":"This field contains the filter expression"},"sortOrder":{"type":"string","description":"Legacy field: not used much. Contains the sort order for the sort columns"},"limit":{"type":"string","description":"Legacy field: not used This field contains the limit for the result retrieved"},"comments":{"type":"array","items":{"type":"string"},"description":"Legacy field: not used. This field contains a list of comments associated with custom report"},"dimensions":{"type":"array","items":{"type":"string"},"description":"This contains the list of dimensions for the report"},"timeUnit":{"type":"string","description":"This field contains the time unit of aggregation for the report"},"properties":{"type":"array","items":{"$ref":"#/components/schemas/GoogleCloudApigeeV1ReportProperty"},"description":"This field contains report properties such as ui metadata etc."},"name":{"type":"string","description":"Required. Unique identifier for the report T his is a legacy field used to encode custom report unique id"}}},"GoogleCloudApigeeV1EndpointAttachment":{"title":"GoogleCloudApigeeV1EndpointAttachment","type":"object","properties":{"location":{"type":"string","description":"Required. Location of the endpoint attachment."},"connectionState":{"allOf":[{"$ref":"#/components/schemas/ConnectionState"},{"description":"Output only. State of the endpoint attachment connection to the service attachment."}]},"state":{"allOf":[{"$ref":"#/components/schemas/State1"},{"description":"Output only. State of the endpoint attachment. Values other than `ACTIVE` mean the resource is not ready to use."}]},"serviceAttachment":{"type":"string","description":"Format: projects/*/regions/*/serviceAttachments/*"},"host":{"type":"string","description":"Output only. Host that can be used in either the HTTP target endpoint directly or as the host in target server."},"name":{"type":"string","description":"Name of the endpoint attachment. Use the following structure in your request: `organizations/{org}/endpointAttachments/{endpoint_attachment}`"}},"description":"Apigee endpoint attachment. For more information, see [Southbound networking patterns] (https://cloud.google.com/apigee/docs/api-platform/architecture/southbound-networking-patterns-endpoints)."},"GoogleCloudApigeeV1ListDataCollectorsResponse":{"title":"GoogleCloudApigeeV1ListDataCollectorsResponse","type":"object","properties":{"nextPageToken":{"type":"string","description":"Page token that you can include in a ListDataCollectors request to retrieve the next page. If omitted, no subsequent pages exist."},"dataCollectors":{"type":"array","items":{"$ref":"#/components/schemas/GoogleCloudApigeeV1DataCollector"},"description":"Data collectors in the specified organization."}},"description":"Response for ListDataCollectors."},"GoogleCloudApigeeV1EnvironmentGroupAttachment":{"title":"GoogleCloudApigeeV1EnvironmentGroupAttachment","type":"object","properties":{"name":{"type":"string","description":"ID of the environment group attachment."},"createdAt":{"type":"string","description":"Output only. The time at which the environment group attachment was created as milliseconds since epoch."},"environmentGroupId":{"type":"string","description":"Output only. ID of the environment group."},"environment":{"type":"string","description":"Required. ID of the attached environment."}},"description":"EnvironmentGroupAttachment is a resource which defines an attachment of an environment to an environment group."},"GoogleTypeInterval":{"title":"GoogleTypeInterval","type":"object","properties":{"endTime":{"type":"string","description":"Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end."},"startTime":{"type":"string","description":"Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start."}},"description":"Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive). The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time."},"GoogleCloudApigeeV1ResourceFile":{"title":"GoogleCloudApigeeV1ResourceFile","type":"object","properties":{"type":{"type":"string","description":"Resource file type. {{ resource_file_type }}"},"name":{"type":"string","description":"ID of the resource file."}},"description":"Metadata about a resource file."},"GoogleCloudApigeeV1QueryTimeSeriesStatsResponse":{"title":"GoogleCloudApigeeV1QueryTimeSeriesStatsResponse","type":"object","properties":{"nextPageToken":{"type":"string","description":"Next page token."},"values":{"type":"array","items":{"$ref":"#/components/schemas/GoogleCloudApigeeV1QueryTimeSeriesStatsResponseSequence"},"description":"Results of the query returned as a JSON array."},"columns":{"type":"array","items":{"type":"string"},"description":"Column names corresponding to the same order as the inner values in the stats field."}},"description":"Represents security stats result as a collection of time series sequences."},"GoogleCloudApigeeV1ScoreComponentRecommendationActionActionContext":{"title":"GoogleCloudApigeeV1ScoreComponentRecommendationActionActionContext","type":"object","properties":{"documentationLink":{"type":"string","description":"Documentation link for the action."}},"description":"Action context are all the relevant details for the action."},"GoogleCloudApigeeV1AsyncQuery":{"title":"GoogleCloudApigeeV1AsyncQuery","type":"object","properties":{"error":{"type":"string","description":"Error is set when query fails."},"resultRows":{"type":"string","description":"ResultRows is available only after the query is completed."},"envgroupHostname":{"type":"string","description":"Hostname is available only when query is executed at host level."},"name":{"type":"string","description":"Asynchronous Query Name."},"self":{"type":"string","description":"Self link of the query. Example: `/organizations/myorg/environments/myenv/queries/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd` or following format if query is running at host level: `/organizations/myorg/hostQueries/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd`"},"reportDefinitionId":{"type":"string","description":"Asynchronous Report ID."},"result":{"$ref":"#/components/schemas/GoogleCloudApigeeV1AsyncQueryResult"},"created":{"type":"string","description":"Creation time of the query."},"executionTime":{"type":"string","description":"ExecutionTime is available only after the query is completed."},"updated":{"type":"string","description":"Last updated timestamp for the query."},"resultFileSize":{"type":"string","description":"ResultFileSize is available only after the query is completed."},"queryParams":{"$ref":"#/components/schemas/GoogleCloudApigeeV1QueryMetadata"},"state":{"type":"string","description":"Query state could be \"enqueued\", \"running\", \"completed\", \"failed\"."}}},"GoogleLongrunningListOperationsResponse":{"title":"GoogleLongrunningListOperationsResponse","type":"object","properties":{"nextPageToken":{"type":"string","description":"The standard List next-page token."},"operations":{"type":"array","items":{"$ref":"#/components/schemas/GoogleLongrunningOperation"},"description":"A list of operations that matches the specified filter in the request."}},"description":"The response message for Operations.ListOperations."},"GoogleCloudApigeeV1TlsInfo":{"title":"GoogleCloudApigeeV1TlsInfo","type":"object","properties":{"trustStore":{"type":"string","description":"The resource ID of the truststore."},"keyAlias":{"type":"string","description":"Required if `client_auth_enabled` is true. The resource ID for the alias containing the private key and cert."},"protocols":{"type":"array","items":{"type":"string"},"description":"The TLS versioins to be used."},"ciphers":{"type":"array","items":{"type":"string"},"description":"The SSL/TLS cipher suites to be used. For programmable proxies, it must be one of the cipher suite names listed in: http://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html#ciphersuites. For configurable proxies, it must follow the configuration specified in: https://commondatastorage.googleapis.com/chromium-boringssl-docs/ssl.h.html#Cipher-suite-configuration. This setting has no effect for configurable proxies when negotiating TLS 1.3."},"enabled":{"type":"boolean","description":"Required. Enables TLS. If false, neither one-way nor two-way TLS will be enabled."},"clientAuthEnabled":{"type":"boolean","description":"Optional. Enables two-way TLS."},"commonName":{"$ref":"#/components/schemas/GoogleCloudApigeeV1TlsInfoCommonName"},"ignoreValidationErrors":{"type":"boolean","description":"If true, Edge ignores TLS certificate errors. Valid when configuring TLS for target servers and target endpoints, and when configuring virtual hosts that use 2-way TLS. When used with a target endpoint/target server, if the backend system uses SNI and returns a cert with a subject Distinguished Name (DN) that does not match the hostname, there is no way to ignore the error and the connection fails."},"keyStore":{"type":"string","description":"Required if `client_auth_enabled` is true. The resource ID of the keystore."}},"description":"TLS configuration information for virtual hosts and TargetServers."},"GoogleCloudApigeeV1SetAddonsRequest":{"title":"GoogleCloudApigeeV1SetAddonsRequest","type":"object","properties":{"addonsConfig":{"allOf":[{"$ref":"#/components/schemas/GoogleCloudApigeeV1AddonsConfig"},{"description":"Add-on configurations for the Apigee organization."}]}},"description":"Request for SetAddons."},"GoogleRpcPreconditionFailure":{"title":"GoogleRpcPreconditionFailure","type":"object","properties":{"violations":{"type":"array","items":{"$ref":"#/components/schemas/GoogleRpcPreconditionFailureViolation"},"description":"Describes all precondition violations."}},"description":"Describes what preconditions have failed. For example, if an RPC failed because it required the Terms of Service to be acknowledged, it could list the terms of service violation in the PreconditionFailure message."},"GoogleCloudApigeeV1ApiCategory":{"title":"GoogleCloudApigeeV1ApiCategory","type":"object","properties":{"requestId":{"type":"string","description":"ID that can be used to find request details in the log files."},"status":{"type":"string","description":"Status of the operation."},"message":{"type":"string","description":"Description of the operation."},"errorCode":{"type":"string","description":"ID that can be used to find errors in the log files."},"data":{"allOf":[{"$ref":"#/components/schemas/GoogleCloudApigeeV1ApiCategoryData"},{"description":"the Api category resource."}]}},"description":"the Api category resource wrapped with response status, error_code etc."},"GoogleCloudApigeeV1MonetizationConfig":{"title":"GoogleCloudApigeeV1MonetizationConfig","type":"object","properties":{"enabled":{"type":"boolean","description":"Flag that specifies whether the Monetization add-on is enabled."}},"description":"Configuration for the Monetization add-on."},"GoogleCloudApigeeV1NodeConfig":{"title":"GoogleCloudApigeeV1NodeConfig","type":"object","properties":{"currentAggregateNodeCount":{"type":"string","description":"Output only. The current total number of gateway nodes that each environment currently has across all instances."},"maxNodeCount":{"type":"string","description":"Optional. The maximum total number of gateway nodes that the is reserved for all instances that has the specified environment. If not specified, the default is determined by the recommended maximum number of nodes for that gateway."},"minNodeCount":{"type":"string","description":"Optional. The minimum total number of gateway nodes that the is reserved for all instances that has the specified environment. If not specified, the default is determined by the recommended minimum number of nodes for that gateway."}},"description":"NodeConfig for setting the min/max number of nodes associated with the environment."},"GoogleCloudApigeeV1SecurityReportQueryMetric":{"title":"GoogleCloudApigeeV1SecurityReportQueryMetric","type":"object","properties":{"alias":{"type":"string","description":"Alias for the metric. Alias will be used to replace metric name in query results."},"aggregationFunction":{"type":"string","description":"Aggregation function: avg, min, max, or sum."},"value":{"type":"string","description":"Operand value should be provided when operator is set."},"name":{"type":"string","description":"Required. Metric name."},"operator":{"type":"string","description":"One of `+`, `-`, `/`, `%`, `*`."}},"description":"Metric of the Query"},"GoogleCloudApigeeV1PodStatus":{"title":"GoogleCloudApigeeV1PodStatus","type":"object","properties":{"deploymentStatus":{"type":"string","description":"Status of the deployment. Valid values include: - `deployed`: Successful. - `error` : Failed. - `pending` : Pod has not yet reported on the deployment."},"podName":{"type":"string","description":"Name of the pod which is reporting the status."},"appVersion":{"type":"string","description":"Version of the application running in the pod."},"deploymentStatusTime":{"type":"string","description":"Time the deployment status was reported in milliseconds since epoch."},"statusCode":{"type":"string","description":"Code associated with the deployment status."},"deploymentTime":{"type":"string","description":"Time the proxy was deployed in milliseconds since epoch."},"podStatusTime":{"type":"string","description":"Time the pod status was reported in milliseconds since epoch."},"podStatus":{"type":"string","description":"Overall status of the pod (not this specific deployment). Valid values include: - `active`: Up to date. - `stale` : Recently out of date. Pods that have not reported status in a long time are excluded from the output."},"statusCodeDetails":{"type":"string","description":"Human-readable message associated with the status code."}}},"GoogleCloudApigeeV1CertInfo":{"title":"GoogleCloudApigeeV1CertInfo","type":"object","properties":{"subject":{"type":"string","description":"X.509 subject."},"subjectAlternativeNames":{"type":"array","items":{"type":"string"},"description":"X.509 subject alternative names (SANs) extension."},"issuer":{"type":"string","description":"X.509 issuer."},"validFrom":{"type":"string","description":"X.509 `notBefore` validity period in milliseconds since epoch."},"serialNumber":{"type":"string","description":"X.509 serial number."},"isValid":{"type":"string","description":"Flag that specifies whether the certificate is valid. Flag is set to `Yes` if the certificate is valid, `No` if expired, or `Not yet` if not yet valid."},"version":{"type":"integer","description":"X.509 version.","contentEncoding":"int32"},"basicConstraints":{"type":"string","description":"X.509 basic constraints extension."},"sigAlgName":{"type":"string","description":"X.509 signatureAlgorithm."},"publicKey":{"type":"string","description":"Public key component of the X.509 subject public key info."},"expiryDate":{"type":"string","description":"X.509 `notAfter` validity period in milliseconds since epoch."}},"description":"X.509 certificate as defined in RFC 5280."},"GoogleCloudApigeeV1QueryTimeSeriesStatsResponseSequence":{"title":"GoogleCloudApigeeV1QueryTimeSeriesStatsResponseSequence","type":"object","properties":{"dimensions":{"type":"object","additionalProperties":{"type":"string"},"description":"Map of dimensions and their values that uniquely identifies a time series sequence."},"points":{"type":"array","items":{"type":"array","items":{}},"description":"List of points. First value of each inner list is a timestamp."}},"description":"A sequence of time series."},"GoogleCloudApigeeV1ComputeEnvironmentScoresRequest":{"title":"GoogleCloudApigeeV1ComputeEnvironmentScoresRequest","type":"object","properties":{"pageSize":{"type":"integer","description":"Optional. The maximum number of subcomponents to be returned in a single page. The service may return fewer than this value. If unspecified, at most 100 subcomponents will be returned in a single page.","contentEncoding":"int32"},"pageToken":{"type":"string","description":"Optional. A token that can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages."},"filters":{"type":"array","items":{"$ref":"#/components/schemas/GoogleCloudApigeeV1ComputeEnvironmentScoresRequestFilter"},"description":"Optional. Filters are used to filter scored components. Return all the components if no filter is mentioned. Example: [{ \"scorePath\": \"/org@myorg/envgroup@myenvgroup/env@myenv/proxies/proxy@myproxy/source\" }, { \"scorePath\": \"/org@myorg/envgroup@myenvgroup/env@myenv/proxies/proxy@myproxy/target\", }] This will return components with path: \"/org@myorg/envgroup@myenvgroup/env@myenv/proxies/proxy@myproxy/source\" OR \"/org@myorg/envgroup@myenvgroup/env@myenv/proxies/proxy@myproxy/target\""},"timeRange":{"allOf":[{"$ref":"#/components/schemas/GoogleTypeInterval"},{"description":"Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive). The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time."}]}},"description":"Request for ComputeEnvironmentScores."},"GoogleCloudApigeeV1ScoreComponent":{"title":"GoogleCloudApigeeV1ScoreComponent","type":"object","properties":{"calculateTime":{"type":"string","description":"Time when score was calculated."},"scorePath":{"type":"string","description":"Path of the component. Example: /org@myorg/envgroup@myenvgroup/proxies/proxy@myproxy"},"score":{"type":"integer","description":"Score for the component.","contentEncoding":"int32"},"dataCaptureTime":{"type":"string","description":"Time in the requested time period when data was last captured to compute the score."},"drilldownPaths":{"type":"array","items":{"type":"string"},"description":"List of paths for next components."},"recommendations":{"type":"array","items":{"$ref":"#/components/schemas/GoogleCloudApigeeV1ScoreComponentRecommendation"},"description":"List of recommendations to improve API security."}},"description":"Component is an individual security element that is scored."},"GoogleCloudApigeeV1QueryTimeSeriesStatsRequest":{"title":"GoogleCloudApigeeV1QueryTimeSeriesStatsRequest","type":"object","properties":{"filter":{"type":"string","description":"Filter further on specific dimension values. Follows the same grammar as custom report's filter expressions. Example, apiproxy eq 'foobar'. https://cloud.google.com/apigee/docs/api-platform/analytics/analytics-reference#filters"},"dimensions":{"type":"array","items":{"type":"string"},"description":"List of dimension names to group the aggregations by. If no dimensions are passed, a single trend line representing the requested metric aggregations grouped by environment is returned."},"timeRange":{"allOf":[{"$ref":"#/components/schemas/GoogleTypeInterval"},{"description":"Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive). The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time."}]},"metrics":{"type":"array","items":{"$ref":"#/components/schemas/GoogleCloudApigeeV1MetricAggregation"},"description":"Required. List of metrics and their aggregations."},"pageToken":{"type":"string","description":"Page token stands for a specific collection of time series sequences."},"windowSize":{"allOf":[{"$ref":"#/components/schemas/WindowSize"},{"description":"Time buckets to group the stats by."}]},"pageSize":{"type":"integer","description":"Page size represents the number of time series sequences, one per unique set of dimensions and their values.","contentEncoding":"int32"},"timestampOrder":{"allOf":[{"$ref":"#/components/schemas/TimestampOrder"},{"description":"Order the sequences in increasing or decreasing order of timestamps. Default is descending order of timestamps (latest first)."}]}},"description":"QueryTimeSeriesStatsRequest represents a query that returns a collection of time series sequences grouped by their values."},"GoogleCloudApigeeV1ListApiProductsResponse":{"title":"GoogleCloudApigeeV1ListApiProductsResponse","type":"object","properties":{"apiProduct":{"type":"array","items":{"$ref":"#/components/schemas/GoogleCloudApigeeV1ApiProduct"},"description":"Lists all API product names defined for an organization."}}},"GoogleCloudApigeeV1Result":{"title":"GoogleCloudApigeeV1Result","type":"object","properties":{"headers":{"type":"array","items":{"$ref":"#/components/schemas/GoogleCloudApigeeV1Property"},"description":"A list of HTTP headers. for example, '\"headers\" : [ { \"name\" : \"Content-Length\", \"value\" : \"83\" }, { \"name\" : \"Content-Type\", \"value\" : \"application/json\" } ]'"},"properties":{"allOf":[{"$ref":"#/components/schemas/GoogleCloudApigeeV1Properties"},{"description":"Message for compatibility with legacy Edge specification for Java Properties object in JSON."}]},"timestamp":{"type":"string","description":"Timestamp of when the result is recorded. Its format is dd-mm-yy hh:mm:ss:xxx. For example, `\"timestamp\" : \"12-08-19 00:31:59:960\"`"},"content":{"type":"string","description":"Error message content. for example, \"content\" : \"{\\\"fault\\\":{\\\"faultstring\\\":\\\"API timed out\\\",\\\"detail\\\":{\\\"errorcode\\\":\\\"flow.APITimedOut\\\"}}}\""},"uRI":{"type":"string","description":"The relative path of the api proxy. for example, `\"uRI\" : \"/iloveapis\"`"},"reasonPhrase":{"type":"string","description":"HTTP response phrase"},"ActionResult":{"type":"string","description":"Type of the action result. Can be one of the five: DebugInfo, RequestMessage, ResponseMessage, ErrorMessage, VariableAccess"},"accessList":{"type":"array","items":{"$ref":"#/components/schemas/GoogleCloudApigeeV1Access"},"description":"A list of variable access actions agaist the api proxy. Supported values: Get, Set, Remove."},"verb":{"type":"string","description":"HTTP method verb"},"statusCode":{"type":"string","description":"HTTP response code"}},"description":"Result is short for \"action result\", could be different types identified by \"action_result\" field. Supported types: 1. DebugInfo : generic debug info collected by runtime recorded as a list of properties. For example, the contents could be virtual host info, state change result, or execution metadata. Required fields : properties, timestamp 2. RequestMessage: information of a http request. Contains headers, request URI and http methods type.Required fields : headers, uri, verb 3. ResponseMessage: information of a http response. Contains headers, reason phrase and http status code. Required fields : headers, reasonPhrase, statusCode 4. ErrorMessage: information of a http error message. Contains detail error message, reason phrase and status code. Required fields : content, headers, reasonPhrase, statusCode 5. VariableAccess: a list of variable access actions, can be Get, Set and Remove. Required fields : accessList"},"GoogleCloudApigeeV1ListAppsResponse":{"title":"GoogleCloudApigeeV1ListAppsResponse","type":"object","properties":{"app":{"type":"array","items":{"$ref":"#/components/schemas/GoogleCloudApigeeV1App"},"description":""}}},"GoogleCloudApigeeV1ListOrganizationsResponse":{"title":"GoogleCloudApigeeV1ListOrganizationsResponse","type":"object","properties":{"organizations":{"type":"array","items":{"$ref":"#/components/schemas/GoogleCloudApigeeV1OrganizationProjectMapping"},"description":"List of Apigee organizations and associated GCP projects."}}},"GoogleCloudApigeeV1TraceConfigOverride":{"title":"GoogleCloudApigeeV1TraceConfigOverride","type":"object","properties":{"name":{"type":"string","description":"ID of the trace configuration override specified as a system-generated UUID."},"apiProxy":{"type":"string","description":"ID of the API proxy that will have its trace configuration overridden."},"samplingConfig":{"allOf":[{"$ref":"#/components/schemas/GoogleCloudApigeeV1TraceSamplingConfig"},{"description":"TraceSamplingConfig represents the detail settings of distributed tracing. Only the fields that are defined in the distributed trace configuration can be overridden using the distribute trace configuration override APIs."}]}},"description":"A representation of a configuration override."},"GoogleCloudApigeeV1DataCollectorConfig":{"title":"GoogleCloudApigeeV1DataCollectorConfig","type":"object","properties":{"name":{"type":"string","description":"Name of the data collector in the following format: `organizations/{org}/datacollectors/{datacollector}`"},"type":{"allOf":[{"$ref":"#/components/schemas/Type1"},{"description":"Data type accepted by the data collector."}]}},"description":"Data collector and its configuration."},"GoogleCloudApigeeV1RuntimeTraceSamplingConfig":{"title":"GoogleCloudApigeeV1RuntimeTraceSamplingConfig","type":"object","properties":{"sampler":{"allOf":[{"$ref":"#/components/schemas/Sampler"},{"description":"Sampler of distributed tracing. OFF is the default value."}]},"samplingRate":{"type":"number","description":"Field sampling rate. This value is only applicable when using the PROBABILITY sampler. The supported values are > 0 and <= 0.5."}},"description":"NEXT ID: 3 RuntimeTraceSamplingConfig represents the detail settings of distributed tracing. Only the fields that are defined in the distributed trace configuration can be overridden using the distribute trace configuration override APIs."},"GoogleCloudApigeeV1ApiResponseWrapper":{"title":"GoogleCloudApigeeV1ApiResponseWrapper","type":"object","properties":{"message":{"type":"string","description":"Description of the operation."},"requestId":{"type":"string","description":"ID that can be used to find request details in the log files."},"errorCode":{"type":"string","description":"ID that can be used to find errors in the log files."},"status":{"type":"string","description":"Status of the operation."}}},"GoogleIamV1Policy":{"title":"GoogleIamV1Policy","type":"object","properties":{"auditConfigs":{"type":"array","items":{"$ref":"#/components/schemas/GoogleIamV1AuditConfig"},"description":"Specifies cloud audit logging configuration for this policy."},"version":{"type":"integer","description":"Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).","contentEncoding":"int32"},"etag":{"type":"string","description":"`etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost."},"bindings":{"type":"array","items":{"$ref":"#/components/schemas/GoogleIamV1Binding"},"description":"Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`."}},"description":"An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { \"bindings\": [ { \"role\": \"roles/resourcemanager.organizationAdmin\", \"members\": [ \"user:mike@example.com\", \"group:admins@example.com\", \"domain:google.com\", \"serviceAccount:my-project-id@appspot.gserviceaccount.com\" ] }, { \"role\": \"roles/resourcemanager.organizationViewer\", \"members\": [ \"user:eve@example.com\" ], \"condition\": { \"title\": \"expirable access\", \"description\": \"Does not grant access after Sep 2020\", \"expression\": \"request.time < timestamp('2020-10-01T00:00:00.000Z')\", } } ], \"etag\": \"BwWWja0YfJA=\", \"version\": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/)."},"GoogleCloudApigeeV1DebugSession":{"title":"GoogleCloudApigeeV1DebugSession","type":"object","properties":{"tracesize":{"type":"integer","description":"Optional. The maximum number of bytes captured from the response payload. Min = 0, Max = 5120, Default = 5120.","contentEncoding":"int32"},"timeout":{"type":"string","description":"Optional. The time in seconds after which this DebugSession should end. This value will override the value in query param, if both are provided."},"validity":{"type":"integer","description":"Optional. The length of time, in seconds, that this debug session is valid, starting from when it's received in the control plane. Min = 1, Max = 15, Default = 10.","contentEncoding":"int32"},"name":{"type":"string","description":"A unique ID for this DebugSession."},"filter":{"type":"string","description":"Optional. A conditional statement which is evaluated against the request message to determine if it should be traced. Syntax matches that of on API Proxy bundle flow Condition."},"count":{"type":"integer","description":"Optional. The number of request to be traced. Min = 1, Max = 15, Default = 10.","contentEncoding":"int32"},"createTime":{"type":"string","description":"Output only. The first transaction creation timestamp, recorded by UAP."}}},"GoogleCloudApigeeV1QueryTabularStatsRequest":{"title":"GoogleCloudApigeeV1QueryTabularStatsRequest","type":"object","properties":{"dimensions":{"type":"array","items":{"type":"string"},"description":"Required. List of dimension names to group the aggregations by."},"metrics":{"type":"array","items":{"$ref":"#/components/schemas/GoogleCloudApigeeV1MetricAggregation"},"description":"Required. List of metrics and their aggregations."},"pageSize":{"type":"integer","description":"Page size represents the number of rows.","contentEncoding":"int32"},"timeRange":{"allOf":[{"$ref":"#/components/schemas/GoogleTypeInterval"},{"description":"Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive). The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time."}]},"pageToken":{"type":"string","description":"Identifies a sequence of rows."},"filter":{"type":"string","description":"Filter further on specific dimension values. Follows the same grammar as custom report's filter expressions. Example, apiproxy eq 'foobar'. https://cloud.google.com/apigee/docs/api-platform/analytics/analytics-reference#filters"}},"description":"Request payload representing the query to be run for fetching security statistics as rows."},"GoogleCloudApigeeV1ListExportsResponse":{"title":"GoogleCloudApigeeV1ListExportsResponse","type":"object","properties":{"exports":{"type":"array","items":{"$ref":"#/components/schemas/GoogleCloudApigeeV1Export"},"description":"Details of the export jobs."}},"description":"The response for ListExports"},"GoogleCloudApigeeV1CommonNameConfig":{"title":"GoogleCloudApigeeV1CommonNameConfig","type":"object","properties":{"name":{"type":"string"},"matchWildCards":{"type":"boolean"}}},"GoogleCloudApigeeV1InstanceDeploymentStatusDeployedRevision":{"title":"GoogleCloudApigeeV1InstanceDeploymentStatusDeployedRevision","type":"object","properties":{"percentage":{"type":"integer","description":"Percentage of MP replicas reporting this revision.","contentEncoding":"int32"},"revision":{"type":"string","description":"API proxy revision reported as deployed."}},"description":"Revisions deployed in the MPs."},"GoogleCloudApigeeV1ListSecurityProfileRevisionsResponse":{"title":"GoogleCloudApigeeV1ListSecurityProfileRevisionsResponse","type":"object","properties":{"securityProfiles":{"type":"array","items":{"$ref":"#/components/schemas/GoogleCloudApigeeV1SecurityProfile"},"description":"List of security profile revisions. The revisions may be attached or unattached to any environment."},"nextPageToken":{"type":"string","description":"A token that can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages."}},"description":"Response for ListSecurityProfileRevisions."},"GoogleCloudApigeeV1SecurityProfileEnvironment":{"title":"GoogleCloudApigeeV1SecurityProfileEnvironment","type":"object","properties":{"attachTime":{"type":"string","description":"Output only. Time at which environment was attached to the security profile."},"environment":{"type":"string","description":"Output only. Name of the environment."}},"description":"Environment information of attached environments. Scoring an environment is enabled only if it is attached to a security profile."},"GoogleCloudApigeeV1OperationMetadata":{"title":"GoogleCloudApigeeV1OperationMetadata","type":"object","properties":{"warnings":{"type":"array","items":{"type":"string"},"description":"Warnings encountered while executing the operation."},"state":{"$ref":"#/components/schemas/State2"},"targetResourceName":{"type":"string","description":"Name of the resource for which the operation is operating on."},"progress":{"allOf":[{"$ref":"#/components/schemas/GoogleCloudApigeeV1OperationMetadataProgress"},{"description":"Information about operation progress."}]},"operationType":{"$ref":"#/components/schemas/OperationType"}},"description":"Metadata describing an Operation."},"GoogleCloudApigeeV1OptimizedStatsNode":{"title":"GoogleCloudApigeeV1OptimizedStatsNode","type":"object","properties":{"data":{"type":"array","items":{},"description":""}},"description":"Encapsulates a data node as represented below: ``` { \"identifier\": { \"names\": [ \"apiproxy\" ], \"values\": [ \"sirjee\" ] }, \"metric\": [ { \"env\": \"prod\", \"name\": \"sum(message_count)\", \"values\": [ 36.0 ] } ] }``` or ``` { \"env\": \"prod\", \"name\": \"sum(message_count)\", \"values\": [ 36.0 ] }``` Depending on whether a dimension is present in the query or not the data node type can be a simple metric value or dimension identifier with list of metrics."},"GoogleCloudApigeeV1SecurityProfileScoringConfig":{"title":"GoogleCloudApigeeV1SecurityProfileScoringConfig","type":"object","properties":{"description":{"type":"string","description":"Description of the config."},"title":{"type":"string","description":"Title of the config."},"scorePath":{"type":"string","description":"Path of the component config used for scoring."}},"description":"Security configurations to manage scoring."},"GoogleCloudApigeeV1CanaryEvaluationMetricLabels":{"title":"GoogleCloudApigeeV1CanaryEvaluationMetricLabels","type":"object","properties":{"env":{"type":"string","description":"The environment ID associated with the metrics."},"location":{"type":"string","description":"Required. The location associated with the metrics."},"instance_id":{"type":"string","description":"Required. The instance ID associated with the metrics. In Apigee Hybrid, the value is configured during installation."}},"description":"Labels that can be used to filter Apigee metrics."},"GoogleCloudApigeeV1AliasRevisionConfig":{"title":"GoogleCloudApigeeV1AliasRevisionConfig","type":"object","properties":{"name":{"type":"string","description":"Name of the alias revision included in the keystore in the following format: `organizations/{org}/environments/{env}/keystores/{keystore}/aliases/{alias}/revisions/{rev}`"},"type":{"$ref":"#/components/schemas/Type2"},"location":{"type":"string","description":"Location of the alias file. For example, a Google Cloud Storage URI."}}},"GoogleCloudApigeeV1ListDatastoresResponse":{"title":"GoogleCloudApigeeV1ListDatastoresResponse","type":"object","properties":{"datastores":{"type":"array","items":{"$ref":"#/components/schemas/GoogleCloudApigeeV1Datastore"},"description":"A list of datastores"}},"description":"The response for ListDatastores"},"GoogleCloudApigeeV1RuntimeTraceConfig":{"title":"GoogleCloudApigeeV1RuntimeTraceConfig","type":"object","properties":{"revisionCreateTime":{"type":"string","description":"The timestamp that the revision was created or updated."},"overrides":{"type":"array","items":{"$ref":"#/components/schemas/GoogleCloudApigeeV1RuntimeTraceConfigOverride"},"description":"List of trace configuration overrides for spicific API proxies."},"revisionId":{"type":"string","description":"Revision number which can be used by the runtime to detect if the trace config has changed between two versions."},"samplingConfig":{"allOf":[{"$ref":"#/components/schemas/GoogleCloudApigeeV1RuntimeTraceSamplingConfig"},{"description":"NEXT ID: 3 RuntimeTraceSamplingConfig represents the detail settings of distributed tracing. Only the fields that are defined in the distributed trace configuration can be overridden using the distribute trace configuration override APIs."}]},"name":{"type":"string","description":"Name of the trace config in the following format: `organizations/{org}/environment/{env}/traceConfig`"},"exporter":{"allOf":[{"$ref":"#/components/schemas/Exporter"},{"description":"Exporter that is used to view the distributed trace captured using OpenCensus. An exporter sends traces to any backend that is capable of consuming them. Recorded spans can be exported by registered exporters."}]},"endpoint":{"type":"string","description":"Endpoint of the exporter."}},"description":"NEXT ID: 8 RuntimeTraceConfig defines the configurations for distributed trace in an environment."},"GoogleCloudApigeeV1ListEnvironmentGroupAttachmentsResponse":{"title":"GoogleCloudApigeeV1ListEnvironmentGroupAttachmentsResponse","type":"object","properties":{"nextPageToken":{"type":"string","description":"Page token that you can include in a ListEnvironmentGroupAttachments request to retrieve the next page. If omitted, no subsequent pages exist."},"environmentGroupAttachments":{"type":"array","items":{"$ref":"#/components/schemas/GoogleCloudApigeeV1EnvironmentGroupAttachment"},"description":"EnvironmentGroupAttachments for the specified environment group."}},"description":"Response for ListEnvironmentGroupAttachments."},"GoogleCloudApigeeV1App":{"title":"GoogleCloudApigeeV1App","type":"object","properties":{"developerId":{"type":"string","description":"ID of the developer."},"credentials":{"type":"array","items":{},"description":"Output only. Set of credentials for the app. Credentials are API key/secret pairs associated with API products."},"callbackUrl":{"type":"string","description":"Callback URL used by OAuth 2.0 authorization servers to communicate authorization codes back to apps."},"attributes":{"type":"array","items":{},"description":"List of attributes."},"lastModifiedAt":{"type":"string","description":"Output only. Last modified time as milliseconds since epoch."},"apiProducts":{"type":"array","items":{},"description":"List of API products associated with the app."},"name":{"type":"string","description":"Name of the app."},"scopes":{"type":"array","items":{"type":"string"},"description":"Scopes to apply to the app. The specified scope names must already exist on the API product that you associate with the app."},"keyExpiresIn":{"type":"string","description":"Duration, in milliseconds, of the consumer key that will be generated for the app. The default value, -1, indicates an infinite validity period. Once set, the expiration can't be updated. json key: keyExpiresIn"},"companyName":{"type":"string","description":"Name of the company that owns the app."},"appId":{"type":"string","description":"ID of the app."},"createdAt":{"type":"string","description":"Output only. Unix time when the app was created."},"status":{"type":"string","description":"Status of the credential."}}},"GoogleCloudApigeeV1DeveloperMonetizationConfig":{"title":"GoogleCloudApigeeV1DeveloperMonetizationConfig","type":"object","properties":{"billingType":{"allOf":[{"$ref":"#/components/schemas/BillingType"},{"description":"Billing type."}]}},"description":"Monetization configuration for the developer."},"GoogleCloudApigeeV1KeyValueMap":{"title":"GoogleCloudApigeeV1KeyValueMap","type":"object","properties":{"name":{"type":"string","description":"Required. ID of the key value map."},"encrypted":{"type":"boolean","description":"Optional. Flag that specifies whether entry values will be encrypted. You must set this value to `true`. Apigee X and hybrid do not support unencrytped key value maps."}},"description":"Collection of key/value string pairs."},"GoogleCloudApigeeV1ServiceIssuersMapping":{"title":"GoogleCloudApigeeV1ServiceIssuersMapping","type":"object","properties":{"service":{"type":"string","description":"String indicating the Apigee service name."},"emailIds":{"type":"array","items":{"type":"string"},"description":"List of trusted issuer email ids."}}},"GoogleCloudApigeeV1ConfigVersion":{"title":"GoogleCloudApigeeV1ConfigVersion","type":"object","properties":{"majorVersion":{"type":"integer","description":"Major version of the API proxy configuration schema.","contentEncoding":"int32"},"minorVersion":{"type":"integer","description":"Minor version of the API proxy configuration schema.","contentEncoding":"int32"}},"description":"Version of the API proxy configuration schema. Currently, only 4.0 is supported."},"GoogleCloudApigeeV1OperationGroup":{"title":"GoogleCloudApigeeV1OperationGroup","type":"object","properties":{"operationConfigType":{"type":"string","description":"Flag that specifes whether the configuration is for Apigee API proxy or a remote service. Valid values include `proxy` or `remoteservice`. Defaults to `proxy`. Set to `proxy` when Apigee API proxies are associated with the API product. Set to `remoteservice` when non-Apigee proxies like Istio-Envoy are associated with the API product."},"operationConfigs":{"type":"array","items":{"$ref":"#/components/schemas/GoogleCloudApigeeV1OperationConfig"},"description":"Required. List of operation configurations for either Apigee API proxies or other remote services that are associated with this API product."}},"description":"List of operation configuration details associated with Apigee API proxies or remote services. Remote services are non-Apigee proxies, such as Istio-Envoy."},"GoogleCloudApigeeV1ListEndpointAttachmentsResponse":{"title":"GoogleCloudApigeeV1ListEndpointAttachmentsResponse","type":"object","properties":{"nextPageToken":{"type":"string","description":"Page token that you can include in an `ListEndpointAttachments` request to retrieve the next page. If omitted, no subsequent pages exist."},"endpointAttachments":{"type":"array","items":{"$ref":"#/components/schemas/GoogleCloudApigeeV1EndpointAttachment"},"description":"Endpoint attachments in the specified organization."}},"description":"Response for ListEndpointAttachments method."},"GoogleCloudApigeeV1Certificate":{"title":"GoogleCloudApigeeV1Certificate","type":"object","properties":{"certInfo":{"type":"array","items":{"$ref":"#/components/schemas/GoogleCloudApigeeV1CertInfo"},"description":"Chain of certificates under this name."}}},"GoogleCloudApigeeV1DeveloperBalance":{"title":"GoogleCloudApigeeV1DeveloperBalance","type":"object","properties":{"wallets":{"type":"array","items":{"$ref":"#/components/schemas/GoogleCloudApigeeV1DeveloperBalanceWallet"},"description":"Output only. List of all wallets. Each individual wallet stores the account balance for a particular currency."}},"description":"Account balance for the developer."},"GoogleCloudApigeeV1ListAsyncQueriesResponse":{"title":"GoogleCloudApigeeV1ListAsyncQueriesResponse","type":"object","properties":{"queries":{"type":"array","items":{"$ref":"#/components/schemas/GoogleCloudApigeeV1AsyncQuery"},"description":"The asynchronous queries belong to requested resource name."}},"description":"The response for ListAsyncQueries."},"GoogleCloudApigeeV1Stats":{"title":"GoogleCloudApigeeV1Stats","type":"object","properties":{"metaData":{"allOf":[{"$ref":"#/components/schemas/GoogleCloudApigeeV1Metadata"},{"description":"Encapsulates additional information about query execution."}]},"hosts":{"type":"array","items":{"$ref":"#/components/schemas/GoogleCloudApigeeV1StatsHostStats"},"description":"List of query results grouped by host."},"environments":{"type":"array","items":{"$ref":"#/components/schemas/GoogleCloudApigeeV1StatsEnvironmentStats"},"description":"List of query results on the environment level."}},"description":"Encapsulates a `stats` response."},"GoogleCloudApigeeV1ListDebugSessionsResponse":{"title":"GoogleCloudApigeeV1ListDebugSessionsResponse","type":"object","properties":{"nextPageToken":{"type":"string","description":"Page token that you can include in a ListDebugSessionsRequest to retrieve the next page. If omitted, no subsequent pages exist."},"sessions":{"type":"array","items":{"$ref":"#/components/schemas/GoogleCloudApigeeV1Session"},"description":"Session info that includes debug session ID and the first transaction creation timestamp."}}},"GoogleIamV1Binding":{"title":"GoogleIamV1Binding","type":"object","properties":{"role":{"type":"string","description":"Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`."},"condition":{"description":"The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies)."},"members":{"type":"array","items":{"type":"string"},"description":"Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`."}},"description":"Associates `members`, or principals, with a `role`."},"GoogleCloudApigeeV1ReferenceConfig":{"title":"GoogleCloudApigeeV1ReferenceConfig","type":"object","properties":{"name":{"type":"string","description":"Name of the reference in the following format: `organizations/{org}/environments/{env}/references/{reference}`"},"resourceName":{"type":"string","description":"Name of the referenced resource in the following format: `organizations/{org}/environments/{env}/keystores/{keystore}` Only references to keystore resources are supported."}}},"GoogleCloudApigeeV1ListTraceConfigOverridesResponse":{"title":"GoogleCloudApigeeV1ListTraceConfigOverridesResponse","type":"object","properties":{"nextPageToken":{"type":"string","description":"Token value that can be passed as `page_token` to retrieve the next page of content."},"traceConfigOverrides":{"type":"array","items":{"$ref":"#/components/schemas/GoogleCloudApigeeV1TraceConfigOverride"},"description":"List all trace configuration overrides in an environment."}},"description":"Response for ListTraceConfigOverrides."},"GoogleCloudApigeeV1DeveloperSubscription":{"title":"GoogleCloudApigeeV1DeveloperSubscription","type":"object","properties":{"endTime":{"type":"string","description":"Time when the API product subscription ends in milliseconds since epoch."},"name":{"type":"string","description":"Output only. Name of the API product subscription."},"startTime":{"type":"string","description":"Time when the API product subscription starts in milliseconds since epoch."},"apiproduct":{"type":"string","description":"Name of the API product for which the developer is purchasing a subscription."},"createdAt":{"type":"string","description":"Output only. Time when the API product subscription was created in milliseconds since epoch."},"lastModifiedAt":{"type":"string","description":"Output only. Time when the API product subscription was last modified in milliseconds since epoch."}},"description":"Structure of a DeveloperSubscription."},"GoogleCloudApigeeV1TargetServerConfig":{"title":"GoogleCloudApigeeV1TargetServerConfig","type":"object","properties":{"protocol":{"allOf":[{"$ref":"#/components/schemas/Protocol"},{"description":"The protocol used by this target server."}]},"tlsInfo":{"$ref":"#/components/schemas/GoogleCloudApigeeV1TlsInfoConfig"},"name":{"type":"string","description":"Target server revision name in the following format: `organizations/{org}/environments/{env}/targetservers/{targetserver}/revisions/{rev}`"},"host":{"type":"string","description":"Host name of the target server."},"port":{"type":"integer","description":"Port number for the target server.","contentEncoding":"int32"},"enabled":{"type":"boolean","description":"Whether the target server is enabled. An empty/omitted value for this field should be interpreted as true."}}},"GoogleCloudApigeeV1CreditDeveloperBalanceRequest":{"title":"GoogleCloudApigeeV1CreditDeveloperBalanceRequest","type":"object","properties":{"transactionId":{"type":"string","description":"Each transaction_id uniquely identifies a credit balance request. If multiple requests are received with the same transaction_id, only one of them will be considered."},"transactionAmount":{"allOf":[{"$ref":"#/components/schemas/GoogleTypeMoney"},{"description":"Represents an amount of money with its currency type."}]}},"description":"Request for CreditDeveloperBalance."},"GoogleCloudApigeeV1Alias":{"title":"GoogleCloudApigeeV1Alias","type":"object","properties":{"alias":{"type":"string","description":"Resource ID for this alias. Values must match the regular expression `[^/]{1,255}`."},"certsInfo":{"$ref":"#/components/schemas/GoogleCloudApigeeV1Certificate"},"type":{"allOf":[{"$ref":"#/components/schemas/Type3"},{"description":"Type of alias."}]}},"description":"Reference to a certificate or key/certificate pair."},"GoogleCloudApigeeV1Access":{"title":"GoogleCloudApigeeV1Access","type":"object","properties":{"Get":{},"Set":{},"Remove":{}}},"GoogleCloudApigeeV1Point":{"title":"GoogleCloudApigeeV1Point","type":"object","properties":{"id":{"type":"string","description":"Name of a step in the transaction."},"results":{"type":"array","items":{"$ref":"#/components/schemas/GoogleCloudApigeeV1Result"},"description":"List of results extracted from a given debug point."}},"description":"Point is a group of information collected by runtime plane at critical points of the message flow of the processed API request. This is a list of supported point IDs, categorized to three major buckets. For each category, debug points that we are currently supporting are listed below: - Flow status debug points: StateChange FlowInfo Condition Execution DebugMask Error - Flow control debug points: FlowCallout Paused Resumed FlowReturn BreakFlow Error - Runtime debug points: ScriptExecutor FlowCalloutStepDefinition CustomTarget StepDefinition Oauth2ServicePoint RaiseFault NodeJS The detail information of the given debug point is stored in a list of results."},"GoogleCloudApigeeV1DataCollector":{"title":"GoogleCloudApigeeV1DataCollector","type":"object","properties":{"name":{"type":"string","description":"ID of the data collector. Must begin with `dc_`."},"lastModifiedAt":{"type":"string","description":"Output only. The time at which the Data Collector was last updated in milliseconds since the epoch."},"createdAt":{"type":"string","description":"Output only. The time at which the data collector was created in milliseconds since the epoch."},"type":{"allOf":[{"$ref":"#/components/schemas/Type"},{"description":"Immutable. The type of data this data collector will collect."}]},"description":{"type":"string","description":"A description of the data collector."}},"description":"Data collector configuration."},"GoogleRpcPreconditionFailureViolation":{"title":"GoogleRpcPreconditionFailureViolation","type":"object","properties":{"type":{"type":"string","description":"The type of PreconditionFailure. We recommend using a service-specific enum type to define the supported precondition violation subjects. For example, \"TOS\" for \"Terms of Service violation\"."},"subject":{"type":"string","description":"The subject, relative to the type, that failed. For example, \"google.com/cloud\" relative to the \"TOS\" type would indicate which terms of service is being referenced."},"description":{"type":"string","description":"A description of how the precondition failed. Developers can use this description to understand how to fix the failure. For example: \"Terms of service not accepted\"."}},"description":"A message type used to describe a single precondition failure."},"GoogleCloudApigeeV1ListDeveloperAppsResponse":{"title":"GoogleCloudApigeeV1ListDeveloperAppsResponse","type":"object","properties":{"app":{"type":"array","items":{"$ref":"#/components/schemas/GoogleCloudApigeeV1DeveloperApp"},"description":"List of developer apps and their credentials."}}},"GoogleCloudApigeeV1ListNatAddressesResponse":{"title":"GoogleCloudApigeeV1ListNatAddressesResponse","type":"object","properties":{"natAddresses":{"type":"array","items":{"$ref":"#/components/schemas/GoogleCloudApigeeV1NatAddress"},"description":"List of NAT Addresses for the instance."},"nextPageToken":{"type":"string","description":"Page token that you can include in a ListNatAddresses request to retrieve the next page of content. If omitted, no subsequent pages exist."}},"description":"Response for ListNatAddresses."},"GoogleCloudApigeeV1ListHybridIssuersResponse":{"title":"GoogleCloudApigeeV1ListHybridIssuersResponse","type":"object","properties":{"issuers":{"type":"array","items":{"$ref":"#/components/schemas/GoogleCloudApigeeV1ServiceIssuersMapping"},"description":"Lists of hybrid services and its trusted issuer email ids."}}},"GoogleCloudApigeeV1TraceSamplingConfig":{"title":"GoogleCloudApigeeV1TraceSamplingConfig","type":"object","properties":{"sampler":{"allOf":[{"$ref":"#/components/schemas/Sampler"},{"description":"Sampler of distributed tracing. OFF is the default value."}]},"samplingRate":{"type":"number","description":"Field sampling rate. This value is only applicable when using the PROBABILITY sampler. The supported values are > 0 and <= 0.5."}},"description":"TraceSamplingConfig represents the detail settings of distributed tracing. Only the fields that are defined in the distributed trace configuration can be overridden using the distribute trace configuration override APIs."},"GoogleCloudApigeeV1EnvironmentGroup":{"title":"GoogleCloudApigeeV1EnvironmentGroup","type":"object","properties":{"state":{"allOf":[{"$ref":"#/components/schemas/State5"},{"description":"Output only. State of the environment group. Values other than ACTIVE means the resource is not ready to use."}]},"lastModifiedAt":{"type":"string","description":"Output only. The time at which the environment group was last updated as milliseconds since epoch."},"hostnames":{"type":"array","items":{"type":"string"},"description":"Required. Host names for this environment group."},"name":{"type":"string","description":"ID of the environment group."},"createdAt":{"type":"string","description":"Output only. The time at which the environment group was created as milliseconds since epoch."}},"description":"EnvironmentGroup configuration. An environment group is used to group one or more Apigee environments under a single host name."},"GoogleCloudApigeeV1ScoreComponentRecommendation":{"title":"GoogleCloudApigeeV1ScoreComponentRecommendation","type":"object","properties":{"actions":{"type":"array","items":{},"description":"Actions for the recommendation to improve the security score."},"impact":{"type":"integer","description":"Potential impact of this recommendation on the overall score. This denotes how important this recommendation is to improve the score.","contentEncoding":"int32"},"description":{"type":"string","description":"Description of the recommendation."},"title":{"type":"string","description":"Title represents recommendation title."}},"description":"Recommendation based on security concerns and score."},"GoogleCloudApigeeV1DateRange":{"title":"GoogleCloudApigeeV1DateRange","type":"object","properties":{"end":{"type":"string","description":"Required. End date (exclusive) of the data to export in the format `yyyy-mm-dd`. The date range ends at 00:00:00 UTC on the end date- which will not be in the output."},"start":{"type":"string","description":"Required. Start date of the data to export in the format `yyyy-mm-dd`. The date range begins at 00:00:00 UTC on the start date."}},"description":"Date range of the data to export."},"GoogleCloudApigeeV1OptimizedStatsResponse":{"title":"GoogleCloudApigeeV1OptimizedStatsResponse","type":"object","properties":{"TimeUnit":{"type":"array","items":{"type":"string"},"description":"List of time unit values. Time unit refers to an epoch timestamp value."},"metaData":{"allOf":[{"$ref":"#/components/schemas/GoogleCloudApigeeV1Metadata"},{"description":"Encapsulates additional information about query execution."}]},"resultTruncated":{"type":"boolean","description":"Boolean flag that indicates whether the results were truncated based on the limit parameter."},"stats":{"allOf":[{"$ref":"#/components/schemas/GoogleCloudApigeeV1OptimizedStatsNode"},{"description":"Encapsulates a data node as represented below: ``` { \"identifier\": { \"names\": [ \"apiproxy\" ], \"values\": [ \"sirjee\" ] }, \"metric\": [ { \"env\": \"prod\", \"name\": \"sum(message_count)\", \"values\": [ 36.0 ] } ] }``` or ``` { \"env\": \"prod\", \"name\": \"sum(message_count)\", \"values\": [ 36.0 ] }``` Depending on whether a dimension is present in the query or not the data node type can be a simple metric value or dimension identifier with list of metrics."}]}},"description":"Encapsulates a response format for JavaScript Optimized Scenario."},"GoogleCloudApigeeV1ApiProductRef":{"title":"GoogleCloudApigeeV1ApiProductRef","type":"object","properties":{"status":{"type":"string","description":"Status of the API product. Valid values are `approved` or `revoked`."},"apiproduct":{"type":"string","description":"Name of the API product."}}},"GoogleCloudApigeeV1EnvironmentConfig":{"title":"GoogleCloudApigeeV1EnvironmentConfig","type":"object","properties":{"deployments":{"type":"array","items":{"$ref":"#/components/schemas/GoogleCloudApigeeV1DeploymentConfig"},"description":"List of deployments in the environment."},"forwardProxyUri":{"type":"string","description":"The forward proxy's url to be used by the runtime. When set, runtime will send requests to the target via the given forward proxy. This is only used by programmable gateways."},"targets":{"type":"array","items":{"$ref":"#/components/schemas/GoogleCloudApigeeV1TargetServerConfig"},"description":"List of target servers in the environment. Disabled target servers are not displayed."},"arcConfigLocation":{"type":"string","description":"The location for the config blob of API Runtime Control, aka Envoy Adapter, for op-based authentication as a URI, e.g. a Cloud Storage URI. This is only used by Envoy-based gateways."},"resourceReferences":{"type":"array","items":{"$ref":"#/components/schemas/GoogleCloudApigeeV1ReferenceConfig"},"description":"List of resource references in the environment."},"uid":{"type":"string","description":"Unique ID for the environment configuration. The ID will only change if the environment is deleted and recreated."},"createTime":{"type":"string","description":"Time that the environment configuration was created."},"resources":{"type":"array","items":{"$ref":"#/components/schemas/GoogleCloudApigeeV1ResourceConfig"},"description":"List of resource versions in the environment."},"debugMask":{"$ref":"#/components/schemas/GoogleCloudApigeeV1DebugMask"},"keystores":{"type":"array","items":{"$ref":"#/components/schemas/GoogleCloudApigeeV1KeystoreConfig"},"description":"List of keystores in the environment."},"pubsubTopic":{"type":"string","description":"Name of the PubSub topic for the environment."},"sequenceNumber":{"type":"string","description":"DEPRECATED: Use revision_id."},"gatewayConfigLocation":{"type":"string","description":"The location for the gateway config blob as a URI, e.g. a Cloud Storage URI. This is only used by Envoy-based gateways."},"dataCollectors":{"type":"array","items":{"$ref":"#/components/schemas/GoogleCloudApigeeV1DataCollectorConfig"},"description":"List of data collectors used by the deployments in the environment."},"provider":{"type":"string","description":"Used by the Control plane to add context information to help detect the source of the document during diagnostics and debugging."},"flowhooks":{"type":"array","items":{"$ref":"#/components/schemas/GoogleCloudApigeeV1FlowHookConfig"},"description":"List of flow hooks in the environment."},"name":{"type":"string","description":"Name of the environment configuration in the following format: `organizations/{org}/environments/{env}/configs/{config}`"},"traceConfig":{"allOf":[{"$ref":"#/components/schemas/GoogleCloudApigeeV1RuntimeTraceConfig"},{"description":"NEXT ID: 8 RuntimeTraceConfig defines the configurations for distributed trace in an environment."}]},"revisionId":{"type":"string","description":"Revision ID of the environment configuration. The higher the value, the more recently the configuration was deployed."},"featureFlags":{"type":"object","additionalProperties":{"type":"string"},"description":"Feature flags inherited from the organization and environment."}}},"GoogleCloudApigeeV1Instance":{"title":"GoogleCloudApigeeV1Instance","type":"object","properties":{"serviceAttachment":{"type":"string","description":"Output only. Resource name of the service attachment created for the instance in the format: `projects/*/regions/*/serviceAttachments/*` Apigee customers can privately forward traffic to this service attachment using the PSC endpoints."},"location":{"type":"string","description":"Required. Compute Engine location where the instance resides."},"ipRange":{"type":"string","description":"Optional. Comma-separated list of CIDR blocks of length 22 and/or 28 used to create the Apigee instance. Providing CIDR ranges is optional. You can provide just /22 or /28 or both (or neither). Ranges you provide should be freely available as part of a larger named range you have allocated to the Service Networking peering. If this parameter is not provided, Apigee automatically requests an available /22 and /28 CIDR block from Service Networking. Use the /22 CIDR block for configuring your firewall needs to allow traffic from Apigee. Input formats: `a.b.c.d/22` or `e.f.g.h/28` or `a.b.c.d/22,e.f.g.h/28`"},"state":{"allOf":[{"$ref":"#/components/schemas/State6"},{"description":"Output only. State of the instance. Values other than `ACTIVE` means the resource is not ready to use."}]},"displayName":{"type":"string","description":"Optional. Display name for the instance."},"consumerAcceptList":{"type":"array","items":{"type":"string"},"description":"Optional. Customer accept list represents the list of projects (id/number) on customer side that can privately connect to the service attachment. It is an optional field which the customers can provide during the instance creation. By default, the customer project associated with the Apigee organization will be included to the list."},"port":{"type":"string","description":"Output only. Port number of the exposed Apigee endpoint."},"name":{"type":"string","description":"Required. Resource ID of the instance. Values must match the regular expression `^a-z{0,30}[a-z\\d]$`."},"runtimeVersion":{"type":"string","description":"Output only. Version of the runtime system running in the instance. The runtime system is the set of components that serve the API Proxy traffic in your Environments."},"host":{"type":"string","description":"Output only. Internal hostname or IP address of the Apigee endpoint used by clients to connect to the service."},"diskEncryptionKeyName":{"type":"string","description":"Customer Managed Encryption Key (CMEK) used for disk and volume encryption. Required for Apigee paid subscriptions only. Use the following format: `projects/([^/]+)/locations/([^/]+)/keyRings/([^/]+)/cryptoKeys/([^/]+)`"},"description":{"type":"string","description":"Optional. Description of the instance."},"peeringCidrRange":{"allOf":[{"$ref":"#/components/schemas/PeeringCidrRange"},{"description":"Optional. Size of the CIDR block range that will be reserved by the instance. PAID organizations support `SLASH_16` to `SLASH_20` and defaults to `SLASH_16`. Evaluation organizations support only `SLASH_23`."}]},"lastModifiedAt":{"type":"string","description":"Output only. Time the instance was last modified in milliseconds since epoch."},"createdAt":{"type":"string","description":"Output only. Time the instance was created in milliseconds since epoch."}},"description":"Apigee runtime instance."},"GoogleCloudApigeeV1InstanceDeploymentStatus":{"title":"GoogleCloudApigeeV1InstanceDeploymentStatus","type":"object","properties":{"deployedRoutes":{"type":"array","items":{"$ref":"#/components/schemas/GoogleCloudApigeeV1InstanceDeploymentStatusDeployedRoute"},"description":"Current routes deployed in the ingress routing table. A route which is missing will appear in `missing_routes`."},"deployedRevisions":{"type":"array","items":{"$ref":"#/components/schemas/GoogleCloudApigeeV1InstanceDeploymentStatusDeployedRevision"},"description":"Revisions currently deployed in MPs."},"instance":{"type":"string","description":"ID of the instance reporting the status."}},"description":"The status of a deployment as reported by a single instance."},"GoogleCloudApigeeV1Operation":{"title":"GoogleCloudApigeeV1Operation","type":"object","properties":{"resource":{"type":"string","description":"Required. REST resource path associated with the API proxy or remote service."},"methods":{"type":"array","items":{"type":"string"},"description":"methods refers to the REST verbs as in https://www.w3.org/Protocols/rfc2616/rfc2616-sec9.html. When none specified, all verb types are allowed."}},"description":"Represents the pairing of REST resource path and the actions (verbs) allowed on the resource path."},"EdgeConfigstoreBundleBadBundle":{"title":"EdgeConfigstoreBundleBadBundle","type":"object","properties":{"violations":{"type":"array","items":{"$ref":"#/components/schemas/EdgeConfigstoreBundleBadBundleViolation"},"description":"Describes all precondition violations."}},"description":"Describes why a bundle is invalid. Intended for use in error details."},"GoogleCloudApigeeV1DeploymentChangeReport":{"title":"GoogleCloudApigeeV1DeploymentChangeReport","type":"object","properties":{"routingConflicts":{"type":"array","items":{"$ref":"#/components/schemas/GoogleCloudApigeeV1DeploymentChangeReportRoutingConflict"},"description":"All base path conflicts detected for a deployment request."},"validationErrors":{"allOf":[{"$ref":"#/components/schemas/GoogleRpcPreconditionFailure"},{"description":"Describes what preconditions have failed. For example, if an RPC failed because it required the Terms of Service to be acknowledged, it could list the terms of service violation in the PreconditionFailure message."}]},"routingChanges":{"type":"array","items":{"$ref":"#/components/schemas/GoogleCloudApigeeV1DeploymentChangeReportRoutingChange"},"description":"All routing changes that may result from a deployment request."}},"description":"Response for GenerateDeployChangeReport and GenerateUndeployChangeReport. This report contains any validation failures that would cause the deployment to be rejected, as well changes and conflicts in routing that may occur due to the new deployment. The existence of a routing warning does not necessarily imply that the deployment request is bad, if the desired state of the deployment request is to effect a routing change. The primary purposes of the routing messages are: 1) To inform users of routing changes that may have an effect on traffic currently being routed to other existing deployments. 2) To warn users if some base path in the proxy will not receive traffic due to an existing deployment having already claimed that base path. The presence of routing conflicts/changes will not cause non-dry-run DeployApiProxy/UndeployApiProxy requests to be rejected."},"GoogleCloudApigeeV1EnvironmentGroupConfig":{"title":"GoogleCloudApigeeV1EnvironmentGroupConfig","type":"object","properties":{"revisionId":{"type":"string","description":"Revision id that defines the ordering of the EnvironmentGroupConfig resource. The higher the revision, the more recently the configuration was deployed."},"uid":{"type":"string","description":"A unique id for the environment group config that will only change if the environment group is deleted and recreated."},"routingRules":{"type":"array","items":{"$ref":"#/components/schemas/GoogleCloudApigeeV1RoutingRule"},"description":"Ordered list of routing rules defining how traffic to this environment group's hostnames should be routed to different environments."},"name":{"type":"string","description":"Name of the environment group in the following format: `organizations/{org}/envgroups/{envgroup}`."},"hostnames":{"type":"array","items":{"type":"string"},"description":"Host names for the environment group."}},"description":"EnvironmentGroupConfig is a revisioned snapshot of an EnvironmentGroup and its associated routing rules."},"GoogleCloudApigeeV1KeyValueEntry":{"title":"GoogleCloudApigeeV1KeyValueEntry","type":"object","properties":{"name":{"type":"string","description":"Resource URI that can be used to identify the scope of the key value map entries."},"value":{"type":"string","description":"Required. Data or payload that is being retrieved and associated with the unique key."}},"description":"Key value map pair where the value represents the data associated with the corresponding key. **Note**: Supported for Apigee hybrid 1.8.x and higher."},"GoogleCloudApigeeV1SecurityReportResultMetadata":{"title":"GoogleCloudApigeeV1SecurityReportResultMetadata","type":"object","properties":{"self":{"type":"string","description":"Self link of the query results. Example: `/organizations/myorg/environments/myenv/securityReports/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd/result` or following format if query is running at host level: `/organizations/myorg/hostSecurityReports/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd/result`"},"expires":{"type":"string","description":"Output only. Expire_time is set to 7 days after report creation. Query result will be unaccessable after this time. Example: \"2021-05-04T13:38:52-07:00\""}},"description":"Contains informations about the security report results."},"GoogleCloudApigeeV1ListInstancesResponse":{"title":"GoogleCloudApigeeV1ListInstancesResponse","type":"object","properties":{"nextPageToken":{"type":"string","description":"Page token that you can include in a ListInstance request to retrieve the next page of content. If omitted, no subsequent pages exist."},"instances":{"type":"array","items":{"$ref":"#/components/schemas/GoogleCloudApigeeV1Instance"},"description":"Instances in the specified organization."}},"description":"Response for ListInstances."},"GoogleCloudApigeeV1AccessRemove":{"title":"GoogleCloudApigeeV1AccessRemove","type":"object","properties":{"name":{"type":"string"},"success":{"type":"boolean"}},"description":"Remove action. For example, \"Remove\" : { \"name\" : \"target.name\", \"success\" : true }"},"GoogleCloudApigeeV1ListApiCategoriesResponse":{"title":"GoogleCloudApigeeV1ListApiCategoriesResponse","type":"object","properties":{"message":{"type":"string","description":"Description of the operation."},"data":{"type":"array","items":{"$ref":"#/components/schemas/GoogleCloudApigeeV1ApiCategoryData"},"description":"Details of categories."},"requestId":{"type":"string","description":"ID that can be used to find request details in the log files."},"status":{"type":"string","description":"Status of the operation."},"errorCode":{"type":"string","description":"ID that can be used to find errors in the log files."}},"description":"the response for ListApiCategoriesRequest."},"GoogleIamV1TestIamPermissionsRequest":{"title":"GoogleIamV1TestIamPermissionsRequest","type":"object","properties":{"permissions":{"type":"array","items":{"type":"string"},"description":"The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions)."}},"description":"Request message for `TestIamPermissions` method."},"GoogleCloudApigeeV1Reference":{"title":"GoogleCloudApigeeV1Reference","type":"object","properties":{"resourceType":{"type":"string","description":"The type of resource referred to by this reference. Valid values are 'KeyStore' or 'TrustStore'."},"name":{"type":"string","description":"Required. The resource id of this reference. Values must match the regular expression [\\w\\s\\-.]+."},"refers":{"type":"string","description":"Required. The id of the resource to which this reference refers. Must be the id of a resource that exists in the parent environment and is of the given resource_type."},"description":{"type":"string","description":"Optional. A human-readable description of this reference."}},"description":"A Reference configuration. References must refer to a keystore that also exists in the parent environment."},"GoogleCloudApigeeV1GetAsyncQueryResultUrlResponse":{"title":"GoogleCloudApigeeV1GetAsyncQueryResultUrlResponse","type":"object","properties":{"urls":{"type":"array","items":{"$ref":"#/components/schemas/GoogleCloudApigeeV1GetAsyncQueryResultUrlResponseURLInfo"},"description":"The list of Signed URLs generated by the CreateAsyncQuery request"}},"description":"The response for GetAsyncQueryResultUrl"},"GoogleCloudApigeeV1Attributes":{"title":"GoogleCloudApigeeV1Attributes","type":"object","properties":{"attribute":{"type":"array","items":{"$ref":"#/components/schemas/GoogleCloudApigeeV1Attribute"},"description":"List of attributes."}}},"GoogleCloudApigeeV1IngressConfig":{"title":"GoogleCloudApigeeV1IngressConfig","type":"object","properties":{"revisionCreateTime":{"type":"string","description":"Time at which the IngressConfig revision was created."},"name":{"type":"string","description":"Name of the resource in the following format: `organizations/{org}/deployedIngressConfig`."},"revisionId":{"type":"string","description":"Revision id that defines the ordering on IngressConfig resources. The higher the revision, the more recently the configuration was deployed."},"environmentGroups":{"type":"array","items":{"$ref":"#/components/schemas/GoogleCloudApigeeV1EnvironmentGroupConfig"},"description":"List of environment groups in the organization."},"uid":{"type":"string","description":"A unique id for the ingress config that will only change if the organization is deleted and recreated."}}},"GoogleCloudApigeeV1Environment":{"title":"GoogleCloudApigeeV1Environment","type":"object","properties":{"forwardProxyUri":{"type":"string","description":"Optional. Url of the forward proxy to be applied to the runtime instances in this environment. Must be in the format of {scheme}://{hostname}:{port}. Note that scheme must be one of \"http\" or \"https\", and port must be supplied."},"createdAt":{"type":"string","description":"Output only. Creation time of this environment as milliseconds since epoch."},"apiProxyType":{"allOf":[{"$ref":"#/components/schemas/ApiProxyType"},{"description":"Optional. API Proxy type supported by the environment. The type can be set when creating the Environment and cannot be changed."}]},"properties":{"allOf":[{"$ref":"#/components/schemas/GoogleCloudApigeeV1Properties"},{"description":"Message for compatibility with legacy Edge specification for Java Properties object in JSON."}]},"description":{"type":"string","description":"Optional. Description of the environment."},"nodeConfig":{"allOf":[{"$ref":"#/components/schemas/GoogleCloudApigeeV1NodeConfig"},{"description":"NodeConfig for setting the min/max number of nodes associated with the environment."}]},"lastModifiedAt":{"type":"string","description":"Output only. Last modification time of this environment as milliseconds since epoch."},"displayName":{"type":"string","description":"Optional. Display name for this environment."},"name":{"type":"string","description":"Required. Name of the environment. Values must match the regular expression `^[.\\\\p{Alnum}-_]{1,255}$`"},"state":{"allOf":[{"$ref":"#/components/schemas/State7"},{"description":"Output only. State of the environment. Values other than ACTIVE means the resource is not ready to use."}]},"deploymentType":{"allOf":[{"$ref":"#/components/schemas/DeploymentType"},{"description":"Optional. Deployment type supported by the environment. The deployment type can be set when creating the environment and cannot be changed. When you enable archive deployment, you will be **prevented from performing** a [subset of actions](/apigee/docs/api-platform/local-development/overview#prevented-actions) within the environment, including: * Managing the deployment of API proxy or shared flow revisions * Creating, updating, or deleting resource files * Creating, updating, or deleting target servers"}]}}},"GoogleCloudApigeeV1DebugMask":{"title":"GoogleCloudApigeeV1DebugMask","type":"object","properties":{"requestXPaths":{"type":"array","items":{"type":"string"},"description":"List of XPaths that specify the XML elements to be filtered from XML request message payloads."},"namespaces":{"type":"object","additionalProperties":{"type":"string"},"description":"Map of namespaces to URIs."},"responseJSONPaths":{"type":"array","items":{"type":"string"},"description":"List of JSON paths that specify the JSON elements to be filtered from JSON response message payloads."},"responseXPaths":{"type":"array","items":{"type":"string"},"description":"List of XPaths that specify the XML elements to be filtered from XML response message payloads."},"requestJSONPaths":{"type":"array","items":{"type":"string"},"description":"List of JSON paths that specify the JSON elements to be filtered from JSON request message payloads."},"faultJSONPaths":{"type":"array","items":{"type":"string"},"description":"List of JSON paths that specify the JSON elements to be filtered from JSON payloads in error flows."},"name":{"type":"string","description":"Name of the debug mask."},"faultXPaths":{"type":"array","items":{"type":"string"},"description":"List of XPaths that specify the XML elements to be filtered from XML payloads in error flows."},"variables":{"type":"array","items":{"type":"string"},"description":"List of variables that should be masked from the debug output."}}},"GoogleCloudApigeeV1Session":{"title":"GoogleCloudApigeeV1Session","type":"object","properties":{"timestampMs":{"type":"string","description":"The first transaction creation timestamp in millisecond, recorded by UAP."},"id":{"type":"string","description":"The debug session ID."}},"description":"Session carries the debug session id and its creation time."},"GoogleCloudApigeeV1ArchiveDeployment":{"title":"GoogleCloudApigeeV1ArchiveDeployment","type":"object","properties":{"name":{"type":"string","description":"Name of the Archive Deployment in the following format: `organizations/{org}/environments/{env}/archiveDeployments/{id}`."},"labels":{"type":"object","additionalProperties":{"type":"string"},"description":"User-supplied key-value pairs used to organize ArchiveDeployments. Label keys must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: \\p{Ll}\\p{Lo}{0,62} Label values must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: [\\p{Ll}\\p{Lo}\\p{N}_-]{0,63} No more than 64 labels can be associated with a given store."},"updatedAt":{"type":"string","description":"Output only. The time at which the Archive Deployment was updated in milliseconds since the epoch."},"createdAt":{"type":"string","description":"Output only. The time at which the Archive Deployment was created in milliseconds since the epoch."},"operation":{"type":"string","description":"Output only. A reference to the LRO that created this Archive Deployment in the following format: `organizations/{org}/operations/{id}`"},"gcsUri":{"type":"string","description":"Input only. The Google Cloud Storage signed URL returned from GenerateUploadUrl and used to upload the Archive zip file."}},"description":"Archive Deployment information."},"GoogleCloudApigeeV1QueryMetadata":{"title":"GoogleCloudApigeeV1QueryMetadata","type":"object","properties":{"timeUnit":{"type":"string","description":"Query GroupBy time unit."},"dimensions":{"type":"array","items":{"type":"string"},"description":"Dimensions of the AsyncQuery."},"startTimestamp":{"type":"string","description":"Start timestamp of the query range."},"endTimestamp":{"type":"string","description":"End timestamp of the query range."},"outputFormat":{"type":"string","description":"Output format."},"metrics":{"type":"array","items":{"type":"string"},"description":"Metrics of the AsyncQuery. Example: [\"name:message_count,func:sum,alias:sum_message_count\"]"}}},"GoogleCloudApigeeV1Keystore":{"title":"GoogleCloudApigeeV1Keystore","type":"object","properties":{"name":{"type":"string","description":"Required. Resource ID for this keystore. Values must match the regular expression `[\\w[:space:].-]{1,255}`."},"aliases":{"type":"array","items":{"type":"string"},"description":"Output only. Aliases in this keystore."}},"description":"Datastore for Certificates and Aliases."},"GoogleCloudApigeeV1Developer":{"title":"GoogleCloudApigeeV1Developer","type":"object","properties":{"status":{"type":"string","description":"Output only. Status of the developer. Valid values are `active` and `inactive`."},"organizationName":{"type":"string","description":"Output only. Name of the Apigee organization in which the developer resides."},"apps":{"type":"array","items":{"type":"string"},"description":"List of apps associated with the developer."},"accessType":{"type":"string","description":"Access type."},"email":{"type":"string","description":"Required. Email address of the developer. This value is used to uniquely identify the developer in Apigee hybrid. Note that the email address has to be in lowercase only."},"lastName":{"type":"string","description":"Required. Last name of the developer."},"appFamily":{"type":"string","description":"Developer app family."},"attributes":{"type":"array","items":{"$ref":"#/components/schemas/GoogleCloudApigeeV1Attribute"},"description":"Optional. Developer attributes (name/value pairs). The custom attribute limit is 18."},"lastModifiedAt":{"type":"string","description":"Output only. Time at which the developer was last modified in milliseconds since epoch."},"companies":{"type":"array","items":{"type":"string"},"description":"List of companies associated with the developer."},"userName":{"type":"string","description":"Required. User name of the developer. Not used by Apigee hybrid."},"firstName":{"type":"string","description":"Required. First name of the developer."},"createdAt":{"type":"string","description":"Output only. Time at which the developer was created in milliseconds since epoch."},"developerId":{"type":"string","description":"ID of the developer. **Note**: IDs are generated internally by Apigee and are not guaranteed to stay the same over time."}}},"GoogleCloudApigeeV1Organization":{"title":"GoogleCloudApigeeV1Organization","type":"object","properties":{"properties":{"allOf":[{"$ref":"#/components/schemas/GoogleCloudApigeeV1Properties"},{"description":"Message for compatibility with legacy Edge specification for Java Properties object in JSON."}]},"displayName":{"type":"string","description":"Display name for the Apigee organization. Unused, but reserved for future use."},"runtimeType":{"allOf":[{"$ref":"#/components/schemas/RuntimeType"},{"description":"Required. Runtime type of the Apigee organization based on the Apigee subscription purchased."}]},"apigeeProjectId":{"type":"string","description":"Output only. Apigee Project ID associated with the organization. Use this project to allowlist Apigee in the Service Attachment when using private service connect with Apigee."},"projectId":{"type":"string","description":"Output only. Project ID associated with the Apigee organization."},"portalDisabled":{"type":"boolean","description":"Configuration for the Portals settings."},"caCertificate":{"type":"string","description":"Output only. Base64-encoded public certificate for the root CA of the Apigee organization. Valid only when [RuntimeType](#RuntimeType) is `CLOUD`."},"runtimeDatabaseEncryptionKeyName":{"type":"string","description":"Cloud KMS key name used for encrypting the data that is stored and replicated across runtime instances. Update is not allowed after the organization is created. Required when [RuntimeType](#RuntimeType) is `CLOUD`. If not specified when [RuntimeType](#RuntimeType) is `TRIAL`, a Google-Managed encryption key will be used. For example: \"projects/foo/locations/us/keyRings/bar/cryptoKeys/baz\". **Note:** Not supported for Apigee hybrid."},"billingType":{"allOf":[{"$ref":"#/components/schemas/BillingType1"},{"description":"Billing type of the Apigee organization. See [Apigee pricing](https://cloud.google.com/apigee/pricing)."}]},"state":{"allOf":[{"$ref":"#/components/schemas/State8"},{"description":"Output only. State of the organization. Values other than ACTIVE means the resource is not ready to use."}]},"createdAt":{"type":"string","description":"Output only. Time that the Apigee organization was created in milliseconds since epoch."},"environments":{"type":"array","items":{"type":"string"},"description":"Output only. List of environments in the Apigee organization."},"expiresAt":{"type":"string","description":"Output only. Time that the Apigee organization is scheduled for deletion."},"description":{"type":"string","description":"Description of the Apigee organization."},"name":{"type":"string","description":"Output only. Name of the Apigee organization."},"attributes":{"type":"array","items":{"type":"string"},"description":"Not used by Apigee."},"authorizedNetwork":{"type":"string","description":"Compute Engine network used for Service Networking to be peered with Apigee runtime instances. See [Getting started with the Service Networking API](https://cloud.google.com/service-infrastructure/docs/service-networking/getting-started). Valid only when [RuntimeType](#RuntimeType) is set to `CLOUD`. The value must be set before the creation of a runtime instance and can be updated only when there are no runtime instances. For example: `default`. Apigee also supports shared VPC (that is, the host network project is not the same as the one that is peering with Apigee). See [Shared VPC overview](https://cloud.google.com/vpc/docs/shared-vpc). To use a shared VPC network, use the following format: `projects/{host-project-id}/{region}/networks/{network-name}`. For example: `projects/my-sharedvpc-host/global/networks/mynetwork` **Note:** Not supported for Apigee hybrid."},"subscriptionType":{"allOf":[{"$ref":"#/components/schemas/SubscriptionType"},{"description":"Output only. DEPRECATED: This will eventually be replaced by BillingType. Subscription type of the Apigee organization. Valid values include trial (free, limited, and for evaluation purposes only) or paid (full subscription has been purchased). See [Apigee pricing](https://cloud.google.com/apigee/pricing/)."}]},"lastModifiedAt":{"type":"string","description":"Output only. Time that the Apigee organization was last modified in milliseconds since epoch."},"addonsConfig":{"allOf":[{"$ref":"#/components/schemas/GoogleCloudApigeeV1AddonsConfig"},{"description":"Add-on configurations for the Apigee organization."}]},"type":{"allOf":[{"$ref":"#/components/schemas/Type4"},{"description":"Not used by Apigee."}]},"customerName":{"type":"string","description":"Not used by Apigee."},"analyticsRegion":{"type":"string","description":"Required. DEPRECATED: This field will be deprecated once Apigee supports DRZ. Primary GCP region for analytics data storage. For valid values, see [Create an Apigee organization](https://cloud.google.com/apigee/docs/api-platform/get-started/create-org)."}}},"GoogleCloudApigeeV1GetAsyncQueryResultUrlResponseURLInfo":{"title":"GoogleCloudApigeeV1GetAsyncQueryResultUrlResponseURLInfo","type":"object","properties":{"md5":{"type":"string","description":"The MD5 Hash of the JSON data"},"uri":{"type":"string","description":"The signed URL of the JSON data. Will be of the form `https://storage.googleapis.com/example-bucket/cat.jpeg?X-Goog-Algorithm= GOOG4-RSA-SHA256&X-Goog-Credential=example%40example-project.iam.gserviceaccount .com%2F20181026%2Fus-central1%2Fstorage%2Fgoog4_request&X-Goog-Date=20181026T18 1309Z&X-Goog-Expires=900&X-Goog-SignedHeaders=host&X-Goog-Signature=247a2aa45f16 9edf4d187d54e7cc46e4731b1e6273242c4f4c39a1d2507a0e58706e25e3a85a7dbb891d62afa849 6def8e260c1db863d9ace85ff0a184b894b117fe46d1225c82f2aa19efd52cf21d3e2022b3b868dc c1aca2741951ed5bf3bb25a34f5e9316a2841e8ff4c530b22ceaa1c5ce09c7cbb5732631510c2058 0e61723f5594de3aea497f195456a2ff2bdd0d13bad47289d8611b6f9cfeef0c46c91a455b94e90a 66924f722292d21e24d31dcfb38ce0c0f353ffa5a9756fc2a9f2b40bc2113206a81e324fc4fd6823 a29163fa845c8ae7eca1fcf6e5bb48b3200983c56c5ca81fffb151cca7402beddfc4a76b13344703 2ea7abedc098d2eb14a7`"},"sizeBytes":{"type":"string","description":"The size of the returned file in bytes"}},"description":"A Signed URL and the relevant metadata associated with it."},"GoogleCloudApigeeV1ListOfDevelopersResponse":{"title":"GoogleCloudApigeeV1ListOfDevelopersResponse","type":"object","properties":{"developer":{"type":"array","items":{"$ref":"#/components/schemas/GoogleCloudApigeeV1Developer"},"description":"List of developers."}}},"EdgeConfigstoreBundleBadBundleViolation":{"title":"EdgeConfigstoreBundleBadBundleViolation","type":"object","properties":{"description":{"type":"string","description":"A description of why the bundle is invalid and how to fix it."},"filename":{"type":"string","description":"The filename (including relative path from the bundle root) in which the error occurred."}},"description":"A message type used to describe a single bundle validation error."},"GoogleCloudApigeeV1ListSecurityReportsResponse":{"title":"GoogleCloudApigeeV1ListSecurityReportsResponse","type":"object","properties":{"nextPageToken":{"type":"string","description":"If the number of security reports exceeded the page size requested, the token can be used to fetch the next page in a subsequent call. If the response is the last page and there are no more reports to return this field is left empty."},"securityReports":{"type":"array","items":{"$ref":"#/components/schemas/GoogleCloudApigeeV1SecurityReport"},"description":"The security reports belong to requested resource name."}},"description":"The response for SecurityReports."},"GoogleCloudApigeeV1CanaryEvaluation":{"title":"GoogleCloudApigeeV1CanaryEvaluation","type":"object","properties":{"control":{"type":"string","description":"Required. The stable version that is serving requests."},"createTime":{"type":"string","description":"Output only. Create time of the canary evaluation."},"metricLabels":{"allOf":[{"$ref":"#/components/schemas/GoogleCloudApigeeV1CanaryEvaluationMetricLabels"},{"description":"Labels that can be used to filter Apigee metrics."}]},"verdict":{"allOf":[{"$ref":"#/components/schemas/Verdict"},{"description":"Output only. The resulting verdict of the canary evaluations: NONE, PASS, or FAIL."}]},"treatment":{"type":"string","description":"Required. The newer version that is serving requests."},"endTime":{"type":"string","description":"Required. End time for the evaluation's analysis."},"name":{"type":"string","description":"Output only. Name of the canary evalution."},"state":{"allOf":[{"$ref":"#/components/schemas/State9"},{"description":"Output only. The current state of the canary evaluation."}]},"startTime":{"type":"string","description":"Required. Start time for the canary evaluation's analysis."}},"description":"CanaryEvaluation represents the canary analysis between two versions of the runtime that is serving requests."},"GoogleCloudApigeeV1ApiSecurityConfig":{"title":"GoogleCloudApigeeV1ApiSecurityConfig","type":"object","properties":{"enabled":{"type":"boolean","description":"Flag that specifies whether the API security add-on is enabled."},"expiresAt":{"type":"string","description":"Output only. Time at which the API Security add-on expires in in milliseconds since epoch. If unspecified, the add-on will never expire."}},"description":"Configurations of the API Security add-on."},"GoogleCloudApigeeV1Query":{"title":"GoogleCloudApigeeV1Query","type":"object","properties":{"groupByTimeUnit":{"type":"string","description":"Time unit used to group the result set. Valid values include: second, minute, hour, day, week, or month. If a query includes groupByTimeUnit, then the result is an aggregation based on the specified time unit and the resultant timestamp does not include milliseconds precision. If a query omits groupByTimeUnit, then the resultant timestamp includes milliseconds precision."},"reportDefinitionId":{"type":"string","description":"Asynchronous Report ID."},"metrics":{"type":"array","items":{"$ref":"#/components/schemas/GoogleCloudApigeeV1QueryMetric"},"description":"A list of Metrics."},"outputFormat":{"type":"string","description":"Valid values include: `csv` or `json`. Defaults to `json`. Note: Configure the delimiter for CSV output using the csvDelimiter property."},"dimensions":{"type":"array","items":{"type":"string"},"description":"A list of dimensions. https://docs.apigee.com/api-platform/analytics/analytics-reference#dimensions"},"csvDelimiter":{"type":"string","description":"Delimiter used in the CSV file, if `outputFormat` is set to `csv`. Defaults to the `,` (comma) character. Supported delimiter characters include comma (`,`), pipe (`|`), and tab (`\\t`)."},"timeRange":{"description":"Required. Time range for the query. Can use the following predefined strings to specify the time range: `last60minutes` `last24hours` `last7days` Or, specify the timeRange as a structure describing start and end timestamps in the ISO format: yyyy-mm-ddThh:mm:ssZ. Example: \"timeRange\": { \"start\": \"2018-07-29T00:13:00Z\", \"end\": \"2018-08-01T00:18:00Z\" }"},"limit":{"type":"integer","description":"Maximum number of rows that can be returned in the result.","contentEncoding":"int32"},"envgroupHostname":{"type":"string","description":"Hostname needs to be specified if query intends to run at host level. This field is only allowed when query is submitted by CreateHostAsyncQuery where analytics data will be grouped by organization and hostname."},"filter":{"type":"string","description":"Boolean expression that can be used to filter data. Filter expressions can be combined using AND/OR terms and should be fully parenthesized to avoid ambiguity. See Analytics metrics, dimensions, and filters reference https://docs.apigee.com/api-platform/analytics/analytics-reference for more information on the fields available to filter on. For more information on the tokens that you use to build filter expressions, see Filter expression syntax. https://docs.apigee.com/api-platform/analytics/asynch-reports-api#filter-expression-syntax"},"name":{"type":"string","description":"Asynchronous Query Name."}}},"GoogleCloudApigeeV1SyncAuthorization":{"title":"GoogleCloudApigeeV1SyncAuthorization","type":"object","properties":{"etag":{"type":"string","description":"Entity tag (ETag) used for optimistic concurrency control as a way to help prevent simultaneous updates from overwriting each other. For example, when you call [getSyncAuthorization](organizations/getSyncAuthorization) an ETag is returned in the response. Pass that ETag when calling the [setSyncAuthorization](organizations/setSyncAuthorization) to ensure that you are updating the correct version. If you don't pass the ETag in the call to `setSyncAuthorization`, then the existing authorization is overwritten indiscriminately. **Note**: We strongly recommend that you use the ETag in the read-modify-write cycle to avoid race conditions."},"identities":{"type":"array","items":{"type":"string"},"description":"Required. Array of service accounts to grant access to control plane resources, each specified using the following format: `serviceAccount:` service-account-name. The service-account-name is formatted like an email address. For example: `my-synchronizer-manager-service_account@my_project_id.iam.gserviceaccount.com` You might specify multiple service accounts, for example, if you have multiple environments and wish to assign a unique service account to each one. The service accounts must have **Apigee Synchronizer Manager** role. See also [Create service accounts](https://cloud.google.com/apigee/docs/hybrid/latest/sa-about#create-the-service-accounts)."}}},"GoogleCloudApigeeV1AccessGet":{"title":"GoogleCloudApigeeV1AccessGet","type":"object","properties":{"name":{"type":"string"},"value":{"type":"string"}},"description":"Get action. For example, \"Get\" : { \"name\" : \"target.name\", \"value\" : \"default\" }"},"GoogleCloudApigeeV1ListArchiveDeploymentsResponse":{"title":"GoogleCloudApigeeV1ListArchiveDeploymentsResponse","type":"object","properties":{"archiveDeployments":{"type":"array","items":{"$ref":"#/components/schemas/GoogleCloudApigeeV1ArchiveDeployment"},"description":"Archive Deployments in the specified environment."},"nextPageToken":{"type":"string","description":"Page token that you can include in a ListArchiveDeployments request to retrieve the next page. If omitted, no subsequent pages exist."}},"description":"Response for ListArchiveDeployments method."},"GoogleCloudApigeeV1UpdateError":{"title":"GoogleCloudApigeeV1UpdateError","type":"object","properties":{"resource":{"type":"string","description":"The sub resource specific to this error (e.g. a proxy deployed within the EnvironmentConfig). If empty the error refers to the top level resource."},"code":{"allOf":[{"$ref":"#/components/schemas/Code"},{"description":"Status code."}]},"message":{"type":"string","description":"User-friendly error message."},"type":{"type":"string","description":"A string that uniquely identifies the type of error. This provides a more reliable means to deduplicate errors across revisions and instances."}},"description":"Details on why a resource update failed in the runtime."},"GoogleCloudApigeeV1SecurityReport":{"title":"GoogleCloudApigeeV1SecurityReport","type":"object","properties":{"updated":{"type":"string","description":"Output only. Last updated timestamp for the query."},"resultRows":{"type":"string","description":"ResultRows is available only after the query is completed."},"envgroupHostname":{"type":"string","description":"Hostname is available only when query is executed at host level."},"displayName":{"type":"string","description":"Display Name specified by the user."},"reportDefinitionId":{"type":"string","description":"Report Definition ID."},"state":{"type":"string","description":"Query state could be \"enqueued\", \"running\", \"completed\", \"expired\" and \"failed\"."},"error":{"type":"string","description":"Error is set when query fails."},"resultFileSize":{"type":"string","description":"ResultFileSize is available only after the query is completed."},"queryParams":{"description":"Contains information like metrics, dimenstions etc of the Security Report."},"created":{"type":"string","description":"Creation time of the query."},"self":{"type":"string","description":"Self link of the query. Example: `/organizations/myorg/environments/myenv/securityReports/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd` or following format if query is running at host level: `/organizations/myorg/hostSecurityReports/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd`"},"executionTime":{"type":"string","description":"ExecutionTime is available only after the query is completed."},"result":{"description":"Result is available only after the query is completed."}},"description":"SecurityReport saves all the information about the created security report."},"GoogleCloudApigeeV1EntityMetadata":{"title":"GoogleCloudApigeeV1EntityMetadata","type":"object","properties":{"lastModifiedAt":{"type":"string","description":"Time at which the API proxy was most recently modified, in milliseconds since epoch."},"subType":{"type":"string","description":"The type of entity described"},"createdAt":{"type":"string","description":"Time at which the API proxy was created, in milliseconds since epoch."}},"description":"Metadata common to many entities in this API."},"GoogleRpcStatus":{"title":"GoogleRpcStatus","type":"object","properties":{"message":{"type":"string","description":"A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client."},"code":{"type":"integer","description":"The status code, which should be an enum value of google.rpc.Code.","contentEncoding":"int32"},"details":{"type":"array","items":{},"description":"A list of messages that carry the error details. There is a common set of message types for APIs to use."}},"description":"The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors)."},"GoogleCloudApigeeV1AsyncQueryResultView":{"title":"GoogleCloudApigeeV1AsyncQueryResultView","type":"object","properties":{"error":{"type":"string","description":"Error message when there is a failure."},"state":{"type":"string","description":"State of retrieving ResultView."},"metadata":{"$ref":"#/components/schemas/GoogleCloudApigeeV1QueryMetadata"},"rows":{"type":"array","items":{},"description":"Rows of query result. Each row is a JSON object. Example: {sum(message_count): 1, developer_app: \"(not set)\",…}"},"code":{"type":"integer","description":"Error code when there is a failure.","contentEncoding":"int32"}}},"GoogleCloudApigeeV1SecurityReportMetadata":{"title":"GoogleCloudApigeeV1SecurityReportMetadata","type":"object","properties":{"metrics":{"type":"array","items":{"type":"string"},"description":"Metrics of the SecurityReport. Example: [\"name:bot_count,func:sum,alias:sum_bot_count\"]"},"endTimestamp":{"type":"string","description":"End timestamp of the query range."},"startTimestamp":{"type":"string","description":"Start timestamp of the query range."},"mimeType":{"type":"string","description":"MIME type / Output format."},"dimensions":{"type":"array","items":{"type":"string"},"description":"Dimensions of the SecurityReport."},"timeUnit":{"type":"string","description":"Query GroupBy time unit. Example: \"seconds\", \"minute\", \"hour\""}},"description":"Metadata for the security report."},"GoogleCloudApigeeV1Metric":{"title":"GoogleCloudApigeeV1Metric","type":"object","properties":{"name":{"type":"string","description":"Metric name."},"values":{"type":"array","items":{},"description":"List of metric values. Possible value formats include: `\"values\":[\"39.0\"]` or `\"values\":[ { \"value\": \"39.0\", \"timestamp\": 1232434354} ]`"}},"description":"Encapsulates the metric data point. For example: ```{ \"name\": \"sum(message_count)\", \"values\" : [ { \"timestamp\": 1549004400000, \"value\": \"39.0\" }, { \"timestamp\" : 1548997200000, \"value\" : \"0.0\" } ] }``` or ```{ \"name\": \"sum(message_count)\", \"values\" : [\"39.0\"] }```"},"GoogleCloudApigeeV1IntegrationConfig":{"title":"GoogleCloudApigeeV1IntegrationConfig","type":"object","properties":{"enabled":{"type":"boolean","description":"Flag that specifies whether the Integration add-on is enabled."}},"description":"Configuration for the Integration add-on."},"GoogleCloudApigeeV1SharedFlow":{"title":"GoogleCloudApigeeV1SharedFlow","type":"object","properties":{"revision":{"type":"array","items":{"type":"string"},"description":"A list of revisions of this shared flow."},"name":{"type":"string","description":"The ID of the shared flow."},"metaData":{"allOf":[{"$ref":"#/components/schemas/GoogleCloudApigeeV1EntityMetadata"},{"description":"Metadata common to many entities in this API."}]},"latestRevisionId":{"type":"string","description":"The id of the most recently created revision for this shared flow."}},"description":"The metadata describing a shared flow"},"GoogleCloudApigeeV1KeyAliasReference":{"title":"GoogleCloudApigeeV1KeyAliasReference","type":"object","properties":{"reference":{"type":"string","description":"Reference name in the following format: `organizations/{org}/environments/{env}/references/{reference}`"},"aliasId":{"type":"string","description":"Alias ID. Must exist in the keystore referred to by the reference."}}},"GoogleCloudApigeeV1OperationMetadataProgress":{"title":"GoogleCloudApigeeV1OperationMetadataProgress","type":"object","properties":{"description":{"type":"string","description":"Description of the operation's progress."},"state":{"allOf":[{"$ref":"#/components/schemas/State3"},{"description":"State of the operation."}]},"details":{"type":"object","additionalProperties":{},"description":"The additional details of the progress."},"percentDone":{"type":"integer","description":"The percentage of the operation progress.","contentEncoding":"int32"}},"description":"Information about operation progress."},"GoogleCloudApigeeV1KeystoreConfig":{"title":"GoogleCloudApigeeV1KeystoreConfig","type":"object","properties":{"aliases":{"type":"array","items":{},"description":"Aliases in the keystore."},"name":{"type":"string","description":"Resource name in the following format: `organizations/{org}/environments/{env}/keystores/{keystore}`"}}},"GoogleCloudApigeeV1DeveloperApp":{"title":"GoogleCloudApigeeV1DeveloperApp","type":"object","properties":{"attributes":{"type":"array","items":{},"description":"List of attributes for the developer app."},"lastModifiedAt":{"type":"string","description":"Output only. Time the developer app was modified in milliseconds since epoch."},"scopes":{"type":"array","items":{"type":"string"},"description":"Scopes to apply to the developer app. The specified scopes must already exist for the API product that you associate with the developer app."},"appFamily":{"type":"string","description":"Developer app family."},"status":{"type":"string","description":"Status of the credential. Valid values include `approved` or `revoked`."},"keyExpiresIn":{"type":"string","description":"Expiration time, in milliseconds, for the consumer key that is generated for the developer app. If not set or left to the default value of `-1`, the API key never expires. The expiration time can't be updated after it is set."},"name":{"type":"string","description":"Name of the developer app."},"callbackUrl":{"type":"string","description":"Callback URL used by OAuth 2.0 authorization servers to communicate authorization codes back to developer apps."},"appId":{"type":"string","description":"ID of the developer app."},"credentials":{"type":"array","items":{},"description":"Output only. Set of credentials for the developer app consisting of the consumer key/secret pairs associated with the API products."},"developerId":{"type":"string","description":"ID of the developer."},"apiProducts":{"type":"array","items":{"type":"string"},"description":"List of API products associated with the developer app."},"createdAt":{"type":"string","description":"Output only. Time the developer app was created in milliseconds since epoch."}}},"GoogleCloudApigeeV1Property":{"title":"GoogleCloudApigeeV1Property","type":"object","properties":{"name":{"type":"string","description":"The property key"},"value":{"type":"string","description":"The property value"}},"description":"A single property entry in the Properties message."},"GoogleCloudApigeeV1DeploymentChangeReportRoutingConflict":{"title":"GoogleCloudApigeeV1DeploymentChangeReportRoutingConflict","type":"object","properties":{"environmentGroup":{"type":"string","description":"Name of the environment group in which this conflict exists."},"description":{"type":"string","description":"Human-readable description of this conflict."},"conflictingDeployment":{"description":"Existing base path/deployment causing the conflict."}},"description":"Describes a routing conflict that may cause a deployment not to receive traffic at some base path."},"GoogleCloudApigeeV1Score":{"title":"GoogleCloudApigeeV1Score","type":"object","properties":{"component":{"allOf":[{"$ref":"#/components/schemas/GoogleCloudApigeeV1ScoreComponent"},{"description":"Component is an individual security element that is scored."}]},"timeRange":{"allOf":[{"$ref":"#/components/schemas/GoogleTypeInterval"},{"description":"Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive). The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time."}]},"subcomponents":{"type":"array","items":{"$ref":"#/components/schemas/GoogleCloudApigeeV1ScoreComponent"},"description":"List of all the drilldown score components."}},"description":"Represents Security Score."},"GoogleCloudApigeeV1Schema":{"title":"GoogleCloudApigeeV1Schema","type":"object","properties":{"metrics":{"type":"array","items":{"$ref":"#/components/schemas/GoogleCloudApigeeV1SchemaSchemaElement"},"description":"List of schema fields grouped as dimensions that can be used with an aggregate function such as `sum`, `avg`, `min`, and `max`."},"meta":{"type":"array","items":{"type":"string"},"description":"Additional metadata associated with schema. This is a legacy field and usually consists of an empty array of strings."},"dimensions":{"type":"array","items":{"$ref":"#/components/schemas/GoogleCloudApigeeV1SchemaSchemaElement"},"description":"List of schema fields grouped as dimensions."}},"description":"Response for Schema call"},"GoogleCloudApigeeV1Properties":{"title":"GoogleCloudApigeeV1Properties","type":"object","properties":{"property":{"type":"array","items":{},"description":"List of all properties in the object"}},"description":"Message for compatibility with legacy Edge specification for Java Properties object in JSON."},"GoogleCloudApigeeV1AdvancedApiOpsConfig":{"title":"GoogleCloudApigeeV1AdvancedApiOpsConfig","type":"object","properties":{"enabled":{"type":"boolean","description":"Flag that specifies whether the Advanced API Ops add-on is enabled."}},"description":"Configuration for the Advanced API Ops add-on."},"GoogleCloudApigeeV1Metadata":{"title":"GoogleCloudApigeeV1Metadata","type":"object","properties":{"notices":{"type":"array","items":{"type":"string"},"description":"List of additional information such as data source, if result was truncated. For example: ``` \"notices\": [ \"Source:Postgres\", \"PG Host:uappg0rw.e2e.apigeeks.net\", \"query served by:4b64601e-40de-4eb1-bfb9-eeee7ac929ed\", \"Table used: edge.api.uapgroup2.agg_api\" ]```"},"errors":{"type":"array","items":{"type":"string"},"description":"List of error messages as strings."}},"description":"Encapsulates additional information about query execution."},"GoogleIamV1TestIamPermissionsResponse":{"title":"GoogleIamV1TestIamPermissionsResponse","type":"object","properties":{"permissions":{"type":"array","items":{"type":"string"},"description":"A subset of `TestPermissionsRequest.permissions` that the caller is allowed."}},"description":"Response message for `TestIamPermissions` method."},"GoogleCloudApigeeV1OptimizedStats":{"title":"GoogleCloudApigeeV1OptimizedStats","type":"object","properties":{"Response":{"allOf":[{"$ref":"#/components/schemas/GoogleCloudApigeeV1OptimizedStatsResponse"},{"description":"Encapsulates a response format for JavaScript Optimized Scenario."}]}}},"GoogleCloudApigeeV1ListDeveloperSubscriptionsResponse":{"title":"GoogleCloudApigeeV1ListDeveloperSubscriptionsResponse","type":"object","properties":{"developerSubscriptions":{"type":"array","items":{"$ref":"#/components/schemas/GoogleCloudApigeeV1DeveloperSubscription"},"description":"List of all subscriptions."},"nextStartKey":{"type":"string","description":"Value that can be sent as `startKey` to retrieve the next page of content. If this field is omitted, there are no subsequent pages."}},"description":"Response for ListDeveloperSubscriptions."},"GoogleCloudApigeeV1DimensionMetric":{"title":"GoogleCloudApigeeV1DimensionMetric","type":"object","properties":{"metrics":{"type":"array","items":{"$ref":"#/components/schemas/GoogleCloudApigeeV1Metric"},"description":"List of metrics."},"name":{"type":"string","description":"Name of the dimension."}},"description":"Encapsulates a metric grouped by dimension."},"GoogleCloudApigeeV1OperationConfig":{"title":"GoogleCloudApigeeV1OperationConfig","type":"object","properties":{"operations":{"type":"array","items":{},"description":"List of resource/method pairs for the API proxy or remote service to which quota will applied. **Note**: Currently, you can specify only a single resource/method pair. The call will fail if more than one resource/method pair is provided."},"attributes":{"type":"array","items":{},"description":"Custom attributes associated with the operation."},"quota":{"description":"Quota parameters to be enforced for the resources, methods, and API source combination. If none are specified, quota enforcement will not be done."},"apiSource":{"type":"string","description":"Required. Name of the API proxy or remote service with which the resources, methods, and quota are associated."}},"description":"Binds the resources in an API proxy or remote service with the allowed REST methods and associated quota enforcement."},"GoogleCloudApigeeV1GenerateUploadUrlResponse":{"title":"GoogleCloudApigeeV1GenerateUploadUrlResponse","type":"object","properties":{"uploadUri":{"type":"string","description":"The Google Cloud Storage signed URL that can be used to upload a new Archive zip file."}},"description":"Response for GenerateUploadUrl method."},"GoogleCloudApigeeV1AccessSet":{"title":"GoogleCloudApigeeV1AccessSet","type":"object","properties":{"value":{"type":"string"},"success":{"type":"boolean"},"name":{"type":"string"}},"description":"Set action. For example, \"Set\" : { \"name\" : \"target.name\", \"success\" : true, \"value\" : \"default\" }"},"GoogleCloudApigeeV1StatsHostStats":{"title":"GoogleCloudApigeeV1StatsHostStats","type":"object","properties":{"name":{"type":"string","description":"Hostname used in query."},"dimensions":{"type":"array","items":{},"description":"List of metrics grouped under dimensions."},"metrics":{"type":"array","items":{},"description":"In the final response, only one of the following fields will be present based on the dimensions provided. If no dimensions are provided, then only the top-level metrics are provided. If dimensions are included, then there will be a top-level dimensions field under hostnames which will contain metrics values and the dimension name. Example: ``` \"hosts\": [ { \"dimensions\": [ { \"metrics\": [ { \"name\": \"sum(message_count)\", \"values\": [ \"2.14049521E8\" ] } ], \"name\": \"nit_proxy\" } ], \"name\": \"example.com\" } ]``` OR ```\"hosts\": [ { \"metrics\": [ { \"name\": \"sum(message_count)\", \"values\": [ \"2.19026331E8\" ] } ], \"name\": \"example.com\" } ]``` List of metric values."}},"description":"Encapsulates the hostname wrapper: ``` \"hosts\": [ { \"metrics\": [ { \"name\": \"sum(message_count)\", \"values\": [ \"2.52056245E8\" ] } ], \"name\": \"example.com\" } ]```"},"GoogleCloudApigeeV1ComputeEnvironmentScoresRequestFilter":{"title":"GoogleCloudApigeeV1ComputeEnvironmentScoresRequestFilter","type":"object","properties":{"scorePath":{"type":"string","description":"Optional. Return scores for this component. Example: \"/org@myorg/envgroup@myenvgroup/env@myenv/proxies/proxy@myproxy/source\""}},"description":"Filter scores by component path. Used custom filter instead of AIP-160 as the use cases are highly constrained and predictable."},"GoogleCloudApigeeV1ListDeploymentsResponse":{"title":"GoogleCloudApigeeV1ListDeploymentsResponse","type":"object","properties":{"deployments":{"type":"array","items":{"$ref":"#/components/schemas/GoogleCloudApigeeV1Deployment"},"description":"List of deployments."}}},"GoogleCloudApigeeV1TestDatastoreResponse":{"title":"GoogleCloudApigeeV1TestDatastoreResponse","type":"object","properties":{"state":{"type":"string","description":"Output only. It could be `completed` or `failed`"},"error":{"type":"string","description":"Output only. Error message of test connection failure"}},"description":"The response for TestDatastore"},"GoogleCloudApigeeV1ComputeEnvironmentScoresResponse":{"title":"GoogleCloudApigeeV1ComputeEnvironmentScoresResponse","type":"object","properties":{"scores":{"type":"array","items":{"$ref":"#/components/schemas/GoogleCloudApigeeV1Score"},"description":"List of scores. One score per day."},"nextPageToken":{"type":"string","description":"A page token, received from a previous `ComputeScore` call. Provide this to retrieve the subsequent page."}},"description":"Response for ComputeEnvironmentScores."},"GoogleCloudApigeeV1TlsInfoCommonName":{"title":"GoogleCloudApigeeV1TlsInfoCommonName","type":"object","properties":{"wildcardMatch":{"type":"boolean","description":"Indicates whether the cert should be matched against as a wildcard cert."},"value":{"type":"string","description":"The TLS Common Name string of the certificate."}}},"GoogleCloudApigeeV1SecurityProfile":{"title":"GoogleCloudApigeeV1SecurityProfile","type":"object","properties":{"name":{"type":"string","description":"Immutable. Name of the security profile resource. Format: organizations/{org}/securityProfiles/{profile}"},"displayName":{"type":"string","description":"Display name of the security profile."},"environments":{"type":"array","items":{},"description":"List of environments attached to security profile."},"minScore":{"type":"integer","description":"Output only. Minimum security score that can be generated by this profile.","contentEncoding":"int32"},"revisionUpdateTime":{"type":"string","description":"Output only. The time when revision was updated."},"revisionCreateTime":{"type":"string","description":"Output only. The time when revision was created."},"scoringConfigs":{"type":"array","items":{},"description":"List of profile scoring configs in this revision."},"revisionPublishTime":{"type":"string","description":"Output only. The time when revision was published. Once published, the security profile revision cannot be updated further and can be attached to environments."},"maxScore":{"type":"integer","description":"Output only. Maximum security score that can be generated by this profile.","contentEncoding":"int32"},"revisionId":{"type":"string","description":"Output only. Revision ID of the security profile."}},"description":"Represents a SecurityProfile resource."},"GoogleCloudApigeeV1TargetServer":{"title":"GoogleCloudApigeeV1TargetServer","type":"object","properties":{"isEnabled":{"type":"boolean","description":"Optional. Enabling/disabling a TargetServer is useful when TargetServers are used in load balancing configurations, and one or more TargetServers need to taken out of rotation periodically. Defaults to true."},"port":{"type":"integer","description":"Required. The port number this target connects to on the given host. Value must be between 1 and 65535, inclusive.","contentEncoding":"int32"},"description":{"type":"string","description":"Optional. A human-readable description of this TargetServer."},"host":{"type":"string","description":"Required. The host name this target connects to. Value must be a valid hostname as described by RFC-1123."},"name":{"type":"string","description":"Required. The resource id of this target server. Values must match the regular expression"},"sSLInfo":{"allOf":[{"$ref":"#/components/schemas/GoogleCloudApigeeV1TlsInfo"},{"description":"TLS configuration information for virtual hosts and TargetServers."}]},"protocol":{"allOf":[{"$ref":"#/components/schemas/Protocol1"},{"description":"Immutable. The protocol used by this TargetServer."}]}},"description":"TargetServer configuration. TargetServers are used to decouple a proxy's TargetEndpoint HTTPTargetConnections from concrete URLs for backend services."},"GoogleCloudApigeeV1RateRange":{"title":"GoogleCloudApigeeV1RateRange","type":"object","properties":{"fee":{"description":"Fee to charge when total number of API calls falls within this range."},"end":{"type":"string","description":"Ending value of the range. Set to 0 or `null` for the last range of values."},"start":{"type":"string","description":"Starting value of the range. Set to 0 or `null` for the initial range of values."}},"description":"API call volume range and the fees charged when the total number of API calls is within the range."},"GoogleCloudApigeeV1DeleteCustomReportResponse":{"title":"GoogleCloudApigeeV1DeleteCustomReportResponse","type":"object","properties":{"message":{"type":"string","description":"The response contains only a message field."}}},"GoogleCloudApigeeV1ListCustomReportsResponse":{"title":"GoogleCloudApigeeV1ListCustomReportsResponse","type":"object","properties":{"qualifier":{"type":"array","items":{"$ref":"#/components/schemas/GoogleCloudApigeeV1CustomReport"},"description":""}},"description":"This message encapsulates a list of custom report definitions"},"GoogleCloudApigeeV1RoutingRule":{"title":"GoogleCloudApigeeV1RoutingRule","type":"object","properties":{"envGroupRevision":{"type":"string","description":"The env group config revision_id when this rule was added or last updated. This value is set when the rule is created and will only update if the the environment_id changes. It is used to determine if the runtime is up to date with respect to this rule. This field is omitted from the IngressConfig unless the GetDeployedIngressConfig API is called with view=FULL."},"receiver":{"type":"string","description":"The resource name of the proxy revision that is receiving this basepath in the following format: `organizations/{org}/apis/{api}/revisions/{rev}`. This field is omitted from the IngressConfig unless the GetDeployedIngressConfig API is called with view=FULL."},"updateTime":{"type":"string","description":"The unix timestamp when this rule was updated. This is updated whenever env_group_revision is updated. This field is omitted from the IngressConfig unless the GetDeployedIngressConfig API is called with view=FULL."},"environment":{"type":"string","description":"Name of an environment bound to the environment group in the following format: `organizations/{org}/environments/{env}`."},"basepath":{"type":"string","description":"URI path prefix used to route to the specified environment. May contain one or more wildcards. For example, path segments consisting of a single `*` character will match any string."}}},"GoogleCloudApigeeV1ApiProduct":{"title":"GoogleCloudApigeeV1ApiProduct","type":"object","properties":{"proxies":{"type":"array","items":{"type":"string"},"description":"Comma-separated list of API proxy names to which this API product is bound. By specifying API proxies, you can associate resources in the API product with specific API proxies, preventing developers from accessing those resources through other API proxies. Apigee rejects requests to API proxies that are not listed. **Note:** The API proxy names must already exist in the specified environment as they will be validated upon creation."},"name":{"type":"string","description":"Internal name of the API product. Characters you can use in the name are restricted to: `A-Z0-9._\\-$ %`. **Note:** The internal name cannot be edited when updating the API product."},"attributes":{"type":"array","items":{},"description":"Array of attributes that may be used to extend the default API product profile with customer-specific metadata. You can specify a maximum of 18 attributes. Use this property to specify the access level of the API product as either `public`, `private`, or `internal`. Only products marked `public` are available to developers in the Apigee developer portal. For example, you can set a product to `internal` while it is in development and then change access to `public` when it is ready to release on the portal. API products marked as `private` do not appear on the portal, but can be accessed by external developers."},"displayName":{"type":"string","description":"Name displayed in the UI or developer portal to developers registering for API access."},"quota":{"type":"string","description":"Number of request messages permitted per app by this API product for the specified `quotaInterval` and `quotaTimeUnit`. For example, a `quota` of 50, for a `quotaInterval` of 12 and a `quotaTimeUnit` of hours means 50 requests are allowed every 12 hours."},"scopes":{"type":"array","items":{"type":"string"},"description":"Comma-separated list of OAuth scopes that are validated at runtime. Apigee validates that the scopes in any access token presented match the scopes defined in the OAuth policy associated with the API product."},"quotaTimeUnit":{"type":"string","description":"Time unit defined for the `quotaInterval`. Valid values include `minute`, `hour`, `day`, or `month`."},"approvalType":{"type":"string","description":"Flag that specifies how API keys are approved to access the APIs defined by the API product. If set to `manual`, the consumer key is generated and returned in \"pending\" state. In this case, the API keys won't work until they have been explicitly approved. If set to `auto`, the consumer key is generated and returned in \"approved\" state and can be used immediately. **Note:** Typically, `auto` is used to provide access to free or trial API products that provide limited quota or capabilities."},"description":{"type":"string","description":"Description of the API product. Include key information about the API product that is not captured by other fields."},"graphqlOperationGroup":{"description":"Configuration used to group Apigee proxies or remote services with graphQL operation name, graphQL operation type and quotas. This grouping allows us to precisely set quota for a particular combination of graphQL name and operation type for a particular proxy request. If graphQL name is not set, this would imply quota will be applied on all graphQL requests matching the operation type."},"apiResources":{"type":"array","items":{"type":"string"},"description":"Comma-separated list of API resources to be bundled in the API product. By default, the resource paths are mapped from the `proxy.pathsuffix` variable. The proxy path suffix is defined as the URI fragment following the ProxyEndpoint base path. For example, if the `apiResources` element is defined to be `/forecastrss` and the base path defined for the API proxy is `/weather`, then only requests to `/weather/forecastrss` are permitted by the API product. You can select a specific path, or you can select all subpaths with the following wildcard: - `/**`: Indicates that all sub-URIs are included. - `/*` : Indicates that only URIs one level down are included. By default, / supports the same resources as /** as well as the base path defined by the API proxy. For example, if the base path of the API proxy is `/v1/weatherapikey`, then the API product supports requests to `/v1/weatherapikey` and to any sub-URIs, such as `/v1/weatherapikey/forecastrss`, `/v1/weatherapikey/region/CA`, and so on. For more information, see Managing API products."},"operationGroup":{"description":"Configuration used to group Apigee proxies or remote services with resources, method types, and quotas. The resource refers to the resource URI (excluding the base path). With this grouping, the API product creator is able to fine-tune and give precise control over which REST methods have access to specific resources and how many calls can be made (using the `quota` setting). **Note:** The `api_resources` setting cannot be specified for both the API product and operation group; otherwise the call will fail."},"createdAt":{"type":"string","description":"Response only. Creation time of this environment as milliseconds since epoch."},"quotaInterval":{"type":"string","description":"Time interval over which the number of request messages is calculated."},"quotaCounterScope":{"allOf":[{"$ref":"#/components/schemas/QuotaCounterScope"},{"description":"Scope of the quota decides how the quota counter gets applied and evaluate for quota violation. If the Scope is set as PROXY, then all the operations defined for the APIproduct that are associated with the same proxy will share the same quota counter set at the APIproduct level, making it a global counter at a proxy level. If the Scope is set as OPERATION, then each operations get the counter set at the API product dedicated, making it a local counter. Note that, the QuotaCounterScope applies only when an operation does not have dedicated quota set for itself."}]},"lastModifiedAt":{"type":"string","description":"Response only. Modified time of this environment as milliseconds since epoch."},"environments":{"type":"array","items":{"type":"string"},"description":"Comma-separated list of environment names to which the API product is bound. Requests to environments that are not listed are rejected. By specifying one or more environments, you can bind the resources listed in the API product to a specific environment, preventing developers from accessing those resources through API proxies deployed in another environment. This setting is used, for example, to prevent resources associated with API proxies in `prod` from being accessed by API proxies deployed in `test`."}}},"GoogleCloudApigeeV1ListApiProxiesResponse":{"title":"GoogleCloudApigeeV1ListApiProxiesResponse","type":"object","properties":{"proxies":{"type":"array","items":{"$ref":"#/components/schemas/GoogleCloudApigeeV1ApiProxy"},"description":""}},"description":"To change this message, in the same CL add a change log in go/changing-api-proto-breaks-ui"},"GoogleCloudApigeeV1Quota":{"title":"GoogleCloudApigeeV1Quota","type":"object","properties":{"interval":{"type":"string","description":"Required. Time interval over which the number of request messages is calculated."},"timeUnit":{"type":"string","description":"Time unit defined for the `interval`. Valid values include `minute`, `hour`, `day`, or `month`. If `limit` and `interval` are valid, the default value is `hour`; otherwise, the default is null."},"limit":{"type":"string","description":"Required. Upper limit allowed for the time interval and time unit specified. Requests exceeding this limit will be rejected."}},"description":"Quota contains the essential parameters needed that can be applied on the resources, methods, API source combination associated with this API product. While Quota is optional, setting it prevents requests from exceeding the provisioned parameters."},"GoogleCloudApigeeV1AdjustDeveloperBalanceRequest":{"title":"GoogleCloudApigeeV1AdjustDeveloperBalanceRequest","type":"object","properties":{"adjustment":{"allOf":[{"$ref":"#/components/schemas/GoogleTypeMoney"},{"description":"Represents an amount of money with its currency type."}]}},"description":"Request for AdjustDeveloperBalance."},"GoogleCloudApigeeV1ListSharedFlowsResponse":{"title":"GoogleCloudApigeeV1ListSharedFlowsResponse","type":"object","properties":{"sharedFlows":{"type":"array","items":{"$ref":"#/components/schemas/GoogleCloudApigeeV1SharedFlow"},"description":""}},"description":"To change this message, in the same CL add a change log in go/changing-api-proto-breaks-ui"},"GoogleCloudApigeeV1ScoreComponentRecommendationAction":{"title":"GoogleCloudApigeeV1ScoreComponentRecommendationAction","type":"object","properties":{"description":{"type":"string","description":"Description of the action."},"actionContext":{"allOf":[{"$ref":"#/components/schemas/GoogleCloudApigeeV1ScoreComponentRecommendationActionActionContext"},{"description":"Action context are all the relevant details for the action."}]}},"description":"Action to improve security score."},"GoogleCloudApigeeV1ResourceFiles":{"title":"GoogleCloudApigeeV1ResourceFiles","type":"object","properties":{"resourceFile":{"type":"array","items":{"$ref":"#/components/schemas/GoogleCloudApigeeV1ResourceFile"},"description":"List of resource files."}},"description":"List of resource files."},"GoogleCloudApigeeV1RuntimeTraceConfigOverride":{"title":"GoogleCloudApigeeV1RuntimeTraceConfigOverride","type":"object","properties":{"revisionCreateTime":{"type":"string","description":"The timestamp that the revision was created or updated."},"apiProxy":{"type":"string","description":"Name of the API proxy that will have its trace configuration overridden following format: `organizations/{org}/apis/{api}`"},"name":{"type":"string","description":"Name of the trace config override in the following format: `organizations/{org}/environment/{env}/traceConfig/overrides/{override}`"},"samplingConfig":{"description":"Trace configuration override for a specific API proxy in an environment."},"revisionId":{"type":"string","description":"Revision number which can be used by the runtime to detect if the trace config override has changed between two versions."},"uid":{"type":"string","description":"Unique ID for the configuration override. The ID will only change if the override is deleted and recreated. Corresponds to name's \"override\" field."}},"description":"NEXT ID: 7 Trace configuration override for a specific API proxy in an environment."},"GoogleCloudApigeeV1SecurityProfileEnvironmentAssociation":{"title":"GoogleCloudApigeeV1SecurityProfileEnvironmentAssociation","type":"object","properties":{"attachTime":{"type":"string","description":"Output only. The time when environment was attached to the security profile."},"name":{"type":"string","description":"Immutable. Name of the profile-environment association resource. Format: organizations/{org}/securityProfiles/{profile}/environments/{env}"},"securityProfileRevisionId":{"type":"string","description":"Revision ID of the security profile."}},"description":"Represents a SecurityProfileEnvironmentAssociation resource."},"GoogleCloudApigeeV1ListInstanceAttachmentsResponse":{"title":"GoogleCloudApigeeV1ListInstanceAttachmentsResponse","type":"object","properties":{"nextPageToken":{"type":"string","description":"Page token that you can include in a ListInstanceAttachments request to retrieve the next page of content. If omitted, no subsequent pages exist."},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/GoogleCloudApigeeV1InstanceAttachment"},"description":"Attachments for the instance."}},"description":"Response for ListInstanceAttachments."},"GoogleCloudApigeeV1Credential":{"title":"GoogleCloudApigeeV1Credential","type":"object","properties":{"scopes":{"type":"array","items":{"type":"string"},"description":"List of scopes to apply to the app. Specified scopes must already exist on the API product that you associate with the app."},"status":{"type":"string","description":"Status of the credential. Valid values include `approved` or `revoked`."},"expiresAt":{"type":"string","description":"Time the credential will expire in milliseconds since epoch."},"apiProducts":{"type":"array","items":{"$ref":"#/components/schemas/GoogleCloudApigeeV1ApiProductRef"},"description":"List of API products this credential can be used for."},"issuedAt":{"type":"string","description":"Time the credential was issued in milliseconds since epoch."},"consumerKey":{"type":"string","description":"Consumer key."},"attributes":{"type":"array","items":{"$ref":"#/components/schemas/GoogleCloudApigeeV1Attribute"},"description":"List of attributes associated with this credential."},"consumerSecret":{"type":"string","description":"Secret key."}}},"GoogleCloudApigeeV1TraceConfig":{"title":"GoogleCloudApigeeV1TraceConfig","type":"object","properties":{"endpoint":{"type":"string","description":"Required. Endpoint of the exporter."},"samplingConfig":{"allOf":[{"$ref":"#/components/schemas/GoogleCloudApigeeV1TraceSamplingConfig"},{"description":"TraceSamplingConfig represents the detail settings of distributed tracing. Only the fields that are defined in the distributed trace configuration can be overridden using the distribute trace configuration override APIs."}]},"exporter":{"allOf":[{"$ref":"#/components/schemas/Exporter1"},{"description":"Required. Exporter that is used to view the distributed trace captured using OpenCensus. An exporter sends traces to any backend that is capable of consuming them. Recorded spans can be exported by registered exporters."}]}},"description":"TraceConfig defines the configurations in an environment of distributed trace."},"GoogleCloudApigeeV1ReportInstanceStatusRequest":{"title":"GoogleCloudApigeeV1ReportInstanceStatusRequest","type":"object","properties":{"instanceUid":{"type":"string","description":"A unique ID for the instance which is guaranteed to be unique in case the user installs multiple hybrid runtimes with the same instance ID."},"reportTime":{"type":"string","description":"The time the report was generated in the runtime. Used to prevent an old status from overwriting a newer one. An instance should space out it's status reports so that clock skew does not play a factor."},"resources":{"type":"array","items":{"$ref":"#/components/schemas/GoogleCloudApigeeV1ResourceStatus"},"description":"Status for config resources"}},"description":"Request for ReportInstanceStatus."},"GoogleCloudApigeeV1DeploymentConfig":{"title":"GoogleCloudApigeeV1DeploymentConfig","type":"object","properties":{"serviceAccount":{"type":"string","description":"The service account identity associated with this deployment. If non-empty, will be in the following format: `projects/-/serviceAccounts/{account_email}`"},"basePath":{"type":"string","description":"Base path where the application will be hosted. Defaults to \"/\"."},"location":{"type":"string","description":"Location of the API proxy bundle as a URI."},"name":{"type":"string","description":"Name of the API or shared flow revision to be deployed in the following format: `organizations/{org}/apis/{api}/revisions/{rev}` or `organizations/{org}/sharedflows/{sharedflow}/revisions/{rev}`"},"attributes":{"type":"object","additionalProperties":{"type":"string"},"description":"Additional key-value metadata for the deployment."},"proxyUid":{"type":"string","description":"Unique ID of the API proxy revision."},"uid":{"type":"string","description":"Unique ID. The ID will only change if the deployment is deleted and recreated."}},"description":"NEXT ID: 9"},"GoogleCloudApigeeV1RevenueShareRange":{"title":"GoogleCloudApigeeV1RevenueShareRange","type":"object","properties":{"end":{"type":"string","description":"Ending value of the range. Set to 0 or `null` for the last range of values."},"start":{"type":"string","description":"Starting value of the range. Set to 0 or `null` for the initial range of values."},"sharePercentage":{"type":"number","description":"Percentage of the revenue to be shared with the developer. For example, to share 21 percent of the total revenue with the developer, set this value to 21. Specify a decimal number with a maximum of two digits following the decimal point."}},"description":"API call volume range and the percentage of revenue to share with the developer when the total number of API calls is within the range."},"GoogleCloudApigeeV1AsyncQueryResult":{"title":"GoogleCloudApigeeV1AsyncQueryResult","type":"object","properties":{"expires":{"type":"string","description":"Query result will be unaccessable after this time."},"self":{"type":"string","description":"Self link of the query results. Example: `/organizations/myorg/environments/myenv/queries/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd/result` or following format if query is running at host level: `/organizations/myorg/hostQueries/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd/result`"}}},"GoogleCloudApigeeV1QueryTabularStatsResponse":{"title":"GoogleCloudApigeeV1QueryTabularStatsResponse","type":"object","properties":{"values":{"type":"array","items":{"type":"array","items":{}},"description":"Resultant rows from the executed query."},"columns":{"type":"array","items":{"type":"string"},"description":"Column names corresponding to the same order as the inner values in the stats field."},"nextPageToken":{"type":"string","description":"Next page token."}},"description":"Encapsulates two kinds of stats that are results of the dimensions and aggregations requested. - Tabular rows. - Time series data. Example of tabular rows, Represents security stats results as a row of flat values."},"GoogleCloudApigeeV1SecurityReportResultView":{"title":"GoogleCloudApigeeV1SecurityReportResultView","type":"object","properties":{"metadata":{"allOf":[{"$ref":"#/components/schemas/GoogleCloudApigeeV1SecurityReportMetadata"},{"description":"Metadata for the security report."}]},"error":{"type":"string","description":"Error message when there is a failure."},"code":{"type":"integer","description":"Error code when there is a failure.","contentEncoding":"int32"},"rows":{"type":"array","items":{},"description":"Rows of security report result. Each row is a JSON object. Example: {sum(message_count): 1, developer_app: \"(not set)\",…}"},"state":{"type":"string","description":"State of retrieving ResultView."}},"description":"The response for security report result view APIs."},"GoogleCloudApigeeV1DeveloperBalanceWallet":{"title":"GoogleCloudApigeeV1DeveloperBalanceWallet","type":"object","properties":{"lastCreditTime":{"type":"string","description":"Output only. Time at which the developer last added credit to the account in milliseconds since epoch."},"balance":{"description":"Current remaining balance of the developer for a particular currency."}},"description":"Wallet used to manage an account balance for a particular currency."},"GoogleCloudApigeeV1QueryMetric":{"title":"GoogleCloudApigeeV1QueryMetric","type":"object","properties":{"value":{"type":"string","description":"Operand value should be provided when operator is set."},"alias":{"type":"string","description":"Alias for the metric. Alias will be used to replace metric name in query results."},"name":{"type":"string","description":"Required. Metric name."},"function":{"type":"string","description":"Aggregation function: avg, min, max, or sum."},"operator":{"type":"string","description":"One of `+`, `-`, `/`, `%`, `*`."}},"description":"More info about Metric: https://docs.apigee.com/api-platform/analytics/analytics-reference#metrics"},"GoogleCloudApigeeV1FlowHook":{"title":"GoogleCloudApigeeV1FlowHook","type":"object","properties":{"continueOnError":{"type":"boolean","description":"Optional. Flag that specifies whether execution should continue if the flow hook throws an exception. Set to `true` to continue execution. Set to `false` to stop execution if the flow hook throws an exception. Defaults to `true`."},"flowHookPoint":{"type":"string","description":"Output only. Where in the API call flow the flow hook is invoked. Must be one of `PreProxyFlowHook`, `PostProxyFlowHook`, `PreTargetFlowHook`, or `PostTargetFlowHook`."},"description":{"type":"string","description":"Description of the flow hook."},"sharedFlow":{"type":"string","description":"Shared flow attached to this flow hook, or empty if there is none attached."}}},"GoogleCloudApigeeV1ResourceStatus":{"title":"GoogleCloudApigeeV1ResourceStatus","type":"object","properties":{"revisions":{"type":"array","items":{},"description":"Revisions of the resource currently deployed in the instance."},"resource":{"type":"string","description":"The resource name. Currently only two resources are supported: EnvironmentGroup - organizations/{org}/envgroups/{envgroup} EnvironmentConfig - organizations/{org}/environments/{environment}/deployedConfig"},"uid":{"type":"string","description":"The uid of the resource. In the unexpected case that the instance has multiple uids for the same name, they should be reported under separate ResourceStatuses."},"totalReplicas":{"type":"integer","description":"The total number of replicas that should have this resource.","contentEncoding":"int32"}},"description":"The status of a resource loaded in the runtime."},"GoogleCloudApigeeV1ListSecurityProfilesResponse":{"title":"GoogleCloudApigeeV1ListSecurityProfilesResponse","type":"object","properties":{"nextPageToken":{"type":"string","description":"A token that can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages."},"securityProfiles":{"type":"array","items":{"$ref":"#/components/schemas/GoogleCloudApigeeV1SecurityProfile"},"description":"List of security profiles in the organization. The profiles may be attached or unattached to any environment. This will return latest revision of each profile."}},"description":"Response for ListSecurityProfiles."},"GoogleCloudApigeeV1Datastore":{"title":"GoogleCloudApigeeV1Datastore","type":"object","properties":{"datastoreConfig":{"description":"Datastore Configurations."},"targetType":{"type":"string","description":"Destination storage type. Supported types `gcs` or `bigquery`."},"createTime":{"type":"string","description":"Output only. Datastore create time, in milliseconds since the epoch of 1970-01-01T00:00:00Z"},"lastUpdateTime":{"type":"string","description":"Output only. Datastore last update time, in milliseconds since the epoch of 1970-01-01T00:00:00Z"},"org":{"type":"string","description":"Output only. Organization that the datastore belongs to"},"displayName":{"type":"string","description":"Required. Display name in UI"},"self":{"type":"string","description":"Output only. Resource link of Datastore. Example: `/organizations/{org}/analytics/datastores/{uuid}`"}},"description":"The data store defines the connection to export data repository (Cloud Storage, BigQuery), including the credentials used to access the data repository."},"GoogleLongrunningOperation":{"title":"GoogleLongrunningOperation","type":"object","properties":{"name":{"type":"string","description":"The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`."},"done":{"type":"boolean","description":"If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available."},"error":{"description":"The error result of the operation in case of failure or cancellation."},"response":{"type":"object","additionalProperties":{},"description":"The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`."},"metadata":{"type":"object","additionalProperties":{},"description":"Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any."}},"description":"This resource represents a long-running operation that is the result of a network API call."},"GoogleCloudApigeeV1SharedFlowRevision":{"title":"GoogleCloudApigeeV1SharedFlowRevision","type":"object","properties":{"type":{"type":"string","description":"The string \"Application\""},"name":{"type":"string","description":"The resource ID of the parent shared flow."},"description":{"type":"string","description":"Description of the shared flow revision."},"createdAt":{"type":"string","description":"Time at which this shared flow revision was created, in milliseconds since epoch."},"entityMetaDataAsProperties":{"type":"object","additionalProperties":{"type":"string"},"description":"A Key-Value map of metadata about this shared flow revision."},"displayName":{"type":"string","description":"The human readable name of this shared flow."},"resources":{"type":"array","items":{"type":"string"},"description":"A list of the resources included in this shared flow revision formatted as \"{type}://{name}\"."},"revision":{"type":"string","description":"The resource ID of this revision."},"contextInfo":{"type":"string","description":"A textual description of the shared flow revision."},"sharedFlows":{"type":"array","items":{"type":"string"},"description":"A list of the shared flow names included in this shared flow revision."},"resourceFiles":{"allOf":[{"$ref":"#/components/schemas/GoogleCloudApigeeV1ResourceFiles"},{"description":"List of resource files."}]},"policies":{"type":"array","items":{"type":"string"},"description":"A list of policy names included in this shared flow revision."},"lastModifiedAt":{"type":"string","description":"Time at which this shared flow revision was most recently modified, in milliseconds since epoch."},"configurationVersion":{"allOf":[{"$ref":"#/components/schemas/GoogleCloudApigeeV1ConfigVersion"},{"description":"Version of the API proxy configuration schema. Currently, only 4.0 is supported."}]}},"description":"The metadata describing a shared flow revision."},"GoogleCloudApigeeV1StatsEnvironmentStats":{"title":"GoogleCloudApigeeV1StatsEnvironmentStats","type":"object","properties":{"dimensions":{"type":"array","items":{},"description":"List of metrics grouped under dimensions."},"metrics":{"type":"array","items":{},"description":"In the final response, only one of the following fields will be present based on the dimensions provided. If no dimensions are provided, then only top-level metrics is provided. If dimensions are included, then there will be a top-level dimensions field under environments which will contain metrics values and the dimension name. Example: ``` \"environments\": [ { \"dimensions\": [ { \"metrics\": [ { \"name\": \"sum(message_count)\", \"values\": [ \"2.14049521E8\" ] } ], \"name\": \"nit_proxy\" } ], \"name\": \"prod\" } ]``` or ```\"environments\": [ { \"metrics\": [ { \"name\": \"sum(message_count)\", \"values\": [ \"2.19026331E8\" ] } ], \"name\": \"prod\" } ]``` List of metric values."},"name":{"type":"string","description":"Name of the environment."}},"description":"Encapsulates the environment wrapper: ``` \"environments\": [ { \"metrics\": [ { \"name\": \"sum(message_count)\", \"values\": [ \"2.52056245E8\" ] } ], \"name\": \"prod\" } ]```"},"GoogleCloudApigeeV1GraphQLOperationGroup":{"title":"GoogleCloudApigeeV1GraphQLOperationGroup","type":"object","properties":{"operationConfigType":{"type":"string","description":"Flag that specifies whether the configuration is for Apigee API proxy or a remote service. Valid values include `proxy` or `remoteservice`. Defaults to `proxy`. Set to `proxy` when Apigee API proxies are associated with the API product. Set to `remoteservice` when non-Apigee proxies like Istio-Envoy are associated with the API product."},"operationConfigs":{"type":"array","items":{"$ref":"#/components/schemas/GoogleCloudApigeeV1GraphQLOperationConfig"},"description":"Required. List of operation configurations for either Apigee API proxies or other remote services that are associated with this API product."}},"description":"List of graphQL operation configuration details associated with Apigee API proxies or remote services. Remote services are non-Apigee proxies, such as Istio-Envoy."},"GoogleCloudApigeeV1AddonsConfig":{"title":"GoogleCloudApigeeV1AddonsConfig","type":"object","properties":{"apiSecurityConfig":{"description":"Configuration for the API Security add-on."},"integrationConfig":{"description":"Configuration for the Integration add-on."},"advancedApiOpsConfig":{"description":"Configuration for the Advanced API Ops add-on."},"connectorsPlatformConfig":{"description":"Configuration for the Connectors Platform add-on."},"monetizationConfig":{"description":"Configuration for the Monetization add-on."}},"description":"Add-on configurations for the Apigee organization."},"GoogleCloudApigeeV1ExportRequest":{"title":"GoogleCloudApigeeV1ExportRequest","type":"object","properties":{"csvDelimiter":{"type":"string","description":"Optional. Delimiter used in the CSV file, if `outputFormat` is set to `csv`. Defaults to the `,` (comma) character. Supported delimiter characters include comma (`,`), pipe (`|`), and tab (`\\t`)."},"outputFormat":{"type":"string","description":"Optional. Output format of the export. Valid values include: `csv` or `json`. Defaults to `json`. Note: Configure the delimiter for CSV output using the `csvDelimiter` property."},"dateRange":{"allOf":[{"$ref":"#/components/schemas/GoogleCloudApigeeV1DateRange"},{"description":"Date range of the data to export."}]},"description":{"type":"string","description":"Optional. Description of the export job."},"name":{"type":"string","description":"Required. Display name of the export job."},"datastoreName":{"type":"string","description":"Required. Name of the preconfigured datastore."}},"description":"Request body for [CreateExportRequest]"},"GoogleCloudApigeeV1TlsInfoConfig":{"title":"GoogleCloudApigeeV1TlsInfoConfig","type":"object","properties":{"keyAlias":{"type":"string","description":"Name of the alias used for client-side authentication in the following format: `organizations/{org}/environments/{env}/keystores/{keystore}/aliases/{alias}`"},"clientAuthEnabled":{"type":"boolean","description":"Flag that specifies whether client-side authentication is enabled for the target server. Enables two-way TLS."},"trustStore":{"type":"string","description":"Name of the keystore or keystore reference containing trusted certificates for the server in the following format: `organizations/{org}/environments/{env}/keystores/{keystore}` or `organizations/{org}/environments/{env}/references/{reference}`"},"enabled":{"type":"boolean","description":"Flag that specifies whether one-way TLS is enabled. Set to `true` to enable one-way TLS."},"protocols":{"type":"array","items":{"type":"string"},"description":"List of TLS protocols that are granted access."},"ignoreValidationErrors":{"type":"boolean","description":"Flag that specifies whether to ignore TLS certificate validation errors. Set to `true` to ignore errors."},"ciphers":{"type":"array","items":{"type":"string"},"description":"List of ciphers that are granted access."},"keyAliasReference":{"description":"Reference name and alias pair to use for client-side authentication."},"commonName":{"description":"Common name to validate the target server against."}}},"GoogleCloudApigeeV1RevisionStatus":{"title":"GoogleCloudApigeeV1RevisionStatus","type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/GoogleCloudApigeeV1UpdateError"},"description":"Errors reported when attempting to load this revision."},"replicas":{"type":"integer","description":"The number of replicas that have successfully loaded this revision.","contentEncoding":"int32"},"revisionId":{"type":"string","description":"The revision of the resource."},"jsonSpec":{"type":"string","description":"The json content of the resource revision. Large specs should be sent individually via the spec field to avoid hitting request size limits."}},"description":"The status of a specific resource revision."},"GoogleCloudApigeeV1Deployment":{"title":"GoogleCloudApigeeV1Deployment","type":"object","properties":{"state":{"allOf":[{"$ref":"#/components/schemas/State10"},{"description":"Current state of the deployment. **Note**: This field is displayed only when viewing deployment status."}]},"serviceAccount":{"type":"string","description":"The full resource name of Cloud IAM Service Account that this deployment is using, eg, `projects/-/serviceAccounts/{email}`."},"revision":{"type":"string","description":"API proxy revision."},"pods":{"type":"array","items":{},"description":"Status reported by runtime pods. **Note**: **This field is deprecated**. Runtime versions 1.3 and above report instance level status rather than pod status."},"routeConflicts":{"type":"array","items":{},"description":"Conflicts in the desired state routing configuration. The presence of conflicts does not cause the state to be `ERROR`, but it will mean that some of the deployment's base paths are not routed to its environment. If the conflicts change, the state will transition to `PROGRESSING` until the latest configuration is rolled out to all instances. **Note**: This field is displayed only when viewing deployment status."},"instances":{"type":"array","items":{},"description":"Status reported by each runtime instance. **Note**: This field is displayed only when viewing deployment status."},"apiProxy":{"type":"string","description":"API proxy."},"deployStartTime":{"type":"string","description":"Time the API proxy was marked `deployed` in the control plane in millisconds since epoch."},"environment":{"type":"string","description":"Environment."},"errors":{"type":"array","items":{},"description":"Errors reported for this deployment. Populated only when state == ERROR. **Note**: This field is displayed only when viewing deployment status."}}},"GoogleCloudApigeeV1InstanceAttachment":{"title":"GoogleCloudApigeeV1InstanceAttachment","type":"object","properties":{"name":{"type":"string","description":"Output only. ID of the attachment."},"environment":{"type":"string","description":"ID of the attached environment."},"createdAt":{"type":"string","description":"Output only. Time the attachment was created in milliseconds since epoch."}},"description":"InstanceAttachment represents the installation of an environment onto an instance."},"GoogleCloudApigeeV1ConnectorsPlatformConfig":{"title":"GoogleCloudApigeeV1ConnectorsPlatformConfig","type":"object","properties":{"expiresAt":{"type":"string","description":"Output only. Time at which the Connectors Platform add-on expires in milliseconds since epoch. If unspecified, the add-on will never expire."},"enabled":{"type":"boolean","description":"Flag that specifies whether the Connectors Platform add-on is enabled."}},"description":"Configuration for the Connectors Platform add-on."},"GoogleCloudApigeeV1ApiSecurityRuntimeConfig":{"title":"GoogleCloudApigeeV1ApiSecurityRuntimeConfig","type":"object","properties":{"updateTime":{"type":"string","description":"Time that the API Security Runtime configuration was updated."},"name":{"type":"string","description":"Name of the environment API Security Runtime configuration resource. Format: `organizations/{org}/environments/{env}/apiSecurityRuntimeConfig`"},"uid":{"type":"string","description":"Unique ID for the API Security Runtime configuration. The ID will only change if the environment is deleted and recreated."},"revisionId":{"type":"string","description":"Revision ID of the API Security Runtime configuration. The higher the value, the more recently the configuration was deployed."},"location":{"type":"array","items":{"type":"string"},"description":"A list of up to 5 Cloud Storage Blobs that contain SecurityActions."}},"description":"Response for GetApiSecurityRuntimeConfig[EnvironmentService.GetApiSecurityRuntimeConfig]."},"GoogleCloudApigeeV1CustomReportMetric":{"title":"GoogleCloudApigeeV1CustomReportMetric","type":"object","properties":{"function":{"type":"string","description":"aggregate function"},"name":{"type":"string","description":"name of the metric"}},"description":"This encapsulates a metric property of the form sum(message_count) where name is message_count and function is sum"},"GoogleCloudApigeeV1RuntimeConfig":{"title":"GoogleCloudApigeeV1RuntimeConfig","type":"object","properties":{"analyticsBucket":{"type":"string","description":"Cloud Storage bucket used for uploading Analytics records."},"traceBucket":{"type":"string","description":"Cloud Storage bucket used for uploading Trace records."},"tenantProjectId":{"type":"string","description":"Output only. Tenant project ID associated with the Apigee organization. The tenant project is used to host Google-managed resources that are dedicated to this Apigee organization. Clients have limited access to resources within the tenant project used to support Apigee runtime instances. Access to the tenant project is managed using SetSyncAuthorization. It can be empty if the tenant project hasn't been created yet."},"name":{"type":"string","description":"Name of the resource in the following format: `organizations/{org}/runtimeConfig`."}},"description":"Runtime configuration for the organization. Response for GetRuntimeConfig."},"GoogleCloudApigeeV1Export":{"title":"GoogleCloudApigeeV1Export","type":"object","properties":{"description":{"type":"string","description":"Description of the export job."},"created":{"type":"string","description":"Output only. Time the export job was created."},"self":{"type":"string","description":"Output only. Self link of the export job. A URI that can be used to retrieve the status of an export job. Example: `/organizations/myorg/environments/myenv/analytics/exports/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd`"},"state":{"type":"string","description":"Output only. Status of the export job. Valid values include `enqueued`, `running`, `completed`, and `failed`."},"datastoreName":{"type":"string","description":"Name of the datastore that is the destination of the export job [datastore]"},"updated":{"type":"string","description":"Output only. Time the export job was last updated."},"executionTime":{"type":"string","description":"Output only. Execution time for this export job. If the job is still in progress, it will be set to the amount of time that has elapsed since`created`, in seconds. Else, it will set to (`updated` - `created`), in seconds."},"name":{"type":"string","description":"Display name of the export job."},"error":{"type":"string","description":"Output only. Error is set when export fails"}},"description":"Details of an export job."},"GoogleCloudApigeeV1SchemaSchemaProperty":{"title":"GoogleCloudApigeeV1SchemaSchemaProperty","type":"object","properties":{"createTime":{"type":"string","description":"Time the field was created in RFC3339 string form. For example: `2016-02-26T10:23:09.592Z`."},"custom":{"type":"string","description":"Flag that specifies whether the field is standard in the dataset or a custom field created by the customer. `true` indicates that it is a custom field."},"type":{"type":"string","description":"Data type of the field."}},"description":"Properties for the schema field."},"GoogleApiHttpBody":{"title":"GoogleApiHttpBody","type":"object","properties":{"data":{"type":"string","description":"The HTTP request/response body as raw binary."},"extensions":{"type":"array","items":{},"description":"Application specific response metadata. Must be set in the first response for streaming APIs."},"contentType":{"type":"string","description":"The HTTP Content-Type header value specifying the content type of the body."}},"description":"Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page. This message can be used both in streaming and non-streaming API methods in the request as well as the response. It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body. Example: message GetResourceRequest { // A unique request id. string request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; } service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } Example with streaming methods: service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); } Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged."},"GoogleCloudApigeeV1DeploymentChangeReportRoutingChange":{"title":"GoogleCloudApigeeV1DeploymentChangeReportRoutingChange","type":"object","properties":{"description":{"type":"string","description":"Human-readable description of this routing change."},"shouldSequenceRollout":{"type":"boolean","description":"Set to `true` if using sequenced rollout would make this routing change safer. **Note**: This does not necessarily imply that automated sequenced rollout mode is supported for the operation."},"environmentGroup":{"type":"string","description":"Name of the environment group affected by this routing change."},"fromDeployment":{"description":"Base path/deployment that may stop receiving some traffic."},"toDeployment":{"description":"Base path/deployment that may start receiving that traffic. May be null if no deployment is able to receive the traffic."}},"description":"Describes a potential routing change that may occur as a result of some deployment operation."},"GoogleCloudApigeeV1ReportProperty":{"title":"GoogleCloudApigeeV1ReportProperty","type":"object","properties":{"property":{"type":"string","description":"name of the property"},"value":{"type":"array","items":{},"description":"property values"}}},"GoogleCloudApigeeV1GenerateDownloadUrlResponse":{"title":"GoogleCloudApigeeV1GenerateDownloadUrlResponse","type":"object","properties":{"downloadUri":{"type":"string","description":"The Google Cloud Storage signed URL that can be used to download the Archive zip file."}},"description":"Response for GenerateDownloadUrl method."},"GoogleCloudApigeeV1NatAddress":{"title":"GoogleCloudApigeeV1NatAddress","type":"object","properties":{"name":{"type":"string","description":"Required. Resource ID of the NAT address."},"ipAddress":{"type":"string","description":"Output only. The static IPV4 address."},"state":{"allOf":[{"$ref":"#/components/schemas/State4"},{"description":"Output only. State of the nat address."}]}},"description":"Apigee NAT(network address translation) address. A NAT address is a static external IP address used for Internet egress traffic."},"GoogleCloudApigeeV1DatastoreConfig":{"title":"GoogleCloudApigeeV1DatastoreConfig","type":"object","properties":{"bucketName":{"type":"string","description":"Name of the Cloud Storage bucket. Required for `gcs` target_type."},"path":{"type":"string","description":"Path of Cloud Storage bucket Required for `gcs` target_type."},"datasetName":{"type":"string","description":"BigQuery dataset name Required for `bigquery` target_type."},"tablePrefix":{"type":"string","description":"Prefix of BigQuery table Required for `bigquery` target_type."},"projectId":{"type":"string","description":"Required. GCP project in which the datastore exists"}},"description":"Configuration detail for datastore"},"GoogleCloudApigeeV1ListKeyValueEntriesResponse":{"title":"GoogleCloudApigeeV1ListKeyValueEntriesResponse","type":"object","properties":{"keyValueEntries":{"type":"array","items":{"$ref":"#/components/schemas/GoogleCloudApigeeV1KeyValueEntry"},"description":"One or more key value map keys and values."},"nextPageToken":{"type":"string","description":"Token that can be sent as `next_page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages."}},"description":"The request structure for listing key value map keys and its corresponding values."},"GoogleCloudApigeeV1ProvisionOrganizationRequest":{"title":"GoogleCloudApigeeV1ProvisionOrganizationRequest","type":"object","properties":{"analyticsRegion":{"type":"string","description":"Primary Cloud Platform region for analytics data storage. For valid values, see [Create an organization](https://cloud.google.com/apigee/docs/hybrid/latest/precog-provision). Defaults to `us-west1`."},"authorizedNetwork":{"type":"string","description":"Name of the customer project's VPC network. If provided, the network needs to be peered through Service Networking. If none is provided, the organization will have access only to the public internet."},"runtimeLocation":{"type":"string","description":"Cloud Platform location for the runtime instance. Defaults to zone `us-west1-a`. If a region is provided, `EVAL` organizations will use the region for automatically selecting a zone for the runtime instance."}},"description":"Request for ProvisionOrganization."},"GoogleCloudApigeeV1DebugSessionTransaction":{"title":"GoogleCloudApigeeV1DebugSessionTransaction","type":"object","properties":{"completed":{"type":"boolean","description":"Flag indicating whether a transaction is completed or not"},"point":{"type":"array","items":{"$ref":"#/components/schemas/GoogleCloudApigeeV1Point"},"description":"List of debug data collected by runtime plane at various defined points in the flow."}},"description":"A transaction contains all of the debug information of the entire message flow of an API call processed by the runtime plane. The information is collected and recorded at critical points of the message flow in the runtime apiproxy."},"GoogleCloudApigeeV1ListEnvironmentGroupsResponse":{"title":"GoogleCloudApigeeV1ListEnvironmentGroupsResponse","type":"object","properties":{"nextPageToken":{"type":"string","description":"Page token that you can include in a ListEnvironmentGroups request to retrieve the next page. If omitted, no subsequent pages exist."},"environmentGroups":{"type":"array","items":{"$ref":"#/components/schemas/GoogleCloudApigeeV1EnvironmentGroup"},"description":"EnvironmentGroups in the specified organization."}},"description":"Response for ListEnvironmentGroups."},"GoogleTypeMoney":{"title":"GoogleTypeMoney","type":"object","properties":{"currencyCode":{"type":"string","description":"The three-letter currency code defined in ISO 4217."},"nanos":{"type":"integer","description":"Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.","contentEncoding":"int32"},"units":{"type":"string","description":"The whole units of the amount. For example if `currencyCode` is `\"USD\"`, then 1 unit is one US dollar."}},"description":"Represents an amount of money with its currency type."},"GoogleCloudApigeeV1ApiProxyRevision":{"title":"GoogleCloudApigeeV1ApiProxyRevision","type":"object","properties":{"basepaths":{"type":"array","items":{"type":"string"},"description":"Base URL of the API proxy."},"sharedFlows":{"type":"array","items":{"type":"string"},"description":"List of the shared flows included in the API proxy revision."},"teams":{"type":"array","items":{"type":"string"},"description":"List of the teams included in the API proxy revision."},"contextInfo":{"type":"string","description":"Revision number, app name, and organization for the API proxy."},"spec":{"type":"string","description":"OpenAPI Specification that is associated with the API proxy. The value is set to a URL or to a path in the specification store."},"type":{"type":"string","description":"Type. Set to `Application`. Maintained for compatibility with the Apigee Edge API."},"entityMetaDataAsProperties":{"type":"object","additionalProperties":{"type":"string"},"description":"Metadata describing the API proxy revision as a key-value map."},"description":{"type":"string","description":"Description of the API proxy revision."},"integrationEndpoints":{"type":"array","items":{"type":"string"},"description":"List of IntegrationEndpoints in the '/integration-endpoints' directory of the API proxy. This is a 'manifest' setting designed to provide visibility into the contents of the API proxy."},"policies":{"type":"array","items":{"type":"string"},"description":"List of policy names included in the API proxy revision.."},"targets":{"type":"array","items":{"type":"string"},"description":"List of the targets included in the API proxy revision."},"configurationVersion":{"allOf":[{"$ref":"#/components/schemas/GoogleCloudApigeeV1ConfigVersion"},{"description":"Version of the API proxy configuration schema. Currently, only 4.0 is supported."}]},"lastModifiedAt":{"type":"string","description":"Time that the API proxy revision was last modified in milliseconds since epoch."},"proxyEndpoints":{"type":"array","items":{"type":"string"},"description":"List of ProxyEndpoints in the `/proxies` directory of the API proxy. Typically, this element is included only when the API proxy was created using the Edge UI. This is a 'manifest' setting designed to provide visibility into the contents of the API proxy."},"resources":{"type":"array","items":{"type":"string"},"description":"List of the resources included in the API proxy revision formatted as \"{type}://{name}\"."},"displayName":{"type":"string","description":"Human-readable name of the API proxy."},"name":{"type":"string","description":"Name of the API proxy."},"createdAt":{"type":"string","description":"Time that the API proxy revision was created in milliseconds since epoch."},"resourceFiles":{"allOf":[{"$ref":"#/components/schemas/GoogleCloudApigeeV1ResourceFiles"},{"description":"List of resource files."}]},"proxies":{"type":"array","items":{"type":"string"},"description":"List of proxy names included in the API proxy revision."},"revision":{"type":"string","description":"API proxy revision."},"archive":{"type":"string","description":"Output only. The archive that generated this proxy revision. This field is only present on proxy revisions that were generated by an archive. Proxies generated by archives cannot be updated, deleted, or deployed to other environments. Format: `organizations/*/environments/*/archiveDeployments/*`"},"targetServers":{"type":"array","items":{"type":"string"},"description":"List of TargetServers referenced in any TargetEndpoint in the API proxy. Typically, you will see this element only when the API proxy was created using the Edge UI. This is a 'manifest' setting designed to provide visibility into the contents of the API proxy."},"targetEndpoints":{"type":"array","items":{"type":"string"},"description":"List of TargetEndpoints in the `/targets` directory of the API proxy. Typically, this element is included only when the API proxy was created using the Edge UI. This is a 'manifest' setting designed to provide visibility into the contents of the API proxy."}},"description":"API proxy revision."},"GoogleCloudApigeeV1SchemaSchemaElement":{"title":"GoogleCloudApigeeV1SchemaSchemaElement","type":"object","properties":{"properties":{"description":"Properties for the schema field. For example: { \"createTime\": \"2016-02-26T10:23:09.592Z\", \"custom\": \"false\", \"type\": \"string\" }"},"name":{"type":"string","description":"Name of the field."}},"description":"Message type for the schema element"},"GoogleCloudApigeeV1DeveloperAppKey":{"title":"GoogleCloudApigeeV1DeveloperAppKey","type":"object","properties":{"expiresAt":{"type":"string","description":"Time the developer app expires in milliseconds since epoch."},"consumerSecret":{"type":"string","description":"Secret key."},"expiresInSeconds":{"type":"string","description":"Input only. Expiration time, in seconds, for the consumer key. If not set or left to the default value of `-1`, the API key never expires. The expiration time can't be updated after it is set."},"issuedAt":{"type":"string","description":"Time the developer app was created in milliseconds since epoch."},"status":{"type":"string","description":"Status of the credential. Valid values include `approved` or `revoked`."},"scopes":{"type":"array","items":{"type":"string"},"description":"Scopes to apply to the app. The specified scope names must already be defined for the API product that you associate with the app."},"attributes":{"type":"array","items":{"$ref":"#/components/schemas/GoogleCloudApigeeV1Attribute"},"description":"List of attributes associated with the credential."},"apiProducts":{"type":"array","items":{},"description":"List of API products for which the credential can be used. **Note**: Do not specify the list of API products when creating a consumer key and secret for a developer app. Instead, use the UpdateDeveloperAppKey API to make the association after the consumer key and secret are created."},"consumerKey":{"type":"string","description":"Consumer key."}}},"GoogleIamV1AuditConfig":{"title":"GoogleIamV1AuditConfig","type":"object","properties":{"auditLogConfigs":{"type":"array","items":{},"description":"The configuration for logging of each type of permission."},"service":{"type":"string","description":"Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services."}},"description":"Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { \"audit_configs\": [ { \"service\": \"allServices\", \"audit_log_configs\": [ { \"log_type\": \"DATA_READ\", \"exempted_members\": [ \"user:jose@example.com\" ] }, { \"log_type\": \"DATA_WRITE\" }, { \"log_type\": \"ADMIN_READ\" } ] }, { \"service\": \"sampleservice.googleapis.com\", \"audit_log_configs\": [ { \"log_type\": \"DATA_READ\" }, { \"log_type\": \"DATA_WRITE\", \"exempted_members\": [ \"user:aliya@example.com\" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging."},"GoogleIamV1SetIamPolicyRequest":{"title":"GoogleIamV1SetIamPolicyRequest","type":"object","properties":{"updateMask":{"type":"string","description":"OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only the fields in the mask will be modified. If no mask is provided, the following default mask is used: `paths: \"bindings, etag\"`"},"policy":{"allOf":[{"$ref":"#/components/schemas/GoogleIamV1Policy"},{"description":"An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { \"bindings\": [ { \"role\": \"roles/resourcemanager.organizationAdmin\", \"members\": [ \"user:mike@example.com\", \"group:admins@example.com\", \"domain:google.com\", \"serviceAccount:my-project-id@appspot.gserviceaccount.com\" ] }, { \"role\": \"roles/resourcemanager.organizationViewer\", \"members\": [ \"user:eve@example.com\" ], \"condition\": { \"title\": \"expirable access\", \"description\": \"Does not grant access after Sep 2020\", \"expression\": \"request.time < timestamp('2020-10-01T00:00:00.000Z')\", } } ], \"etag\": \"BwWWja0YfJA=\", \"version\": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/)."}]}},"description":"Request message for `SetIamPolicy` method."},"GoogleCloudApigeeV1FlowHookConfig":{"title":"GoogleCloudApigeeV1FlowHookConfig","type":"object","properties":{"name":{"type":"string","description":"Name of the flow hook in the following format: `organizations/{org}/environments/{env}/flowhooks/{point}`. Valid `point` values include: `PreProxyFlowHook`, `PostProxyFlowHook`, `PreTargetFlowHook`, and `PostTargetFlowHook`"},"sharedFlowName":{"type":"string","description":"Name of the shared flow to invoke in the following format: `organizations/{org}/sharedflows/{sharedflow}`"},"continueOnError":{"type":"boolean","description":"Flag that specifies whether the flow should abort after an error in the flow hook. Defaults to `true` (continue on error)."}}},"GoogleCloudApigeeV1Attribute":{"title":"GoogleCloudApigeeV1Attribute","type":"object","properties":{"name":{"type":"string","description":"API key of the attribute."},"value":{"type":"string","description":"Value of the attribute."}},"description":"Key-value pair to store extra metadata."},"GoogleCloudApigeeV1ApiCategoryData":{"title":"GoogleCloudApigeeV1ApiCategoryData","type":"object","properties":{"id":{"type":"string","description":"ID of the category (a UUID)."},"name":{"type":"string","description":"Name of the category."},"updateTime":{"type":"string","description":"Time the category was last modified in milliseconds since epoch."},"siteId":{"type":"string","description":"Name of the portal."}},"description":"the Api category resource."},"GoogleCloudApigeeV1DeploymentChangeReportRoutingDeployment":{"title":"GoogleCloudApigeeV1DeploymentChangeReportRoutingDeployment","type":"object","properties":{"basepath":{"type":"string","description":"Base path receiving traffic."},"apiProxy":{"type":"string","description":"Name of the deployed API proxy revision containing the base path."},"environment":{"type":"string","description":"Name of the environment in which the proxy is deployed."},"revision":{"type":"string","description":"Name of the deployed API proxy revision containing the base path."}},"description":"Tuple representing a base path and the deployment containing it."},"GoogleCloudApigeeV1ApiProxy":{"title":"GoogleCloudApigeeV1ApiProxy","type":"object","properties":{"apiProxyType":{"allOf":[{"$ref":"#/components/schemas/ApiProxyType1"},{"description":"Output only. The type of the API proxy."}]},"readOnly":{"type":"boolean","description":"Output only. Whether this proxy is read-only. A read-only proxy cannot have new revisions created through calls to CreateApiProxyRevision. A proxy is read-only if it was generated by an archive."},"metaData":{"description":"Output only. Metadata describing the API proxy."},"latestRevisionId":{"type":"string","description":"Output only. The id of the most recently created revision for this api proxy."},"name":{"type":"string","description":"Output only. Name of the API proxy."},"labels":{"type":"object","additionalProperties":{"type":"string"},"description":"User labels applied to this API Proxy."},"revision":{"type":"array","items":{"type":"string"},"description":"Output only. List of revisions defined for the API proxy."}},"description":"Metadata describing the API proxy"},"GoogleCloudApigeeV1SecurityReportQuery":{"title":"GoogleCloudApigeeV1SecurityReportQuery","type":"object","properties":{"filter":{"type":"string","description":"Boolean expression that can be used to filter data. Filter expressions can be combined using AND/OR terms and should be fully parenthesized to avoid ambiguity. See Analytics metrics, dimensions, and filters reference https://docs.apigee.com/api-platform/analytics/analytics-reference for more information on the fields available to filter on. For more information on the tokens that you use to build filter expressions, see Filter expression syntax. https://docs.apigee.com/api-platform/analytics/asynch-reports-api#filter-expression-syntax"},"displayName":{"type":"string","description":"Security Report display name which users can specify."},"groupByTimeUnit":{"type":"string","description":"Time unit used to group the result set. Valid values include: second, minute, hour, day, week, or month. If a query includes groupByTimeUnit, then the result is an aggregation based on the specified time unit and the resultant timestamp does not include milliseconds precision. If a query omits groupByTimeUnit, then the resultant timestamp includes milliseconds precision."},"metrics":{"type":"array","items":{"$ref":"#/components/schemas/GoogleCloudApigeeV1SecurityReportQueryMetric"},"description":"A list of Metrics."},"limit":{"type":"integer","description":"Maximum number of rows that can be returned in the result.","contentEncoding":"int32"},"mimeType":{"type":"string","description":"Valid values include: `csv` or `json`. Defaults to `json`. Note: Configure the delimiter for CSV output using the csvDelimiter property."},"reportDefinitionId":{"type":"string","description":"Report Definition ID."},"timeRange":{"description":"Required. Time range for the query. Can use the following predefined strings to specify the time range: `last60minutes` `last24hours` `last7days` Or, specify the timeRange as a structure describing start and end timestamps in the ISO format: yyyy-mm-ddThh:mm:ssZ. Example: \"timeRange\": { \"start\": \"2018-07-29T00:13:00Z\", \"end\": \"2018-08-01T00:18:00Z\" }"},"envgroupHostname":{"type":"string","description":"Hostname needs to be specified if query intends to run at host level. This field is only allowed when query is submitted by CreateHostSecurityReport where analytics data will be grouped by organization and hostname."},"dimensions":{"type":"array","items":{"type":"string"},"description":"A list of dimensions. https://docs.apigee.com/api-platform/analytics/analytics-reference#dimensions"},"csvDelimiter":{"type":"string","description":"Delimiter used in the CSV file, if `outputFormat` is set to `csv`. Defaults to the `,` (comma) character. Supported delimiter characters include comma (`,`), pipe (`|`), and tab (`\\t`)."}},"description":"Body structure when user makes a request to create a security report."},"GoogleCloudApigeeV1GraphQLOperationConfig":{"title":"GoogleCloudApigeeV1GraphQLOperationConfig","type":"object","properties":{"quota":{"description":"Quota parameters to be enforced for the resources, methods, and API source combination. If none are specified, quota enforcement will not be done."},"operations":{"type":"array","items":{},"description":"Required. List of GraphQL name/operation type pairs for the proxy or remote service to which quota will be applied. If only operation types are specified, the quota will be applied to all GraphQL requests irrespective of the GraphQL name. **Note**: Currently, you can specify only a single GraphQLOperation. Specifying more than one will cause the operation to fail."},"attributes":{"type":"array","items":{},"description":"Custom attributes associated with the operation."},"apiSource":{"type":"string","description":"Required. Name of the API proxy endpoint or remote service with which the GraphQL operation and quota are associated."}},"description":"Binds the resources in a proxy or remote service with the GraphQL operation and its associated quota enforcement."},"Aggregation":{"title":"Aggregation","enum":["AGGREGATION_FUNCTION_UNSPECIFIED","AVG","SUM","MIN","MAX","COUNT_DISTINCT"],"type":"string","description":"Aggregation function associated with the metric."},"ApiProxyType":{"title":"ApiProxyType","enum":["API_PROXY_TYPE_UNSPECIFIED","PROGRAMMABLE","CONFIGURABLE"],"type":"string","description":"Optional. API Proxy type supported by the environment. The type can be set when creating the Environment and cannot be changed."},"ApiProxyType1":{"title":"ApiProxyType1","enum":["API_PROXY_TYPE_UNSPECIFIED","PROGRAMMABLE","CONFIGURABLE"],"type":"string","description":"Output only. The type of the API proxy."},"BillingPeriod":{"title":"BillingPeriod","enum":["BILLING_PERIOD_UNSPECIFIED","WEEKLY","MONTHLY"],"type":"string","description":"Frequency at which the customer will be billed."},"BillingType":{"title":"BillingType","enum":["BILLING_TYPE_UNSPECIFIED","PREPAID","POSTPAID"],"type":"string","description":"Billing type."},"BillingType1":{"title":"BillingType1","enum":["BILLING_TYPE_UNSPECIFIED","SUBSCRIPTION","EVALUATION","PAYG"],"type":"string","description":"Billing type of the Apigee organization. See [Apigee pricing](https://cloud.google.com/apigee/pricing)."},"Code":{"title":"Code","enum":["OK","CANCELLED","UNKNOWN","INVALID_ARGUMENT","DEADLINE_EXCEEDED","NOT_FOUND","ALREADY_EXISTS","PERMISSION_DENIED","UNAUTHENTICATED","RESOURCE_EXHAUSTED","FAILED_PRECONDITION","ABORTED","OUT_OF_RANGE","UNIMPLEMENTED","INTERNAL","UNAVAILABLE","DATA_LOSS"],"type":"string","description":"Status code."},"ConnectionState":{"title":"ConnectionState","enum":["CONNECTION_STATE_UNSPECIFIED","UNAVAILABLE","PENDING","ACCEPTED","REJECTED","CLOSED","FROZEN","NEEDS_ATTENTION"],"type":"string","description":"Output only. State of the endpoint attachment connection to the service attachment."},"ConsumptionPricingType":{"title":"ConsumptionPricingType","enum":["CONSUMPTION_PRICING_TYPE_UNSPECIFIED","FIXED_PER_UNIT","BANDED","TIERED","STAIRSTEP"],"type":"string","description":"Pricing model used for consumption-based charges."},"DeploymentType":{"title":"DeploymentType","enum":["DEPLOYMENT_TYPE_UNSPECIFIED","PROXY","ARCHIVE"],"type":"string","description":"Optional. Deployment type supported by the environment. The deployment type can be set when creating the environment and cannot be changed. When you enable archive deployment, you will be **prevented from performing** a [subset of actions](/apigee/docs/api-platform/local-development/overview#prevented-actions) within the environment, including: * Managing the deployment of API proxy or shared flow revisions * Creating, updating, or deleting resource files * Creating, updating, or deleting target servers"},"Exporter":{"title":"Exporter","enum":["EXPORTER_UNSPECIFIED","JAEGER","CLOUD_TRACE"],"type":"string","description":"Exporter that is used to view the distributed trace captured using OpenCensus. An exporter sends traces to any backend that is capable of consuming them. Recorded spans can be exported by registered exporters."},"Exporter1":{"title":"Exporter1","enum":["EXPORTER_UNSPECIFIED","JAEGER","CLOUD_TRACE"],"type":"string","description":"Required. Exporter that is used to view the distributed trace captured using OpenCensus. An exporter sends traces to any backend that is capable of consuming them. Recorded spans can be exported by registered exporters."},"LogType":{"title":"LogType","enum":["LOG_TYPE_UNSPECIFIED","ADMIN_READ","DATA_WRITE","DATA_READ"],"type":"string","description":"The log type that this config enables."},"OperationType":{"title":"OperationType","enum":["OPERATION_TYPE_UNSPECIFIED","INSERT","DELETE","UPDATE"],"type":"string"},"Order":{"title":"Order","enum":["ORDER_UNSPECIFIED","ASCENDING","DESCENDING"],"type":"string","description":"Ordering for this aggregation in the result. For time series this is ignored since the ordering of points depends only on the timestamp, not the values."},"PaymentFundingModel":{"title":"PaymentFundingModel","enum":["PAYMENT_FUNDING_MODEL_UNSPECIFIED","PREPAID","POSTPAID"],"type":"string","description":"DEPRECATED: This field is no longer supported and will eventually be removed when Apigee Hybrid 1.5/1.6 is no longer supported. Instead, use the `billingType` field inside `DeveloperMonetizationConfig` resource. Flag that specifies the billing account type, prepaid or postpaid."},"PeeringCidrRange":{"title":"PeeringCidrRange","enum":["CIDR_RANGE_UNSPECIFIED","SLASH_16","SLASH_17","SLASH_18","SLASH_19","SLASH_20","SLASH_22","SLASH_23"],"type":"string","description":"Optional. Size of the CIDR block range that will be reserved by the instance. PAID organizations support `SLASH_16` to `SLASH_20` and defaults to `SLASH_16`. Evaluation organizations support only `SLASH_23`."},"Protocol":{"title":"Protocol","enum":["PROTOCOL_UNSPECIFIED","HTTP","GRPC"],"type":"string","description":"The protocol used by this target server."},"Protocol1":{"title":"Protocol1","enum":["PROTOCOL_UNSPECIFIED","HTTP","GRPC"],"type":"string","description":"Immutable. The protocol used by this TargetServer."},"QuotaCounterScope":{"title":"QuotaCounterScope","enum":["QUOTA_COUNTER_SCOPE_UNSPECIFIED","PROXY","OPERATION"],"type":"string","description":"Scope of the quota decides how the quota counter gets applied and evaluate for quota violation. If the Scope is set as PROXY, then all the operations defined for the APIproduct that are associated with the same proxy will share the same quota counter set at the APIproduct level, making it a global counter at a proxy level. If the Scope is set as OPERATION, then each operations get the counter set at the API product dedicated, making it a local counter. Note that, the QuotaCounterScope applies only when an operation does not have dedicated quota set for itself."},"RevenueShareType":{"title":"RevenueShareType","enum":["REVENUE_SHARE_TYPE_UNSPECIFIED","FIXED","VOLUME_BANDED"],"type":"string","description":"Method used to calculate the revenue that is shared with developers."},"RuntimeType":{"title":"RuntimeType","enum":["RUNTIME_TYPE_UNSPECIFIED","CLOUD","HYBRID"],"type":"string","description":"Required. Runtime type of the Apigee organization based on the Apigee subscription purchased."},"Sampler":{"title":"Sampler","enum":["SAMPLER_UNSPECIFIED",false,"PROBABILITY"],"type":"string","description":"Sampler of distributed tracing. OFF is the default value."},"State":{"title":"State","enum":["STATE_UNSPECIFIED","DRAFT","PUBLISHED"],"type":"string","description":"Current state of the rate plan (draft or published)."},"State1":{"title":"State1","enum":["STATE_UNSPECIFIED","CREATING","ACTIVE","DELETING","UPDATING"],"type":"string","description":"Output only. State of the endpoint attachment. Values other than `ACTIVE` mean the resource is not ready to use."},"State2":{"title":"State2","enum":["STATE_UNSPECIFIED","NOT_STARTED","IN_PROGRESS","FINISHED"],"type":"string"},"State3":{"title":"State3","enum":["STATE_UNSPECIFIED","NOT_STARTED","IN_PROGRESS","FINISHED"],"type":"string","description":"State of the operation."},"State4":{"title":"State4","enum":["STATE_UNSPECIFIED","CREATING","RESERVED","ACTIVE","DELETING"],"type":"string","description":"Output only. State of the nat address."},"State5":{"title":"State5","enum":["STATE_UNSPECIFIED","CREATING","ACTIVE","DELETING","UPDATING"],"type":"string","description":"Output only. State of the environment group. Values other than ACTIVE means the resource is not ready to use."},"State6":{"title":"State6","enum":["STATE_UNSPECIFIED","CREATING","ACTIVE","DELETING","UPDATING"],"type":"string","description":"Output only. State of the instance. Values other than `ACTIVE` means the resource is not ready to use."},"State7":{"title":"State7","enum":["STATE_UNSPECIFIED","CREATING","ACTIVE","DELETING","UPDATING"],"type":"string","description":"Output only. State of the environment. Values other than ACTIVE means the resource is not ready to use."},"State8":{"title":"State8","enum":["STATE_UNSPECIFIED","CREATING","ACTIVE","DELETING","UPDATING"],"type":"string","description":"Output only. State of the organization. Values other than ACTIVE means the resource is not ready to use."},"State9":{"title":"State9","enum":["STATE_UNSPECIFIED","RUNNING","SUCCEEDED"],"type":"string","description":"Output only. The current state of the canary evaluation."},"State10":{"title":"State10","enum":["RUNTIME_STATE_UNSPECIFIED","READY","PROGRESSING","ERROR"],"type":"string","description":"Current state of the deployment. **Note**: This field is displayed only when viewing deployment status."},"SubscriptionType":{"title":"SubscriptionType","enum":["SUBSCRIPTION_TYPE_UNSPECIFIED","PAID","TRIAL"],"type":"string","description":"Output only. DEPRECATED: This will eventually be replaced by BillingType. Subscription type of the Apigee organization. Valid values include trial (free, limited, and for evaluation purposes only) or paid (full subscription has been purchased). See [Apigee pricing](https://cloud.google.com/apigee/pricing/)."},"TimestampOrder":{"title":"TimestampOrder","enum":["ORDER_UNSPECIFIED","ASCENDING","DESCENDING"],"type":"string","description":"Order the sequences in increasing or decreasing order of timestamps. Default is descending order of timestamps (latest first)."},"Type":{"title":"Type","enum":["TYPE_UNSPECIFIED","INTEGER","FLOAT","STRING","BOOLEAN","DATETIME"],"type":"string","description":"Immutable. The type of data this data collector will collect."},"Type1":{"title":"Type1","enum":["TYPE_UNSPECIFIED","INTEGER","FLOAT","STRING","BOOLEAN","DATETIME"],"type":"string","description":"Data type accepted by the data collector."},"Type2":{"title":"Type2","enum":["ALIAS_TYPE_UNSPECIFIED","CERT","KEY_CERT"],"type":"string"},"Type3":{"title":"Type3","enum":["ALIAS_TYPE_UNSPECIFIED","CERT","KEY_CERT"],"type":"string","description":"Type of alias."},"Type4":{"title":"Type4","enum":["TYPE_UNSPECIFIED","TYPE_TRIAL","TYPE_PAID","TYPE_INTERNAL"],"type":"string","description":"Not used by Apigee."},"Verdict":{"title":"Verdict","enum":["VERDICT_UNSPECIFIED","NONE","FAIL","PASS"],"type":"string","description":"Output only. The resulting verdict of the canary evaluations: NONE, PASS, or FAIL."},"WindowSize":{"title":"WindowSize","enum":["WINDOW_SIZE_UNSPECIFIED","MINUTE","HOUR","DAY","MONTH"],"type":"string","description":"Time buckets to group the stats by."}},"securitySchemes":{"httpBearer":{"type":"http","scheme":"bearer"}}},"security":[{"httpBearer":[]}],"tags":[{"name":"projects","description":""},{"name":"issuers","description":""},{"name":"attachments","description":""},{"name":"envgroups","description":""},{"name":"hostQueries","description":""},{"name":"apicategories","description":""},{"name":"balance","description":""},{"name":"attributes","description":""},{"name":"apiproducts","description":""},{"name":"create","description":""},{"name":"keys","description":""},{"name":"apps","description":""},{"name":"subscriptions","description":""},{"name":"developers","description":""},{"name":"deployments","description":""},{"name":"revisions","description":""},{"name":"sharedflows","description":""},{"name":"natAddresses","description":""},{"name":"canaryevaluations","description":""},{"name":"instances","description":""},{"name":"environments","description":""},{"name":"securityProfiles","description":""},{"name":"hostSecurityReports","description":""},{"name":"operations","description":""},{"name":"datacollectors","description":""},{"name":"reports","description":""},{"name":"entries","description":""},{"name":"keyvaluemaps","description":""},{"name":"hostStats","description":""},{"name":"apis","description":""},{"name":"datastores","description":""},{"name":"optimizedHostStats","description":""},{"name":"rateplans","description":""},{"name":"references","description":""},{"name":"caches","description":""},{"name":"securityStats","description":""},{"name":"queries","description":""},{"name":"data","description":""},{"name":"debugsessions","description":""},{"name":"aliases","description":""},{"name":"keystores","description":""},{"name":"overrides","description":""},{"name":"targetservers","description":""},{"name":"archiveDeployments","description":""},{"name":"resourcefiles","description":""},{"name":"admin","description":""},{"name":"exports","description":""},{"name":"stats","description":""},{"name":"flowhooks","description":""},{"name":"securityReports","description":""},{"name":"optimizedStats","description":""},{"name":"endpointAttachments","description":""},{"name":"organizations","description":""}]}
/ v1 / {project}:provisionOrganization
/ v1 / {name}
/ v1 / {parent} / attachments
/ v1 / {parent} / envgroups
/ v1 / {parent} / hostQueries
/ v1 / {parent} / apicategories
/ v1 / {name}:credit
/ v1 / {name}:adjust
/ v1 / {parent} / attributes
/ v1 / {name} / attributes
/ v1 / {parent} / apiproducts
/ v1 / {parent} / keys / create
/ v1 / {parent} / keys
/ v1 / {parent} / apps
/ v1 / {parent} / subscriptions
/ v1 / {name}:expire
/ v1 / {parent} / developers
/ v1 / {parent} / deployments
/ v1 / {name} / deployments:generateDeployChangeReport
/ v1 / {name} / deployments:generateUndeployChangeReport
/ v1 / {name} / deployments
/ v1 / {parent} / sharedflows
/ v1 / {name}:activate
/ v1 / {parent} / natAddresses
/ v1 / {parent} / canaryevaluations
/ v1 / {parent} / instances
/ v1 / {instance}:reportStatus
/ v1 / {profileEnvironment}:computeEnvironmentScores
/ v1 / {parent} / environments
/ v1 / {parent}:subscribe
/ v1 / {resource}:getIamPolicy
/ v1 / {parent}:unsubscribe
/ v1 / {resource}:setIamPolicy
/ v1 / {resource}:testIamPermissions
/ v1 / {parent} / securityProfiles
/ v1 / {name}:listRevisions
/ v1 / {parent} / hostSecurityReports
/ v1 / {name} / operations
/ v1 / {parent} / datacollectors
/ v1 / {parent} / reports
/ v1 / {parent} / entries
/ v1 / {parent} / keyvaluemaps
/ v1 / {parent} / apis
/ v1 / {parent} / analytics / datastores
/ v1 / {parent} / analytics / datastores:test
/ v1 / {parent} / rateplans
/ v1 / {parent} / references
/ v1 / {orgenv} / securityStats:queryTabularStats
/ v1 / {orgenv} / securityStats:queryTimeSeriesStats
/ v1 / {parent} / queries
/ v1 / {parent} / debugsessions
/ v1 / {name} / data
/ v1 / {parent} / aliases
/ v1 / {name} / csr
/ v1 / {name} / certificate
/ v1 / {parent} / keystores
/ v1 / {parent} / overrides
/ v1 / {parent} / targetservers
/ v1 / {parent} / archiveDeployments
/ v1 / {name}:generateDownloadUrl
/ v1 / {parent} / archiveDeployments:generateUploadUrl
/ v1 / {parent} / resourcefiles / {type} / {name}
/ v1 / {parent} / resourcefiles / {type}
/ v1 / {parent} / resourcefiles
/ v1 / {parent} / analytics / exports
/ v1 / {parent} / securityReports
/ v1 / {parent} / endpointAttachments
/ v1 / {name}:setSyncAuthorization
/ v1 / {name}:getProjectMapping
/ v1 / {parent}
/ v1 / {name}:getSyncAuthorization
/ v1 / organizations
/ v1 / {org}:setAddons
Connectors API OpenAPI	{"openapi":"3.1.0","info":{"title":"Connectors API","description":"Enables users to create and manage connections to Google Cloud services and third-party business applications using the Connectors interface.","contact":{},"version":"v1"},"jsonSchemaDialect":"https://json-schema.org/draft/2020-12/schema","servers":[{"url":"https://connectors.googleapis.com/","variables":{}}],"paths":{"/v1/{name}":{"delete":{"tags":["operations"],"summary":"DeleteV1ByName","description":"Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.","operationId":"DeleteV1ByName","parameters":[{"name":"prettyPrint","in":"query","description":"Returns response with indentations and line breaks.","style":"form","explode":true,"schema":{"type":"boolean","default":true}},{"name":"alt","in":"query","description":"Data format for response. (Acceptable values are: \"json\", \"media\", \"proto\")","style":"form","explode":true,"schema":{"type":"string","default":"json"}},{"name":"access_token","in":"query","description":"OAuth access token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"callback","in":"query","description":"JSONP","style":"form","explode":true,"schema":{"type":"string"}},{"name":"key","in":"query","description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"uploadType","in":"query","description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"oauth_token","in":"query","description":"OAuth 2.0 token for the current user.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"quotaUser","in":"query","description":"Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"upload_protocol","in":"query","description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"Selector specifying which fields to include in a partial response.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"$.xgafv","in":"query","description":"V1 error format. (Acceptable values are: \"1\", \"2\")","style":"form","explode":true,"schema":{"type":"string","default":"1"}},{"name":"name","in":"path","description":"The name of the operation resource to be deleted.","required":true,"style":"simple","schema":{"pattern":"^projects/[^/]+/locations/[^/]+/operations/[^/]+$","type":"string"}}],"responses":{"200":{"description":"","headers":{},"content":{"text/plain":{"schema":{"type":"object","contentMediaType":"text/plain"}}}}},"deprecated":false,"security":[{"httpBearer":["https://www.googleapis.com/auth/cloud-platform"]}]},"get":{"tags":["operations"],"summary":"GetV1ByName","description":"Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.","operationId":"GetV1ByName","parameters":[{"name":"prettyPrint","in":"query","description":"Returns response with indentations and line breaks.","style":"form","explode":true,"schema":{"type":"boolean","default":true}},{"name":"alt","in":"query","description":"Data format for response. (Acceptable values are: \"json\", \"media\", \"proto\")","style":"form","explode":true,"schema":{"type":"string","default":"json"}},{"name":"access_token","in":"query","description":"OAuth access token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"callback","in":"query","description":"JSONP","style":"form","explode":true,"schema":{"type":"string"}},{"name":"key","in":"query","description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"uploadType","in":"query","description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"oauth_token","in":"query","description":"OAuth 2.0 token for the current user.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"quotaUser","in":"query","description":"Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"upload_protocol","in":"query","description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"Selector specifying which fields to include in a partial response.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"$.xgafv","in":"query","description":"V1 error format. (Acceptable values are: \"1\", \"2\")","style":"form","explode":true,"schema":{"type":"string","default":"1"}},{"name":"name","in":"path","description":"The name of the operation resource.","required":true,"style":"simple","schema":{"pattern":"^projects/[^/]+/locations/[^/]+/operations/[^/]+$","type":"string"}}],"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Operation"}}}}},"deprecated":false,"security":[{"httpBearer":["https://www.googleapis.com/auth/cloud-platform"]}]},"patch":{"tags":["connections"],"summary":"PatchV1ByName","description":"Updates the parameters of a single Connection.","operationId":"PatchV1ByName","parameters":[{"name":"prettyPrint","in":"query","description":"Returns response with indentations and line breaks.","style":"form","explode":true,"schema":{"type":"boolean","default":true}},{"name":"alt","in":"query","description":"Data format for response. (Acceptable values are: \"json\", \"media\", \"proto\")","style":"form","explode":true,"schema":{"type":"string","default":"json"}},{"name":"access_token","in":"query","description":"OAuth access token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"callback","in":"query","description":"JSONP","style":"form","explode":true,"schema":{"type":"string"}},{"name":"key","in":"query","description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"uploadType","in":"query","description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"oauth_token","in":"query","description":"OAuth 2.0 token for the current user.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"quotaUser","in":"query","description":"Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"upload_protocol","in":"query","description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"Selector specifying which fields to include in a partial response.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"$.xgafv","in":"query","description":"V1 error format. (Acceptable values are: \"1\", \"2\")","style":"form","explode":true,"schema":{"type":"string","default":"1"}},{"name":"name","in":"path","description":"Output only. Resource name of the Connection. Format: projects/{project}/locations/{location}/connections/{connection}","required":true,"style":"simple","schema":{"pattern":"^projects/[^/]+/locations/[^/]+/connections/[^/]+$","type":"string"}},{"name":"updateMask","in":"query","description":"Required. You can modify only the fields listed below. To lock/unlock a connection: * `lock_config` To suspend/resume a connection: * `suspended` To update the connection details: * `description` * `labels` * `connector_version` * `config_variables` * `auth_config` * `destination_configs` * `node_config`","style":"form","explode":true,"schema":{"type":"string"}}],"requestBody":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Connection"}}},"required":true},"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Operation"}}}}},"deprecated":false,"security":[{"httpBearer":["https://www.googleapis.com/auth/cloud-platform"]}]},"parameters":[]},"/v1/{name}:cancel":{"post":{"tags":["operations"],"summary":"CancelV1CancelByName","description":"Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.","operationId":"CancelV1CancelByName","parameters":[{"name":"prettyPrint","in":"query","description":"Returns response with indentations and line breaks.","style":"form","explode":true,"schema":{"type":"boolean","default":true}},{"name":"alt","in":"query","description":"Data format for response. (Acceptable values are: \"json\", \"media\", \"proto\")","style":"form","explode":true,"schema":{"type":"string","default":"json"}},{"name":"access_token","in":"query","description":"OAuth access token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"callback","in":"query","description":"JSONP","style":"form","explode":true,"schema":{"type":"string"}},{"name":"key","in":"query","description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"uploadType","in":"query","description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"oauth_token","in":"query","description":"OAuth 2.0 token for the current user.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"quotaUser","in":"query","description":"Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"upload_protocol","in":"query","description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"Selector specifying which fields to include in a partial response.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"$.xgafv","in":"query","description":"V1 error format. (Acceptable values are: \"1\", \"2\")","style":"form","explode":true,"schema":{"type":"string","default":"1"}},{"name":"name","in":"path","description":"The name of the operation resource to be cancelled.","required":true,"style":"simple","schema":{"pattern":"^projects/[^/]+/locations/[^/]+/operations/[^/]+$","type":"string"}}],"requestBody":{"description":"","content":{"text/plain":{"schema":{"type":"object","contentMediaType":"text/plain"}}},"required":true},"responses":{"200":{"description":"","headers":{},"content":{"text/plain":{"schema":{"type":"object","contentMediaType":"text/plain"}}}}},"deprecated":false,"security":[{"httpBearer":["https://www.googleapis.com/auth/cloud-platform"]}]},"parameters":[]},"/v1/{name}/operations":{"get":{"tags":["operations"],"summary":"ListV1OperationsByName","description":"Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services to override the binding to use different resource name schemes, such as `users/*/operations`. To override the binding, API services can add a binding such as `\"/v1/{name=users/*}/operations\"` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.","operationId":"ListV1OperationsByName","parameters":[{"name":"prettyPrint","in":"query","description":"Returns response with indentations and line breaks.","style":"form","explode":true,"schema":{"type":"boolean","default":true}},{"name":"alt","in":"query","description":"Data format for response. (Acceptable values are: \"json\", \"media\", \"proto\")","style":"form","explode":true,"schema":{"type":"string","default":"json"}},{"name":"access_token","in":"query","description":"OAuth access token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"callback","in":"query","description":"JSONP","style":"form","explode":true,"schema":{"type":"string"}},{"name":"key","in":"query","description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"uploadType","in":"query","description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"oauth_token","in":"query","description":"OAuth 2.0 token for the current user.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"quotaUser","in":"query","description":"Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"upload_protocol","in":"query","description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"Selector specifying which fields to include in a partial response.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"$.xgafv","in":"query","description":"V1 error format. (Acceptable values are: \"1\", \"2\")","style":"form","explode":true,"schema":{"type":"string","default":"1"}},{"name":"name","in":"path","description":"The name of the operation's parent resource.","required":true,"style":"simple","schema":{"pattern":"^projects/[^/]+/locations/[^/]+$","type":"string"}},{"name":"filter","in":"query","description":"The standard list filter.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"pageToken","in":"query","description":"The standard list page token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"pageSize","in":"query","description":"The standard list page size.","style":"form","explode":true,"schema":{"type":"integer","contentEncoding":"int32"}}],"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListOperationsResponse"}}}}},"deprecated":false,"security":[{"httpBearer":["https://www.googleapis.com/auth/cloud-platform"]}]},"parameters":[]},"/v1/{parent}/versions":{"get":{"tags":["versions"],"summary":"ListV1VersionsByParent","description":"Lists Connector Versions in a given project and location.","operationId":"ListV1VersionsByParent","parameters":[{"name":"prettyPrint","in":"query","description":"Returns response with indentations and line breaks.","style":"form","explode":true,"schema":{"type":"boolean","default":true}},{"name":"alt","in":"query","description":"Data format for response. (Acceptable values are: \"json\", \"media\", \"proto\")","style":"form","explode":true,"schema":{"type":"string","default":"json"}},{"name":"access_token","in":"query","description":"OAuth access token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"callback","in":"query","description":"JSONP","style":"form","explode":true,"schema":{"type":"string"}},{"name":"key","in":"query","description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"uploadType","in":"query","description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"oauth_token","in":"query","description":"OAuth 2.0 token for the current user.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"quotaUser","in":"query","description":"Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"upload_protocol","in":"query","description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"Selector specifying which fields to include in a partial response.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"$.xgafv","in":"query","description":"V1 error format. (Acceptable values are: \"1\", \"2\")","style":"form","explode":true,"schema":{"type":"string","default":"1"}},{"name":"view","in":"query","description":"Specifies which fields of the ConnectorVersion are returned in the response. Defaults to `BASIC` view. (Acceptable values are: \"CONNECTOR_VERSION_VIEW_UNSPECIFIED\", \"CONNECTOR_VERSION_VIEW_BASIC\", \"CONNECTOR_VERSION_VIEW_FULL\")","style":"form","explode":true,"schema":{"type":"string","default":"CONNECTOR_VERSION_VIEW_UNSPECIFIED"}},{"name":"parent","in":"path","description":"Required. Parent resource of the connectors, of the form: `projects/*/locations/*/providers/*/connectors/*` Only global location is supported for ConnectorVersion resource.","required":true,"style":"simple","schema":{"pattern":"^projects/[^/]+/locations/[^/]+/providers/[^/]+/connectors/[^/]+$","type":"string"}},{"name":"pageSize","in":"query","description":"Page size.","style":"form","explode":true,"schema":{"type":"integer","contentEncoding":"int32"}},{"name":"pageToken","in":"query","description":"Page token.","style":"form","explode":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListConnectorVersionsResponse"}}}}},"deprecated":false,"security":[{"httpBearer":["https://www.googleapis.com/auth/cloud-platform"]}]},"parameters":[]},"/v1/{parent}/connectors":{"get":{"tags":["connectors"],"summary":"ListV1ConnectorsByParent","description":"Lists Connectors in a given project and location.","operationId":"ListV1ConnectorsByParent","parameters":[{"name":"prettyPrint","in":"query","description":"Returns response with indentations and line breaks.","style":"form","explode":true,"schema":{"type":"boolean","default":true}},{"name":"alt","in":"query","description":"Data format for response. (Acceptable values are: \"json\", \"media\", \"proto\")","style":"form","explode":true,"schema":{"type":"string","default":"json"}},{"name":"access_token","in":"query","description":"OAuth access token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"callback","in":"query","description":"JSONP","style":"form","explode":true,"schema":{"type":"string"}},{"name":"key","in":"query","description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"uploadType","in":"query","description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"oauth_token","in":"query","description":"OAuth 2.0 token for the current user.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"quotaUser","in":"query","description":"Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"upload_protocol","in":"query","description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"Selector specifying which fields to include in a partial response.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"$.xgafv","in":"query","description":"V1 error format. (Acceptable values are: \"1\", \"2\")","style":"form","explode":true,"schema":{"type":"string","default":"1"}},{"name":"parent","in":"path","description":"Required. Parent resource of the connectors, of the form: `projects/*/locations/*/providers/*` Only global location is supported for Connector resource.","required":true,"style":"simple","schema":{"pattern":"^projects/[^/]+/locations/[^/]+/providers/[^/]+$","type":"string"}},{"name":"pageSize","in":"query","description":"Page size.","style":"form","explode":true,"schema":{"type":"integer","contentEncoding":"int32"}},{"name":"pageToken","in":"query","description":"Page token.","style":"form","explode":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListConnectorsResponse"}}}}},"deprecated":false,"security":[{"httpBearer":["https://www.googleapis.com/auth/cloud-platform"]}]},"parameters":[]},"/v1/{resource}:testIamPermissions":{"post":{"tags":["providers"],"summary":"TestIamPermissionsV1TestIamPermissionsByResource","description":"Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.","operationId":"TestIamPermissionsV1TestIamPermissionsByResource","parameters":[{"name":"prettyPrint","in":"query","description":"Returns response with indentations and line breaks.","style":"form","explode":true,"schema":{"type":"boolean","default":true}},{"name":"alt","in":"query","description":"Data format for response. (Acceptable values are: \"json\", \"media\", \"proto\")","style":"form","explode":true,"schema":{"type":"string","default":"json"}},{"name":"access_token","in":"query","description":"OAuth access token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"callback","in":"query","description":"JSONP","style":"form","explode":true,"schema":{"type":"string"}},{"name":"key","in":"query","description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"uploadType","in":"query","description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"oauth_token","in":"query","description":"OAuth 2.0 token for the current user.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"quotaUser","in":"query","description":"Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"upload_protocol","in":"query","description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"Selector specifying which fields to include in a partial response.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"$.xgafv","in":"query","description":"V1 error format. (Acceptable values are: \"1\", \"2\")","style":"form","explode":true,"schema":{"type":"string","default":"1"}},{"name":"resource","in":"path","description":"REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.","required":true,"style":"simple","schema":{"pattern":"^projects/[^/]+/locations/[^/]+/providers/[^/]+$","type":"string"}}],"requestBody":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TestIamPermissionsRequest"}}},"required":true},"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TestIamPermissionsResponse"}}}}},"deprecated":false,"security":[{"httpBearer":["https://www.googleapis.com/auth/cloud-platform"]}]},"parameters":[]},"/v1/{resource}:getIamPolicy":{"get":{"tags":["providers"],"summary":"GetIamPolicyV1GetIamPolicyByResource","description":"Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.","operationId":"GetIamPolicyV1GetIamPolicyByResource","parameters":[{"name":"prettyPrint","in":"query","description":"Returns response with indentations and line breaks.","style":"form","explode":true,"schema":{"type":"boolean","default":true}},{"name":"alt","in":"query","description":"Data format for response. (Acceptable values are: \"json\", \"media\", \"proto\")","style":"form","explode":true,"schema":{"type":"string","default":"json"}},{"name":"access_token","in":"query","description":"OAuth access token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"callback","in":"query","description":"JSONP","style":"form","explode":true,"schema":{"type":"string"}},{"name":"key","in":"query","description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"uploadType","in":"query","description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"oauth_token","in":"query","description":"OAuth 2.0 token for the current user.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"quotaUser","in":"query","description":"Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"upload_protocol","in":"query","description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"Selector specifying which fields to include in a partial response.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"$.xgafv","in":"query","description":"V1 error format. (Acceptable values are: \"1\", \"2\")","style":"form","explode":true,"schema":{"type":"string","default":"1"}},{"name":"options.requestedPolicyVersion","in":"query","description":"Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).","style":"form","explode":true,"schema":{"type":"integer","contentEncoding":"int32"}},{"name":"resource","in":"path","description":"REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.","required":true,"style":"simple","schema":{"pattern":"^projects/[^/]+/locations/[^/]+/providers/[^/]+$","type":"string"}}],"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Policy"}}}}},"deprecated":false,"security":[{"httpBearer":["https://www.googleapis.com/auth/cloud-platform"]}]},"parameters":[]},"/v1/{parent}/providers":{"get":{"tags":["providers"],"summary":"ListV1ProvidersByParent","description":"Lists Providers in a given project and location.","operationId":"ListV1ProvidersByParent","parameters":[{"name":"prettyPrint","in":"query","description":"Returns response with indentations and line breaks.","style":"form","explode":true,"schema":{"type":"boolean","default":true}},{"name":"alt","in":"query","description":"Data format for response. (Acceptable values are: \"json\", \"media\", \"proto\")","style":"form","explode":true,"schema":{"type":"string","default":"json"}},{"name":"access_token","in":"query","description":"OAuth access token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"callback","in":"query","description":"JSONP","style":"form","explode":true,"schema":{"type":"string"}},{"name":"key","in":"query","description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"uploadType","in":"query","description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"oauth_token","in":"query","description":"OAuth 2.0 token for the current user.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"quotaUser","in":"query","description":"Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"upload_protocol","in":"query","description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"Selector specifying which fields to include in a partial response.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"$.xgafv","in":"query","description":"V1 error format. (Acceptable values are: \"1\", \"2\")","style":"form","explode":true,"schema":{"type":"string","default":"1"}},{"name":"pageSize","in":"query","description":"Page size.","style":"form","explode":true,"schema":{"type":"integer","contentEncoding":"int32"}},{"name":"pageToken","in":"query","description":"Page token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"parent","in":"path","description":"Required. Parent resource of the API, of the form: `projects/*/locations/*` Only global location is supported for Provider resource.","required":true,"style":"simple","schema":{"pattern":"^projects/[^/]+/locations/[^/]+$","type":"string"}}],"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListProvidersResponse"}}}}},"deprecated":false,"security":[{"httpBearer":["https://www.googleapis.com/auth/cloud-platform"]}]},"parameters":[]},"/v1/{resource}:setIamPolicy":{"post":{"tags":["providers"],"summary":"SetIamPolicyV1SetIamPolicyByResource","description":"Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.","operationId":"SetIamPolicyV1SetIamPolicyByResource","parameters":[{"name":"prettyPrint","in":"query","description":"Returns response with indentations and line breaks.","style":"form","explode":true,"schema":{"type":"boolean","default":true}},{"name":"alt","in":"query","description":"Data format for response. (Acceptable values are: \"json\", \"media\", \"proto\")","style":"form","explode":true,"schema":{"type":"string","default":"json"}},{"name":"access_token","in":"query","description":"OAuth access token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"callback","in":"query","description":"JSONP","style":"form","explode":true,"schema":{"type":"string"}},{"name":"key","in":"query","description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"uploadType","in":"query","description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"oauth_token","in":"query","description":"OAuth 2.0 token for the current user.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"quotaUser","in":"query","description":"Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"upload_protocol","in":"query","description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"Selector specifying which fields to include in a partial response.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"$.xgafv","in":"query","description":"V1 error format. (Acceptable values are: \"1\", \"2\")","style":"form","explode":true,"schema":{"type":"string","default":"1"}},{"name":"resource","in":"path","description":"REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.","required":true,"style":"simple","schema":{"pattern":"^projects/[^/]+/locations/[^/]+/providers/[^/]+$","type":"string"}}],"requestBody":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SetIamPolicyRequest"}}},"required":true},"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Policy"}}}}},"deprecated":false,"security":[{"httpBearer":["https://www.googleapis.com/auth/cloud-platform"]}]},"parameters":[]},"/v1/{parent}/runtimeActionSchemas":{"get":{"tags":["runtimeActionSchemas"],"summary":"ListV1RuntimeActionSchemasByParent","description":"List schema of a runtime actions filtered by action name.","operationId":"ListV1RuntimeActionSchemasByParent","parameters":[{"name":"prettyPrint","in":"query","description":"Returns response with indentations and line breaks.","style":"form","explode":true,"schema":{"type":"boolean","default":true}},{"name":"alt","in":"query","description":"Data format for response. (Acceptable values are: \"json\", \"media\", \"proto\")","style":"form","explode":true,"schema":{"type":"string","default":"json"}},{"name":"access_token","in":"query","description":"OAuth access token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"callback","in":"query","description":"JSONP","style":"form","explode":true,"schema":{"type":"string"}},{"name":"key","in":"query","description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"uploadType","in":"query","description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"oauth_token","in":"query","description":"OAuth 2.0 token for the current user.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"quotaUser","in":"query","description":"Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"upload_protocol","in":"query","description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"Selector specifying which fields to include in a partial response.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"$.xgafv","in":"query","description":"V1 error format. (Acceptable values are: \"1\", \"2\")","style":"form","explode":true,"schema":{"type":"string","default":"1"}},{"name":"parent","in":"path","description":"Required. Parent resource of RuntimeActionSchema Format: projects/{project}/locations/{location}/connections/{connection}","required":true,"style":"simple","schema":{"pattern":"^projects/[^/]+/locations/[^/]+/connections/[^/]+$","type":"string"}},{"name":"filter","in":"query","description":"Required. Filter Format: action=\"{actionId}\" Only action field is supported with literal equality operator. Accepted filter example: action=\"CancelOrder\" Wildcards are not supported in the filter currently.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"pageSize","in":"query","description":"Page size.","style":"form","explode":true,"schema":{"type":"integer","contentEncoding":"int32"}},{"name":"pageToken","in":"query","description":"Page token.","style":"form","explode":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListRuntimeActionSchemasResponse"}}}}},"deprecated":false,"security":[{"httpBearer":["https://www.googleapis.com/auth/cloud-platform"]}]},"parameters":[]},"/v1/{parent}/runtimeEntitySchemas":{"get":{"tags":["runtimeEntitySchemas"],"summary":"ListV1RuntimeEntitySchemasByParent","description":"List schema of a runtime entities filtered by entity name.","operationId":"ListV1RuntimeEntitySchemasByParent","parameters":[{"name":"prettyPrint","in":"query","description":"Returns response with indentations and line breaks.","style":"form","explode":true,"schema":{"type":"boolean","default":true}},{"name":"alt","in":"query","description":"Data format for response. (Acceptable values are: \"json\", \"media\", \"proto\")","style":"form","explode":true,"schema":{"type":"string","default":"json"}},{"name":"access_token","in":"query","description":"OAuth access token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"callback","in":"query","description":"JSONP","style":"form","explode":true,"schema":{"type":"string"}},{"name":"key","in":"query","description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"uploadType","in":"query","description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"oauth_token","in":"query","description":"OAuth 2.0 token for the current user.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"quotaUser","in":"query","description":"Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"upload_protocol","in":"query","description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"Selector specifying which fields to include in a partial response.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"$.xgafv","in":"query","description":"V1 error format. (Acceptable values are: \"1\", \"2\")","style":"form","explode":true,"schema":{"type":"string","default":"1"}},{"name":"filter","in":"query","description":"Required. Filter Format: entity=\"{entityId}\" Only entity field is supported with literal equality operator. Accepted filter example: entity=\"Order\" Wildcards are not supported in the filter currently.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"parent","in":"path","description":"Required. Parent resource of RuntimeEntitySchema Format: projects/{project}/locations/{location}/connections/{connection}","required":true,"style":"simple","schema":{"pattern":"^projects/[^/]+/locations/[^/]+/connections/[^/]+$","type":"string"}},{"name":"pageToken","in":"query","description":"Page token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"pageSize","in":"query","description":"Page size.","style":"form","explode":true,"schema":{"type":"integer","contentEncoding":"int32"}}],"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListRuntimeEntitySchemasResponse"}}}}},"deprecated":false,"security":[{"httpBearer":["https://www.googleapis.com/auth/cloud-platform"]}]},"parameters":[]},"/v1/{parent}/connections":{"post":{"tags":["connections"],"summary":"CreateV1ConnectionsByParent","description":"Creates a new Connection in a given project and location.","operationId":"CreateV1ConnectionsByParent","parameters":[{"name":"prettyPrint","in":"query","description":"Returns response with indentations and line breaks.","style":"form","explode":true,"schema":{"type":"boolean","default":true}},{"name":"alt","in":"query","description":"Data format for response. (Acceptable values are: \"json\", \"media\", \"proto\")","style":"form","explode":true,"schema":{"type":"string","default":"json"}},{"name":"access_token","in":"query","description":"OAuth access token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"callback","in":"query","description":"JSONP","style":"form","explode":true,"schema":{"type":"string"}},{"name":"key","in":"query","description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"uploadType","in":"query","description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"oauth_token","in":"query","description":"OAuth 2.0 token for the current user.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"quotaUser","in":"query","description":"Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"upload_protocol","in":"query","description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"Selector specifying which fields to include in a partial response.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"$.xgafv","in":"query","description":"V1 error format. (Acceptable values are: \"1\", \"2\")","style":"form","explode":true,"schema":{"type":"string","default":"1"}},{"name":"parent","in":"path","description":"Required. Parent resource of the Connection, of the form: `projects/*/locations/*`","required":true,"style":"simple","schema":{"pattern":"^projects/[^/]+/locations/[^/]+$","type":"string"}},{"name":"connectionId","in":"query","description":"Required. Identifier to assign to the Connection. Must be unique within scope of the parent resource.","style":"form","explode":true,"schema":{"type":"string"}}],"requestBody":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Connection"}}},"required":true},"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Operation"}}}}},"deprecated":false,"security":[{"httpBearer":["https://www.googleapis.com/auth/cloud-platform"]}]},"get":{"tags":["connections"],"summary":"ListV1ConnectionsByParent","description":"Lists Connections in a given project and location.","operationId":"ListV1ConnectionsByParent","parameters":[{"name":"prettyPrint","in":"query","description":"Returns response with indentations and line breaks.","style":"form","explode":true,"schema":{"type":"boolean","default":true}},{"name":"alt","in":"query","description":"Data format for response. (Acceptable values are: \"json\", \"media\", \"proto\")","style":"form","explode":true,"schema":{"type":"string","default":"json"}},{"name":"access_token","in":"query","description":"OAuth access token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"callback","in":"query","description":"JSONP","style":"form","explode":true,"schema":{"type":"string"}},{"name":"key","in":"query","description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"uploadType","in":"query","description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"oauth_token","in":"query","description":"OAuth 2.0 token for the current user.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"quotaUser","in":"query","description":"Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"upload_protocol","in":"query","description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"Selector specifying which fields to include in a partial response.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"$.xgafv","in":"query","description":"V1 error format. (Acceptable values are: \"1\", \"2\")","style":"form","explode":true,"schema":{"type":"string","default":"1"}},{"name":"parent","in":"path","description":"Required. Parent resource of the Connection, of the form: `projects/*/locations/*`","required":true,"style":"simple","schema":{"pattern":"^projects/[^/]+/locations/[^/]+$","type":"string"}},{"name":"orderBy","in":"query","description":"Order by parameters.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"view","in":"query","description":"Specifies which fields of the Connection are returned in the response. Defaults to `BASIC` view. (Acceptable values are: \"CONNECTION_VIEW_UNSPECIFIED\", \"BASIC\", \"FULL\")","style":"form","explode":true,"schema":{"type":"string","default":"CONNECTION_VIEW_UNSPECIFIED"}},{"name":"filter","in":"query","description":"Filter.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"pageSize","in":"query","description":"Page size.","style":"form","explode":true,"schema":{"type":"integer","contentEncoding":"int32"}},{"name":"pageToken","in":"query","description":"Page token.","style":"form","explode":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListConnectionsResponse"}}}}},"deprecated":false,"security":[{"httpBearer":["https://www.googleapis.com/auth/cloud-platform"]}]},"parameters":[]},"/v1/{name}/locations":{"get":{"tags":["locations"],"summary":"ListV1LocationsByName","description":"Lists information about the supported locations for this service.","operationId":"ListV1LocationsByName","parameters":[{"name":"prettyPrint","in":"query","description":"Returns response with indentations and line breaks.","style":"form","explode":true,"schema":{"type":"boolean","default":true}},{"name":"alt","in":"query","description":"Data format for response. (Acceptable values are: \"json\", \"media\", \"proto\")","style":"form","explode":true,"schema":{"type":"string","default":"json"}},{"name":"access_token","in":"query","description":"OAuth access token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"callback","in":"query","description":"JSONP","style":"form","explode":true,"schema":{"type":"string"}},{"name":"key","in":"query","description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"uploadType","in":"query","description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"oauth_token","in":"query","description":"OAuth 2.0 token for the current user.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"quotaUser","in":"query","description":"Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"upload_protocol","in":"query","description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"Selector specifying which fields to include in a partial response.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"$.xgafv","in":"query","description":"V1 error format. (Acceptable values are: \"1\", \"2\")","style":"form","explode":true,"schema":{"type":"string","default":"1"}},{"name":"name","in":"path","description":"The resource that owns the locations collection, if applicable.","required":true,"style":"simple","schema":{"pattern":"^projects/[^/]+$","type":"string"}},{"name":"pageSize","in":"query","description":"The maximum number of results to return. If not set, the service selects a default.","style":"form","explode":true,"schema":{"type":"integer","contentEncoding":"int32"}},{"name":"filter","in":"query","description":"A filter to narrow down results to a preferred subset. The filtering language accepts strings like `\"displayName=tokyo\"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).","style":"form","explode":true,"schema":{"type":"string"}},{"name":"pageToken","in":"query","description":"A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.","style":"form","explode":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListLocationsResponse"}}}}},"deprecated":false,"security":[{"httpBearer":["https://www.googleapis.com/auth/cloud-platform"]}]},"parameters":[]}},"components":{"schemas":{"ListConnectionsResponse":{"title":"ListConnectionsResponse","type":"object","properties":{"nextPageToken":{"type":"string","description":"Next page token."},"unreachable":{"type":"array","items":{"type":"string"},"description":"Locations that could not be reached."},"connections":{"type":"array","items":{"$ref":"#/components/schemas/Connection"},"description":"Connections."}},"description":"Response message for ConnectorsService.ListConnections"},"Secret":{"title":"Secret","type":"object","properties":{"secretVersion":{"type":"string","description":"The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`."}},"description":"Secret provides a reference to entries in Secret Manager."},"Destination":{"title":"Destination","type":"object","properties":{"port":{"type":"integer","description":"The port is the target port number that is accepted by the destination.","contentEncoding":"int32"},"serviceAttachment":{"type":"string","description":"PSC service attachments. Format: projects/*/regions/*/serviceAttachments/*"},"host":{"type":"string","description":"For publicly routable host."}}},"SshPublicKey":{"title":"SshPublicKey","type":"object","properties":{"certType":{"type":"string","description":"Format of SSH Client cert."},"sshClientCertPass":{"allOf":[{"$ref":"#/components/schemas/Secret"},{"description":"Secret provides a reference to entries in Secret Manager."}]},"username":{"type":"string","description":"The user account used to authenticate."},"sshClientCert":{"allOf":[{"$ref":"#/components/schemas/Secret"},{"description":"Secret provides a reference to entries in Secret Manager."}]}},"description":"Parameters to support Ssh public key Authentication."},"Binding":{"title":"Binding","type":"object","properties":{"members":{"type":"array","items":{"type":"string"},"description":"Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`."},"role":{"type":"string","description":"Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`."},"condition":{"allOf":[{"$ref":"#/components/schemas/Expr"},{"description":"Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: \"Summary size limit\" description: \"Determines if a summary is less than 100 chars\" expression: \"document.summary.size() < 100\" Example (Equality): title: \"Requestor is owner\" description: \"Determines if requestor is the document owner\" expression: \"document.owner == request.auth.claims.email\" Example (Logic): title: \"Public documents\" description: \"Determine whether the document should be publicly visible\" expression: \"document.type != 'private' && document.type != 'internal'\" Example (Data Manipulation): title: \"Notification string\" description: \"Create a notification string with a timestamp.\" expression: \"'New message received at ' + string(document.create_time)\" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information."}]}},"description":"Associates `members`, or principals, with a `role`."},"Status":{"title":"Status","type":"object","properties":{"code":{"type":"integer","description":"The status code, which should be an enum value of google.rpc.Code.","contentEncoding":"int32"},"details":{"type":"array","items":{},"description":"A list of messages that carry the error details. There is a common set of message types for APIs to use."},"message":{"type":"string","description":"A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client."}},"description":"The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors)."},"ConfigVariable":{"title":"ConfigVariable","type":"object","properties":{"key":{"type":"string","description":"Key of the config variable."},"intValue":{"type":"string","description":"Value is an integer"},"boolValue":{"type":"boolean","description":"Value is a bool."},"stringValue":{"type":"string","description":"Value is a string."},"secretValue":{"allOf":[{"$ref":"#/components/schemas/Secret"},{"description":"Secret provides a reference to entries in Secret Manager."}]}},"description":"ConfigVariable represents a configuration variable present in a Connection. or AuthConfig."},"SupportedRuntimeFeatures":{"title":"SupportedRuntimeFeatures","type":"object","properties":{"sqlQuery":{"type":"boolean","description":"Specifies if the connector supports 'ExecuteSqlQuery' operation."},"actionApis":{"type":"boolean","description":"Specifies if the connector supports action apis like 'executeAction'."},"entityApis":{"type":"boolean","description":"Specifies if the connector supports entity apis like 'createEntity'."}},"description":"Supported runtime features of a connector version. This is passed to the management layer to add a new connector version by the connector developer. Details about how this proto is passed to the management layer is covered in this doc - go/runtime-manifest."},"Policy":{"title":"Policy","type":"object","properties":{"bindings":{"type":"array","items":{"$ref":"#/components/schemas/Binding"},"description":"Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`."},"auditConfigs":{"type":"array","items":{"$ref":"#/components/schemas/AuditConfig"},"description":"Specifies cloud audit logging configuration for this policy."},"version":{"type":"integer","description":"Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).","contentEncoding":"int32"},"etag":{"type":"string","description":"`etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost."}},"description":"An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { \"bindings\": [ { \"role\": \"roles/resourcemanager.organizationAdmin\", \"members\": [ \"user:mike@example.com\", \"group:admins@example.com\", \"domain:google.com\", \"serviceAccount:my-project-id@appspot.gserviceaccount.com\" ] }, { \"role\": \"roles/resourcemanager.organizationViewer\", \"members\": [ \"user:eve@example.com\" ], \"condition\": { \"title\": \"expirable access\", \"description\": \"Does not grant access after Sep 2020\", \"expression\": \"request.time < timestamp('2020-10-01T00:00:00.000Z')\", } } ], \"etag\": \"BwWWja0YfJA=\", \"version\": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/)."},"ExtractionRules":{"title":"ExtractionRules","type":"object","properties":{"extractionRule":{"type":"array","items":{"$ref":"#/components/schemas/ExtractionRule"},"description":"Collection of Extraction Rule."}},"description":"Extraction Rules to identity the backends from customer provided configuration in Connection resource."},"Connection":{"title":"Connection","type":"object","properties":{"lockConfig":{"description":"Optional. Configuration that indicates whether or not the Connection can be edited."},"status":{"description":"Output only. Current status of the connection."},"nodeConfig":{"description":"Optional. Configuration for the connection."},"suspended":{"type":"boolean","description":"Optional. Suspended indicates if a user has suspended a connection or not."},"updateTime":{"type":"string","description":"Output only. Updated time."},"authConfig":{"description":"Optional. Configuration for establishing the connection's authentication with an external system."},"envoyImageLocation":{"type":"string","description":"Output only. GCR location where the envoy image is stored. formatted like: gcr.io/{bucketName}/{imageName}"},"serviceDirectory":{"type":"string","description":"Output only. The name of the Service Directory service name. Used for Private Harpoon to resolve the ILB address. e.g. \"projects/cloud-connectors-e2e-testing/locations/us-central1/namespaces/istio-system/services/istio-ingressgateway-connectors\""},"labels":{"type":"object","additionalProperties":{"type":"string"},"description":"Optional. Resource labels to represent user-provided metadata. Refer to cloud documentation on labels for more details. https://cloud.google.com/compute/docs/labeling-resources"},"imageLocation":{"type":"string","description":"Output only. GCR location where the runtime image is stored. formatted like: gcr.io/{bucketName}/{imageName}"},"name":{"type":"string","description":"Output only. Resource name of the Connection. Format: projects/{project}/locations/{location}/connections/{connection}"},"createTime":{"type":"string","description":"Output only. Created time."},"serviceAccount":{"type":"string","description":"Optional. Service account needed for runtime plane to access GCP resources."},"connectorVersion":{"type":"string","description":"Required. Connector version on which the connection is created. The format is: projects/*/locations/*/providers/*/connectors/*/versions/* Only global location is supported for ConnectorVersion resource."},"destinationConfigs":{"type":"array","items":{},"description":"Optional. Configuration of the Connector's destination. Only accepted for Connectors that accepts user defined destination(s)."},"description":{"type":"string","description":"Optional. Description of the resource."},"configVariables":{"type":"array","items":{},"description":"Optional. Configuration for configuring the connection with an external system."}},"description":"Connection represents an instance of connector."},"ConfigVariableTemplate":{"title":"ConfigVariableTemplate","type":"object","properties":{"enumOptions":{"type":"array","items":{"$ref":"#/components/schemas/EnumOption"},"description":"Enum options. To be populated if `ValueType` is `ENUM`"},"displayName":{"type":"string","description":"Display name of the parameter."},"valueType":{"allOf":[{"$ref":"#/components/schemas/ValueType"},{"description":"Type of the parameter: string, int, bool etc. consider custom type for the benefit for the validation."}]},"roleGrant":{"allOf":[{"$ref":"#/components/schemas/RoleGrant"},{"description":"This configuration defines all the Cloud IAM roles that needs to be granted to a particular GCP resource for the selected prinicpal like service account. These configurations will let UI display to customers what IAM roles need to be granted by them. Or these configurations can be used by the UI to render a 'grant' button to do the same on behalf of the user."}]},"description":{"type":"string","description":"Description."},"required":{"type":"boolean","description":"Flag represents that this `ConfigVariable` must be provided for a connection."},"validationRegex":{"type":"string","description":"Regular expression in RE2 syntax used for validating the `value` of a `ConfigVariable`."},"authorizationCodeLink":{"allOf":[{"$ref":"#/components/schemas/AuthorizationCodeLink"},{"description":"This configuration captures the details required to render an authorization link for the OAuth Authorization Code Flow."}]},"state":{"allOf":[{"$ref":"#/components/schemas/State"},{"description":"State of the config variable."}]},"key":{"type":"string","description":"Key of the config variable."}},"description":"ConfigVariableTemplate provides metadata about a `ConfigVariable` that is used in a Connection."},"AuthConfig":{"title":"AuthConfig","type":"object","properties":{"sshPublicKey":{"allOf":[{"$ref":"#/components/schemas/SshPublicKey"},{"description":"Parameters to support Ssh public key Authentication."}]},"authType":{"allOf":[{"$ref":"#/components/schemas/AuthType"},{"description":"The type of authentication configured."}]},"oauth2ClientCredentials":{"allOf":[{"$ref":"#/components/schemas/Oauth2ClientCredentials"},{"description":"Parameters to support Oauth 2.0 Client Credentials Grant Authentication. See https://tools.ietf.org/html/rfc6749#section-1.3.4 for more details."}]},"userPassword":{"allOf":[{"$ref":"#/components/schemas/UserPassword"},{"description":"Parameters to support Username and Password Authentication."}]},"oauth2JwtBearer":{"allOf":[{"$ref":"#/components/schemas/Oauth2JwtBearer"},{"description":"Parameters to support JSON Web Token (JWT) Profile for Oauth 2.0 Authorization Grant based authentication. See https://tools.ietf.org/html/rfc7523 for more details."}]},"additionalVariables":{"type":"array","items":{"$ref":"#/components/schemas/ConfigVariable"},"description":"List containing additional auth configs."}},"description":"AuthConfig defines details of a authentication type."},"AuditLogConfig":{"title":"AuditLogConfig","type":"object","properties":{"exemptedMembers":{"type":"array","items":{"type":"string"},"description":"Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members."},"logType":{"allOf":[{"$ref":"#/components/schemas/LogType"},{"description":"The log type that this config enables."}]}},"description":"Provides the configuration for logging a type of permissions. Example: { \"audit_log_configs\": [ { \"log_type\": \"DATA_READ\", \"exempted_members\": [ \"user:jose@example.com\" ] }, { \"log_type\": \"DATA_WRITE\" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging."},"ListRuntimeActionSchemasResponse":{"title":"ListRuntimeActionSchemasResponse","type":"object","properties":{"nextPageToken":{"type":"string","description":"Next page token."},"runtimeActionSchemas":{"type":"array","items":{"$ref":"#/components/schemas/RuntimeActionSchema"},"description":"Runtime action schemas."}},"description":"Response message for ConnectorsService.ListRuntimeActionSchemas."},"TestIamPermissionsResponse":{"title":"TestIamPermissionsResponse","type":"object","properties":{"permissions":{"type":"array","items":{"type":"string"},"description":"A subset of `TestPermissionsRequest.permissions` that the caller is allowed."}},"description":"Response message for `TestIamPermissions` method."},"Operation":{"title":"Operation","type":"object","properties":{"metadata":{"type":"object","additionalProperties":{},"description":"Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any."},"response":{"type":"object","additionalProperties":{},"description":"The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`."},"name":{"type":"string","description":"The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`."},"done":{"type":"boolean","description":"If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available."},"error":{"allOf":[{"$ref":"#/components/schemas/Status"},{"description":"The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors)."}]}},"description":"This resource represents a long-running operation that is the result of a network API call."},"Source":{"title":"Source","type":"object","properties":{"fieldId":{"type":"string","description":"Field identifier. For example config vaiable name."},"sourceType":{"allOf":[{"$ref":"#/components/schemas/SourceType"},{"description":"Type of the source."}]}},"description":"Source to extract the backend from."},"ListOperationsResponse":{"title":"ListOperationsResponse","type":"object","properties":{"operations":{"type":"array","items":{"$ref":"#/components/schemas/Operation"},"description":"A list of operations that matches the specified filter in the request."},"nextPageToken":{"type":"string","description":"The standard List next-page token."}},"description":"The response message for Operations.ListOperations."},"DestinationConfig":{"title":"DestinationConfig","type":"object","properties":{"destinations":{"type":"array","items":{"$ref":"#/components/schemas/Destination"},"description":"The destinations for the key."},"key":{"type":"string","description":"The key is the destination identifier that is supported by the Connector."}},"description":"Define the Connectors target endpoint."},"ListProvidersResponse":{"title":"ListProvidersResponse","type":"object","properties":{"unreachable":{"type":"array","items":{"type":"string"},"description":"Locations that could not be reached."},"nextPageToken":{"type":"string","description":"Next page token."},"providers":{"type":"array","items":{"$ref":"#/components/schemas/Provider"},"description":"A list of providers."}},"description":"Response message for Connectors.ListProviders."},"ListRuntimeEntitySchemasResponse":{"title":"ListRuntimeEntitySchemasResponse","type":"object","properties":{"runtimeEntitySchemas":{"type":"array","items":{"$ref":"#/components/schemas/RuntimeEntitySchema"},"description":"Runtime entity schemas."},"nextPageToken":{"type":"string","description":"Next page token."}},"description":"Response message for ConnectorsService.ListRuntimeEntitySchemas."},"Oauth2ClientCredentials":{"title":"Oauth2ClientCredentials","type":"object","properties":{"clientId":{"type":"string","description":"The client identifier."},"clientSecret":{"description":"Secret version reference containing the client secret."}},"description":"Parameters to support Oauth 2.0 Client Credentials Grant Authentication. See https://tools.ietf.org/html/rfc6749#section-1.3.4 for more details."},"Field":{"title":"Field","type":"object","properties":{"description":{"type":"string","description":"A brief description of the Field."},"key":{"type":"boolean","description":"The following boolean field specifies if the current Field acts as a primary key or id if the parent is of type entity."},"dataType":{"allOf":[{"$ref":"#/components/schemas/DataType"},{"description":"The data type of the Field."}]},"defaultValue":{"description":"The following field specifies the default value of the Field provided by the external system if a value is not provided."},"field":{"type":"string","description":"Name of the Field."},"readonly":{"type":"boolean","description":"Specifies if the Field is readonly."},"nullable":{"type":"boolean","description":"Specifies whether a null value is allowed."},"additionalDetails":{"type":"object","additionalProperties":{},"description":"The following map contains fields that are not explicitly mentioned above,this give connectors the flexibility to add new metadata fields."}},"description":"Metadata of an entity field."},"Location":{"title":"Location","type":"object","properties":{"name":{"type":"string","description":"Resource name for the location, which may vary between implementations. For example: `\"projects/example-project/locations/us-east1\"`"},"metadata":{"type":"object","additionalProperties":{},"description":"Service-specific metadata. For example the available capacity at the given location."},"displayName":{"type":"string","description":"The friendly name for this location, typically a nearby city name. For example, \"Tokyo\"."},"locationId":{"type":"string","description":"The canonical id for this location. For example: `\"us-east1\"`."},"labels":{"type":"object","additionalProperties":{"type":"string"},"description":"Cross-service attributes for the location. For example {\"cloud.googleapis.com/region\": \"us-east1\"}"}},"description":"A resource that represents Google Cloud Platform location."},"Provider":{"title":"Provider","type":"object","properties":{"externalUri":{"type":"string","description":"Output only. Link to external page."},"name":{"type":"string","description":"Output only. Resource name of the Provider. Format: projects/{project}/locations/{location}/providers/{provider} Only global location is supported for Provider resource."},"description":{"type":"string","description":"Output only. Description of the resource."},"webAssetsLocation":{"type":"string","description":"Output only. Cloud storage location of icons etc consumed by UI."},"updateTime":{"type":"string","description":"Output only. Updated time."},"createTime":{"type":"string","description":"Output only. Created time."},"labels":{"type":"object","additionalProperties":{"type":"string"},"description":"Output only. Resource labels to represent user-provided metadata. Refer to cloud documentation on labels for more details. https://cloud.google.com/compute/docs/labeling-resources"},"documentationUri":{"type":"string","description":"Output only. Link to documentation page."},"displayName":{"type":"string","description":"Output only. Display name."},"launchStage":{"allOf":[{"$ref":"#/components/schemas/LaunchStage"},{"description":"Output only. Flag to mark the version indicating the launch stage."}]}},"description":"Provider indicates the owner who provides the connectors."},"EgressControlConfig":{"title":"EgressControlConfig","type":"object","properties":{"extractionRules":{"allOf":[{"$ref":"#/components/schemas/ExtractionRules"},{"description":"Extraction Rules to identity the backends from customer provided configuration in Connection resource."}]},"backends":{"type":"string","description":"Static Comma separated backends which are common for all Connection resources. Supported formats for each backend are host:port or just host (host can be ip address or domain name)."}},"description":"Egress control config for connector runtime. These configurations define the rules to identify which outbound domains/hosts needs to be whitelisted. It may be a static information for a particular connector version or it is derived from the configurations provided by the customer in Connection resource."},"RoleGrant":{"title":"RoleGrant","type":"object","properties":{"resource":{"description":"Resource on which the roles needs to be granted for the principal."},"principal":{"allOf":[{"$ref":"#/components/schemas/Principal"},{"description":"Prinicipal/Identity for whom the role need to assigned."}]},"roles":{"type":"array","items":{"type":"string"},"description":"List of roles that need to be granted."},"helperTextTemplate":{"type":"string","description":"Template that UI can use to provide helper text to customers."}},"description":"This configuration defines all the Cloud IAM roles that needs to be granted to a particular GCP resource for the selected prinicpal like service account. These configurations will let UI display to customers what IAM roles need to be granted by them. Or these configurations can be used by the UI to render a 'grant' button to do the same on behalf of the user."},"InputParameter":{"title":"InputParameter","type":"object","properties":{"dataType":{"allOf":[{"$ref":"#/components/schemas/DataType1"},{"description":"The data type of the Parameter."}]},"description":{"type":"string","description":"A brief description of the Parameter."},"parameter":{"type":"string","description":"Name of the Parameter."},"nullable":{"type":"boolean","description":"Specifies whether a null value is allowed."},"defaultValue":{"description":"The following field specifies the default value of the Parameter provided by the external system if a value is not provided."}},"description":"Metadata of an input parameter."},"RuntimeConfig":{"title":"RuntimeConfig","type":"object","properties":{"schemaGcsBucket":{"type":"string","description":"Output only. The Cloud Storage bucket that stores connector's schema reports."},"state":{"allOf":[{"$ref":"#/components/schemas/State1"},{"description":"Output only. The state of the location."}]},"conndSubscription":{"type":"string","description":"Output only. Pub/Sub subscription for connd to receive message. E.g. projects/{project-id}/subscriptions/{topic-id}"},"name":{"type":"string","description":"Output only. Name of the runtimeConfig resource. Format: projects/{project}/locations/{location}/runtimeConfig"},"locationId":{"type":"string","description":"Output only. location_id of the runtime location. E.g. \"us-west1\"."},"controlPlaneSubscription":{"type":"string","description":"Output only. Pub/Sub subscription for control plane to receive message. E.g. projects/{project-id}/subscriptions/{topic-id}"},"serviceDirectory":{"type":"string","description":"Output only. The name of the Service Directory service name."},"controlPlaneTopic":{"type":"string","description":"Output only. Pub/Sub topic for control plne to send message. communication. E.g. projects/{project-id}/topics/{topic-id}"},"runtimeEndpoint":{"type":"string","description":"Output only. The endpoint of the connectors runtime ingress."},"conndTopic":{"type":"string","description":"Output only. Pub/Sub topic for connd to send message. E.g. projects/{project-id}/topics/{topic-id}"}},"description":"RuntimeConfig is the singleton resource of each location. It includes generic resource configs consumed by control plane and runtime plane like: pub/sub topic/subscription resource name, Cloud Storage location storing schema etc."},"ConnectorVersion":{"title":"ConnectorVersion","type":"object","properties":{"roleGrant":{"allOf":[{"$ref":"#/components/schemas/RoleGrant"},{"description":"This configuration defines all the Cloud IAM roles that needs to be granted to a particular GCP resource for the selected prinicpal like service account. These configurations will let UI display to customers what IAM roles need to be granted by them. Or these configurations can be used by the UI to render a 'grant' button to do the same on behalf of the user."}]},"displayName":{"type":"string","description":"Output only. Display name."},"updateTime":{"type":"string","description":"Output only. Updated time."},"supportedRuntimeFeatures":{"allOf":[{"$ref":"#/components/schemas/SupportedRuntimeFeatures"},{"description":"Supported runtime features of a connector version. This is passed to the management layer to add a new connector version by the connector developer. Details about how this proto is passed to the management layer is covered in this doc - go/runtime-manifest."}]},"configVariableTemplates":{"type":"array","items":{"$ref":"#/components/schemas/ConfigVariableTemplate"},"description":"Output only. List of config variables needed to create a connection."},"name":{"type":"string","description":"Output only. Resource name of the Version. Format: projects/{project}/locations/{location}/providers/{provider}/connectors/{connector}/versions/{version} Only global location is supported for Connector resource."},"labels":{"type":"object","additionalProperties":{"type":"string"},"description":"Output only. Resource labels to represent user-provided metadata. Refer to cloud documentation on labels for more details. https://cloud.google.com/compute/docs/labeling-resources"},"launchStage":{"allOf":[{"$ref":"#/components/schemas/LaunchStage"},{"description":"Output only. Flag to mark the version indicating the launch stage."}]},"egressControlConfig":{"allOf":[{"$ref":"#/components/schemas/EgressControlConfig"},{"description":"Egress control config for connector runtime. These configurations define the rules to identify which outbound domains/hosts needs to be whitelisted. It may be a static information for a particular connector version or it is derived from the configurations provided by the customer in Connection resource."}]},"releaseVersion":{"type":"string","description":"Output only. ReleaseVersion of the connector, for example: \"1.0.1-alpha\"."},"roleGrants":{"type":"array","items":{"$ref":"#/components/schemas/RoleGrant"},"description":"Output only. Role grant configurations for this connector version."},"createTime":{"type":"string","description":"Output only. Created time."},"authConfigTemplates":{"type":"array","items":{"$ref":"#/components/schemas/AuthConfigTemplate"},"description":"Output only. List of auth configs supported by the Connector Version."}},"description":"ConnectorVersion indicates a specific version of a connector."},"Expr":{"title":"Expr","type":"object","properties":{"description":{"type":"string","description":"Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI."},"title":{"type":"string","description":"Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression."},"expression":{"type":"string","description":"Textual representation of an expression in Common Expression Language syntax."},"location":{"type":"string","description":"Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file."}},"description":"Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: \"Summary size limit\" description: \"Determines if a summary is less than 100 chars\" expression: \"document.summary.size() < 100\" Example (Equality): title: \"Requestor is owner\" description: \"Determines if requestor is the document owner\" expression: \"document.owner == request.auth.claims.email\" Example (Logic): title: \"Public documents\" description: \"Determine whether the document should be publicly visible\" expression: \"document.type != 'private' && document.type != 'internal'\" Example (Data Manipulation): title: \"Notification string\" description: \"Create a notification string with a timestamp.\" expression: \"'New message received at ' + string(document.create_time)\" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information."},"AuditConfig":{"title":"AuditConfig","type":"object","properties":{"service":{"type":"string","description":"Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services."},"auditLogConfigs":{"type":"array","items":{},"description":"The configuration for logging of each type of permission."}},"description":"Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { \"audit_configs\": [ { \"service\": \"allServices\", \"audit_log_configs\": [ { \"log_type\": \"DATA_READ\", \"exempted_members\": [ \"user:jose@example.com\" ] }, { \"log_type\": \"DATA_WRITE\" }, { \"log_type\": \"ADMIN_READ\" } ] }, { \"service\": \"sampleservice.googleapis.com\", \"audit_log_configs\": [ { \"log_type\": \"DATA_READ\" }, { \"log_type\": \"DATA_WRITE\", \"exempted_members\": [ \"user:aliya@example.com\" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging."},"EnumOption":{"title":"EnumOption","type":"object","properties":{"id":{"type":"string","description":"Id of the option."},"displayName":{"type":"string","description":"Display name of the option."}},"description":"EnumOption definition"},"ExtractionRule":{"title":"ExtractionRule","type":"object","properties":{"source":{"description":"Source on which the rule is applied."},"extractionRegex":{"type":"string","description":"Regex used to extract backend details from source. If empty, whole source value will be used."}},"description":"Extraction Rule."},"ResultMetadata":{"title":"ResultMetadata","type":"object","properties":{"dataType":{"allOf":[{"$ref":"#/components/schemas/DataType2"},{"description":"The data type of the field."}]},"description":{"type":"string","description":"A brief description of the field."},"field":{"type":"string","description":"Name of the result field."}},"description":"Metadata of result field."},"ListConnectorsResponse":{"title":"ListConnectorsResponse","type":"object","properties":{"unreachable":{"type":"array","items":{"type":"string"},"description":"Locations that could not be reached."},"nextPageToken":{"type":"string","description":"Next page token."},"connectors":{"type":"array","items":{"$ref":"#/components/schemas/Connector"},"description":"A list of connectors."}},"description":"Response message for Connectors.ListConnectors."},"UserPassword":{"title":"UserPassword","type":"object","properties":{"password":{"description":"Secret version reference containing the password."},"username":{"type":"string","description":"Username."}},"description":"Parameters to support Username and Password Authentication."},"Resource":{"title":"Resource","type":"object","properties":{"type":{"allOf":[{"$ref":"#/components/schemas/Type"},{"description":"Different types of resource supported."}]},"pathTemplate":{"type":"string","description":"Template to uniquely represent a GCP resource in a format IAM expects This is a template that can have references to other values provided in the config variable template."}},"description":"Resource definition"},"OperationMetadata":{"title":"OperationMetadata","type":"object","properties":{"statusMessage":{"type":"string","description":"Output only. Human-readable status of the operation, if any."},"createTime":{"type":"string","description":"Output only. The time the operation was created."},"apiVersion":{"type":"string","description":"Output only. API version used to start the operation."},"endTime":{"type":"string","description":"Output only. The time the operation finished running."},"target":{"type":"string","description":"Output only. Server-defined resource path for the target of the operation."},"requestedCancellation":{"type":"boolean","description":"Output only. Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`."},"verb":{"type":"string","description":"Output only. Name of the verb executed by the operation."}},"description":"Represents the metadata of the long-running operation."},"ConnectionStatus":{"title":"ConnectionStatus","type":"object","properties":{"status":{"type":"string","description":"Status provides detailed information for the state."},"description":{"type":"string","description":"Description."},"state":{"allOf":[{"$ref":"#/components/schemas/State2"},{"description":"State."}]}},"description":"ConnectionStatus indicates the state of the connection."},"AuthorizationCodeLink":{"title":"AuthorizationCodeLink","type":"object","properties":{"enablePkce":{"type":"boolean","description":"Whether to enable PKCE for the auth code flow."},"uri":{"type":"string","description":"The base URI the user must click to trigger the authorization code login flow."},"scopes":{"type":"array","items":{"type":"string"},"description":"The scopes for which the user will authorize GCP Connectors on the connector data source."},"clientId":{"type":"string","description":"The client ID assigned to the GCP Connectors OAuth app for the connector data source."}},"description":"This configuration captures the details required to render an authorization link for the OAuth Authorization Code Flow."},"TestIamPermissionsRequest":{"title":"TestIamPermissionsRequest","type":"object","properties":{"permissions":{"type":"array","items":{"type":"string"},"description":"The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions)."}},"description":"Request message for `TestIamPermissions` method."},"Connector":{"title":"Connector","type":"object","properties":{"labels":{"type":"object","additionalProperties":{"type":"string"},"description":"Output only. Resource labels to represent user-provided metadata. Refer to cloud documentation on labels for more details. https://cloud.google.com/compute/docs/labeling-resources"},"webAssetsLocation":{"type":"string","description":"Output only. Cloud storage location of icons etc consumed by UI."},"createTime":{"type":"string","description":"Output only. Created time."},"name":{"type":"string","description":"Output only. Resource name of the Connector. Format: projects/{project}/locations/{location}/providers/{provider}/connectors/{connector} Only global location is supported for Connector resource."},"documentationUri":{"type":"string","description":"Output only. Link to documentation page."},"launchStage":{"allOf":[{"$ref":"#/components/schemas/LaunchStage"},{"description":"Output only. Flag to mark the version indicating the launch stage."}]},"updateTime":{"type":"string","description":"Output only. Updated time."},"externalUri":{"type":"string","description":"Output only. Link to external page."},"description":{"type":"string","description":"Output only. Description of the resource."},"displayName":{"type":"string","description":"Output only. Display name."}},"description":"Connectors indicates a specific connector type, e.x. Salesforce, SAP etc."},"Oauth2JwtBearer":{"title":"Oauth2JwtBearer","type":"object","properties":{"clientKey":{"description":"Secret version reference containing a PKCS#8 PEM-encoded private key associated with the Client Certificate. This private key will be used to sign JWTs used for the jwt-bearer authorization grant. Specified in the form as: `projects/*/secrets/*/versions/*`."},"jwtClaims":{"description":"JwtClaims providers fields to generate the token."}},"description":"Parameters to support JSON Web Token (JWT) Profile for Oauth 2.0 Authorization Grant based authentication. See https://tools.ietf.org/html/rfc7523 for more details."},"LockConfig":{"title":"LockConfig","type":"object","properties":{"reason":{"type":"string","description":"Describes why a connection is locked."},"locked":{"type":"boolean","description":"Indicates whether or not the connection is locked."}},"description":"Determines whether or no a connection is locked. If locked, a reason must be specified."},"NodeConfig":{"title":"NodeConfig","type":"object","properties":{"minNodeCount":{"type":"integer","description":"Minimum number of nodes in the runtime nodes.","contentEncoding":"int32"},"maxNodeCount":{"type":"integer","description":"Maximum number of nodes in the runtime nodes.","contentEncoding":"int32"}},"description":"Configuration for the connection."},"JwtClaims":{"title":"JwtClaims","type":"object","properties":{"audience":{"type":"string","description":"Value for the \"aud\" claim."},"subject":{"type":"string","description":"Value for the \"sub\" claim."},"issuer":{"type":"string","description":"Value for the \"iss\" claim."}},"description":"JWT claims used for the jwt-bearer authorization grant."},"ConnectionSchemaMetadata":{"title":"ConnectionSchemaMetadata","type":"object","properties":{"entities":{"type":"array","items":{"type":"string"},"description":"Output only. List of entity names."},"name":{"type":"string","description":"Output only. Resource name. Format: projects/{project}/locations/{location}/connections/{connection}/connectionSchemaMetadata"},"updateTime":{"type":"string","description":"Output only. Timestamp when the connection runtime schema was updated."},"refreshTime":{"type":"string","description":"Output only. Timestamp when the connection runtime schema refresh was triggered."},"actions":{"type":"array","items":{"type":"string"},"description":"Output only. List of actions."},"state":{"allOf":[{"$ref":"#/components/schemas/State3"},{"description":"Output only. The current state of runtime schema."}]}},"description":"ConnectionSchemaMetadata is the singleton resource of each connection. It includes the entity and action names of runtime resources exposed by a connection backend."},"RuntimeEntitySchema":{"title":"RuntimeEntitySchema","type":"object","properties":{"fields":{"type":"array","items":{},"description":"Output only. List of fields in the entity."},"entity":{"type":"string","description":"Output only. Name of the entity."}},"description":"Schema of a runtime entity."},"ListConnectorVersionsResponse":{"title":"ListConnectorVersionsResponse","type":"object","properties":{"unreachable":{"type":"array","items":{"type":"string"},"description":"Locations that could not be reached."},"connectorVersions":{"type":"array","items":{"$ref":"#/components/schemas/ConnectorVersion"},"description":"A list of connector versions."},"nextPageToken":{"type":"string","description":"Next page token."}},"description":"Response message for Connectors.ListConnectorVersions."},"RuntimeActionSchema":{"title":"RuntimeActionSchema","type":"object","properties":{"resultMetadata":{"type":"array","items":{},"description":"Output only. List of result field metadata."},"action":{"type":"string","description":"Output only. Name of the action."},"inputParameters":{"type":"array","items":{},"description":"Output only. List of input parameter metadata for the action."}},"description":"Schema of a runtime action."},"ListLocationsResponse":{"title":"ListLocationsResponse","type":"object","properties":{"nextPageToken":{"type":"string","description":"The standard List next-page token."},"locations":{"type":"array","items":{"$ref":"#/components/schemas/Location"},"description":"A list of locations that matches the specified filter in the request."}},"description":"The response message for Locations.ListLocations."},"AuthConfigTemplate":{"title":"AuthConfigTemplate","type":"object","properties":{"configVariableTemplates":{"type":"array","items":{},"description":"Config variables to describe an `AuthConfig` for a `Connection`."},"authType":{"allOf":[{"$ref":"#/components/schemas/AuthType"},{"description":"The type of authentication configured."}]}},"description":"AuthConfigTemplate defines required field over an authentication type."},"SetIamPolicyRequest":{"title":"SetIamPolicyRequest","type":"object","properties":{"updateMask":{"type":"string","description":"OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only the fields in the mask will be modified. If no mask is provided, the following default mask is used: `paths: \"bindings, etag\"`"},"policy":{"allOf":[{"$ref":"#/components/schemas/Policy"},{"description":"An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { \"bindings\": [ { \"role\": \"roles/resourcemanager.organizationAdmin\", \"members\": [ \"user:mike@example.com\", \"group:admins@example.com\", \"domain:google.com\", \"serviceAccount:my-project-id@appspot.gserviceaccount.com\" ] }, { \"role\": \"roles/resourcemanager.organizationViewer\", \"members\": [ \"user:eve@example.com\" ], \"condition\": { \"title\": \"expirable access\", \"description\": \"Does not grant access after Sep 2020\", \"expression\": \"request.time < timestamp('2020-10-01T00:00:00.000Z')\", } } ], \"etag\": \"BwWWja0YfJA=\", \"version\": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/)."}]}},"description":"Request message for `SetIamPolicy` method."},"AuthType":{"title":"AuthType","enum":["AUTH_TYPE_UNSPECIFIED","USER_PASSWORD","OAUTH2_JWT_BEARER","OAUTH2_CLIENT_CREDENTIALS","SSH_PUBLIC_KEY","OAUTH2_AUTH_CODE_FLOW"],"type":"string","description":"The type of authentication configured."},"DataType":{"title":"DataType","enum":["DATA_TYPE_UNSPECIFIED","DATA_TYPE_INT","DATA_TYPE_SMALLINT","DATA_TYPE_DOUBLE","DATA_TYPE_DATE","DATA_TYPE_DATETIME","DATA_TYPE_TIME","DATA_TYPE_STRING","DATA_TYPE_LONG","DATA_TYPE_BOOLEAN","DATA_TYPE_DECIMAL","DATA_TYPE_UUID","DATA_TYPE_BLOB","DATA_TYPE_BIT","DATA_TYPE_TINYINT","DATA_TYPE_INTEGER","DATA_TYPE_BIGINT","DATA_TYPE_FLOAT","DATA_TYPE_REAL","DATA_TYPE_NUMERIC","DATA_TYPE_CHAR","DATA_TYPE_VARCHAR","DATA_TYPE_LONGVARCHAR","DATA_TYPE_TIMESTAMP","DATA_TYPE_NCHAR","DATA_TYPE_NVARCHAR","DATA_TYPE_LONGNVARCHAR","DATA_TYPE_NULL","DATA_TYPE_OTHER","DATA_TYPE_JAVA_OBJECT","DATA_TYPE_DISTINCT","DATA_TYPE_STRUCT","DATA_TYPE_ARRAY","DATA_TYPE_CLOB","DATA_TYPE_REF","DATA_TYPE_DATALINK","DATA_TYPE_ROWID","DATA_TYPE_BINARY","DATA_TYPE_VARBINARY","DATA_TYPE_LONGVARBINARY","DATA_TYPE_NCLOB","DATA_TYPE_SQLXML","DATA_TYPE_REF_CURSOR","DATA_TYPE_TIME_WITH_TIMEZONE","DATA_TYPE_TIMESTAMP_WITH_TIMEZONE"],"type":"string","description":"The data type of the Field."},"DataType1":{"title":"DataType1","enum":["DATA_TYPE_UNSPECIFIED","DATA_TYPE_INT","DATA_TYPE_SMALLINT","DATA_TYPE_DOUBLE","DATA_TYPE_DATE","DATA_TYPE_DATETIME","DATA_TYPE_TIME","DATA_TYPE_STRING","DATA_TYPE_LONG","DATA_TYPE_BOOLEAN","DATA_TYPE_DECIMAL","DATA_TYPE_UUID","DATA_TYPE_BLOB","DATA_TYPE_BIT","DATA_TYPE_TINYINT","DATA_TYPE_INTEGER","DATA_TYPE_BIGINT","DATA_TYPE_FLOAT","DATA_TYPE_REAL","DATA_TYPE_NUMERIC","DATA_TYPE_CHAR","DATA_TYPE_VARCHAR","DATA_TYPE_LONGVARCHAR","DATA_TYPE_TIMESTAMP","DATA_TYPE_NCHAR","DATA_TYPE_NVARCHAR","DATA_TYPE_LONGNVARCHAR","DATA_TYPE_NULL","DATA_TYPE_OTHER","DATA_TYPE_JAVA_OBJECT","DATA_TYPE_DISTINCT","DATA_TYPE_STRUCT","DATA_TYPE_ARRAY","DATA_TYPE_CLOB","DATA_TYPE_REF","DATA_TYPE_DATALINK","DATA_TYPE_ROWID","DATA_TYPE_BINARY","DATA_TYPE_VARBINARY","DATA_TYPE_LONGVARBINARY","DATA_TYPE_NCLOB","DATA_TYPE_SQLXML","DATA_TYPE_REF_CURSOR","DATA_TYPE_TIME_WITH_TIMEZONE","DATA_TYPE_TIMESTAMP_WITH_TIMEZONE"],"type":"string","description":"The data type of the Parameter."},"DataType2":{"title":"DataType2","enum":["DATA_TYPE_UNSPECIFIED","DATA_TYPE_INT","DATA_TYPE_SMALLINT","DATA_TYPE_DOUBLE","DATA_TYPE_DATE","DATA_TYPE_DATETIME","DATA_TYPE_TIME","DATA_TYPE_STRING","DATA_TYPE_LONG","DATA_TYPE_BOOLEAN","DATA_TYPE_DECIMAL","DATA_TYPE_UUID","DATA_TYPE_BLOB","DATA_TYPE_BIT","DATA_TYPE_TINYINT","DATA_TYPE_INTEGER","DATA_TYPE_BIGINT","DATA_TYPE_FLOAT","DATA_TYPE_REAL","DATA_TYPE_NUMERIC","DATA_TYPE_CHAR","DATA_TYPE_VARCHAR","DATA_TYPE_LONGVARCHAR","DATA_TYPE_TIMESTAMP","DATA_TYPE_NCHAR","DATA_TYPE_NVARCHAR","DATA_TYPE_LONGNVARCHAR","DATA_TYPE_NULL","DATA_TYPE_OTHER","DATA_TYPE_JAVA_OBJECT","DATA_TYPE_DISTINCT","DATA_TYPE_STRUCT","DATA_TYPE_ARRAY","DATA_TYPE_CLOB","DATA_TYPE_REF","DATA_TYPE_DATALINK","DATA_TYPE_ROWID","DATA_TYPE_BINARY","DATA_TYPE_VARBINARY","DATA_TYPE_LONGVARBINARY","DATA_TYPE_NCLOB","DATA_TYPE_SQLXML","DATA_TYPE_REF_CURSOR","DATA_TYPE_TIME_WITH_TIMEZONE","DATA_TYPE_TIMESTAMP_WITH_TIMEZONE"],"type":"string","description":"The data type of the field."},"LaunchStage":{"title":"LaunchStage","enum":["LAUNCH_STAGE_UNSPECIFIED","PREVIEW","GA","DEPRECATED"],"type":"string","description":"Output only. Flag to mark the version indicating the launch stage."},"LogType":{"title":"LogType","enum":["LOG_TYPE_UNSPECIFIED","ADMIN_READ","DATA_WRITE","DATA_READ"],"type":"string","description":"The log type that this config enables."},"Principal":{"title":"Principal","enum":["PRINCIPAL_UNSPECIFIED","CONNECTOR_SA"],"type":"string","description":"Prinicipal/Identity for whom the role need to assigned."},"SourceType":{"title":"SourceType","enum":["SOURCE_TYPE_UNSPECIFIED","CONFIG_VARIABLE"],"type":"string","description":"Type of the source."},"State":{"title":"State","enum":["STATE_UNSPECIFIED","ACTIVE","DEPRECATED"],"type":"string","description":"State of the config variable."},"State1":{"title":"State1","enum":["STATE_UNSPECIFIED","INACTIVE","ACTIVATING","ACTIVE","CREATING","DELETING","UPDATING"],"type":"string","description":"Output only. The state of the location."},"State2":{"title":"State2","enum":["STATE_UNSPECIFIED","CREATING","ACTIVE","INACTIVE","DELETING","UPDATING","ERROR"],"type":"string","description":"State."},"State3":{"title":"State3","enum":["STATE_UNSPECIFIED","REFRESHING","UPDATED"],"type":"string","description":"Output only. The current state of runtime schema."},"Type":{"title":"Type","enum":["TYPE_UNSPECIFIED","GCP_PROJECT","GCP_RESOURCE","GCP_SECRETMANAGER_SECRET","GCP_SECRETMANAGER_SECRET_VERSION"],"type":"string","description":"Different types of resource supported."},"ValueType":{"title":"ValueType","enum":["VALUE_TYPE_UNSPECIFIED","STRING","INT","BOOL","SECRET","ENUM","AUTHORIZATION_CODE"],"type":"string","description":"Type of the parameter: string, int, bool etc. consider custom type for the benefit for the validation."}},"securitySchemes":{"httpBearer":{"type":"http","scheme":"bearer"}}},"security":[{"httpBearer":[]}],"tags":[{"name":"operations","description":""},{"name":"versions","description":""},{"name":"connectors","description":""},{"name":"providers","description":""},{"name":"runtimeActionSchemas","description":""},{"name":"runtimeEntitySchemas","description":""},{"name":"connections","description":""},{"name":"locations","description":""}]}
/ v1 / {name}
/ v1 / {name}:cancel
/ v1 / {name} / operations
/ v1 / {parent} / versions
/ v1 / {parent} / connectors
/ v1 / {resource}:testIamPermissions
/ v1 / {resource}:getIamPolicy
/ v1 / {parent} / providers
/ v1 / {resource}:setIamPolicy
/ v1 / {parent} / runtimeActionSchemas
/ v1 / {parent} / runtimeEntitySchemas
/ v1 / {parent} / connections
/ v1 / {name} / locations
Application Integration API OpenAPI	{"openapi":"3.1.0","info":{"title":"Application Integration API","description":"","contact":{},"version":"v1"},"jsonSchemaDialect":"https://json-schema.org/draft/2020-12/schema","servers":[{"url":"https://integrations.googleapis.com/","variables":{}}],"paths":{"/v1/{parent}/appsScriptProjects":{"post":{"tags":["appsScriptProjects"],"summary":"CreateV1AppsScriptProjectsByParent","description":"Creates an Apps Script project.","operationId":"CreateV1AppsScriptProjectsByParent","parameters":[{"name":"quotaUser","in":"query","description":"Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"prettyPrint","in":"query","description":"Returns response with indentations and line breaks.","style":"form","explode":true,"schema":{"type":"boolean","default":true}},{"name":"oauth_token","in":"query","description":"OAuth 2.0 token for the current user.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"uploadType","in":"query","description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"callback","in":"query","description":"JSONP","style":"form","explode":true,"schema":{"type":"string"}},{"name":"$.xgafv","in":"query","description":"V1 error format. (Acceptable values are: \"1\", \"2\")","style":"form","explode":true,"schema":{"type":"string","default":"1"}},{"name":"fields","in":"query","description":"Selector specifying which fields to include in a partial response.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"upload_protocol","in":"query","description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"access_token","in":"query","description":"OAuth access token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"alt","in":"query","description":"Data format for response. (Acceptable values are: \"json\", \"media\", \"proto\")","style":"form","explode":true,"schema":{"type":"string","default":"json"}},{"name":"key","in":"query","description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"parent","in":"path","description":"Required. The project that the executed integration belongs to.","required":true,"style":"simple","schema":{"pattern":"^projects/[^/]+/locations/[^/]+$","type":"string"}}],"requestBody":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudIntegrationsV1alphaCreateAppsScriptProjectRequest"}}},"required":true},"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudIntegrationsV1alphaCreateAppsScriptProjectResponse"}}}}},"deprecated":false,"security":[{"httpBearer":["https://www.googleapis.com/auth/cloud-platform"]}]},"parameters":[]},"/v1/{parent}/appsScriptProjects:link":{"post":{"tags":["appsScriptProjects"],"summary":"LinkV1AppsScriptProjectsLinkByParent","description":"Links a existing Apps Script project.","operationId":"LinkV1AppsScriptProjectsLinkByParent","parameters":[{"name":"quotaUser","in":"query","description":"Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"prettyPrint","in":"query","description":"Returns response with indentations and line breaks.","style":"form","explode":true,"schema":{"type":"boolean","default":true}},{"name":"oauth_token","in":"query","description":"OAuth 2.0 token for the current user.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"uploadType","in":"query","description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"callback","in":"query","description":"JSONP","style":"form","explode":true,"schema":{"type":"string"}},{"name":"$.xgafv","in":"query","description":"V1 error format. (Acceptable values are: \"1\", \"2\")","style":"form","explode":true,"schema":{"type":"string","default":"1"}},{"name":"fields","in":"query","description":"Selector specifying which fields to include in a partial response.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"upload_protocol","in":"query","description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"access_token","in":"query","description":"OAuth access token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"alt","in":"query","description":"Data format for response. (Acceptable values are: \"json\", \"media\", \"proto\")","style":"form","explode":true,"schema":{"type":"string","default":"json"}},{"name":"key","in":"query","description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"parent","in":"path","description":"Required. The project that the executed integration belongs to.","required":true,"style":"simple","schema":{"pattern":"^projects/[^/]+/locations/[^/]+$","type":"string"}}],"requestBody":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudIntegrationsV1alphaLinkAppsScriptProjectRequest"}}},"required":true},"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudIntegrationsV1alphaLinkAppsScriptProjectResponse"}}}}},"deprecated":false,"security":[{"httpBearer":["https://www.googleapis.com/auth/cloud-platform"]}]},"parameters":[]},"/v1/{name}":{"patch":{"tags":["sfdcChannels"],"summary":"PatchV1ByName","description":"Updates an sfdc channel. Updates the sfdc channel in spanner. Returns the sfdc channel.","operationId":"PatchV1ByName","parameters":[{"name":"quotaUser","in":"query","description":"Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"prettyPrint","in":"query","description":"Returns response with indentations and line breaks.","style":"form","explode":true,"schema":{"type":"boolean","default":true}},{"name":"oauth_token","in":"query","description":"OAuth 2.0 token for the current user.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"uploadType","in":"query","description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"callback","in":"query","description":"JSONP","style":"form","explode":true,"schema":{"type":"string"}},{"name":"$.xgafv","in":"query","description":"V1 error format. (Acceptable values are: \"1\", \"2\")","style":"form","explode":true,"schema":{"type":"string","default":"1"}},{"name":"fields","in":"query","description":"Selector specifying which fields to include in a partial response.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"upload_protocol","in":"query","description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"access_token","in":"query","description":"OAuth access token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"alt","in":"query","description":"Data format for response. (Acceptable values are: \"json\", \"media\", \"proto\")","style":"form","explode":true,"schema":{"type":"string","default":"json"}},{"name":"key","in":"query","description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"name","in":"path","description":"Resource name of the SFDC channel projects/{project}/locations/{location}/sfdcInstances/{sfdc_instance}/sfdcChannels/{sfdc_channel}.","required":true,"style":"simple","schema":{"pattern":"^projects/[^/]+/locations/[^/]+/sfdcInstances/[^/]+/sfdcChannels/[^/]+$","type":"string"}},{"name":"updateMask","in":"query","description":"Field mask specifying the fields in the above SfdcChannel that have been modified and need to be updated.","style":"form","explode":true,"schema":{"type":"string"}}],"requestBody":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudIntegrationsV1alphaSfdcChannel"}}},"required":true},"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudIntegrationsV1alphaSfdcChannel"}}}}},"deprecated":false,"security":[{"httpBearer":["https://www.googleapis.com/auth/cloud-platform"]}]},"delete":{"tags":["sfdcChannels"],"summary":"DeleteV1ByName","description":"Deletes an sfdc channel.","operationId":"DeleteV1ByName","parameters":[{"name":"quotaUser","in":"query","description":"Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"prettyPrint","in":"query","description":"Returns response with indentations and line breaks.","style":"form","explode":true,"schema":{"type":"boolean","default":true}},{"name":"oauth_token","in":"query","description":"OAuth 2.0 token for the current user.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"uploadType","in":"query","description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"callback","in":"query","description":"JSONP","style":"form","explode":true,"schema":{"type":"string"}},{"name":"$.xgafv","in":"query","description":"V1 error format. (Acceptable values are: \"1\", \"2\")","style":"form","explode":true,"schema":{"type":"string","default":"1"}},{"name":"fields","in":"query","description":"Selector specifying which fields to include in a partial response.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"upload_protocol","in":"query","description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"access_token","in":"query","description":"OAuth access token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"alt","in":"query","description":"Data format for response. (Acceptable values are: \"json\", \"media\", \"proto\")","style":"form","explode":true,"schema":{"type":"string","default":"json"}},{"name":"key","in":"query","description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"name","in":"path","description":"Required. The name that is associated with the SfdcChannel.","required":true,"style":"simple","schema":{"pattern":"^projects/[^/]+/locations/[^/]+/sfdcInstances/[^/]+/sfdcChannels/[^/]+$","type":"string"}}],"responses":{"200":{"description":"","headers":{},"content":{"text/plain":{"schema":{"type":"object","contentMediaType":"text/plain"}}}}},"deprecated":false,"security":[{"httpBearer":["https://www.googleapis.com/auth/cloud-platform"]}]},"get":{"tags":["sfdcChannels"],"summary":"GetV1ByName","description":"Gets an sfdc channel. If the channel doesn't exist, Code.NOT_FOUND exception will be thrown.","operationId":"GetV1ByName","parameters":[{"name":"quotaUser","in":"query","description":"Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"prettyPrint","in":"query","description":"Returns response with indentations and line breaks.","style":"form","explode":true,"schema":{"type":"boolean","default":true}},{"name":"oauth_token","in":"query","description":"OAuth 2.0 token for the current user.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"uploadType","in":"query","description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"callback","in":"query","description":"JSONP","style":"form","explode":true,"schema":{"type":"string"}},{"name":"$.xgafv","in":"query","description":"V1 error format. (Acceptable values are: \"1\", \"2\")","style":"form","explode":true,"schema":{"type":"string","default":"1"}},{"name":"fields","in":"query","description":"Selector specifying which fields to include in a partial response.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"upload_protocol","in":"query","description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"access_token","in":"query","description":"OAuth access token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"alt","in":"query","description":"Data format for response. (Acceptable values are: \"json\", \"media\", \"proto\")","style":"form","explode":true,"schema":{"type":"string","default":"json"}},{"name":"key","in":"query","description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"name","in":"path","description":"Required. The name that is associated with the SfdcChannel.","required":true,"style":"simple","schema":{"pattern":"^projects/[^/]+/locations/[^/]+/sfdcInstances/[^/]+/sfdcChannels/[^/]+$","type":"string"}}],"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudIntegrationsV1alphaSfdcChannel"}}}}},"deprecated":false,"security":[{"httpBearer":["https://www.googleapis.com/auth/cloud-platform"]}]},"parameters":[]},"/v1/{parent}/sfdcChannels":{"post":{"tags":["sfdcChannels"],"summary":"CreateV1SfdcChannelsByParent","description":"Creates an sfdc channel record. Store the sfdc channel in Spanner. Returns the sfdc channel.","operationId":"CreateV1SfdcChannelsByParent","parameters":[{"name":"quotaUser","in":"query","description":"Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"prettyPrint","in":"query","description":"Returns response with indentations and line breaks.","style":"form","explode":true,"schema":{"type":"boolean","default":true}},{"name":"oauth_token","in":"query","description":"OAuth 2.0 token for the current user.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"uploadType","in":"query","description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"callback","in":"query","description":"JSONP","style":"form","explode":true,"schema":{"type":"string"}},{"name":"$.xgafv","in":"query","description":"V1 error format. (Acceptable values are: \"1\", \"2\")","style":"form","explode":true,"schema":{"type":"string","default":"1"}},{"name":"fields","in":"query","description":"Selector specifying which fields to include in a partial response.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"upload_protocol","in":"query","description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"access_token","in":"query","description":"OAuth access token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"alt","in":"query","description":"Data format for response. (Acceptable values are: \"json\", \"media\", \"proto\")","style":"form","explode":true,"schema":{"type":"string","default":"json"}},{"name":"key","in":"query","description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"parent","in":"path","description":"Required. \"projects/{project}/locations/{location}\" format.","required":true,"style":"simple","schema":{"pattern":"^projects/[^/]+/locations/[^/]+/sfdcInstances/[^/]+$","type":"string"}}],"requestBody":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudIntegrationsV1alphaSfdcChannel"}}},"required":true},"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudIntegrationsV1alphaSfdcChannel"}}}}},"deprecated":false,"security":[{"httpBearer":["https://www.googleapis.com/auth/cloud-platform"]}]},"get":{"tags":["sfdcChannels"],"summary":"ListV1SfdcChannelsByParent","description":"Lists all sfdc channels that match the filter. Restrict to sfdc channels belonging to the current client only.","operationId":"ListV1SfdcChannelsByParent","parameters":[{"name":"quotaUser","in":"query","description":"Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"prettyPrint","in":"query","description":"Returns response with indentations and line breaks.","style":"form","explode":true,"schema":{"type":"boolean","default":true}},{"name":"oauth_token","in":"query","description":"OAuth 2.0 token for the current user.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"uploadType","in":"query","description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"callback","in":"query","description":"JSONP","style":"form","explode":true,"schema":{"type":"string"}},{"name":"$.xgafv","in":"query","description":"V1 error format. (Acceptable values are: \"1\", \"2\")","style":"form","explode":true,"schema":{"type":"string","default":"1"}},{"name":"fields","in":"query","description":"Selector specifying which fields to include in a partial response.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"upload_protocol","in":"query","description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"access_token","in":"query","description":"OAuth access token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"alt","in":"query","description":"Data format for response. (Acceptable values are: \"json\", \"media\", \"proto\")","style":"form","explode":true,"schema":{"type":"string","default":"json"}},{"name":"key","in":"query","description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"filter","in":"query","description":"Filtering as supported in https://developers.google.com/authorized-buyers/apis/guides/v2/list-filters.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"pageSize","in":"query","description":"The size of entries in the response. If unspecified, defaults to 100.","style":"form","explode":true,"schema":{"type":"integer","contentEncoding":"int32"}},{"name":"readMask","in":"query","description":"The mask which specifies fields that need to be returned in the SfdcChannel's response.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"parent","in":"path","description":"Required. The client, which owns this collection of SfdcChannels.","required":true,"style":"simple","schema":{"pattern":"^projects/[^/]+/locations/[^/]+/sfdcInstances/[^/]+$","type":"string"}},{"name":"pageToken","in":"query","description":"The token returned in the previous response.","style":"form","explode":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudIntegrationsV1alphaListSfdcChannelsResponse"}}}}},"deprecated":false,"security":[{"httpBearer":["https://www.googleapis.com/auth/cloud-platform"]}]},"parameters":[]},"/v1/{parent}/sfdcInstances":{"get":{"tags":["sfdcInstances"],"summary":"ListV1SfdcInstancesByParent","description":"Lists all sfdc instances that match the filter. Restrict to sfdc instances belonging to the current client only.","operationId":"ListV1SfdcInstancesByParent","parameters":[{"name":"quotaUser","in":"query","description":"Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"prettyPrint","in":"query","description":"Returns response with indentations and line breaks.","style":"form","explode":true,"schema":{"type":"boolean","default":true}},{"name":"oauth_token","in":"query","description":"OAuth 2.0 token for the current user.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"uploadType","in":"query","description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"callback","in":"query","description":"JSONP","style":"form","explode":true,"schema":{"type":"string"}},{"name":"$.xgafv","in":"query","description":"V1 error format. (Acceptable values are: \"1\", \"2\")","style":"form","explode":true,"schema":{"type":"string","default":"1"}},{"name":"fields","in":"query","description":"Selector specifying which fields to include in a partial response.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"upload_protocol","in":"query","description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"access_token","in":"query","description":"OAuth access token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"alt","in":"query","description":"Data format for response. (Acceptable values are: \"json\", \"media\", \"proto\")","style":"form","explode":true,"schema":{"type":"string","default":"json"}},{"name":"key","in":"query","description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"filter","in":"query","description":"Filtering as supported in https://developers.google.com/authorized-buyers/apis/guides/v2/list-filters.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"pageSize","in":"query","description":"The size of entries in the response. If unspecified, defaults to 100.","style":"form","explode":true,"schema":{"type":"integer","contentEncoding":"int32"}},{"name":"pageToken","in":"query","description":"The token returned in the previous response.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"readMask","in":"query","description":"The mask which specifies fields that need to be returned in the SfdcInstance's response.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"parent","in":"path","description":"Required. The client, which owns this collection of SfdcInstances.","required":true,"style":"simple","schema":{"pattern":"^projects/[^/]+/locations/[^/]+$","type":"string"}}],"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudIntegrationsV1alphaListSfdcInstancesResponse"}}}}},"deprecated":false,"security":[{"httpBearer":["https://www.googleapis.com/auth/cloud-platform"]}]},"post":{"tags":["sfdcInstances"],"summary":"CreateV1SfdcInstancesByParent","description":"Creates an sfdc instance record. Store the sfdc instance in Spanner. Returns the sfdc instance.","operationId":"CreateV1SfdcInstancesByParent","parameters":[{"name":"quotaUser","in":"query","description":"Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"prettyPrint","in":"query","description":"Returns response with indentations and line breaks.","style":"form","explode":true,"schema":{"type":"boolean","default":true}},{"name":"oauth_token","in":"query","description":"OAuth 2.0 token for the current user.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"uploadType","in":"query","description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"callback","in":"query","description":"JSONP","style":"form","explode":true,"schema":{"type":"string"}},{"name":"$.xgafv","in":"query","description":"V1 error format. (Acceptable values are: \"1\", \"2\")","style":"form","explode":true,"schema":{"type":"string","default":"1"}},{"name":"fields","in":"query","description":"Selector specifying which fields to include in a partial response.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"upload_protocol","in":"query","description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"access_token","in":"query","description":"OAuth access token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"alt","in":"query","description":"Data format for response. (Acceptable values are: \"json\", \"media\", \"proto\")","style":"form","explode":true,"schema":{"type":"string","default":"json"}},{"name":"key","in":"query","description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"parent","in":"path","description":"Required. \"projects/{project}/locations/{location}\" format.","required":true,"style":"simple","schema":{"pattern":"^projects/[^/]+/locations/[^/]+$","type":"string"}}],"requestBody":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudIntegrationsV1alphaSfdcInstance"}}},"required":true},"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudIntegrationsV1alphaSfdcInstance"}}}}},"deprecated":false,"security":[{"httpBearer":["https://www.googleapis.com/auth/cloud-platform"]}]},"parameters":[]},"/v1/{parent}/executionsnapshots":{"get":{"tags":["executionsnapshots"],"summary":"ListV1ExecutionsnapshotsByParent","description":"Lists the snapshots of a given integration executions. This RPC is not being used.","operationId":"ListV1ExecutionsnapshotsByParent","parameters":[{"name":"quotaUser","in":"query","description":"Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"prettyPrint","in":"query","description":"Returns response with indentations and line breaks.","style":"form","explode":true,"schema":{"type":"boolean","default":true}},{"name":"oauth_token","in":"query","description":"OAuth 2.0 token for the current user.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"uploadType","in":"query","description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"callback","in":"query","description":"JSONP","style":"form","explode":true,"schema":{"type":"string"}},{"name":"$.xgafv","in":"query","description":"V1 error format. (Acceptable values are: \"1\", \"2\")","style":"form","explode":true,"schema":{"type":"string","default":"1"}},{"name":"fields","in":"query","description":"Selector specifying which fields to include in a partial response.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"upload_protocol","in":"query","description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"access_token","in":"query","description":"OAuth access token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"alt","in":"query","description":"Data format for response. (Acceptable values are: \"json\", \"media\", \"proto\")","style":"form","explode":true,"schema":{"type":"string","default":"json"}},{"name":"key","in":"query","description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"pageToken","in":"query","description":"The token used to retrieve the next page results.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"readMask","in":"query","description":"View mask for the response data. If set, only the field specified will be returned as part of the result. If not set, all fields in event execution snapshot will be filled and returned.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"pageSize","in":"query","description":"Number of entries to be returned in a page.","style":"form","explode":true,"schema":{"type":"integer","contentEncoding":"int32"}},{"name":"parent","in":"path","description":"Required. The parent resource name of the integration execution.","required":true,"style":"simple","schema":{"pattern":"^projects/[^/]+/locations/[^/]+/products/[^/]+/integrations/[^/]+$","type":"string"}},{"name":"filter","in":"query","description":"Currently supports filter by `execution_info_id` or `execution_snapshot_id`.","style":"form","explode":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudIntegrationsV1alphaListExecutionSnapshotsResponse"}}}}},"deprecated":false,"security":[{"httpBearer":["https://www.googleapis.com/auth/cloud-platform"]}]},"parameters":[]},"/v1/{name}:publish":{"post":{"tags":["versions"],"summary":"PublishV1PublishByName","description":"This RPC throws an exception if the integration is in ARCHIVED or ACTIVE state. This RPC throws an exception if the version being published is DRAFT, and if the `locked_by` user is not the same as the user performing the Publish. Audit fields updated include last_published_timestamp, last_published_by, last_modified_timestamp, last_modified_by. Any existing lock is on this integration is released.","operationId":"PublishV1PublishByName","parameters":[{"name":"quotaUser","in":"query","description":"Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"prettyPrint","in":"query","description":"Returns response with indentations and line breaks.","style":"form","explode":true,"schema":{"type":"boolean","default":true}},{"name":"oauth_token","in":"query","description":"OAuth 2.0 token for the current user.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"uploadType","in":"query","description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"callback","in":"query","description":"JSONP","style":"form","explode":true,"schema":{"type":"string"}},{"name":"$.xgafv","in":"query","description":"V1 error format. (Acceptable values are: \"1\", \"2\")","style":"form","explode":true,"schema":{"type":"string","default":"1"}},{"name":"fields","in":"query","description":"Selector specifying which fields to include in a partial response.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"upload_protocol","in":"query","description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"access_token","in":"query","description":"OAuth access token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"alt","in":"query","description":"Data format for response. (Acceptable values are: \"json\", \"media\", \"proto\")","style":"form","explode":true,"schema":{"type":"string","default":"json"}},{"name":"key","in":"query","description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"name","in":"path","description":"Required. The version to publish. Format: projects/{project}/locations/{location}/integrations/{integration}/versions/{version}","required":true,"style":"simple","schema":{"pattern":"^projects/[^/]+/locations/[^/]+/products/[^/]+/integrations/[^/]+/versions/[^/]+$","type":"string"}}],"requestBody":{"description":"","content":{"text/plain":{"schema":{"type":"object","contentMediaType":"text/plain"}}},"required":true},"responses":{"200":{"description":"","headers":{},"content":{"text/plain":{"schema":{"type":"object","contentMediaType":"text/plain"}}}}},"deprecated":false,"security":[{"httpBearer":["https://www.googleapis.com/auth/cloud-platform"]}]},"parameters":[]},"/v1/{name}:updateBundle":{"patch":{"tags":["versions"],"summary":"UpdateBundleV1UpdateBundleByName","description":"THIS METHOD WILL BE MOVED TO A SEPARATE SERVICE. RPC to update the Bundle","operationId":"UpdateBundleV1UpdateBundleByName","parameters":[{"name":"quotaUser","in":"query","description":"Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"prettyPrint","in":"query","description":"Returns response with indentations and line breaks.","style":"form","explode":true,"schema":{"type":"boolean","default":true}},{"name":"oauth_token","in":"query","description":"OAuth 2.0 token for the current user.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"uploadType","in":"query","description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"callback","in":"query","description":"JSONP","style":"form","explode":true,"schema":{"type":"string"}},{"name":"$.xgafv","in":"query","description":"V1 error format. (Acceptable values are: \"1\", \"2\")","style":"form","explode":true,"schema":{"type":"string","default":"1"}},{"name":"fields","in":"query","description":"Selector specifying which fields to include in a partial response.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"upload_protocol","in":"query","description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"access_token","in":"query","description":"OAuth access token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"alt","in":"query","description":"Data format for response. (Acceptable values are: \"json\", \"media\", \"proto\")","style":"form","explode":true,"schema":{"type":"string","default":"json"}},{"name":"key","in":"query","description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"name","in":"path","description":"Required. Bundle name","required":true,"style":"simple","schema":{"pattern":"^projects/[^/]+/locations/[^/]+/products/[^/]+/integrations/[^/]+/versions/[^/]+$","type":"string"}}],"requestBody":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudIntegrationsV1alphaUpdateBundleRequest"}}},"required":true},"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudIntegrationsV1alphaUpdateBundleResponse"}}}}},"deprecated":false,"security":[{"httpBearer":["https://www.googleapis.com/auth/cloud-platform"]}]},"parameters":[]},"/v1/{name}:getBundle":{"get":{"tags":["versions"],"summary":"GetBundleV1GetBundleByName","description":"PROTECT WITH A VISIBILITY LABEL. THIS METHOD WILL BE MOVED TO A SEPARATE SERVICE. RPC to get details of the Bundle","operationId":"GetBundleV1GetBundleByName","parameters":[{"name":"quotaUser","in":"query","description":"Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"prettyPrint","in":"query","description":"Returns response with indentations and line breaks.","style":"form","explode":true,"schema":{"type":"boolean","default":true}},{"name":"oauth_token","in":"query","description":"OAuth 2.0 token for the current user.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"uploadType","in":"query","description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"callback","in":"query","description":"JSONP","style":"form","explode":true,"schema":{"type":"string"}},{"name":"$.xgafv","in":"query","description":"V1 error format. (Acceptable values are: \"1\", \"2\")","style":"form","explode":true,"schema":{"type":"string","default":"1"}},{"name":"fields","in":"query","description":"Selector specifying which fields to include in a partial response.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"upload_protocol","in":"query","description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"access_token","in":"query","description":"OAuth access token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"alt","in":"query","description":"Data format for response. (Acceptable values are: \"json\", \"media\", \"proto\")","style":"form","explode":true,"schema":{"type":"string","default":"json"}},{"name":"key","in":"query","description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"name","in":"path","description":"Required. The bundle name.","required":true,"style":"simple","schema":{"pattern":"^projects/[^/]+/locations/[^/]+/products/[^/]+/integrations/[^/]+/versions/[^/]+$","type":"string"}}],"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudIntegrationsV1alphaGetBundleResponse"}}}}},"deprecated":false,"security":[{"httpBearer":["https://www.googleapis.com/auth/cloud-platform"]}]},"parameters":[]},"/v1/{parent}/versions":{"post":{"tags":["versions"],"summary":"CreateV1VersionsByParent","description":"Create a integration with a draft version in the specified project.","operationId":"CreateV1VersionsByParent","parameters":[{"name":"quotaUser","in":"query","description":"Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"prettyPrint","in":"query","description":"Returns response with indentations and line breaks.","style":"form","explode":true,"schema":{"type":"boolean","default":true}},{"name":"oauth_token","in":"query","description":"OAuth 2.0 token for the current user.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"uploadType","in":"query","description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"callback","in":"query","description":"JSONP","style":"form","explode":true,"schema":{"type":"string"}},{"name":"$.xgafv","in":"query","description":"V1 error format. (Acceptable values are: \"1\", \"2\")","style":"form","explode":true,"schema":{"type":"string","default":"1"}},{"name":"fields","in":"query","description":"Selector specifying which fields to include in a partial response.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"upload_protocol","in":"query","description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"access_token","in":"query","description":"OAuth access token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"alt","in":"query","description":"Data format for response. (Acceptable values are: \"json\", \"media\", \"proto\")","style":"form","explode":true,"schema":{"type":"string","default":"json"}},{"name":"key","in":"query","description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"parent","in":"path","description":"Required. The parent resource where this version will be created. Format: projects/{project}/locations/{location}/integrations/{integration}","required":true,"style":"simple","schema":{"pattern":"^projects/[^/]+/locations/[^/]+/products/[^/]+/integrations/[^/]+$","type":"string"}},{"name":"newIntegration","in":"query","description":"Set this flag to true, if draft version is to be created for a brand new integration. False, if the request is for an existing integration. For backward compatibility reasons, even if this flag is set to `false` and no existing integration is found, a new draft integration will still be created.","style":"form","explode":true,"schema":{"type":"boolean"}}],"requestBody":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationVersion"}}},"required":true},"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationVersion"}}}}},"deprecated":false,"security":[{"httpBearer":["https://www.googleapis.com/auth/cloud-platform"]}]},"get":{"tags":["versions"],"summary":"ListV1VersionsByParent","description":"Returns the list of all integration versions in the specified project.","operationId":"ListV1VersionsByParent","parameters":[{"name":"quotaUser","in":"query","description":"Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"prettyPrint","in":"query","description":"Returns response with indentations and line breaks.","style":"form","explode":true,"schema":{"type":"boolean","default":true}},{"name":"oauth_token","in":"query","description":"OAuth 2.0 token for the current user.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"uploadType","in":"query","description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"callback","in":"query","description":"JSONP","style":"form","explode":true,"schema":{"type":"string"}},{"name":"$.xgafv","in":"query","description":"V1 error format. (Acceptable values are: \"1\", \"2\")","style":"form","explode":true,"schema":{"type":"string","default":"1"}},{"name":"fields","in":"query","description":"Selector specifying which fields to include in a partial response.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"upload_protocol","in":"query","description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"access_token","in":"query","description":"OAuth access token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"alt","in":"query","description":"Data format for response. (Acceptable values are: \"json\", \"media\", \"proto\")","style":"form","explode":true,"schema":{"type":"string","default":"json"}},{"name":"key","in":"query","description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"fieldMask","in":"query","description":"The field mask which specifies the particular data to be returned.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"pageToken","in":"query","description":"A page token, received from a previous `ListIntegrationVersions` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListIntegrationVersions` must match the call that provided the page token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"filter","in":"query","description":"Filter on fields of IntegrationVersion. Fields can be compared with literal values by use of \":\" (containment), \"=\" (equality), \">\" (greater), \"<\" (less than), >=\" (greater than or equal to), \"<=\" (less than or equal to), and \"!=\" (inequality) operators. Negation, conjunction, and disjunction are written using NOT, AND, and OR keywords. For example, organization_id=\\\"1\\\" AND state=ACTIVE AND description:\"test\". Filtering cannot be performed on repeated fields like `task_config`.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"parent","in":"path","description":"Required. The parent resource where this version will be created. Format: projects/{project}/locations/{location}/integrations/{integration} Specifically, when parent equals: 1. projects//locations//integrations/, Meaning: \"List versions (with filter) for a particular integration\". 2. projects//locations//integrations/- Meaning: \"List versions (with filter) for a client within a particular region\". 3. projects//locations/-/integrations/- Meaning: \"List versions (with filter) for a client\".","required":true,"style":"simple","schema":{"pattern":"^projects/[^/]+/locations/[^/]+/products/[^/]+/integrations/[^/]+$","type":"string"}},{"name":"pageSize","in":"query","description":"The maximum number of versions to return. The service may return fewer than this value. If unspecified, at most 50 versions will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.","style":"form","explode":true,"schema":{"type":"integer","contentEncoding":"int32"}},{"name":"orderBy","in":"query","description":"The results would be returned in order you specified here. Currently supported sort keys are: Descending sort order for \"last_modified_time\", \"created_time\", \"snapshot_number\" Ascending sort order for \"name\".","style":"form","explode":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudIntegrationsV1alphaListIntegrationVersionsResponse"}}}}},"deprecated":false,"security":[{"httpBearer":["https://www.googleapis.com/auth/cloud-platform"]}]},"parameters":[]},"/v1/{parent}/versions:upload":{"post":{"tags":["versions"],"summary":"UploadV1VersionsUploadByParent","description":"Uploads an integration. The content can be a previously downloaded integration. Performs the same function as CreateDraftIntegrationVersion, but accepts input in a string format, which holds the complete representation of the IntegrationVersion content.","operationId":"UploadV1VersionsUploadByParent","parameters":[{"name":"quotaUser","in":"query","description":"Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"prettyPrint","in":"query","description":"Returns response with indentations and line breaks.","style":"form","explode":true,"schema":{"type":"boolean","default":true}},{"name":"oauth_token","in":"query","description":"OAuth 2.0 token for the current user.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"uploadType","in":"query","description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"callback","in":"query","description":"JSONP","style":"form","explode":true,"schema":{"type":"string"}},{"name":"$.xgafv","in":"query","description":"V1 error format. (Acceptable values are: \"1\", \"2\")","style":"form","explode":true,"schema":{"type":"string","default":"1"}},{"name":"fields","in":"query","description":"Selector specifying which fields to include in a partial response.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"upload_protocol","in":"query","description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"access_token","in":"query","description":"OAuth access token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"alt","in":"query","description":"Data format for response. (Acceptable values are: \"json\", \"media\", \"proto\")","style":"form","explode":true,"schema":{"type":"string","default":"json"}},{"name":"key","in":"query","description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"parent","in":"path","description":"Required. The version to upload. Format: projects/{project}/locations/{location}/integrations/{integration}","required":true,"style":"simple","schema":{"pattern":"^projects/[^/]+/locations/[^/]+/products/[^/]+/integrations/[^/]+$","type":"string"}}],"requestBody":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudIntegrationsV1alphaUploadIntegrationVersionRequest"}}},"required":true},"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudIntegrationsV1alphaUploadIntegrationVersionResponse"}}}}},"deprecated":false,"security":[{"httpBearer":["https://www.googleapis.com/auth/cloud-platform"]}]},"parameters":[]},"/v1/{name}:archive":{"post":{"tags":["versions"],"summary":"ArchiveV1ArchiveByName","description":"Soft-deletes the integration. Changes the status of the integration to ARCHIVED. If the integration being ARCHIVED is tagged as \"HEAD\", the tag is removed from this snapshot and set to the previous non-ARCHIVED snapshot. The PUBLISH_REQUESTED, DUE_FOR_DELETION tags are removed too. This RPC throws an exception if the version being archived is DRAFT, and if the `locked_by` user is not the same as the user performing the Archive. Audit fields updated include last_modified_timestamp, last_modified_by. Any existing lock is released when Archiving a integration. Currently, there is no unarchive mechanism.","operationId":"ArchiveV1ArchiveByName","parameters":[{"name":"quotaUser","in":"query","description":"Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"prettyPrint","in":"query","description":"Returns response with indentations and line breaks.","style":"form","explode":true,"schema":{"type":"boolean","default":true}},{"name":"oauth_token","in":"query","description":"OAuth 2.0 token for the current user.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"uploadType","in":"query","description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"callback","in":"query","description":"JSONP","style":"form","explode":true,"schema":{"type":"string"}},{"name":"$.xgafv","in":"query","description":"V1 error format. (Acceptable values are: \"1\", \"2\")","style":"form","explode":true,"schema":{"type":"string","default":"1"}},{"name":"fields","in":"query","description":"Selector specifying which fields to include in a partial response.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"upload_protocol","in":"query","description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"access_token","in":"query","description":"OAuth access token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"alt","in":"query","description":"Data format for response. (Acceptable values are: \"json\", \"media\", \"proto\")","style":"form","explode":true,"schema":{"type":"string","default":"json"}},{"name":"key","in":"query","description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"name","in":"path","description":"Required. The version to archive. Format: projects/{project}/locations/{location}/integrations/{integration}/versions/{version}","required":true,"style":"simple","schema":{"pattern":"^projects/[^/]+/locations/[^/]+/products/[^/]+/integrations/[^/]+/versions/[^/]+$","type":"string"}}],"requestBody":{"description":"","content":{"text/plain":{"schema":{"type":"object","contentMediaType":"text/plain"}}},"required":true},"responses":{"200":{"description":"","headers":{},"content":{"text/plain":{"schema":{"type":"object","contentMediaType":"text/plain"}}}}},"deprecated":false,"security":[{"httpBearer":["https://www.googleapis.com/auth/cloud-platform"]}]},"parameters":[]},"/v1/{name}:download":{"get":{"tags":["versions"],"summary":"DownloadV1DownloadByName","description":"Downloads an integration. Retrieves the `IntegrationVersion` for a given `integration_id` and returns the response as a string.","operationId":"DownloadV1DownloadByName","parameters":[{"name":"quotaUser","in":"query","description":"Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"prettyPrint","in":"query","description":"Returns response with indentations and line breaks.","style":"form","explode":true,"schema":{"type":"boolean","default":true}},{"name":"oauth_token","in":"query","description":"OAuth 2.0 token for the current user.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"uploadType","in":"query","description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"callback","in":"query","description":"JSONP","style":"form","explode":true,"schema":{"type":"string"}},{"name":"$.xgafv","in":"query","description":"V1 error format. (Acceptable values are: \"1\", \"2\")","style":"form","explode":true,"schema":{"type":"string","default":"1"}},{"name":"fields","in":"query","description":"Selector specifying which fields to include in a partial response.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"upload_protocol","in":"query","description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"access_token","in":"query","description":"OAuth access token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"alt","in":"query","description":"Data format for response. (Acceptable values are: \"json\", \"media\", \"proto\")","style":"form","explode":true,"schema":{"type":"string","default":"json"}},{"name":"key","in":"query","description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"name","in":"path","description":"Required. The version to download. Format: projects/{project}/locations/{location}/integrations/{integration}/versions/{version}","required":true,"style":"simple","schema":{"pattern":"^projects/[^/]+/locations/[^/]+/products/[^/]+/integrations/[^/]+/versions/[^/]+$","type":"string"}},{"name":"fileFormat","in":"query","description":"File format for download request. (Acceptable values are: \"FILE_FORMAT_UNSPECIFIED\", \"JSON\", \"YAML\")","style":"form","explode":true,"schema":{"type":"string","default":"FILE_FORMAT_UNSPECIFIED"}}],"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudIntegrationsV1alphaDownloadIntegrationVersionResponse"}}}}},"deprecated":false,"security":[{"httpBearer":["https://www.googleapis.com/auth/cloud-platform"]}]},"parameters":[]},"/v1/{name}:validate":{"post":{"tags":["versions"],"summary":"ValidateV1ValidateByName","description":"Validates the given integration. If the id doesn't exist, a NotFoundException is thrown. If validation fails a CanonicalCodeException is thrown. If there was no failure an empty response is returned.","operationId":"ValidateV1ValidateByName","parameters":[{"name":"quotaUser","in":"query","description":"Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"prettyPrint","in":"query","description":"Returns response with indentations and line breaks.","style":"form","explode":true,"schema":{"type":"boolean","default":true}},{"name":"oauth_token","in":"query","description":"OAuth 2.0 token for the current user.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"uploadType","in":"query","description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"callback","in":"query","description":"JSONP","style":"form","explode":true,"schema":{"type":"string"}},{"name":"$.xgafv","in":"query","description":"V1 error format. (Acceptable values are: \"1\", \"2\")","style":"form","explode":true,"schema":{"type":"string","default":"1"}},{"name":"fields","in":"query","description":"Selector specifying which fields to include in a partial response.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"upload_protocol","in":"query","description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"access_token","in":"query","description":"OAuth access token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"alt","in":"query","description":"Data format for response. (Acceptable values are: \"json\", \"media\", \"proto\")","style":"form","explode":true,"schema":{"type":"string","default":"json"}},{"name":"key","in":"query","description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"name","in":"path","description":"Required. The version to validate. Format: projects/{project}/locations/{location}/integrations/{integration}/versions/{version}","required":true,"style":"simple","schema":{"pattern":"^projects/[^/]+/locations/[^/]+/products/[^/]+/integrations/[^/]+/versions/[^/]+$","type":"string"}}],"requestBody":{"description":"","content":{"text/plain":{"schema":{"type":"object","contentMediaType":"text/plain"}}},"required":true},"responses":{"200":{"description":"","headers":{},"content":{"text/plain":{"schema":{"type":"object","contentMediaType":"text/plain"}}}}},"deprecated":false,"security":[{"httpBearer":["https://www.googleapis.com/auth/cloud-platform"]}]},"parameters":[]},"/v1/{integrationVersion}:takeoverEditLock":{"post":{"tags":["versions"],"summary":"TakeoverEditLockV1TakeoverEditLockByIntegrationVersion","description":"Clears the `locked_by` and `locked_at_timestamp`in the DRAFT version of this integration. It then performs the same action as the CreateDraftIntegrationVersion (i.e., copies the DRAFT version of the integration as a SNAPSHOT and then creates a new DRAFT version with the `locked_by` set to the `user_taking_over` and the `locked_at_timestamp` set to the current timestamp). Both the `locked_by` and `user_taking_over` are notified via email about the takeover. This RPC throws an exception if the integration is not in DRAFT status or if the `locked_by` and `locked_at_timestamp` fields are not set.The TakeoverEdit lock is treated the same as an edit of the integration, and hence shares ACLs with edit. Audit fields updated include last_modified_timestamp, last_modified_by.","operationId":"TakeoverEditLockV1TakeoverEditLockByIntegrationVersion","parameters":[{"name":"quotaUser","in":"query","description":"Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"prettyPrint","in":"query","description":"Returns response with indentations and line breaks.","style":"form","explode":true,"schema":{"type":"boolean","default":true}},{"name":"oauth_token","in":"query","description":"OAuth 2.0 token for the current user.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"uploadType","in":"query","description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"callback","in":"query","description":"JSONP","style":"form","explode":true,"schema":{"type":"string"}},{"name":"$.xgafv","in":"query","description":"V1 error format. (Acceptable values are: \"1\", \"2\")","style":"form","explode":true,"schema":{"type":"string","default":"1"}},{"name":"fields","in":"query","description":"Selector specifying which fields to include in a partial response.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"upload_protocol","in":"query","description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"access_token","in":"query","description":"OAuth access token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"alt","in":"query","description":"Data format for response. (Acceptable values are: \"json\", \"media\", \"proto\")","style":"form","explode":true,"schema":{"type":"string","default":"json"}},{"name":"key","in":"query","description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"integrationVersion","in":"path","description":"Required. The version to take over edit lock. Format: projects/{project}/locations/{location}/integrations/{integration}/versions/{version}","required":true,"style":"simple","schema":{"pattern":"^projects/[^/]+/locations/[^/]+/products/[^/]+/integrations/[^/]+/versions/[^/]+$","type":"string"}}],"requestBody":{"description":"","content":{"text/plain":{"schema":{"type":"object","contentMediaType":"text/plain"}}},"required":true},"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudIntegrationsV1alphaTakeoverEditLockResponse"}}}}},"deprecated":false,"security":[{"httpBearer":["https://www.googleapis.com/auth/cloud-platform"]}]},"parameters":[]},"/v1/{name}:unpublish":{"post":{"tags":["versions"],"summary":"UnpublishV1UnpublishByName","description":"Sets the status of the ACTIVE integration to SNAPSHOT with a new tag \"PREVIOUSLY_PUBLISHED\" after validating it. The \"HEAD\" and \"PUBLISH_REQUESTED\" tags do not change. This RPC throws an exception if the version being snapshot is not ACTIVE. Audit fields added include action, action_by, action_timestamp.","operationId":"UnpublishV1UnpublishByName","parameters":[{"name":"quotaUser","in":"query","description":"Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"prettyPrint","in":"query","description":"Returns response with indentations and line breaks.","style":"form","explode":true,"schema":{"type":"boolean","default":true}},{"name":"oauth_token","in":"query","description":"OAuth 2.0 token for the current user.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"uploadType","in":"query","description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"callback","in":"query","description":"JSONP","style":"form","explode":true,"schema":{"type":"string"}},{"name":"$.xgafv","in":"query","description":"V1 error format. (Acceptable values are: \"1\", \"2\")","style":"form","explode":true,"schema":{"type":"string","default":"1"}},{"name":"fields","in":"query","description":"Selector specifying which fields to include in a partial response.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"upload_protocol","in":"query","description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"access_token","in":"query","description":"OAuth access token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"alt","in":"query","description":"Data format for response. (Acceptable values are: \"json\", \"media\", \"proto\")","style":"form","explode":true,"schema":{"type":"string","default":"json"}},{"name":"key","in":"query","description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"name","in":"path","description":"Required. The version to deactivate. Format: projects/{project}/locations/{location}/integrations/{integration}/versions/{version}","required":true,"style":"simple","schema":{"pattern":"^projects/[^/]+/locations/[^/]+/products/[^/]+/integrations/[^/]+/versions/[^/]+$","type":"string"}}],"requestBody":{"description":"","content":{"text/plain":{"schema":{"type":"object","contentMediaType":"text/plain"}}},"required":true},"responses":{"200":{"description":"","headers":{},"content":{"text/plain":{"schema":{"type":"object","contentMediaType":"text/plain"}}}}},"deprecated":false,"security":[{"httpBearer":["https://www.googleapis.com/auth/cloud-platform"]}]},"parameters":[]},"/v1/{name}:deactivate":{"post":{"tags":["versions"],"summary":"DeactivateV1DeactivateByName","description":"Sets the status of the ACTIVE integration to SNAPSHOT with a new tag \"PREVIOUSLY_PUBLISHED\" after validating it. The \"HEAD\" and \"PUBLISH_REQUESTED\" tags do not change. This RPC throws an exception if the version being snapshot is not ACTIVE. Audit fields added include action, action_by, action_timestamp.","operationId":"DeactivateV1DeactivateByName","parameters":[{"name":"quotaUser","in":"query","description":"Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"prettyPrint","in":"query","description":"Returns response with indentations and line breaks.","style":"form","explode":true,"schema":{"type":"boolean","default":true}},{"name":"oauth_token","in":"query","description":"OAuth 2.0 token for the current user.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"uploadType","in":"query","description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"callback","in":"query","description":"JSONP","style":"form","explode":true,"schema":{"type":"string"}},{"name":"$.xgafv","in":"query","description":"V1 error format. (Acceptable values are: \"1\", \"2\")","style":"form","explode":true,"schema":{"type":"string","default":"1"}},{"name":"fields","in":"query","description":"Selector specifying which fields to include in a partial response.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"upload_protocol","in":"query","description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"access_token","in":"query","description":"OAuth access token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"alt","in":"query","description":"Data format for response. (Acceptable values are: \"json\", \"media\", \"proto\")","style":"form","explode":true,"schema":{"type":"string","default":"json"}},{"name":"key","in":"query","description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"name","in":"path","description":"Required. The version to deactivate. Format: projects/{project}/locations/{location}/integrations/{integration}/versions/{version}","required":true,"style":"simple","schema":{"pattern":"^projects/[^/]+/locations/[^/]+/products/[^/]+/integrations/[^/]+/versions/[^/]+$","type":"string"}}],"requestBody":{"description":"","content":{"text/plain":{"schema":{"type":"object","contentMediaType":"text/plain"}}},"required":true},"responses":{"200":{"description":"","headers":{},"content":{"text/plain":{"schema":{"type":"object","contentMediaType":"text/plain"}}}}},"deprecated":false,"security":[{"httpBearer":["https://www.googleapis.com/auth/cloud-platform"]}]},"parameters":[]},"/v1/{name}:lift":{"post":{"tags":["suspensions"],"summary":"LiftV1LiftByName","description":"* Lifts suspension for advanced suspension task. Fetch corresponding suspension with provided suspension Id, resolve suspension, and set up suspension result for the Suspension Task.","operationId":"LiftV1LiftByName","parameters":[{"name":"quotaUser","in":"query","description":"Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"prettyPrint","in":"query","description":"Returns response with indentations and line breaks.","style":"form","explode":true,"schema":{"type":"boolean","default":true}},{"name":"oauth_token","in":"query","description":"OAuth 2.0 token for the current user.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"uploadType","in":"query","description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"callback","in":"query","description":"JSONP","style":"form","explode":true,"schema":{"type":"string"}},{"name":"$.xgafv","in":"query","description":"V1 error format. (Acceptable values are: \"1\", \"2\")","style":"form","explode":true,"schema":{"type":"string","default":"1"}},{"name":"fields","in":"query","description":"Selector specifying which fields to include in a partial response.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"upload_protocol","in":"query","description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"access_token","in":"query","description":"OAuth access token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"alt","in":"query","description":"Data format for response. (Acceptable values are: \"json\", \"media\", \"proto\")","style":"form","explode":true,"schema":{"type":"string","default":"json"}},{"name":"key","in":"query","description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"name","in":"path","description":"Required. The resource that the suspension belongs to. \"projects/{project}/locations/{location}/products/{product}/integrations/{integration}/executions/{execution}/suspensions/{suspenion}\" format.","required":true,"style":"simple","schema":{"pattern":"^projects/[^/]+/locations/[^/]+/products/[^/]+/integrations/[^/]+/executions/[^/]+/suspensions/[^/]+$","type":"string"}}],"requestBody":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudIntegrationsV1alphaLiftSuspensionRequest"}}},"required":true},"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudIntegrationsV1alphaLiftSuspensionResponse"}}}}},"deprecated":false,"security":[{"httpBearer":["https://www.googleapis.com/auth/cloud-platform"]}]},"parameters":[]},"/v1/{parent}/suspensions":{"get":{"tags":["suspensions"],"summary":"ListV1SuspensionsByParent","description":"* Lists suspensions associated with a specific execution. Only those with permissions to resolve the relevant suspensions will be able to view them.","operationId":"ListV1SuspensionsByParent","parameters":[{"name":"quotaUser","in":"query","description":"Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"prettyPrint","in":"query","description":"Returns response with indentations and line breaks.","style":"form","explode":true,"schema":{"type":"boolean","default":true}},{"name":"oauth_token","in":"query","description":"OAuth 2.0 token for the current user.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"uploadType","in":"query","description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"callback","in":"query","description":"JSONP","style":"form","explode":true,"schema":{"type":"string"}},{"name":"$.xgafv","in":"query","description":"V1 error format. (Acceptable values are: \"1\", \"2\")","style":"form","explode":true,"schema":{"type":"string","default":"1"}},{"name":"fields","in":"query","description":"Selector specifying which fields to include in a partial response.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"upload_protocol","in":"query","description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"access_token","in":"query","description":"OAuth access token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"alt","in":"query","description":"Data format for response. (Acceptable values are: \"json\", \"media\", \"proto\")","style":"form","explode":true,"schema":{"type":"string","default":"json"}},{"name":"key","in":"query","description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"parent","in":"path","description":"Required. projects/{gcp_project_id}/locations/{location}/products/{product}/integrations/{integration_name}/executions/{execution_name}","required":true,"style":"simple","schema":{"pattern":"^projects/[^/]+/locations/[^/]+/products/[^/]+/integrations/[^/]+/executions/[^/]+$","type":"string"}},{"name":"pageToken","in":"query","description":"Token to retrieve a specific page.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"orderBy","in":"query","description":"Field name to order by.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"pageSize","in":"query","description":"Maximum number of entries in the response.","style":"form","explode":true,"schema":{"type":"integer","contentEncoding":"int32"}},{"name":"filter","in":"query","description":"Standard filter field.","style":"form","explode":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudIntegrationsV1alphaListSuspensionsResponse"}}}}},"deprecated":false,"security":[{"httpBearer":["https://www.googleapis.com/auth/cloud-platform"]}]},"parameters":[]},"/v1/{name}:resolve":{"post":{"tags":["suspensions"],"summary":"ResolveV1ResolveByName","description":"* Resolves (lifts/rejects) any number of suspensions. If the integration is already running, only the status of the suspension is updated. Otherwise, the suspended integration will begin execution again.","operationId":"ResolveV1ResolveByName","parameters":[{"name":"quotaUser","in":"query","description":"Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"prettyPrint","in":"query","description":"Returns response with indentations and line breaks.","style":"form","explode":true,"schema":{"type":"boolean","default":true}},{"name":"oauth_token","in":"query","description":"OAuth 2.0 token for the current user.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"uploadType","in":"query","description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"callback","in":"query","description":"JSONP","style":"form","explode":true,"schema":{"type":"string"}},{"name":"$.xgafv","in":"query","description":"V1 error format. (Acceptable values are: \"1\", \"2\")","style":"form","explode":true,"schema":{"type":"string","default":"1"}},{"name":"fields","in":"query","description":"Selector specifying which fields to include in a partial response.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"upload_protocol","in":"query","description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"access_token","in":"query","description":"OAuth access token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"alt","in":"query","description":"Data format for response. (Acceptable values are: \"json\", \"media\", \"proto\")","style":"form","explode":true,"schema":{"type":"string","default":"json"}},{"name":"key","in":"query","description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"name","in":"path","description":"Required. projects/{gcp_project_id}/locations/{location}/products/{product}/integrations/{integration_name}/executions/{execution_name}/suspensions/{suspension_id}","required":true,"style":"simple","schema":{"pattern":"^projects/[^/]+/locations/[^/]+/products/[^/]+/integrations/[^/]+/executions/[^/]+/suspensions/[^/]+$","type":"string"}}],"requestBody":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudIntegrationsV1alphaResolveSuspensionRequest"}}},"required":true},"responses":{"200":{"description":"","headers":{},"content":{"text/plain":{"schema":{"type":"object","contentMediaType":"text/plain"}}}}},"deprecated":false,"security":[{"httpBearer":["https://www.googleapis.com/auth/cloud-platform"]}]},"parameters":[]},"/v1/{name}:cancel":{"post":{"tags":["executions"],"summary":"CancelV1CancelByName","description":"Cancellation of an execution","operationId":"CancelV1CancelByName","parameters":[{"name":"quotaUser","in":"query","description":"Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"prettyPrint","in":"query","description":"Returns response with indentations and line breaks.","style":"form","explode":true,"schema":{"type":"boolean","default":true}},{"name":"oauth_token","in":"query","description":"OAuth 2.0 token for the current user.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"uploadType","in":"query","description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"callback","in":"query","description":"JSONP","style":"form","explode":true,"schema":{"type":"string"}},{"name":"$.xgafv","in":"query","description":"V1 error format. (Acceptable values are: \"1\", \"2\")","style":"form","explode":true,"schema":{"type":"string","default":"1"}},{"name":"fields","in":"query","description":"Selector specifying which fields to include in a partial response.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"upload_protocol","in":"query","description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"access_token","in":"query","description":"OAuth access token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"alt","in":"query","description":"Data format for response. (Acceptable values are: \"json\", \"media\", \"proto\")","style":"form","explode":true,"schema":{"type":"string","default":"json"}},{"name":"key","in":"query","description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"name","in":"path","description":"Required. The execution resource name. Format: projects/{gcp_project_id}/locations/{location}/products/{product}/integrations/{integration_id}/executions/{execution_id}","required":true,"style":"simple","schema":{"pattern":"^projects/[^/]+/locations/[^/]+/products/[^/]+/integrations/[^/]+/executions/[^/]+$","type":"string"}}],"requestBody":{"description":"","content":{"text/plain":{"schema":{"type":"object","contentMediaType":"text/plain"}}},"required":true},"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudIntegrationsV1alphaCancelExecutionResponse"}}}}},"deprecated":false,"security":[{"httpBearer":["https://www.googleapis.com/auth/cloud-platform"]}]},"parameters":[]},"/v1/{parent}/executions":{"get":{"tags":["executions"],"summary":"ListV1ExecutionsByParent","description":"Lists the results of all the integration executions. The response includes the same information as the [execution log](https://cloud.google.com/application-integration/docs/viewing-logs) in the Integration UI.","operationId":"ListV1ExecutionsByParent","parameters":[{"name":"quotaUser","in":"query","description":"Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"prettyPrint","in":"query","description":"Returns response with indentations and line breaks.","style":"form","explode":true,"schema":{"type":"boolean","default":true}},{"name":"oauth_token","in":"query","description":"OAuth 2.0 token for the current user.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"uploadType","in":"query","description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"callback","in":"query","description":"JSONP","style":"form","explode":true,"schema":{"type":"string"}},{"name":"$.xgafv","in":"query","description":"V1 error format. (Acceptable values are: \"1\", \"2\")","style":"form","explode":true,"schema":{"type":"string","default":"1"}},{"name":"fields","in":"query","description":"Selector specifying which fields to include in a partial response.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"upload_protocol","in":"query","description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"access_token","in":"query","description":"OAuth access token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"alt","in":"query","description":"Data format for response. (Acceptable values are: \"json\", \"media\", \"proto\")","style":"form","explode":true,"schema":{"type":"string","default":"json"}},{"name":"key","in":"query","description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"parent","in":"path","description":"Required. The parent resource name of the integration execution.","required":true,"style":"simple","schema":{"pattern":"^projects/[^/]+/locations/[^/]+/products/[^/]+/integrations/[^/]+$","type":"string"}},{"name":"filterParams.workflowName","in":"query","description":"Workflow name.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"readMask","in":"query","description":"Optional. View mask for the response data. If set, only the field specified will be returned as part of the result. If not set, all fields in event execution info will be filled and returned.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"filterParams.parameterKey","in":"query","description":"Param key. DEPRECATED. User parameter_pair_key instead.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"orderBy","in":"query","description":"Optional. The results would be returned in order you specified here. Currently supporting \"last_modified_time\" and \"create_time\".","style":"form","explode":true,"schema":{"type":"string"}},{"name":"pageToken","in":"query","description":"Optional. The token returned in the previous response.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"filterParams.taskStatuses","in":"query","description":"List of possible task statuses.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"filterParams.startTime","in":"query","description":"Start timestamp.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"pageSize","in":"query","description":"Optional. The size of entries in the response.","style":"form","explode":true,"schema":{"type":"integer","contentEncoding":"int32"}},{"name":"filterParams.eventStatuses","in":"query","description":"List of possible event statuses.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"truncateParams","in":"query","description":"Optional. If true, the service will truncate the params to only keep the first 1000 characters of string params and empty the executions in order to make response smaller. Only works for UI and when the params fields are not filtered out.","style":"form","explode":true,"schema":{"type":"boolean"}},{"name":"filterParams.parameterPairKey","in":"query","description":"Param key in the key value pair filter.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"filterParams.endTime","in":"query","description":"End timestamp.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"filterParams.parameterType","in":"query","description":"Param type.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"filterParams.parameterValue","in":"query","description":"Param value. DEPRECATED. User parameter_pair_value instead.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"filterParams.customFilter","in":"query","description":"Optional user-provided custom filter.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"filterParams.executionId","in":"query","description":"Execution id.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"filter","in":"query","description":"Optional. Standard filter field, we support filtering on all fields in EventExecutionParamIndexes table. All fields support for EQUALS, in additional: CreateTimestamp support for LESS_THAN, GREATER_THAN ParameterKey, ParameterValue, ParameterType support for HAS For example: \"parameter_value\" HAS \\\"parameter1\\\" Also supports operators like AND, OR, NOT For example, trigger_id=\\\"id1\\\" AND event_execution_state=\\\"FAILED\\\"","style":"form","explode":true,"schema":{"type":"string"}},{"name":"filterParams.parameterPairValue","in":"query","description":"Param value in the key value pair filter.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"refreshAcl","in":"query","description":"Optional. If true, the service will use the most recent acl information to list event execution infos and renew the acl cache. Note that fetching the most recent acl is synchronous, so it will increase RPC call latency.","style":"form","explode":true,"schema":{"type":"boolean"}}],"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudIntegrationsV1alphaListExecutionsResponse"}}}}},"deprecated":false,"security":[{"httpBearer":["https://www.googleapis.com/auth/cloud-platform"]}]},"parameters":[]},"/v1/{name}:schedule":{"post":{"tags":["integrations"],"summary":"ScheduleV1ScheduleByName","description":"Schedules an integration for execution by passing the trigger id and the scheduled time in the request body.","operationId":"ScheduleV1ScheduleByName","parameters":[{"name":"quotaUser","in":"query","description":"Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"prettyPrint","in":"query","description":"Returns response with indentations and line breaks.","style":"form","explode":true,"schema":{"type":"boolean","default":true}},{"name":"oauth_token","in":"query","description":"OAuth 2.0 token for the current user.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"uploadType","in":"query","description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"callback","in":"query","description":"JSONP","style":"form","explode":true,"schema":{"type":"string"}},{"name":"$.xgafv","in":"query","description":"V1 error format. (Acceptable values are: \"1\", \"2\")","style":"form","explode":true,"schema":{"type":"string","default":"1"}},{"name":"fields","in":"query","description":"Selector specifying which fields to include in a partial response.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"upload_protocol","in":"query","description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"access_token","in":"query","description":"OAuth access token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"alt","in":"query","description":"Data format for response. (Acceptable values are: \"json\", \"media\", \"proto\")","style":"form","explode":true,"schema":{"type":"string","default":"json"}},{"name":"key","in":"query","description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"name","in":"path","description":"The integration resource name.","required":true,"style":"simple","schema":{"pattern":"^projects/[^/]+/locations/[^/]+/products/[^/]+/integrations/[^/]+$","type":"string"}}],"requestBody":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudIntegrationsV1alphaScheduleIntegrationsRequest"}}},"required":true},"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudIntegrationsV1alphaScheduleIntegrationsResponse"}}}}},"deprecated":false,"security":[{"httpBearer":["https://www.googleapis.com/auth/cloud-platform"]}]},"parameters":[]},"/v1/{name}:archiveBundle":{"post":{"tags":["integrations"],"summary":"ArchiveBundleV1ArchiveBundleByName","description":"PROTECT WITH A VISIBILITY LABEL. THIS METHOD WILL BE MOVED TO A SEPARATE SERVICE. Soft-deletes the bundle.","operationId":"ArchiveBundleV1ArchiveBundleByName","parameters":[{"name":"quotaUser","in":"query","description":"Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"prettyPrint","in":"query","description":"Returns response with indentations and line breaks.","style":"form","explode":true,"schema":{"type":"boolean","default":true}},{"name":"oauth_token","in":"query","description":"OAuth 2.0 token for the current user.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"uploadType","in":"query","description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"callback","in":"query","description":"JSONP","style":"form","explode":true,"schema":{"type":"string"}},{"name":"$.xgafv","in":"query","description":"V1 error format. (Acceptable values are: \"1\", \"2\")","style":"form","explode":true,"schema":{"type":"string","default":"1"}},{"name":"fields","in":"query","description":"Selector specifying which fields to include in a partial response.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"upload_protocol","in":"query","description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"access_token","in":"query","description":"OAuth access token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"alt","in":"query","description":"Data format for response. (Acceptable values are: \"json\", \"media\", \"proto\")","style":"form","explode":true,"schema":{"type":"string","default":"json"}},{"name":"key","in":"query","description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"name","in":"path","description":"Required. The bundle to archive. Format: projects/{project}/locations/{location}/integrations/{integration}","required":true,"style":"simple","schema":{"pattern":"^projects/[^/]+/locations/[^/]+/products/[^/]+/integrations/[^/]+$","type":"string"}}],"requestBody":{"description":"","content":{"text/plain":{"schema":{"type":"object","contentMediaType":"text/plain"}}},"required":true},"responses":{"200":{"description":"","headers":{},"content":{"text/plain":{"schema":{"type":"object","contentMediaType":"text/plain"}}}}},"deprecated":false,"security":[{"httpBearer":["https://www.googleapis.com/auth/cloud-platform"]}]},"parameters":[]},"/v1/{name}:test":{"post":{"tags":["integrations"],"summary":"TestV1TestByName","description":"Execute the integration in draft state","operationId":"TestV1TestByName","parameters":[{"name":"quotaUser","in":"query","description":"Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"prettyPrint","in":"query","description":"Returns response with indentations and line breaks.","style":"form","explode":true,"schema":{"type":"boolean","default":true}},{"name":"oauth_token","in":"query","description":"OAuth 2.0 token for the current user.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"uploadType","in":"query","description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"callback","in":"query","description":"JSONP","style":"form","explode":true,"schema":{"type":"string"}},{"name":"$.xgafv","in":"query","description":"V1 error format. (Acceptable values are: \"1\", \"2\")","style":"form","explode":true,"schema":{"type":"string","default":"1"}},{"name":"fields","in":"query","description":"Selector specifying which fields to include in a partial response.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"upload_protocol","in":"query","description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"access_token","in":"query","description":"OAuth access token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"alt","in":"query","description":"Data format for response. (Acceptable values are: \"json\", \"media\", \"proto\")","style":"form","explode":true,"schema":{"type":"string","default":"json"}},{"name":"key","in":"query","description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"name","in":"path","description":"Output only. Auto-generated primary key.","required":true,"style":"simple","schema":{"pattern":"^projects/[^/]+/locations/[^/]+/products/[^/]+/integrations/[^/]+$","type":"string"}}],"requestBody":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudIntegrationsV1alphaTestIntegrationsRequest"}}},"required":true},"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudIntegrationsV1alphaTestIntegrationsResponse"}}}}},"deprecated":false,"security":[{"httpBearer":["https://www.googleapis.com/auth/cloud-platform"]}]},"parameters":[]},"/v1/{parent}:monitorexecutionstats":{"post":{"tags":["integrations"],"summary":"MonitorexecutionstatsV1MonitorexecutionstatsByParent","description":"Get execution stats","operationId":"MonitorexecutionstatsV1MonitorexecutionstatsByParent","parameters":[{"name":"quotaUser","in":"query","description":"Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"prettyPrint","in":"query","description":"Returns response with indentations and line breaks.","style":"form","explode":true,"schema":{"type":"boolean","default":true}},{"name":"oauth_token","in":"query","description":"OAuth 2.0 token for the current user.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"uploadType","in":"query","description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"callback","in":"query","description":"JSONP","style":"form","explode":true,"schema":{"type":"string"}},{"name":"$.xgafv","in":"query","description":"V1 error format. (Acceptable values are: \"1\", \"2\")","style":"form","explode":true,"schema":{"type":"string","default":"1"}},{"name":"fields","in":"query","description":"Selector specifying which fields to include in a partial response.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"upload_protocol","in":"query","description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"access_token","in":"query","description":"OAuth access token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"alt","in":"query","description":"Data format for response. (Acceptable values are: \"json\", \"media\", \"proto\")","style":"form","explode":true,"schema":{"type":"string","default":"json"}},{"name":"key","in":"query","description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"parent","in":"path","description":"Required. The parent resource name: {parent=projects/*/locations/*}.","required":true,"style":"simple","schema":{"pattern":"^projects/[^/]+/locations/[^/]+/products/[^/]+/integrations/[^/]+$","type":"string"}}],"requestBody":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudIntegrationsV1alphaMonitorExecutionStatsRequest"}}},"required":true},"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudIntegrationsV1alphaMonitorExecutionStatsResponse"}}}}},"deprecated":false,"security":[{"httpBearer":["https://www.googleapis.com/auth/cloud-platform"]}]},"parameters":[]},"/v1/{name}:execute":{"post":{"tags":["integrations"],"summary":"ExecuteV1ExecuteByName","description":"Executes integrations synchronously by passing the trigger id in the request body. The request is not returned until the requested executions are either fulfilled or experienced an error. If the integration name is not specified (passing `-`), all of the associated integration under the given trigger_id will be executed. Otherwise only the specified integration for the given `trigger_id` is executed. This is helpful for execution the integration from UI.","operationId":"ExecuteV1ExecuteByName","parameters":[{"name":"quotaUser","in":"query","description":"Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"prettyPrint","in":"query","description":"Returns response with indentations and line breaks.","style":"form","explode":true,"schema":{"type":"boolean","default":true}},{"name":"oauth_token","in":"query","description":"OAuth 2.0 token for the current user.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"uploadType","in":"query","description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"callback","in":"query","description":"JSONP","style":"form","explode":true,"schema":{"type":"string"}},{"name":"$.xgafv","in":"query","description":"V1 error format. (Acceptable values are: \"1\", \"2\")","style":"form","explode":true,"schema":{"type":"string","default":"1"}},{"name":"fields","in":"query","description":"Selector specifying which fields to include in a partial response.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"upload_protocol","in":"query","description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"access_token","in":"query","description":"OAuth access token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"alt","in":"query","description":"Data format for response. (Acceptable values are: \"json\", \"media\", \"proto\")","style":"form","explode":true,"schema":{"type":"string","default":"json"}},{"name":"key","in":"query","description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"name","in":"path","description":"Required. The integration resource name.","required":true,"style":"simple","schema":{"pattern":"^projects/[^/]+/locations/[^/]+/products/[^/]+/integrations/[^/]+$","type":"string"}}],"requestBody":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudIntegrationsV1alphaExecuteIntegrationsRequest"}}},"required":true},"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudIntegrationsV1alphaExecuteIntegrationsResponse"}}}}},"deprecated":false,"security":[{"httpBearer":["https://www.googleapis.com/auth/cloud-platform"]}]},"parameters":[]},"/v1/{parent}/integrations":{"get":{"tags":["integrations"],"summary":"ListV1IntegrationsByParent","description":"Returns the list of all integrations in the specified project.","operationId":"ListV1IntegrationsByParent","parameters":[{"name":"quotaUser","in":"query","description":"Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"prettyPrint","in":"query","description":"Returns response with indentations and line breaks.","style":"form","explode":true,"schema":{"type":"boolean","default":true}},{"name":"oauth_token","in":"query","description":"OAuth 2.0 token for the current user.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"uploadType","in":"query","description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"callback","in":"query","description":"JSONP","style":"form","explode":true,"schema":{"type":"string"}},{"name":"$.xgafv","in":"query","description":"V1 error format. (Acceptable values are: \"1\", \"2\")","style":"form","explode":true,"schema":{"type":"string","default":"1"}},{"name":"fields","in":"query","description":"Selector specifying which fields to include in a partial response.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"upload_protocol","in":"query","description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"access_token","in":"query","description":"OAuth access token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"alt","in":"query","description":"Data format for response. (Acceptable values are: \"json\", \"media\", \"proto\")","style":"form","explode":true,"schema":{"type":"string","default":"json"}},{"name":"key","in":"query","description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"parent","in":"path","description":"Required. Project and location from which the integrations should be listed. Format: projects/{project}","required":true,"style":"simple","schema":{"pattern":"^projects/[^/]+/locations/[^/]+/products/[^/]+$","type":"string"}},{"name":"orderBy","in":"query","description":"The results would be returned in order you specified here. Supported sort keys are: Descending sort order by \"last_modified_time\", \"created_time\", \"snapshot_number\". Ascending sort order by the integration name.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"pageSize","in":"query","description":"The page size for the resquest.","style":"form","explode":true,"schema":{"type":"integer","contentEncoding":"int32"}},{"name":"pageToken","in":"query","description":"The page token for the resquest.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"filter","in":"query","description":"Filter on fields of IntegrationVersion. Fields can be compared with literal values by use of \":\" (containment), \"=\" (equality), \">\" (greater), \"<\" (less than), >=\" (greater than or equal to), \"<=\" (less than or equal to), and \"!=\" (inequality) operators. Negation, conjunction, and disjunction are written using NOT, AND, and OR keywords. For example, organization_id=\\\"1\\\" AND state=ACTIVE AND description:\"test\". Filtering cannot be performed on repeated fields like `task_config`.","style":"form","explode":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudIntegrationsV1alphaListIntegrationsResponse"}}}}},"deprecated":false,"security":[{"httpBearer":["https://www.googleapis.com/auth/cloud-platform"]}]},"parameters":[]},"/v1/{parent}/cloudFunctions":{"post":{"tags":["cloudFunctions"],"summary":"CreateV1CloudFunctionsByParent","description":"Creates an cloud function project.","operationId":"CreateV1CloudFunctionsByParent","parameters":[{"name":"quotaUser","in":"query","description":"Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"prettyPrint","in":"query","description":"Returns response with indentations and line breaks.","style":"form","explode":true,"schema":{"type":"boolean","default":true}},{"name":"oauth_token","in":"query","description":"OAuth 2.0 token for the current user.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"uploadType","in":"query","description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"callback","in":"query","description":"JSONP","style":"form","explode":true,"schema":{"type":"string"}},{"name":"$.xgafv","in":"query","description":"V1 error format. (Acceptable values are: \"1\", \"2\")","style":"form","explode":true,"schema":{"type":"string","default":"1"}},{"name":"fields","in":"query","description":"Selector specifying which fields to include in a partial response.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"upload_protocol","in":"query","description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"access_token","in":"query","description":"OAuth access token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"alt","in":"query","description":"Data format for response. (Acceptable values are: \"json\", \"media\", \"proto\")","style":"form","explode":true,"schema":{"type":"string","default":"json"}},{"name":"key","in":"query","description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"parent","in":"path","description":"Required. The project that the executed integration belongs to.","required":true,"style":"simple","schema":{"pattern":"^projects/[^/]+/locations/[^/]+/products/[^/]+$","type":"string"}}],"requestBody":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudIntegrationsV1alphaCreateCloudFunctionRequest"}}},"required":true},"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudIntegrationsV1alphaCreateCloudFunctionResponse"}}}}},"deprecated":false,"security":[{"httpBearer":["https://www.googleapis.com/auth/cloud-platform"]}]},"parameters":[]},"/v1/{parent}/authConfigs":{"get":{"tags":["authConfigs"],"summary":"ListV1AuthConfigsByParent","description":"Lists all auth configs that match the filter. Restrict to auth configs belong to the current client only.","operationId":"ListV1AuthConfigsByParent","parameters":[{"name":"quotaUser","in":"query","description":"Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"prettyPrint","in":"query","description":"Returns response with indentations and line breaks.","style":"form","explode":true,"schema":{"type":"boolean","default":true}},{"name":"oauth_token","in":"query","description":"OAuth 2.0 token for the current user.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"uploadType","in":"query","description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"callback","in":"query","description":"JSONP","style":"form","explode":true,"schema":{"type":"string"}},{"name":"$.xgafv","in":"query","description":"V1 error format. (Acceptable values are: \"1\", \"2\")","style":"form","explode":true,"schema":{"type":"string","default":"1"}},{"name":"fields","in":"query","description":"Selector specifying which fields to include in a partial response.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"upload_protocol","in":"query","description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"access_token","in":"query","description":"OAuth access token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"alt","in":"query","description":"Data format for response. (Acceptable values are: \"json\", \"media\", \"proto\")","style":"form","explode":true,"schema":{"type":"string","default":"json"}},{"name":"key","in":"query","description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"readMask","in":"query","description":"The mask which specifies fields that need to be returned in the AuthConfig's response.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"filter","in":"query","description":"Filtering as supported in https://developers.google.com/authorized-buyers/apis/guides/v2/list-filters.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"pageToken","in":"query","description":"The token returned in the previous response.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"pageSize","in":"query","description":"The size of entries in the response. If unspecified, defaults to 100.","style":"form","explode":true,"schema":{"type":"integer","contentEncoding":"int32"}},{"name":"parent","in":"path","description":"Required. The client, which owns this collection of AuthConfigs.","required":true,"style":"simple","schema":{"pattern":"^projects/[^/]+/locations/[^/]+/products/[^/]+$","type":"string"}}],"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudIntegrationsV1alphaListAuthConfigsResponse"}}}}},"deprecated":false,"security":[{"httpBearer":["https://www.googleapis.com/auth/cloud-platform"]}]},"post":{"tags":["authConfigs"],"summary":"CreateV1AuthConfigsByParent","description":"Creates an auth config record. Fetch corresponding credentials for specific auth types, e.g. access token for OAuth 2.0, JWT token for JWT. Encrypt the auth config with Cloud KMS and store the encrypted credentials in Spanner. Returns the encrypted auth config.","operationId":"CreateV1AuthConfigsByParent","parameters":[{"name":"quotaUser","in":"query","description":"Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"prettyPrint","in":"query","description":"Returns response with indentations and line breaks.","style":"form","explode":true,"schema":{"type":"boolean","default":true}},{"name":"oauth_token","in":"query","description":"OAuth 2.0 token for the current user.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"uploadType","in":"query","description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"callback","in":"query","description":"JSONP","style":"form","explode":true,"schema":{"type":"string"}},{"name":"$.xgafv","in":"query","description":"V1 error format. (Acceptable values are: \"1\", \"2\")","style":"form","explode":true,"schema":{"type":"string","default":"1"}},{"name":"fields","in":"query","description":"Selector specifying which fields to include in a partial response.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"upload_protocol","in":"query","description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"access_token","in":"query","description":"OAuth access token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"alt","in":"query","description":"Data format for response. (Acceptable values are: \"json\", \"media\", \"proto\")","style":"form","explode":true,"schema":{"type":"string","default":"json"}},{"name":"key","in":"query","description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"clientCertificate.encryptedPrivateKey","in":"query","description":"The ssl certificate encoded in PEM format. This string must include the begin header and end footer lines. For example, -----BEGIN CERTIFICATE----- MIICTTCCAbagAwIBAgIJAPT0tSKNxan/MA0GCSqGSIb3DQEBCwUAMCoxFzAVBgNV BAoTDkdvb2dsZSBURVNUSU5HMQ8wDQYDVQQDEwZ0ZXN0Q0EwHhcNMTUwMTAxMDAw MDAwWhcNMjUwMTAxMDAwMDAwWjAuMRcwFQYDVQQKEw5Hb29nbGUgVEVTVElORzET MBEGA1UEAwwKam9lQGJhbmFuYTCBnzANBgkqhkiG9w0BAQEFAAOBjQAwgYkCgYEA vDYFgMgxi5W488d9J7UpCInl0NXmZQpJDEHE4hvkaRlH7pnC71H0DLt0/3zATRP1 JzY2+eqBmbGl4/sgZKYv8UrLnNyQNUTsNx1iZAfPUflf5FwgVsai8BM0pUciq1NB xD429VFcrGZNucvFLh72RuRFIKH8WUpiK/iZNFkWhZ0CAwEAAaN3MHUwDgYDVR0P AQH/BAQDAgWgMB0GA1UdJQQWMBQGCCsGAQUFBwMBBggrBgEFBQcDAjAMBgNVHRMB Af8EAjAAMBkGA1UdDgQSBBCVgnFBCWgL/iwCqnGrhTPQMBsGA1UdIwQUMBKAEKey Um2o4k2WiEVA0ldQvNYwDQYJKoZIhvcNAQELBQADgYEAYK986R4E3L1v+Q6esBtW JrUwA9UmJRSQr0N5w3o9XzarU37/bkjOP0Fw0k/A6Vv1n3vlciYfBFaBIam1qRHr 5dMsYf4CZS6w50r7hyzqyrwDoyNxkLnd2PdcHT/sym1QmflsjEs7pejtnohO6N2H wQW6M0H7Zt8claGRla4fKkg= -----END CERTIFICATE-----","style":"form","explode":true,"schema":{"type":"string"}},{"name":"clientCertificate.passphrase","in":"query","description":"'passphrase' should be left unset if private key is not encrypted. Note that 'passphrase' is not the password for web server, but an extra layer of security to protected private key.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"clientCertificate.sslCertificate","in":"query","description":"The ssl certificate encoded in PEM format. This string must include the begin header and end footer lines. For example, -----BEGIN CERTIFICATE----- MIICTTCCAbagAwIBAgIJAPT0tSKNxan/MA0GCSqGSIb3DQEBCwUAMCoxFzAVBgNV BAoTDkdvb2dsZSBURVNUSU5HMQ8wDQYDVQQDEwZ0ZXN0Q0EwHhcNMTUwMTAxMDAw MDAwWhcNMjUwMTAxMDAwMDAwWjAuMRcwFQYDVQQKEw5Hb29nbGUgVEVTVElORzET MBEGA1UEAwwKam9lQGJhbmFuYTCBnzANBgkqhkiG9w0BAQEFAAOBjQAwgYkCgYEA vDYFgMgxi5W488d9J7UpCInl0NXmZQpJDEHE4hvkaRlH7pnC71H0DLt0/3zATRP1 JzY2+eqBmbGl4/sgZKYv8UrLnNyQNUTsNx1iZAfPUflf5FwgVsai8BM0pUciq1NB xD429VFcrGZNucvFLh72RuRFIKH8WUpiK/iZNFkWhZ0CAwEAAaN3MHUwDgYDVR0P AQH/BAQDAgWgMB0GA1UdJQQWMBQGCCsGAQUFBwMBBggrBgEFBQcDAjAMBgNVHRMB Af8EAjAAMBkGA1UdDgQSBBCVgnFBCWgL/iwCqnGrhTPQMBsGA1UdIwQUMBKAEKey Um2o4k2WiEVA0ldQvNYwDQYJKoZIhvcNAQELBQADgYEAYK986R4E3L1v+Q6esBtW JrUwA9UmJRSQr0N5w3o9XzarU37/bkjOP0Fw0k/A6Vv1n3vlciYfBFaBIam1qRHr 5dMsYf4CZS6w50r7hyzqyrwDoyNxkLnd2PdcHT/sym1QmflsjEs7pejtnohO6N2H wQW6M0H7Zt8claGRla4fKkg= -----END CERTIFICATE-----","style":"form","explode":true,"schema":{"type":"string"}},{"name":"parent","in":"path","description":"Required. \"projects/{project}/locations/{location}\" format.","required":true,"style":"simple","schema":{"pattern":"^projects/[^/]+/locations/[^/]+/products/[^/]+$","type":"string"}}],"requestBody":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudIntegrationsV1alphaAuthConfig"}}},"required":true},"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudIntegrationsV1alphaAuthConfig"}}}}},"deprecated":false,"security":[{"httpBearer":["https://www.googleapis.com/auth/cloud-platform"]}]},"parameters":[]},"/v1/{parent}/certificates":{"get":{"tags":["certificates"],"summary":"ListV1CertificatesByParent","description":"List all the certificates that match the filter. Restrict to certificate of current client only.","operationId":"ListV1CertificatesByParent","parameters":[{"name":"quotaUser","in":"query","description":"Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"prettyPrint","in":"query","description":"Returns response with indentations and line breaks.","style":"form","explode":true,"schema":{"type":"boolean","default":true}},{"name":"oauth_token","in":"query","description":"OAuth 2.0 token for the current user.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"uploadType","in":"query","description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"callback","in":"query","description":"JSONP","style":"form","explode":true,"schema":{"type":"string"}},{"name":"$.xgafv","in":"query","description":"V1 error format. (Acceptable values are: \"1\", \"2\")","style":"form","explode":true,"schema":{"type":"string","default":"1"}},{"name":"fields","in":"query","description":"Selector specifying which fields to include in a partial response.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"upload_protocol","in":"query","description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"access_token","in":"query","description":"OAuth access token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"alt","in":"query","description":"Data format for response. (Acceptable values are: \"json\", \"media\", \"proto\")","style":"form","explode":true,"schema":{"type":"string","default":"json"}},{"name":"key","in":"query","description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"filter","in":"query","description":"Filtering as supported in https://developers.google.com/authorized-buyers/apis/guides/v2/list-filters.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"pageToken","in":"query","description":"The token returned in the previous response.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"parent","in":"path","description":"Required. The client, which owns this collection of Certificates.","required":true,"style":"simple","schema":{"pattern":"^projects/[^/]+/locations/[^/]+/products/[^/]+$","type":"string"}},{"name":"pageSize","in":"query","description":"The size of entries in the response. If unspecified, defaults to 100.","style":"form","explode":true,"schema":{"type":"integer","contentEncoding":"int32"}},{"name":"readMask","in":"query","description":"The mask which specifies fields that need to be returned in the Certificate's response.","style":"form","explode":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudIntegrationsV1alphaListCertificatesResponse"}}}}},"deprecated":false,"security":[{"httpBearer":["https://www.googleapis.com/auth/cloud-platform"]}]},"post":{"tags":["certificates"],"summary":"CreateV1CertificatesByParent","description":"Creates a new certificate. The certificate will be registered to the trawler service and will be encrypted using cloud KMS and stored in Spanner Returns the certificate.","operationId":"CreateV1CertificatesByParent","parameters":[{"name":"quotaUser","in":"query","description":"Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"prettyPrint","in":"query","description":"Returns response with indentations and line breaks.","style":"form","explode":true,"schema":{"type":"boolean","default":true}},{"name":"oauth_token","in":"query","description":"OAuth 2.0 token for the current user.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"uploadType","in":"query","description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"callback","in":"query","description":"JSONP","style":"form","explode":true,"schema":{"type":"string"}},{"name":"$.xgafv","in":"query","description":"V1 error format. (Acceptable values are: \"1\", \"2\")","style":"form","explode":true,"schema":{"type":"string","default":"1"}},{"name":"fields","in":"query","description":"Selector specifying which fields to include in a partial response.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"upload_protocol","in":"query","description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"access_token","in":"query","description":"OAuth access token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"alt","in":"query","description":"Data format for response. (Acceptable values are: \"json\", \"media\", \"proto\")","style":"form","explode":true,"schema":{"type":"string","default":"json"}},{"name":"key","in":"query","description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"parent","in":"path","description":"Required. \"projects/{project}/locations/{location}\" format.","required":true,"style":"simple","schema":{"pattern":"^projects/[^/]+/locations/[^/]+/products/[^/]+$","type":"string"}}],"requestBody":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudIntegrationsV1alphaCertificate"}}},"required":true},"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudIntegrationsV1alphaCertificate"}}}}},"deprecated":false,"security":[{"httpBearer":["https://www.googleapis.com/auth/cloud-platform"]}]},"parameters":[]},"/v1/{parent}:createBundle":{"post":{"tags":["products"],"summary":"CreateBundleV1CreateBundleByParent","description":"PROTECT WITH A VISIBILITY LABEL. THIS METHOD WILL BE MOVED TO A SEPARATE SERVICE. Create a bundle.","operationId":"CreateBundleV1CreateBundleByParent","parameters":[{"name":"quotaUser","in":"query","description":"Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"prettyPrint","in":"query","description":"Returns response with indentations and line breaks.","style":"form","explode":true,"schema":{"type":"boolean","default":true}},{"name":"oauth_token","in":"query","description":"OAuth 2.0 token for the current user.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"uploadType","in":"query","description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"callback","in":"query","description":"JSONP","style":"form","explode":true,"schema":{"type":"string"}},{"name":"$.xgafv","in":"query","description":"V1 error format. (Acceptable values are: \"1\", \"2\")","style":"form","explode":true,"schema":{"type":"string","default":"1"}},{"name":"fields","in":"query","description":"Selector specifying which fields to include in a partial response.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"upload_protocol","in":"query","description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"access_token","in":"query","description":"OAuth access token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"alt","in":"query","description":"Data format for response. (Acceptable values are: \"json\", \"media\", \"proto\")","style":"form","explode":true,"schema":{"type":"string","default":"json"}},{"name":"key","in":"query","description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"parent","in":"path","description":"Required. The location resource of the request.","required":true,"style":"simple","schema":{"pattern":"^projects/[^/]+/locations/[^/]+/products/[^/]+$","type":"string"}}],"requestBody":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudIntegrationsV1alphaCreateBundleRequest"}}},"required":true},"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudIntegrationsV1alphaCreateBundleResponse"}}}}},"deprecated":false,"security":[{"httpBearer":["https://www.googleapis.com/auth/cloud-platform"]}]},"parameters":[]},"/v1/{parent}:listTaskEntities":{"get":{"tags":["products"],"summary":"ListTaskEntitiesV1ListTaskEntitiesByParent","description":"This is a UI only method and will be moved away. Returns a list of common tasks.","operationId":"ListTaskEntitiesV1ListTaskEntitiesByParent","parameters":[{"name":"quotaUser","in":"query","description":"Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"prettyPrint","in":"query","description":"Returns response with indentations and line breaks.","style":"form","explode":true,"schema":{"type":"boolean","default":true}},{"name":"oauth_token","in":"query","description":"OAuth 2.0 token for the current user.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"uploadType","in":"query","description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"callback","in":"query","description":"JSONP","style":"form","explode":true,"schema":{"type":"string"}},{"name":"$.xgafv","in":"query","description":"V1 error format. (Acceptable values are: \"1\", \"2\")","style":"form","explode":true,"schema":{"type":"string","default":"1"}},{"name":"fields","in":"query","description":"Selector specifying which fields to include in a partial response.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"upload_protocol","in":"query","description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"access_token","in":"query","description":"OAuth access token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"alt","in":"query","description":"Data format for response. (Acceptable values are: \"json\", \"media\", \"proto\")","style":"form","explode":true,"schema":{"type":"string","default":"json"}},{"name":"key","in":"query","description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"parent","in":"path","description":"Required. The location resource of the request. This is not going to be used but preserve the field for future.","required":true,"style":"simple","schema":{"pattern":"^projects/[^/]+/locations/[^/]+/products/[^/]+$","type":"string"}}],"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudIntegrationsV1alphaListTaskEntitiesResponse"}}}}},"deprecated":false,"security":[{"httpBearer":["https://www.googleapis.com/auth/cloud-platform"]}]},"parameters":[]},"/v1/{parent}/runtimeActionSchemas":{"get":{"tags":["runtimeActionSchemas"],"summary":"ListV1RuntimeActionSchemasByParent","description":"Lists the JSON schemas for the inputs and outputs of actions, filtered by action name.","operationId":"ListV1RuntimeActionSchemasByParent","parameters":[{"name":"quotaUser","in":"query","description":"Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"prettyPrint","in":"query","description":"Returns response with indentations and line breaks.","style":"form","explode":true,"schema":{"type":"boolean","default":true}},{"name":"oauth_token","in":"query","description":"OAuth 2.0 token for the current user.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"uploadType","in":"query","description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"callback","in":"query","description":"JSONP","style":"form","explode":true,"schema":{"type":"string"}},{"name":"$.xgafv","in":"query","description":"V1 error format. (Acceptable values are: \"1\", \"2\")","style":"form","explode":true,"schema":{"type":"string","default":"1"}},{"name":"fields","in":"query","description":"Selector specifying which fields to include in a partial response.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"upload_protocol","in":"query","description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"access_token","in":"query","description":"OAuth access token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"alt","in":"query","description":"Data format for response. (Acceptable values are: \"json\", \"media\", \"proto\")","style":"form","explode":true,"schema":{"type":"string","default":"json"}},{"name":"key","in":"query","description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"pageToken","in":"query","description":"Page token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"filter","in":"query","description":"Filter. Only the action field with literal equality operator is supported.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"parent","in":"path","description":"Required. Parent resource of RuntimeActionSchema. Format: projects/{project}/locations/{location}/connections/{connection}","required":true,"style":"simple","schema":{"pattern":"^projects/[^/]+/locations/[^/]+/connections/[^/]+$","type":"string"}},{"name":"pageSize","in":"query","description":"Page size.","style":"form","explode":true,"schema":{"type":"integer","contentEncoding":"int32"}}],"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudIntegrationsV1alphaListRuntimeActionSchemasResponse"}}}}},"deprecated":false,"security":[{"httpBearer":["https://www.googleapis.com/auth/cloud-platform"]}]},"parameters":[]},"/v1/{parent}/runtimeEntitySchemas":{"get":{"tags":["runtimeEntitySchemas"],"summary":"ListV1RuntimeEntitySchemasByParent","description":"Lists the JSON schemas for the properties of runtime entities, filtered by entity name.","operationId":"ListV1RuntimeEntitySchemasByParent","parameters":[{"name":"quotaUser","in":"query","description":"Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"prettyPrint","in":"query","description":"Returns response with indentations and line breaks.","style":"form","explode":true,"schema":{"type":"boolean","default":true}},{"name":"oauth_token","in":"query","description":"OAuth 2.0 token for the current user.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"uploadType","in":"query","description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"callback","in":"query","description":"JSONP","style":"form","explode":true,"schema":{"type":"string"}},{"name":"$.xgafv","in":"query","description":"V1 error format. (Acceptable values are: \"1\", \"2\")","style":"form","explode":true,"schema":{"type":"string","default":"1"}},{"name":"fields","in":"query","description":"Selector specifying which fields to include in a partial response.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"upload_protocol","in":"query","description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"access_token","in":"query","description":"OAuth access token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"alt","in":"query","description":"Data format for response. (Acceptable values are: \"json\", \"media\", \"proto\")","style":"form","explode":true,"schema":{"type":"string","default":"json"}},{"name":"key","in":"query","description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"pageSize","in":"query","description":"Page size.","style":"form","explode":true,"schema":{"type":"integer","contentEncoding":"int32"}},{"name":"parent","in":"path","description":"Required. Parent resource of RuntimeEntitySchema. Format: projects/{project}/locations/{location}/connections/{connection}","required":true,"style":"simple","schema":{"pattern":"^projects/[^/]+/locations/[^/]+/connections/[^/]+$","type":"string"}},{"name":"filter","in":"query","description":"Filter. Only the entity field with literal equality operator is supported.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"pageToken","in":"query","description":"Page token.","style":"form","explode":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudIntegrationsV1alphaListRuntimeEntitySchemasResponse"}}}}},"deprecated":false,"security":[{"httpBearer":["https://www.googleapis.com/auth/cloud-platform"]}]},"parameters":[]},"/v1/{parent}/connections":{"get":{"tags":["connections"],"summary":"ListV1ConnectionsByParent","description":"Lists Connections in a given project and location.","operationId":"ListV1ConnectionsByParent","parameters":[{"name":"quotaUser","in":"query","description":"Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"prettyPrint","in":"query","description":"Returns response with indentations and line breaks.","style":"form","explode":true,"schema":{"type":"boolean","default":true}},{"name":"oauth_token","in":"query","description":"OAuth 2.0 token for the current user.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"uploadType","in":"query","description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"callback","in":"query","description":"JSONP","style":"form","explode":true,"schema":{"type":"string"}},{"name":"$.xgafv","in":"query","description":"V1 error format. (Acceptable values are: \"1\", \"2\")","style":"form","explode":true,"schema":{"type":"string","default":"1"}},{"name":"fields","in":"query","description":"Selector specifying which fields to include in a partial response.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"upload_protocol","in":"query","description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"access_token","in":"query","description":"OAuth access token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"alt","in":"query","description":"Data format for response. (Acceptable values are: \"json\", \"media\", \"proto\")","style":"form","explode":true,"schema":{"type":"string","default":"json"}},{"name":"key","in":"query","description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"filter","in":"query","description":"Filter.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"pageSize","in":"query","description":"Page size.","style":"form","explode":true,"schema":{"type":"integer","contentEncoding":"int32"}},{"name":"orderBy","in":"query","description":"Order by parameters.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"pageToken","in":"query","description":"Page token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"parent","in":"path","description":"Required. Parent resource of the Connection, of the form: `projects/*/locations/*`","required":true,"style":"simple","schema":{"pattern":"^projects/[^/]+/locations/[^/]+$","type":"string"}}],"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudIntegrationsV1alphaListConnectionsResponse"}}}}},"deprecated":false,"security":[{"httpBearer":["https://www.googleapis.com/auth/cloud-platform"]}]},"parameters":[]},"/v1/{parent}/clients:provision":{"post":{"tags":["clients"],"summary":"ProvisionV1ClientsProvisionByParent","description":"Perform the provisioning steps to enable a user GCP project to use IP. If GCP project already registered on IP end via Apigee Integration, provisioning will fail.","operationId":"ProvisionV1ClientsProvisionByParent","parameters":[{"name":"quotaUser","in":"query","description":"Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"prettyPrint","in":"query","description":"Returns response with indentations and line breaks.","style":"form","explode":true,"schema":{"type":"boolean","default":true}},{"name":"oauth_token","in":"query","description":"OAuth 2.0 token for the current user.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"uploadType","in":"query","description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"callback","in":"query","description":"JSONP","style":"form","explode":true,"schema":{"type":"string"}},{"name":"$.xgafv","in":"query","description":"V1 error format. (Acceptable values are: \"1\", \"2\")","style":"form","explode":true,"schema":{"type":"string","default":"1"}},{"name":"fields","in":"query","description":"Selector specifying which fields to include in a partial response.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"upload_protocol","in":"query","description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"access_token","in":"query","description":"OAuth access token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"alt","in":"query","description":"Data format for response. (Acceptable values are: \"json\", \"media\", \"proto\")","style":"form","explode":true,"schema":{"type":"string","default":"json"}},{"name":"key","in":"query","description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"parent","in":"path","description":"Required. Required: The ID of the GCP Project to be provisioned.","required":true,"style":"simple","schema":{"pattern":"^projects/[^/]+/locations/[^/]+$","type":"string"}}],"requestBody":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudIntegrationsV1alphaProvisionClientRequest"}}},"required":true},"responses":{"200":{"description":"","headers":{},"content":{"text/plain":{"schema":{"type":"object","contentMediaType":"text/plain"}}}}},"deprecated":false,"security":[{"httpBearer":["https://www.googleapis.com/auth/cloud-platform"]}]},"parameters":[]},"/v1/{parent}/clients:deprovision":{"post":{"tags":["clients"],"summary":"DeprovisionV1ClientsDeprovisionByParent","description":"Perform the deprovisioning steps to disable a user GCP project to use IP and purge all related data in a wipeout-compliant way.","operationId":"DeprovisionV1ClientsDeprovisionByParent","parameters":[{"name":"quotaUser","in":"query","description":"Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"prettyPrint","in":"query","description":"Returns response with indentations and line breaks.","style":"form","explode":true,"schema":{"type":"boolean","default":true}},{"name":"oauth_token","in":"query","description":"OAuth 2.0 token for the current user.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"uploadType","in":"query","description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"callback","in":"query","description":"JSONP","style":"form","explode":true,"schema":{"type":"string"}},{"name":"$.xgafv","in":"query","description":"V1 error format. (Acceptable values are: \"1\", \"2\")","style":"form","explode":true,"schema":{"type":"string","default":"1"}},{"name":"fields","in":"query","description":"Selector specifying which fields to include in a partial response.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"upload_protocol","in":"query","description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"access_token","in":"query","description":"OAuth access token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"alt","in":"query","description":"Data format for response. (Acceptable values are: \"json\", \"media\", \"proto\")","style":"form","explode":true,"schema":{"type":"string","default":"json"}},{"name":"key","in":"query","description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"parent","in":"path","description":"Required. Required: The ID of the GCP Project to be deprovisioned.","required":true,"style":"simple","schema":{"pattern":"^projects/[^/]+/locations/[^/]+$","type":"string"}}],"requestBody":{"description":"","content":{"text/plain":{"schema":{"type":"object","contentMediaType":"text/plain"}}},"required":true},"responses":{"200":{"description":"","headers":{},"content":{"text/plain":{"schema":{"type":"object","contentMediaType":"text/plain"}}}}},"deprecated":false,"security":[{"httpBearer":["https://www.googleapis.com/auth/cloud-platform"]}]},"parameters":[]},"/v1/{parent}/clients":{"get":{"tags":["locations"],"summary":"GetClientsV1ClientsByParent","description":"Gets the client configuration for the given project and location resource name","operationId":"GetClientsV1ClientsByParent","parameters":[{"name":"quotaUser","in":"query","description":"Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"prettyPrint","in":"query","description":"Returns response with indentations and line breaks.","style":"form","explode":true,"schema":{"type":"boolean","default":true}},{"name":"oauth_token","in":"query","description":"OAuth 2.0 token for the current user.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"uploadType","in":"query","description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"callback","in":"query","description":"JSONP","style":"form","explode":true,"schema":{"type":"string"}},{"name":"$.xgafv","in":"query","description":"V1 error format. (Acceptable values are: \"1\", \"2\")","style":"form","explode":true,"schema":{"type":"string","default":"1"}},{"name":"fields","in":"query","description":"Selector specifying which fields to include in a partial response.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"upload_protocol","in":"query","description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"access_token","in":"query","description":"OAuth access token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"alt","in":"query","description":"Data format for response. (Acceptable values are: \"json\", \"media\", \"proto\")","style":"form","explode":true,"schema":{"type":"string","default":"json"}},{"name":"key","in":"query","description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"parent","in":"path","description":"Required. Required: The ID of the GCP Project to be provisioned.","required":true,"style":"simple","schema":{"pattern":"^projects/[^/]+/locations/[^/]+$","type":"string"}}],"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudIntegrationsV1alphaGetClientResponse"}}}}},"deprecated":false,"security":[{"httpBearer":["https://www.googleapis.com/auth/cloud-platform"]}]},"parameters":[]},"/v1/{parent}/clientmetadata":{"get":{"tags":["projects"],"summary":"GetClientmetadataV1ClientmetadataByParent","description":"Gets the metadata info for the requested client","operationId":"GetClientmetadataV1ClientmetadataByParent","parameters":[{"name":"quotaUser","in":"query","description":"Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"prettyPrint","in":"query","description":"Returns response with indentations and line breaks.","style":"form","explode":true,"schema":{"type":"boolean","default":true}},{"name":"oauth_token","in":"query","description":"OAuth 2.0 token for the current user.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"uploadType","in":"query","description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"callback","in":"query","description":"JSONP","style":"form","explode":true,"schema":{"type":"string"}},{"name":"$.xgafv","in":"query","description":"V1 error format. (Acceptable values are: \"1\", \"2\")","style":"form","explode":true,"schema":{"type":"string","default":"1"}},{"name":"fields","in":"query","description":"Selector specifying which fields to include in a partial response.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"upload_protocol","in":"query","description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"access_token","in":"query","description":"OAuth access token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"alt","in":"query","description":"Data format for response. (Acceptable values are: \"json\", \"media\", \"proto\")","style":"form","explode":true,"schema":{"type":"string","default":"json"}},{"name":"key","in":"query","description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"parent","in":"path","description":"Required. Required: The ID of the GCP Project to be provisioned.","required":true,"style":"simple","schema":{"pattern":"^projects/[^/]+$","type":"string"}}],"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudIntegrationsV1alphaGetClientMetadataResponse"}}}}},"deprecated":false,"security":[{"httpBearer":["https://www.googleapis.com/auth/cloud-platform"]}]},"parameters":[]},"/v1/callback:generateToken":{"get":{"tags":["callback"],"summary":"GenerateTokenV1CallbackGenerateToken","description":"Receives the auth code and auth config id to combine that with the client id and secret to retrieve access tokens from the token endpoint. Returns either a success or error message when it's done.","operationId":"GenerateTokenV1CallbackGenerateToken","parameters":[{"name":"quotaUser","in":"query","description":"Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"prettyPrint","in":"query","description":"Returns response with indentations and line breaks.","style":"form","explode":true,"schema":{"type":"boolean","default":true}},{"name":"oauth_token","in":"query","description":"OAuth 2.0 token for the current user.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"uploadType","in":"query","description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"callback","in":"query","description":"JSONP","style":"form","explode":true,"schema":{"type":"string"}},{"name":"$.xgafv","in":"query","description":"V1 error format. (Acceptable values are: \"1\", \"2\")","style":"form","explode":true,"schema":{"type":"string","default":"1"}},{"name":"fields","in":"query","description":"Selector specifying which fields to include in a partial response.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"upload_protocol","in":"query","description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"access_token","in":"query","description":"OAuth access token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"alt","in":"query","description":"Data format for response. (Acceptable values are: \"json\", \"media\", \"proto\")","style":"form","explode":true,"schema":{"type":"string","default":"json"}},{"name":"key","in":"query","description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"redirectUri","in":"query","description":"Redirect uri of the auth code request","style":"form","explode":true,"schema":{"type":"string"}},{"name":"state","in":"query","description":"The auth config id for the given request","style":"form","explode":true,"schema":{"type":"string"}},{"name":"code","in":"query","description":"The auth code for the given request","style":"form","explode":true,"schema":{"type":"string"}},{"name":"gcpProjectId","in":"query","description":"The gcp project id of the request","style":"form","explode":true,"schema":{"type":"string"}},{"name":"product","in":"query","description":"Which product sends the request (Acceptable values are: \"UNSPECIFIED_PRODUCT\", \"IP\", \"APIGEE\", \"SECURITY\")","style":"form","explode":true,"schema":{"type":"string","default":"UNSPECIFIED_PRODUCT"}}],"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudIntegrationsV1alphaGenerateTokenResponse"}}}}},"deprecated":false,"security":[{"httpBearer":["https://www.googleapis.com/auth/cloud-platform"]}]},"parameters":[]},"/v1/connectorPlatformRegions:enumerate":{"get":{"tags":["connectorPlatformRegions"],"summary":"EnumerateV1ConnectorPlatformRegionsEnumerate","description":"Enumerates the regions for which Connector Platform is provisioned.","operationId":"EnumerateV1ConnectorPlatformRegionsEnumerate","parameters":[{"name":"quotaUser","in":"query","description":"Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"prettyPrint","in":"query","description":"Returns response with indentations and line breaks.","style":"form","explode":true,"schema":{"type":"boolean","default":true}},{"name":"oauth_token","in":"query","description":"OAuth 2.0 token for the current user.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"uploadType","in":"query","description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"callback","in":"query","description":"JSONP","style":"form","explode":true,"schema":{"type":"string"}},{"name":"$.xgafv","in":"query","description":"V1 error format. (Acceptable values are: \"1\", \"2\")","style":"form","explode":true,"schema":{"type":"string","default":"1"}},{"name":"fields","in":"query","description":"Selector specifying which fields to include in a partial response.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"upload_protocol","in":"query","description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","style":"form","explode":true,"schema":{"type":"string"}},{"name":"access_token","in":"query","description":"OAuth access token.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"alt","in":"query","description":"Data format for response. (Acceptable values are: \"json\", \"media\", \"proto\")","style":"form","explode":true,"schema":{"type":"string","default":"json"}},{"name":"key","in":"query","description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.","style":"form","explode":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudIntegrationsV1alphaEnumerateConnectorPlatformRegionsResponse"}}}}},"deprecated":false,"security":[{"httpBearer":["https://www.googleapis.com/auth/cloud-platform"]}]},"parameters":[]}},"components":{"schemas":{"GoogleCloudIntegrationsV1alphaListRuntimeActionSchemasResponse":{"title":"GoogleCloudIntegrationsV1alphaListRuntimeActionSchemasResponse","type":"object","properties":{"nextPageToken":{"type":"string","description":"Next page token."},"runtimeActionSchemas":{"type":"array","items":{"$ref":"#/components/schemas/GoogleCloudIntegrationsV1alphaRuntimeActionSchema"},"description":"Runtime action schemas."}},"description":"Response for listing RuntimeActionSchemas for a specific Connection."},"EnterpriseCrmEventbusProtoSuccessPolicy":{"title":"EnterpriseCrmEventbusProtoSuccessPolicy","type":"object","properties":{"finalState":{"allOf":[{"$ref":"#/components/schemas/FinalState"},{"description":"State to which the execution snapshot status will be set if the task succeeds."}]}},"description":"Policy that dictates the behavior for the task after it completes successfully."},"GoogleCloudIntegrationsV1alphaListExecutionSnapshotsResponse":{"title":"GoogleCloudIntegrationsV1alphaListExecutionSnapshotsResponse","type":"object","properties":{"nextPageToken":{"type":"string","description":"The token returned in the previous response."},"executionSnapshots":{"type":"array","items":{"$ref":"#/components/schemas/EnterpriseCrmEventbusProtoEventExecutionSnapshot"},"description":"Required. The detailed information for the execution snapshot."}},"description":"Response for listing the integration execution snapshot."},"EnterpriseCrmEventbusProtoConditionResult":{"title":"EnterpriseCrmEventbusProtoConditionResult","type":"object","properties":{"currentTaskNumber":{"type":"string","description":"the current task number."},"nextTaskNumber":{"type":"string","description":"the next task number."},"result":{"type":"boolean","description":"the result comes out after evaluate the combined condition. True if there's no combined condition specified."}},"description":"Contains the combined condition calculation results."},"GoogleCloudIntegrationsV1alphaSfdcInstance":{"title":"GoogleCloudIntegrationsV1alphaSfdcInstance","type":"object","properties":{"authConfigId":{"type":"array","items":{"type":"string"},"description":"A list of AuthConfigs that can be tried to open the channel to SFDC"},"deleteTime":{"type":"string","description":"Output only. Time when the instance was deleted. Empty if not deleted."},"sfdcOrgId":{"type":"string","description":"The SFDC Org Id. This is defined in salesforce."},"description":{"type":"string","description":"A description of the sfdc instance."},"serviceAuthority":{"type":"string","description":"URL used for API calls after authentication (the login authority is configured within the referenced AuthConfig)."},"name":{"type":"string","description":"Resource name of the SFDC instance projects/{project}/locations/{location}/sfdcInstances/{sfdcInstance}."},"createTime":{"type":"string","description":"Output only. Time when the instance is created"},"displayName":{"type":"string","description":"User selected unique name/alias to easily reference an instance."},"updateTime":{"type":"string","description":"Output only. Time when the instance was last updated"}},"description":"The SfdcInstance resource use to hold channels and connection config data."},"GoogleCloudIntegrationsV1alphaListSfdcChannelsResponse":{"title":"GoogleCloudIntegrationsV1alphaListSfdcChannelsResponse","type":"object","properties":{"nextPageToken":{"type":"string","description":"The token used to retrieve the next page of results."},"sfdcChannels":{"type":"array","items":{"$ref":"#/components/schemas/GoogleCloudIntegrationsV1alphaSfdcChannel"},"description":"The list of SfdcChannels retrieved."}},"description":"Response to list SfdcChannels."},"GoogleCloudIntegrationsV1alphaUpdateBundleRequest":{"title":"GoogleCloudIntegrationsV1alphaUpdateBundleRequest","type":"object","properties":{"config":{"allOf":[{"$ref":"#/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationBundleConfig"},{"description":"This proto holds the core runner data in the bundle task. It is not expected to be directly edited by the user. Instead, a default value will be provided at the task creation time."}]}},"description":"THIS METHOD WILL BE MOVED TO A SEPARATE SERVICE. Request message for Bundle update"},"EnterpriseCrmEventbusProtoProtoParameterArray":{"title":"EnterpriseCrmEventbusProtoProtoParameterArray","type":"object","properties":{"protoValues":{"type":"array","items":{},"description":""}}},"EnterpriseCrmLoggingGwsSanitizeOptions":{"title":"EnterpriseCrmLoggingGwsSanitizeOptions","type":"object","properties":{"sanitizeType":{"$ref":"#/components/schemas/SanitizeType"},"isAlreadySanitized":{"type":"boolean","description":"If true, the value has already been sanitized and needs no further sanitization. For instance, a D3 customer id is already an obfuscated entity and *might not* need further sanitization."},"logType":{"type":"array","items":{"$ref":"#/components/schemas/LogType"},"description":"To which type(s) of logs the sanitize options apply."},"privacy":{"$ref":"#/components/schemas/Privacy"}},"description":"Identifies whether a field contains, or may contain, PII or sensitive data, and how to sanitize the field if it does. If a field's privacy type cannot be determined then it is sanitized (e.g., scrubbed). The specific sanitizer implementation is determined by run-time configuration and environment options (e.g., prod vs. qa). next_id: 5"},"EnterpriseCrmEventbusProtoNextTask":{"title":"EnterpriseCrmEventbusProtoNextTask","type":"object","properties":{"combinedConditions":{"type":"array","items":{"$ref":"#/components/schemas/EnterpriseCrmEventbusProtoCombinedCondition"},"description":"Combined condition for this task to become an eligible next task. Each of these combined_conditions are joined with logical OR. DEPRECATED: use `condition`"},"description":{"type":"string","description":"User-provided description intended to give more business context about the next task edge or condition."},"taskConfigId":{"type":"string","description":"ID of the next task."},"condition":{"type":"string","description":"Standard filter expression for this task to become an eligible next task."},"taskNumber":{"type":"string","description":"Task number of the next task."},"label":{"type":"string","description":"User-provided label that is attached to this edge in the UI."}},"description":"The task that is next in line to be executed, if the condition specified evaluated to true."},"GoogleCloudIntegrationsV1alphaServiceAccountCredentials":{"title":"GoogleCloudIntegrationsV1alphaServiceAccountCredentials","type":"object","properties":{"scope":{"type":"string","description":"A space-delimited list of requested scope permissions."},"serviceAccount":{"type":"string","description":"Name of the service account that has the permission to make the request."}},"description":"Represents the service account which can be used to generate access token for authenticating the service call."},"GoogleCloudConnectorsV1AuthConfigUserPassword":{"title":"GoogleCloudConnectorsV1AuthConfigUserPassword","type":"object","properties":{"password":{"allOf":[{"$ref":"#/components/schemas/GoogleCloudConnectorsV1Secret"},{"description":"Secret provides a reference to entries in Secret Manager."}]},"username":{"type":"string","description":"Username."}},"description":"Parameters to support Username and Password Authentication."},"EnterpriseCrmEventbusProtoFunctionType":{"title":"EnterpriseCrmEventbusProtoFunctionType","type":"object","properties":{"protoFunction":{"$ref":"#/components/schemas/EnterpriseCrmEventbusProtoProtoFunction"},"doubleArrayFunction":{"$ref":"#/components/schemas/EnterpriseCrmEventbusProtoDoubleArrayFunction"},"intFunction":{"$ref":"#/components/schemas/EnterpriseCrmEventbusProtoIntFunction"},"booleanArrayFunction":{"$ref":"#/components/schemas/EnterpriseCrmEventbusProtoBooleanArrayFunction"},"intArrayFunction":{"$ref":"#/components/schemas/EnterpriseCrmEventbusProtoIntArrayFunction"},"baseFunction":{"$ref":"#/components/schemas/EnterpriseCrmEventbusProtoBaseFunction"},"booleanFunction":{"$ref":"#/components/schemas/EnterpriseCrmEventbusProtoBooleanFunction"},"stringArrayFunction":{"$ref":"#/components/schemas/EnterpriseCrmEventbusProtoStringArrayFunction"},"jsonFunction":{"$ref":"#/components/schemas/EnterpriseCrmEventbusProtoJsonFunction"},"stringFunction":{"$ref":"#/components/schemas/EnterpriseCrmEventbusProtoStringFunction"},"doubleFunction":{"$ref":"#/components/schemas/EnterpriseCrmEventbusProtoDoubleFunction"},"protoArrayFunction":{"$ref":"#/components/schemas/EnterpriseCrmEventbusProtoProtoArrayFunction"}}},"GoogleCloudIntegrationsV1alphaListIntegrationsResponse":{"title":"GoogleCloudIntegrationsV1alphaListIntegrationsResponse","type":"object","properties":{"nextPageToken":{"type":"string","description":"The next page token for the response."},"integrations":{"type":"array","items":{"$ref":"#/components/schemas/GoogleCloudIntegrationsV1alphaIntegration"},"description":"The integrations which match the request."}},"description":"Response for ListIntegrations."},"EnterpriseCrmEventbusProtoCondition":{"title":"EnterpriseCrmEventbusProtoCondition","type":"object","properties":{"value":{"allOf":[{"$ref":"#/components/schemas/EnterpriseCrmEventbusProtoValueType"},{"description":"Used for define type for values. Currently supported value types include int, string, double, array, and any proto message."}]},"operator":{"allOf":[{"$ref":"#/components/schemas/Operator"},{"description":"Operator used to evaluate the condition. Please note that an operator with an inappropriate key/value operand will result in IllegalArgumentException, e.g. CONTAINS with boolean key/value pair."}]},"eventPropertyKey":{"type":"string","description":"Key that's evaluated against the `value`. Please note the data type of the runtime value associated with the key should match the data type of `value`, else an IllegalArgumentException is thrown."}},"description":"Condition that uses `operator` to evaluate the key against the value."},"EnterpriseCrmFrontendsEventbusProtoParameterMapEntry":{"title":"EnterpriseCrmFrontendsEventbusProtoParameterMapEntry","type":"object","properties":{"key":{"allOf":[{"$ref":"#/components/schemas/EnterpriseCrmFrontendsEventbusProtoParameterMapField"},{"description":"Field represents either the key or value in an entry."}]},"value":{"allOf":[{"$ref":"#/components/schemas/EnterpriseCrmFrontendsEventbusProtoParameterMapField"},{"description":"Field represents either the key or value in an entry."}]}},"description":"Entry is a pair of key and value."},"EnterpriseCrmEventbusProtoParamSpecEntryValidationRule":{"title":"EnterpriseCrmEventbusProtoParamSpecEntryValidationRule","type":"object","properties":{"intRange":{"allOf":[{"$ref":"#/components/schemas/EnterpriseCrmEventbusProtoParamSpecEntryValidationRuleIntRange"},{"description":"Range used to validate longs and ints."}]},"doubleRange":{"allOf":[{"$ref":"#/components/schemas/EnterpriseCrmEventbusProtoParamSpecEntryValidationRuleDoubleRange"},{"description":"Range used to validate doubles and floats."}]},"stringRegex":{"allOf":[{"$ref":"#/components/schemas/EnterpriseCrmEventbusProtoParamSpecEntryValidationRuleStringRegex"},{"description":"Rule used to validate strings."}]}}},"GoogleCloudConnectorsV1AuthConfigOauth2JwtBearer":{"title":"GoogleCloudConnectorsV1AuthConfigOauth2JwtBearer","type":"object","properties":{"clientKey":{"allOf":[{"$ref":"#/components/schemas/GoogleCloudConnectorsV1Secret"},{"description":"Secret provides a reference to entries in Secret Manager."}]},"jwtClaims":{"allOf":[{"$ref":"#/components/schemas/GoogleCloudConnectorsV1AuthConfigOauth2JwtBearerJwtClaims"},{"description":"JWT claims used for the jwt-bearer authorization grant."}]}},"description":"Parameters to support JSON Web Token (JWT) Profile for Oauth 2.0 Authorization Grant based authentication. See https://tools.ietf.org/html/rfc7523 for more details."},"EnterpriseCrmEventbusProtoFunction":{"title":"EnterpriseCrmEventbusProtoFunction","type":"object","properties":{"parameters":{"type":"array","items":{"$ref":"#/components/schemas/EnterpriseCrmEventbusProtoTransformExpression"},"description":"List of parameters required for the transformation."},"functionType":{"$ref":"#/components/schemas/EnterpriseCrmEventbusProtoFunctionType"}}},"GoogleCloudIntegrationsV1alphaSuspensionApprovalExpiration":{"title":"GoogleCloudIntegrationsV1alphaSuspensionApprovalExpiration","type":"object","properties":{"expireTime":{"type":"string","description":"Output only. Time after which the suspension expires, if no action taken."},"remindTime":{"type":"string","description":"Time after the previous suspension action reminder, if any, is sent using the selected notification option, for a suspension which is still PENDING_UNSPECIFIED."},"liftWhenExpired":{"type":"boolean","description":"Whether the suspension will be REJECTED or LIFTED upon expiration. REJECTED is the default behavior."}},"description":"Expiration configs for the approval request."},"EnterpriseCrmFrontendsEventbusProtoEventParameters":{"title":"EnterpriseCrmFrontendsEventbusProtoEventParameters","type":"object","properties":{"parameters":{"type":"array","items":{"$ref":"#/components/schemas/EnterpriseCrmFrontendsEventbusProtoParameterEntry"},"description":"Parameters are a part of Event and can be used to communicate between different tasks that are part of the same workflow execution."}},"description":"LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4"},"GoogleCloudIntegrationsV1alphaListExecutionsResponse":{"title":"GoogleCloudIntegrationsV1alphaListExecutionsResponse","type":"object","properties":{"executionInfos":{"type":"array","items":{"$ref":"#/components/schemas/EnterpriseCrmFrontendsEventbusProtoEventExecutionInfo"},"description":"Required. The detailed information of requested executions."},"executions":{"type":"array","items":{"$ref":"#/components/schemas/GoogleCloudIntegrationsV1alphaExecution"},"description":"The detailed information of requested executions"},"nextPageToken":{"type":"string","description":"The token used to retrieve the next page results."}},"description":"Response for listing the integration execution data."},"GoogleCloudIntegrationsV1alphaLiftSuspensionResponse":{"title":"GoogleCloudIntegrationsV1alphaLiftSuspensionResponse","type":"object","properties":{"eventExecutionInfoId":{"type":"string","description":"Execution Id that will be returned"}},"description":"Response of lift Suspense"},"GoogleCloudIntegrationsV1alphaTestIntegrationsRequest":{"title":"GoogleCloudIntegrationsV1alphaTestIntegrationsRequest","type":"object","properties":{"integrationVersion":{"allOf":[{"$ref":"#/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationVersion"},{"description":"The integration version definition."}]},"parameters":{"allOf":[{"$ref":"#/components/schemas/EnterpriseCrmFrontendsEventbusProtoEventParameters"},{"description":"LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4"}]},"clientId":{"type":"string","description":"Required. This is used to identify the client on whose behalf the event will be executed."},"testMode":{"type":"boolean","description":"Optional. Can be specified in the event request, otherwise false (default). If true, enables tasks with condition \"test_mode = true\". If false, disables tasks with condition \"test_mode = true\" if global test mode (set by platform) is also false {@link EventBusConfig}."},"deadlineSecondsTime":{"type":"string","description":"Optional. custom deadline of the rpc"},"triggerId":{"type":"string","description":"Required. The trigger id of the integration trigger config. If both trigger_id and client_id is present, the integration is executed from the start tasks provided by the matching trigger config otherwise it is executed from the default start tasks."},"inputParameters":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/GoogleCloudIntegrationsV1alphaValueType"},"description":"Optional. Input parameters used during integration execution."}},"description":"The request for testing an integration."},"EnterpriseCrmEventbusProtoBaseFunction":{"title":"EnterpriseCrmEventbusProtoBaseFunction","type":"object","properties":{"functionName":{"$ref":"#/components/schemas/FunctionName5"}}},"EnterpriseCrmEventbusProtoEventExecutionSnapshotEventExecutionSnapshotMetadata":{"title":"EnterpriseCrmEventbusProtoEventExecutionSnapshotEventExecutionSnapshotMetadata","type":"object","properties":{"taskName":{"type":"string","description":"the task name associated with this snapshot. Could be empty."},"eventAttemptNum":{"type":"integer","description":"the event attempt number this snapshot belongs to.","contentEncoding":"int32"},"taskNumber":{"type":"string","description":"The task number associated with this snapshot. Could be empty."},"taskAttemptNum":{"type":"integer","description":"the task attempt number this snapshot belongs to. Could be empty.","contentEncoding":"int32"}}},"GoogleCloudIntegrationsV1alphaListRuntimeEntitySchemasResponse":{"title":"GoogleCloudIntegrationsV1alphaListRuntimeEntitySchemasResponse","type":"object","properties":{"runtimeEntitySchemas":{"type":"array","items":{"$ref":"#/components/schemas/GoogleCloudIntegrationsV1alphaRuntimeEntitySchema"},"description":"Runtime entity schemas."},"nextPageToken":{"type":"string","description":"Next page token."}},"description":"Response for listing RuntimeEntitySchemas for a specific Connection."},"GoogleCloudConnectorsV1AuthConfigOauth2JwtBearerJwtClaims":{"title":"GoogleCloudConnectorsV1AuthConfigOauth2JwtBearerJwtClaims","type":"object","properties":{"subject":{"type":"string","description":"Value for the \"sub\" claim."},"issuer":{"type":"string","description":"Value for the \"iss\" claim."},"audience":{"type":"string","description":"Value for the \"aud\" claim."}},"description":"JWT claims used for the jwt-bearer authorization grant."},"GoogleCloudIntegrationsV1alphaBooleanParameterArray":{"title":"GoogleCloudIntegrationsV1alphaBooleanParameterArray","type":"object","properties":{"booleanValues":{"type":"array","items":{"type":"boolean"},"description":"Boolean array."}},"description":"This message only contains a field of boolean array."},"EnterpriseCrmEventbusProtoFieldMappingConfig":{"title":"EnterpriseCrmEventbusProtoFieldMappingConfig","type":"object","properties":{"mappedFields":{"type":"array","items":{"$ref":"#/components/schemas/EnterpriseCrmEventbusProtoMappedField"},"description":""}},"description":"Field Mapping Config to map multiple output fields values from input fields values. Next id: 2"},"GoogleCloudIntegrationsV1alphaIntegrationAlertConfigThresholdValue":{"title":"GoogleCloudIntegrationsV1alphaIntegrationAlertConfigThresholdValue","type":"object","properties":{"percentage":{"type":"integer","description":"Percentage threshold.","contentEncoding":"int32"},"absolute":{"type":"string","description":"Absolute value threshold."}},"description":"The threshold value of the metric, above or below which the alert should be triggered. See EventAlertConfig or TaskAlertConfig for the different alert metric types in each case. For the *RATE metrics, one or both of these fields may be set. Zero is the default value and can be left at that. For *PERCENTILE_DURATION metrics, one or both of these fields may be set, and also, the duration threshold value should be specified in the threshold_duration_ms member below. For *AVERAGE_DURATION metrics, these fields should not be set at all. A different member, threshold_duration_ms, must be set in the EventAlertConfig or the TaskAlertConfig."},"GoogleCloudIntegrationsV1alphaCreateBundleResponse":{"title":"GoogleCloudIntegrationsV1alphaCreateBundleResponse","type":"object","properties":{"triggerId":{"type":"string","description":"trigger_id of the bundle task"},"config":{"allOf":[{"$ref":"#/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationBundleConfig"},{"description":"This proto holds the core runner data in the bundle task. It is not expected to be directly edited by the user. Instead, a default value will be provided at the task creation time."}]}},"description":"Response for create bundle."},"EnterpriseCrmEventbusProtoParameterValueType":{"title":"EnterpriseCrmEventbusProtoParameterValueType","type":"object","properties":{"doubleValue":{"type":"number"},"stringValue":{"type":"string"},"booleanArray":{"$ref":"#/components/schemas/EnterpriseCrmEventbusProtoBooleanParameterArray"},"protoArray":{"$ref":"#/components/schemas/EnterpriseCrmEventbusProtoProtoParameterArray"},"serializedObjectValue":{"$ref":"#/components/schemas/EnterpriseCrmEventbusProtoSerializedObjectParameter"},"protoValue":{"type":"object","additionalProperties":{}},"intArray":{"$ref":"#/components/schemas/EnterpriseCrmEventbusProtoIntParameterArray"},"booleanValue":{"type":"boolean"},"intValue":{"type":"string"},"stringArray":{"$ref":"#/components/schemas/EnterpriseCrmEventbusProtoStringParameterArray"},"doubleArray":{"$ref":"#/components/schemas/EnterpriseCrmEventbusProtoDoubleParameterArray"}},"description":"LINT.IfChange To support various types of parameter values. Next available id: 14"},"GoogleCloudIntegrationsV1alphaScheduleIntegrationsRequest":{"title":"GoogleCloudIntegrationsV1alphaScheduleIntegrationsRequest","type":"object","properties":{"inputParameters":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/GoogleCloudIntegrationsV1alphaValueType"},"description":"Optional. Input parameters used by integration execution."},"requestId":{"type":"string","description":"This is used to de-dup incoming request: if the duplicate request was detected, the response from the previous execution is returned."},"scheduleTime":{"type":"string","description":"The time that the integration should be executed. If the time is less or equal to the current time, the integration is executed immediately."},"triggerId":{"type":"string","description":"Matched against all {@link TriggerConfig}s across all integrations. i.e. TriggerConfig.trigger_id.equals(trigger_id)"},"parameters":{"allOf":[{"$ref":"#/components/schemas/EnterpriseCrmEventbusProtoEventParameters"},{"description":"LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4"}]},"parameterEntries":{"type":"array","items":{"$ref":"#/components/schemas/EnterpriseCrmFrontendsEventbusProtoParameterEntry"},"description":"Parameters are a part of Event and can be used to communicate between different tasks that are part of the same integration execution."}},"description":"The request for scheduling an integration."},"EnterpriseCrmEventbusProtoDoubleArrayFunction":{"title":"EnterpriseCrmEventbusProtoDoubleArrayFunction","type":"object","properties":{"functionName":{"$ref":"#/components/schemas/FunctionName1"}}},"EnterpriseCrmEventbusProtoValueType":{"title":"EnterpriseCrmEventbusProtoValueType","type":"object","properties":{"intValue":{"type":"string"},"doubleArray":{},"booleanValue":{"type":"boolean"},"protoValue":{"type":"object","additionalProperties":{}},"intArray":{},"doubleValue":{"type":"number"},"stringValue":{"type":"string"},"stringArray":{}},"description":"Used for define type for values. Currently supported value types include int, string, double, array, and any proto message."},"EnterpriseCrmEventbusProtoIntParameterArray":{"title":"EnterpriseCrmEventbusProtoIntParameterArray","type":"object","properties":{"intValues":{"type":"array","items":{"type":"string"},"description":""}}},"EnterpriseCrmCardsTemplatesAplosSeriesData":{"title":"EnterpriseCrmCardsTemplatesAplosSeriesData","type":"object","properties":{"rows":{"type":"array","items":{"$ref":"#/components/schemas/EnterpriseCrmCardsTemplatesAplosSeriesDataRow"},"description":"A single Series Row"}},"description":"Data used to render an Aplos Series card."},"EnterpriseCrmEventbusProtoEventBusProperties":{"title":"EnterpriseCrmEventbusProtoEventBusProperties","type":"object","properties":{"properties":{"type":"array","items":{"$ref":"#/components/schemas/EnterpriseCrmEventbusProtoPropertyEntry"},"description":"An unordered list of property entries."}},"description":"LINT.IfChange This message is used for storing key value pair properties for each Event / Task in the EventBus. Please see go/cloud-crm-eng/platform/event_bus.md for more details."},"GoogleCloudIntegrationsV1alphaValueType":{"title":"GoogleCloudIntegrationsV1alphaValueType","type":"object","properties":{"doubleArray":{"description":"Double Number Array."},"booleanArray":{"description":"Boolean Array."},"stringArray":{"description":"String Array."},"booleanValue":{"type":"boolean","description":"Boolean."},"jsonValue":{"type":"string","description":"Json."},"doubleValue":{"type":"number","description":"Double Number."},"intValue":{"type":"string","description":"Integer."},"intArray":{"description":"Integer Array."},"stringValue":{"type":"string","description":"String."}},"description":"The type of the parameter."},"GoogleCloudIntegrationsV1alphaMonitorExecutionStatsRequestMashQueryComponent":{"title":"GoogleCloudIntegrationsV1alphaMonitorExecutionStatsRequestMashQueryComponent","type":"object","properties":{"groupBy":{"allOf":[{"$ref":"#/components/schemas/GoogleCloudIntegrationsV1alphaMonitorExecutionStatsRequestGroupBy"},{"description":"MashQuery GroupBy parameters."}]},"pointOperation":{"type":"string","description":"Optional. optional, Point Operation on single query or joined query."},"borgTaskMetric":{"allOf":[{"$ref":"#/components/schemas/BorgTaskMetric"},{"description":"Required. The metric for monarch.BorgTask."}]},"fetchFilters":{"type":"array","items":{"type":"string"},"description":"Optional. optional, filters for Fetch Raw, \"metric:client_id\" not supported."},"timeDelta":{"type":"string","description":"Required. Window time delta."},"dataFilters":{"type":"array","items":{"type":"string"},"description":"Optional. optional, filters on fetched data, \"metric:client_id\" not supported."}},"description":"The components for constructing MashQuery."},"GoogleCloudIntegrationsV1alphaMonitorExecutionStatsResponse":{"title":"GoogleCloudIntegrationsV1alphaMonitorExecutionStatsResponse","type":"object","properties":{"aplosSeriesListData":{"allOf":[{"$ref":"#/components/schemas/EnterpriseCrmCardsTemplatesAplosSeriesListData"},{"description":"Data used for Aplos charts that accept multiple Series."}]},"tableData":{"allOf":[{"$ref":"#/components/schemas/EnterpriseCrmCardsTabularData"},{"description":"The generic data format returned from all connectors."}]}},"description":"The response for getting Execution stats."},"GoogleCloudIntegrationsV1alphaCloudSchedulerConfig":{"title":"GoogleCloudIntegrationsV1alphaCloudSchedulerConfig","type":"object","properties":{"errorMessage":{"type":"string","description":"Optional. When the job was deleted from Pantheon UI, error_message will be populated when Get/List integrations"},"location":{"type":"string","description":"Required. The location where associated cloud scheduler job will be created"},"cronTab":{"type":"string","description":"Required. The cron tab of cloud scheduler trigger."},"serviceAccountEmail":{"type":"string","description":"Required. Service account used by Cloud Scheduler to trigger the integration at scheduled time"}},"description":"Cloud Scheduler Trigger configuration"},"GoogleCloudIntegrationsV1alphaProjectProperties":{"title":"GoogleCloudIntegrationsV1alphaProjectProperties","type":"object","properties":{"provisionedRegions":{"type":"array","items":{"type":"string"},"description":"A list of provisioned regions on the current project"},"ipEnablementState":{"allOf":[{"$ref":"#/components/schemas/IpEnablementState"},{"description":"An enum value of what the enablement state is for the given project"}]}},"description":"Metadata information for the given project"},"EnterpriseCrmCardsTabularData":{"title":"EnterpriseCrmCardsTabularData","type":"object","properties":{"rows":{"type":"array","items":{},"description":"Ordered list of table rows."},"headers":{"type":"array","items":{"type":"string"},"description":"Ordered list of column headers."}},"description":"The generic data format returned from all connectors."},"EnterpriseCrmEventbusProtoIntFunction":{"title":"EnterpriseCrmEventbusProtoIntFunction","type":"object","properties":{"functionName":{"$ref":"#/components/schemas/FunctionName2"}}},"GoogleCloudIntegrationsV1alphaExecutionDetails":{"title":"GoogleCloudIntegrationsV1alphaExecutionDetails","type":"object","properties":{"executionSnapshots":{"type":"array","items":{"$ref":"#/components/schemas/GoogleCloudIntegrationsV1alphaExecutionSnapshot"},"description":"List of snapshots taken during the execution."},"attemptStats":{"type":"array","items":{"$ref":"#/components/schemas/GoogleCloudIntegrationsV1alphaAttemptStats"},"description":"List of Start and end time of the execution attempts."},"state":{"allOf":[{"$ref":"#/components/schemas/State1"},{"description":"Status of the execution."}]}},"description":"Contains the details of the execution info: this includes the tasks execution details plus the event execution statistics."},"EnterpriseCrmEventbusProtoTaskUiModuleConfig":{"title":"EnterpriseCrmEventbusProtoTaskUiModuleConfig","type":"object","properties":{"moduleId":{"allOf":[{"$ref":"#/components/schemas/ModuleId"},{"description":"ID of the config module."}]}},"description":"Task author would use this type to configure a config module."},"EnterpriseCrmCardsTemplatesAplosSeriesListDataSeries":{"title":"EnterpriseCrmCardsTemplatesAplosSeriesListDataSeries","type":"object","properties":{"name":{"type":"string"},"data":{"allOf":[{"$ref":"#/components/schemas/EnterpriseCrmCardsTemplatesAplosSeriesData"},{"description":"Data used to render an Aplos Series card."}]}}},"GoogleCloudIntegrationsV1alphaIntegrationVersion":{"title":"GoogleCloudIntegrationsV1alphaIntegrationVersion","type":"object","properties":{"teardown":{"description":"Optional. Contains a graph of tasks that will be executed before putting the event in a terminal state (SUCCEEDED/FAILED/FATAL), regardless of success or failure, similar to \"finally\" in code."},"updateTime":{"type":"string","description":"Output only. Auto-generated."},"triggerConfigsInternal":{"type":"array","items":{},"description":"Optional. Trigger configurations."},"databasePersistencePolicy":{"allOf":[{"$ref":"#/components/schemas/DatabasePersistencePolicy"},{"description":"Optional. Flag to disable database persistence for execution data, including event execution info, execution export info, execution metadata index and execution param index."}]},"lockHolder":{"type":"string","description":"Optional. The edit lock holder's email address. Generated based on the End User Credentials/LOAS role of the user making the call."},"name":{"type":"string","description":"Output only. Auto-generated primary key."},"integrationParametersInternal":{"description":"Optional. Parameters that are expected to be passed to the integration when an event is triggered. This consists of all the parameters that are expected in the integration execution. This gives the user the ability to provide default values, add information like PII and also provide data types of each parameter."},"userLabel":{"type":"string","description":"Optional. A user-defined label that annotates an integration version. Typically, this is only set when the integration version is created."},"state":{"allOf":[{"$ref":"#/components/schemas/State"},{"description":"Output only. User should not set it as an input."}]},"status":{"allOf":[{"$ref":"#/components/schemas/Status"},{"description":"Output only. Generated by eventbus. User should not set it as an input."}]},"taskConfigs":{"type":"array","items":{},"description":"Optional. Task configuration for the integration. It's optional, but the integration doesn't do anything without task_configs."},"integrationParameters":{"type":"array","items":{},"description":"Optional. Parameters that are expected to be passed to the integration when an event is triggered. This consists of all the parameters that are expected in the integration execution. This gives the user the ability to provide default values, add information like PII and also provide data types of each parameter."},"triggerConfigs":{"type":"array","items":{},"description":"Optional. Trigger configurations."},"parentTemplateId":{"type":"string","description":"Optional. The id of the template which was used to create this integration_version."},"lastModifierEmail":{"type":"string","description":"Optional. The last modifier's email address. Generated based on the End User Credentials/LOAS role of the user making the call."},"snapshotNumber":{"type":"string","description":"Optional. An increasing sequence that is set when a new snapshot is created. The last created snapshot can be identified by [workflow_name, org_id latest(snapshot_number)]. However, last created snapshot need not be same as the HEAD. So users should always use \"HEAD\" tag to identify the head."},"createTime":{"type":"string","description":"Output only. Auto-generated."},"taskConfigsInternal":{"type":"array","items":{},"description":"Optional. Task configuration for the integration. It's optional, but the integration doesn't do anything without task_configs."},"origin":{"allOf":[{"$ref":"#/components/schemas/Origin"},{"description":"Optional. The origin that indicates where this integration is coming from."}]},"description":{"type":"string","description":"Optional. The integration description."}},"description":"The integration version definition."},"EnterpriseCrmFrontendsEventbusProtoBooleanParameterArray":{"title":"EnterpriseCrmFrontendsEventbusProtoBooleanParameterArray","type":"object","properties":{"booleanValues":{"type":"array","items":{"type":"boolean"},"description":""}}},"GoogleCloudIntegrationsV1alphaGetBundleResponse":{"title":"GoogleCloudIntegrationsV1alphaGetBundleResponse","type":"object","properties":{"config":{"allOf":[{"$ref":"#/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationBundleConfig"},{"description":"This proto holds the core runner data in the bundle task. It is not expected to be directly edited by the user. Instead, a default value will be provided at the task creation time."}]}},"description":"Response for GetBundle."},"EnterpriseCrmEventbusProtoTaskAlertConfig":{"title":"EnterpriseCrmEventbusProtoTaskAlertConfig","type":"object","properties":{"durationThresholdMs":{"type":"string","description":"Should be specified only for TASK_AVERAGE_DURATION and TASK_PERCENTILE_DURATION metrics. This member should be used to specify what duration value the metrics should exceed for the alert to trigger."},"alertDisabled":{"type":"boolean","description":"Set to false by default. When set to true, the metrics are not aggregated or pushed to Monarch for this workflow alert."},"playbookUrl":{"type":"string","description":"Link to a playbook for resolving the issue that triggered this alert."},"metricType":{"$ref":"#/components/schemas/MetricType"},"thresholdType":{"allOf":[{"$ref":"#/components/schemas/ThresholdType"},{"description":"The threshold type for which this alert is being configured. If value falls below expected_min or exceeds expected_max, an alert will be fired."}]},"aggregationPeriod":{"type":"string","description":"The period over which the metric value should be aggregated and evaluated. Format is , where integer should be a positive integer and unit should be one of (s,m,h,d,w) meaning (second, minute, hour, day, week)."},"onlyFinalAttempt":{"type":"boolean","description":"Only count final task attempts, not retries."},"warningEnumList":{"allOf":[{"$ref":"#/components/schemas/EnterpriseCrmEventbusProtoBaseAlertConfigErrorEnumList"},{"description":"List of error enums for alerts."}]},"numAggregationPeriods":{"type":"integer","description":"For how many contiguous aggregation periods should the expected min or max be violated for the alert to be fired.","contentEncoding":"int32"},"clientId":{"type":"string","description":"Client associated with this alert configuration. Must be a client enabled in one of the containing workflow's triggers."},"thresholdValue":{"allOf":[{"$ref":"#/components/schemas/EnterpriseCrmEventbusProtoBaseAlertConfigThresholdValue"},{"description":"The threshold value of the metric, above or below which the alert should be triggered. See EventAlertConfig or TaskAlertConfig for the different alert metric types in each case. For the *RATE metrics, one or both of these fields may be set. Zero is the default value and can be left at that. For *PERCENTILE_DURATION metrics, one or both of these fields may be set, and also, the duration threshold value should be specified in the threshold_duration_ms member below. For *AVERAGE_DURATION metrics, these fields should not be set at all. A different member, threshold_duration_ms, must be set in the EventAlertConfig or the TaskAlertConfig. See go/eventbus-alert-config-examples"}]},"errorEnumList":{"allOf":[{"$ref":"#/components/schemas/EnterpriseCrmEventbusProtoBaseAlertConfigErrorEnumList"},{"description":"List of error enums for alerts."}]},"alertName":{"type":"string","description":"A name to identify this alert. This will be displayed in the alert subject. If set, this name should be unique in within the scope of the containing workflow."}},"description":"Message to be used to configure alerting in the {@code TaskConfig} protos for tasks in an event. See go/eventbus-alert-config-examples for examples of the different alerts that can be configured."},"GoogleCloudIntegrationsV1alphaSuspension":{"title":"GoogleCloudIntegrationsV1alphaSuspension","type":"object","properties":{"state":{"allOf":[{"$ref":"#/components/schemas/State2"},{"description":"Required. State of this suspension, indicating what action a resolver has taken."}]},"audit":{"allOf":[{"$ref":"#/components/schemas/GoogleCloudIntegrationsV1alphaSuspensionAudit"},{"description":"Contains when and by whom the suspension was resolved."}]},"suspensionConfig":{"$ref":"#/components/schemas/EnterpriseCrmEventbusProtoSuspensionConfig"},"eventExecutionInfoId":{"type":"string","description":"Required. ID of the associated execution."},"taskId":{"type":"string","description":"Required. Task id of the associated SuspensionTask."},"approvalConfig":{"allOf":[{"$ref":"#/components/schemas/GoogleCloudIntegrationsV1alphaSuspensionApprovalConfig"},{"description":"Configurations for approving the Suspension."}]},"createTime":{"type":"string","description":"Output only. Auto-generated."},"name":{"type":"string","description":"Resource name for suspensions suspension/{suspension_id}"},"integration":{"type":"string","description":"Required. The name of the originating integration."},"lastModifyTime":{"type":"string","description":"Output only. Auto-generated."}},"description":"A record representing a suspension."},"EnterpriseCrmFrontendsEventbusProtoStringParameterArray":{"title":"EnterpriseCrmFrontendsEventbusProtoStringParameterArray","type":"object","properties":{"stringValues":{"type":"array","items":{"type":"string"},"description":""}}},"EnterpriseCrmEventbusProtoTaskExecutionDetails":{"title":"EnterpriseCrmEventbusProtoTaskExecutionDetails","type":"object","properties":{"taskAttemptStats":{"type":"array","items":{"$ref":"#/components/schemas/EnterpriseCrmEventbusProtoTaskExecutionDetailsTaskAttemptStats"},"description":""},"taskExecutionState":{"$ref":"#/components/schemas/TaskExecutionState"},"taskNumber":{"type":"string","description":"Pointer to the task config it used for execution."}},"description":"Contains the details of the execution of this task. Next available id: 11"},"EnterpriseCrmEventbusProtoTaskMetadataAdmin":{"title":"EnterpriseCrmEventbusProtoTaskMetadataAdmin","type":"object","properties":{"googleGroupEmail":{"type":"string"},"userEmail":{"type":"string"}},"description":"Admins are owners of a Task, and have all permissions on a particular task identified by the task name. By default, Eventbus periodically scans all task metadata and syncs (adds) any new admins defined here to Zanzibar."},"GoogleCloudIntegrationsV1alphaExecuteIntegrationsResponse":{"title":"GoogleCloudIntegrationsV1alphaExecuteIntegrationsResponse","type":"object","properties":{"eventParameters":{"allOf":[{"$ref":"#/components/schemas/EnterpriseCrmFrontendsEventbusProtoEventParameters"},{"description":"LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4"}]},"executionFailed":{"type":"boolean","description":"Is true if any execution in the integration failed. False otherwise."},"parameterEntries":{"type":"array","items":{"$ref":"#/components/schemas/EnterpriseCrmFrontendsEventbusProtoParameterEntry"},"description":"Parameters are a part of Event and can be used to communicate between different tasks that are part of the same integration execution."},"executionId":{"type":"string","description":"The id of the execution corresponding to this run of integration."},"outputParameters":{"type":"object","additionalProperties":{},"description":"OUTPUT parameters in format of Map. Where Key is the name of the parameter. Note: Name of the system generated parameters are wrapped by backtick(`) to distinguish them from the user defined parameters."}},"description":"The response for executing an integration."},"EnterpriseCrmEventbusProtoEventExecutionDetailsEventAttemptStats":{"title":"EnterpriseCrmEventbusProtoEventExecutionDetailsEventAttemptStats","type":"object","properties":{"endTime":{"type":"string","description":"The end time of the event execution for current attempt."},"startTime":{"type":"string","description":"The start time of the event execution for current attempt. This could be in the future if it's been scheduled."}}},"GoogleCloudIntegrationsV1alphaListIntegrationVersionsResponse":{"title":"GoogleCloudIntegrationsV1alphaListIntegrationVersionsResponse","type":"object","properties":{"noPermission":{"type":"boolean","description":"Whether the user has no permission on the version or not."},"integrationVersions":{"type":"array","items":{"$ref":"#/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationVersion"},"description":"The integrations which match the request."},"nextPageToken":{"type":"string","description":"A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages."}},"description":"Response for ListIntegrationVersions."},"EnterpriseCrmEventbusProtoBooleanParameterArray":{"title":"EnterpriseCrmEventbusProtoBooleanParameterArray","type":"object","properties":{"booleanValues":{"type":"array","items":{"type":"boolean"},"description":""}}},"EnterpriseCrmFrontendsEventbusProtoRollbackStrategy":{"title":"EnterpriseCrmFrontendsEventbusProtoRollbackStrategy","type":"object","properties":{"rollbackTaskImplementationClassName":{"type":"string","description":"Required. This is the name of the task that needs to be executed upon rollback of this task."},"taskNumbersToRollback":{"type":"array","items":{"type":"string"},"description":"Required. These are the tasks numbers of the tasks whose `rollback_strategy.rollback_task_implementation_class_name` needs to be executed upon failure of this task."},"parameters":{"allOf":[{"$ref":"#/components/schemas/EnterpriseCrmFrontendsEventbusProtoEventParameters"},{"description":"LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4"}]}},"description":"Next available id: 4"},"GoogleCloudIntegrationsV1alphaExecution":{"title":"GoogleCloudIntegrationsV1alphaExecution","type":"object","properties":{"eventExecutionDetails":{"description":"The execution info about this event."},"requestParameters":{"type":"object","additionalProperties":{},"description":"Event parameters come in as part of the request."},"executionMethod":{"allOf":[{"$ref":"#/components/schemas/ExecutionMethod"},{"description":"The ways user posts this event."}]},"name":{"type":"string","description":"Auto-generated primary key."},"directSubExecutions":{"type":"array","items":{},"description":"Direct sub executions of the following Execution."},"requestParams":{"type":"array","items":{},"description":"Event parameters come in as part of the request."},"updateTime":{"type":"string","description":"Output only. Last modified time of the execution."},"responseParameters":{"type":"object","additionalProperties":{},"description":"Event parameters returned as part of the response."},"triggerId":{"type":"string","description":"The trigger id of the integration trigger config. If both trigger_id and client_id is present, the integration is executed from the start tasks provided by the matching trigger config otherwise it is executed from the default start tasks."},"responseParams":{"type":"array","items":{},"description":"Event parameters come out as part of the response."},"createTime":{"type":"string","description":"Output only. Created time of the execution."},"executionDetails":{"description":"Detailed info of this execution."}},"description":"The Execution resource contains detailed information of an individual integration execution."},"GoogleCloudIntegrationsV1alphaEnumerateConnectorPlatformRegionsResponse":{"title":"GoogleCloudIntegrationsV1alphaEnumerateConnectorPlatformRegionsResponse","type":"object","properties":{"regions":{"type":"array","items":{"type":"string"},"description":"All regions where Connector Platform is provisioned."}},"description":"Response containing all provisioned regions for Connector Platform."},"GoogleCloudIntegrationsV1alphaCreateBundleRequest":{"title":"GoogleCloudIntegrationsV1alphaCreateBundleRequest","type":"object","properties":{"bundleId":{"type":"string","description":"Required. name of the bundle that will be created"},"secondaryCustomerOrgId":{"type":"string","description":"Optional. The prefix for the SA, it should be in the format \"o\". This is an optional field, and if empty service account will be created per project, where we are creating bundle. This should only be used as the org ID for which we want to run the integrations in the bundle."},"integrations":{"type":"array","items":{"type":"string"},"description":"A list of integrations that can be executed by the bundle"}},"description":"PROTECT WITH A VISIBILITY LABEL. THIS METHOD WILL BE MOVED TO A SEPARATE SERVICE. Request to create a new Bundle."},"GoogleCloudIntegrationsV1alphaExecutionSnapshot":{"title":"GoogleCloudIntegrationsV1alphaExecutionSnapshot","type":"object","properties":{"checkpointTaskNumber":{"type":"string","description":"Indicates \"after which checkpoint task's execution\" this snapshot is taken."},"executionSnapshotMetadata":{"description":"Metadata of the execution snapshot."},"params":{"type":"object","additionalProperties":{},"description":"Parameters used during the execution."},"taskExecutionDetails":{"type":"array","items":{},"description":"All of the task execution details at the given point of time."}},"description":"Contains the snapshot of the execution for a given checkpoint."},"EnterpriseCrmEventbusProtoStringFunction":{"title":"EnterpriseCrmEventbusProtoStringFunction","type":"object","properties":{"functionName":{"$ref":"#/components/schemas/FunctionName9"}}},"GoogleCloudIntegrationsV1alphaMonitorExecutionStatsRequestMashQuery":{"title":"GoogleCloudIntegrationsV1alphaMonitorExecutionStatsRequestMashQuery","type":"object","properties":{"firstQuery":{"allOf":[{"$ref":"#/components/schemas/GoogleCloudIntegrationsV1alphaMonitorExecutionStatsRequestMashQueryComponent"},{"description":"The components for constructing MashQuery."}]},"operationMode":{"allOf":[{"$ref":"#/components/schemas/GoogleCloudIntegrationsV1alphaMonitorExecutionStatsRequestMashQueryOperationMode"},{"description":"Operation between 2 query"}]},"secondQuery":{"allOf":[{"$ref":"#/components/schemas/GoogleCloudIntegrationsV1alphaMonitorExecutionStatsRequestMashQueryComponent"},{"description":"The components for constructing MashQuery."}]}},"description":"The MashQuery for searching data, set both queries for Join Operation."},"EnterpriseCrmEventbusProtoSerializedObjectParameter":{"title":"EnterpriseCrmEventbusProtoSerializedObjectParameter","type":"object","properties":{"objectValue":{"type":"string"}}},"EnterpriseCrmEventbusProtoIntArray":{"title":"EnterpriseCrmEventbusProtoIntArray","type":"object","properties":{"values":{"type":"array","items":{"type":"string"},"description":""}}},"CrmlogErrorCode":{"title":"CrmlogErrorCode","type":"object","properties":{"commonErrorCode":{"$ref":"#/components/schemas/CommonErrorCode"}},"description":"Registered ids for errors, as \"oneof\" enums. Each task or logical grouping of tasks may share the same enum."},"EnterpriseCrmFrontendsEventbusProtoTriggerConfig":{"title":"EnterpriseCrmFrontendsEventbusProtoTriggerConfig","type":"object","properties":{"description":{"type":"string","description":"User-provided description intended to give more business context about the task."},"alertConfig":{"type":"array","items":{"$ref":"#/components/schemas/EnterpriseCrmEventbusProtoWorkflowAlertConfig"},"description":"An alert threshold configuration for the [trigger + client + workflow] tuple. If these values are not specified in the trigger config, default values will be populated by the system. Note that there must be exactly one alert threshold configured per [client + trigger + workflow] when published."},"triggerCriteria":{"$ref":"#/components/schemas/EnterpriseCrmEventbusProtoTriggerCriteria"},"startTasks":{"type":"array","items":{"$ref":"#/components/schemas/EnterpriseCrmEventbusProtoNextTask"},"description":"Set of tasks numbers from where the workflow execution is started by this trigger. If this is empty, then workflow is executed with default start tasks. In the list of start tasks, none of two tasks can have direct ancestor-descendant relationships (i.e. in a same workflow execution graph)."},"properties":{"type":"object","additionalProperties":{"type":"string"},"description":"Configurable properties of the trigger, not to be confused with workflow parameters. E.g. \"name\" is a property for API triggers and \"subscription\" is a property for Cloud Pubsub triggers."},"triggerNumber":{"type":"string","description":"Required. A number to uniquely identify each trigger config within the workflow on UI."},"position":{"allOf":[{"$ref":"#/components/schemas/EnterpriseCrmEventbusProtoCoordinate"},{"description":"Represents two-dimensional positions."}]},"label":{"type":"string","description":"The user created label for a particular trigger."},"cloudSchedulerConfig":{"allOf":[{"$ref":"#/components/schemas/EnterpriseCrmEventbusProtoCloudSchedulerConfig"},{"description":"Cloud Scheduler Trigger configuration"}]},"pauseWorkflowExecutions":{"type":"boolean","description":"Optional. If set to true, any upcoming requests for this trigger config will be paused and the executions will be resumed later when the flag is reset. The workflow to which this trigger config belongs has to be in ACTIVE status for the executions to be paused or resumed."},"triggerId":{"type":"string","description":"The backend trigger ID."},"enabledClients":{"type":"array","items":{"type":"string"},"description":"Required. The list of client ids which are enabled to execute the workflow using this trigger. In other words, these clients have the workflow execution privledges for this trigger. For API trigger, the client id in the incoming request is validated against the list of enabled clients. For non-API triggers, one workflow execution is triggered on behalf of each enabled client."},"triggerType":{"$ref":"#/components/schemas/TriggerType"},"nextTasksExecutionPolicy":{"allOf":[{"$ref":"#/components/schemas/NextTasksExecutionPolicy"},{"description":"Dictates how next tasks will be executed."}]}},"description":"Configuration detail of a trigger. Next available id: 17"},"EnterpriseCrmEventbusProtoNextTeardownTask":{"title":"EnterpriseCrmEventbusProtoNextTeardownTask","type":"object","properties":{"name":{"type":"string","description":"Required. Name of the next teardown task."}},"description":"The teardown task that is next in line to be executed. We support only sequential execution of teardown tasks (i.e. no branching)."},"EnterpriseCrmEventbusProtoEventExecutionDetails":{"title":"EnterpriseCrmEventbusProtoEventExecutionDetails","type":"object","properties":{"eventExecutionState":{"$ref":"#/components/schemas/EventExecutionState"},"eventAttemptStats":{"type":"array","items":{"$ref":"#/components/schemas/EnterpriseCrmEventbusProtoEventExecutionDetailsEventAttemptStats"},"description":""},"nextExecutionTime":{"type":"string","description":"Next scheduled execution time in case the execution status was RETRY_ON_HOLD."},"eventRetriesFromBeginningCount":{"type":"integer","description":"Indicates the number of times the execution has restarted from the beginning.","contentEncoding":"int32"},"logFilePath":{"type":"string","description":"The log file path (aka. cns address) for this event."},"eventExecutionSnapshot":{"type":"array","items":{"$ref":"#/components/schemas/EnterpriseCrmEventbusProtoEventExecutionSnapshot"},"description":""},"networkAddress":{"type":"string","description":"The network address (aka. bns address) that indicates where the event executor is running."},"ryeLockUnheldCount":{"type":"integer","description":"Used internally and shouldn't be exposed to users. A counter for the cron job to record how many times this event is in in_process state but don't have a lock consecutively/","contentEncoding":"int32"}},"description":"Contains the details of the execution info of this event: this includes the tasks execution details plus the event execution statistics. Next available id: 10"},"EnterpriseCrmFrontendsEventbusProtoParameterMapField":{"title":"EnterpriseCrmFrontendsEventbusProtoParameterMapField","type":"object","properties":{"literalValue":{"description":"Passing a literal value."},"referenceKey":{"type":"string","description":"Referencing one of the WF variables."}},"description":"Field represents either the key or value in an entry."},"EnterpriseCrmEventbusProtoTeardown":{"title":"EnterpriseCrmEventbusProtoTeardown","type":"object","properties":{"teardownTaskConfigs":{"type":"array","items":{"$ref":"#/components/schemas/EnterpriseCrmEventbusProtoTeardownTaskConfig"},"description":"Required."}}},"GoogleCloudIntegrationsV1alphaUploadIntegrationVersionResponse":{"title":"GoogleCloudIntegrationsV1alphaUploadIntegrationVersionResponse","type":"object","properties":{"integrationVersion":{"allOf":[{"$ref":"#/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationVersion"},{"description":"The integration version definition."}]}},"description":"Response for UploadIntegrationVersion."},"EnterpriseCrmEventbusProtoLogSettings":{"title":"EnterpriseCrmEventbusProtoLogSettings","type":"object","properties":{"sanitizeOptions":{"allOf":[{"$ref":"#/components/schemas/EnterpriseCrmLoggingGwsSanitizeOptions"},{"description":"Identifies whether a field contains, or may contain, PII or sensitive data, and how to sanitize the field if it does. If a field's privacy type cannot be determined then it is sanitized (e.g., scrubbed). The specific sanitizer implementation is determined by run-time configuration and environment options (e.g., prod vs. qa). next_id: 5"}]},"seedScope":{"$ref":"#/components/schemas/SeedScope"},"shorteningLimits":{"allOf":[{"$ref":"#/components/schemas/EnterpriseCrmLoggingGwsFieldLimits"},{"description":"Describes string and array limits when writing to logs. When a limit is exceeded the *shortener_type* describes how to shorten the field. next_id: 6"}]},"logFieldName":{"type":"string","description":"The name of corresponding logging field of the event property. If omitted, assumes the same name as the event property key."},"seedPeriod":{"$ref":"#/components/schemas/SeedPeriod"}},"description":"The LogSettings define the logging attributes for an event property. These attributes are used to map the property to the parameter in the log proto. Also used to define scrubbing/truncation behavior and PII information. See go/integration-platform/analytics/logging_task.md for details."},"EnterpriseCrmFrontendsEventbusProtoParameterMap":{"title":"EnterpriseCrmFrontendsEventbusProtoParameterMap","type":"object","properties":{"valueType":{"$ref":"#/components/schemas/ValueType"},"entries":{"type":"array","items":{"$ref":"#/components/schemas/EnterpriseCrmFrontendsEventbusProtoParameterMapEntry"},"description":""},"keyType":{"allOf":[{"$ref":"#/components/schemas/KeyType"},{"description":"Option to specify key value type for all entries of the map. If provided then field types for all entries must conform to this."}]}},"description":"A generic multi-map that holds key value pairs. They keys and values can be of any type, unless specified."},"EnterpriseCrmEventbusProtoPropertyEntry":{"title":"EnterpriseCrmEventbusProtoPropertyEntry","type":"object","properties":{"key":{"type":"string","description":"Key is used to retrieve the corresponding property value. This should be unique for a given fired event. The Tasks should be aware of the keys used while firing the events for them to be able to retrieve the values."},"value":{"description":"Values for the defined keys. Each value can either be string, int, double or any proto message."}},"description":"Key-value pair of EventBus property."},"GoogleCloudIntegrationsV1alphaDownloadIntegrationVersionResponse":{"title":"GoogleCloudIntegrationsV1alphaDownloadIntegrationVersionResponse","type":"object","properties":{"content":{"type":"string","description":"String representation of the integration version."}},"description":"Response for DownloadIntegrationVersion."},"EnterpriseCrmEventbusProtoTransformExpression":{"title":"EnterpriseCrmEventbusProtoTransformExpression","type":"object","properties":{"transformationFunctions":{"type":"array","items":{},"description":"Transformations to be applied sequentially."},"initialValue":{"description":"Initial value upon which to perform transformations."}}},"GoogleCloudIntegrationsV1alphaRuntimeActionSchema":{"title":"GoogleCloudIntegrationsV1alphaRuntimeActionSchema","type":"object","properties":{"action":{"type":"string","description":"Name of the action."},"outputSchema":{"type":"string","description":"Output parameter schema for the action."},"inputSchema":{"type":"string","description":"Input parameter schema for the action."}},"description":"Metadata of an action, including schemas for its inputs and outputs."},"GoogleCloudIntegrationsV1alphaMonitorExecutionStatsRequestGroupBy":{"title":"GoogleCloudIntegrationsV1alphaMonitorExecutionStatsRequestGroupBy","type":"object","properties":{"fields":{"type":"array","items":{"type":"string"},"description":"Optional. optional, metrics list for GroupBy."},"reducer":{"type":"string","description":"Optional. optional, reduce function for GroupBy."}},"description":"MashQuery GroupBy parameters."},"EnterpriseCrmEventbusProtoErrorDetail":{"title":"EnterpriseCrmEventbusProtoErrorDetail","type":"object","properties":{"taskNumber":{"type":"integer","description":"The task try-number, in which, the error occurred. If zero, the error happened at the event level.","contentEncoding":"int32"},"severity":{"allOf":[{"$ref":"#/components/schemas/Severity"},{"description":"The severity of the error: ERROR|WARN|INFO."}]},"errorCode":{"allOf":[{"$ref":"#/components/schemas/CrmlogErrorCode"},{"description":"Registered ids for errors, as \"oneof\" enums. Each task or logical grouping of tasks may share the same enum."}]},"errorMessage":{"type":"string","description":"The full text of the error message, including any parameters that were thrown along with the exception."}},"description":"An error, warning, or information message associated with a workflow."},"EnterpriseCrmFrontendsEventbusProtoProtoParameterArray":{"title":"EnterpriseCrmFrontendsEventbusProtoProtoParameterArray","type":"object","properties":{"protoValues":{"type":"array","items":{},"description":""}}},"EnterpriseCrmEventbusProtoParameterMapEntry":{"title":"EnterpriseCrmEventbusProtoParameterMapEntry","type":"object","properties":{"key":{"allOf":[{"$ref":"#/components/schemas/EnterpriseCrmEventbusProtoParameterMapField"},{"description":"Field represents either the key or value in an entry."}]},"value":{"allOf":[{"$ref":"#/components/schemas/EnterpriseCrmEventbusProtoParameterMapField"},{"description":"Field represents either the key or value in an entry."}]}},"description":"Entry is a pair of key and value."},"GoogleCloudIntegrationsV1alphaExecutionSnapshotExecutionSnapshotMetadata":{"title":"GoogleCloudIntegrationsV1alphaExecutionSnapshotExecutionSnapshotMetadata","type":"object","properties":{"taskAttempt":{"type":"integer","description":"the task attempt number this snapshot belongs to.","contentEncoding":"int32"},"task":{"type":"string","description":"the task name associated with this snapshot."},"executionAttempt":{"type":"integer","description":"the execution attempt number this snapshot belongs to.","contentEncoding":"int32"},"taskNumber":{"type":"string","description":"The task number associated with this snapshot."}},"description":"Metadata of the execution snapshot."},"EnterpriseCrmFrontendsEventbusProtoWorkflowParameters":{"title":"EnterpriseCrmFrontendsEventbusProtoWorkflowParameters","type":"object","properties":{"parameters":{"type":"array","items":{"$ref":"#/components/schemas/EnterpriseCrmFrontendsEventbusProtoWorkflowParameterEntry"},"description":"Parameters are a part of Event and can be used to communiticate between different tasks that are part of the same workflow execution."}},"description":"LINT.IfChange This is the frontend version of WorkflowParameters. It's exactly like the backend version except that instead of flattening protobuf parameters and treating every field and subfield of a protobuf parameter as a separate parameter, the fields/subfields of a protobuf parameter will be nested as \"children\" (see 'children' field below) parameters of the parent parameter. Please refer to enterprise/crm/eventbus/proto/workflow_parameters.proto for more information about WorkflowParameters."},"GoogleCloudIntegrationsV1alphaIntegrationAlertConfig":{"title":"GoogleCloudIntegrationsV1alphaIntegrationAlertConfig","type":"object","properties":{"displayName":{"type":"string","description":"Name of the alert. This will be displayed in the alert subject. If set, this name should be unique within the scope of the integration."},"thresholdType":{"allOf":[{"$ref":"#/components/schemas/ThresholdType2"},{"description":"The threshold type, whether lower(expected_min) or upper(expected_max), for which this alert is being configured. If value falls below expected_min or exceeds expected_max, an alert will be fired."}]},"metricType":{"allOf":[{"$ref":"#/components/schemas/MetricType2"},{"description":"The type of metric."}]},"aggregationPeriod":{"type":"string","description":"The period over which the metric value should be aggregated and evaluated. Format is , where integer should be a positive integer and unit should be one of (s,m,h,d,w) meaning (second, minute, hour, day, week). For an EXPECTED_MIN threshold, this aggregation_period must be lesser than 24 hours."},"onlyFinalAttempt":{"type":"boolean","description":"For either events or tasks, depending on the type of alert, count only final attempts, not retries."},"durationThreshold":{"type":"string","description":"Should be specified only for *AVERAGE_DURATION and *PERCENTILE_DURATION metrics. This member should be used to specify what duration value the metrics should exceed for the alert to trigger."},"disableAlert":{"type":"boolean","description":"Set to false by default. When set to true, the metrics are not aggregated or pushed to Monarch for this integration alert."},"thresholdValue":{"allOf":[{"$ref":"#/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationAlertConfigThresholdValue"},{"description":"The threshold value of the metric, above or below which the alert should be triggered. See EventAlertConfig or TaskAlertConfig for the different alert metric types in each case. For the *RATE metrics, one or both of these fields may be set. Zero is the default value and can be left at that. For *PERCENTILE_DURATION metrics, one or both of these fields may be set, and also, the duration threshold value should be specified in the threshold_duration_ms member below. For *AVERAGE_DURATION metrics, these fields should not be set at all. A different member, threshold_duration_ms, must be set in the EventAlertConfig or the TaskAlertConfig."}]},"alertThreshold":{"type":"integer","description":"For how many contiguous aggregation periods should the expected min or max be violated for the alert to be fired.","contentEncoding":"int32"}},"description":"Message to be used to configure custom alerting in the {@code EventConfig} protos for an event."},"EnterpriseCrmEventbusProtoAttributes":{"title":"EnterpriseCrmEventbusProtoAttributes","type":"object","properties":{"logSettings":{"allOf":[{"$ref":"#/components/schemas/EnterpriseCrmEventbusProtoLogSettings"},{"description":"The LogSettings define the logging attributes for an event property. These attributes are used to map the property to the parameter in the log proto. Also used to define scrubbing/truncation behavior and PII information. See go/integration-platform/analytics/logging_task.md for details."}]},"isSearchable":{"type":"boolean","description":"Used to indicate if a ParameterEntry should be converted to ParamIndexes for ST-Spanner full-text search. DEPRECATED: use searchable."},"taskVisibility":{"type":"array","items":{"type":"string"},"description":"List of tasks that can view this property, if empty then all."},"isRequired":{"type":"boolean","description":"Required for event execution. The validation will be done by the event bus when the event is triggered."},"dataType":{"allOf":[{"$ref":"#/components/schemas/DataType2"},{"description":"Things like URL, Email, Currency, Timestamp (rather than string, int64...)"}]},"searchable":{"$ref":"#/components/schemas/Searchable"},"defaultValue":{"allOf":[{"$ref":"#/components/schemas/EnterpriseCrmEventbusProtoValueType"},{"description":"Used for define type for values. Currently supported value types include int, string, double, array, and any proto message."}]}},"description":"Attributes are additional options that can be associated with each event property. For more information, see go/integration-platform/event_bus/attributes_registry.md. Next available: 8"},"EnterpriseCrmEventbusProtoDoubleFunction":{"title":"EnterpriseCrmEventbusProtoDoubleFunction","type":"object","properties":{"functionName":{"$ref":"#/components/schemas/FunctionName10"}}},"EnterpriseCrmEventbusProtoCombinedCondition":{"title":"EnterpriseCrmEventbusProtoCombinedCondition","type":"object","properties":{"conditions":{"type":"array","items":{},"description":"A set of individual constituent conditions."}},"description":"This message recursively combines constituent conditions using logical AND."},"EnterpriseCrmEventbusStatsDimensions":{"title":"EnterpriseCrmEventbusStatsDimensions","type":"object","properties":{"taskNumber":{"type":"string"},"workflowId":{"type":"string"},"clientId":{"type":"string"},"warningEnumString":{"type":"string"},"workflowName":{"type":"string"},"enumFilterType":{"allOf":[{"$ref":"#/components/schemas/EnumFilterType"},{"description":"Whether to include or exclude the enums matching the regex."}]},"retryAttempt":{"$ref":"#/components/schemas/RetryAttempt"},"triggerId":{"type":"string","description":"Stats have been or will be aggregated on set fields for any semantically-meaningful combination."},"errorEnumString":{"type":"string"},"taskName":{"type":"string"}}},"EnterpriseCrmEventbusProtoTaskMetadata":{"title":"EnterpriseCrmEventbusProtoTaskMetadata","type":"object","properties":{"status":{"allOf":[{"$ref":"#/components/schemas/Status1"},{"description":"Allows author to indicate if the task is ready to use or not. If not set, then it will default to INACTIVE."}]},"docMarkdown":{"type":"string","description":"Snippet of markdown documentation to embed in the RHP for this task."},"externalDocMarkdown":{"type":"string","description":"DEPRECATED: Use external_doc_html."},"category":{"$ref":"#/components/schemas/Category"},"name":{"type":"string","description":"The actual class name or the annotated name of the task. Task Author should initialize this field with value from the getName() method of the Task class."},"tags":{"type":"array","items":{"type":"string"},"description":"A set of tags that pertain to a particular task. This can be used to improve the searchability of tasks with several names (\"REST Caller\" vs. \"Call REST Endpoint\") or to help users find tasks based on related words."},"iconLink":{"type":"string","description":"URL to gstatic image icon for this task. This icon shows up on the task list panel along with the task name in the Workflow Editor screen. Use the 24p, 2x, gray color icon image format. See go/icons."},"defaultJsonValidationOption":{"allOf":[{"$ref":"#/components/schemas/DefaultJsonValidationOption"},{"description":"Controls whether JSON workflow parameters are validated against provided schemas before and/or after this task's execution."}]},"isDeprecated":{"type":"boolean","description":"The deprecation status of the current task. Default value is false;"},"externalDocLink":{"type":"string","description":"Doc link for external-facing documentation (separate from g3doc)."},"standaloneExternalDocHtml":{"type":"string","description":"External-facing documention for standalone IP in pantheon embedded in the RHP for this task. Non null only if different from external_doc_html"},"system":{"$ref":"#/components/schemas/System"},"codeSearchLink":{"type":"string","description":"The Code Search link to the Task Java file."},"externalCategory":{"$ref":"#/components/schemas/ExternalCategory"},"descriptiveName":{"type":"string","description":"The string name to show on the task list on the Workflow editor screen. This should be a very short, one to two words name for the task. (e.g. \"Send Mail\")"},"description":{"type":"string","description":"In a few sentences, describe the purpose and usage of the task."},"g3DocLink":{"type":"string","description":"URL to the associated G3 Doc for the task if available"},"activeTaskName":{"type":"string","description":"The new task name to replace the current task if it is deprecated. Otherwise, it is the same as the current task name."},"defaultSpec":{"type":"string","description":"Contains the initial configuration of the task with default values set. For now, The string should be compatible to an ASCII-proto format."},"externalDocHtml":{"type":"string","description":"External-facing documention embedded in the RHP for this task."},"externalCategorySequence":{"type":"integer","description":"Sequence with which the task in specific category to be displayed in task discovery panel for external users.","contentEncoding":"int32"},"admins":{"type":"array","items":{"$ref":"#/components/schemas/EnterpriseCrmEventbusProtoTaskMetadataAdmin"},"description":""}},"description":"TaskMetadata are attributes that are associated to every common Task we have. Next available: 26"},"EnterpriseCrmEventbusProtoSuspensionConfig":{"title":"EnterpriseCrmEventbusProtoSuspensionConfig","type":"object","properties":{"suspensionExpiration":{"description":"Indicates the next steps when no external actions happen on the suspension."},"customMessage":{"type":"string","description":"Optional information to provide recipients of the suspension in addition to the resolution URL, typically containing relevant parameter values from the originating workflow."},"notifications":{"type":"array","items":{},"description":""},"whoMayResolve":{"type":"array","items":{},"description":"Identities able to resolve this suspension."}}},"EnterpriseCrmEventbusProtoTeardownTaskConfig":{"title":"EnterpriseCrmEventbusProtoTeardownTaskConfig","type":"object","properties":{"creatorEmail":{"type":"string","description":"The creator's email address."},"name":{"type":"string","description":"Required. Unique identifier of the teardown task within this Config. We use this field as the identifier to find next teardown tasks."},"properties":{},"parameters":{"description":"The parameters the user can pass to this task."},"nextTeardownTask":{},"teardownTaskImplementationClassName":{"type":"string","description":"Required. Implementation class name."}}},"GoogleCloudIntegrationsV1alphaGenerateTokenResponse":{"title":"GoogleCloudIntegrationsV1alphaGenerateTokenResponse","type":"object","properties":{"message":{"type":"string","description":"The message that notifies the user if the request succeeded or not."}},"description":"Returns success or error message"},"GoogleCloudIntegrationsV1alphaLinkAppsScriptProjectRequest":{"title":"GoogleCloudIntegrationsV1alphaLinkAppsScriptProjectRequest","type":"object","properties":{"scriptId":{"type":"string","description":"The id of the Apps Script project to be linked."}},"description":"Request for LinkAppsScriptProject rpc call."},"GoogleCloudConnectorsV1AuthConfigSshPublicKey":{"title":"GoogleCloudConnectorsV1AuthConfigSshPublicKey","type":"object","properties":{"sshClientCert":{"allOf":[{"$ref":"#/components/schemas/GoogleCloudConnectorsV1Secret"},{"description":"Secret provides a reference to entries in Secret Manager."}]},"certType":{"type":"string","description":"Format of SSH Client cert."},"sshClientCertPass":{"allOf":[{"$ref":"#/components/schemas/GoogleCloudConnectorsV1Secret"},{"description":"Secret provides a reference to entries in Secret Manager."}]},"username":{"type":"string","description":"The user account used to authenticate."}},"description":"Parameters to support Ssh public key Authentication."},"GoogleCloudIntegrationsV1alphaFailurePolicy":{"title":"GoogleCloudIntegrationsV1alphaFailurePolicy","type":"object","properties":{"maxRetries":{"type":"integer","description":"Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the number of times the task will be retried if failed.","contentEncoding":"int32"},"retryStrategy":{"allOf":[{"$ref":"#/components/schemas/RetryStrategy"},{"description":"Defines what happens to the task upon failure."}]},"intervalTime":{"type":"string","description":"Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the initial interval in seconds for backoff."}},"description":"Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied)."},"EnterpriseCrmEventbusProtoIntArrayFunction":{"title":"EnterpriseCrmEventbusProtoIntArrayFunction","type":"object","properties":{"functionName":{"$ref":"#/components/schemas/FunctionName1"}}},"EnterpriseCrmFrontendsEventbusProtoSerializedObjectParameter":{"title":"EnterpriseCrmFrontendsEventbusProtoSerializedObjectParameter","type":"object","properties":{"objectValue":{"type":"string"}}},"EnterpriseCrmEventbusProtoMappedField":{"title":"EnterpriseCrmEventbusProtoMappedField","type":"object","properties":{"inputField":{"description":"The input field being mapped from."},"outputField":{"description":"The output field being mapped to."}},"description":"Mapped field is a pair of input field and output field. Next Id: 3"},"EnterpriseCrmEventbusProtoStringArray":{"title":"EnterpriseCrmEventbusProtoStringArray","type":"object","properties":{"values":{"type":"array","items":{"type":"string"},"description":""}}},"GoogleCloudConnectorsV1Secret":{"title":"GoogleCloudConnectorsV1Secret","type":"object","properties":{"secretVersion":{"type":"string","description":"The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`."}},"description":"Secret provides a reference to entries in Secret Manager."},"GoogleCloudConnectorsV1DestinationConfig":{"title":"GoogleCloudConnectorsV1DestinationConfig","type":"object","properties":{"destinations":{"type":"array","items":{"$ref":"#/components/schemas/GoogleCloudConnectorsV1Destination"},"description":"The destinations for the key."},"key":{"type":"string","description":"The key is the destination identifier that is supported by the Connector."}},"description":"Define the Connectors target endpoint."},"GoogleCloudIntegrationsV1alphaOAuth2ResourceOwnerCredentials":{"title":"GoogleCloudIntegrationsV1alphaOAuth2ResourceOwnerCredentials","type":"object","properties":{"scope":{"type":"string","description":"A space-delimited list of requested scope permissions."},"clientSecret":{"type":"string","description":"The client's secret."},"clientId":{"type":"string","description":"The client's ID."},"accessToken":{"allOf":[{"$ref":"#/components/schemas/GoogleCloudIntegrationsV1alphaAccessToken"},{"description":"The access token represents the authorization of a specific application to access specific parts of a user’s data."}]},"tokenParams":{"allOf":[{"$ref":"#/components/schemas/GoogleCloudIntegrationsV1alphaParameterMap"},{"description":"A generic multi-map that holds key value pairs. They keys and values can be of any type, unless specified."}]},"tokenEndpoint":{"type":"string","description":"The token endpoint is used by the client to obtain an access token by presenting its authorization grant or refresh token."},"username":{"type":"string","description":"The user's username."},"password":{"type":"string","description":"The user's password."},"requestType":{"allOf":[{"$ref":"#/components/schemas/RequestType"},{"description":"Represent how to pass parameters to fetch access token"}]}},"description":"For resource owner credentials grant, the client will ask the user for their authorization credentials (ususally a username and password) and send a POST request to the authorization server. The authorization server will respond with a JSON object containing the access token."},"GoogleCloudIntegrationsV1alphaConnectionSchemaMetadata":{"title":"GoogleCloudIntegrationsV1alphaConnectionSchemaMetadata","type":"object","properties":{"actions":{"type":"array","items":{"type":"string"},"description":"List of actions."},"entities":{"type":"array","items":{"type":"string"},"description":"List of entity names."}},"description":"Metadata of runtime connection schema."},"GoogleCloudConnectorsV1LockConfig":{"title":"GoogleCloudConnectorsV1LockConfig","type":"object","properties":{"reason":{"type":"string","description":"Describes why a connection is locked."},"locked":{"type":"boolean","description":"Indicates whether or not the connection is locked."}},"description":"Determines whether or no a connection is locked. If locked, a reason must be specified."},"GoogleCloudIntegrationsV1alphaCloudLoggingConfig":{"title":"GoogleCloudIntegrationsV1alphaCloudLoggingConfig","type":"object","properties":{"enableCloudLogging":{"type":"boolean","description":"This field determines whether the logs should be sent to cloud logging api"},"bucket":{"type":"string","description":"Cloud bucket name for the project."}},"description":"Config info for Cloud Logging"},"EnterpriseCrmEventbusProtoCustomSuspensionRequest":{"title":"EnterpriseCrmEventbusProtoCustomSuspensionRequest","type":"object","properties":{"postToQueueWithTriggerIdRequest":{"allOf":[{"$ref":"#/components/schemas/GoogleInternalCloudCrmEventbusV3PostToQueueWithTriggerIdRequest"},{"description":"Use this request to post all workflows associated with a given trigger id. Next available id: 10"}]},"suspensionInfoEventParameterKey":{"type":"string","description":"In the fired event, set the SuspensionInfo message as the value for this key."}}},"GoogleCloudIntegrationsV1alphaIntegrationParameter":{"title":"GoogleCloudIntegrationsV1alphaIntegrationParameter","type":"object","properties":{"key":{"type":"string","description":"Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition."},"inputOutputType":{"allOf":[{"$ref":"#/components/schemas/InputOutputType"},{"description":"Specifies the input/output type for the parameter."}]},"searchable":{"type":"boolean","description":"Searchable in the execution log or not."},"jsonSchema":{"type":"string","description":"This schema will be used to validate runtime JSON-typed values of this parameter."},"producer":{"type":"string","description":"The identifier of the node (TaskConfig/TriggerConfig) this parameter was produced by, if it is a transient param or a copy of an input param."},"defaultValue":{"allOf":[{"$ref":"#/components/schemas/GoogleCloudIntegrationsV1alphaValueType"},{"description":"The type of the parameter."}]},"displayName":{"type":"string","description":"The name (without prefix) to be displayed in the UI for this parameter. E.g. if the key is \"foo.bar.myName\", then the name would be \"myName\"."},"isTransient":{"type":"boolean","description":"Whether this parameter is a transient parameter."},"dataType":{"allOf":[{"$ref":"#/components/schemas/DataType3"},{"description":"Type of the parameter."}]}},"description":"Integration Parameter is defined in the integration config and are used to provide information about data types of the expected parameters and provide any default values if needed. They can also be used to add custom attributes. These are static in nature and should not be used for dynamic event definition."},"GoogleCloudConnectorsV1ConfigVariable":{"title":"GoogleCloudConnectorsV1ConfigVariable","type":"object","properties":{"boolValue":{"type":"boolean","description":"Value is a bool."},"intValue":{"type":"string","description":"Value is an integer"},"secretValue":{"allOf":[{"$ref":"#/components/schemas/GoogleCloudConnectorsV1Secret"},{"description":"Secret provides a reference to entries in Secret Manager."}]},"stringValue":{"type":"string","description":"Value is a string."},"key":{"type":"string","description":"Key of the config variable."}},"description":"ConfigVariable represents a configuration variable present in a Connection. or AuthConfig."},"GoogleCloudIntegrationsV1alphaCertificate":{"title":"GoogleCloudIntegrationsV1alphaCertificate","type":"object","properties":{"credentialId":{"type":"string","description":"Immutable. Credential id that will be used to register with trawler INTERNAL_ONLY"},"certificateStatus":{"allOf":[{"$ref":"#/components/schemas/CertificateStatus"},{"description":"Status of the certificate"}]},"displayName":{"type":"string","description":"Name of the certificate"},"validEndTime":{"type":"string","description":"Output only. The timestamp after which certificate will expire"},"validStartTime":{"type":"string","description":"Output only. The timestamp after which certificate will be valid"},"description":{"type":"string","description":"Description of the certificate"},"rawCertificate":{"allOf":[{"$ref":"#/components/schemas/GoogleCloudIntegrationsV1alphaClientCertificate"},{"description":"Contains client certificate information"}]},"name":{"type":"string","description":"Output only. Auto generated primary key"},"requestorId":{"type":"string","description":"Immutable. Requestor ID to be used to register certificate with trawler"}},"description":"The certificate definition"},"GoogleCloudIntegrationsV1alphaUsernameAndPassword":{"title":"GoogleCloudIntegrationsV1alphaUsernameAndPassword","type":"object","properties":{"username":{"type":"string","description":"Username to be used"},"password":{"type":"string","description":"Password to be used"}},"description":"Username and password pair."},"GoogleCloudIntegrationsV1alphaEventParameter":{"title":"GoogleCloudIntegrationsV1alphaEventParameter","type":"object","properties":{"value":{"allOf":[{"$ref":"#/components/schemas/GoogleCloudIntegrationsV1alphaValueType"},{"description":"The type of the parameter."}]},"key":{"type":"string","description":"Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition."}},"description":"This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus."},"GoogleCloudIntegrationsV1alphaLinkAppsScriptProjectResponse":{"title":"GoogleCloudIntegrationsV1alphaLinkAppsScriptProjectResponse","type":"object","properties":{"scriptId":{"type":"string","description":"The id of the linked Apps Script project."}},"description":"Response for LinkAppsScriptProject rpc call."},"EnterpriseCrmEventbusProtoWorkflowAlertConfig":{"title":"EnterpriseCrmEventbusProtoWorkflowAlertConfig","type":"object","properties":{"playbookUrl":{"type":"string","description":"Link to a playbook for resolving the issue that triggered this alert."},"alertDisabled":{"type":"boolean","description":"Set to false by default. When set to true, the metrics are not aggregated or pushed to Monarch for this workflow alert."},"thresholdType":{"allOf":[{"$ref":"#/components/schemas/ThresholdType1"},{"description":"The threshold type, whether lower(expected_min) or upper(expected_max), for which this alert is being configured. If value falls below expected_min or exceeds expected_max, an alert will be fired."}]},"aggregationPeriod":{"type":"string","description":"For an EXPECTED_MIN threshold, this aggregation_period must be lesser than 24 hours."},"thresholdValue":{"description":"The metric value, above or below which the alert should be triggered. See go/eventbus-alert-config-examples."},"errorEnumList":{},"durationThresholdMs":{"type":"string","description":"Should be specified only for *AVERAGE_DURATION and *PERCENTILE_DURATION metrics. This member should be used to specify what duration value the metrics should exceed for the alert to trigger."},"clientId":{"type":"string","description":"Client associated with this alert configuration."},"warningEnumList":{},"numAggregationPeriods":{"type":"integer","description":"For how many contiguous aggregation periods should the expected min or max be violated for the alert to be fired.","contentEncoding":"int32"},"metricType":{"$ref":"#/components/schemas/MetricType1"},"alertName":{"type":"string","description":"A name to identify this alert. This will be displayed in the alert subject. If set, this name should be unique within the scope of the workflow."},"onlyFinalAttempt":{"type":"boolean","description":"For either events or tasks, depending on the type of alert, count only final attempts, not retries."}},"description":"Message to be used to configure custom alerting in the {@code EventConfig} protos for an event. See go/eventbus-alert-config-examples for examples of the different alerts that can be configured."},"EnterpriseCrmEventbusProtoField":{"title":"EnterpriseCrmEventbusProtoField","type":"object","properties":{"protoDefPath":{"type":"string","description":"Optional. The fully qualified proto name (e.g. enterprise.crm.storage.Account). Required for output field of type PROTO_VALUE or PROTO_ARRAY. For e.g., if input field_type is BYTES and output field_type is PROTO_VALUE, then fully qualified proto type url should be provided to parse the input bytes. If field_type is *_ARRAY, then all the converted protos are of the same type."},"transformExpression":{"$ref":"#/components/schemas/EnterpriseCrmEventbusProtoTransformExpression"},"referenceKey":{"type":"string","description":"This holds the reference key of the workflow or task parameter. 1. Any workflow parameter, for e.g. $workflowParam1$. 2. Any task input or output parameter, for e.g. $task1_param1$. 3. Any workflow or task parameters with subfield references, for e.g., $task1_param1.employee.id$"},"fieldType":{"allOf":[{"$ref":"#/components/schemas/FieldType"},{"description":"Specifies the data type of the field."}]},"cardinality":{"allOf":[{"$ref":"#/components/schemas/Cardinality"},{"description":"By default, if the cardinality is unspecified the field is considered required while mapping."}]},"defaultValue":{"allOf":[{"$ref":"#/components/schemas/EnterpriseCrmEventbusProtoParameterValueType"},{"description":"LINT.IfChange To support various types of parameter values. Next available id: 14"}]}},"description":"Information about the value and type of the field. Next Id: 8"},"EnterpriseCrmEventbusProtoAddress":{"title":"EnterpriseCrmEventbusProtoAddress","type":"object","properties":{"email":{"type":"string","description":"Required."},"name":{"type":"string"},"tokens":{"type":"array","items":{"$ref":"#/components/schemas/EnterpriseCrmEventbusProtoToken"},"description":""}},"description":"Email address along with optional name and tokens. These tokens will be substituted for the variables in the form of [{var_name}], where var_name could be any string of no more than 32 bytes."},"EnterpriseCrmEventbusStats":{"title":"EnterpriseCrmEventbusStats","type":"object","properties":{"qps":{"type":"number","description":"Queries per second."},"errorRate":{"type":"number","description":"Average error rate."},"durationInSeconds":{"type":"number","description":"Average duration in seconds."},"dimensions":{"$ref":"#/components/schemas/EnterpriseCrmEventbusStatsDimensions"},"warningRate":{"type":"number","description":"Average warning rate."}},"description":"Stats for the requested dimensions: QPS, duration, and error/warning rate"},"GoogleCloudIntegrationsV1alphaTaskConfig":{"title":"GoogleCloudIntegrationsV1alphaTaskConfig","type":"object","properties":{"description":{"type":"string","description":"Optional. User-provided description intended to give additional business context about the task."},"taskExecutionStrategy":{"allOf":[{"$ref":"#/components/schemas/TaskExecutionStrategy"},{"description":"Optional. The policy dictating the execution strategy of this task."}]},"task":{"type":"string","description":"Optional. The name for the task."},"failurePolicy":{"allOf":[{"$ref":"#/components/schemas/GoogleCloudIntegrationsV1alphaFailurePolicy"},{"description":"Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied)."}]},"synchronousCallFailurePolicy":{"allOf":[{"$ref":"#/components/schemas/GoogleCloudIntegrationsV1alphaFailurePolicy"},{"description":"Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied)."}]},"taskTemplate":{"type":"string","description":"Optional. Used to define task-template name if task is of type task-template"},"successPolicy":{"allOf":[{"$ref":"#/components/schemas/GoogleCloudIntegrationsV1alphaSuccessPolicy"},{"description":"Policy that dictates the behavior for the task after it completes successfully."}]},"taskId":{"type":"string","description":"Required. The identifier of this task within its parent event config, specified by the client. This should be unique among all the tasks belong to the same event config. We use this field as the identifier to find next tasks (via field `next_tasks.task_id`)."},"nextTasksExecutionPolicy":{"allOf":[{"$ref":"#/components/schemas/NextTasksExecutionPolicy1"},{"description":"Optional. The policy dictating the execution of the next set of tasks for the current task."}]},"nextTasks":{"type":"array","items":{"$ref":"#/components/schemas/GoogleCloudIntegrationsV1alphaNextTask"},"description":"Optional. The set of tasks that are next in line to be executed as per the execution graph defined for the parent event, specified by `event_config_id`. Each of these next tasks are executed only if the condition associated with them evaluates to true."},"parameters":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/GoogleCloudIntegrationsV1alphaEventParameter"},"description":"Optional. The customized parameters the user can pass to this task."},"jsonValidationOption":{"allOf":[{"$ref":"#/components/schemas/JsonValidationOption"},{"description":"Optional. If set, overrides the option configured in the Task implementation class."}]},"displayName":{"type":"string","description":"Optional. User-provided label that is attached to this TaskConfig in the UI."}},"description":"The task configuration details. This is not the implementation of Task. There might be multiple TaskConfigs for the same Task."},"EnterpriseCrmEventbusProtoParameterEntry":{"title":"EnterpriseCrmEventbusProtoParameterEntry","type":"object","properties":{"key":{"type":"string","description":"Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition."},"value":{"allOf":[{"$ref":"#/components/schemas/EnterpriseCrmEventbusProtoParameterValueType"},{"description":"LINT.IfChange To support various types of parameter values. Next available id: 14"}]}},"description":"Key-value pair of EventBus parameters."},"EnterpriseCrmEventbusProtoParamSpecEntryProtoDefinition":{"title":"EnterpriseCrmEventbusProtoParamSpecEntryProtoDefinition","type":"object","properties":{"fullName":{"type":"string","description":"The fully-qualified proto name. This message, for example, would be \"enterprise.crm.eventbus.proto.ParamSpecEntry.ProtoDefinition\"."},"path":{"type":"string","description":"Path to the proto file that contains the message type's definition."}}},"GoogleCloudIntegrationsV1alphaIntegration":{"title":"GoogleCloudIntegrationsV1alphaIntegration","type":"object","properties":{"name":{"type":"string","description":"Required. The resource name of the integration."},"updateTime":{"type":"string","description":"Output only. Auto-generated."},"active":{"type":"boolean","description":"Required. If any integration version is published."},"description":{"type":"string","description":"Optional."}},"description":"The integration definition."},"GoogleCloudIntegrationsV1alphaOAuth2ClientCredentials":{"title":"GoogleCloudIntegrationsV1alphaOAuth2ClientCredentials","type":"object","properties":{"clientId":{"type":"string","description":"The client's ID."},"clientSecret":{"type":"string","description":"The client's secret."},"tokenParams":{"allOf":[{"$ref":"#/components/schemas/GoogleCloudIntegrationsV1alphaParameterMap"},{"description":"A generic multi-map that holds key value pairs. They keys and values can be of any type, unless specified."}]},"accessToken":{"allOf":[{"$ref":"#/components/schemas/GoogleCloudIntegrationsV1alphaAccessToken"},{"description":"The access token represents the authorization of a specific application to access specific parts of a user’s data."}]},"tokenEndpoint":{"type":"string","description":"The token endpoint is used by the client to obtain an access token by presenting its authorization grant or refresh token."},"requestType":{"allOf":[{"$ref":"#/components/schemas/RequestType"},{"description":"Represent how to pass parameters to fetch access token"}]},"scope":{"type":"string","description":"A space-delimited list of requested scope permissions."}},"description":"For client credentials grant, the client sends a POST request with grant_type as 'client_credentials' to the authorization server. The authorization server will respond with a JSON object containing the access token."},"EnterpriseCrmEventbusProtoCloudSchedulerConfig":{"title":"EnterpriseCrmEventbusProtoCloudSchedulerConfig","type":"object","properties":{"serviceAccountEmail":{"type":"string","description":"Required. Service account used by Cloud Scheduler to trigger the integration at scheduled time"},"cronTab":{"type":"string","description":"Required. The cron tab of cloud scheduler trigger."},"errorMessage":{"type":"string","description":"Optional. When the job was deleted from Pantheon UI, error_message will be populated when Get/List integrations"},"location":{"type":"string","description":"Required. The location where associated cloud scheduler job will be created"}},"description":"Cloud Scheduler Trigger configuration"},"GoogleCloudIntegrationsV1alphaLiftSuspensionRequest":{"title":"GoogleCloudIntegrationsV1alphaLiftSuspensionRequest","type":"object","properties":{"suspensionResult":{"type":"string","description":"User passed in suspension result and will be used to control workflow execution branching behavior by setting up corresponnding edge condition with suspension result. For example, if you want to lift the suspension, you can pass \"Approved\", or if you want to reject the suspension and terminate workfloe execution, you can pass \"Rejected\" and terminate the workflow execution with configuring the edge condition."}},"description":"Request for lift Suspension"},"GoogleCloudIntegrationsV1alphaCancelExecutionResponse":{"title":"GoogleCloudIntegrationsV1alphaCancelExecutionResponse","type":"object","properties":{"isCanceled":{"type":"boolean","description":"True if cancellation performed successfully"}},"description":"Response for cancelling an execution."},"EnterpriseCrmFrontendsEventbusProtoEventExecutionDetails":{"title":"EnterpriseCrmFrontendsEventbusProtoEventExecutionDetails","type":"object","properties":{"eventRetriesFromBeginningCount":{"type":"integer","description":"Indicates the number of times the execution has restarted from the beginning.","contentEncoding":"int32"},"eventExecutionSnapshot":{"type":"array","items":{"$ref":"#/components/schemas/EnterpriseCrmFrontendsEventbusProtoEventExecutionSnapshot"},"description":"After snapshot migration, this field will no longer be populated, but old execution snapshots will still be accessible."},"logFilePath":{"type":"string","description":"The log file path (aka. cns address) for this event."},"nextExecutionTime":{"type":"string","description":"Next scheduled execution time in case the execution status was RETRY_ON_HOLD."},"eventAttemptStats":{"type":"array","items":{"$ref":"#/components/schemas/EnterpriseCrmEventbusProtoEventExecutionDetailsEventAttemptStats"},"description":""},"ryeLockUnheldCount":{"type":"integer","description":"Used internally and shouldn't be exposed to users. A counter for the cron job to record how many times this event is in in_process state but don't have a lock consecutively/","contentEncoding":"int32"},"networkAddress":{"type":"string","description":"The network address (aka. bns address) that indicates where the event executor is running."},"eventExecutionState":{"allOf":[{"$ref":"#/components/schemas/EventExecutionState1"},{"description":"The execution state of this event."}]}},"description":"Contains the details of the execution info of this event: this includes the tasks execution details plus the event execution statistics. Next available id: 10"},"GoogleCloudIntegrationsV1alphaTaskExecutionDetails":{"title":"GoogleCloudIntegrationsV1alphaTaskExecutionDetails","type":"object","properties":{"taskAttemptStats":{"type":"array","items":{"$ref":"#/components/schemas/GoogleCloudIntegrationsV1alphaAttemptStats"},"description":"Status for the current task execution attempt."},"taskNumber":{"type":"string","description":"Pointer to the task config it used for execution."},"taskExecutionState":{"allOf":[{"$ref":"#/components/schemas/TaskExecutionState1"},{"description":"The execution state of this task."}]}},"description":"Contains the details of the execution of this task."},"GoogleCloudIntegrationsV1alphaTriggerConfig":{"title":"GoogleCloudIntegrationsV1alphaTriggerConfig","type":"object","properties":{"alertConfig":{"type":"array","items":{"$ref":"#/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationAlertConfig"},"description":"Optional. An alert threshold configuration for the [trigger + client + integration] tuple. If these values are not specified in the trigger config, default values will be populated by the system. Note that there must be exactly one alert threshold configured per [client + trigger + integration] when published."},"startTasks":{"type":"array","items":{"$ref":"#/components/schemas/GoogleCloudIntegrationsV1alphaNextTask"},"description":"Optional. Set of tasks numbers from where the integration execution is started by this trigger. If this is empty, then integration is executed with default start tasks. In the list of start tasks, none of two tasks can have direct ancestor-descendant relationships (i.e. in a same integration execution graph)."},"label":{"type":"string","description":"Optional. The user created label for a particular trigger."},"nextTasksExecutionPolicy":{"allOf":[{"$ref":"#/components/schemas/NextTasksExecutionPolicy2"},{"description":"Optional. Dictates how next tasks will be executed."}]},"cloudSchedulerConfig":{"allOf":[{"$ref":"#/components/schemas/GoogleCloudIntegrationsV1alphaCloudSchedulerConfig"},{"description":"Cloud Scheduler Trigger configuration"}]},"properties":{"type":"object","additionalProperties":{"type":"string"},"description":"Optional. Configurable properties of the trigger, not to be confused with integration parameters. E.g. \"name\" is a property for API triggers and \"subscription\" is a property for Pub/sub triggers."},"triggerType":{"allOf":[{"$ref":"#/components/schemas/TriggerType1"},{"description":"Optional. Type of trigger"}]},"triggerNumber":{"type":"string","description":"Required. A number to uniquely identify each trigger config within the integration on UI."},"description":{"type":"string","description":"Optional. User-provided description intended to give additional business context about the task."},"triggerId":{"type":"string","description":"Optional. The backend trigger ID."}},"description":"Configuration detail of a trigger."},"EnterpriseCrmEventbusProtoScatterResponse":{"title":"EnterpriseCrmEventbusProtoScatterResponse","type":"object","properties":{"errorMsg":{"type":"string","description":"The error message of the failure if applicable."},"responseParams":{"type":"array","items":{"$ref":"#/components/schemas/EnterpriseCrmEventbusProtoParameterEntry"},"description":"A list of all the response parameters in the aggregtorMap stored with the remapped key."},"isSuccessful":{"type":"boolean","description":"If execution is sync, this is true if the execution passed and false if it failed. If the execution is async, this is true if the WF was fired off successfully, and false if it failed to execute. The success or failure of the subworkflows executed are not captured."},"scatterElement":{"allOf":[{"$ref":"#/components/schemas/EnterpriseCrmEventbusProtoParameterValueType"},{"description":"LINT.IfChange To support various types of parameter values. Next available id: 14"}]},"executionIds":{"type":"array","items":{"type":"string"},"description":"The execution ids of each Subworkflow fired by this scatter."}}},"EnterpriseCrmEventbusProtoLoopMetadata":{"title":"EnterpriseCrmEventbusProtoLoopMetadata","type":"object","properties":{"errorMsg":{"type":"string","description":"Add the error message when loops fail."},"currentIterationCount":{"type":"string","description":"Starting from 1, not 0."},"currentIterationDetail":{"type":"string","description":"Needs to be set by the loop impl class before each iteration. The abstract loop class will append the request and response to it. Eg. The foreach Loop will clean up and set it as the current iteration element at the start of each loop. The post request and response will be appended to the value once they are available."},"failureLocation":{"allOf":[{"$ref":"#/components/schemas/FailureLocation"},{"description":"Indicates where in the loop logic did it error out."}]}}},"EnterpriseCrmEventbusProtoBooleanArrayFunction":{"title":"EnterpriseCrmEventbusProtoBooleanArrayFunction","type":"object","properties":{"functionName":{"$ref":"#/components/schemas/FunctionName3"}}},"EnterpriseCrmEventbusProtoNodeIdentifier":{"title":"EnterpriseCrmEventbusProtoNodeIdentifier","type":"object","properties":{"elementIdentifier":{"type":"string","description":"Configuration of the edge."},"elementType":{"allOf":[{"$ref":"#/components/schemas/ElementType"},{"description":"Destination node where the edge ends. It can only be a task config."}]}},"description":"Represents a node identifier (type + id). Next highest id: 3"},"GoogleCloudIntegrationsV1alphaAuthConfig":{"title":"GoogleCloudIntegrationsV1alphaAuthConfig","type":"object","properties":{"overrideValidTime":{"type":"string","description":"User provided expiry time to override. For the example of Salesforce, username/password credentials can be valid for 6 months depending on the instance settings."},"validTime":{"type":"string","description":"The time until the auth config is valid. Empty or max value is considered the auth config won't expire."},"lastModifierEmail":{"type":"string","description":"The last modifier's email address. Generated based on the End User Credentials/LOAS role of the user making the call."},"reason":{"type":"string","description":"The reason / details of the current status."},"credentialType":{"allOf":[{"$ref":"#/components/schemas/CredentialType"},{"description":"Credential type of the encrypted credential."}]},"expiryNotificationDuration":{"type":"array","items":{"type":"string"},"description":"User can define the time to receive notification after which the auth config becomes invalid. Support up to 30 days. Support granularity in hours."},"name":{"type":"string","description":"Resource name of the SFDC instance projects/{project}/locations/{location}/authConfigs/{authConfig}."},"description":{"type":"string","description":"A description of the auth config."},"decryptedCredential":{"allOf":[{"$ref":"#/components/schemas/GoogleCloudIntegrationsV1alphaCredential"},{"description":"Defines parameters for a single, canonical credential."}]},"creatorEmail":{"type":"string","description":"The creator's email address. Generated based on the End User Credentials/LOAS role of the user making the call."},"state":{"allOf":[{"$ref":"#/components/schemas/State3"},{"description":"The status of the auth config."}]},"encryptedCredential":{"type":"string","description":"Auth credential encrypted by Cloud KMS. Can be decrypted as Credential with proper KMS key."},"certificateId":{"type":"string","description":"Certificate id for client certificate"},"visibility":{"allOf":[{"$ref":"#/components/schemas/Visibility"},{"description":"The visibility of the auth config."}]},"createTime":{"type":"string","description":"Output only. The timestamp when the auth config is created."},"displayName":{"type":"string","description":"The name of the auth config."},"updateTime":{"type":"string","description":"Output only. The timestamp when the auth config is modified."}},"description":"The AuthConfig resource use to hold channels and connection config data."},"EnterpriseCrmEventbusProtoSuspensionResolutionInfoAudit":{"title":"EnterpriseCrmEventbusProtoSuspensionResolutionInfoAudit","type":"object","properties":{"resolvedBy":{"type":"string"},"timestamp":{"type":"string"}}},"GoogleCloudIntegrationsV1alphaAttemptStats":{"title":"GoogleCloudIntegrationsV1alphaAttemptStats","type":"object","properties":{"endTime":{"type":"string","description":"The end time of the event execution for current attempt."},"startTime":{"type":"string","description":"The start time of the event execution for current attempt. This could be in the future if it's been scheduled."}},"description":"Status for the execution attempt."},"GoogleCloudIntegrationsV1alphaSfdcChannel":{"title":"GoogleCloudIntegrationsV1alphaSfdcChannel","type":"object","properties":{"updateTime":{"type":"string","description":"Output only. Time when the channel was last updated"},"name":{"type":"string","description":"Resource name of the SFDC channel projects/{project}/locations/{location}/sfdcInstances/{sfdc_instance}/sfdcChannels/{sfdc_channel}."},"displayName":{"type":"string","description":"Client level unique name/alias to easily reference a channel."},"deleteTime":{"type":"string","description":"Output only. Time when the channel was deleted. Empty if not deleted."},"createTime":{"type":"string","description":"Output only. Time when the channel is created"},"isActive":{"type":"boolean","description":"Indicated if a channel has any active integrations referencing it. Set to false when the channel is created, and set to true if there is any integration published with the channel configured in it."},"lastReplayId":{"type":"string","description":"Last sfdc messsage replay id for channel"},"description":{"type":"string","description":"The description for this channel"},"channelTopic":{"type":"string","description":"The Channel topic defined by salesforce once an channel is opened"}},"description":"The SfdcChannel that points to a CDC or Platform Event Channel."},"EnterpriseCrmEventbusProtoFailurePolicy":{"title":"EnterpriseCrmEventbusProtoFailurePolicy","type":"object","properties":{"intervalInSeconds":{"type":"string","description":"Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the initial interval for backoff."},"maxNumRetries":{"type":"integer","description":"Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the number of times the task will be retried if failed.","contentEncoding":"int32"},"retryStrategy":{"allOf":[{"$ref":"#/components/schemas/RetryStrategy1"},{"description":"Defines what happens to the task upon failure."}]}},"description":"Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied)."},"EnterpriseCrmCardsTemplatesAplosSeriesDataRow":{"title":"EnterpriseCrmCardsTemplatesAplosSeriesDataRow","type":"object","properties":{"x":{},"y":{}},"description":"Aplos series row is exactly two columns labeled x and y."},"EnterpriseCrmEventbusProtoEventExecutionSnapshot":{"title":"EnterpriseCrmEventbusProtoEventExecutionSnapshot","type":"object","properties":{"diffParams":{"description":"The parameters in Event object that differs from last snapshot."},"snapshotTime":{"type":"string","description":"Indicates when this snapshot is taken."},"taskName":{"type":"string","description":"The task name associated with this snapshot. Could be empty."},"eventExecutionInfoId":{"type":"string","description":"Points to the event execution info this snapshot belongs to."},"checkpointTaskNumber":{"type":"string","description":"Indicates \"right after which checkpoint task's execution\" this snapshot is taken."},"exceedMaxSize":{"type":"boolean","description":"indicate whether snapshot exceeded maximum size before clean up"},"taskExecutionDetails":{"type":"array","items":{},"description":"All of the task execution details at the given point of time."},"eventParams":{"description":"The parameters in Event object."},"conditionResults":{"type":"array","items":{},"description":"All of the computed conditions that been calculated."},"eventExecutionSnapshotMetadata":{},"eventExecutionSnapshotId":{"type":"string","description":"Auto-generated. Used as primary key for EventExecutionSnapshots table."}},"description":"Contains the snapshot of the event execution for a given checkpoint. Next available id: 13"},"GoogleCloudConnectorsV1Connection":{"title":"GoogleCloudConnectorsV1Connection","type":"object","properties":{"updateTime":{"type":"string","description":"Output only. Updated time."},"envoyImageLocation":{"type":"string","description":"Output only. GCR location where the envoy image is stored. formatted like: gcr.io/{bucketName}/{imageName}"},"configVariables":{"type":"array","items":{"$ref":"#/components/schemas/GoogleCloudConnectorsV1ConfigVariable"},"description":"Optional. Configuration for configuring the connection with an external system."},"authConfig":{"allOf":[{"$ref":"#/components/schemas/GoogleCloudConnectorsV1AuthConfig"},{"description":"AuthConfig defines details of a authentication type."}]},"serviceAccount":{"type":"string","description":"Optional. Service account needed for runtime plane to access GCP resources."},"labels":{"type":"object","additionalProperties":{"type":"string"},"description":"Optional. Resource labels to represent user-provided metadata. Refer to cloud documentation on labels for more details. https://cloud.google.com/compute/docs/labeling-resources"},"connectorVersion":{"type":"string","description":"Required. Connector version on which the connection is created. The format is: projects/*/locations/*/providers/*/connectors/*/versions/* Only global location is supported for ConnectorVersion resource."},"status":{"allOf":[{"$ref":"#/components/schemas/GoogleCloudConnectorsV1ConnectionStatus"},{"description":"ConnectionStatus indicates the state of the connection."}]},"description":{"type":"string","description":"Optional. Description of the resource."},"serviceDirectory":{"type":"string","description":"Output only. The name of the Service Directory service name. Used for Private Harpoon to resolve the ILB address. e.g. \"projects/cloud-connectors-e2e-testing/locations/us-central1/namespaces/istio-system/services/istio-ingressgateway-connectors\""},"imageLocation":{"type":"string","description":"Output only. GCR location where the runtime image is stored. formatted like: gcr.io/{bucketName}/{imageName}"},"lockConfig":{"allOf":[{"$ref":"#/components/schemas/GoogleCloudConnectorsV1LockConfig"},{"description":"Determines whether or no a connection is locked. If locked, a reason must be specified."}]},"name":{"type":"string","description":"Output only. Resource name of the Connection. Format: projects/{project}/locations/{location}/connections/{connection}"},"destinationConfigs":{"type":"array","items":{"$ref":"#/components/schemas/GoogleCloudConnectorsV1DestinationConfig"},"description":"Optional. Configuration of the Connector's destination. Only accepted for Connectors that accepts user defined destination(s)."},"createTime":{"type":"string","description":"Output only. Created time."},"suspended":{"type":"boolean","description":"Optional. Suspended indicates if a user has suspended a connection or not."},"nodeConfig":{"allOf":[{"$ref":"#/components/schemas/GoogleCloudConnectorsV1NodeConfig"},{"description":"Configuration for the connection."}]}},"description":"Connection represents an instance of connector."},"GoogleCloudIntegrationsV1alphaGetClientMetadataResponse":{"title":"GoogleCloudIntegrationsV1alphaGetClientMetadataResponse","type":"object","properties":{"properties":{"allOf":[{"$ref":"#/components/schemas/GoogleCloudIntegrationsV1alphaProjectProperties"},{"description":"Metadata information for the given project"}]}},"description":"Response for the GetClientMetadata rpc"},"GoogleCloudIntegrationsV1alphaListSuspensionsResponse":{"title":"GoogleCloudIntegrationsV1alphaListSuspensionsResponse","type":"object","properties":{"nextPageToken":{"type":"string","description":"Token to retrieve the next page of results."},"suspensions":{"type":"array","items":{"$ref":"#/components/schemas/GoogleCloudIntegrationsV1alphaSuspension"},"description":"The suspensions for the relevant execution which the caller has permissions to view and resolve."}},"description":"Response for Suspensions.ListSuspensions."},"GoogleCloudIntegrationsV1alphaExecuteIntegrationsRequest":{"title":"GoogleCloudIntegrationsV1alphaExecuteIntegrationsRequest","type":"object","properties":{"doNotPropagateError":{"type":"boolean","description":"Optional. Flag to determine how to should propagate errors. If this flag is set to be true, it will not throw an exception. Instead, it will return a {@link ExecuteIntegrationsResponse} with an execution id and error messages as PostWithTriggerIdExecutionException in {@link EventParameters}. The flag is set to be false by default."},"parameters":{"allOf":[{"$ref":"#/components/schemas/EnterpriseCrmFrontendsEventbusProtoEventParameters"},{"description":"LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4"}]},"executionId":{"type":"string","description":"Optional. The id of the ON_HOLD execution to be resumed."},"triggerId":{"type":"string","description":"Required. Matched against all {@link TriggerConfig}s across all integrations. i.e. TriggerConfig.trigger_id.equals(trigger_id). The trigger_id is in the format of `api_trigger/TRIGGER_NAME`."},"inputParameters":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/GoogleCloudIntegrationsV1alphaValueType"},"description":"Optional. Input parameters used by integration execution."},"parameterEntries":{"type":"array","items":{"$ref":"#/components/schemas/EnterpriseCrmFrontendsEventbusProtoParameterEntry"},"description":"Optional. Parameters are a part of Event and can be used to communicate between different tasks that are part of the same integration execution."},"requestId":{"type":"string","description":"Optional. This is used to de-dup incoming request: if the duplicate request was detected, the response from the previous execution is returned."}},"description":"The request for executing an integration."},"EnterpriseCrmEventbusProtoTriggerCriteria":{"title":"EnterpriseCrmEventbusProtoTriggerCriteria","type":"object","properties":{"triggerCriteriaTaskImplementationClassName":{"type":"string","description":"Optional. Implementation class name. The class should implement the “TypedTask” interface."},"parameters":{"description":"Optional. To be used in TaskConfig for the implementation class."},"condition":{"type":"string","description":"Required. Standard filter expression, when true the workflow will be executed. If there's no trigger_criteria_task_implementation_class_name specified, the condition will be validated directly."}}},"EnterpriseCrmEventbusProtoBuganizerNotification":{"title":"EnterpriseCrmEventbusProtoBuganizerNotification","type":"object","properties":{"assigneeEmailAddress":{"type":"string","description":"Whom to assign the new bug. Optional."},"title":{"type":"string","description":"Title of the issue to be created. Required."},"templateId":{"type":"string","description":"ID of the buganizer template to use. Optional."},"componentId":{"type":"string","description":"ID of the buganizer component within which to create a new issue. Required."}}},"GoogleCloudIntegrationsV1alphaCloudKmsConfig":{"title":"GoogleCloudIntegrationsV1alphaCloudKmsConfig","type":"object","properties":{"keyVersion":{"type":"string","description":"Optional. Each version of a key contains key material used for encryption or signing. A key's version is represented by an integer, starting at 1. To decrypt data or verify a signature, you must use the same key version that was used to encrypt or sign the data."},"kmsRing":{"type":"string","description":"Required. A key ring organizes keys in a specific Google Cloud location and allows you to manage access control on groups of keys. A key ring's name does not need to be unique across a Google Cloud project, but must be unique within a given location."},"key":{"type":"string","description":"Required. A Cloud KMS key is a named object containing one or more key versions, along with metadata for the key. A key exists on exactly one key ring tied to a specific location."},"kmsLocation":{"type":"string","description":"Required. Location name of the key ring, e.g. \"us-west1\"."}},"description":"Configuration information for Client's Cloud KMS information"},"EnterpriseCrmEventbusProtoSuspensionExpiration":{"title":"EnterpriseCrmEventbusProtoSuspensionExpiration","type":"object","properties":{"liftWhenExpired":{"type":"boolean","description":"Whether the suspension will be REJECTED or LIFTED upon expiration. REJECTED is the default behavior."},"expireAfterMs":{"type":"integer","description":"Milliseconds after which the suspension expires, if no action taken.","contentEncoding":"int32"},"remindAfterMs":{"type":"integer","description":"Milliseconds after which the previous suspension action reminder, if any, is sent using the selected notification option, for a suspension which is still PENDING_UNSPECIFIED.","contentEncoding":"int32"}}},"GoogleInternalCloudCrmEventbusV3PostToQueueWithTriggerIdRequest":{"title":"GoogleInternalCloudCrmEventbusV3PostToQueueWithTriggerIdRequest","type":"object","properties":{"requestId":{"type":"string","description":"Optional. This is used to de-dup incoming request: if the duplicate request was detected, the response from the previous execution is returned. Must have no more than 36 characters and contain only alphanumeric characters and hyphens."},"workflowName":{"type":"string","description":"Optional. If provided, the workflow_name is used to filter all the matched workflows having same trigger_id+client_id. A combination of trigger_id, client_id and workflow_name identifies a unique workflow."},"priority":{"allOf":[{"$ref":"#/components/schemas/Priority"},{"description":"The request priority this request should be processed at. For internal users:"}]},"parameters":{"description":"Passed in as parameters to each workflow execution. Optional."},"triggerId":{"type":"string","description":"Matched against all {@link TriggerConfig}s across all workflows. i.e. TriggerConfig.trigger_id.equals(trigger_id) Required."},"testMode":{"type":"boolean","description":"Optional. Sets test mode in {@link enterprise/crm/eventbus/event_message.proto}."},"ignoreErrorIfNoActiveWorkflow":{"type":"boolean","description":"Optional. Flag to determine whether clients would suppress a warning when no ACTIVE workflows are not found. If this flag is set to be true, an error will not be thrown if the requested trigger_id or client_id is not found in any ACTIVE workflow. Otherwise, the error is always thrown. The flag is set to be false by default."},"clientId":{"type":"string","description":"Optional. If the client id is provided, then the combination of trigger id and client id is matched across all the workflows. If the client id is not provided, then workflows with matching trigger id are executed for each client id in the {@link TriggerConfig}. For Api Trigger, the client id is required and will be validated against the allowed clients."},"scheduledTime":{"type":"string","description":"Optional. Time in milliseconds since epoch when the given event would be scheduled."}},"description":"Use this request to post all workflows associated with a given trigger id. Next available id: 10"},"GoogleCloudIntegrationsV1alphaSuccessPolicy":{"title":"GoogleCloudIntegrationsV1alphaSuccessPolicy","type":"object","properties":{"finalState":{"allOf":[{"$ref":"#/components/schemas/FinalState1"},{"description":"State to which the execution snapshot status will be set if the task succeeds."}]}},"description":"Policy that dictates the behavior for the task after it completes successfully."},"GoogleCloudIntegrationsV1alphaDownloadExecutionResponse":{"title":"GoogleCloudIntegrationsV1alphaDownloadExecutionResponse","type":"object","properties":{"content":{"type":"string","description":"The content of downloaded execution."}},"description":"Response for downloading an execution."},"EnterpriseCrmEventbusProtoConnectorsConnection":{"title":"EnterpriseCrmEventbusProtoConnectorsConnection","type":"object","properties":{"serviceName":{"type":"string","description":"Service name Format: projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}"},"connectorVersion":{"type":"string","description":"Connector version Format: projects/{project}/locations/{location}/providers/{provider}/connectors/{connector}/versions/{version}"},"connectionName":{"type":"string","description":"Connection name Format: projects/{project}/locations/{location}/connections/{connection}"}}},"GoogleCloudIntegrationsV1alphaResolveSuspensionRequest":{"title":"GoogleCloudIntegrationsV1alphaResolveSuspensionRequest","type":"object","properties":{"suspension":{"allOf":[{"$ref":"#/components/schemas/GoogleCloudIntegrationsV1alphaSuspension"},{"description":"A record representing a suspension."}]}},"description":"Request for [Suspensions.ResolveSuspensions]."},"GoogleCloudIntegrationsV1alphaJwt":{"title":"GoogleCloudIntegrationsV1alphaJwt","type":"object","properties":{"secret":{"type":"string","description":"User's pre-shared secret to sign the token."},"jwtHeader":{"type":"string","description":"Identifies which algorithm is used to generate the signature."},"jwt":{"type":"string","description":"The token calculated by the header, payload and signature."},"jwtPayload":{"type":"string","description":"Contains a set of claims. The JWT specification defines seven Registered Claim Names which are the standard fields commonly included in tokens. Custom claims are usually also included, depending on the purpose of the token."}},"description":"Represents JSON web token(JWT), which is a compact, URL-safe means of representing claims to be transferred between two parties, enabling the claims to be digitally signed or integrity protected."},"GoogleCloudIntegrationsV1alphaSuspensionAudit":{"title":"GoogleCloudIntegrationsV1alphaSuspensionAudit","type":"object","properties":{"resolveTime":{"type":"string","description":"Time at which this suspension was resolved."},"resolver":{"type":"string","description":"Email address of the person who resolved this suspension."}},"description":"Contains when and by whom the suspension was resolved."},"GoogleCloudIntegrationsV1alphaCreateAppsScriptProjectResponse":{"title":"GoogleCloudIntegrationsV1alphaCreateAppsScriptProjectResponse","type":"object","properties":{"projectId":{"type":"string","description":"The created AppsScriptProject ID."}},"description":"Response for CreateAppsScriptProject rpc call."},"EnterpriseCrmCardsTemplatesAplosSeriesListData":{"title":"EnterpriseCrmCardsTemplatesAplosSeriesListData","type":"object","properties":{"series":{"type":"array","items":{},"description":""}},"description":"Data used for Aplos charts that accept multiple Series."},"GoogleCloudIntegrationsV1alphaNextTask":{"title":"GoogleCloudIntegrationsV1alphaNextTask","type":"object","properties":{"taskId":{"type":"string","description":"Task number of the next task."},"description":{"type":"string","description":"User-provided description intended to give additional business context about the task."},"condition":{"type":"string","description":"Standard filter expression for this task to become an eligible next task."},"displayName":{"type":"string","description":"User-provided label that is attached to this edge in the UI."},"taskConfigId":{"type":"string","description":"ID of the next task."}},"description":"The task that is next in line to be executed, if the condition specified evaluated to true."},"EnterpriseCrmFrontendsEventbusProtoEventExecutionInfo":{"title":"EnterpriseCrmFrontendsEventbusProtoEventExecutionInfo","type":"object","properties":{"executionTraceInfo":{"description":"Execution trace info to aggregate parent-child executions."},"triggerId":{"type":"string","description":"The trigger id of the workflow trigger config. If both trigger_id and client_id is present, the workflow is executed from the start tasks provided by the matching trigger config otherwise it is executed from the default start tasks."},"workflowName":{"type":"string","description":"Name of the workflow."},"workflowId":{"type":"string","description":"Required. Pointer to the workflow it is executing."},"responseParams":{"description":"Event parameters come out as part of the response."},"tenant":{"type":"string","description":"Tenant this event is created. Used to reschedule the event to correct tenant."},"eventExecutionInfoId":{"type":"string","description":"Auto-generated primary key."},"snapshotNumber":{"type":"string","description":"Workflow snapshot number."},"requestId":{"type":"string","description":"Optional. This is used to de-dup incoming request."},"lastModifiedTime":{"type":"string","description":"Auto-generated."},"clientId":{"type":"string","description":"The event data user sends as request."},"product":{"allOf":[{"$ref":"#/components/schemas/Product"},{"description":"Which Google product the execution_info belongs to. If not set, the execution_info belongs to Integration Platform by default."}]},"createTime":{"type":"string","description":"Auto-generated."},"eventExecutionDetails":{"description":"The execution info about this event."},"postMethod":{"allOf":[{"$ref":"#/components/schemas/PostMethod"},{"description":"The ways user posts this event."}]},"errors":{"type":"array","items":{},"description":"Errors, warnings, and informationals associated with the workflow/task. The order in which the errors were added by the workflow/task is maintained."},"workflowRetryBackoffIntervalSeconds":{"type":"string","description":"Time interval in seconds to schedule retry of workflow in manifold when workflow is already running"},"errorCode":{"description":"Final error-code if event failed."},"requestParams":{"description":"Event parameters come in as part of the request."}},"description":"Contains all the execution details for a workflow instance. Next available id: 24"},"EnterpriseCrmEventbusProtoParamSpecEntryConfig":{"title":"EnterpriseCrmEventbusProtoParamSpecEntryConfig","type":"object","properties":{"subSectionLabel":{"type":"string","description":"A user-friendly label for subSection under which the parameter will be displayed."},"parameterNameOption":{"$ref":"#/components/schemas/ParameterNameOption"},"isHidden":{"type":"boolean","description":"Whether this field is hidden in the UI."},"label":{"type":"string","description":"A user-friendly label for the parameter."},"descriptivePhrase":{"type":"string","description":"A short phrase to describe what this parameter contains."},"inputDisplayOption":{"$ref":"#/components/schemas/InputDisplayOption"},"hideDefaultValue":{"type":"boolean","description":"Whether the default value is hidden in the UI."},"helpText":{"type":"string","description":"Detailed help text for this parameter containing information not provided elsewhere. For example, instructions on how to migrate from a deprecated parameter."},"uiPlaceholderText":{"type":"string","description":"Placeholder text which will appear in the UI input form for this parameter."}}},"GoogleCloudIntegrationsV1alphaIntParameterArray":{"title":"GoogleCloudIntegrationsV1alphaIntParameterArray","type":"object","properties":{"intValues":{"type":"array","items":{"type":"string"},"description":"Integer array."}},"description":"This message only contains a field of integer array."},"EnterpriseCrmEventbusProtoParameterMapField":{"title":"EnterpriseCrmEventbusProtoParameterMapField","type":"object","properties":{"literalValue":{"description":"Passing a literal value."},"referenceKey":{"type":"string","description":"Referencing one of the WF variables."}},"description":"Field represents either the key or value in an entry."},"GoogleCloudConnectorsV1Destination":{"title":"GoogleCloudConnectorsV1Destination","type":"object","properties":{"port":{"type":"integer","description":"The port is the target port number that is accepted by the destination.","contentEncoding":"int32"},"host":{"type":"string","description":"For publicly routable host."},"serviceAttachment":{"type":"string","description":"PSC service attachments. Format: projects/*/regions/*/serviceAttachments/*"}}},"GoogleCloudIntegrationsV1alphaMonitorExecutionStatsRequest":{"title":"GoogleCloudIntegrationsV1alphaMonitorExecutionStatsRequest","type":"object","properties":{"mashQuery":{"allOf":[{"$ref":"#/components/schemas/GoogleCloudIntegrationsV1alphaMonitorExecutionStatsRequestMashQuery"},{"description":"The MashQuery for searching data, set both queries for Join Operation."}]},"outputPeriod":{"type":"string","description":"The output period for the query. Must be set if there is a window operation within the query and unset otherwise."},"duration":{"type":"string","description":"How long the series data range: \"1h\",\"1d\",etc."},"metricFieldTable":{"type":"boolean","description":"Returns a table of all possible metric field values within the specified duration, ignoring any data samples. Useful for autocomplete functionality."},"endTime":{"type":"string","description":"Final time to query over, or the current time if left unset."},"responseTemplate":{"allOf":[{"$ref":"#/components/schemas/ResponseTemplate"},{"description":"Required. Template for response."}]}},"description":"The request to get data for monarch connector config."},"GoogleCloudIntegrationsV1alphaRuntimeEntitySchema":{"title":"GoogleCloudIntegrationsV1alphaRuntimeEntitySchema","type":"object","properties":{"fieldSchema":{"type":"string","description":"List of fields in the entity."},"entity":{"type":"string","description":"Name of the entity."},"arrayFieldSchema":{"type":"string","description":"The above schema, but for an array of the associated entity."}},"description":"Metadata of an entity, including a schema for its properties."},"GoogleCloudIntegrationsV1alphaClientConfig":{"title":"GoogleCloudIntegrationsV1alphaClientConfig","type":"object","properties":{"p4ServiceAccount":{"type":"string","description":"The P4SA account associated with this client"},"projectId":{"type":"string","description":"The GCP project id of the client associated with"},"description":{"type":"string","description":"Description of what the client is used for"},"clientState":{"allOf":[{"$ref":"#/components/schemas/ClientState"},{"description":"Indicates the activity state the client"}]},"createTime":{"type":"string","description":"The timestamp when the client was first created."},"cloudKmsConfig":{"allOf":[{"$ref":"#/components/schemas/GoogleCloudIntegrationsV1alphaCloudKmsConfig"},{"description":"Configuration information for Client's Cloud KMS information"}]},"cloudLoggingConfig":{"allOf":[{"$ref":"#/components/schemas/GoogleCloudIntegrationsV1alphaCloudLoggingConfig"},{"description":"Config info for Cloud Logging"}]},"region":{"type":"string","description":"The region the client is linked to."},"billingType":{"allOf":[{"$ref":"#/components/schemas/BillingType"},{"description":"Indicates the billing type of the client"}]},"id":{"type":"string","description":"Globally unique ID (project_id + region)"}},"description":"The configuration information for the Client"},"EnterpriseCrmEventbusProtoDoubleParameterArray":{"title":"EnterpriseCrmEventbusProtoDoubleParameterArray","type":"object","properties":{"doubleValues":{"type":"array","items":{"type":"number"},"description":""}}},"EnterpriseCrmEventbusProtoBooleanFunction":{"title":"EnterpriseCrmEventbusProtoBooleanFunction","type":"object","properties":{"functionName":{"$ref":"#/components/schemas/FunctionName6"}}},"GoogleCloudIntegrationsV1alphaListAuthConfigsResponse":{"title":"GoogleCloudIntegrationsV1alphaListAuthConfigsResponse","type":"object","properties":{"authConfigs":{"type":"array","items":{"$ref":"#/components/schemas/GoogleCloudIntegrationsV1alphaAuthConfig"},"description":"The list of AuthConfigs retrieved."},"nextPageToken":{"type":"string","description":"The token used to retrieve the next page of results."}},"description":"Response to list AuthConfigs."},"GoogleCloudIntegrationsV1alphaCreateAppsScriptProjectRequest":{"title":"GoogleCloudIntegrationsV1alphaCreateAppsScriptProjectRequest","type":"object","properties":{"authConfigId":{"type":"string","description":"The auth config id necessary to fetch the necessary credentials to create the project for external clients"},"appsScriptProject":{"type":"string","description":"The name of the Apps Script project to be created."}},"description":"Request for CreateAppsScriptProject rpc call."},"EnterpriseCrmEventbusProtoConnectorsGenericConnectorTaskConfig":{"title":"EnterpriseCrmEventbusProtoConnectorsGenericConnectorTaskConfig","type":"object","properties":{"connection":{"$ref":"#/components/schemas/EnterpriseCrmEventbusProtoConnectorsConnection"},"operation":{"allOf":[{"$ref":"#/components/schemas/Operation"},{"description":"Operation to perform using the configured connection."}]}}},"EnterpriseCrmCardsRow":{"title":"EnterpriseCrmCardsRow","type":"object","properties":{"cells":{"type":"array","items":{"$ref":"#/components/schemas/EnterpriseCrmCardsCellValue"},"description":"Ordered list of cell values within a row."}}},"GoogleCloudIntegrationsV1alphaTakeoverEditLockResponse":{"title":"GoogleCloudIntegrationsV1alphaTakeoverEditLockResponse","type":"object","properties":{"integrationVersion":{"allOf":[{"$ref":"#/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationVersion"},{"description":"The integration version definition."}]}},"description":"Response for TakeoverEditLock."},"EnterpriseCrmEventbusAuthconfigAuthConfigTaskParam":{"title":"EnterpriseCrmEventbusAuthconfigAuthConfigTaskParam","type":"object","properties":{"allowedServiceAccountInContext":{"type":"boolean"},"allowedCredentialTypes":{"type":"array","items":{"$ref":"#/components/schemas/AllowedCredentialType"},"description":"Defines the credential types to be supported as Task may restrict specific types to use, e.g. Cloud SQL Task will use username/password type only."},"scope":{"type":"string","description":"A space-delimited list of requested scope permissions."},"authConfigId":{"type":"string","description":"UUID of the AuthConfig."},"useServiceAccountInContext":{"type":"boolean"}}},"EnterpriseCrmEventbusProtoEventParameters":{"title":"EnterpriseCrmEventbusProtoEventParameters","type":"object","properties":{"parameters":{"type":"array","items":{},"description":"Parameters are a part of Event and can be used to communicate between different tasks that are part of the same integration execution."}},"description":"LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4"},"GoogleCloudIntegrationsV1alphaAccessToken":{"title":"GoogleCloudIntegrationsV1alphaAccessToken","type":"object","properties":{"accessTokenExpireTime":{"type":"string","description":"Required. The approximate time until the access token retrieved is valid."},"tokenType":{"type":"string","description":"Only support \"bearer\" token in v1 as bearer token is the predominant type used with OAuth 2.0."},"accessToken":{"type":"string","description":"The access token encapsulating the security identity of a process or thread."},"refreshTokenExpireTime":{"type":"string","description":"The approximate time until the refresh token retrieved is valid."},"refreshToken":{"type":"string","description":"If the access token will expire, use the refresh token to obtain another access token."}},"description":"The access token represents the authorization of a specific application to access specific parts of a user’s data."},"GoogleCloudIntegrationsV1alphaUploadIntegrationVersionRequest":{"title":"GoogleCloudIntegrationsV1alphaUploadIntegrationVersionRequest","type":"object","properties":{"content":{"type":"string","description":"The textproto of the integration_version."},"fileFormat":{"allOf":[{"$ref":"#/components/schemas/FileFormat"},{"description":"File format for upload request."}]}},"description":"Request for UploadIntegrationVersion."},"EnterpriseCrmEventbusProtoJsonFunction":{"title":"EnterpriseCrmEventbusProtoJsonFunction","type":"object","properties":{"functionName":{"$ref":"#/components/schemas/FunctionName8"}}},"GoogleCloudIntegrationsV1alphaListSfdcInstancesResponse":{"title":"GoogleCloudIntegrationsV1alphaListSfdcInstancesResponse","type":"object","properties":{"sfdcInstances":{"type":"array","items":{"$ref":"#/components/schemas/GoogleCloudIntegrationsV1alphaSfdcInstance"},"description":"The list of SfdcInstances retrieved."},"nextPageToken":{"type":"string","description":"The token used to retrieve the next page of results."}},"description":"Response to list SfdcInstances."},"EnterpriseCrmEventbusProtoCoordinate":{"title":"EnterpriseCrmEventbusProtoCoordinate","type":"object","properties":{"x":{"type":"integer","contentEncoding":"int32"},"y":{"type":"integer","contentEncoding":"int32"}},"description":"Represents two-dimensional positions."},"GoogleCloudConnectorsV1ConnectionStatus":{"title":"GoogleCloudConnectorsV1ConnectionStatus","type":"object","properties":{"status":{"type":"string","description":"Status provides detailed information for the state."},"state":{"allOf":[{"$ref":"#/components/schemas/State4"},{"description":"State."}]},"description":{"type":"string","description":"Description."}},"description":"ConnectionStatus indicates the state of the connection."},"EnterpriseCrmFrontendsEventbusProtoEventExecutionSnapshot":{"title":"EnterpriseCrmFrontendsEventbusProtoEventExecutionSnapshot","type":"object","properties":{"conditionResults":{"type":"array","items":{},"description":"All of the computed conditions that been calculated."},"taskExecutionDetails":{"type":"array","items":{},"description":"All of the task execution details at the given point of time."},"eventExecutionSnapshotMetadata":{},"eventParams":{"description":"The parameters in Event object."},"eventExecutionInfoId":{"type":"string","description":"Points to the event execution info this snapshot belongs to."},"diffParams":{"description":"The parameters in Event object that differs from last snapshot."},"taskName":{"type":"string","description":"The task name associated with this snapshot. Could be empty."},"checkpointTaskNumber":{"type":"string","description":"Indicates \"right after which checkpoint task's execution\" this snapshot is taken."},"eventExecutionSnapshotId":{"type":"string","description":"Auto-generated. Used as primary key for EventExecutionSnapshots table."},"snapshotTime":{"type":"string","description":"Indicates when this snapshot is taken."}}},"EnterpriseCrmEventbusProtoBaseAlertConfigThresholdValue":{"title":"EnterpriseCrmEventbusProtoBaseAlertConfigThresholdValue","type":"object","properties":{"percentage":{"type":"integer","contentEncoding":"int32"},"absolute":{"type":"string"}},"description":"The threshold value of the metric, above or below which the alert should be triggered. See EventAlertConfig or TaskAlertConfig for the different alert metric types in each case. For the *RATE metrics, one or both of these fields may be set. Zero is the default value and can be left at that. For *PERCENTILE_DURATION metrics, one or both of these fields may be set, and also, the duration threshold value should be specified in the threshold_duration_ms member below. For *AVERAGE_DURATION metrics, these fields should not be set at all. A different member, threshold_duration_ms, must be set in the EventAlertConfig or the TaskAlertConfig. See go/eventbus-alert-config-examples"},"GoogleCloudIntegrationsV1alphaIntegrationBundleConfig":{"title":"GoogleCloudIntegrationsV1alphaIntegrationBundleConfig","type":"object","properties":{"integrations":{"type":"array","items":{"type":"string"},"description":"A bundle of integrations that can be executed by the task at runtime."},"serviceAccount":{"type":"string","description":"Output only. The service account created and owned by IP and added to the customers GCP project."}},"description":"This proto holds the core runner data in the bundle task. It is not expected to be directly edited by the user. Instead, a default value will be provided at the task creation time."},"EnterpriseCrmEventbusProtoParameterMap":{"title":"EnterpriseCrmEventbusProtoParameterMap","type":"object","properties":{"entries":{"type":"array","items":{"$ref":"#/components/schemas/EnterpriseCrmEventbusProtoParameterMapEntry"},"description":""},"keyType":{"allOf":[{"$ref":"#/components/schemas/KeyType"},{"description":"Option to specify key value type for all entries of the map. If provided then field types for all entries must conform to this."}]},"valueType":{"$ref":"#/components/schemas/ValueType"}},"description":"A generic multi-map that holds key value pairs. They keys and values can be of any type, unless specified."},"GoogleCloudIntegrationsV1alphaParameterMapEntry":{"title":"GoogleCloudIntegrationsV1alphaParameterMapEntry","type":"object","properties":{"key":{"allOf":[{"$ref":"#/components/schemas/GoogleCloudIntegrationsV1alphaParameterMapField"},{"description":"Field represents either the key or value in an entry."}]},"value":{"allOf":[{"$ref":"#/components/schemas/GoogleCloudIntegrationsV1alphaParameterMapField"},{"description":"Field represents either the key or value in an entry."}]}},"description":"Entry is a pair of key and value."},"GoogleCloudIntegrationsV1alphaCreateCloudFunctionResponse":{"title":"GoogleCloudIntegrationsV1alphaCreateCloudFunctionResponse","type":"object","properties":{"triggerUrl":{"type":"string","description":"The trigger url that will be returned"}},"description":"Response for Creating Cloud Function rpc call."},"GoogleCloudIntegrationsV1alphaSuspensionApprovalConfig":{"title":"GoogleCloudIntegrationsV1alphaSuspensionApprovalConfig","type":"object","properties":{"customMessage":{"type":"string","description":"Information to provide for recipients."},"expiration":{"description":"Indicates the next steps when no external actions happen on the suspension."},"emailAddresses":{"type":"array","items":{"type":"string"},"description":"Email addresses to send approval request to."}},"description":"Configurations for approving the Suspension."},"EnterpriseCrmFrontendsEventbusProtoParameterValueType":{"title":"EnterpriseCrmFrontendsEventbusProtoParameterValueType","type":"object","properties":{"doubleValue":{"type":"number"},"jsonValue":{"type":"string"},"stringValue":{"type":"string"},"intValue":{"type":"string"},"booleanValue":{"type":"boolean"},"booleanArray":{"$ref":"#/components/schemas/EnterpriseCrmFrontendsEventbusProtoBooleanParameterArray"},"intArray":{"$ref":"#/components/schemas/EnterpriseCrmFrontendsEventbusProtoIntParameterArray"},"stringArray":{"$ref":"#/components/schemas/EnterpriseCrmFrontendsEventbusProtoStringParameterArray"},"doubleArray":{"$ref":"#/components/schemas/EnterpriseCrmFrontendsEventbusProtoDoubleParameterArray"},"protoValue":{"type":"object","additionalProperties":{}},"serializedObjectValue":{"$ref":"#/components/schemas/EnterpriseCrmFrontendsEventbusProtoSerializedObjectParameter"},"protoArray":{"$ref":"#/components/schemas/EnterpriseCrmFrontendsEventbusProtoProtoParameterArray"}},"description":"To support various types of parameter values. Next available id: 14"},"EnterpriseCrmEventbusProtoToken":{"title":"EnterpriseCrmEventbusProtoToken","type":"object","properties":{"value":{"type":"string"},"name":{"type":"string"}}},"GoogleCloudConnectorsV1NodeConfig":{"title":"GoogleCloudConnectorsV1NodeConfig","type":"object","properties":{"minNodeCount":{"type":"integer","description":"Minimum number of nodes in the runtime nodes.","contentEncoding":"int32"},"maxNodeCount":{"type":"integer","description":"Maximum number of nodes in the runtime nodes.","contentEncoding":"int32"}},"description":"Configuration for the connection."},"GoogleCloudIntegrationsV1alphaListConnectionsResponse":{"title":"GoogleCloudIntegrationsV1alphaListConnectionsResponse","type":"object","properties":{"connections":{"type":"array","items":{"$ref":"#/components/schemas/GoogleCloudConnectorsV1Connection"},"description":"Connections."},"nextPageToken":{"type":"string","description":"Next page token."}},"description":"Response containing Connections listed by region."},"GoogleCloudIntegrationsV1alphaProvisionClientRequest":{"title":"GoogleCloudIntegrationsV1alphaProvisionClientRequest","type":"object","properties":{"cloudKmsConfig":{"allOf":[{"$ref":"#/components/schemas/GoogleCloudIntegrationsV1alphaCloudKmsConfig"},{"description":"Configuration information for Client's Cloud KMS information"}]},"createSampleWorkflows":{"type":"boolean","description":"Optional. Indicates if sample workflow should be created along with provisioning"}},"description":"Request for the Provision rpc"},"EnterpriseCrmFrontendsEventbusProtoParamSpecsMessage":{"title":"EnterpriseCrmFrontendsEventbusProtoParamSpecsMessage","type":"object","properties":{"parameters":{"type":"array","items":{"$ref":"#/components/schemas/EnterpriseCrmFrontendsEventbusProtoParamSpecEntry"},"description":""}}},"EnterpriseCrmEventbusProtoProtoArrayFunction":{"title":"EnterpriseCrmEventbusProtoProtoArrayFunction","type":"object","properties":{"functionName":{"$ref":"#/components/schemas/FunctionName3"}}},"GoogleCloudIntegrationsV1alphaUpdateBundleResponse":{"title":"GoogleCloudIntegrationsV1alphaUpdateBundleResponse","type":"object","properties":{"config":{"allOf":[{"$ref":"#/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationBundleConfig"},{"description":"This proto holds the core runner data in the bundle task. It is not expected to be directly edited by the user. Instead, a default value will be provided at the task creation time."}]}},"description":"Response message for Bundle update"},"GoogleCloudIntegrationsV1alphaCreateCloudFunctionRequest":{"title":"GoogleCloudIntegrationsV1alphaCreateCloudFunctionRequest","type":"object","properties":{"functionName":{"type":"string","description":"The function name of CF to be created"},"functionRegion":{"type":"string","description":"The function region of CF to be created"},"projectId":{"type":"string","description":"Indicates the id of the GCP project that the function will be created in."}},"description":"Request for Creating Cloud Function rpc call."},"GoogleCloudIntegrationsV1alphaAuthToken":{"title":"GoogleCloudIntegrationsV1alphaAuthToken","type":"object","properties":{"type":{"type":"string","description":"Authentication type, e.g. \"Basic\", \"Bearer\", etc."},"token":{"type":"string","description":"The token for the auth type."}},"description":"The credentials to authenticate a user agent with a server that is put in HTTP Authorization request header."},"EnterpriseCrmLoggingGwsFieldLimits":{"title":"EnterpriseCrmLoggingGwsFieldLimits","type":"object","properties":{"shortenerType":{"$ref":"#/components/schemas/ShortenerType"},"maxArraySize":{"type":"integer","description":"maximum array size. If the array exceds this size, the field (list) is truncated.","contentEncoding":"int32"},"logType":{"type":"array","items":{"$ref":"#/components/schemas/LogType"},"description":"To which type(s) of logs the limits apply."},"maxStringLength":{"type":"integer","description":"maximum string length. If the field exceeds this amount the field is shortened.","contentEncoding":"int32"},"logAction":{"$ref":"#/components/schemas/LogAction"}},"description":"Describes string and array limits when writing to logs. When a limit is exceeded the *shortener_type* describes how to shorten the field. next_id: 6"},"GoogleCloudIntegrationsV1alphaOAuth2AuthorizationCode":{"title":"GoogleCloudIntegrationsV1alphaOAuth2AuthorizationCode","type":"object","properties":{"authParams":{"allOf":[{"$ref":"#/components/schemas/GoogleCloudIntegrationsV1alphaParameterMap"},{"description":"A generic multi-map that holds key value pairs. They keys and values can be of any type, unless specified."}]},"authCode":{"type":"string","description":"The Auth Code that is used to initially retrieve the access token."},"tokenEndpoint":{"type":"string","description":"The token url endpoint to send the token request to."},"authEndpoint":{"type":"string","description":"The auth url endpoint to send the auth code request to."},"applyReauthPolicy":{"type":"boolean","description":"Indicates if the user has opted in Google Reauth Policy. If opted in, the refresh token will be valid for 20 hours, after which time users must re-authenticate in order to obtain a new one."},"clientId":{"type":"string","description":"The client's id."},"clientSecret":{"type":"string","description":"The client's secret."},"accessToken":{"allOf":[{"$ref":"#/components/schemas/GoogleCloudIntegrationsV1alphaAccessToken"},{"description":"The access token represents the authorization of a specific application to access specific parts of a user’s data."}]},"tokenParams":{"allOf":[{"$ref":"#/components/schemas/GoogleCloudIntegrationsV1alphaParameterMap"},{"description":"A generic multi-map that holds key value pairs. They keys and values can be of any type, unless specified."}]},"scope":{"type":"string","description":"A space-delimited list of requested scope permissions."},"requestType":{"allOf":[{"$ref":"#/components/schemas/RequestType"},{"description":"Represent how to pass parameters to fetch access token"}]}},"description":"The OAuth Type where the client sends request with the client id and requested scopes to auth endpoint. User sees a consent screen and auth code is received at specified redirect url afterwards. The auth code is then combined with the client id and secret and sent to the token endpoint in exchange for the access and refresh token. The refresh token can be used to fetch new access tokens."},"EnterpriseCrmEventbusProtoNotification":{"title":"EnterpriseCrmEventbusProtoNotification","type":"object","properties":{"pubsubTopic":{"type":"string"},"escalatorQueue":{"type":"string"},"emailAddress":{"allOf":[{"$ref":"#/components/schemas/EnterpriseCrmEventbusProtoAddress"},{"description":"Email address along with optional name and tokens. These tokens will be substituted for the variables in the form of [{var_name}], where var_name could be any string of no more than 32 bytes."}]},"buganizerNotification":{"$ref":"#/components/schemas/EnterpriseCrmEventbusProtoBuganizerNotification"},"request":{"$ref":"#/components/schemas/EnterpriseCrmEventbusProtoCustomSuspensionRequest"}}},"EnterpriseCrmEventbusProtoProtoFunction":{"title":"EnterpriseCrmEventbusProtoProtoFunction","type":"object","properties":{"functionName":{"$ref":"#/components/schemas/FunctionName"}}},"EnterpriseCrmCardsCellValue":{"title":"EnterpriseCrmCardsCellValue","type":"object","properties":{"stringValue":{"type":"string"},"booleanValue":{"type":"boolean"},"longValue":{"type":"string"},"doubleValue":{"type":"number"},"empty":{}}},"GoogleCloudIntegrationsV1alphaParameterMapField":{"title":"GoogleCloudIntegrationsV1alphaParameterMapField","type":"object","properties":{"referenceKey":{"type":"string","description":"Referencing one of the Integration variables."},"literalValue":{"description":"Passing a literal value."}},"description":"Field represents either the key or value in an entry."},"EnterpriseCrmFrontendsEventbusProtoIntParameterArray":{"title":"EnterpriseCrmFrontendsEventbusProtoIntParameterArray","type":"object","properties":{"intValues":{"type":"array","items":{"type":"string"},"description":""}}},"EnterpriseCrmFrontendsEventbusProtoParamSpecEntry":{"title":"EnterpriseCrmFrontendsEventbusProtoParamSpecEntry","type":"object","properties":{"isOutput":{"type":"boolean"},"isDeprecated":{"type":"boolean","description":"If set, this entry is deprecated, so further use of this parameter should be prohibited."},"defaultValue":{"description":"Default values for the defined keys. Each value can either be string, int, double or any proto message or a serialized object."},"required":{"type":"boolean","description":"If set, the user must provide an input value for this parameter."},"jsonSchema":{"type":"string","description":"If the data_type is JSON_VALUE, then this will define its schema."},"key":{"type":"string","description":"Key is used to retrieve the corresponding parameter value. This should be unique for a given task. These parameters must be predefined in the workflow definition."},"className":{"type":"string","description":"The FQCN of the Java object this represents. A string, for example, would be \"java.lang.String\". If this is \"java.lang.Object\", the parameter can be of any type."},"config":{"description":"Optional fields, such as help text and other useful info."},"collectionElementClassName":{"type":"string","description":"If it is a collection of objects, this would be the FCQN of every individual element in the collection. If this is \"java.lang.Object\", the parameter is a collection of any type."},"validationRule":{"description":"Rule used to validate inputs (individual values and collection elements) for this parameter."},"protoDef":{"description":"Populated if this represents a proto or proto array."},"dataType":{"allOf":[{"$ref":"#/components/schemas/DataType1"},{"description":"The data type of the parameter."}]}},"description":"Key-value pair of EventBus task parameters. Next id: 13"},"EnterpriseCrmEventbusProtoExternalTraffic":{"title":"EnterpriseCrmEventbusProtoExternalTraffic","type":"object","properties":{"gcpProjectId":{"type":"string","description":"User’s GCP project id the traffic is referring to."},"location":{"type":"string","description":"Location for the user's request."},"source":{"allOf":[{"$ref":"#/components/schemas/Source"},{"description":"LINT.ThenChange(//depot/google3/enterprise/crm/eventbus/proto/product.proto:product, //depot/google3/java/com/google/enterprise/crm/integrationplatform/api/utils/ConverterUtils.java:source_to_product)"}]},"gcpProjectNumber":{"type":"string","description":"User’s GCP project number the traffic is referring to."}},"description":"Represents external traffic type and id."},"EnterpriseCrmEventbusProtoSuspensionAuthPermissionsGaiaIdentity":{"title":"EnterpriseCrmEventbusProtoSuspensionAuthPermissionsGaiaIdentity","type":"object","properties":{"emailAddress":{"type":"string"},"gaiaId":{"type":"string"}}},"EnterpriseCrmEventbusProtoSuspensionResolutionInfo":{"title":"EnterpriseCrmEventbusProtoSuspensionResolutionInfo","type":"object","properties":{"createdTimestamp":{"type":"string","description":"Auto-generated."},"product":{"allOf":[{"$ref":"#/components/schemas/Product1"},{"description":"Which Google product the suspension belongs to. If not set, the suspension belongs to Integration Platform by default."}]},"audit":{"$ref":"#/components/schemas/EnterpriseCrmEventbusProtoSuspensionResolutionInfoAudit"},"suspensionConfig":{"$ref":"#/components/schemas/EnterpriseCrmEventbusProtoSuspensionConfig"},"externalTraffic":{"allOf":[{"$ref":"#/components/schemas/EnterpriseCrmEventbusProtoExternalTraffic"},{"description":"Represents external traffic type and id."}]},"workflowName":{"type":"string","description":"Required. The name of the originating workflow."},"lastModifiedTimestamp":{"type":"string","description":"Auto-generated."},"status":{"$ref":"#/components/schemas/Status2"},"eventExecutionInfoId":{"type":"string","description":"Required. ID of the associated execution."},"taskNumber":{"type":"string","description":"Required. Task number of the associated SuspensionTask."},"suspensionId":{"type":"string","description":"Primary key for the SuspensionResolutionInfoTable."}}},"EnterpriseCrmFrontendsEventbusProtoParameterEntry":{"title":"EnterpriseCrmFrontendsEventbusProtoParameterEntry","type":"object","properties":{"value":{"description":"Values for the defined keys. Each value can either be string, int, double or any proto message."},"dataType":{"allOf":[{"$ref":"#/components/schemas/DataType"},{"description":"Explicitly getting the type of the parameter."}]},"key":{"type":"string","description":"Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the workflow definition."}},"description":"Key-value pair of EventBus parameters."},"GoogleCloudIntegrationsV1alphaParameterMap":{"title":"GoogleCloudIntegrationsV1alphaParameterMap","type":"object","properties":{"entries":{"type":"array","items":{},"description":"A list of parameter map entries."},"keyType":{"allOf":[{"$ref":"#/components/schemas/KeyType1"},{"description":"Option to specify key type for all entries of the map. If provided then field types for all entries must conform to this."}]},"valueType":{"allOf":[{"$ref":"#/components/schemas/ValueType1"},{"description":"Option to specify value type for all entries of the map. If provided then field types for all entries must conform to this."}]}},"description":"A generic multi-map that holds key value pairs. They keys and values can be of any type, unless specified."},"GoogleCloudConnectorsV1AuthConfig":{"title":"GoogleCloudConnectorsV1AuthConfig","type":"object","properties":{"additionalVariables":{"type":"array","items":{},"description":"List containing additional auth configs."},"authType":{"allOf":[{"$ref":"#/components/schemas/AuthType"},{"description":"The type of authentication configured."}]},"userPassword":{"description":"UserPassword."},"oauth2JwtBearer":{"description":"Oauth2JwtBearer."},"sshPublicKey":{"description":"SSH Public Key."},"oauth2ClientCredentials":{"description":"Oauth2ClientCredentials."}},"description":"AuthConfig defines details of a authentication type."},"GoogleCloudIntegrationsV1alphaTestIntegrationsResponse":{"title":"GoogleCloudIntegrationsV1alphaTestIntegrationsResponse","type":"object","properties":{"executionFailed":{"type":"boolean","description":"Is true if any execution in the integration failed. False otherwise."},"executionId":{"type":"string","description":"The id of the execution corresponding to this run of integration."},"parameters":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/GoogleCloudIntegrationsV1alphaValueType"},"description":"Optional. Parameters are a part of Event and can be used to communicate between different tasks that are part of the same integration execution."},"parameterEntries":{"type":"array","items":{"$ref":"#/components/schemas/EnterpriseCrmFrontendsEventbusProtoParameterEntry"},"description":"Parameters are a part of Event and can be used to communicate between different tasks that are part of the same integration execution."},"eventParameters":{"allOf":[{"$ref":"#/components/schemas/EnterpriseCrmFrontendsEventbusProtoEventParameters"},{"description":"LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4"}]}},"description":"The response for testing an integration."},"EnterpriseCrmEventbusProtoParamSpecEntryValidationRuleIntRange":{"title":"EnterpriseCrmEventbusProtoParamSpecEntryValidationRuleIntRange","type":"object","properties":{"min":{"type":"string","description":"The inclusive minimum of the acceptable range."},"max":{"type":"string","description":"The inclusive maximum of the acceptable range."}},"description":"Range used to validate longs and ints."},"GoogleCloudIntegrationsV1alphaListCertificatesResponse":{"title":"GoogleCloudIntegrationsV1alphaListCertificatesResponse","type":"object","properties":{"certificates":{"type":"array","items":{"$ref":"#/components/schemas/GoogleCloudIntegrationsV1alphaCertificate"},"description":"The list of Certificates retrieved."},"nextPageToken":{"type":"string","description":"The token used to retrieve the next page of results."}},"description":"Response to list Certificates."},"GoogleCloudIntegrationsV1alphaClientCertificate":{"title":"GoogleCloudIntegrationsV1alphaClientCertificate","type":"object","properties":{"encryptedPrivateKey":{"type":"string","description":"The ssl certificate encoded in PEM format. This string must include the begin header and end footer lines. For example, -----BEGIN CERTIFICATE----- MIICTTCCAbagAwIBAgIJAPT0tSKNxan/MA0GCSqGSIb3DQEBCwUAMCoxFzAVBgNV BAoTDkdvb2dsZSBURVNUSU5HMQ8wDQYDVQQDEwZ0ZXN0Q0EwHhcNMTUwMTAxMDAw MDAwWhcNMjUwMTAxMDAwMDAwWjAuMRcwFQYDVQQKEw5Hb29nbGUgVEVTVElORzET MBEGA1UEAwwKam9lQGJhbmFuYTCBnzANBgkqhkiG9w0BAQEFAAOBjQAwgYkCgYEA vDYFgMgxi5W488d9J7UpCInl0NXmZQpJDEHE4hvkaRlH7pnC71H0DLt0/3zATRP1 JzY2+eqBmbGl4/sgZKYv8UrLnNyQNUTsNx1iZAfPUflf5FwgVsai8BM0pUciq1NB xD429VFcrGZNucvFLh72RuRFIKH8WUpiK/iZNFkWhZ0CAwEAAaN3MHUwDgYDVR0P AQH/BAQDAgWgMB0GA1UdJQQWMBQGCCsGAQUFBwMBBggrBgEFBQcDAjAMBgNVHRMB Af8EAjAAMBkGA1UdDgQSBBCVgnFBCWgL/iwCqnGrhTPQMBsGA1UdIwQUMBKAEKey Um2o4k2WiEVA0ldQvNYwDQYJKoZIhvcNAQELBQADgYEAYK986R4E3L1v+Q6esBtW JrUwA9UmJRSQr0N5w3o9XzarU37/bkjOP0Fw0k/A6Vv1n3vlciYfBFaBIam1qRHr 5dMsYf4CZS6w50r7hyzqyrwDoyNxkLnd2PdcHT/sym1QmflsjEs7pejtnohO6N2H wQW6M0H7Zt8claGRla4fKkg= -----END CERTIFICATE-----"},"passphrase":{"type":"string","description":"'passphrase' should be left unset if private key is not encrypted. Note that 'passphrase' is not the password for web server, but an extra layer of security to protected private key."},"sslCertificate":{"type":"string","description":"The ssl certificate encoded in PEM format. This string must include the begin header and end footer lines. For example, -----BEGIN CERTIFICATE----- MIICTTCCAbagAwIBAgIJAPT0tSKNxan/MA0GCSqGSIb3DQEBCwUAMCoxFzAVBgNV BAoTDkdvb2dsZSBURVNUSU5HMQ8wDQYDVQQDEwZ0ZXN0Q0EwHhcNMTUwMTAxMDAw MDAwWhcNMjUwMTAxMDAwMDAwWjAuMRcwFQYDVQQKEw5Hb29nbGUgVEVTVElORzET MBEGA1UEAwwKam9lQGJhbmFuYTCBnzANBgkqhkiG9w0BAQEFAAOBjQAwgYkCgYEA vDYFgMgxi5W488d9J7UpCInl0NXmZQpJDEHE4hvkaRlH7pnC71H0DLt0/3zATRP1 JzY2+eqBmbGl4/sgZKYv8UrLnNyQNUTsNx1iZAfPUflf5FwgVsai8BM0pUciq1NB xD429VFcrGZNucvFLh72RuRFIKH8WUpiK/iZNFkWhZ0CAwEAAaN3MHUwDgYDVR0P AQH/BAQDAgWgMB0GA1UdJQQWMBQGCCsGAQUFBwMBBggrBgEFBQcDAjAMBgNVHRMB Af8EAjAAMBkGA1UdDgQSBBCVgnFBCWgL/iwCqnGrhTPQMBsGA1UdIwQUMBKAEKey Um2o4k2WiEVA0ldQvNYwDQYJKoZIhvcNAQELBQADgYEAYK986R4E3L1v+Q6esBtW JrUwA9UmJRSQr0N5w3o9XzarU37/bkjOP0Fw0k/A6Vv1n3vlciYfBFaBIam1qRHr 5dMsYf4CZS6w50r7hyzqyrwDoyNxkLnd2PdcHT/sym1QmflsjEs7pejtnohO6N2H wQW6M0H7Zt8claGRla4fKkg= -----END CERTIFICATE-----"}},"description":"Contains client certificate information"},"GoogleCloudIntegrationsV1alphaScheduleIntegrationsResponse":{"title":"GoogleCloudIntegrationsV1alphaScheduleIntegrationsResponse","type":"object","properties":{"executionInfoIds":{"type":"array","items":{"type":"string"},"description":"The execution info id for the executed integrations."}},"description":"The response for executing an integration."},"EnterpriseCrmEventbusProtoStringArrayFunction":{"title":"EnterpriseCrmEventbusProtoStringArrayFunction","type":"object","properties":{"functionName":{"$ref":"#/components/schemas/FunctionName3"}}},"GoogleCloudIntegrationsV1alphaListTaskEntitiesResponse":{"title":"GoogleCloudIntegrationsV1alphaListTaskEntitiesResponse","type":"object","properties":{"taskEntities":{"type":"array","items":{"$ref":"#/components/schemas/EnterpriseCrmFrontendsEventbusProtoTaskEntity"},"description":"The list of the tasks."}},"description":"This is a UI only method and will be moved away. Response for ListTaskEntities."},"GoogleCloudIntegrationsV1alphaOidcToken":{"title":"GoogleCloudIntegrationsV1alphaOidcToken","type":"object","properties":{"tokenExpireTime":{"type":"string","description":"The approximate time until the token retrieved is valid."},"serviceAccountEmail":{"type":"string","description":"The service account email to be used as the identity for the token."},"token":{"type":"string","description":"ID token obtained for the service account"},"audience":{"type":"string","description":"Audience to be used when generating OIDC token. The audience claim identifies the recipients that the JWT is intended for."}},"description":"OIDC Token"},"GoogleCloudIntegrationsV1alphaDoubleParameterArray":{"title":"GoogleCloudIntegrationsV1alphaDoubleParameterArray","type":"object","properties":{"doubleValues":{"type":"array","items":{"type":"number"},"description":"Double number array."}},"description":"This message only contains a field of double number array."},"EnterpriseCrmEventbusProtoTaskUiConfig":{"title":"EnterpriseCrmEventbusProtoTaskUiConfig","type":"object","properties":{"taskUiModuleConfigs":{"type":"array","items":{"$ref":"#/components/schemas/EnterpriseCrmEventbusProtoTaskUiModuleConfig"},"description":"Configurations of included config modules."}},"description":"Task authors would use this type to configure the UI for a particular task by specifying what UI config modules should be included to compose the UI. Learn more about config module framework: go/integration-platform-config-module-framework"},"GoogleCloudConnectorsV1AuthConfigOauth2ClientCredentials":{"title":"GoogleCloudConnectorsV1AuthConfigOauth2ClientCredentials","type":"object","properties":{"clientId":{"type":"string","description":"The client identifier."},"clientSecret":{"allOf":[{"$ref":"#/components/schemas/GoogleCloudConnectorsV1Secret"},{"description":"Secret provides a reference to entries in Secret Manager."}]}},"description":"Parameters to support Oauth 2.0 Client Credentials Grant Authentication. See https://tools.ietf.org/html/rfc6749#section-1.3.4 for more details."},"GoogleCloudIntegrationsV1alphaStringParameterArray":{"title":"GoogleCloudIntegrationsV1alphaStringParameterArray","type":"object","properties":{"stringValues":{"type":"array","items":{"type":"string"},"description":"String array."}},"description":"This message only contains a field of string array."},"EnterpriseCrmEventbusProtoDoubleArray":{"title":"EnterpriseCrmEventbusProtoDoubleArray","type":"object","properties":{"values":{"type":"array","items":{"type":"number"},"description":""}}},"EnterpriseCrmEventbusProtoBaseValue":{"title":"EnterpriseCrmEventbusProtoBaseValue","type":"object","properties":{"literalValue":{"allOf":[{"$ref":"#/components/schemas/EnterpriseCrmEventbusProtoParameterValueType"},{"description":"LINT.IfChange To support various types of parameter values. Next available id: 14"}]},"baseFunction":{"$ref":"#/components/schemas/EnterpriseCrmEventbusProtoFunction"},"referenceValue":{"type":"string","description":"Start with a reference value to dereference."}}},"EnterpriseCrmEventbusProtoStringParameterArray":{"title":"EnterpriseCrmEventbusProtoStringParameterArray","type":"object","properties":{"stringValues":{"type":"array","items":{"type":"string"},"description":""}}},"GoogleCloudIntegrationsV1alphaCredential":{"title":"GoogleCloudIntegrationsV1alphaCredential","type":"object","properties":{"oauth2ClientCredentials":{"description":"OAuth2Implicit oauth2_implicit = 5; OAuth2 client credentials"},"usernameAndPassword":{"description":"Username and password credential"},"oidcToken":{"description":"Google OIDC ID Token"},"authToken":{"description":"Auth token credential"},"credentialType":{"allOf":[{"$ref":"#/components/schemas/CredentialType1"},{"description":"Credential type associated with auth config."}]},"oauth2AuthorizationCode":{"description":"The api_key and oauth2_implicit are not covered in v1 and will be picked up once v1 is implemented. ApiKey api_key = 3; OAuth2 authorization code credential"},"oauth2ResourceOwnerCredentials":{"description":"OAuth2 resource owner credentials"},"jwt":{"description":"JWT credential"},"serviceAccountCredentials":{"description":"Service account credential"}},"description":"Defines parameters for a single, canonical credential."},"EnterpriseCrmEventbusProtoParamSpecEntryValidationRuleStringRegex":{"title":"EnterpriseCrmEventbusProtoParamSpecEntryValidationRuleStringRegex","type":"object","properties":{"regex":{"type":"string","description":"The regex applied to the input value(s)."},"exclusive":{"type":"boolean","description":"Whether the regex matcher is applied exclusively (if true, matching values will be rejected)."}},"description":"Rule used to validate strings."},"GoogleCloudIntegrationsV1alphaMonitorExecutionStatsRequestMashQueryOperationMode":{"title":"GoogleCloudIntegrationsV1alphaMonitorExecutionStatsRequestMashQueryOperationMode","type":"object","properties":{"joinConfig":{"description":"Optional. join operation"},"operationType":{"allOf":[{"$ref":"#/components/schemas/OperationType"},{"description":"Optional. optional operation types."}]},"unionConfig":{"description":"Optional. union operation"}},"description":"Operation between 2 query"},"EnterpriseCrmEventbusProtoTaskExecutionDetailsTaskAttemptStats":{"title":"EnterpriseCrmEventbusProtoTaskExecutionDetailsTaskAttemptStats","type":"object","properties":{"endTime":{"type":"string","description":"The end time of the task execution for current attempt."},"startTime":{"type":"string","description":"The start time of the task execution for current attempt. This could be in the future if it's been scheduled."}}},"EnterpriseCrmEventbusProtoSuspensionAuthPermissions":{"title":"EnterpriseCrmEventbusProtoSuspensionAuthPermissions","type":"object","properties":{"loasRole":{"type":"string"},"gaiaIdentity":{"$ref":"#/components/schemas/EnterpriseCrmEventbusProtoSuspensionAuthPermissionsGaiaIdentity"},"googleGroup":{"$ref":"#/components/schemas/EnterpriseCrmEventbusProtoSuspensionAuthPermissionsGaiaIdentity"},"mdbGroup":{"type":"string"}},"description":"LINT.IfChange"},"EnterpriseCrmEventbusProtoParamSpecEntryValidationRuleDoubleRange":{"title":"EnterpriseCrmEventbusProtoParamSpecEntryValidationRuleDoubleRange","type":"object","properties":{"max":{"type":"number","description":"The inclusive maximum of the acceptable range."},"min":{"type":"number","description":"The inclusive minimum of the acceptable range."}},"description":"Range used to validate doubles and floats."},"GoogleCloudIntegrationsV1alphaMonitorExecutionStatsRequestMashQueryOperationModeUnionConfig":{"title":"GoogleCloudIntegrationsV1alphaMonitorExecutionStatsRequestMashQueryOperationModeUnionConfig","type":"object","properties":{"reducer":{"type":"string","description":"Optional. optional, reduce function"}},"description":"Union operation"},"EnterpriseCrmFrontendsEventbusProtoTaskConfig":{"title":"EnterpriseCrmFrontendsEventbusProtoTaskConfig","type":"object","properties":{"incomingEdgeCount":{"type":"integer","description":"The number of edges leading into this TaskConfig.","contentEncoding":"int32"},"taskNumber":{"type":"string","description":"REQUIRED: the identifier of this task within its parent event config, specified by the client. This should be unique among all the tasks belong to the same event config. We use this field as the identifier to find next tasks (via field `next_tasks.task_number`)."},"synchronousCallFailurePolicy":{"allOf":[{"$ref":"#/components/schemas/EnterpriseCrmEventbusProtoFailurePolicy"},{"description":"Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied)."}]},"description":{"type":"string","description":"User-provided description intended to give more business context about the task."},"taskEntity":{"allOf":[{"$ref":"#/components/schemas/EnterpriseCrmFrontendsEventbusProtoTaskEntity"},{"description":"Contains a task's metadata and associated information. Next available id: 7"}]},"jsonValidationOption":{"allOf":[{"$ref":"#/components/schemas/JsonValidationOption1"},{"description":"If set, overrides the option configured in the Task implementation class."}]},"nextTasksExecutionPolicy":{"allOf":[{"$ref":"#/components/schemas/NextTasksExecutionPolicy3"},{"description":"The policy dictating the execution of the next set of tasks for the current task."}]},"position":{"allOf":[{"$ref":"#/components/schemas/EnterpriseCrmEventbusProtoCoordinate"},{"description":"Represents two-dimensional positions."}]},"taskTemplateName":{"type":"string","description":"Used to define task-template name if task is of type task-template"},"taskType":{"allOf":[{"$ref":"#/components/schemas/TaskType"},{"description":"Defines the type of the task"}]},"parameters":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/EnterpriseCrmFrontendsEventbusProtoParameterEntry"},"description":"The customized parameters the user can pass to this task."},"disableStrictTypeValidation":{"type":"boolean","description":"If this config contains a TypedTask, allow validation to succeed if an input is read from the output of another TypedTask whose output type is declared as a superclass of the requested input type. For instance, if the previous task declares an output of type Message, any task with this flag enabled will pass validation when attempting to read any proto Message type from the resultant Event parameter."},"createTime":{"type":"string","description":"Auto-generated."},"precondition":{"type":"string","description":"Optional. Standard filter expression evaluated before execution. Independent of other conditions and tasks. Can be used to enable rollout. e.g. \"rollout(5)\" will only allow 5% of incoming traffic to task."},"creatorEmail":{"type":"string","description":"The creator's email address. Auto-generated from the user's email."},"label":{"type":"string","description":"User-provided label that is attached to this TaskConfig in the UI."},"successPolicy":{"allOf":[{"$ref":"#/components/schemas/EnterpriseCrmEventbusProtoSuccessPolicy"},{"description":"Policy that dictates the behavior for the task after it completes successfully."}]},"failurePolicy":{"allOf":[{"$ref":"#/components/schemas/EnterpriseCrmEventbusProtoFailurePolicy"},{"description":"Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied)."}]},"nextTasks":{"type":"array","items":{"$ref":"#/components/schemas/EnterpriseCrmEventbusProtoNextTask"},"description":"The set of tasks that are next in line to be executed as per the execution graph defined for the parent event, specified by `event_config_id`. Each of these next tasks are executed only if the condition associated with them evaluates to true."},"taskExecutionStrategy":{"allOf":[{"$ref":"#/components/schemas/TaskExecutionStrategy1"},{"description":"The policy dictating the execution strategy of this task."}]},"preconditionLabel":{"type":"string","description":"Optional. User-provided label that is attached to precondition in the UI."},"alertConfigs":{"type":"array","items":{"$ref":"#/components/schemas/EnterpriseCrmEventbusProtoTaskAlertConfig"},"description":"Alert configurations on error rate, warning rate, number of runs, durations, etc."},"taskName":{"type":"string","description":"The name for the task."},"rollbackStrategy":{"allOf":[{"$ref":"#/components/schemas/EnterpriseCrmFrontendsEventbusProtoRollbackStrategy"},{"description":"Next available id: 4"}]},"lastModifiedTime":{"type":"string","description":"Auto-generated."},"taskSpec":{"type":"string","description":"A string template that allows user to configure task parameters (with either literal default values or tokens which will be resolved at execution time) for the task. It will eventually replace the old \"parameters\" field. Please refer to go/eventbus-task-spec-example for detailed usage example."}},"description":"The task configuration details. This is not the implementation of Task. There might be multiple TaskConfigs for the same Task. Next available id: 27"},"EnterpriseCrmEventbusProtoBaseAlertConfigErrorEnumList":{"title":"EnterpriseCrmEventbusProtoBaseAlertConfigErrorEnumList","type":"object","properties":{"filterType":{"$ref":"#/components/schemas/FilterType"},"enumStrings":{"type":"array","items":{"type":"string"},"description":""}},"description":"List of error enums for alerts."},"GoogleCloudIntegrationsV1alphaGetClientResponse":{"title":"GoogleCloudIntegrationsV1alphaGetClientResponse","type":"object","properties":{"client":{"allOf":[{"$ref":"#/components/schemas/GoogleCloudIntegrationsV1alphaClientConfig"},{"description":"The configuration information for the Client"}]}},"description":"Response for the GetClient rpc"},"EnterpriseCrmFrontendsEventbusProtoTaskEntity":{"title":"EnterpriseCrmFrontendsEventbusProtoTaskEntity","type":"object","properties":{"metadata":{"description":"Metadata inclueds the task name, author and so on."},"paramSpecs":{"description":"Declarations for inputs/outputs for a TypedTask. This is also associated with the METADATA mask."},"taskType":{"allOf":[{"$ref":"#/components/schemas/TaskType"},{"description":"Defines the type of the task"}]},"stats":{"description":"Deprecated - statistics from the Monarch query."},"uiConfig":{"description":"UI configuration for this task Also associated with the METADATA mask."},"disabledForVpcSc":{"type":"boolean","description":"True if the task has conflict with vpcsc"}},"description":"Contains a task's metadata and associated information. Next available id: 7"},"EnterpriseCrmFrontendsEventbusProtoWorkflowParameterEntry":{"title":"EnterpriseCrmFrontendsEventbusProtoWorkflowParameterEntry","type":"object","properties":{"defaultValue":{"description":"Default values for the defined keys. Each value can either be string, int, double or any proto message or a serialized object."},"jsonSchema":{"type":"string","description":"This schema will be used to validate runtime JSON-typed values of this parameter."},"attributes":{"description":"Metadata information about the parameters."},"protoDefPath":{"type":"string","description":"If the data type is of type proto or proto array, this field needs to be populated with the fully qualified proto name. This message, for example, would be \"enterprise.crm.frontends.eventbus.proto.WorkflowParameterEntry\"."},"protoDefName":{"type":"string","description":"The name of the protobuf type if the parameter has a protobuf data type."},"inOutType":{"allOf":[{"$ref":"#/components/schemas/InOutType"},{"description":"Specifies the input/output type for the parameter."}]},"isTransient":{"type":"boolean","description":"Whether this parameter is a transient parameter. go/ip-transient-parameters"},"producedBy":{"description":"The identifier of the node (TaskConfig/TriggerConfig) this parameter was produced by, if it is a transient param or a copy of an input param."},"key":{"type":"string","description":"Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the workflow definition."},"producer":{"type":"string"},"name":{"type":"string","description":"The name (without prefix) to be displayed in the UI for this parameter. E.g. if the key is \"foo.bar.myName\", then the name would be \"myName\"."},"dataType":{"allOf":[{"$ref":"#/components/schemas/DataType1"},{"description":"The data type of the parameter."}]},"children":{"type":"array","items":{},"description":"Child parameters nested within this parameter. This field only applies to protobuf parameters"}}},"EnterpriseCrmEventbusProtoExecutionTraceInfo":{"title":"EnterpriseCrmEventbusProtoExecutionTraceInfo","type":"object","properties":{"parentEventExecutionInfoId":{"type":"string","description":"Parent event execution info id that triggers the current execution through SubWorkflowExecutorTask."},"traceId":{"type":"string","description":"Used to aggregate ExecutionTraceInfo."}},"description":"Message that helps aggregate all sub-executions triggered by one execution and keeps track of child-parent relationships."},"EnterpriseCrmFrontendsEventbusProtoDoubleParameterArray":{"title":"EnterpriseCrmFrontendsEventbusProtoDoubleParameterArray","type":"object","properties":{"doubleValues":{"type":"array","items":{"type":"number"},"description":""}}},"AllowedCredentialType":{"title":"AllowedCredentialType","enum":["CREDENTIAL_TYPE_UNSPECIFIED","USERNAME_AND_PASSWORD","API_KEY","OAUTH2_AUTHORIZATION_CODE","OAUTH2_IMPLICIT","OAUTH2_CLIENT_CREDENTIALS","OAUTH2_RESOURCE_OWNER_CREDENTIALS","JWT","AUTH_TOKEN","SERVICE_ACCOUNT","CLIENT_CERTIFICATE_ONLY","OIDC_TOKEN"],"type":"string"},"AuthType":{"title":"AuthType","enum":["AUTH_TYPE_UNSPECIFIED","USER_PASSWORD","OAUTH2_JWT_BEARER","OAUTH2_CLIENT_CREDENTIALS","SSH_PUBLIC_KEY","OAUTH2_AUTH_CODE_FLOW"],"type":"string","description":"The type of authentication configured."},"BillingType":{"title":"BillingType","enum":["BILLING_TYPE_UNSPECIFIED","BILLING_TYPE_APIGEE_TRIALS","BILLING_TYPE_APIGEE_SUBSCRIPTION","BILLING_TYPE_PAYG"],"type":"string","description":"Indicates the billing type of the client"},"BorgTaskMetric":{"title":"BorgTaskMetric","enum":["BORG_TASK_METRIC_UNSPECIFIED","TASK_INDIVIDUAL_COUNT","EVENT_COUNT","EVENT_DURATION","TASK_INDIVIDUAL_DURATION"],"type":"string","description":"Required. The metric for monarch.BorgTask."},"Cardinality":{"title":"Cardinality","enum":["UNSPECIFIED","OPTIONAL"],"type":"string","description":"By default, if the cardinality is unspecified the field is considered required while mapping."},"Category":{"title":"Category","enum":["UNSPECIFIED_CATEGORY","CUSTOM","FLOW_CONTROL","DATA_MANIPULATION","SCRIPTING","CONNECTOR","HIDDEN","CLOUD_SYSTEMS","CUSTOM_TASK_TEMPLATE"],"type":"string"},"CertificateStatus":{"title":"CertificateStatus","enum":["STATE_UNSPECIFIED","ACTIVE","EXPIRED"],"type":"string","description":"Status of the certificate"},"ClientState":{"title":"ClientState","enum":["CLIENT_STATE_UNSPECIFIED","CLIENT_STATE_ACTIVE","CLIENT_STATE_DISABLED"],"type":"string","description":"Indicates the activity state the client"},"CommonErrorCode":{"title":"CommonErrorCode","enum":["COMMON_ERROR_CODE_UNSPECIFIED","INVALID_CREDENTIALS","REQUIRED_FIELDS_MISSING","INVALID_FIELDS","BACKEND","GENERAL","INTERNAL","IO_ERROR","NOT_FOUND","EVENT_BUS","ALREADY_EXISTS","CONCORD","CONVERSION","FLUME","PERMISSION","SALES_FORCE","SPANNER","UNIMPLEMENTED","RELTIO","WORKFLOW_NOT_FOUND","QUOTA_THROTTLED","QUOTA_ENQUEUED","INVALID_QUOTA_CONFIGURATION","TASK_NOT_FOUND","EXECUTION_TIMEOUT","INVALID_EVENT_EXECUTION_STATE","INVALID_ATTRIBUTE","MISSING_ATTRIBUTE","CLIENT_UNAUTHORIZED_FOR_WORKFLOW","INVALID_PARAMETER","MISSING_PARAMETER","UNAUTHROIZED_WORKFLOW_EDITOR_ACTION","FAILED_PRECONDITION","INVALID_CLIENT","MISSING_CLIENT","INVALID_WORKFLOW","MISSING_QUOTA_CONFIGURATION","UNHANDLED_TASK_ERROR","SCRIPT_TASK_RUNTIME_ERROR","RPC","INVALID_PROTO","UNHANDLED_EVENTBUS_ERROR","INVALID_TASK_STATE","TYPED_TASK_INVALID_INPUT_OPERATION","TYPED_TASK_INVALID_OUTPUT_OPERATION","VALIDATION_ERROR","RESUME_ERROR","APPS_SCRIPT_EXECUTION_ERROR","INVALID_VECTOR_USER","INFORMATICA","RETRYABLE_TASK_ERROR","INVALID_TENANT","WRONG_TENANT","INFORMATICA_BACKEND_UNAVAILABLE","RPC_PERMISSION_DENIED","SYNC_EVENTBUS_EXECUTION_TIMEOUT","ASYNC_EVENTBUS_EXECUTION_TIMEOUT","NOT_SUPPORTED_DATA_TYPE","UNSANITIZED_USER_INPUT","TRANSFORM_EXPRESSION_EVALUATION_ERROR","HTTP_EXCEPTION","EXECUTION_CANCELLED"],"type":"string"},"CredentialType":{"title":"CredentialType","enum":["CREDENTIAL_TYPE_UNSPECIFIED","USERNAME_AND_PASSWORD","API_KEY","OAUTH2_AUTHORIZATION_CODE","OAUTH2_IMPLICIT","OAUTH2_CLIENT_CREDENTIALS","OAUTH2_RESOURCE_OWNER_CREDENTIALS","JWT","AUTH_TOKEN","SERVICE_ACCOUNT","CLIENT_CERTIFICATE_ONLY","OIDC_TOKEN"],"type":"string","description":"Credential type of the encrypted credential."},"CredentialType1":{"title":"CredentialType1","enum":["CREDENTIAL_TYPE_UNSPECIFIED","USERNAME_AND_PASSWORD","API_KEY","OAUTH2_AUTHORIZATION_CODE","OAUTH2_IMPLICIT","OAUTH2_CLIENT_CREDENTIALS","OAUTH2_RESOURCE_OWNER_CREDENTIALS","JWT","AUTH_TOKEN","SERVICE_ACCOUNT","CLIENT_CERTIFICATE_ONLY","OIDC_TOKEN"],"type":"string","description":"Credential type associated with auth config."},"DatabasePersistencePolicy":{"title":"DatabasePersistencePolicy","enum":["DATABASE_PERSISTENCE_POLICY_UNSPECIFIED","DATABASE_PERSISTENCE_DISABLED"],"type":"string","description":"Optional. Flag to disable database persistence for execution data, including event execution info, execution export info, execution metadata index and execution param index."},"DataType":{"title":"DataType","enum":["DATA_TYPE_UNSPECIFIED","STRING_VALUE","INT_VALUE","DOUBLE_VALUE","BOOLEAN_VALUE","PROTO_VALUE","SERIALIZED_OBJECT_VALUE","STRING_ARRAY","INT_ARRAY","DOUBLE_ARRAY","PROTO_ARRAY","PROTO_ENUM","BOOLEAN_ARRAY","PROTO_ENUM_ARRAY","BYTES","BYTES_ARRAY","NON_SERIALIZABLE_OBJECT","JSON_VALUE"],"type":"string","description":"Explicitly getting the type of the parameter."},"DataType1":{"title":"DataType1","enum":["DATA_TYPE_UNSPECIFIED","STRING_VALUE","INT_VALUE","DOUBLE_VALUE","BOOLEAN_VALUE","PROTO_VALUE","SERIALIZED_OBJECT_VALUE","STRING_ARRAY","INT_ARRAY","DOUBLE_ARRAY","PROTO_ARRAY","PROTO_ENUM","BOOLEAN_ARRAY","PROTO_ENUM_ARRAY","BYTES","BYTES_ARRAY","NON_SERIALIZABLE_OBJECT","JSON_VALUE"],"type":"string","description":"The data type of the parameter."},"DataType2":{"title":"DataType2","enum":["DATA_TYPE_UNSPECIFIED","EMAIL","URL","CURRENCY","TIMESTAMP","DOMAIN_NAME"],"type":"string","description":"Things like URL, Email, Currency, Timestamp (rather than string, int64...)"},"DataType3":{"title":"DataType3","enum":["INTEGRATION_PARAMETER_DATA_TYPE_UNSPECIFIED","STRING_VALUE","INT_VALUE","DOUBLE_VALUE","BOOLEAN_VALUE","STRING_ARRAY","INT_ARRAY","DOUBLE_ARRAY","BOOLEAN_ARRAY","JSON_VALUE","PROTO_VALUE","PROTO_ARRAY"],"type":"string","description":"Type of the parameter."},"DefaultJsonValidationOption":{"title":"DefaultJsonValidationOption","enum":["UNSPECIFIED_JSON_VALIDATION_OPTION","SKIP","PRE_EXECUTION","POST_EXECUTION","PRE_POST_EXECUTION"],"type":"string","description":"Controls whether JSON workflow parameters are validated against provided schemas before and/or after this task's execution."},"ElementType":{"title":"ElementType","enum":["UNKNOWN_TYPE","TASK_CONFIG","TRIGGER_CONFIG"],"type":"string","description":"Destination node where the edge ends. It can only be a task config."},"EnumFilterType":{"title":"EnumFilterType","enum":["DEFAULT_INCLUSIVE","EXCLUSIVE"],"type":"string","description":"Whether to include or exclude the enums matching the regex."},"EventExecutionState":{"title":"EventExecutionState","enum":["UNSPECIFIED","ON_HOLD","IN_PROCESS","SUCCEEDED","FAILED","CANCELED","RETRY_ON_HOLD","SUSPENDED"],"type":"string"},"EventExecutionState1":{"title":"EventExecutionState1","enum":["UNSPECIFIED","ON_HOLD","IN_PROCESS","SUCCEEDED","FAILED","CANCELED","RETRY_ON_HOLD","SUSPENDED"],"type":"string","description":"The execution state of this event."},"ExecutionMethod":{"title":"ExecutionMethod","enum":["EXECUTION_METHOD_UNSPECIFIED","POST","POST_TO_QUEUE","SCHEDULE"],"type":"string","description":"The ways user posts this event."},"ExternalCategory":{"title":"ExternalCategory","enum":["UNSPECIFIED_EXTERNAL_CATEGORY","CORE","CONNECTORS"],"type":"string"},"FailureLocation":{"title":"FailureLocation","enum":["UNKNOWN","SUBWORKFLOW","PARAM_OVERRIDING","PARAM_AGGREGATING","SETTING_ITERATION_ELEMENT","GETTING_LIST_TO_ITERATE","CONDITION_EVALUATION","BUILDING_REQUEST"],"type":"string","description":"Indicates where in the loop logic did it error out."},"FieldType":{"title":"FieldType","enum":["DATA_TYPE_UNSPECIFIED","STRING_VALUE","INT_VALUE","DOUBLE_VALUE","BOOLEAN_VALUE","PROTO_VALUE","SERIALIZED_OBJECT_VALUE","STRING_ARRAY","INT_ARRAY","DOUBLE_ARRAY","PROTO_ARRAY","PROTO_ENUM","BOOLEAN_ARRAY","PROTO_ENUM_ARRAY","BYTES","BYTES_ARRAY","NON_SERIALIZABLE_OBJECT","JSON_VALUE"],"type":"string","description":"Specifies the data type of the field."},"FileFormat":{"title":"FileFormat","enum":["FILE_FORMAT_UNSPECIFIED","JSON","YAML"],"type":"string","description":"File format for upload request."},"FilterType":{"title":"FilterType","enum":["DEFAULT_INCLUSIVE","EXCLUSIVE"],"type":"string"},"FinalState":{"title":"FinalState","enum":["UNSPECIFIED","SUCCEEDED","SUSPENDED"],"type":"string","description":"State to which the execution snapshot status will be set if the task succeeds."},"FinalState1":{"title":"FinalState1","enum":["FINAL_STATE_UNSPECIFIED","SUCCEEDED","SUSPENDED"],"type":"string","description":"State to which the execution snapshot status will be set if the task succeeds."},"FunctionName":{"title":"FunctionName","enum":["UNSPECIFIED","GET_STRING_SUBFIELD","GET_INT_SUBFIELD","GET_DOUBLE_SUBFIELD","GET_BOOLEAN_SUBFIELD","GET_STRING_ARRAY_SUBFIELD","GET_INT_ARRAY_SUBFIELD","GET_DOUBLE_ARRAY_SUBFIELD","GET_BOOLEAN_ARRAY_SUBFIELD","GET_PROTO_ARRAY_SUBFIELD","GET_PROTO_SUBFIELD","TO_JSON","GET_BYTES_SUBFIELD_AS_UTF_8_STRING","GET_BYTES_SUBFIELD_AS_PROTO","EQUALS"],"type":"string"},"FunctionName1":{"title":"FunctionName1","enum":["UNSPECIFIED","GET","APPEND","SIZE","SUM","AVG","MAX","MIN","TO_SET","APPEND_ALL","TO_JSON","SET","REMOVE","REMOVE_AT","CONTAINS","FOR_EACH","FILTER"],"type":"string"},"FunctionName2":{"title":"FunctionName2","enum":["UNSPECIFIED","ADD","SUBTRACT","MULTIPLY","DIVIDE","EXPONENT","GREATER_THAN_EQUAL_TO","GREATER_THAN","LESS_THAN_EQUAL_TO","LESS_THAN","TO_DOUBLE","TO_STRING","EQUALS","TO_JSON","MOD","EPOCH_TO_HUMAN_READABLE_TIME"],"type":"string"},"FunctionName3":{"title":"FunctionName3","enum":["UNSPECIFIED","GET","APPEND","SIZE","TO_SET","APPEND_ALL","TO_JSON","SET","REMOVE","REMOVE_AT","CONTAINS","FOR_EACH","FILTER"],"type":"string"},"FunctionName5":{"title":"FunctionName5","enum":["UNSPECIFIED","NOW_IN_MILLIS","INT_LIST","ENVIRONMENT","GET_EXECUTION_ID","GET_INTEGRATION_NAME","GET_REGION","GET_UUID","GET_PROJECT_ID"],"type":"string"},"FunctionName6":{"title":"FunctionName6","enum":["UNSPECIFIED","TO_JSON","NOT","AND","NAND","OR","XOR","NOR","XNOR","TO_STRING","EQUALS"],"type":"string"},"FunctionName8":{"title":"FunctionName8","enum":["UNSPECIFIED","GET_PROPERTY","GET_ELEMENT","APPEND_ELEMENT","SIZE","SET_PROPERTY","FLATTEN","FLATTEN_ONCE","MERGE","TO_STRING","TO_INT","TO_DOUBLE","TO_BOOLEAN","TO_PROTO","TO_STRING_ARRAY","TO_INT_ARRAY","TO_DOUBLE_ARRAY","TO_PROTO_ARRAY","TO_BOOLEAN_ARRAY","REMOVE_PROPERTY","RESOLVE_TEMPLATE","EQUALS","FOR_EACH","FILTER_ELEMENTS"],"type":"string"},"FunctionName9":{"title":"FunctionName9","enum":["UNSPECIFIED","CONCAT","TO_UPPERCASE","TO_LOWERCASE","CONTAINS","SPLIT","LENGTH","EQUALS","TO_INT","TO_DOUBLE","TO_BOOLEAN","TO_BASE_64","TO_JSON","EQUALS_IGNORE_CASE","REPLACE_ALL","SUBSTRING","RESOLVE_TEMPLATE"],"type":"string"},"FunctionName10":{"title":"FunctionName10","enum":["UNSPECIFIED","TO_JSON","TO_STRING","ADD","SUBTRACT","MULTIPLY","DIVIDE","EXPONENT","ROUND","FLOOR","CEIL","GREATER_THAN","LESS_THAN","EQUALS","GREATER_THAN_EQUALS","LESS_THAN_EQUALS","MOD"],"type":"string"},"InOutType":{"title":"InOutType","enum":["IN_OUT_TYPE_UNSPECIFIED","IN","OUT","IN_OUT"],"type":"string","description":"Specifies the input/output type for the parameter."},"InputDisplayOption":{"title":"InputDisplayOption","enum":["DEFAULT","STRING_MULTI_LINE","NUMBER_SLIDER","BOOLEAN_TOGGLE"],"type":"string"},"InputOutputType":{"title":"InputOutputType","enum":["IN_OUT_TYPE_UNSPECIFIED","IN","OUT","IN_OUT"],"type":"string","description":"Specifies the input/output type for the parameter."},"IpEnablementState":{"title":"IpEnablementState","enum":["IP_ENABLEMENT_STATE_UNSPECIFIED","IP_ENABLEMENT_STATE_STANDALONE","IP_ENABLEMENT_STATE_APIGEE","IP_ENABLEMENT_STATE_APIGEE_ENTITLED"],"type":"string","description":"An enum value of what the enablement state is for the given project"},"JsonValidationOption":{"title":"JsonValidationOption","enum":["JSON_VALIDATION_OPTION_UNSPECIFIED","SKIP","PRE_EXECUTION","POST_EXECUTION","PRE_POST_EXECUTION"],"type":"string","description":"Optional. If set, overrides the option configured in the Task implementation class."},"JsonValidationOption1":{"title":"JsonValidationOption1","enum":["UNSPECIFIED_JSON_VALIDATION_OPTION","SKIP","PRE_EXECUTION","POST_EXECUTION","PRE_POST_EXECUTION"],"type":"string","description":"If set, overrides the option configured in the Task implementation class."},"KeyType":{"title":"KeyType","enum":["DATA_TYPE_UNSPECIFIED","STRING_VALUE","INT_VALUE","DOUBLE_VALUE","BOOLEAN_VALUE","PROTO_VALUE","SERIALIZED_OBJECT_VALUE","STRING_ARRAY","INT_ARRAY","DOUBLE_ARRAY","PROTO_ARRAY","PROTO_ENUM","BOOLEAN_ARRAY","PROTO_ENUM_ARRAY","BYTES","BYTES_ARRAY","NON_SERIALIZABLE_OBJECT","JSON_VALUE"],"type":"string","description":"Option to specify key value type for all entries of the map. If provided then field types for all entries must conform to this."},"KeyType1":{"title":"KeyType1","enum":["INTEGRATION_PARAMETER_DATA_TYPE_UNSPECIFIED","STRING_VALUE","INT_VALUE","DOUBLE_VALUE","BOOLEAN_VALUE","STRING_ARRAY","INT_ARRAY","DOUBLE_ARRAY","BOOLEAN_ARRAY","JSON_VALUE","PROTO_VALUE","PROTO_ARRAY"],"type":"string","description":"Option to specify key type for all entries of the map. If provided then field types for all entries must conform to this."},"LogAction":{"title":"LogAction","enum":["LOG_ACTION_UNSPECIFIED","DONT_LOG","LOG"],"type":"string"},"LogType":{"title":"LogType","enum":["LOG_TYPE_UNSPECIFIED","GWS","GTS","ALL"],"type":"string"},"MetricType":{"title":"MetricType","enum":["METRIC_TYPE_UNSPECIFIED","TASK_ERROR_RATE","TASK_WARNING_RATE","TASK_RATE","TASK_AVERAGE_DURATION","TASK_PERCENTILE_DURATION"],"type":"string"},"MetricType1":{"title":"MetricType1","enum":["METRIC_TYPE_UNSPECIFIED","EVENT_ERROR_RATE","EVENT_WARNING_RATE","TASK_ERROR_RATE","TASK_WARNING_RATE","TASK_RATE","EVENT_RATE","EVENT_AVERAGE_DURATION","EVENT_PERCENTILE_DURATION","TASK_AVERAGE_DURATION","TASK_PERCENTILE_DURATION"],"type":"string"},"MetricType2":{"title":"MetricType2","enum":["METRIC_TYPE_UNSPECIFIED","EVENT_ERROR_RATE","EVENT_WARNING_RATE","TASK_ERROR_RATE","TASK_WARNING_RATE","TASK_RATE","EVENT_RATE","EVENT_AVERAGE_DURATION","EVENT_PERCENTILE_DURATION","TASK_AVERAGE_DURATION","TASK_PERCENTILE_DURATION"],"type":"string","description":"The type of metric."},"ModuleId":{"title":"ModuleId","enum":["UNSPECIFIED_TASK_MODULE","LABEL","ERROR_HANDLING","TASK_PARAM_TABLE","TASK_PARAM_FORM","PRECONDITION","SCRIPT_EDITOR","RPC","TASK_SUMMARY","SUSPENSION","RPC_TYPED","SUB_WORKFLOW","APPS_SCRIPT_NAVIGATOR","SUB_WORKFLOW_FOR_EACH_LOOP","FIELD_MAPPING","README","REST_CALLER","SUB_WORKFLOW_SCATTER_GATHER","CLOUD_SQL","GENERIC_CONNECTOR_TASK"],"type":"string","description":"ID of the config module."},"NextTasksExecutionPolicy":{"title":"NextTasksExecutionPolicy","enum":["UNSPECIFIED","RUN_ALL_MATCH","RUN_FIRST_MATCH"],"type":"string","description":"Dictates how next tasks will be executed."},"NextTasksExecutionPolicy1":{"title":"NextTasksExecutionPolicy1","enum":["NEXT_TASKS_EXECUTION_POLICY_UNSPECIFIED","RUN_ALL_MATCH","RUN_FIRST_MATCH"],"type":"string","description":"Optional. The policy dictating the execution of the next set of tasks for the current task."},"NextTasksExecutionPolicy2":{"title":"NextTasksExecutionPolicy2","enum":["NEXT_TASKS_EXECUTION_POLICY_UNSPECIFIED","RUN_ALL_MATCH","RUN_FIRST_MATCH"],"type":"string","description":"Optional. Dictates how next tasks will be executed."},"NextTasksExecutionPolicy3":{"title":"NextTasksExecutionPolicy3","enum":["UNSPECIFIED","RUN_ALL_MATCH","RUN_FIRST_MATCH"],"type":"string","description":"The policy dictating the execution of the next set of tasks for the current task."},"Operation":{"title":"Operation","enum":["OPERATION_UNSPECIFIED","EXECUTE_ACTION","LIST_ENTITIES","GET_ENTITY","CREATE_ENTITY","UPDATE_ENTITY","DELETE_ENTITY"],"type":"string","description":"Operation to perform using the configured connection."},"OperationType":{"title":"OperationType","enum":["OPERATION_TYPE_UNSPECIFIED","UNION","JOIN"],"type":"string","description":"Optional. optional operation types."},"Operator":{"title":"Operator","enum":["UNSET","EQUALS","CONTAINS","LESS_THAN","GREATER_THAN","EXISTS","DOES_NOT_EXIST","IS_EMPTY","IS_NOT_EMPTY"],"type":"string","description":"Operator used to evaluate the condition. Please note that an operator with an inappropriate key/value operand will result in IllegalArgumentException, e.g. CONTAINS with boolean key/value pair."},"Origin":{"title":"Origin","enum":["UNSPECIFIED","UI","PIPER_V2","PIPER_V3","APPLICATION_IP_PROVISIONING"],"type":"string","description":"Optional. The origin that indicates where this integration is coming from."},"ParameterNameOption":{"title":"ParameterNameOption","enum":["DEFAULT_NOT_PARAMETER_NAME","IS_PARAMETER_NAME","KEY_IS_PARAMETER_NAME","VALUE_IS_PARAMETER_NAME"],"type":"string"},"PostMethod":{"title":"PostMethod","enum":["UNSPECIFIED","POST","POST_TO_QUEUE","SCHEDULE","POST_BY_EVENT_CONFIG_ID","POST_WITH_EVENT_DETAILS"],"type":"string","description":"The ways user posts this event."},"Priority":{"title":"Priority","enum":["UNSPCIFIED","SHEDDABLE","SHEDDABLE_PLUS","CRITICAL","CRITICAL_PLUS"],"type":"string","description":"The request priority this request should be processed at. For internal users:"},"Privacy":{"title":"Privacy","enum":["PRIVACY_TYPE_UNSPECIFIED","NOT_PII","PII","SPII","UNSURE"],"type":"string"},"Product":{"title":"Product","enum":["UNSPECIFIED_PRODUCT","IP","APIGEE","SECURITY"],"type":"string","description":"Which Google product the execution_info belongs to. If not set, the execution_info belongs to Integration Platform by default."},"Product1":{"title":"Product1","enum":["UNSPECIFIED_PRODUCT","IP","APIGEE","SECURITY"],"type":"string","description":"Which Google product the suspension belongs to. If not set, the suspension belongs to Integration Platform by default."},"RequestType":{"title":"RequestType","enum":["REQUEST_TYPE_UNSPECIFIED","REQUEST_BODY","QUERY_PARAMETERS","ENCODED_HEADER"],"type":"string","description":"Represent how to pass parameters to fetch access token"},"ResponseTemplate":{"title":"ResponseTemplate","enum":["DATA_FORMAT_UNSPECIFIED","TABLE_CONFIG","APLOSE_SERIES_LIST_CONFIG"],"type":"string","description":"Required. Template for response."},"RetryAttempt":{"title":"RetryAttempt","enum":["UNSPECIFIED","FINAL","RETRYABLE","CANCELED"],"type":"string"},"RetryStrategy":{"title":"RetryStrategy","enum":["RETRY_STRATEGY_UNSPECIFIED","IGNORE","NONE","FATAL","FIXED_INTERVAL","LINEAR_BACKOFF","EXPONENTIAL_BACKOFF","RESTART_INTEGRATION_WITH_BACKOFF"],"type":"string","description":"Defines what happens to the task upon failure."},"RetryStrategy1":{"title":"RetryStrategy1","enum":["UNSPECIFIED","IGNORE","NONE","FATAL","FIXED_INTERVAL","LINEAR_BACKOFF","EXPONENTIAL_BACKOFF","RESTART_WORKFLOW_WITH_BACKOFF"],"type":"string","description":"Defines what happens to the task upon failure."},"SanitizeType":{"title":"SanitizeType","enum":["SANITIZE_TYPE_UNSPECIFIED","SCRUB","ANONYMIZE","ANONYMIZE_LIMITED_REPEATABLE","OBFUSCATE","ENCRYPT","DO_NOT_SANITIZE"],"type":"string"},"Searchable":{"title":"Searchable","enum":["UNSPECIFIED",true,false],"type":"string"},"SeedPeriod":{"title":"SeedPeriod","enum":["SEED_PERIOD_UNSPECIFIED","DAY","WEEK","MONTH"],"type":"string"},"SeedScope":{"title":"SeedScope","enum":["SEED_SCOPE_UNSPECIFIED","EVENT_NAME","TIME_PERIOD","PARAM_NAME"],"type":"string"},"Severity":{"title":"Severity","enum":["SEVERITY_UNSPECIFIED","ERROR","WARN","INFO"],"type":"string","description":"The severity of the error: ERROR|WARN|INFO."},"ShortenerType":{"title":"ShortenerType","enum":["SHORTENER_TYPE_UNSPECIFIED","SHORTEN","HASH","SHORTEN_WITH_HASH","SHORTEN_EMAIL","SHORTEN_EMAIL_WITH_HASH","SHORTEN_DOMAIN"],"type":"string"},"Source":{"title":"Source","enum":["SOURCE_UNSPECIFIED","APIGEE","SECURITY"],"type":"string","description":"LINT.ThenChange(//depot/google3/enterprise/crm/eventbus/proto/product.proto:product, //depot/google3/java/com/google/enterprise/crm/integrationplatform/api/utils/ConverterUtils.java:source_to_product)"},"State":{"title":"State","enum":["INTEGRATION_STATE_UNSPECIFIED","DRAFT","ACTIVE","ARCHIVED","SNAPSHOT"],"type":"string","description":"Output only. User should not set it as an input."},"State1":{"title":"State1","enum":["STATE_UNSPECIFIED","PENDING","PROCESSING","SUCCEEDED","FAILED","CANCELLED","RETRY_ON_HOLD","SUSPENDED"],"type":"string","description":"Status of the execution."},"State2":{"title":"State2","enum":["RESOLUTION_STATE_UNSPECIFIED","PENDING","REJECTED","LIFTED"],"type":"string","description":"Required. State of this suspension, indicating what action a resolver has taken."},"State3":{"title":"State3","enum":["STATE_UNSPECIFIED","VALID","INVALID","SOFT_DELETED","EXPIRED","UNAUTHORIZED","UNSUPPORTED"],"type":"string","description":"The status of the auth config."},"State4":{"title":"State4","enum":["STATE_UNSPECIFIED","CREATING","ACTIVE","INACTIVE","DELETING","UPDATING","ERROR"],"type":"string","description":"State."},"Status":{"title":"Status","enum":["UNKNOWN","DRAFT","ACTIVE","ARCHIVED","SNAPSHOT"],"type":"string","description":"Output only. Generated by eventbus. User should not set it as an input."},"Status1":{"title":"Status1","enum":["UNSPECIFIED_STATUS","DEFAULT_INACTIVE","ACTIVE"],"type":"string","description":"Allows author to indicate if the task is ready to use or not. If not set, then it will default to INACTIVE."},"Status2":{"title":"Status2","enum":["PENDING_UNSPECIFIED","REJECTED","LIFTED"],"type":"string"},"System":{"title":"System","enum":["UNSPECIFIED_SYSTEM","GENERIC","BUGANIZER","SALESFORCE","CLOUD_SQL","PLX","SHEETS","GOOGLE_GROUPS","EMAIL","SPANNER","DATA_BRIDGE"],"type":"string"},"TaskExecutionState":{"title":"TaskExecutionState","enum":["UNSPECIFIED","PENDING_EXECUTION","IN_PROCESS","SUCCEED","FAILED","FATAL","RETRY_ON_HOLD","SKIPPED","CANCELED","PENDING_ROLLBACK","ROLLBACK_IN_PROCESS","ROLLEDBACK","SUSPENDED"],"type":"string"},"TaskExecutionState1":{"title":"TaskExecutionState1","enum":["TASK_EXECUTION_STATE_UNSPECIFIED","PENDING_EXECUTION","IN_PROCESS","SUCCEED","FAILED","FATAL","RETRY_ON_HOLD","SKIPPED","CANCELLED","PENDING_ROLLBACK","ROLLBACK_IN_PROCESS","ROLLEDBACK","SUSPENDED"],"type":"string","description":"The execution state of this task."},"TaskExecutionStrategy":{"title":"TaskExecutionStrategy","enum":["TASK_EXECUTION_STRATEGY_UNSPECIFIED","WHEN_ALL_SUCCEED","WHEN_ANY_SUCCEED","WHEN_ALL_TASKS_AND_CONDITIONS_SUCCEED"],"type":"string","description":"Optional. The policy dictating the execution strategy of this task."},"TaskExecutionStrategy1":{"title":"TaskExecutionStrategy1","enum":["WHEN_ALL_SUCCEED","WHEN_ANY_SUCCEED","WHEN_ALL_TASKS_AND_CONDITIONS_SUCCEED"],"type":"string","description":"The policy dictating the execution strategy of this task."},"TaskType":{"title":"TaskType","enum":["TASK","ASIS_TEMPLATE","IO_TEMPLATE"],"type":"string","description":"Defines the type of the task"},"ThresholdType":{"title":"ThresholdType","enum":["UNSPECIFIED_THRESHOLD_TYPE","EXPECTED_MIN","EXPECTED_MAX"],"type":"string","description":"The threshold type for which this alert is being configured. If value falls below expected_min or exceeds expected_max, an alert will be fired."},"ThresholdType1":{"title":"ThresholdType1","enum":["UNSPECIFIED_THRESHOLD_TYPE","EXPECTED_MIN","EXPECTED_MAX"],"type":"string","description":"The threshold type, whether lower(expected_min) or upper(expected_max), for which this alert is being configured. If value falls below expected_min or exceeds expected_max, an alert will be fired."},"ThresholdType2":{"title":"ThresholdType2","enum":["THRESHOLD_TYPE_UNSPECIFIED","EXPECTED_MIN","EXPECTED_MAX"],"type":"string","description":"The threshold type, whether lower(expected_min) or upper(expected_max), for which this alert is being configured. If value falls below expected_min or exceeds expected_max, an alert will be fired."},"TriggerType":{"title":"TriggerType","enum":["UNKNOWN","CLOUD_PUBSUB","GOOPS","SFDC_SYNC","CRON","API","MANIFOLD_TRIGGER","DATALAYER_DATA_CHANGE","SFDC_CHANNEL","CLOUD_PUBSUB_EXTERNAL","SFDC_CDC_CHANNEL","SFDC_PLATFORM_EVENTS_CHANNEL","CLOUD_SCHEDULER"],"type":"string"},"TriggerType1":{"title":"TriggerType1","enum":["TRIGGER_TYPE_UNSPECIFIED","CRON","API","SFDC_CHANNEL","CLOUD_PUBSUB_EXTERNAL","SFDC_CDC_CHANNEL","CLOUD_SCHEDULER"],"type":"string","description":"Optional. Type of trigger"},"ValueType":{"title":"ValueType","enum":["DATA_TYPE_UNSPECIFIED","STRING_VALUE","INT_VALUE","DOUBLE_VALUE","BOOLEAN_VALUE","PROTO_VALUE","SERIALIZED_OBJECT_VALUE","STRING_ARRAY","INT_ARRAY","DOUBLE_ARRAY","PROTO_ARRAY","PROTO_ENUM","BOOLEAN_ARRAY","PROTO_ENUM_ARRAY","BYTES","BYTES_ARRAY","NON_SERIALIZABLE_OBJECT","JSON_VALUE"],"type":"string"},"ValueType1":{"title":"ValueType1","enum":["INTEGRATION_PARAMETER_DATA_TYPE_UNSPECIFIED","STRING_VALUE","INT_VALUE","DOUBLE_VALUE","BOOLEAN_VALUE","STRING_ARRAY","INT_ARRAY","DOUBLE_ARRAY","BOOLEAN_ARRAY","JSON_VALUE","PROTO_VALUE","PROTO_ARRAY"],"type":"string","description":"Option to specify value type for all entries of the map. If provided then field types for all entries must conform to this."},"Visibility":{"title":"Visibility","enum":["AUTH_CONFIG_VISIBILITY_UNSPECIFIED","PRIVATE","CLIENT_VISIBLE"],"type":"string","description":"The visibility of the auth config."}},"securitySchemes":{"httpBearer":{"type":"http","scheme":"bearer"}}},"security":[{"httpBearer":[]}],"tags":[{"name":"appsScriptProjects","description":""},{"name":"sfdcChannels","description":""},{"name":"sfdcInstances","description":""},{"name":"executionsnapshots","description":""},{"name":"versions","description":""},{"name":"suspensions","description":""},{"name":"executions","description":""},{"name":"integrations","description":""},{"name":"cloudFunctions","description":""},{"name":"authConfigs","description":""},{"name":"certificates","description":""},{"name":"products","description":""},{"name":"runtimeActionSchemas","description":""},{"name":"runtimeEntitySchemas","description":""},{"name":"connections","description":""},{"name":"clients","description":""},{"name":"locations","description":""},{"name":"projects","description":""},{"name":"callback","description":""},{"name":"connectorPlatformRegions","description":""}]}
/ v1 / {parent} / appsScriptProjects
/ v1 / {parent} / appsScriptProjects:link
/ v1 / {name}
/ v1 / {parent} / sfdcChannels
/ v1 / {parent} / sfdcInstances
/ v1 / {parent} / executionsnapshots
/ v1 / {name}:publish
/ v1 / {name}:updateBundle
/ v1 / {name}:getBundle
/ v1 / {parent} / versions
/ v1 / {parent} / versions:upload
/ v1 / {name}:archive
/ v1 / {name}:download
/ v1 / {name}:validate
/ v1 / {integrationVersion}:takeoverEditLock
/ v1 / {name}:unpublish
/ v1 / {name}:deactivate
/ v1 / {name}:lift
/ v1 / {parent} / suspensions
/ v1 / {name}:resolve
/ v1 / {name}:cancel
/ v1 / {parent} / executions
/ v1 / {name}:schedule
/ v1 / {name}:archiveBundle
/ v1 / {name}:test
/ v1 / {parent}:monitorexecutionstats
/ v1 / {name}:execute
/ v1 / {parent} / integrations
/ v1 / {parent} / cloudFunctions
/ v1 / {parent} / authConfigs
/ v1 / {parent} / certificates
/ v1 / {parent}:createBundle
/ v1 / {parent}:listTaskEntities
/ v1 / {parent} / runtimeActionSchemas
/ v1 / {parent} / runtimeEntitySchemas
/ v1 / {parent} / connections
/ v1 / {parent} / clients:provision
/ v1 / {parent} / clients:deprovision
/ v1 / {parent} / clients
/ v1 / {parent} / clientmetadata
/ v1 / callback:generateToken
/ v1 / connectorPlatformRegions:enumerate
No API Resources

(Product) (Docs)

---

{"class":["gateway"],"properties":{"name":"Axway","provider":"Axway","slug":"axway","rating":1,"license":"Proprietary","status":"Pending Review","researchDate":"2022-11","description":"Axway Software is a French-American publicly held information technology company that provides software tools for enterprise software, enterprise application integration, business activity monitoring, business analytics, mobile application development and web API management.\n","platformCapabilities":["Design","Gateway","Analytics","Portal","Documentation","Monetization","Monitoring","SDK","Threat Protection"],"gatewayCapabilities":["Custom Code Execution","Mediation","Mocking","OpenAPI Integration","OpenAPI Linting","Protocol Transformation","Traffic Management","Versioning"],"customCodeSupport":["None"],"upstreamProtocols":["HTTP/1.1","SOAP","WebSockets","FTP","SQL"],"downstreamProtocols":["HTTP/1.1","SOAP","WebSockets"],"deliveryModels":["Customer Managed (Cloud)","Customer Managed (On-Premises)","Hybrid","SaaS"],"policies":[{"category":"Traffic Management","capabilities":["Cache Eviction","Cache Invalidation","Cache Lookup","Cache Population","Cache Storage","Cache Target Response","Cache Validation","Dynamic Routing","Load Balancer Routing","Mocking","Quota","Quota Reset","Rate Limiting","Rate Limiting (Dynamic)","Request Size Limiting","Throttling","Traffic Optimization"]},{"category":"Mediation","capabilities":["CORS","Cache Eviction","Cache Lookup","Cache Store","Context Persistence","Custom Data Storage","Custom Exception Handling","JSON Validation","Redaction","Request Size Limit","Request Termination","Request Transformation","Response Transformation","SOAP Validation","URL Rewriting","XML to JSON","XSL Tranformations","XSL Transformation"]},{"category":"Security","capabilities":["Auth0","API Key","API Key Authentication","AWS IAM roles and policies","Access Control Lists (ACL)","Audit Logs","Basic Authentication","CORS","Custom Credentials","HMAC","IP Access Rules","JWT Validation","JWT authorizers","JWT authorizers (Custom","Kerberos","LDAP","LDAP Authentication","Message Inspection","Mutual TLS","OAuth 1.0","OAuth 2.0","Okta","OpenID Connect","PingFederate OAuth2.0 Token","SAML Assertion","SLA Management","WAF"]},{"category":"Extensions","capabilities":["HTTP Callout","HTTP integrations"]}]},"links":[{"rel":["urn:gateway:product"],"title":"Product","href":"https://docs.axway.com/bundle/axway-open-docs/page/docs/api_mgmt_overview/api_mgmt_components/apigateway/index.html"},{"rel":["urn:gateway:docs"],"title":"Documentation","href":"https://docs.axway.com/bundle/axway-open-docs/page/docs/api_mgmt_overview/api_mgmt_components/apigateway/index.html"},{"rel":["urn:gateway:logo"],"title":"Logo","href":"/images/gateways/name.svg"},{"rel":["urn:gateway:screenshot"],"title":"Screenshot","href":"https://kinlane-productions2.s3.amazonaws.com/api-gateways/axway.png"}]}

Axway

Axway Software is a French-American publicly held information technology company that provides software tools for enterprise software, enterprise application integration, business activity monitoring, business analytics, mobile application development and web API management.

Platform Capabilities

These are the wider capabilities beyond the gateway they offer.

• Design
• Gateway
• Analytics
• Portal
• Documentation
• Monetization
• Monitoring
• SDK
• Threat Protection

Gateway Capabilities

These are the capabilities the gateway supports.

• Custom Code Execution
• Mediation
• Mocking
• OpenAPI Integration
• OpenAPI Linting
• Protocol Transformation
• Traffic Management
• Versioning

Upstream Protocols

The different protocols they support upstream.

• HTTP/1.1
• SOAP
• WebSockets
• FTP
• SQL

Downtream Protocols

The different protocols they support downstream.

• HTTP/1.1
• SOAP
• WebSockets

Custom Code

If they offer plugin, extension, and custom coding options.

• None

Delivery Models

These are they ways you can deliver this solution.

• Customer Managed (Cloud)
• Customer Managed (On-Premises)
• Hybrid
• SaaS

Policies

These are the policies available across the gateway capabilities.

Traffic Management

• Cache Eviction
• Cache Invalidation
• Cache Lookup
• Cache Population
• Cache Storage
• Cache Target Response
• Cache Validation
• Dynamic Routing
• Load Balancer Routing
• Mocking
• Quota
• Quota Reset
• Rate Limiting
• Rate Limiting (Dynamic)
• Request Size Limiting
• Throttling
• Traffic Optimization

Mediation

• CORS
• Cache Eviction
• Cache Lookup
• Cache Store
• Context Persistence
• Custom Data Storage
• Custom Exception Handling
• JSON Validation
• Redaction
• Request Size Limit
• Request Termination
• Request Transformation
• Response Transformation
• SOAP Validation
• URL Rewriting
• XML to JSON
• XSL Tranformations
• XSL Transformation

Security

• Auth0
• API Key
• API Key Authentication
• AWS IAM roles and policies
• Access Control Lists (ACL)
• Audit Logs
• Basic Authentication
• CORS
• Custom Credentials
• HMAC
• IP Access Rules
• JWT Validation
• JWT authorizers
• JWT authorizers (Custom
• Kerberos
• LDAP
• LDAP Authentication
• Message Inspection
• Mutual TLS
• OAuth 1.0
• OAuth 2.0
• Okta
• OpenID Connect
• PingFederate OAuth2.0 Token
• SAML Assertion
• SLA Management
• WAF

Extensions

• HTTP Callout
• HTTP integrations

API Resources

API Manager API v1.3 OpenAPI	{"openapi":"3.0.1","info":{"title":"API Manager API v1.3","description":"Version 1.3 of the API Manager Rest API","contact":{"email":"support@axway.com"},"license":{"name":"Copyright Axway 2020. All rights reserved."},"version":"1.3"},"servers":[{"url":"https://localhost:8075/api/portal/v1.3"}],"paths":{"/applications/oauthclient/{clientId}":{"get":{"tags":["Applications"],"summary":"Get an application associated with an OAuth Client ID","description":"Retrieves the application associated with an OAuth Client ID","operationId":"appFromOAuthClient_1","parameters":[{"name":"clientId","in":"path","description":"The OAuth Client ID associated with the Application.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Application"}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}}}},"/applications/{id}/apis/{apiAccessId}/approve":{"post":{"tags":["Applications"],"summary":"Creates an API access request to an API for an application.","description":"Approving user must be API Manager Administrator or an Organization Administrator of the application's organization with the correct privileges to approve API access requests.","operationId":"approveApiAccess_1","parameters":[{"name":"id","in":"path","description":"The application ID.","required":true,"schema":{"type":"string"}},{"name":"apiAccessId","in":"path","description":"The API access ID.","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"Created"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/applications/{id}/approve":{"post":{"tags":["Applications"],"summary":"Approves a pending application request","description":"Approving user must be API Manager Administrator or an Organization Administrator of the application's organization with the correct privileges to approve new application requests.","operationId":"approveApp_1","parameters":[{"name":"id","in":"path","description":"The application request ID.","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"Created"},"400":{"description":"Bad Request"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}}}},"/applications/{id}/apikeys":{"get":{"tags":["Applications"],"summary":"Returns the API Keys associated with an application","description":"Returns the API Keys associated with an application.","operationId":"getApiKeysForAppID_1","parameters":[{"name":"id","in":"path","description":"The ID of application whose API Keys are to be returned.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/APIKey"}}}}},"204":{"description":"No Content"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}}},"post":{"tags":["Applications"],"summary":"Creates a new API Key and secret for the application","description":"Creates a new API Key and secret for the application.","operationId":"createAPIKey_1","parameters":[{"name":"id","in":"path","description":"The ID of application requiring an API Key.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"The APIKey to create","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIKey"}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIKey"}}}},"204":{"description":"No Content"},"400":{"description":"Bad Request"},"404":{"description":"Not Found"},"409":{"description":"Conflict"},"500":{"description":"Internal Server Error"}}}},"/applications":{"get":{"tags":["Applications"],"summary":"Get the list of applications","description":"Get the list of applications that are visible to the authenticated user. The list of applications can be filtered using the expression: field=__field__&op=__op__&value=__value__. Optionally, you can add a logical operation for all expressions, using the form: &lop=AND|OR. By default, the logical operation is AND. Multiple expression filters can be used, specifying field, op, and value for each filter. The __field__ is one of:\n\napiid\n: Matches the application if the application is using the API, specified by ID\n\nuserid\n: Matches the application if the user has explicit access to the application, specified by ID\n\ndescription\n: The application's description\n\nemail\n: The application's contact email address\n\nenabled\n: The enabled state of the application, one of: enabled, disabled\n\ncreatedOn\n: The date the application was created on, time in ms, e.g.: 1372755998542\n\nname\n: The name of the application\n\norgid\n: Matches the application if the application is part of the organization, specified by ID\n\nphone\n: The application's contact phone\n\nstate\n: The application's current state, one of: approved, pending\n\nThe __op__ is an operation and is one of:\n\neq\n: Equal\n\nne\n: Not equal\n\ngt\n: Greater than\n\nlt\n: Less than\n\nge\n: Greater than or equal\n\nle\n: Less than or equal\n\nlike\n: Like\n\ngele\n: Greater than or equal to, and less than or equal to; the __value__ should be a lower-minimum and upper-maximum separated by comma, e.g: value=5,10\n\nThe __value__ will be compared against the __field__, according to the supplied __op__. ","operationId":"getAllApplications_1","parameters":[{"name":"field","in":"query","description":"Filter field name.","schema":{"type":"array","items":{"type":"string"}}},{"name":"op","in":"query","description":"Filter operation.","schema":{"type":"array","items":{"type":"string"}}},{"name":"value","in":"query","description":"Filter value","schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Application"}}}}},"400":{"description":"Bad Request"},"500":{"description":"Internal Server Error"}}},"post":{"tags":["Applications"],"summary":"Creates a new application.","description":"Creates a new application. New applications may need to be approved using [/approve](#APIApplicationsapproveApp). Data posted in this request may include custom properties defined in app.config","operationId":"createApp_1","responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Application"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/applications/{id}/extclients":{"get":{"tags":["Applications"],"summary":"Returns the external clients associated with an application","description":"Returns the external clients associated with an application. External clients are used when authenticating the application through a 3rd party OAuth service","operationId":"getExternalClientsForAppID_1","parameters":[{"name":"id","in":"path","description":"The ID of application whose external clients are to be returned.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ExternalClient"}}}}},"400":{"description":"Bad Request"},"500":{"description":"Internal Server Error"}}},"post":{"tags":["Applications"],"summary":"Maps a new external client to the application","description":"Maps a new external client to the application. External clients are used when authenticating the application through a 3rd party OAuth service","operationId":"createExternalClient_1","parameters":[{"name":"id","in":"path","description":"The ID of application to map to an external client.","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExternalClient"}}}},"400":{"description":"Bad Request"},"500":{"description":"Internal Server Error"}}}},"/applications/{id}/oauth":{"get":{"tags":["Applications"],"summary":"Returns the OAuth Credentials associated with an application","description":"Returns the OAuth Credentials associated with an application.","operationId":"getOAuthInfoForAppID_1","parameters":[{"name":"id","in":"path","description":"The ID of application whose OAuth Credentials are to be returned.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/OAuthClient"}}}}},"204":{"description":"No Content"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}}},"post":{"tags":["Applications"],"summary":"Creates a new OAuth client ID and secret for the application","description":"Creates a new OAuth client ID and secret for the application.","operationId":"createOAuthCred_1","parameters":[{"name":"id","in":"path","description":"The ID of application requiring an OAuth client ID and secret.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"The OAuth credential to create","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OAuthClient"}}},"required":true},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OAuthClient"}}}},"204":{"description":"No Content"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}}}},"/applications/{id}/permissions":{"get":{"tags":["Applications"],"summary":"Get the list of permissions.","description":"Get the access-control list (ACL) for the application. Callers with view-only privilege can only access their own permission.","operationId":"getPermission_1","parameters":[{"name":"id","in":"path","description":"The application ID.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PermissionDTO"}}}}},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"post":{"tags":["Applications"],"summary":"Create a new permission.","description":"Add a new access-control entry to the application's ACL. Management privilege required.","operationId":"createPermission_1","parameters":[{"name":"id","in":"path","description":"The application ID.","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PermissionDTO"}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}}}},"/applications/{id}/oauthresource":{"get":{"tags":["Applications"],"summary":"Returns the OAuth protected resources (scopes) associated with an application","description":"Returns the OAuth protected resources (scopes) associated with an application.","operationId":"getResourcesForAppID_1","parameters":[{"name":"id","in":"path","description":"The ID of application whose OAuth protected resources (Scopes) are to be returned.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/OAuthResource"}}}}},"204":{"description":"No Content"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}}},"post":{"tags":["Applications"],"summary":"Adds an OAuth protected resource to an application","description":"An application must define which OAuth Protected resources it wants to access. These resources will define the scope of the application.","operationId":"createProtectedResource_1","parameters":[{"name":"id","in":"path","description":"The ID of application requiring an OAuth protected resource.","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OAuthResource"}}}},"204":{"description":"No Content"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}}}},"/applications/{id}/quota":{"get":{"tags":["Applications"],"summary":"Returns the quota associated with an application.","description":"Returns the quota associated with an application.","operationId":"getQuota_2","parameters":[{"name":"id","in":"path","description":"The ID of application who's quota constraints are to be returned.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/QuotaDTO"}}}},"500":{"description":"Internal Server Error"}}},"put":{"tags":["Applications"],"summary":"Updates a quota contraint for an application","description":"Updates a quota contraint for the given application.","operationId":"updateQuota_2","parameters":[{"name":"id","in":"path","description":"The ID of application who's quota is to be updated.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/QuotaDTO"}}}},"400":{"description":"Bad Request"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}}},"post":{"tags":["Applications"],"summary":"Creates a new quota constraint for the application","description":"Creates a new quota constraint for the application.","operationId":"createQuota_2","parameters":[{"name":"id","in":"path","description":"The ID of application for the quota contraint.","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/QuotaDTO"}}}},"400":{"description":"Bad Request"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}}},"delete":{"tags":["Applications"],"summary":"Deletes a quota from an application","description":"Deletes a quota from an application","operationId":"deleteQuota_2","parameters":[{"name":"id","in":"path","description":"The ID of application who's quota constraint is to be deleted.","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}}}},"/applications/{id}/scope":{"get":{"tags":["Applications"],"summary":"Returns the scopes associated with an application","description":"Returns the OAuth scopes associated with an application.","operationId":"getScopesForAppID_1","parameters":[{"name":"id","in":"path","description":"The ID of application whose OAuth protected resources (Scopes) are to be returned.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/OAuthAppScope"}}}}},"204":{"description":"No Content"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}}},"post":{"tags":["Applications"],"summary":"Adds an OAuth protected resource to an application","description":"An application must define which scopes it wants to access. These define the scope of the application.","operationId":"createScope_1","parameters":[{"name":"id","in":"path","description":"The ID of application requiring an OAuth scope.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"The OAuth Scope to add to the application","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OAuthAppScope"}}},"required":true},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OAuthAppScope"}}}},"204":{"description":"No Content"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}}}},"/applications/{id}/apikeys/{apikeyid}":{"put":{"tags":["Applications"],"summary":"Updates an API Key","description":"Updates the secret, enabled and Cors origin field. The fields __id__, __createdBy__, __createdOn__ are read only.","operationId":"updateAPIKey_1","parameters":[{"name":"id","in":"path","description":"The ID of application whose API Key is to be updated.","required":true,"schema":{"type":"string"}},{"name":"apikeyid","in":"path","description":"The ID of the API Key to be updated.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIKey"}}}},"204":{"description":"No Content"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}}},"delete":{"tags":["Applications"],"summary":"Delete an API Key","description":"Deletes an API Key. Deleting an API key means that it will no longer be accepted for application authentication.","operationId":"deleteAPIKey_1","parameters":[{"name":"id","in":"path","description":"The API Key ID to be deleted.","required":true,"schema":{"type":"string"}},{"name":"apikeyid","in":"path","description":"The ID of application whose API Key is to be deleted.","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}}}},"/applications/{id}":{"get":{"tags":["Applications"],"summary":"Get an application","description":"Retrieves the details of an application.","operationId":"getApp_1","parameters":[{"name":"id","in":"path","description":"The ID of the application to be returned.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Application"}}}},"204":{"description":"No Content"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}}},"put":{"tags":["Applications"],"summary":"Update an application","description":"Only managers of the application, API Manager Administrators, or Organization Administrators with enabled delegated application management privileges, may update an application. Note, if a field is omitted from the payload, or its value is set to null, the existing value for this field will be retained.","operationId":"updateApp_1","parameters":[{"name":"id","in":"path","description":"The ID of the application to be updated","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Application"}}}},"400":{"description":"Bad Request"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}}},"delete":{"tags":["Applications"],"summary":"Delete an application","description":"Only managers of the application, API Manager Administrators, or Organization Administrators with enabled delegated application management privileges, may delete applications.","operationId":"deleteApp_1","parameters":[{"name":"id","in":"path","description":"The ID of application to delete.","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}}}},"/applications/{id}/extclients/{objectId}":{"put":{"tags":["Applications"],"summary":"Updates an external client for the application","description":"Updates an external client for the application. External clients are used when authenticating the application through a 3rd party OAuth service","operationId":"updateExternalClient_1","parameters":[{"name":"id","in":"path","description":"The ID of application whose external client is to be updated.","required":true,"schema":{"type":"string"}},{"name":"objectId","in":"path","description":"The external client entry to be updated.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExternalClient"}}}},"400":{"description":"Bad Request"},"500":{"description":"Internal Server Error"}}},"delete":{"tags":["Applications"],"summary":"Delete an external client","description":"Deletes an external client. Deleting a mapping means that it will no longer be accepted for application authentication.","operationId":"deleteExternalClient_1","parameters":[{"name":"id","in":"path","description":"The ID of application whose external client is to be deleted.","required":true,"schema":{"type":"string"}},{"name":"objectId","in":"path","description":"The ID of the external client entry to be deleted.","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"500":{"description":"Internal Server Error"}}}},"/applications/{id}/oauth/{clientId}":{"put":{"tags":["Applications"],"summary":"Updates an OAuth Credential for the application","description":"Updates an OAuth Credential for the application.","operationId":"updateOAuthCred_1","parameters":[{"name":"id","in":"path","description":"The ID of application whose OAuth credential is to be updated.","required":true,"schema":{"type":"string"}},{"name":"clientId","in":"path","description":"The OAuth Credential ID to be updated.","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}}},"delete":{"tags":["Applications"],"summary":"Delete an OAuth client ID and secret","description":"Deletes an OAuth client ID and secret. Deleting an OAuth client ID and secret means that it will no longer be accepted for OAuth application authentication.","operationId":"deleteOAuthKey_1","parameters":[{"name":"id","in":"path","description":"The ID of application whose OAuth Credential is to be deleted.","required":true,"schema":{"type":"string"}},{"name":"clientId","in":"path","description":"The OAuth Client ID to be deleted.","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}}}},"/applications/{id}/permissions/{permId}":{"put":{"tags":["Applications"],"summary":"Modify a permission","description":"Add a new access-control entry to the application's ACL. Management privilege required.","operationId":"updatePermission_1","parameters":[{"name":"id","in":"path","description":"The application ID.","required":true,"schema":{"type":"string"}},{"name":"permId","in":"path","description":"The permission ID.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PermissionDTO"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}}},"delete":{"tags":["Applications"],"summary":"Remove a permission","description":"Remove an existing access-control entry from the application's ACL. Management privilege required.","operationId":"deletePermission_1","parameters":[{"name":"id","in":"path","description":"The application ID.","required":true,"schema":{"type":"string"}},{"name":"permId","in":"path","description":"The permission ID.","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}}}},"/applications/{id}/oauthresource/{resourceId}":{"put":{"tags":["Applications"],"summary":"Updates a protected resource associate with an application, sets enabled to true/false","description":"An OAuth Protected resource associated with an application can be enabled or disabled with this method.","operationId":"updateProtectedResource_1","parameters":[{"name":"id","in":"path","description":"The ID of application requiring an updated OAuth protected resource.","required":true,"schema":{"type":"string"}},{"name":"resourceId","in":"path","description":"The ID of the OAuth protected resource to update","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"The updated OAuth protected resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OAuthResource"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OAuthResource"}}}},"204":{"description":"No Content"},"400":{"description":"Bad Request"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}}},"delete":{"tags":["Applications"],"summary":"Remove an OAuth protected resource from an application","description":"Removes the association between an application and an OAuth protected resource on the API Server. The application will no longer have the scope associated with the resource. Tokens issued prior to the removal will still be scoped for the resource.","operationId":"deleteProtectedResource_1","parameters":[{"name":"id","in":"path","description":"The ID of application whose protected resource is to be removed.","required":true,"schema":{"type":"string"}},{"name":"resourceId","in":"path","description":"The uri of the OAuth protected resource to be disassociated from the application.","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}}}},"/applications/{id}/scope/{scopeId}":{"put":{"tags":["Applications"],"summary":"Updates a scope associated with an application, sets default to true/false","description":"An OAuth Scope associated with an application can be set or unset as a default scope with this method.","operationId":"updateAppScope_1","parameters":[{"name":"id","in":"path","description":"The ID of application requiring an updated OAuth protected resource.","required":true,"schema":{"type":"string"}},{"name":"scopeId","in":"path","description":"The ID of the Application Scope to update","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"The updated OAuth protected resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OAuthAppScope"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OAuthAppScope"}}}},"204":{"description":"No Content"},"400":{"description":"Bad Request"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}}},"delete":{"tags":["Applications"],"summary":"Remove an OAuth protected resource from an application","description":"Removes the association between an application and an OAuth protected resource on the API Server. The application will no longer have the scope associated with the resource. Tokens issued prior to the removal will still be scoped for the resource.","operationId":"deleteScope_1","parameters":[{"name":"id","in":"path","description":"The ID of application whose protected resource is to be removed.","required":true,"schema":{"type":"string"}},{"name":"scopeId","in":"path","description":"The id of the Scope to be disassociated from the application.","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}}}},"/applications/{id}/oauth/{clientid}/newsecret":{"put":{"tags":["Applications"],"summary":"Updates an OAuth Credential for an application by generating a new secret","description":"Updates an OAuth Credential for an application by generating a new client secret.","operationId":"generateNewOAuthSecret_1","parameters":[{"name":"id","in":"path","description":"The ID of application whose OAuth credential is to be updated with a new secret","required":true,"schema":{"type":"string"}},{"name":"clientid","in":"path","description":"The OAuth Credential ID to be updated with a new secret","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}}}},"/applications/{id}/apis":{"get":{"tags":["Applications"],"summary":"Get the list of APIs that the application can access","description":"Get the list of APIs that the application can access.","operationId":"getApisAccess_1","parameters":[{"name":"id","in":"path","description":"The application ID.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/APIAccess"}}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}}},"post":{"tags":["Applications"],"summary":"Create a request for an application to access an API.","description":"Only API Manager Administrator, or an Organization Administrator of the application's organization with the correct privileges, or the application manager may create API access requests.","operationId":"requestApiAccess_2","parameters":[{"name":"id","in":"path","description":"The application ID.","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIAccess"}}}},"204":{"description":"No Content"},"400":{"description":"Bad Request"},"500":{"description":"Internal Server Error"}}}},"/applications/{id}/availablescopes":{"get":{"tags":["Applications"],"summary":"Returns the scopes available to an application","description":"Returns the OAuth scopes available to an application.","operationId":"getAvailableScopesForAppID_1","parameters":[{"name":"id","in":"path","description":"The ID of application whose OAuth scopes are to be returned.","required":true,"schema":{"type":"string"}},{"name":"apiScope","in":"query","description":"The api scope","schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"No Content","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OAuthScope"}}}},"204":{"description":"No Content"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}}}},"/applications/{id}/image":{"get":{"tags":["Applications"],"summary":"Get the image for an application","description":"Get the JPEG image associated with an application.","operationId":"getImage_4","parameters":[{"name":"id","in":"path","description":"The ID of the application whose image is to be return","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}}},"post":{"tags":["Applications"],"summary":"Adds a JPEG image to an application","description":"Adds a JPEG image to an application with a MultiPart POST","operationId":"postImage_4","parameters":[{"name":"id","in":"path","description":"The ID of the application whose image is being added","required":true,"schema":{"type":"string"}},{"name":"type","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"OK"},"400":{"description":"Bad Request"},"404":{"description":"Not Found"},"409":{"description":"Conflict"},"413":{"description":"Request Entity Too Large"},"500":{"description":"Internal Server Error"}}}},"/applications/{id}/apis/{apiAccessId}":{"put":{"tags":["Applications"],"summary":"Updates access to an API for an application","description":"Updates access to an API for an application. Only __enabled__ may be modified.","operationId":"updateApiAccess_2","parameters":[{"name":"id","in":"path","description":"The application ID.","required":true,"schema":{"type":"string"}},{"name":"apiAccessId","in":"path","description":"The API access ID.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIAccess"}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}}},"delete":{"tags":["Applications"],"summary":"Deletes access to an API for an application","description":"Permanently deletes access to an API for an application.","operationId":"removeApiAccess_1","parameters":[{"name":"id","in":"path","description":"The application ID.","required":true,"schema":{"type":"string"}},{"name":"apiAccessId","in":"path","description":"The API access ID.","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}}}},"/authorizations/{authzid}":{"delete":{"tags":["OAuth Authorizations"],"summary":"Delete the OAuth Authorization for the given authorization id.","description":"Admin or Resource Owner task to delete the given authorization id.","operationId":"deleteAuthorization_2","parameters":[{"name":"authzid","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/authorizations/owner/{subjectid}/application/{appid}":{"delete":{"tags":["OAuth Authorizations"],"operationId":"deleteAuthorization","parameters":[{"name":"subjectid","in":"path","required":true,"schema":{"type":"string"}},{"name":"appid","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/authorizations":{"get":{"tags":["OAuth Authorizations"],"summary":"Retrieve all stored OAuth Authorizations for the logged in user.","description":"If user is a member of the admin group then all authorizations are returned. If not, then the logged in user's authorizations are returned.","operationId":"getAuthorizations_1","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/OAuthAuthorization"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/metrics/fields":{"get":{"tags":["Metrics"],"summary":"Gets a list of metric field names available for summary and timeline queries.","description":"Retrieves a set of metric fields that may be used when querying or interpreting the summary and timeline reports. The __metricType__ is the metric name. The __aggreggateName__ is the metric name for the aggregated __metricType__.","operationId":"getMetricFields_1","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MetricField"}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}}}},"/metrics/reports/{type}/summary/{level}":{"get":{"tags":["Metrics"],"summary":"Gets a summary report for application usage","operationId":"getMetricSummaryPortal_1","parameters":[{"name":"type","in":"path","description":"The report type, either 'app' or 'api'","required":true,"schema":{"type":"string"}},{"name":"level","in":"path","description":"The report level (0 or 1 for drill-through)","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"from","in":"query","description":"The starting date/time for the report.","required":true,"schema":{"type":"string"}},{"name":"to","in":"query","description":"The end date/time for the report.","required":true,"schema":{"type":"string"}},{"name":"client","in":"query","description":"Filter a specific client ID (multiple permitted).","schema":{"type":"array","items":{"type":"string"}}},{"name":"service","in":"query","description":"Filter a specific service name (multiple permitted).","schema":{"type":"array","items":{"type":"string"}}},{"name":"method","in":"query","description":"Filter a specific method.","schema":{"type":"string"}},{"name":"organization","in":"query","description":"Filter a specific organziation.","schema":{"type":"string"}},{"name":"reportsubtype","in":"query","description":"Define the report subtype. Allowed values are : 'original', 'trafficAll' or 'trafficSubset'. Defaults to 'original' if absent","schema":{"type":"string"}}],"responses":{"200":{"description":"OK"},"400":{"description":"Bad Request"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}}}},"/metrics/reports/{type}/timeline/{level}/{metricType}":{"get":{"tags":["Metrics"],"summary":"Gets a timeline report for application usage","description":"Produces a timeline report for a __metricType__ over a specified time range. The __from__ and __two__ parameters should be a URL encoded ISO-8601 combined date and time format (e.g. 2013-03-13T00%3A00%3A00Z). The __metricType__ name is one of the types returned from [fields](#APIMetricsgetMetricFields).","operationId":"getMetricsTimeline_1","parameters":[{"name":"type","in":"path","description":"The report type, either 'app' or 'api'","required":true,"schema":{"type":"string"}},{"name":"level","in":"path","description":"The report level (0 or 1 for drill-through)","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"from","in":"query","description":"The starting date/time for the report.","required":true,"schema":{"type":"string"}},{"name":"to","in":"query","description":"The end date/time for the report.","required":true,"schema":{"type":"string"}},{"name":"client","in":"query","description":"Filter a specific client ID (multiple permitted).","schema":{"type":"array","items":{"type":"string"}}},{"name":"service","in":"query","description":"Filter a specific service name (multiple permitted).","schema":{"type":"array","items":{"type":"string"}}},{"name":"method","in":"query","description":"Filter a specific method.","schema":{"type":"string"}},{"name":"organization","in":"query","description":"Filter a specific organziation.","schema":{"type":"string"}},{"name":"metricType","in":"path","description":"The metric type to query.","required":true,"schema":{"type":"string"}},{"name":"reportsubtype","in":"query","description":"Define the report subtype. Allowed values are : 'original', 'trafficAll' or 'trafficSubset'. Defaults to 'original' if absent","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MetricTimeline"}}}},"400":{"description":"Bad Request"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}}}},"/migrate/applications/export/create":{"post":{"tags":["Migrate"],"summary":"Creates a set of export options associated with the current http session","description":"Creates a set of export options associated with the current http session. Options include the password used to encrypt the resulting export, export elements: apikeys, oauth & quotas, the filename of the export, and the list of application ids for inclusion in the export. The exported data can be retrieved subsequently with a GET request","operationId":"exportCreate_1","parameters":[{"name":"CSRF-Token","in":"header","description":"CSRF Token Header","required":true,"schema":{"type":"string"}},{"name":"APIMANAGERSESSION","in":"cookie","description":"API Manager Session Cookie","required":true,"schema":{"type":"string"}},{"name":"APIMANAGERSTATIC","in":"cookie","description":"API Manager Static Cookie","schema":{"type":"string"}}],"requestBody":{"description":"The options for creating an application export file","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExportOptions"}}},"required":true},"responses":{"204":{"description":"No Content"},"403":{"description":"It will return 403 Forbidden if the caller is not an ADMIN"},"500":{"description":"Internal Server Error"}}}},"/migrate/applications/export/json":{"post":{"tags":["Migrate"],"summary":"Creates an export of applications based on the export options posted as a JSON object","description":"Creates an export file based on options including the password used to encrypt the resulting export, export elements: apikeys, oauth & quotas, the filename of the export, and the list of application ids for inclusion in the export. The exported data is returned as part of the response body","operationId":"exportJson_1","requestBody":{"description":"Export options","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExportOptions"}}},"required":true},"responses":{"200":{"description":"OK"},"403":{"description":"It will return 403 Forbidden if the caller is not an ADMIN"},"500":{"description":"Internal Server Error"}}}},"/migrate/applications/export/download":{"get":{"tags":["Migrate"],"summary":"Exports Application data for migration to other API Gateways","description":"Retrieves the export options associated with the current user HTTP session and creates a stream or returns the exported data in response body.","operationId":"exportSelected_2","parameters":[{"name":"CSRF-Token","in":"header","description":"CSRF Token Header","required":true,"schema":{"type":"string"}},{"name":"APIMANAGERSESSION","in":"cookie","description":"API Manager Session Cookie","required":true,"schema":{"type":"string"}},{"name":"APIMANAGERSTATIC","in":"cookie","description":"API Manager Static Cookie","schema":{"type":"string"}},{"name":"filename","in":"query","description":"Optional. If present this method will return an octet stream with an file attachment of the same name","schema":{"type":"string"}}],"responses":{"200":{"description":"OK"},"400":{"description":"Bad Request"},"403":{"description":"It will return 403 Forbidden if the caller is not an ADMIN"},"500":{"description":"Internal Server Error"}}}},"/migrate/applications/export":{"post":{"tags":["Migrate"],"summary":"Creates an export of applications based on the export options posted in a form data","description":"Creates an export file based on options including the password used to encrypt the resulting export, export elements: apikeys, oauth & quotas, the filename of the export, and the list of application ids for inclusion in the export. The exported data is returned as part of the response body","operationId":"exportSelected","requestBody":{"content":{"multipart/form-data":{"schema":{"required":["apikeys","oauth","quota"],"type":"object","properties":{"apikeys":{"type":"string","description":"True/False. Include/Exclude api keys"},"oauth":{"type":"string","description":"True/False. Include/Exclude oauth credentials"},"quota":{"type":"string","description":"True/False. Include/Exclude quotas, if available"},"filename":{"type":"string","description":"The name of the export file"},"password":{"type":"string","description":"The password used to encrypt the exported file"},"appIds":{"type":"array","items":{"type":"string","description":"The list of identifiers for the applications to be exported"}}}}}}},"responses":{"200":{"description":"OK"},"403":{"description":"It will return 403 Forbidden if the caller is not an ADMIN"},"500":{"description":"Internal Server Error"}}}},"/migrate/applications/import":{"post":{"tags":["Migrate"],"summary":"Imports applications to the API Gateway","description":"Imports a set of applications and assocated API Keys and OAuth credentials, encrypted files require a decryption password","operationId":"importApplications_1","parameters":[{"name":"type","in":"query","description":"This value should be unset","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"required":["file","userId"],"type":"object","properties":{"file":{"type":"string","description":"The file containing application data to be imported","format":"binary"},"password":{"type":"string","description":"Password to be used for decryption"},"organizationId":{"type":"string","description":"The Organization to associate the imported applications with. If applicable, for Core OAuth this parameter will be ignored"},"userId":{"type":"string","description":"The user to associate the applications with. Default is the API Admin"}}}}}},"responses":{"200":{"description":"OK"},"403":{"description":"It will return 403 Forbidden if the caller is not an ADMIN"},"500":{"description":"Internal Server Error"}}}},"/organizations":{"get":{"tags":["Organizations"],"summary":"List all organizations","description":"Get the list of organizations that are visible to the authenticated user. Only API Administrators may list all organizations, all other users will see their organization. The list of organizations can be filtered using the expression: field=__field__&op=__op__&value=__value__. Optionally, you can add a logical operation for all expressions, using the form: &lop=AND|OR. By default, the logical operation is AND. Multiple expression filters can be used, specifying field, op, and value for each filter. The __field__ is one of:\n\napiid\n: Matches the organization if the organization is using the API, specified by ID\n\ndescription\n: The organization's description\n\nemail\n: The organization's contact email address\n\nenabled\n: The enabled state of the organization, one of: enabled, disabled\n\ncreatedOn\n: The date the organization was created on, time in ms, e.g.: 1372755998542\n\nname\n: The name of the organization\n\nphone\n: The organization's contact phone\n\nThe __op__ is an operation and is one of:\n\neq\n: Equal\n\nne\n: Not equal\n\ngt\n: Greater than\n\nlt\n: Less than\n\nge\n: Greater than or equal\n\nle\n: Less than or equal\n\nlike\n: Like\n\ngele\n: Greater than or equal to, and less than or equal to; the __value__ should be a lower-minimum and upper-maximum separated by comma, e.g: value=5,10\n\nThe __value__ will be compared against the __field__, according to the supplied __op__. ","operationId":"getOrganizations_1","parameters":[{"name":"field","in":"query","description":"Filter field name.","schema":{"type":"array","items":{"type":"string"}}},{"name":"op","in":"query","description":"Filter operation.","schema":{"type":"array","items":{"type":"string"}}},{"name":"value","in":"query","description":"Filter value","schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Organization"}}}}},"400":{"description":"Bad Request"},"500":{"description":"Internal Server Error"}}},"post":{"tags":["Organizations"],"summary":"Creates a new organization","description":"Creates a new organization. Only API Administrators may create organizations. Data posted in this request may include custom properties defined in app.config","operationId":"createOrganization_1","responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Organization"}}}},"400":{"description":"Bad Request"},"413":{"description":"Request Entity Too Large"},"500":{"description":"Internal Server Error"}}}},"/organizations/{id}/tokens":{"get":{"tags":["Organizations"],"summary":"Get registration codes for an organization","description":"Retrieves the registration codes for an organization.","operationId":"getRegistrationTokens_1","parameters":[{"name":"id","in":"path","description":"The organization ID whos tokens are to be returned.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RegistrationToken"}}}},"500":{"description":"Internal Server Error"}}},"post":{"tags":["Organizations"],"summary":"Create a registration code","description":"Create a registration code for self service onboarding of users to the organization","operationId":"createRegistrationToken_1","parameters":[{"name":"id","in":"path","description":"The organization ID to be associated with the registration code.","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RegistrationToken"}}}},"500":{"description":"Internal Server Error"}}}},"/organizations/{id}/apis/{apiAccessId}":{"put":{"tags":["Organizations"],"summary":"Updates access to an API for an organization","description":"Updates access to an API for an organization. Only __enabled__ may be modified, and disabling access will also disable access to all applications that may be using it.","operationId":"updateApiAccess","parameters":[{"name":"id","in":"path","description":"The organization ID.","required":true,"schema":{"type":"string"}},{"name":"apiAccessId","in":"path","description":"The API access ID.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIAccess"}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}}},"delete":{"tags":["Organizations"],"summary":"Deletes access to an API for an organization","description":"Permanently deletes access to an API for an organization. Deleting API access will also delete API access to any application.","operationId":"deleteApiAccess_1","parameters":[{"name":"id","in":"path","description":"The organization ID.","required":true,"schema":{"type":"string"}},{"name":"apiAccessId","in":"path","description":"The API access ID.","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}}}},"/organizations/{id}":{"get":{"tags":["Organizations"],"summary":"Get an organization","description":"Retrieves the details of an organization.","operationId":"getOrganization_1","parameters":[{"name":"id","in":"path","description":"The organization ID to be returned.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Organization"}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}}},"put":{"tags":["Organizations"],"summary":"Update the details of an organization","description":"Updates an organization.","operationId":"updateOrganization_1","parameters":[{"name":"id","in":"path","description":"The organization ID to update.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Organization"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}}},"delete":{"tags":["Organizations"],"summary":"Delete an organization","description":"Deletes an organization. Deleting an organization will result in all users and associated applications being deleted.","operationId":"deleteOrganization_1","parameters":[{"name":"id","in":"path","description":"The organization ID to delete.","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}}}},"/organizations/{id}/tokens/{token}":{"get":{"tags":["Organizations"],"summary":"Get registration code","description":"Retrieves the registration code.","operationId":"getRegistrationToken_1","parameters":[{"name":"id","in":"path","description":"The organization ID associated with the registration code.","required":true,"schema":{"type":"string"}},{"name":"token","in":"path","description":"The registration code to be returned.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RegistrationToken"}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}}},"put":{"tags":["Organizations"],"summary":"Update a registration code","description":"Update a registration code for self service onboarding of users to the organization","operationId":"updateRegistrationToken_1","parameters":[{"name":"id","in":"path","description":"The organization ID to be associated with the registration code.","required":true,"schema":{"type":"string"}},{"name":"token","in":"path","description":"The token to be deleted","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RegistrationToken"}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}}},"delete":{"tags":["Organizations"],"summary":"Delete the registration code","description":"Delete the registration code.","operationId":"deleteRegistrationToken_1","parameters":[{"name":"id","in":"path","description":"The organization ID associated with the registration code.","required":true,"schema":{"type":"string"}},{"name":"token","in":"path","description":"The registration code to be deleted.","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}}}},"/organizations/{id}/apis":{"get":{"tags":["Organizations"],"summary":"Get the list of approved APIs for the organization","description":"Get the list of aproved APIs for the organization","operationId":"getApprovedApisAccess_1","parameters":[{"name":"id","in":"path","description":"The organization ID who's approved APIs are required.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIAccess"}}}},"500":{"description":"Internal Server Error"}}},"post":{"tags":["Organizations"],"summary":"Grants access to an API for an organization.","description":"Grants access to an API for an organization. Only the API Admin may call this method.","operationId":"requestApiAccess","parameters":[{"name":"id","in":"path","description":"The organization ID requesting access to an API.","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIAccess"}}}},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/organizations/{id}/image":{"get":{"tags":["Organizations"],"summary":"Get the image for an organization","description":"Returns the jpeg image associated with an organization.","operationId":"getImage","parameters":[{"name":"id","in":"path","description":"The organization ID whos image is to be returned","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}}},"post":{"tags":["Organizations"],"summary":"Set the image for an organization","description":"Set the jpeg image to be associated with an organization.","operationId":"postImage","parameters":[{"name":"id","in":"path","description":"The organization ID whos image is to be set","required":true,"schema":{"type":"string"}},{"name":"type","in":"query","schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"413":{"description":"Request Entity Too Large"},"500":{"description":"Internal Server Error"}}}},"/remotehosts":{"get":{"tags":["API Manager Services"],"summary":"Returns a list of remote hosts","description":"Returns a list of API Manager-registered remote hosts.","operationId":"getRemoteHosts_1","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/RemoteHost"}}}}},"403":{"description":"Forbidden"}}},"post":{"tags":["API Manager Services"],"summary":"Creates a new remote host","description":"Creates a new API Manager-regsitered remote host. Dynamically updates the API Gateway runtime so that the remote host is available.","operationId":"addRemoteHost_1","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RemoteHost"}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RemoteHost"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/license":{"get":{"tags":["API Manager Services"],"summary":"Checks that the API Manager has a valid license","description":"Returns an API Manager license configuration object. Does not require authentication.","operationId":"checkLicense_1","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LicenseConfig"}}}}}}},"/remotehosts/{id}":{"put":{"tags":["API Manager Services"],"summary":"Updates a remote host","description":"Updates an API Manager-registered remote host. Dynamically updates the API Gateway runtime so that the new remote host settings are available.","operationId":"updateRemoteHost_1","parameters":[{"name":"id","in":"path","description":"The remote host identifier.","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RemoteHost"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RemoteHost"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"delete":{"tags":["API Manager Services"],"summary":"Deletes a remote host.","description":"Deletes an API Manager-registered remote host. Dynamically removes the remote host from the API Gateway runtime.","operationId":"deleteRemoteHost_1","parameters":[{"name":"id","in":"path","description":"The remote host identifier.","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"}}}},"/alerts":{"get":{"tags":["API Manager Services"],"summary":"Gets the alerts configured for the API Manager","description":"Gets the alerts configured for the API Manager that shows which alerts are enabled/disabled for the application. Only the API Administrator may call this method.","operationId":"getAlerts_1","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlertConfig"}}}},"403":{"description":"Forbidden"}}},"post":{"tags":["API Manager Services"],"summary":"Updates the API Manager alerts configuration","description":"Updates the API Manager alerts configuration. Only the API Administrator may call this method.","operationId":"updateAlertConfig_1","responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlertConfig"}}}},"403":{"description":"Forbidden"}}}},"/appinfo":{"get":{"tags":["API Manager Services"],"summary":"Gets API Manager feature information.","description":"Returns an API Manager configuration object describing the application.","operationId":"getAppInfo_1","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Config"}}}}}}},"/certinfo":{"post":{"tags":["API Manager Services"],"summary":"Extracts certificate information from the supplied data","description":"Extracts certificate information from the supplied data.","operationId":"getCertInfo_1","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CACert"}}}}},"400":{"description":"Bad Request"}}}},"/certinfoFromUrl":{"post":{"tags":["API Manager Services"],"summary":"Extracts certificate information from the supplied data","description":"Extracts certificate information from the supplied data.","operationId":"getCertInfoFromUrl_1","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CACert"}}}}},"400":{"description":"Bad Request"}}}},"/config":{"get":{"tags":["API Manager Services"],"summary":"Gets API Manager configuration","description":"Returns an API Manager configuration object.","operationId":"getConfig_1","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Config"}}}},"403":{"description":"Forbidden"}}},"put":{"tags":["API Manager Services"],"summary":"Updates the API Manager configuration","description":"Updates the API Manager configuration. Only the API Administrator may call this method.","operationId":"updateConfig_1","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Config"}}}},"403":{"description":"Forbidden"}}}},"/filedata":{"post":{"tags":["API Manager Services"],"summary":"Returns the DataURI representation of the uploaded file","description":"Returns the DataURI representation of the uploaded file.","operationId":"getFileData_1","responses":{"200":{"description":"OK"},"400":{"description":"Bad Request"}}}},"/service-discovery/{instance}/{type}":{"post":{"tags":["API Manager Services"],"summary":"Returns a list of services hosted on the specified Gateway instance","description":"Returns a list of services hosted on the specified Gateway instance. __type__ is one of: rest, wsdl.","operationId":"getGatewayServices_1","parameters":[{"name":"instance","in":"path","required":true,"schema":{"type":"string"}},{"name":"type","in":"path","description":"The type of service to return. Possible values are: 'rest', 'wsdl'","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"host":{"type":"string"},"port":{"type":"string"},"username":{"type":"string"},"password":{"type":"string"}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Swagger"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/oauthclientprofiles":{"get":{"tags":["API Manager Services"],"summary":"Get a list of OAuth profiles for use in backend API authorisation","description":"Return a list of OAuth Client Profiles for use in authorising API access to backend APIs.","operationId":"getOAuthClientProfiles_1","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ReferencedEntity"}}}}},"400":{"description":"Bad Request"}}}},"/policies":{"get":{"tags":["API Manager Services"],"summary":"Gets a list of the specified policies","description":"Returns the list of policies (of the specified type) that are available to Portal-registered APIs. __type__ is one of: faulthandler, globalrequest, globalresponse, request, routing, response, promotion, authentication or token-info.","operationId":"getPolicies_1","parameters":[{"name":"type","in":"query","description":"The type of policy to return. Possible values are: 'faulthandler', 'globalrequest', 'globalresponse', 'request', 'routing', 'response', 'authentication', 'oauthtokeninfo', 'promotion'","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ReferencedEntity"}}}}},"400":{"description":"Bad Request"}}}},"/listeners":{"get":{"tags":["API Manager Services"],"summary":"Gets the API Manager listeners","description":"Returns a list of API Manager listeners.","operationId":"getPortalListeners_1","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PortalTrafficListener"}}}}},"403":{"description":"Forbidden"}}}},"/sysconfig":{"get":{"tags":["API Manager Services"],"summary":"Gets API Manager system configuration","description":"Returns an API Manager system configuration object.","operationId":"getSystemApiConfig_1","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SystemConfig"}}}},"403":{"description":"Forbidden"}}},"put":{"tags":["API Manager Services"],"summary":"Update API Manager system configuration","description":"Returns an API Manager system configuration object.","operationId":"updateSystemApiConfig_1","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SystemConfig"}}}},"403":{"description":"Forbidden"}}}},"/title":{"get":{"tags":["API Manager Services"],"summary":"Gets the API Manager's title","description":"Returns the API Manager title. Does not require authentication.","operationId":"getTitle_1","responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"type":"string"}}}}}}},"/tokenstores":{"get":{"tags":["API Manager Services"],"summary":"Gets a list of Token Stores","description":"Returns a list of Token Stores to be used by OAuth Security Devices for inbound security on portal-registered APIs.","operationId":"getTokenStores_1","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ReferencedEntity"}}}}},"400":{"description":"Bad Request"}}}},"/topology":{"post":{"tags":["API Manager Services"],"summary":"Retrieves the Topology from the specified Admin Node Manager","description":"Retrieves the Topology from the specified Admin Node Manager","operationId":"getTopology_1","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"required":["host","password","port","username"],"type":"object","properties":{"host":{"type":"string","description":"The host on which the Admin Node Manager is running"},"port":{"type":"string","description":"The Admin Node Manager management port."},"username":{"type":"string","description":"Username to use for Admin Node Manager authentication ."},"password":{"type":"string","description":"Password to use for Admin Node Manager authentication."}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Topology"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/proxies/{id}":{"get":{"tags":["API Proxy Registration"],"summary":"Gets a frontend API by ID.","operationId":"getApi_2","parameters":[{"name":"id","in":"path","description":"The frontend API identifier.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VirtualizedAPI"}}}},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"put":{"tags":["API Proxy Registration"],"summary":"Updates an API proxy.","description":"Updates an API proxy definition. Data in this request may include custom properties defined in app.config.","operationId":"updateApi_2","parameters":[{"name":"id","in":"path","description":"The frontend API identifier.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"The virtualized API to update","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VirtualizedAPI"}}},"required":true},"responses":{"204":{"description":"No Content"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"delete":{"tags":["API Proxy Registration"],"summary":"Deletes an API proxy.","description":"Deletes an API proxy, removing all API access in the process.","operationId":"deleteApi_2","parameters":[{"name":"id","in":"path","description":"The frontend API identifier.","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/proxies/{id}/operations/{operationId}":{"get":{"tags":["API Proxy Registration"],"summary":"Gets an API method by ID.","operationId":"getApiMethod_1","parameters":[{"name":"id","in":"path","description":"The frontend API identifier.","required":true,"schema":{"type":"string"}},{"name":"operationId","in":"path","description":"The frontend API method identifier.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VirtualizedAPIMethod"}}}},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"put":{"tags":["API Proxy Registration"],"summary":"Updates an API proxy operation.","operationId":"updateApiMethod_1","parameters":[{"name":"id","in":"path","description":"The frontend API identifier.","required":true,"schema":{"type":"string"}},{"name":"operationId","in":"path","description":"The frontend API method identifier.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"The virtualized API to update","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VirtualizedAPIMethod"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VirtualizedAPIMethod"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"delete":{"tags":["API Proxy Registration"],"summary":"Deletes an API method by ID.","operationId":"deleteMethod_2","parameters":[{"name":"id","in":"path","description":"The frontend API identifier.","required":true,"schema":{"type":"string"}},{"name":"operationId","in":"path","description":"The frontend API method identifier.","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/proxies/{id}/deprecate":{"post":{"tags":["API Proxy Registration"],"summary":"Deprecates the API.","description":"Deprecates the API.","operationId":"deprecateApi_1","parameters":[{"name":"id","in":"path","description":"The frontend API identifier.","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"retirementDate":{"type":"string","description":"Optional API retirement date specified in supported ISO-8601 format."}}}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VirtualizedAPI"}}}},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/proxies/export/{id}":{"get":{"tags":["API Proxy Registration"],"summary":"Downloads an API export.","description":"The API export is produced from [/exportApis](APIProxyRegistration.html#APIProxyRegistrationexportApis). If __filename__ is supplied, the download will use it as the `Content-Disposition` filename attachment.","operationId":"exportApi_1","parameters":[{"name":"id","in":"path","description":"The export identifier.","required":true,"schema":{"type":"string"}},{"name":"filename","in":"query","description":"The export will be downloaded using a Content-Dispostion using the supplied filename","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIPromotion"}}}},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/proxies/export":{"post":{"tags":["API Proxy Registration"],"summary":"Creates an API export.","description":"Creates an export for use in promoting the API to a new environment. The export contains the frontend [VirtualizedAPI](VirtualizedAPI.html), their settings, and all backend [APIDefinition](APIDefinition.html) that are required for the frontend API. If **password** is supplied, the exported file will be encrypted with the password. If successful, returns **201 Created**, and the HTTP `Location` header contain the of the URL of the export. The export is temporary, and may only be downloaded once.","operationId":"exportApis_1","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"required":["filename","id","password"],"type":"object","properties":{"id":{"type":"array","description":"The frontend API identifier(s) to export.","items":{"type":"string","description":"The frontend API identifier(s) to export."}},"password":{"type":"string","description":"Encrypts the list of API using the password."},"filename":{"type":"string","description":"Optional filename to use in response."}}}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VirtualizedAPI"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/proxies":{"get":{"tags":["API Proxy Registration"],"summary":"Queries a list of frontend API.","description":"Returns a list of API that are visible to the authenticated user. The list of API can be filtered using the expression: field=__field__&op=__op__&value=__value__. Optionally, you can add a logical operation for all expressions, using the form: &lop=AND|OR. By default, the logical operation is AND. Multiple expression filters can be used, specifying field, op, and value for each filter. The __field__ is one of:\n\nname\n: The name of the API\n\napiid\n: Matches the API if the API is virtualized from the specified backend API\n\ncreatedOn\n: The date the virtualized API was created on, time in ms, e.g.: 1372755998542\n\ndeprecated\n: The deprecated state of the API, one of: true or false\n\nretired\n: The retired state of the API, one of: true or false\n\nstate\n: The API's state, one of: unpublished, pending, or published\n\npath\n: The path that services this virtualized API.\n\nThe __op__ is an operation and is one of:\n\neq\n: Equal\n\nne\n: Not equal\n\ngt\n: Greater than\n\nlt\n: Less than\n\nge\n: Greater than or equal\n\nle\n: Less than or equal\n\nlike\n: Like\n\ngele\n: Greater than or equal to, and less than or equal to; the __value__ should be a lower-minimum and upper-maximum separated by comma, e.g: value=5,10\n\nThe __value__ will be compared against the __field__, according to the supplied __op__.","operationId":"getAllApis_2","parameters":[{"name":"field","in":"query","description":"Filter field name.","schema":{"type":"array","items":{"type":"string"}}},{"name":"op","in":"query","description":"Filter operation.","schema":{"type":"array","items":{"type":"string"}}},{"name":"value","in":"query","description":"Filter value","schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/VirtualizedAPI"}}}}},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"post":{"tags":["API Proxy Registration"],"summary":"Creates a new API proxy from a backend API.","description":"The [VirtualizedAPI apiId](VirtualizedAPI.html#apiId) is required. Only one [VirtualizedAPI](VirtualizedAPI.html) can be created per [VirtualizedAPI apiId]. If creating the API as an API administrator, the [VirtualizedAPI organizationId](VirtualizedAPI.html#organizationId) must also be specified.","operationId":"virtualizeApi_1","requestBody":{"description":"The frontend API to create.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VirtualizedAPI"}}},"required":true},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VirtualizedAPI"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/proxies/{id}/operations":{"get":{"tags":["API Proxy Registration"],"summary":"Gets a list of methods that are avilable to the API proxy.","operationId":"getApiMethods_1","parameters":[{"name":"id","in":"path","description":"The frontend API identifier.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VirtualizedAPIMethod"}}}},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/proxies/{id}/image":{"get":{"tags":["API Proxy Registration"],"summary":"Gets the image for the API.","description":"Returns the jpeg image associated with the API.","operationId":"getImage_1","parameters":[{"name":"id","in":"path","description":"The frontend API identifier.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"post":{"tags":["API Proxy Registration"],"summary":"Set the image for the frontend API.","description":"Set the jpeg image to be associated with the API.","operationId":"postImage_1","parameters":[{"name":"id","in":"path","description":"The frontend API identifier.","required":true,"schema":{"type":"string"}},{"name":"type","in":"query","schema":{"type":"string"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"file":{"type":"string","format":"binary"}}}}}},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"413":{"description":"Request Entity Too Large"},"500":{"description":"Internal Server Error"}}}},"/proxies/grantaccess":{"post":{"tags":["API Proxy Registration"],"summary":"Macro function to grant API access.","description":"Function to macro-apply access to selected API. The access can be granted to organizations or entities having access to specified API. If **action** is _all_orgs_, access will be granted to all organizations; if **action** is _orgs_, access will be granted to the organization(s) specified by **grantOrganizations**; if **action** is _orgs\\_with\\_apis_, access will be granted to the organizations with access to the apis specified by **grantApis**.","operationId":"grantAccess_1","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"required":["action","apiId","grantApiId","grantOrgId"],"type":"object","properties":{"action":{"type":"string","description":"Grant action to perform. Possible values are: all\\_orgs, orgs, and orgs\\_with\\_apis."},"apiId":{"type":"array","description":"List of API ID to which access will be granted.","items":{"type":"string","description":"List of API ID to which access will be granted."}},"grantOrgId":{"type":"array","description":"List of target organization ID to which access to _apiId_ will be granted (action is _orgs_)","items":{"type":"string","description":"List of target organization ID to which access to _apiId_ will be granted (action is _orgs_)"}},"grantApiId":{"type":"array","description":"List of API ID to which access to to _apiId_ will be granted (action is _orgs\\_with\\_apis_).","items":{"type":"string","description":"List of API ID to which access to to _apiId_ will be granted (action is _orgs\\_with\\_apis_)."}}}}}}},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/proxies/import":{"post":{"tags":["API Proxy Registration"],"summary":"Imports a previously exported API.","description":"Imports API, previously exported using [/exportApis](APIProxyRegistration.html#APIProxyRegistrationexportApis). If the API was exported using a password, then the file is encrypted, and a **password** argument must be provided to decrypt. The import will create [VirtualizedAPI](VirtualizedAPI.html), their settings, and all backend [APIDefinition](APIDefinition.html) necessary to support the frontend API. This method is similar to [/importFromUrl](APIProxyRegistration.html#APIProxyRegistrationimportFromUrl), save that this method supports traditional form-based file upload, using `multipart/form-data`.","operationId":"importApisFromFile_2","requestBody":{"content":{"multipart/form-data":{"schema":{"required":["file","organizationId","password"],"type":"object","properties":{"organizationId":{"type":"string","description":"The organization identifier."},"password":{"type":"string","description":"Optional password to decrypt the import file."},"file":{"type":"object","description":"The data file to import."}}}}}},"responses":{"201":{"description":"Created"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/proxies/importFromUrl":{"post":{"tags":["API Proxy Registration"],"summary":"Imports a previously exported API.","description":"Imports API, previously exported using [/exportApis](APIProxyRegistration.html#APIProxyRegistrationexportApis). If the API was exported using a password, then the file is encrypted, and a **password** argument must be provided to decrypt. The import will create [VirtualizedAPI](VirtualizedAPI.html), their settings, and all backend [APIDefinition](APIDefinition.html) necessary to support the frontend API. The **url** should be a [data URI scheme](http://en.wikipedia.org/wiki/Data_URI_scheme).","operationId":"importApisFromUrl_1","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"required":["organizationId","password","url"],"type":"object","properties":{"organizationId":{"type":"string","description":"The organization identifier."},"url":{"type":"string","description":"The data URI."},"password":{"type":"string","description":"Optional password to decrypt the import file."}}}}}},"responses":{"201":{"description":"Created"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/proxies/promote":{"post":{"tags":["API Proxy Registration"],"summary":"Invokes the internal API promotion policy for the specified API.","description":"In API Manager, API promotion must first be enabled in Settings. Also, in Policy Studio (Server Settings -> API Manager -> API Promotion) a promotion policy must be selected. By default a sample promotion policy is installed","operationId":"promoteApis_1","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"required":["apiId"],"type":"object","properties":{"apiId":{"type":"array","description":"The frontend API identifier(s) to promote","items":{"type":"string","description":"The frontend API identifier(s) to promote"}}}}}}},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/proxies/{id}/publish":{"post":{"tags":["API Proxy Registration"],"summary":"Publish the API.","description":"If called by an API Administrator, then the API state will be _published_, otherwise the API state will be _pending_, and an email notification will be sent to the API Administrators, notifying them of the event. Optionally, on publishing, a new **name** for the API may be specified. Similarly, an optional **vhost** may be specified. The **vhost** is an externally resolvable virtual host from which the API will be accessed.","operationId":"publishApi_1","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","description":"The frontend API identifier."}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"The name on which to publish this API."},"vhost":{"type":"string","description":"The optional virtual host on which to publish this API."}}}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VirtualizedAPI"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/proxies/{id}/undeprecate":{"post":{"tags":["API Proxy Registration"],"summary":"Undeprecates the API.","description":"Only an API Administrator may undeprecate an API, and only _published_ API, that are deprecated, may be undeprecated.","operationId":"undeprecateApi_1","parameters":[{"name":"id","in":"path","description":"The frontend API identifier.","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VirtualizedAPI"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/proxies/{id}/unpublish":{"post":{"tags":["API Proxy Registration"],"summary":"Unpublish the API.","description":"Only an API Administrator may unpublish an API. When an API is _unpublished_, all access to the API is revoked from all applications, and all organizations, save the API development organization that owns the API.","operationId":"unpublishApi_1","parameters":[{"name":"id","in":"path","description":"The frontend API identifier.","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VirtualizedAPI"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/proxies/upgrade/{id}":{"post":{"tags":["API Proxy Registration"],"summary":"Upgrades an existing frontend API to a newer frontend API.","description":"During an API lifecycle, it is necessary to upgrade users to use a newer frontend API. The idea being that the old frontend API should be phased-out, and developers should move their applications to use the newer frontend API. This method assigns all organizations and applications the same access to the new frontend API (identified by **upgradeApiId**) that they have to the old API (identified by **id**). Optionally, the old frontend API may be deprecated or retired using **deprecate**, **retire**, or scheduled to be retired using **retirementDate**. If specified, the **retirementDate** should be in the ISO-8601 format of yyyy-MM-ddTHH:mm:ssZ (e.g. 2015-01-01T12:00:00Z).","operationId":"upgradeApi_1","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"required":["deprecate","retire","retirementDate","upgradeApiId"],"type":"object","properties":{"upgradeApiId":{"type":"string","description":"The id of the frontend API which will be used to upgrade this virtualized API"},"deprecate":{"type":"boolean","description":"Specifies whether or not the API being upgraded should be deprecated"},"retire":{"type":"boolean","description":"Specifies whether or not the API being upgraded should be retired"},"retirementDate":{"type":"string","description":"Specifies the retirement date of the the API being upgraded if its being retired"}}}}}},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/quotas":{"get":{"tags":["Quotas"],"summary":"Returns all quotas","description":"This method may be called by any member of the Portal, however only the API Administrator may retrieve the system quota.","operationId":"getAllQuotas_1","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/QuotaDTO"}}}}},"204":{"description":"No Content"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}}},"post":{"tags":["Quotas"],"summary":"Creates a new quota","description":"Creates a new quota. Only API Administrators may create quotas.","operationId":"createQuota","responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/QuotaDTO"}}}},"500":{"description":"Internal Server Error"}}}},"/quotas/{id}":{"get":{"tags":["Quotas"],"summary":"Returns the quota with the given ID","description":"Returns a quota. This method may be called by any member of the Portal, however, only API Administrators may retrieve the system quota.","operationId":"getQuota","parameters":[{"name":"id","in":"path","description":"The quota ID to retrieve.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/QuotaDTO"}}}},"204":{"description":"No Content"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}}},"put":{"tags":["Quotas"],"summary":"Updates a quota","description":"Updates an existing quota. Only API Administrators may update quotas.","operationId":"updateQuota","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/QuotaDTO"}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}}},"delete":{"tags":["Quotas"],"summary":"Deletes a quota","description":"Deletes a quota. Only API Administrators may update quotas. Default system and application quotas may not be deleted.","operationId":"deleteQuota","parameters":[{"name":"id","in":"path","description":"The quota ID to delete.","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}}}},"/apirepo":{"get":{"tags":["API Repository"],"summary":"Get the list of API","description":"Get the list of API from the API repository. The list of API can be filtered using the expression: field=__field__&op=__op__&value=__value__. Optionally, you can add a logical operation for all expressions, using the form: &lop=AND|OR. By default, the logical operation is AND. Multiple expression filters can be used, specifying field, op, and value for each filter. The __field__ is one of:\n\nid\n: Matches the API by ID\n\nname\n: Matches the API by name\n\ndescription\n: Matches the API by description\n\nversion\n: Matches the API by version\n\ncreatedOn\n: The date the backend API was created/imported on, time in ms, e.g.: 1372755998542\n\nresourcePath\n: Matches the API by resourcePath\n\nbasePath\n: Matches the API by basePath\n\norganization\n: Matches the API by it's organization identifier\n\nThe __op__ is an operation and is one of:\n\neq\n: Equal\n\nne\n: Not equal\n\ngt\n: Greater than\n\nlt\n: Less than\n\nge\n: Greater than or equal\n\nle\n: Less than or equal\n\nlike\n: Like\n\ngele\n: Greater than or equal to, and less than or equal to; the __value__ should be a lower-minimum and upper-maximum separated by comma, e.g: value=5,10\n\nThe __value__ will be compared against the __field__, according to the supplied __op__.\n\n","operationId":"getAllApis","parameters":[{"name":"field","in":"query","description":"Filter field name.","schema":{"type":"array","items":{"type":"string"}}},{"name":"op","in":"query","description":"Filter operation.","schema":{"type":"array","items":{"type":"string"}}},{"name":"value","in":"query","description":"Filter value","schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIDefinition"}},"application/octet-stream":{"schema":{"$ref":"#/components/schemas/APIDefinition"}}}},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"post":{"tags":["API Repository"],"summary":"Create an API definition","description":"When creating an API, the __name__ and __basePath__ are required.","operationId":"createApi_1","requestBody":{"description":"The API resource to create.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIDefinition"}}},"required":true},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIDefinition"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/apirepo/importFromUrl":{"post":{"tags":["API Repository"],"summary":"Create an API by loading a file from URL.","description":"Imports an API definition from a valid standard Swagger, WSDL or WADL definition from the specified __url__. It is possible to supply an optional __username__ and __password__ if the __url__ requires HTTP Basic authentication. On import, the original API definition is retained, but the API is converted to an internal format for processing. The API name currently defaults to the filename but this will be deprecated in a future release. The name parameter should be used to name the API and will be required in a future release.","operationId":"createApiFromUrl_1","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"required":["organizationId","type","url"],"type":"object","properties":{"organizationId":{"type":"string","description":"The API development organization ID that owns the import."},"name":{"type":"string","description":"The name of the API."},"fileName":{"type":"string","description":"The file name of the import."},"type":{"type":"string","description":"The type of import, one of: swagger, wadl."},"url":{"type":"string","description":"The URL to import."},"username":{"type":"string","description":"HTTP Basic username to use for connection."},"password":{"type":"string","description":"HTTP Basic password to use for connection."}}}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIDefinition"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/apirepo/{id}/methods":{"get":{"tags":["API Repository"],"summary":"Queries the list of API methods","description":"Get the list of API methods from the API repository. The list of methods can be filtered using the expression: field=__field__&op=__op__&value=__value__. Optionally, you can add a logical operation for all expressions, using the form: &lop=AND|OR. By default, the logical operation is AND. Multiple expression filters can be used, specifying field, op, and value for each filter. The __field__ is one of:\n\nid\n: Matches the API by ID\n\nname\n: Matches the API by name\n\nThe __op__ is an operation and is one of:\n\neq\n: Equal\n\nne\n: Not equal\n\ngt\n: Greater than\n\nlt\n: Less than\n\nge\n: Greater than or equal\n\nle\n: Less than or equal\n\nlike\n: Like\n\ngele\n: Greater than or equal to, and less than or equal to; the __value__ should be a lower-minimum and upper-maximum separated by comma, e.g: value=5,10\n\nThe __value__ will be compared against the __field__, according to the supplied __op__.\n\n","operationId":"getMethods_1","parameters":[{"name":"field","in":"query","description":"Filter field name.","schema":{"type":"array","items":{"type":"string"}}},{"name":"op","in":"query","description":"Filter operation.","schema":{"type":"array","items":{"type":"string"}}},{"name":"value","in":"query","description":"Filter value","schema":{"type":"array","items":{"type":"string"}}},{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Method"}}}},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"post":{"tags":["API Repository"],"summary":"Create an API method","operationId":"createMethod_1","parameters":[{"name":"id","in":"path","description":"The API identifier to create a method.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"The API identifier to create a method.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Method"}}},"required":true},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Method"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/apirepo/{id}":{"get":{"tags":["API Repository"],"summary":"Get an API by ID","operationId":"getApi","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIDefinition"}}}},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"put":{"tags":["API Repository"],"summary":"Updates an API","operationId":"updateApi","parameters":[{"name":"id","in":"path","description":"The API identifier.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"The API resource to update.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIDefinition"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIDefinition"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"delete":{"tags":["API Repository"],"summary":"Deletes an API.","description":"Deletes a backend API.","operationId":"deleteApi","parameters":[{"name":"id","in":"path","description":"The API identifier.","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/apirepo/{id}/methods/{methodId}":{"get":{"tags":["API Repository"],"summary":"Get API method by ID.","description":"Retrieves a method for a given API.","operationId":"getMethodById_1","parameters":[{"name":"id","in":"path","description":"The API identifier.","required":true,"schema":{"type":"string"}},{"name":"methodId","in":"path","description":"The API method ID.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Method"}}}},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"put":{"tags":["API Repository"],"summary":"Update an API method","operationId":"updateMethod_1","parameters":[{"name":"id","in":"path","description":"The API identifier to create a method.","required":true,"schema":{"type":"string"}},{"name":"methodId","in":"path","description":"The API identifier.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"The method to update.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Method"}}},"required":true},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Method"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"delete":{"tags":["API Repository"],"summary":"Delete an API method","description":"Deletes a backend API method.","operationId":"deleteMethod","parameters":[{"name":"id","in":"path","description":"The API identifier.","required":true,"schema":{"type":"string"}},{"name":"methodId","in":"path","description":"The method identifier.","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/apirepo/{id}/download":{"get":{"tags":["API Repository"],"summary":"Downloads an API by ID.","description":"Downloads an API by ID. If __filename__ is not supplied, the API name will be used. If the API was imported using [/import](#importApisFromFile) or [/import](#createApiFromUrl), then it is possible to download the original API definition by setting __original__ to __true__.","operationId":"downloadApi_1","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"name":"filename","in":"query","description":"Override the default filename for download","required":true,"schema":{"type":"string"}},{"name":"original","in":"query","description":"If true, and the API was imported, this will download the original definition","required":true,"schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"OK"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/apirepo/import":{"post":{"tags":["API Repository"],"summary":"Create an API by uploading a file","description":"Imports an API definition from a valid standard Swagger or WADL definition. On import, the original API definition is retained, but the API is converted to an internal format for processing.","operationId":"importApisFromFile","requestBody":{"content":{"multipart/form-data":{"schema":{"required":["file","name","organizationId","type"],"type":"object","properties":{"organizationId":{"type":"string","description":"The API development organization ID that owns the import."},"name":{"type":"string","description":"The API name."},"type":{"type":"string","description":"The type of import, one of: swagger, wadl."},"file":{"type":"string","description":"The API definition file to import","format":"binary"}}}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIDefinition"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/apirepo/importFromExternal":{"post":{"tags":["API Repository"],"summary":"Create one or more backend APIs for an external service","description":"Create one or more backend APIs for an external service. External APIs are imported via a connector. If the connector configuration specifies that all external APIs should be merged into a single new backend API, the name and description parameters are applied to this new API. Alternatively, if the connector specifies that a separate backend API should be created for each external API, the name and description parameters are ignored, and the names and descriptions of the new backend APIs are taken from the external service definitions.","operationId":"importFromExternal_1","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"required":["api","connectorId","description","name","organizationId"],"type":"object","properties":{"organizationId":{"type":"string","description":"The API development organization that owns the new APIs"},"connectorId":{"type":"string","description":"The API connector through which new APIs should be created"},"name":{"type":"string","description":"The name of the merged API (see description)"},"description":{"type":"string","description":"A description of the merged API (see description)"},"api":{"type":"string","description":"List of external APIs to be imported"}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIDefinition"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/apirepo/importFromGw":{"post":{"tags":["API Repository"],"summary":"Create an API definition by importing a PolicyStudio-registered web service (REST) hosted on the the API Gateway","description":"Imports an API definition from a Policy Studio REST service hosted on the API Gateway. On import, a Swagger representation of the original API definition is retained, but the API is converted to an internal format for processing.","operationId":"importFromGw_1","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"required":["id","name","organizationId"],"type":"object","properties":{"id":{"type":"string","description":"The id of the PolicyStudio-registered service to import."},"name":{"type":"string","description":"The service name."},"organizationId":{"type":"string","description":"The API development organization ID that owns the import."},"instance":{"type":"string"},"host":{"type":"string"},"port":{"type":"string"},"username":{"type":"string"},"password":{"type":"string"}}}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIDefinition"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/users/{id}/approve":{"post":{"tags":["Users"],"summary":"Grants approval to a request to create a new user on the system.","description":"Approving user must be API Manager Administrator or an Organization Administrator of the user's organization with the correct privileges to approve new user requests.","operationId":"approveUser_1","parameters":[{"name":"id","in":"path","description":"The ID of the user to be approved.","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/User"}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"},"default":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/User"}}}}}}},"/users/{id}/changepassword":{"post":{"tags":["Users"],"summary":"Updates the password for a given user.","description":"The authenticated user must be API Manager Administrator or an Organization Administrator of the user's organization with the correct privileges to invoke this method.","operationId":"changePassword_2","parameters":[{"name":"id","in":"path","description":"The ID of the user being updated.","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"404":{"description":"Not Found"}}}},"/users":{"get":{"tags":["Users"],"summary":"Obtains a list of users","description":"Returns a list of users that are visible to the authenticated user. The list of users can be filtered using the expression: field=__field__&op=__op__&value=__value__. Optionally, you can add a logical operation for all expressions, using the form: &lop=AND|OR. By default, the logical operation is AND. Multiple expression filters can be used, specifying field, op, and value for each filter. The __field__ is one of:\n\napiid\n: Matches the user if the user has explicit access to application(s) that are using the API, specified by ID\n\nappid\n: Matches the user if the user has explicit access to the application, specified by ID\n\ndescription\n: The user's description\n\nemail\n: The user's email address\n\nenabled\n: The enabled state of the user, one of: enabled, disabled\n\ncreatedOn\n: The date the user was created on, time in ms, e.g.: 1372755998542\n\nmobile\n: The user's mobile phone\n\nname\n: The name of the user\n\nloginName\n: The login name of the user\n\norgid\n: Matches the user if the user is a member of the organization, specified by ID\n\nphone\n: The user's phone\n\nrole\n: The user's role, one of: user or oadmin\n\nstate\n: The user's current state, one of: approved, pending\n\nsurname\n: The surname of the user\n\nThe __op__ is an operation and is one of:\n\neq\n: Equal\n\nne\n: Not equal\n\ngt\n: Greater than\n\nlt\n: Less than\n\nge\n: Greater than or equal\n\nle\n: Less than or equal\n\nlike\n: Like\n\ngele\n: Greater than or equal to, and less than or equal to; the __value__ should be a lower-minimum and upper-maximum separated by comma, e.g: value=5,10\n\nThe __value__ will be compared against the __field__, according to the supplied __op__.","operationId":"getUsers_1","parameters":[{"name":"field","in":"query","description":"Filter field name.","schema":{"type":"array","items":{"type":"string"}}},{"name":"op","in":"query","description":"Filter operation.","schema":{"type":"array","items":{"type":"string"}}},{"name":"value","in":"query","description":"Filter value","schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/User"}}}}},"400":{"description":"Bad Request"},"500":{"description":"Internal Server Error"}}},"post":{"tags":["Users"],"summary":"Admin function to create a new user on the system","description":"Creates a new user on the system. Only Organization Administrators and API Manager Administrators may create users. Data posted in this request may include custom properties defined in app.config.","operationId":"createUser_1","responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/User"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"413":{"description":"Request Entity Too Large"},"500":{"description":"Internal Server Error"}}}},"/users/{id}":{"get":{"tags":["Users"],"summary":"Retrieves the details for a given user.","description":"Retrieves user details, given a user ID. The API Manager Administrator may access all users, otherwise, the user ID must be a member of the authenticated user's own organization.","operationId":"getUser_1","parameters":[{"name":"id","in":"path","description":"The ID of the user to be retreived.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/User"}}}},"404":{"description":"Not Found"}}},"put":{"tags":["Users"],"summary":"Updates the details for a given user.","description":"Updates user details, given a user ID. The API Manager Administrator may update all users, otherwise, the user ID must be a member of the authenticated user's own organization and the authenticated user must be an Organization Administrator.","operationId":"updateUser_1","parameters":[{"name":"id","in":"path","description":"The ID of the user being updated.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/User"}}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}}},"delete":{"tags":["Users"],"summary":"Deletes a user.","description":"Deletes a user with the given user ID. All the applications and keys associated with the deleted user remain in the organization and can be managed by the Organization Administrator or the API Administrator. The API Administrator can delete any user. The Organization Administrators can only delete users belonging to their organizations..","operationId":"deleteUser_1","parameters":[{"name":"id","in":"path","description":"The user ID to delete","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}}},"/users/forgotpassword":{"post":{"tags":["Users"],"summary":"Allows a user to reset their password.","description":"When this method is invoked, an email is sent to the owner of _email_ to verify that they wish for their password to be reset. The owner of _email_ must click on a link to reset the password. The link should direct the user to [/resetpassword](#APIUsersresetForgottenPassword) with appropriate query paremeters. Redirect URLs may be specified for success and failure conditions. If redirect URLs are specified, they must be a known Static File listener configured in the gateway or the request will be rejected.","operationId":"forgotUserPassword_1","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"required":["email"],"type":"object","properties":{"email":{"type":"string","description":"The email address of the user."},"success":{"type":"string","description":"The redirect success location (e.g. /request-forgotten-pw-success)"},"failure":{"type":"string","description":"The redirect failure location (e.g. /request-forgotten-pw-failed)"}}}}}},"responses":{"201":{"description":"Created"},"303":{"description":"See Other"},"400":{"description":"Bad Request"}}}},"/users/{id}/image":{"get":{"tags":["Users"],"summary":"Get the image for a user","description":"Returns the jpeg image associated with an user.","operationId":"getImage_2","parameters":[{"name":"id","in":"path","description":"The user ID whos image is to be returned","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}}},"post":{"tags":["Users"],"summary":"Set the image for a user","description":"Set the jpeg image to be associated with a user.","operationId":"postImage_2","parameters":[{"name":"id","in":"path","description":"The user ID for which an image is to be updated","required":true,"schema":{"type":"string"}},{"name":"type","in":"query","description":"This value should be unset","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"413":{"description":"Request Entity Too Large"},"500":{"description":"Internal Server Error"}}}},"/users/register":{"post":{"tags":["Users"],"summary":"Register a new user.","description":"Allows a user to register for an account on the system. A validation email request is sent to the provided email address to confirm ownership. The email should contain a link to [/validateuser](#APIUsersvalidateUser) with appropriate parameters. User properties (including custom properties) may be supplied as form parameters. The method will return JSON, but optionally, redirect URLs may be specified for success and failure conditions. If redirect URLs are specified, they must be a known Static File listener configured in the gateway or the request will be rejected.","operationId":"registerUser_1","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"required":["email","name","password"],"type":"object","properties":{"name":{"type":"string","description":"The name of the user to register."},"email":{"type":"string","description":"The unique email address of the user to register."},"password":{"type":"string","description":"The password of the user to register."},"token":{"type":"string","description":"The registration token to use."},"success":{"type":"string","description":"The redirect success location (e.g. '/registration-success')"},"failure":{"type":"string","description":"The redirect failure location (e.g. '/registration-failed')"}}}}}},"responses":{"201":{"description":"Created"},"303":{"description":"See Other"},"404":{"description":"Bad Request"}}}},"/users/resetpassword":{"get":{"tags":["Users"],"summary":"Validates the user [/forgotpassword](#APIUsersforgotUserPassword) password request.","description":"User validation code and email address are expected as query string parameters. When invoked, an email will be sent to the user with their new password.","operationId":"resetForgottenPassword_1","parameters":[{"name":"email","in":"query","description":"The email address of the user being validated.","required":true,"schema":{"type":"string"}},{"name":"validator","in":"query","description":"Validation string for the user entry.","required":true,"schema":{"type":"string"}}],"responses":{"303":{"description":"See Other"},"404":{"description":"Not Found"}}}},"/users/{id}/resetpassword":{"put":{"tags":["Users"],"summary":"Admin level function to reset the password for a given user.","description":"The authenticated user must be API Manager Administrator or an Organization Administrator of the user's organization with the correct privileges to invoke this method.","operationId":"resetUserPassword_1","parameters":[{"name":"id","in":"path","description":"The ID of the user having password reset administratively.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/User"}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}}}},"/users/validateuser":{"get":{"tags":["Users"],"summary":"Validates the user [/register](#APIUsersregisterUser) request.","description":"User validation code and email address are expected as query parameters.","operationId":"validateUser_1","parameters":[{"name":"email","in":"query","description":"The email address of the user being validated.","required":true,"schema":{"type":"string"}},{"name":"validator","in":"query","description":"Validation string for the user entry.","required":true,"schema":{"type":"string"}}],"responses":{"303":{"description":"See Other"},"500":{"description":"Bad Request"}}}},"/currentuser/changepassword":{"post":{"tags":["Current User"],"summary":"Modify the current user's password","description":"Modify the password of the authenticated user","operationId":"changePassword","responses":{"204":{"description":"No Content"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/currentuser":{"get":{"tags":["Current User"],"summary":"Get the current user","description":"Get the account details of the authenticated user","operationId":"getCurrentUser_1","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/User"}}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"put":{"tags":["Current User"],"summary":"Modify the current user","description":"Modify the account details of the authenticated user","operationId":"updateCurrentUser_1","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/User"}}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/discovery/apis":{"get":{"tags":["API Discovery"],"summary":"Lists all APIs/services virtualised in the API Server.","description":"Lists all APIs/services virtualised in the API Server. API Administrators see all APIs/services. Users see APIs/services for their organization.","operationId":"getAPIs_1","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DiscoveryAPI"}}}}},"500":{"description":"Internal Server Error"}}}},"/discovery/swagger/apis/{id}/image":{"get":{"tags":["API Discovery"],"summary":"Retrieves the API image","operationId":"getApiImage_1","parameters":[{"name":"id","in":"path","description":"The API identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK"},"500":{"description":"Internal Server Error"}}}},"/discovery/swagger/apis/{id}/service-definition":{"get":{"tags":["API Discovery"],"summary":"Retrieves the service definition of the API.","operationId":"getApiServiceDefinition_1","parameters":[{"name":"id","in":"path","description":"The API identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK"},"500":{"description":"Internal Server Error"}}}},"/discovery/oauthresources":{"get":{"tags":["API Discovery"],"summary":"Gets a list OAuth protected resources and their associated scopes.","description":"Gets a list OAuth protected resources and their associated scopes.","operationId":"getOAuthResources_1","responses":{"200":{"description":"OK"}}}},"/discovery/scopes":{"get":{"tags":["API Discovery"],"summary":"Retrieves every resource on the API Server that is protected by OAuth, and the scopes that cover those resources","description":"Retrieves every resource on the API Server that is protected by OAuth, and the scopes that cover those resources. Only API Administrators will be able to retrieve information.","operationId":"getScopes_1","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/OAuthProtectedResource"}}}}},"500":{"description":"Internal Server Error"}}}},"/discovery/swagger/api/id/{id}":{"get":{"tags":["API Discovery"],"summary":"Retrieves an extended Swagger feed for the specified API.","description":"Retrieves an extended Swagger feed for the specified API. API Administrators will always see the API. Users will only see the API if it is available for their organization.If __filename__ is supplied, the download will use it as the `Content-Disposition` filename attachment.","operationId":"getSwaggerAPI_1","parameters":[{"name":"id","in":"path","description":"The unique ID of the API to return","required":true,"schema":{"type":"string"}},{"name":"filename","in":"query","description":"Override the default filename for download","schema":{"type":"string"}},{"name":"swaggerVersion","in":"query","description":"The Swagger version of the feed, either 1.1 (default), 2.0 or 3.0.","schema":{"type":"string","default":"1.1"}},{"name":"extensions","in":"query","description":"If true, extensions such as the x-axway object are returned in the Swagger definitions (default=true)","schema":{"type":"boolean","default":true}},{"name":"User-Agent","in":"header","description":"The user agent header sent by the browser (default='')","schema":{"type":"string","default":""}}],"responses":{"200":{"description":"OK"},"400":{"description":"Bad Request"},"500":{"description":"Internal Server Error"}}}},"/discovery/swagger/apis":{"get":{"tags":["API Discovery"],"summary":"Convenience method for retrieving all Swagger feeds for all virtualised services.","description":"Convenience method for retrieving all Swagger feeds for all virtualised services that are visible to the authenticated user. The list of APIs can be filtered using the expression: field=__field__&op=__op__&value=__value__. Optionally, you can add a logical operation for all expressions, using the form: &lop=AND|OR. By default, the logical operation is AND. Multiple expression filters can be used, specifying field, op, and value for each filter. The __field__ is one of:\n\nid\n: Matches the API by the specified ID\n\nname\n: Matches the API by the specified name\n\ntitle\n: Swagger 2.0 only: Matches the API by the specified title/name\n\ndescription\n: Matches the API by the specified description\n\nsummary\n: Swagger 1.2 only: Matches the API by the specified summary\n\nversion\n: Matches the API by the specified version\n\ntype\n: Matches the API by the specified type. Type can be 'rest' or 'wsdl'\n\nresourcepath\n: Swagger 1.2 only: Matches the API by the specified inbound path\n\nbasepath\n: Swagger 2.0 only: Matches the API by the specified inbound path\n\ntaggroup\n: Matches the API by the specified tag group\n\ntag\n: Matches the API by the specified tag value\n\nmethodtaggroup\n: Matches the API by the specified method tag group, i.e. if the API contains a method that contains a tag group matching that specified\n\nmethodtag\n: Matches the API by the specified method tag value, i.e. if the API contains a method that contains a tag value matching that specified\n\nThe __op__ is an operation and is one of:\n\neq\n: Equal\n\nne\n: Not equal\n\ngt\n: Greater than\n\nlt\n: Less than\n\nge\n: Greater than or equal\n\nle\n: Less than or equal\n\nlike\n: Like\n\ngele\n: Greater than or equal to, and less than or equal to; the __value__ should be a lower-minimum and upper-maximum separated by comma, e.g: value=5,10\n\nThe __value__ will be compared against the __field__, according to the supplied __op__. ","operationId":"getSwaggerAPIs_1","parameters":[{"name":"field","in":"query","description":"Filter field name.","schema":{"type":"array","items":{"type":"string"}}},{"name":"op","in":"query","description":"Filter operation.","schema":{"type":"array","items":{"type":"string"}}},{"name":"value","in":"query","description":"Filter value","schema":{"type":"array","items":{"type":"string"}}},{"name":"swaggerVersion","in":"query","description":"The Swagger version","schema":{"type":"string","default":"1.2"}}],"responses":{"200":{"description":"OK"},"500":{"description":"Internal Server Error"}}}},"/login":{"post":{"tags":["Login"],"summary":"Login to API Manager","description":"Logs a user, identified by _username_ and _password_, into the API Manager by creating unique a session cookie. The _success_ parameter defaults to a named URL identified by \"/home\" and will return a redirect to the portal after login. The _failure_ parameter is optional. If _failure_ is not specified, and the login attempt fails, this method returns a JSON error response. If _failure_ is specified, and the login attempt fails, then this method will redirect to a named URL, identified by \"/login-failed\".","operationId":"login_1","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"required":["password","username"],"type":"object","properties":{"username":{"type":"string","description":"The login name of the authenticating user"},"password":{"type":"string","description":"The password of the authenticating user"},"success":{"type":"string","description":"The redirect success location (defaults to: /home)"},"failure":{"type":"string","description":"Optional redirect failure location (e.g. /login-failed"}}}}}},"responses":{"303":{"description":"See Other"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"409":{"description":"Conflict"},"500":{"description":"Internal Server Error"}}},"delete":{"tags":["Login"],"summary":"Logout from API Manager","description":"Destroys the caller session with the API Manager.","operationId":"logout_1","responses":{"204":{"description":"No Content"}}}},"/connectors":{"get":{"tags":["API Manager Services"],"summary":"Return a list of API connectors","description":"Return a list of API connectors.","operationId":"getConnectors","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Connector"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/config/customproperties":{"get":{"tags":["API Manager Services"],"summary":"Gets API Manager custom property metadata","description":"Returns an API Manager configuration object containing the metadata for the custom properties defined in the API Manager app.config.","operationId":"getCustomPropertiesConfig","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomPropertiesConfig"}}}},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/connectors/{connectorId}":{"get":{"tags":["API Manager Services"],"summary":"Return a list of APIs for the specified connector","description":"Return a list of APIs for the specified connector.","operationId":"getExternalApis","parameters":[{"name":"connectorId","in":"path","description":"ID of the connector for which APIs should be returned. Connector IDs can be retrieved by calling /connectors.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ExternalApi"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/connectors/{connectorId}/login":{"post":{"tags":["API Manager Services"],"summary":"Login to an external service from which APIs will be imported","description":"Login to an external service from which APIs will be imported.","operationId":"storeConnectorCredentials","parameters":[{"name":"connectorId","in":"path","description":"ID of the API connector. Connector IDs can be retrieved by calling /connectors.","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"required":["password","username"],"type":"object","properties":{"username":{"type":"string","description":"External service username"},"password":{"type":"string","description":"External service password"}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"string"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/proxies/{id}/applications":{"get":{"tags":["API Proxy Registration"],"summary":"Gets a list of Applications that have been granted access to the specified frontend API.","operationId":"getApiApplications","parameters":[{"name":"id","in":"path","description":"The frontend API identifier.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Application"}}}}},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/discovery/sdk/{id}/{platform}":{"get":{"tags":["API Discovery"],"summary":"Generates an SDK package for the specified API based on the type of the client requested","description":"Generates a client SDK package for the specified API based on the platform. Supported platform are Android, iOS-swift, NodeJS","operationId":"getClientSDK","parameters":[{"name":"id","in":"path","description":"The name of the API to generate the client SDK package for","required":true,"schema":{"type":"string"}},{"name":"platform","in":"path","description":"Generated client type, one of: android, iOS-swift, nodejS","required":true,"schema":{"type":"string"}},{"name":"packagename","in":"query","description":"Java package name generated only for Android platform. It must be a valid java package name.","schema":{"type":"string","default":"com.axway"}}],"responses":{"200":{"description":"OK"},"500":{"description":"Internal Server Error"}}}}},"components":{"schemas":{"Application":{"required":["name","organizationId"],"type":"object","properties":{"id":{"type":"string","description":"The unique identifier for the application","readOnly":true,"example":"b76a3e23-deca-49ab-9682-79cd503b7e3a"},"name":{"type":"string","description":"The display name for the application","example":"My First iPhone App"},"description":{"type":"string","description":"Descriptive text for the application","example":"My First iPhone App which is a \"Hello World\" basic application"},"organizationId":{"type":"string","description":"The organization identifier to which the application belongs","example":"3e21b76a-defa-49ab-9682-a9cd60387e37"},"phone":{"type":"string","description":"Contact phone number of the application","example":"+1 877-564-7700"},"email":{"type":"string","description":"The contact email address associated with the application","example":"support@acmecorp.com"},"createdBy":{"type":"string","description":"The unique identifier for user that created the application","readOnly":true,"example":"de077cd8-83b7-46d1-b06f-2eaaf1548898"},"managedBy":{"type":"array","description":"A list of unique identifier for users that manages the application","example":["de077cd8-83b7-46d1-b06f-2eaaf1548898"],"items":{"type":"string","description":"A list of unique identifier for users that manages the application","example":"[\"de077cd8-83b7-46d1-b06f-2eaaf1548898\"]"}},"createdOn":{"type":"integer","description":"Epoch/Unix time stamp when the application was created","format":"int64","readOnly":true,"example":1364407145121},"enabled":{"type":"boolean","description":"Flag to indicate if this application is enabled or not","example":false},"image":{"type":"string","description":"URI of the image to be used for this application, this field only indicates that the application has an image assigned to it. In order to retrieve the actual image use the following URL /api/portal/applications/{id}/image/","example":"resources/photo.jpg"},"state":{"type":"string","description":"Flag to indicate if an application has been approved by the API Manager admin or if delegated then the org admin","example":"approved"},"tags":{"type":"object","additionalProperties":{"type":"string"},"writeOnly":true}},"description":"API Manager application."},"APICookie":{"type":"object","properties":{"name":{"type":"string"},"value":{"type":"string"},"version":{"type":"integer","format":"int32"},"path":{"type":"string"},"domain":{"type":"string"},"comment":{"type":"string"},"maxAge":{"type":"integer","format":"int32"},"expiry":{"type":"string","format":"date-time"},"secure":{"type":"boolean"},"httpOnly":{"type":"boolean"},"sessionSameSiteRule":{"type":"string","enum":["Strict","Lax","None"]}}},"AuthenticatedUserAttributes":{"type":"object","properties":{"firstLogin":{"type":"boolean"},"isSSOLogin":{"type":"boolean"},"userDn":{"type":"string"},"lastSeen":{"type":"integer","format":"int64"},"passwordSetOn":{"type":"integer","format":"int64"},"changePassword":{"type":"boolean"},"changePasswordMessage":{"type":"string"}}},"ExportOptions":{"type":"object","properties":{"filename":{"type":"string","description":"If specified, the name of the file that the exported applications will be wrote to","example":"export.dat"},"password":{"type":"string","description":"Password value which, when specified, will be use to encrypt the output stream for the export","example":"1223425"},"appIds":{"type":"array","description":"List of the application ids that was chosen for export","example":"[c95b7c70-fe01-4e31-8f1f-cdd977812d7d]","items":{"type":"string","description":"List of the application ids that was chosen for export","example":"[c95b7c70-fe01-4e31-8f1f-cdd977812d7d]"}},"quota":{"type":"boolean","description":"Flag to indicate if api quota information is to be included in the export","example":false},"oauth":{"type":"boolean","description":"Flag to indicate if oauth credentials are to be included in the export","example":true},"apikeys":{"type":"boolean","description":"Flag to indicate if api keys are to be included in the export","example":false}}},"Session":{"type":"object","properties":{"randomDigest":{"type":"array","items":{"type":"string","format":"byte"}},"expiryTime":{"type":"integer","format":"int64"},"isSSOLogin":{"type":"boolean"},"creationTime":{"type":"integer","format":"int64"},"reqLimitSize":{"type":"integer","format":"int64"},"reqLimitOffset":{"type":"integer","format":"int64","writeOnly":true},"valueNames":{"type":"array","items":{"type":"string"}},"attributeNames":{"type":"object"}}},"SessionData":{"type":"object","properties":{"ssoCookie":{"$ref":"#/components/schemas/APICookie"},"session":{"$ref":"#/components/schemas/Session"},"sessionId":{"type":"string"},"staticSessionId":{"type":"string"},"apicookie":{"$ref":"#/components/schemas/APICookie"},"apistaticCookie":{"$ref":"#/components/schemas/APICookie"},"exportOptions":{"$ref":"#/components/schemas/ExportOptions"}}},"User":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier for the user","example":"2be9fc6e-1110-474f-8029-bf1577ec3801"},"organizationId":{"type":"string","description":"The unique identifier for the organization to which the user belongs","example":"6fb4bd38-199a-4e9f-8c11-43233f530d82"},"name":{"type":"string","description":"The user's name","example":"New User"},"description":{"type":"string","description":"A description of the user","example":"Created by admin"},"loginName":{"type":"string","description":"A unique login name for the user","example":"jbloggs"},"email":{"type":"string","description":"An email address for the user","example":"jbloggs@acmecorp.com"},"phone":{"type":"string","description":"The user's phone number","example":"+353 (1) 6742000"},"mobile":{"type":"string","description":"The user's mobile number","example":"+353 (89) 6742087"},"role":{"type":"string","description":"The user's role, one of: user, oadmin, or admin","example":"user"},"image":{"type":"string","description":"The user's photo. To update the image, please refer to the API.","example":"resources/photo.jpg"},"enabled":{"type":"boolean","description":"Indicates whether or not the user account is enabled or not","example":true},"createdOn":{"type":"integer","description":"Epoch/Unix time stamp when the organization was created","format":"int64","example":1367337125476},"state":{"type":"string","description":"The current state of the account, one of: approved, pending","example":"approved"},"type":{"type":"string","description":"Indicates the type of user. Possible values: internal, external","example":"internal"},"orgs2Role":{"type":"object","additionalProperties":{"type":"string","description":"Maps the organization Id to the user's role for that organization (optional)","example":"{\"63d434a6-f286-4d0e-9dc9-80b45b0f80f8\":\"user\"}"},"description":"Maps the organization Id to the user's role for that organization (optional)","example":{"63d434a6-f286-4d0e-9dc9-80b45b0f80f8":"user"}},"orgs2Name":{"type":"object","additionalProperties":{"type":"string","description":"Maps the organization Id to the organization name (read-only)","example":"{\"63d434a6-f286-4d0e-9dc9-80b45b0f80f8\":\"Axway Inc.\"}"},"description":"Maps the organization Id to the organization name (read-only)","example":{"63d434a6-f286-4d0e-9dc9-80b45b0f80f8":"Axway Inc."}},"authAttrs":{"$ref":"#/components/schemas/AuthenticatedUserAttributes"},"tags":{"type":"object","additionalProperties":{"type":"string"},"writeOnly":true},"orgName":{"type":"string","writeOnly":true},"dn":{"type":"string"}},"description":"The API Manager user is a member of organizations."},"APIKey":{"type":"object","properties":{"id":{"type":"string","description":"The ID which is used to identify the API Key. You include it in each request, so it's not a secret.","example":"19da5d5e-b18a-4217-abec-291033cd939c"},"applicationId":{"type":"string","description":"The ID which is used to identify an application. You include it in each request, so it's not a secret.","example":"19da5d5e-b18a-4217-abec-291033cd939c"},"secret":{"type":"string","description":"Each API Key ID has a Secret Key associated with it. This key is just a long string of characters that can be used to calculate the digital signature that can be included in requests. Your Secret Key is a secret do not distribute.","example":"19da5d5e-b18a-4217-abec-291033cd939c"},"enabled":{"type":"boolean","description":"Flag disables the API key so can't be used in authentication","example":true},"createdBy":{"type":"string","description":"The unique identifier for user that generated the API Key","readOnly":true,"example":"3e21b76a-defa-49ab-9682-a9cd60387e37"},"createdOn":{"type":"integer","description":"Epoch/Unix time stamp when the API key was created","format":"int64","readOnly":true,"example":1364287486876},"deletedOn":{"type":"integer","description":"Epoch/Unix time stamp when the API key was deleted","format":"int64","readOnly":true,"example":1364287486876},"corsOrigins":{"type":"array","description":"The domains to allow access for browser-based clients","example":"[example.com]","items":{"type":"string","description":"The domains to allow access for browser-based clients","example":"[example.com]"}}},"description":"API Manager API Key for use in authenticating applications"},"ApplicationRequest":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier for the application request","example":"b76a3e23-deca-49ab-9682-79cd503b7e3a"},"name":{"type":"string","description":"The display name for the application","example":"My First iPhone App"},"description":{"type":"string","description":"Descriptive text for the application","example":"My First iPhone App which is a \"Hello World\" basic application"},"organizationId":{"type":"string","description":"The organization identifier to which the application request belongs","example":"3e21b76a-defa-49ab-9682-a9cd60387e37"},"phone":{"type":"string","description":"Contact phone number of the application","example":"+1 877-564-7700"},"email":{"type":"string","description":"The contact email address associated with the application","example":"support@acmecorp.com"},"image":{"type":"string","description":"URI of the image to be used for this application, this field only indicates that the application has an image assigned to it. In order to retrieve the actual image use the following URL /api/portal/organizations/{uid of org}/image/","example":"resources/photo.jpg"},"apis":{"type":"array","description":"A list of unqiue API identifiers to which the application wants to use.","example":["c1c63d3b-5283-4755-ade7-e2377bd35049"],"items":{"type":"string","description":"A list of unqiue API identifiers to which the application wants to use.","example":"[\"c1c63d3b-5283-4755-ade7-e2377bd35049\"]"}},"tags":{"type":"object","additionalProperties":{"type":"string"},"writeOnly":true}},"description":"API Manager application request."},"ExternalClient":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the external client","readOnly":true,"example":"19da5d5e-b18a-4217-abec-291033cd939c"},"clientId":{"type":"string","description":"The 3rd party client ID. This client ID is provided by a 3rd party OAuth service and is used to map an application to an external client. This value is unique, i.e. no other application can specify the same client ID.","example":"296ec1ae-3fc7-4470-8d90-a6cc1482797f"},"enabled":{"type":"boolean","description":"Flag disables the external client so it can't be used in authentication","example":true},"createdBy":{"type":"string","description":"The unique identifier of the user that created the mapping","readOnly":true,"example":"3e21b76a-defa-49ab-9682-a9cd60387e37"},"createdOn":{"type":"integer","description":"Epoch/Unix time stamp when the mapping was created","format":"int64","readOnly":true,"example":1364287486876},"corsOrigins":{"type":"array","description":"The domains to allow access for browser-based clients","example":"[example.com]","items":{"type":"string","description":"The domains to allow access for browser-based clients","example":"[example.com]"}}},"description":"API Manager external client"},"OAuthClient":{"type":"object","properties":{"id":{"type":"string","description":"The client ID to be used in OAuth flows","example":"7b32f6c9-9e27-4def-87e2-247aadf7f583"},"cert":{"type":"string","description":"The PEM encodeded certificate used in JWT flow","example":"-----BEGIN CERTIFICATE-----MIICUTC..............-----END CERTIFICATE-----"},"secret":{"type":"string","description":"The client application secret to be used in OAuth flows","example":"ddf27559-ace0-4c4f-b5e4-ecf2086fddc5"},"type":{"type":"string","description":"OAuth defines two client types, based on their ability to authenticate securely with the authorization server. Possible values public or confidential","example":"public"},"enabled":{"type":"boolean","description":"Flag disables the OAuth credentials so they can't be used in authentication","example":true},"redirectUrls":{"type":"array","description":"The URL where the server will redirect the to present authorization codes or access tokens depending on the OAuth flow being executed","example":"[https://example.com/callback]","items":{"type":"string","description":"The URL where the server will redirect the to present authorization codes or access tokens depending on the OAuth flow being executed","example":"[https://example.com/callback]"}},"corsOrigins":{"type":"array","description":"The domains to allow access for browser-based clients","example":"[example.com]","items":{"type":"string","description":"The domains to allow access for browser-based clients","example":"[example.com]"}},"createdBy":{"type":"string","description":"The unique identifier for user that generated the OAuth credentials","readOnly":true,"example":"3e21b76a-defa-49ab-9682-a9cd60387e37"},"createdOn":{"type":"integer","description":"Epoch/Unix time stamp when the OAuth credentials was created","format":"int64","readOnly":true,"example":1364287486876},"applicationId":{"type":"string","description":"The application identifier associated with the OAuth credential"}},"description":"API Manager OAuth Credentials."},"PermissionDTO":{"type":"object","properties":{"id":{"type":"string","description":"The permission identifier","readOnly":true,"example":"46a6e874-a341-4c2d-870e-55e4c6ec27dc"},"userId":{"type":"string","description":"The user identifier","example":"46a6e874-a341-4c2d-870e-55e4c6ec27dc"},"permission":{"type":"string","description":"The privilege","example":"manage"},"createdBy":{"type":"string","description":"The unique identifier for user that create the permission","readOnly":true,"example":"de077cd8-83b7-46d1-b06f-2eaaf1548898"},"createdOn":{"type":"integer","description":"Epoch/Unix time stamp when the permission was created","format":"int64","readOnly":true,"example":1364407145121}},"description":"API Manager application permission."},"OAuthResource":{"required":["applicationId","id"],"type":"object","properties":{"id":{"type":"string","description":"The unique identifier for the oauth protected resource","example":"1e71b76a-defa-49ab-96s2-a9cd60387f31"},"applicationId":{"type":"string","description":"The unique identifier for the application who has access to this resource","example":"3e21b76a-defa-49ab-9682-a9cd60387e37"},"uriprefix":{"type":"string","description":"The uri prefix which this oauth protected resource relates to","example":"/api/oauth/protected"},"scopes":{"uniqueItems":true,"type":"array","description":"Set of scope strings that have been resolved from querying the OAuth Resource Service at the uri prefix","example":"email","items":{"type":"string","description":"Set of scope strings that have been resolved from querying the OAuth Resource Service at the uri prefix","example":"email"}},"enabled":{"type":"boolean","description":"Flag to indicate if this oauth protected resource is enabled or not","example":false},"scope":{"type":"string"},"isDefault":{"type":"boolean"}},"description":"OAuth protected resource."},"QuotaApiConstraintDTO":{"required":["type"],"type":"object","properties":{"api":{"type":"string","description":"The API identifier from API discovery, or '\\*' for all API","example":"60d1c7da-9e2e-4f57-948a-eeb1da71beca"},"method":{"type":"string","description":"The API method identifier from API discovery, or '\\*' for all methods","example":"0c5f8a4a-0e74-4e66-ad7b-e21962940e02"},"type":{"type":"string","description":"The restriction type, one of: throttle, throttlemb","example":"throttle"},"config":{"type":"object","additionalProperties":{"type":"string","description":"The restriction configuration","example":"{\"messages\":\"10\",\"per\":\"1\",\"period\":\"seconds\"}"},"description":"The restriction configuration","example":{"messages":"10","per":"1","period":"seconds"}}},"description":"The APIConstraint is restriction that applies to API(s) and API method(s)."},"QuotaDTO":{"required":["id","name","type"],"type":"object","properties":{"id":{"type":"string","description":"The quota identifier","example":"a1c70859-702b-4f3a-a1ad-a61067fdc4c7"},"type":{"type":"string","description":"API quota types","example":"APPLICATION","enum":["API","APPLICATION"]},"name":{"type":"string","description":"The name of the quota","example":"MyApplication Quota"},"description":{"type":"string","description":"The quota for MyApplication the overrides default Application quota","example":"A set of restrictions to MyApplication"},"restrictions":{"type":"array","description":"An array of restrictions imposed on the quota","items":{"$ref":"#/components/schemas/QuotaApiConstraintDTO"}},"system":{"type":"boolean","description":"Indicates if the quota is system (protected)","example":false}},"description":"The Quota is a set of restrictions that apply to applications in the Portal."},"OAuthAppScope":{"required":["applicationId","id"],"type":"object","properties":{"id":{"type":"string","description":"The unique identifier for the oauth protected resource","example":"1e71b76a-defa-49ab-96s2-a9cd60387f31"},"applicationId":{"type":"string","description":"The unique identifier for the application that has this scope","example":"3e21b76a-defa-49ab-9682-a9cd60387e37"},"scope":{"type":"string","description":"The scope string","example":"/api/oauth/protected"},"isDefault":{"type":"boolean","description":"Flag to indicate if this scope is one of the applications default scopes","example":false}},"description":"OAuth Application Scope"},"APIAccess":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier for approval decisions (includes pending approvals)","example":"19da5d5e-b18a-4217-abec-291033cd939c"},"apiId":{"type":"string","description":"Virtualised REST API unique id","example":"c1c63d3b-5283-4755-ade7-e2377bd35049"},"createdBy":{"type":"string","description":"The unique identifier for user that requested access","readOnly":true,"example":"3e21b76a-defa-49ab-9682-a9cd60387e37"},"state":{"type":"string","description":"Pending or approved state","example":"approved"},"createdOn":{"type":"integer","description":"Epoch/Unix time stamp when the approval decision was created ","format":"int64","readOnly":true,"example":1364287486876},"enabled":{"type":"boolean","description":"Flag disables access to an API for organization or application","example":true}},"description":"API Access indicates whether access to an API is available"},"OAuthScope":{"type":"object","properties":{"scope":{"type":"string","description":"Oauth Scope","example":"Read"},"description":{"type":"string","description":"Scope Description","example":"Read access to resource"}},"description":"OAuth Scope information."},"FormDataContentDisposition":{"type":"object","properties":{"type":{"type":"string"},"parameters":{"type":"object","additionalProperties":{"type":"string"}},"fileName":{"type":"string"},"creationDate":{"type":"string","format":"date-time"},"modificationDate":{"type":"string","format":"date-time"},"readDate":{"type":"string","format":"date-time"},"size":{"type":"integer","format":"int64"},"name":{"type":"string"}}},"BodyPart":{"type":"object","properties":{"contentDisposition":{"$ref":"#/components/schemas/ContentDisposition"},"entity":{"type":"object"},"headers":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"mediaType":{"type":"object","properties":{"type":{"type":"string"},"subtype":{"type":"string"},"parameters":{"type":"object","additionalProperties":{"type":"string"}},"wildcardType":{"type":"boolean"},"wildcardSubtype":{"type":"boolean"}}},"messageBodyWorkers":{"$ref":"#/components/schemas/MessageBodyWorkers"},"parent":{"$ref":"#/components/schemas/MultiPart"},"providers":{"type":"object"},"parameterizedHeaders":{"type":"object","additionalProperties":{"type":"array","items":{"$ref":"#/components/schemas/ParameterizedHeader"}}}}},"ContentDisposition":{"type":"object","properties":{"type":{"type":"string"},"parameters":{"type":"object","additionalProperties":{"type":"string"}},"fileName":{"type":"string"},"creationDate":{"type":"string","format":"date-time"},"modificationDate":{"type":"string","format":"date-time"},"readDate":{"type":"string","format":"date-time"},"size":{"type":"integer","format":"int64"}}},"FormDataBodyPart":{"type":"object","properties":{"contentDisposition":{"$ref":"#/components/schemas/ContentDisposition"},"entity":{"type":"object"},"headers":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"mediaType":{"type":"object","properties":{"type":{"type":"string"},"subtype":{"type":"string"},"parameters":{"type":"object","additionalProperties":{"type":"string"}},"wildcardType":{"type":"boolean"},"wildcardSubtype":{"type":"boolean"}}},"messageBodyWorkers":{"$ref":"#/components/schemas/MessageBodyWorkers"},"parent":{"$ref":"#/components/schemas/MultiPart"},"providers":{"type":"object"},"simple":{"type":"boolean"},"formDataContentDisposition":{"$ref":"#/components/schemas/FormDataContentDisposition"},"name":{"type":"string"},"value":{"type":"string"},"parameterizedHeaders":{"type":"object","additionalProperties":{"type":"array","items":{"$ref":"#/components/schemas/ParameterizedHeader"}}}}},"MessageBodyWorkers":{"type":"object"},"MultiPart":{"type":"object","properties":{"contentDisposition":{"$ref":"#/components/schemas/ContentDisposition"},"entity":{"type":"object"},"headers":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"mediaType":{"type":"object","properties":{"type":{"type":"string"},"subtype":{"type":"string"},"parameters":{"type":"object","additionalProperties":{"type":"string"}},"wildcardType":{"type":"boolean"},"wildcardSubtype":{"type":"boolean"}}},"messageBodyWorkers":{"$ref":"#/components/schemas/MessageBodyWorkers"},"parent":{"$ref":"#/components/schemas/MultiPart"},"providers":{"type":"object"},"bodyParts":{"type":"array","items":{"$ref":"#/components/schemas/BodyPart"}},"parameterizedHeaders":{"type":"object","additionalProperties":{"type":"array","items":{"$ref":"#/components/schemas/ParameterizedHeader"}}}}},"ParameterizedHeader":{"type":"object","properties":{"value":{"type":"string"},"parameters":{"type":"object","additionalProperties":{"type":"string"}}}},"OAuthAuthorization":{"type":"object","properties":{"scopes":{"uniqueItems":true,"type":"array","description":"A list of scopes that a resource owner has authorized access to.","items":{"type":"string","description":"A list of scopes that a resource owner has authorized access to."}},"created":{"type":"string","description":"The Date that the resource owner granted access to the scope(s).","format":"date-time"},"applicationID":{"type":"string","description":"The application requesting authorization.","example":"3c82acfc-26c2-11e4-a149-a6c5e4d22fb7"},"subject":{"type":"string","description":"The unique identifier representing the resource owner who granted authorization to the client.","example":"sampleuser"},"id":{"type":"string","description":"The unique identifier for the authorization","example":"b76a3e23-deca-49ab-9682-79cd503b7e3a"}},"description":"An OAuth Authorization"},"MetricField":{"type":"object","properties":{"metricType":{"type":"string","description":"The metric type name","readOnly":true,"example":"numMessages"},"aggregateName":{"type":"string","description":"The metric aggregate name","readOnly":true,"example":"totalNumMessages"}}},"MetricTimeline":{"type":"object","properties":{"name":{"type":"string","description":"The metric name.","readOnly":true,"example":"numMessages"},"id":{"type":"string","writeOnly":true},"series":{"type":"array","description":"The metric name.","items":{"$ref":"#/components/schemas/Series"}}}},"Series":{"type":"object","properties":{"name":{"type":"string","description":"The metric type name","readOnly":true,"example":"numMessages"},"pointInterval":{"type":"integer","description":"The amount of time, in milliseconds, between data points","format":"int64","example":300000},"pointStart":{"type":"integer","description":"The time of the first data point in milliseconds","format":"int64","example":1363737600000},"data":{"type":"array","description":"The a metric measurement at a specific time interval","example":[0,0,1,0,2,0,3,0,4],"items":{"type":"number","description":"The a metric measurement at a specific time interval","format":"float"}}},"description":"The metric name."},"Organization":{"required":["name"],"type":"object","properties":{"id":{"type":"string","description":"The unique identifier for the organization","readOnly":true,"example":"3e21b76a-defa-49ab-9682-a9cd60387e37"},"name":{"type":"string","description":"The name of the organization","example":"Acme Corporation"},"description":{"type":"string","description":"The description of the organization","example":"Acme Corporation is a fictional corporation in Road Runner/Wile E. Coyote cartoons"},"email":{"type":"string","description":"The contact email address associated with the organization","example":"support@acmecorp.com"},"image":{"type":"string","description":"URI of the image to be used for this organization. To update the image, please refer to the API.","example":"resources/photo.jpg"},"restricted":{"type":"boolean","description":"Indicates that the organization is restricted. Users in a restricted organization cannot see other users, and users cannot register for the organization using tokens. Default is 'false'.","example":false},"virtualHost":{"type":"string","description":"The virtual host associated with the organization","example":"acme.api.axway.com"},"tags":{"type":"object","additionalProperties":{"type":"string"},"writeOnly":true},"phone":{"type":"string","description":"Contact phone number of the organization","example":"+1 877-564-7700"},"enabled":{"type":"boolean","description":"Flag to indicate if this organization is enabled or not","example":false},"development":{"type":"boolean","description":"Flag to indicate if this organization is enabled or not for API development.","example":false,"default":false},"dn":{"type":"string"},"createdOn":{"type":"integer","description":"Epoch/Unix time stamp when the organization was created","format":"int64","readOnly":true,"example":1364287486876},"startTrialDate":{"type":"integer","description":"Epoch/Unix time stamp when the trial starts","format":"int64","example":1364287486876},"endTrialDate":{"type":"integer","description":"Epoch/Unix time stamp when the trial expires","format":"int64","example":1364287486876},"trialDuration":{"type":"integer","description":"Length of the trial in days","format":"int32","example":365},"isTrial":{"type":"boolean","description":"Indicates if this Org is a trial or not","example":true}},"description":"API Manager organization"},"RegistrationToken":{"type":"object","properties":{"token":{"type":"string","description":"The registration code","example":"257690"},"organizationId":{"type":"string","description":"Unique identifier for the organization who the registration code applies to","readOnly":true,"example":"3e21b76a-defa-49ab-9682-a9cd60387e37"},"expiry":{"type":"integer","description":"Epoch/Unix time stamp when the registration code will expire","format":"int64","example":1366930800000},"createdOn":{"type":"integer","description":"Epoch/Unix time stamp when the registration code was created","format":"int64","readOnly":true,"example":1364407145121},"createdBy":{"type":"string","description":"The unique identifier for user that created the registration code","readOnly":true,"example":"de077cd8-83b7-46d1-b06f-2eaaf1548898"},"userQuota":{"type":"integer","description":"The remaining number of users that can use the registration code for self registration to an organization","format":"int32","example":10},"maxUsers":{"type":"integer","description":"The total number of users that can use the registration code for self registration to an organization since the code has been created","format":"int32","example":10},"enabled":{"type":"boolean","description":"Flag disables registration code so that it can no longer be used for registration","example":true}},"description":"Organization Registration Token."},"RemoteHost":{"required":["alias","name","port"],"type":"object","properties":{"id":{"type":"string","description":"The unique identifier for the remote host","readOnly":true,"example":"3e21b76a-defa-49ab-9682-a9cd60387e37"},"alias":{"type":"string","description":"A human readable alias name for the remote host","example":"Acme Remote Server"},"name":{"type":"string","description":"The host name of the remote host","example":"www.google.com"},"port":{"type":"integer","description":"The host port of the remote host","format":"int32","example":80},"createdOn":{"type":"integer","description":"Epoch/Unix time stamp when the remote host was created","format":"int64","readOnly":true,"example":1364287486876},"createdBy":{"type":"string","description":"The unique identifier for user that created the remote host","readOnly":true,"example":"de077cd8-83b7-46d1-b06f-2eaaf1548898"},"organizationId":{"type":"string","description":"The organization identifier to which the remote host belongs","example":"3e21b76a-defa-49ab-9682-a9cd60387e37"},"maxConnections":{"type":"integer","description":"The maximum number of connections to open to a Remote Host. If the maximum number of connections has already been established, the API Gateway instance waits for a connection to drop or become idle before making another request. The default value is -1, meaning there is no limit","format":"int32","example":128,"default":-1},"allowHTTP11":{"type":"boolean","description":"Enables the API Gateway to use HTTP 1.1 when connecting to the remote host. Default value is false, meaning HTTP 1.0 is used","example":false,"default":false},"includeContentLengthRequest":{"type":"boolean","description":"If this option is set, the API Gateway will include the Content-Length HTTP header in all requests to this Remote Host. Default value is false.","example":false,"default":false},"includeContentLengthResponse":{"type":"boolean","description":"If this option is set, if the API Gateway receives a response from this Remote Host that contains a Content-Length HTTP header, it returns this length to the client. Default value is false.","example":false,"default":false},"offerTLSServerName":{"type":"boolean","description":"Adds a field to outbound TLS/SSL calls that shows the name that the client used to connect. Default value is false.","example":false,"default":false},"verifyServerHostname":{"type":"boolean","description":"Ensures that the certificate presented by the server matches the name of the remote host being connected to. This prevents host spoofing and man-in-the-middle attacks. Default value is false.","example":false,"default":true},"connectionTimeout":{"type":"integer","description":"If a connection to this remote host is not established within the time set in this field, the connection times out and the connection fails. Default value is 30000 milliseconds (30 seconds).","format":"int64","example":30000,"default":30000},"activeTimeout":{"type":"integer","description":"The maximum amount of time permitted between reading successive blocks of data. If the Active Timeout is exceeded, the API Gateway closes the connection. This prevents a Remote Host from closing the connection while sending data. Default value is 30000 milliseconds (30 seconds).","format":"int64","example":30000,"default":30000},"transactionTimeout":{"type":"integer","description":"The maximum amount of time permitted to complete the transaction. Default value is 240000 milliseconds (4 minutes).","format":"int64","example":240000,"default":240000},"idleTimeout":{"type":"integer","description":"The maximum amount of time that API Gateway waits after sending a message over a persistent connection to the Remote Host before it closes the connection. Default value is 15000 milliseconds (15 seconds).","format":"int64","example":15000,"default":15000},"maxReceiveBytes":{"type":"integer","description":"The maximum amount of data the API Gateway can receive per transaction. Default value is 20971520 bytes (20MiB).","format":"int64","example":20971520,"default":20971520},"maxSendBytes":{"type":"integer","description":"The maximum amount of data the API Gateway can transmit per transaction. Default value is 20971520 bytes (20MiB).","format":"int64","example":20971520,"default":20971520},"inputBufferSize":{"type":"integer","description":"The maximum amount of memory allocated to each request. Default value is 8192 bytes.","format":"int64","example":8192,"default":8192},"outputBufferSize":{"type":"integer","description":"The maximum amount of memory allocated to each response. Default value is 8192 bytes.","format":"int64","example":8192,"default":8192},"addressCacheTimeout":{"type":"integer","description":"The period of time to cache addressing information after it has been received from the naming service. Default value is 300000 milliseconds (5 minutes)","format":"int64","example":300000,"default":300000},"sslSessionCacheSize":{"type":"integer","description":"Specifies the size of the SSL session cache for connections to the remote host, which controls the number of idle SSL sessions that can be kept in memory. Default value is 32.","format":"int32","example":32,"default":32},"inputEncodings":{"type":"array","description":"Specifies the HTTP content encodings that the API Gateway can accept from peers. Supported encodings: *deflate*, *gzip*. If no encodings are specified the default encoding is applied.","example":["deflate","gzip"],"items":{"type":"string","description":"Specifies the HTTP content encodings that the API Gateway can accept from peers. Supported encodings: *deflate*, *gzip*. If no encodings are specified the default encoding is applied.","example":"[\"deflate\",\"gzip\"]"}},"outputEncodings":{"type":"array","description":"Specifies the HTTP content encodings that the API Gateway can apply to outgoing messages. Supported encodings: *deflate*, *gzip*. If no encodings are specified the default encoding is applied.","example":["deflate","gzip"],"items":{"type":"string","description":"Specifies the HTTP content encodings that the API Gateway can apply to outgoing messages. Supported encodings: *deflate*, *gzip*. If no encodings are specified the default encoding is applied.","example":"[\"deflate\",\"gzip\"]"}},"exportCorrelationId":{"type":"boolean","description":"Specifies whether to add the X-CorrelationID header to outbound messages","example":true,"default":true},"loadBalancing":{"type":"string","description":"Specifies the load balancing algorithm that is performed on connection attempts made to listed host addresses. Supported values: 'roundRobin', 'responseTime'. Default value: 'roundRobin'.","example":"roundRobin","enum":["roundRobin","responseTime"]},"responseTimeDecay":{"type":"integer","description":"Specifies the rate of exponential decline of response times used by the 'Weighted response time' load-balancing algorthim. Default value: 10000 (ms)","format":"int64","example":10000,"default":10000},"addressing":{"$ref":"#/components/schemas/VApiRemoteHostAddressing"},"watchdog":{"$ref":"#/components/schemas/VApiWatchdog"}},"description":"An API Manager-registered remote host."},"VApiRemoteHostAddressing":{"type":"object","properties":{"highestPriority":{"type":"array","description":"Highest priority IP addresses","example":["5.5.5.5:8080"],"items":{"type":"string","description":"Highest priority IP addresses","example":"[\"5.5.5.5:8080\"]"}},"highPriority":{"type":"array","description":"High priority IP addresses","example":["4.4.4.4:8443"],"items":{"type":"string","description":"High priority IP addresses","example":"[\"4.4.4.4:8443\"]"}},"mediumPriority":{"type":"array","description":"Medium priority IP addresses","example":["3.3.3.3"],"items":{"type":"string","description":"Medium priority IP addresses","example":"[\"3.3.3.3\"]"}},"lowestPriority":{"type":"array","description":"Low priority IP addresses","example":["2.2.2.2"],"items":{"type":"string","description":"Low priority IP addresses","example":"[\"2.2.2.2\"]"}}},"description":"Specifies a list of IP addresses that the API Gateway can use instead of attempting a DNS lookup on the host name of the remote host provided","example":"{ \"highestPriority\": [ \"5.5.5.5:8080\"], \"highPriority\": [ \"2.2.2.2\" ], \"mediumPriority\": [ \"3.3.3.3\" ], , \"lowestPriority\": [ \"1.2.3.4:8080\" ] }"},"VApiWatchdog":{"type":"object","properties":{"responseCodes":{"type":"array","description":"Specifies the HTTP response code ranges that indicate that the Remote Host is available.","example":[{"start":200,"end":200},{"start":300,"end":999}],"items":{"$ref":"#/components/schemas/VApiWatchdogResponseCodeInterval"}},"httpRequest":{"$ref":"#/components/schemas/VApiWatchdogRequest"},"pollTimeout":{"type":"integer","description":"Specifies how often the Watchdog is to send the a polling request to the Remote Host.","format":"int64","example":60000},"pollIfUp":{"type":"boolean","description":"Configures the Watchdog to send poll requests during periods when it is not sending requests to and receiving responses from the Remote Host","example":true}},"description":"Specifies a watchdog that can periodically poll the Remote Host to check its availability","example":{"responseCodes":[{"start":100,"end":999}],"httpRequest":{"method":"OPTIONS","uri":"*"},"pollTimeout":60000,"pollIfUp":true}},"VApiWatchdogRequest":{"type":"object","properties":{"method":{"type":"string","description":"Specifies the HTTP method to be used when sending the polling request to the remote host. Possible values: [ 'GET', 'OPTIONS', 'POST', 'PUT' ]. Default value: OPTIONS","example":"OPTIONS","enum":["GET","PUT","POST","OPTIONS"],"default":"OPTIONS"},"uri":{"type":"string","description":"Specifies the HTTP URI to be used when sending the polling request to the remote host. Default value: '*'.","example":"*","default":"*"}},"description":" Specifies the the HTTP request to poll the Remote Host with. Defaults to OPTIONS *, which is typically used to retrieve status information about a HTTP server.","example":{}},"VApiWatchdogResponseCodeInterval":{"type":"object","properties":{"start":{"type":"integer","description":"Specifies the start value of the response code range.","format":"int32","example":200},"end":{"type":"integer","description":"Specifies the end value of the response code range.","format":"int32","example":299}},"description":"Specifies the HTTP response code ranges that indicate that the Remote Host is available.","example":[{"start":200,"end":200},{"start":300,"end":999}]},"LicenseConfig":{"type":"object","properties":{"license":{"type":"boolean","description":"Indicates whether or not a valid license is available","example":true}},"description":"API Manager license configuration"},"AlertConfig":{"type":"object","properties":{"runSysquotaExceeded":{"type":"boolean","example":false,"default":false},"runSysquotaWarning":{"type":"boolean","example":false,"default":false},"runAppquotaExceeded":{"type":"boolean","example":false,"default":false},"runAppquotaWarning":{"type":"boolean","example":false,"default":false},"quotaOverrideChanged":{"type":"boolean","example":false,"default":false},"quotaOverrideDeleted":{"type":"boolean","example":false,"default":false},"quotaDefaultChanged":{"type":"boolean","example":false,"default":false},"quotaSystemChanged":{"type":"boolean","example":false,"default":false},"organizationCreate":{"type":"boolean","example":false,"default":false},"organizationDelete":{"type":"boolean","example":false,"default":false},"organizationEnable":{"type":"boolean","example":false,"default":false},"organizationDisable":{"type":"boolean","example":false,"default":false},"organizationAddapi":{"type":"boolean","example":false,"default":false},"organizationRemoveapi":{"type":"boolean","example":false,"default":false},"organizationEnableapi":{"type":"boolean","example":false,"default":false},"organizationDisableapi":{"type":"boolean","example":false,"default":false},"appdevRegister":{"type":"boolean","example":false,"default":false},"appdevApprove":{"type":"boolean","example":false,"default":false},"appdevDelete":{"type":"boolean","example":false,"default":false},"appdevEnable":{"type":"boolean","example":false,"default":false},"appdevDisable":{"type":"boolean","example":false,"default":false},"appdevResetpwd":{"type":"boolean","example":false,"default":false},"applicationRegister":{"type":"boolean","example":false,"default":false},"applicationApprove":{"type":"boolean","example":false,"default":false},"applicationDelete":{"type":"boolean","example":false,"default":false},"applicationEnable":{"type":"boolean","example":false,"default":false},"applicationDisable":{"type":"boolean","example":false,"default":false},"applicationRequestapi":{"type":"boolean","example":false,"default":false},"applicationApproveapi":{"type":"boolean","example":false,"default":false},"applicationRemoveapi":{"type":"boolean","example":false,"default":false},"applicationEnableapi":{"type":"boolean","example":false,"default":false},"applicationDisableapi":{"type":"boolean","example":false,"default":false},"apicatalogEnable":{"type":"boolean","example":false,"default":false},"apicatalogDisable":{"type":"boolean","example":false,"default":false},"apiproxyPublish":{"type":"boolean","example":false,"default":false},"apiproxyDeprecate":{"type":"boolean","example":false,"default":false},"apiproxyUndeprecate":{"type":"boolean","example":false,"default":false},"apiproxyRetire":{"type":"boolean","example":false,"default":false},"apiproxyUnpublish":{"type":"boolean","example":false,"default":false},"applicationcredentialsCreate":{"type":"boolean","description":"Specifies whether or not an alert will be generated when an application credential is created","example":false,"default":false},"applicationcredentialsUpdate":{"type":"boolean","description":"Specifies whether or not an alert will be generated when an application credential is updated","example":false,"default":false},"applicationcredentialsDelete":{"type":"boolean","description":"Specifies whether or not an alert will be generated when an application credential is deleted","example":false,"default":false},"applicationcredentialsEnable":{"type":"boolean","description":"Specifies whether or not an alert will be generated when an application credential is enabled","example":false,"default":false},"applicationcredentialsDisable":{"type":"boolean","description":"Specifies whether or not an alert will be generated when an application credential is disabled","example":false,"default":false}},"description":"API Access indicates whether access to an API is available"},"Config":{"required":["sessionIdleTimeout","sessionTimeout"],"type":"object","properties":{"portalName":{"type":"string","description":"The name of the API Manager.","example":"API Manager"},"portalHostname":{"type":"string","description":"The network hostname or IP Address of the API Manager which will be used in email links.","example":"apimanager.axway.com"},"apiPortalName":{"type":"string","description":"The name of the API Portal","example":"Axway API Portal"},"apiPortalHostname":{"type":"string","description":"The network hostname or IP Address of the API Portal which will be used in email links.","example":"apiportal.axway.com"},"isApiPortalConfigured":{"type":"boolean","description":"Indicates if the API Portal is configured.","example":true},"registrationEnabled":{"type":"boolean","description":"Enables/disables user registration for the API Manager","example":true},"resetPasswordEnabled":{"type":"boolean","description":"Enables/disables support for resetting user passwords for the API Manager","example":true},"changePasswordOnFirstLogin":{"type":"boolean","description":"Enables/disables support for changing user passwords on first login for the API Manager","example":true},"passwordExpiryEnabled":{"type":"boolean","description":"Enables/disables support for user passwords expiration for the API Manager","example":true},"passwordLifetimeDays":{"type":"integer","description":"The number of days before user passwords expire for the API Manager","format":"int32","example":90,"default":90},"minimumPasswordLength":{"type":"integer","description":"The minimum password length.","format":"int32","example":6,"default":6},"loginResponseTime":{"type":"integer","description":"The login response time in milliseconds to mitigate user accounts enumeration","format":"int32","example":1000,"default":100},"autoApproveUserRegistration":{"type":"boolean","description":"Enables/disables auto-approve for user registration whereby API Administrator or Organization Administrator approval is not required.","example":true},"systemOAuthScopesEnabled":{"type":"boolean","description":"Enables/disables the ability to add System scopes to an Application. These scopes represent Gateway OAuth resources that are not covered by APIs.","example":false},"applicationScopeRestrictions":{"type":"boolean","description":"Enables/disables the ability to show Application default enabled scopes only.","example":false},"autoApproveApplications":{"type":"boolean","description":"Enables/disables auto-application approval whereby users do not need API Administrator or Organization Administrator approval.","example":true},"delegateUserAdministration":{"type":"boolean","description":"Enables/disables user administration to the Organization Administrators.","example":true},"delegateApplicationAdministration":{"type":"boolean","description":"Enables/disables application administration to the Organization Administrators.","example":true},"apiDefaultVirtualHost":{"type":"string","description":"The network host and port that serves as the default virtual host from which API Manager registered API will be accessible through.","example":"apimanager.axway.com:443"},"apiRoutingKeyEnabled":{"type":"boolean","description":"Enable routing to APIs on the same base path.","example":true},"apiRoutingKeyLocation":{"type":"string","description":"An additional routing key is required to support multiple APIs registered on the same base path. This indicates where to look for the value.","example":"query|param"},"emailFrom":{"type":"string","description":"The 'from' address used in emails.","example":"no-reply@axway.com"},"emailBounceAddress":{"type":"string","description":"An email address where undeliverable emails will be bounced to.","example":"apiadmin@axway.com"},"promoteApiViaPolicy":{"type":"boolean","description":"Enables/disables API promotion via policy.","example":true},"globalPoliciesEnabled":{"type":"boolean","description":"Enables/disables Global policies.","example":true},"globalRequestPolicy":{"type":"string","description":"The Global Request Policy to be executed for all Frontend API calls. Must be a valid policy ID. Can be null to indicate no policy","example":"Corporate Security Policy"},"globalResponsePolicy":{"type":"string","description":"The Global Response Policy to be executed for all Frontend API calls. Must be a valid policy ID. Can be null to indicate no policy","example":"Corporate Response Policy"},"faultHandlersEnabled":{"type":"boolean","description":"Enables/disables API Manager fault handlers.","example":true},"globalFaultHandlerPolicy":{"type":"string","description":"The Global Fault Handler Policy to be used by all Frontend APIs in the event of an error. Must be a valid policy ID. Can be null to indicate no policy","example":"Corporate Fault Handler Policy","default":"<key type='CircuitContainer'><id field='name' value='Generated Policies'/><key type='CircuitContainer'><id field='name' value='REST API's'/><key type='CircuitContainer'><id field='name' value='Templates'/><key type='FilterCircuit'><id field='name' value='Default Fault Handler'/></key></key></key></key>"},"strictCertificateChecking":{"type":"boolean","description":"For API import, strict certificate checking will only allow recognised, valid server certificates when performing API imports from SSL protected endpoints. Default is set to true","example":true,"default":true},"serverCertificateVerification":{"type":"boolean","description":"Fr API import, server certificate verification ensures that the certificate presented by the server matches the name of the remote host being connected to. Default is set to true","example":true,"default":true},"advisoryBannerEnabled":{"type":"boolean","description":"Enables/disables API Manager advisory banner.","example":true},"advisoryBannerText":{"type":"string","description":"Advisory banner text.","example":"Usage of this system constitutes consent to abide by the company's security policies and standards.","default":"Warning - unauthorized use of this tool is strictly prohibited and subject to audit, investigation, and potential prosecution."},"baseOAuth":{"type":"boolean","default":false},"oadminSelfServiceEnabled":{"type":"boolean","default":false},"externalUserName":{"type":"string","description":"External user name","example":"${userinfo.name}"},"externalUserDescription":{"type":"string","description":"External user description","example":"${userinfo.description}"},"externalUserPhone":{"type":"string","description":"External user phone","example":"${userinfo.phone}"},"externalUserEmail":{"type":"string","description":"External user email","example":"${userinfo.email}"},"externalUserOrganization":{"type":"string","description":"External user organization name","example":"${userinfo.organization}"},"externalUserRole":{"type":"string","description":"External user role","example":"${userinfo.role}"},"externalUserEnabled":{"type":"string","description":"External user enabled","example":"${userinfo.enabled}"},"sessionIdleTimeout":{"type":"integer","description":"Idle session timeout in milliseconds","format":"int64","example":360000},"sessionTimeout":{"type":"integer","description":"Session timeout in milliseconds","format":"int64","example":720000},"isTrial":{"type":"boolean","description":"Is trial enabled","example":false},"defaultTrialDuration":{"type":"integer","description":"Default trial duration in days","format":"int32","example":30},"loginNameRegex":{"type":"string","description":"Login name validation regex","example":"[^;,\\/?#<>&!]{1,}"},"userNameRegex":{"type":"string","description":"User name validation regex","example":"^[\\p{L}\\d .,'_-]+$"},"productVersion":{"type":"string","description":"The Version information of API Manager.","example":"7.7.0","default":"7.7.20220830"},"os":{"type":"string","description":"The operating system on which API Manager server is running.","example":"Windows 7"},"architecture":{"type":"string","description":"The architecture of the operating system on which the API Manager server is running. Supported values: [ win-x86-32, linux-x86-64 ]","example":"win-x86-32"},"apiImportTimeout":{"type":"integer","description":"API Import timeout in seconds. Defaults to 60 seconds","format":"int64","example":60,"default":60},"apiImportMimeValidation":{"type":"boolean","description":"Specifies whether or not mime-type validation is performed during API Import. Currently mime-type validation is implemented for Swagger (1.x and 2.0) and OAS 3.0. This feature is switched on by default","example":true,"default":true},"apiImportEditable":{"type":"boolean","description":"Specifies whether or not backend APIs can be edited post import. This option is switched OFF by default.","example":false,"default":false},"lockUserAccount":{"$ref":"#/components/schemas/LockUserAccount"},"regTokenEmailEnabled":{"type":"boolean","description":"Specifies whether or not to send an email notification when a registration token is generated for an Organization.","example":true,"default":true}},"description":"API Manager configuration"},"LockUserAccount":{"type":"object","properties":{"enabled":{"type":"boolean"},"attempts":{"type":"integer","format":"int64"},"timePeriod":{"type":"integer","format":"int64"},"timePeriodUnit":{"type":"string","enum":["week","day","hour","minute","second"]},"lockTimePeriod":{"type":"integer","format":"int64"},"lockTimePeriodUnit":{"type":"string","enum":["week","day","hour","minute","second"]}},"description":"Specifies whether or not to lock a user account when invalid login attempts are encountered; settings include, how many times authentication can be attempted, and what happens after this limit is crossed","example":{"enabled":false,"interval":30,"intervalUnit":"minute","attempts":6,"timePeriod":5,"timePeriodUnit":"minute"},"default":{"enabled":true,"interval":30,"intervalUnit":"minute","attempts":6,"timePeriod":5,"timePeriodUnit":"minute"}},"CACert":{"type":"object","properties":{"certBlob":{"type":"string","description":"Raw certificate data","example":"YmxvYg=="},"name":{"type":"string","description":"Name of the certificate","example":"CN=Equifax Secure eBusiness CA-1, O=Equifax Secure Inc., C=US"},"alias":{"type":"string","description":"Certificate alias","example":"CN=Equifax Secure eBusiness CA-1, O=Equifax Secure Inc., C=US"},"subject":{"type":"string","description":"Certificate subject","example":"CN=Equifax Secure eBusiness CA-1, O=Equifax Secure Inc., C=US"},"issuer":{"type":"string","description":"Certificate issuer","example":"CN=Equifax Secure eBusiness CA-1, O=Equifax Secure Inc., C=US"},"version":{"type":"integer","description":"Version of the certificate","format":"int32","example":3},"notValidBefore":{"type":"integer","description":"Start date of the certificate","format":"int64","example":1364287486876},"notValidAfter":{"type":"integer","description":"Expiry date of the certificate","format":"int64","example":1364287486876},"signatureAlgorithm":{"type":"string","description":"The algorithm used to sign the certificate.","example":"RSA (2048 bits)"},"sha1Fingerprint":{"type":"string","description":"SHA1 fingerprint.","example":"BC:5C:0D:3E:47:58:DF:E8:42:A4:D2:34:C5:D4:97:14:DA:54:F4:CD"},"md5Fingerprint":{"type":"string","description":"MD5 fingerprint.","example":"89:DD:C1:6C:C0:6E:1D:B1:75:0C:48:E5:E6:AC:76:B0"},"expired":{"type":"boolean","description":"Flag indicating whether or not the certificate is expired.","example":true,"default":false},"notYetValid":{"type":"boolean","description":"Flag indicating whether or not the certificate is valid yet.","example":false,"default":false},"inbound":{"type":"boolean","description":"Flag indicating whether this certificate is used for inbound SSL connections when invoking the virtualized API.","example":false,"default":false},"outbound":{"type":"boolean","description":"Flag indicating whether this certificate is used for outbound SSL connections when invoking the virtualized API.","example":true,"default":true}},"description":"The trsuted CA certificates apply to inbound and/or outbound SSL connections and are used as part of the [VirtualizedAPI](VirtualizedAPI.html)."},"API":{"type":"object","properties":{"id":{"type":"string","description":"An identifier","readOnly":true},"title":{"type":"string","description":"Schema title"},"description":{"type":"string","description":"Description of the Schema"},"format":{"type":"string","description":"The format ex: int32, int64, float, double, byte, binary, date, date-time or password"},"required":{"type":"array","description":"Specifies if the parameter is required","items":{"type":"string","description":"Specifies if the parameter is required"}},"properties":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/SchemaObject"},"description":"Not used because our model does not support inline nested types"},"additionalProperties":{"type":"object","description":"Specifies additional schema properties"},"items":{"$ref":"#/components/schemas/SchemaObject"},"example":{"type":"object","description":"Specifies an example of an instance of this schema"},"xml":{"type":"object","description":"Specifies metadata to describe the XML representation format of this schema"},"maxLength":{"type":"integer","description":"Indicates the maximum length of a parameter of type 'string'","format":"int32","example":100},"minLength":{"type":"integer","description":"Indicates the minimum length of a parameter of type 'string'. If not present, assumed default value is 0.","format":"int32","example":3},"pattern":{"type":"string","description":"Specifies a valid regular expression against which a parameter of type 'string' is validated.","example":"3"},"exclusiveMinimum":{"type":"boolean","description":"If true, specifies that the value of the number parameter must be greater than the specified minimum value, otherwise the value must be great than, or equal to, the specified minimum value.","example":true},"exclusiveMaximum":{"type":"boolean","description":"If true, specifies that the value of the number parameter must be less than the specified maximum value, otherwise the value must be less than, or equal to, the specified maximum value.","example":false},"minimum":{"type":"object","description":"Specifies the minimum possible value of the number parameter.","example":1},"maximum":{"type":"object","description":"Specifies the maximum possible value of the number parameter.","example":100},"multipleOf":{"type":"number","description":"Specifies that the value of the number parameter must be divisible by this value. Must be an integer value > 0","example":10},"maxItems":{"type":"integer","description":"Specifies the maximum number of items permitted for array parameters. Must be an integer value greater than, or equal to 0","format":"int32","example":3},"minItems":{"type":"integer","description":"Specifies the minimum number of items permitted for array parameters. Must be an integer value greater than, or equal to 0","format":"int32","example":0},"uniqueItems":{"type":"boolean","description":"Specifies whether or not all array items should be unique.","example":true},"allowEmptyValue":{"type":"boolean","description":"Specifies whether or not an empty value is permitted.","example":false},"maxProperties":{"type":"integer","description":"Specifies the maximum number of items permitted for object parameters. Must be an integer value greater than, or equal to 0","format":"int32","example":3},"minProperties":{"type":"integer","description":"Specifies the minimum number of items permitted for object parameters. Must be an integer value greater than, or equal to 0","format":"int32","example":0},"not":{"$ref":"#/components/schemas/SchemaObject"},"nullable":{"type":"boolean","description":"Specifies whether or not a null value for the defined schema should be allowed","example":false},"readOnly":{"type":"boolean","description":"Specifies whether or not an object property is read only and should not be used as part of the request","example":false},"writeOnly":{"type":"boolean","description":"Specifies whether or not an object property is write only and should not be used as part of the response","example":false},"deprecated":{"type":"boolean","description":"Specifies whether or not the schema is deprecated. It should be transitioned out of usage","example":false},"externalDocs":{"$ref":"#/components/schemas/ExternalDocs"},"discriminator":{"$ref":"#/components/schemas/Discriminator"},"collectionFormat":{"type":"string"},"oneOf":{"type":"array","description":"Specifies that the schema can be one of those listed","items":{"$ref":"#/components/schemas/SchemaObject"}},"anyOf":{"type":"array","description":"Specifies that the schema can be any of those listed","items":{"$ref":"#/components/schemas/SchemaObject"}},"allOf":{"type":"array","description":"Specifies that the schema is a combination of all of those listed","items":{"$ref":"#/components/schemas/SchemaObject"}},"path":{"type":"string","description":"The API path","example":"/users"},"name":{"type":"string","description":"The name of the REST API Method. This contains the exposed path."},"operations":{"type":"array","description":"The list of operations that can be performed on *path*","items":{"$ref":"#/components/schemas/Operation"}},"$ref":{"type":"string","description":"A Reference to a definition on definitions object","example":"#/definitions/User"},"default":{"type":"object","description":"Default value for this schema if it is applicable"},"type":{"type":"string","description":"The type ex: array , boolean, integer , null , number, object, string","example":"string"},"enum":{"type":"array","items":{"type":"object"}}},"description":"API Access indicates whether access to an API is available"},"Authorization":{"type":"object","properties":{"id":{"type":"string","description":"An identifier","readOnly":true},"title":{"type":"string","description":"Schema title"},"description":{"type":"string","description":"Description of the Schema"},"format":{"type":"string","description":"The format ex: int32, int64, float, double, byte, binary, date, date-time or password"},"required":{"type":"array","description":"Specifies if the parameter is required","items":{"type":"string","description":"Specifies if the parameter is required"}},"properties":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/SchemaObject"},"description":"Not used because our model does not support inline nested types"},"additionalProperties":{"type":"object","description":"Specifies additional schema properties"},"items":{"$ref":"#/components/schemas/SchemaObject"},"example":{"type":"object","description":"Specifies an example of an instance of this schema"},"xml":{"type":"object","description":"Specifies metadata to describe the XML representation format of this schema"},"maxLength":{"type":"integer","description":"Indicates the maximum length of a parameter of type 'string'","format":"int32","example":100},"minLength":{"type":"integer","description":"Indicates the minimum length of a parameter of type 'string'. If not present, assumed default value is 0.","format":"int32","example":3},"pattern":{"type":"string","description":"Specifies a valid regular expression against which a parameter of type 'string' is validated.","example":"3"},"exclusiveMinimum":{"type":"boolean","description":"If true, specifies that the value of the number parameter must be greater than the specified minimum value, otherwise the value must be great than, or equal to, the specified minimum value.","example":true},"exclusiveMaximum":{"type":"boolean","description":"If true, specifies that the value of the number parameter must be less than the specified maximum value, otherwise the value must be less than, or equal to, the specified maximum value.","example":false},"minimum":{"type":"object","description":"Specifies the minimum possible value of the number parameter.","example":1},"maximum":{"type":"object","description":"Specifies the maximum possible value of the number parameter.","example":100},"multipleOf":{"type":"number","description":"Specifies that the value of the number parameter must be divisible by this value. Must be an integer value > 0","example":10},"maxItems":{"type":"integer","description":"Specifies the maximum number of items permitted for array parameters. Must be an integer value greater than, or equal to 0","format":"int32","example":3},"minItems":{"type":"integer","description":"Specifies the minimum number of items permitted for array parameters. Must be an integer value greater than, or equal to 0","format":"int32","example":0},"uniqueItems":{"type":"boolean","description":"Specifies whether or not all array items should be unique.","example":true},"allowEmptyValue":{"type":"boolean","description":"Specifies whether or not an empty value is permitted.","example":false},"maxProperties":{"type":"integer","description":"Specifies the maximum number of items permitted for object parameters. Must be an integer value greater than, or equal to 0","format":"int32","example":3},"minProperties":{"type":"integer","description":"Specifies the minimum number of items permitted for object parameters. Must be an integer value greater than, or equal to 0","format":"int32","example":0},"not":{"$ref":"#/components/schemas/SchemaObject"},"nullable":{"type":"boolean","description":"Specifies whether or not a null value for the defined schema should be allowed","example":false},"readOnly":{"type":"boolean","description":"Specifies whether or not an object property is read only and should not be used as part of the request","example":false},"writeOnly":{"type":"boolean","description":"Specifies whether or not an object property is write only and should not be used as part of the response","example":false},"deprecated":{"type":"boolean","description":"Specifies whether or not the schema is deprecated. It should be transitioned out of usage","example":false},"externalDocs":{"$ref":"#/components/schemas/ExternalDocs"},"discriminator":{"$ref":"#/components/schemas/Discriminator"},"collectionFormat":{"type":"string"},"oneOf":{"type":"array","description":"Specifies that the schema can be one of those listed","items":{"$ref":"#/components/schemas/SchemaObject"}},"anyOf":{"type":"array","description":"Specifies that the schema can be any of those listed","items":{"$ref":"#/components/schemas/SchemaObject"}},"allOf":{"type":"array","description":"Specifies that the schema is a combination of all of those listed","items":{"$ref":"#/components/schemas/SchemaObject"}},"passAs":{"type":"string","description":"Denotes how the API key must be passed. Valid values are 'header' or 'query'.","example":"header"},"keyname":{"type":"string","description":"The name of the header or query parameter to be used when passing the API key.","example":"apiKey"},"scopes":{"type":"array","description":"The list of OAuth scopes.","items":{"$ref":"#/components/schemas/Scope"}},"grantTypes":{"$ref":"#/components/schemas/GrantTypes"},"$ref":{"type":"string","description":"A Reference to a definition on definitions object","example":"#/definitions/User"},"default":{"type":"object","description":"Default value for this schema if it is applicable"},"type":{"type":"string","description":"The authorization type. One of: basicAuth, apiKey, oauth2, none","example":"apiKey"},"enum":{"type":"array","items":{"type":"object"}}},"description":"The Authorization schemes provided for this API","example":{}},"AuthorizationCode":{"type":"object","properties":{"id":{"type":"string","description":"An identifier","readOnly":true},"title":{"type":"string","description":"Schema title"},"description":{"type":"string","description":"Description of the Schema"},"format":{"type":"string","description":"The format ex: int32, int64, float, double, byte, binary, date, date-time or password"},"required":{"type":"array","description":"Specifies if the parameter is required","items":{"type":"string","description":"Specifies if the parameter is required"}},"properties":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/SchemaObject"},"description":"Not used because our model does not support inline nested types"},"additionalProperties":{"type":"object","description":"Specifies additional schema properties"},"items":{"$ref":"#/components/schemas/SchemaObject"},"example":{"type":"object","description":"Specifies an example of an instance of this schema"},"xml":{"type":"object","description":"Specifies metadata to describe the XML representation format of this schema"},"maxLength":{"type":"integer","description":"Indicates the maximum length of a parameter of type 'string'","format":"int32","example":100},"minLength":{"type":"integer","description":"Indicates the minimum length of a parameter of type 'string'. If not present, assumed default value is 0.","format":"int32","example":3},"pattern":{"type":"string","description":"Specifies a valid regular expression against which a parameter of type 'string' is validated.","example":"3"},"exclusiveMinimum":{"type":"boolean","description":"If true, specifies that the value of the number parameter must be greater than the specified minimum value, otherwise the value must be great than, or equal to, the specified minimum value.","example":true},"exclusiveMaximum":{"type":"boolean","description":"If true, specifies that the value of the number parameter must be less than the specified maximum value, otherwise the value must be less than, or equal to, the specified maximum value.","example":false},"minimum":{"type":"object","description":"Specifies the minimum possible value of the number parameter.","example":1},"maximum":{"type":"object","description":"Specifies the maximum possible value of the number parameter.","example":100},"multipleOf":{"type":"number","description":"Specifies that the value of the number parameter must be divisible by this value. Must be an integer value > 0","example":10},"maxItems":{"type":"integer","description":"Specifies the maximum number of items permitted for array parameters. Must be an integer value greater than, or equal to 0","format":"int32","example":3},"minItems":{"type":"integer","description":"Specifies the minimum number of items permitted for array parameters. Must be an integer value greater than, or equal to 0","format":"int32","example":0},"uniqueItems":{"type":"boolean","description":"Specifies whether or not all array items should be unique.","example":true},"allowEmptyValue":{"type":"boolean","description":"Specifies whether or not an empty value is permitted.","example":false},"maxProperties":{"type":"integer","description":"Specifies the maximum number of items permitted for object parameters. Must be an integer value greater than, or equal to 0","format":"int32","example":3},"minProperties":{"type":"integer","description":"Specifies the minimum number of items permitted for object parameters. Must be an integer value greater than, or equal to 0","format":"int32","example":0},"not":{"$ref":"#/components/schemas/SchemaObject"},"nullable":{"type":"boolean","description":"Specifies whether or not a null value for the defined schema should be allowed","example":false},"readOnly":{"type":"boolean","description":"Specifies whether or not an object property is read only and should not be used as part of the request","example":false},"writeOnly":{"type":"boolean","description":"Specifies whether or not an object property is write only and should not be used as part of the response","example":false},"deprecated":{"type":"boolean","description":"Specifies whether or not the schema is deprecated. It should be transitioned out of usage","example":false},"externalDocs":{"$ref":"#/components/schemas/ExternalDocs"},"discriminator":{"$ref":"#/components/schemas/Discriminator"},"collectionFormat":{"type":"string"},"oneOf":{"type":"array","description":"Specifies that the schema can be one of those listed","items":{"$ref":"#/components/schemas/SchemaObject"}},"anyOf":{"type":"array","description":"Specifies that the schema can be any of those listed","items":{"$ref":"#/components/schemas/SchemaObject"}},"allOf":{"type":"array","description":"Specifies that the schema is a combination of all of those listed","items":{"$ref":"#/components/schemas/SchemaObject"}},"tokenRequestEndpoint":{"$ref":"#/components/schemas/TokenRequestEndpoint"},"tokenEndpoint":{"$ref":"#/components/schemas/TokenEndpoint"},"$ref":{"type":"string","description":"A Reference to a definition on definitions object","example":"#/definitions/User"},"default":{"type":"object","description":"Default value for this schema if it is applicable"},"type":{"type":"string","description":"The type ex: array , boolean, integer , null , number, object, string","example":"string"},"enum":{"type":"array","items":{"type":"object"}}},"description":"The Authorization Code Grant flow definition."},"ClientCredentials":{"type":"object","properties":{"id":{"type":"string","description":"An identifier","readOnly":true},"title":{"type":"string","description":"Schema title"},"description":{"type":"string","description":"Description of the Schema"},"format":{"type":"string","description":"The format ex: int32, int64, float, double, byte, binary, date, date-time or password"},"required":{"type":"array","description":"Specifies if the parameter is required","items":{"type":"string","description":"Specifies if the parameter is required"}},"properties":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/SchemaObject"},"description":"Not used because our model does not support inline nested types"},"additionalProperties":{"type":"object","description":"Specifies additional schema properties"},"items":{"$ref":"#/components/schemas/SchemaObject"},"example":{"type":"object","description":"Specifies an example of an instance of this schema"},"xml":{"type":"object","description":"Specifies metadata to describe the XML representation format of this schema"},"maxLength":{"type":"integer","description":"Indicates the maximum length of a parameter of type 'string'","format":"int32","example":100},"minLength":{"type":"integer","description":"Indicates the minimum length of a parameter of type 'string'. If not present, assumed default value is 0.","format":"int32","example":3},"pattern":{"type":"string","description":"Specifies a valid regular expression against which a parameter of type 'string' is validated.","example":"3"},"exclusiveMinimum":{"type":"boolean","description":"If true, specifies that the value of the number parameter must be greater than the specified minimum value, otherwise the value must be great than, or equal to, the specified minimum value.","example":true},"exclusiveMaximum":{"type":"boolean","description":"If true, specifies that the value of the number parameter must be less than the specified maximum value, otherwise the value must be less than, or equal to, the specified maximum value.","example":false},"minimum":{"type":"object","description":"Specifies the minimum possible value of the number parameter.","example":1},"maximum":{"type":"object","description":"Specifies the maximum possible value of the number parameter.","example":100},"multipleOf":{"type":"number","description":"Specifies that the value of the number parameter must be divisible by this value. Must be an integer value > 0","example":10},"maxItems":{"type":"integer","description":"Specifies the maximum number of items permitted for array parameters. Must be an integer value greater than, or equal to 0","format":"int32","example":3},"minItems":{"type":"integer","description":"Specifies the minimum number of items permitted for array parameters. Must be an integer value greater than, or equal to 0","format":"int32","example":0},"uniqueItems":{"type":"boolean","description":"Specifies whether or not all array items should be unique.","example":true},"allowEmptyValue":{"type":"boolean","description":"Specifies whether or not an empty value is permitted.","example":false},"maxProperties":{"type":"integer","description":"Specifies the maximum number of items permitted for object parameters. Must be an integer value greater than, or equal to 0","format":"int32","example":3},"minProperties":{"type":"integer","description":"Specifies the minimum number of items permitted for object parameters. Must be an integer value greater than, or equal to 0","format":"int32","example":0},"not":{"$ref":"#/components/schemas/SchemaObject"},"nullable":{"type":"boolean","description":"Specifies whether or not a null value for the defined schema should be allowed","example":false},"readOnly":{"type":"boolean","description":"Specifies whether or not an object property is read only and should not be used as part of the request","example":false},"writeOnly":{"type":"boolean","description":"Specifies whether or not an object property is write only and should not be used as part of the response","example":false},"deprecated":{"type":"boolean","description":"Specifies whether or not the schema is deprecated. It should be transitioned out of usage","example":false},"externalDocs":{"$ref":"#/components/schemas/ExternalDocs"},"discriminator":{"$ref":"#/components/schemas/Discriminator"},"collectionFormat":{"type":"string"},"oneOf":{"type":"array","description":"Specifies that the schema can be one of those listed","items":{"$ref":"#/components/schemas/SchemaObject"}},"anyOf":{"type":"array","description":"Specifies that the schema can be any of those listed","items":{"$ref":"#/components/schemas/SchemaObject"}},"allOf":{"type":"array","description":"Specifies that the schema is a combination of all of those listed","items":{"$ref":"#/components/schemas/SchemaObject"}},"url":{"type":"string","description":"The URL of the token endpoint for the client credentials grant flow. The value should be in a URL format.","example":"https://localhost:8089/api/oauth/token"},"tokenName":{"type":"string","description":"An optional alternative name to standard 'access_token' OAuth2 parameter.","example":"access_token"},"$ref":{"type":"string","description":"A Reference to a definition on definitions object","example":"#/definitions/User"},"default":{"type":"object","description":"Default value for this schema if it is applicable"},"type":{"type":"string","description":"The type ex: array , boolean, integer , null , number, object, string","example":"string"},"enum":{"type":"array","items":{"type":"object"}}},"description":"The Client Credentials Grant flow definition."},"Discriminator":{"type":"object","properties":{"propertyName":{"type":"string"},"mapping":{"type":"object","additionalProperties":{"type":"string"}}},"description":"Specifies an object name that is used to differentiate between other schemas. It adds support for polymorphism."},"ErrorResponse":{"type":"object","properties":{"id":{"type":"string","description":"An identifier","readOnly":true},"title":{"type":"string","description":"Schema title"},"description":{"type":"string","description":"Description of the Schema"},"format":{"type":"string","description":"The format ex: int32, int64, float, double, byte, binary, date, date-time or password"},"required":{"type":"array","description":"Specifies if the parameter is required","items":{"type":"string","description":"Specifies if the parameter is required"}},"properties":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/SchemaObject"},"description":"Not used because our model does not support inline nested types"},"additionalProperties":{"type":"object","description":"Specifies additional schema properties"},"items":{"$ref":"#/components/schemas/SchemaObject"},"example":{"type":"object","description":"Specifies an example of an instance of this schema"},"xml":{"type":"object","description":"Specifies metadata to describe the XML representation format of this schema"},"maxLength":{"type":"integer","description":"Indicates the maximum length of a parameter of type 'string'","format":"int32","example":100},"minLength":{"type":"integer","description":"Indicates the minimum length of a parameter of type 'string'. If not present, assumed default value is 0.","format":"int32","example":3},"pattern":{"type":"string","description":"Specifies a valid regular expression against which a parameter of type 'string' is validated.","example":"3"},"exclusiveMinimum":{"type":"boolean","description":"If true, specifies that the value of the number parameter must be greater than the specified minimum value, otherwise the value must be great than, or equal to, the specified minimum value.","example":true},"exclusiveMaximum":{"type":"boolean","description":"If true, specifies that the value of the number parameter must be less than the specified maximum value, otherwise the value must be less than, or equal to, the specified maximum value.","example":false},"minimum":{"type":"object","description":"Specifies the minimum possible value of the number parameter.","example":1},"maximum":{"type":"object","description":"Specifies the maximum possible value of the number parameter.","example":100},"multipleOf":{"type":"number","description":"Specifies that the value of the number parameter must be divisible by this value. Must be an integer value > 0","example":10},"maxItems":{"type":"integer","description":"Specifies the maximum number of items permitted for array parameters. Must be an integer value greater than, or equal to 0","format":"int32","example":3},"minItems":{"type":"integer","description":"Specifies the minimum number of items permitted for array parameters. Must be an integer value greater than, or equal to 0","format":"int32","example":0},"uniqueItems":{"type":"boolean","description":"Specifies whether or not all array items should be unique.","example":true},"allowEmptyValue":{"type":"boolean","description":"Specifies whether or not an empty value is permitted.","example":false},"maxProperties":{"type":"integer","description":"Specifies the maximum number of items permitted for object parameters. Must be an integer value greater than, or equal to 0","format":"int32","example":3},"minProperties":{"type":"integer","description":"Specifies the minimum number of items permitted for object parameters. Must be an integer value greater than, or equal to 0","format":"int32","example":0},"not":{"$ref":"#/components/schemas/SchemaObject"},"nullable":{"type":"boolean","description":"Specifies whether or not a null value for the defined schema should be allowed","example":false},"readOnly":{"type":"boolean","description":"Specifies whether or not an object property is read only and should not be used as part of the request","example":false},"writeOnly":{"type":"boolean","description":"Specifies whether or not an object property is write only and should not be used as part of the response","example":false},"deprecated":{"type":"boolean","description":"Specifies whether or not the schema is deprecated. It should be transitioned out of usage","example":false},"externalDocs":{"$ref":"#/components/schemas/ExternalDocs"},"discriminator":{"$ref":"#/components/schemas/Discriminator"},"collectionFormat":{"type":"string"},"oneOf":{"type":"array","description":"Specifies that the schema can be one of those listed","items":{"$ref":"#/components/schemas/SchemaObject"}},"anyOf":{"type":"array","description":"Specifies that the schema can be any of those listed","items":{"$ref":"#/components/schemas/SchemaObject"}},"allOf":{"type":"array","description":"Specifies that the schema is a combination of all of those listed","items":{"$ref":"#/components/schemas/SchemaObject"}},"code":{"type":"integer","format":"int64"},"reason":{"type":"string"},"schema":{"$ref":"#/components/schemas/SchemaObject"},"$ref":{"type":"string","description":"A Reference to a definition on definitions object","example":"#/definitions/User"},"default":{"type":"object","description":"Default value for this schema if it is applicable"},"type":{"type":"string","description":"The type ex: array , boolean, integer , null , number, object, string","example":"string"},"enum":{"type":"array","items":{"type":"object"}}}},"ExternalDocs":{"type":"object","properties":{"description":{"type":"string"},"url":{"type":"string"}},"description":"Specifies external documentation"},"GrantTypes":{"type":"object","properties":{"id":{"type":"string","description":"An identifier","readOnly":true},"title":{"type":"string","description":"Schema title"},"description":{"type":"string","description":"Description of the Schema"},"format":{"type":"string","description":"The format ex: int32, int64, float, double, byte, binary, date, date-time or password"},"required":{"type":"array","description":"Specifies if the parameter is required","items":{"type":"string","description":"Specifies if the parameter is required"}},"properties":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/SchemaObject"},"description":"Not used because our model does not support inline nested types"},"additionalProperties":{"type":"object","description":"Specifies additional schema properties"},"items":{"$ref":"#/components/schemas/SchemaObject"},"example":{"type":"object","description":"Specifies an example of an instance of this schema"},"xml":{"type":"object","description":"Specifies metadata to describe the XML representation format of this schema"},"maxLength":{"type":"integer","description":"Indicates the maximum length of a parameter of type 'string'","format":"int32","example":100},"minLength":{"type":"integer","description":"Indicates the minimum length of a parameter of type 'string'. If not present, assumed default value is 0.","format":"int32","example":3},"pattern":{"type":"string","description":"Specifies a valid regular expression against which a parameter of type 'string' is validated.","example":"3"},"exclusiveMinimum":{"type":"boolean","description":"If true, specifies that the value of the number parameter must be greater than the specified minimum value, otherwise the value must be great than, or equal to, the specified minimum value.","example":true},"exclusiveMaximum":{"type":"boolean","description":"If true, specifies that the value of the number parameter must be less than the specified maximum value, otherwise the value must be less than, or equal to, the specified maximum value.","example":false},"minimum":{"type":"object","description":"Specifies the minimum possible value of the number parameter.","example":1},"maximum":{"type":"object","description":"Specifies the maximum possible value of the number parameter.","example":100},"multipleOf":{"type":"number","description":"Specifies that the value of the number parameter must be divisible by this value. Must be an integer value > 0","example":10},"maxItems":{"type":"integer","description":"Specifies the maximum number of items permitted for array parameters. Must be an integer value greater than, or equal to 0","format":"int32","example":3},"minItems":{"type":"integer","description":"Specifies the minimum number of items permitted for array parameters. Must be an integer value greater than, or equal to 0","format":"int32","example":0},"uniqueItems":{"type":"boolean","description":"Specifies whether or not all array items should be unique.","example":true},"allowEmptyValue":{"type":"boolean","description":"Specifies whether or not an empty value is permitted.","example":false},"maxProperties":{"type":"integer","description":"Specifies the maximum number of items permitted for object parameters. Must be an integer value greater than, or equal to 0","format":"int32","example":3},"minProperties":{"type":"integer","description":"Specifies the minimum number of items permitted for object parameters. Must be an integer value greater than, or equal to 0","format":"int32","example":0},"not":{"$ref":"#/components/schemas/SchemaObject"},"nullable":{"type":"boolean","description":"Specifies whether or not a null value for the defined schema should be allowed","example":false},"readOnly":{"type":"boolean","description":"Specifies whether or not an object property is read only and should not be used as part of the request","example":false},"writeOnly":{"type":"boolean","description":"Specifies whether or not an object property is write only and should not be used as part of the response","example":false},"deprecated":{"type":"boolean","description":"Specifies whether or not the schema is deprecated. It should be transitioned out of usage","example":false},"externalDocs":{"$ref":"#/components/schemas/ExternalDocs"},"discriminator":{"$ref":"#/components/schemas/Discriminator"},"collectionFormat":{"type":"string"},"oneOf":{"type":"array","description":"Specifies that the schema can be one of those listed","items":{"$ref":"#/components/schemas/SchemaObject"}},"anyOf":{"type":"array","description":"Specifies that the schema can be any of those listed","items":{"$ref":"#/components/schemas/SchemaObject"}},"allOf":{"type":"array","description":"Specifies that the schema is a combination of all of those listed","items":{"$ref":"#/components/schemas/SchemaObject"}},"implicit":{"$ref":"#/components/schemas/Implicit"},"clientCredentials":{"$ref":"#/components/schemas/ClientCredentials"},"$ref":{"type":"string","description":"A Reference to a definition on definitions object","example":"#/definitions/User"},"default":{"type":"object","description":"Default value for this schema if it is applicable"},"type":{"type":"string","description":"The type ex: array , boolean, integer , null , number, object, string","example":"string"},"authorization_code":{"$ref":"#/components/schemas/AuthorizationCode"},"enum":{"type":"array","items":{"type":"object"}}},"description":"The OAuth grant types."},"Implicit":{"type":"object","properties":{"id":{"type":"string","description":"An identifier","readOnly":true},"title":{"type":"string","description":"Schema title"},"description":{"type":"string","description":"Description of the Schema"},"format":{"type":"string","description":"The format ex: int32, int64, float, double, byte, binary, date, date-time or password"},"required":{"type":"array","description":"Specifies if the parameter is required","items":{"type":"string","description":"Specifies if the parameter is required"}},"properties":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/SchemaObject"},"description":"Not used because our model does not support inline nested types"},"additionalProperties":{"type":"object","description":"Specifies additional schema properties"},"items":{"$ref":"#/components/schemas/SchemaObject"},"example":{"type":"object","description":"Specifies an example of an instance of this schema"},"xml":{"type":"object","description":"Specifies metadata to describe the XML representation format of this schema"},"maxLength":{"type":"integer","description":"Indicates the maximum length of a parameter of type 'string'","format":"int32","example":100},"minLength":{"type":"integer","description":"Indicates the minimum length of a parameter of type 'string'. If not present, assumed default value is 0.","format":"int32","example":3},"pattern":{"type":"string","description":"Specifies a valid regular expression against which a parameter of type 'string' is validated.","example":"3"},"exclusiveMinimum":{"type":"boolean","description":"If true, specifies that the value of the number parameter must be greater than the specified minimum value, otherwise the value must be great than, or equal to, the specified minimum value.","example":true},"exclusiveMaximum":{"type":"boolean","description":"If true, specifies that the value of the number parameter must be less than the specified maximum value, otherwise the value must be less than, or equal to, the specified maximum value.","example":false},"minimum":{"type":"object","description":"Specifies the minimum possible value of the number parameter.","example":1},"maximum":{"type":"object","description":"Specifies the maximum possible value of the number parameter.","example":100},"multipleOf":{"type":"number","description":"Specifies that the value of the number parameter must be divisible by this value. Must be an integer value > 0","example":10},"maxItems":{"type":"integer","description":"Specifies the maximum number of items permitted for array parameters. Must be an integer value greater than, or equal to 0","format":"int32","example":3},"minItems":{"type":"integer","description":"Specifies the minimum number of items permitted for array parameters. Must be an integer value greater than, or equal to 0","format":"int32","example":0},"uniqueItems":{"type":"boolean","description":"Specifies whether or not all array items should be unique.","example":true},"allowEmptyValue":{"type":"boolean","description":"Specifies whether or not an empty value is permitted.","example":false},"maxProperties":{"type":"integer","description":"Specifies the maximum number of items permitted for object parameters. Must be an integer value greater than, or equal to 0","format":"int32","example":3},"minProperties":{"type":"integer","description":"Specifies the minimum number of items permitted for object parameters. Must be an integer value greater than, or equal to 0","format":"int32","example":0},"not":{"$ref":"#/components/schemas/SchemaObject"},"nullable":{"type":"boolean","description":"Specifies whether or not a null value for the defined schema should be allowed","example":false},"readOnly":{"type":"boolean","description":"Specifies whether or not an object property is read only and should not be used as part of the request","example":false},"writeOnly":{"type":"boolean","description":"Specifies whether or not an object property is write only and should not be used as part of the response","example":false},"deprecated":{"type":"boolean","description":"Specifies whether or not the schema is deprecated. It should be transitioned out of usage","example":false},"externalDocs":{"$ref":"#/components/schemas/ExternalDocs"},"discriminator":{"$ref":"#/components/schemas/Discriminator"},"collectionFormat":{"type":"string"},"oneOf":{"type":"array","description":"Specifies that the schema can be one of those listed","items":{"$ref":"#/components/schemas/SchemaObject"}},"anyOf":{"type":"array","description":"Specifies that the schema can be any of those listed","items":{"$ref":"#/components/schemas/SchemaObject"}},"allOf":{"type":"array","description":"Specifies that the schema is a combination of all of those listed","items":{"$ref":"#/components/schemas/SchemaObject"}},"loginEndpoint":{"$ref":"#/components/schemas/LoginEndpoint"},"tokenName":{"type":"string","description":"An optional alternative name to standard 'access_token' OAuth2 parameter.","example":"access_token"},"$ref":{"type":"string","description":"A Reference to a definition on definitions object","example":"#/definitions/User"},"default":{"type":"object","description":"Default value for this schema if it is applicable"},"type":{"type":"string","description":"The type ex: array , boolean, integer , null , number, object, string","example":"string"},"enum":{"type":"array","items":{"type":"object"}}},"description":"The Implicit Grant flow definition."},"LoginEndpoint":{"type":"object","properties":{"id":{"type":"string","description":"An identifier","readOnly":true},"title":{"type":"string","description":"Schema title"},"description":{"type":"string","description":"Description of the Schema"},"format":{"type":"string","description":"The format ex: int32, int64, float, double, byte, binary, date, date-time or password"},"required":{"type":"array","description":"Specifies if the parameter is required","items":{"type":"string","description":"Specifies if the parameter is required"}},"properties":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/SchemaObject"},"description":"Not used because our model does not support inline nested types"},"additionalProperties":{"type":"object","description":"Specifies additional schema properties"},"items":{"$ref":"#/components/schemas/SchemaObject"},"example":{"type":"object","description":"Specifies an example of an instance of this schema"},"xml":{"type":"object","description":"Specifies metadata to describe the XML representation format of this schema"},"maxLength":{"type":"integer","description":"Indicates the maximum length of a parameter of type 'string'","format":"int32","example":100},"minLength":{"type":"integer","description":"Indicates the minimum length of a parameter of type 'string'. If not present, assumed default value is 0.","format":"int32","example":3},"pattern":{"type":"string","description":"Specifies a valid regular expression against which a parameter of type 'string' is validated.","example":"3"},"exclusiveMinimum":{"type":"boolean","description":"If true, specifies that the value of the number parameter must be greater than the specified minimum value, otherwise the value must be great than, or equal to, the specified minimum value.","example":true},"exclusiveMaximum":{"type":"boolean","description":"If true, specifies that the value of the number parameter must be less than the specified maximum value, otherwise the value must be less than, or equal to, the specified maximum value.","example":false},"minimum":{"type":"object","description":"Specifies the minimum possible value of the number parameter.","example":1},"maximum":{"type":"object","description":"Specifies the maximum possible value of the number parameter.","example":100},"multipleOf":{"type":"number","description":"Specifies that the value of the number parameter must be divisible by this value. Must be an integer value > 0","example":10},"maxItems":{"type":"integer","description":"Specifies the maximum number of items permitted for array parameters. Must be an integer value greater than, or equal to 0","format":"int32","example":3},"minItems":{"type":"integer","description":"Specifies the minimum number of items permitted for array parameters. Must be an integer value greater than, or equal to 0","format":"int32","example":0},"uniqueItems":{"type":"boolean","description":"Specifies whether or not all array items should be unique.","example":true},"allowEmptyValue":{"type":"boolean","description":"Specifies whether or not an empty value is permitted.","example":false},"maxProperties":{"type":"integer","description":"Specifies the maximum number of items permitted for object parameters. Must be an integer value greater than, or equal to 0","format":"int32","example":3},"minProperties":{"type":"integer","description":"Specifies the minimum number of items permitted for object parameters. Must be an integer value greater than, or equal to 0","format":"int32","example":0},"not":{"$ref":"#/components/schemas/SchemaObject"},"nullable":{"type":"boolean","description":"Specifies whether or not a null value for the defined schema should be allowed","example":false},"readOnly":{"type":"boolean","description":"Specifies whether or not an object property is read only and should not be used as part of the request","example":false},"writeOnly":{"type":"boolean","description":"Specifies whether or not an object property is write only and should not be used as part of the response","example":false},"deprecated":{"type":"boolean","description":"Specifies whether or not the schema is deprecated. It should be transitioned out of usage","example":false},"externalDocs":{"$ref":"#/components/schemas/ExternalDocs"},"discriminator":{"$ref":"#/components/schemas/Discriminator"},"collectionFormat":{"type":"string"},"oneOf":{"type":"array","description":"Specifies that the schema can be one of those listed","items":{"$ref":"#/components/schemas/SchemaObject"}},"anyOf":{"type":"array","description":"Specifies that the schema can be any of those listed","items":{"$ref":"#/components/schemas/SchemaObject"}},"allOf":{"type":"array","description":"Specifies that the schema is a combination of all of those listed","items":{"$ref":"#/components/schemas/SchemaObject"}},"url":{"type":"string","description":"The URL of the authorization endpoint for the implicit grant flow. The value should be in a URL format.","example":"http://myapi.io/oauth/dialog"},"$ref":{"type":"string","description":"A Reference to a definition on definitions object","example":"#/definitions/User"},"default":{"type":"object","description":"Default value for this schema if it is applicable"},"type":{"type":"string","description":"The type ex: array , boolean, integer , null , number, object, string","example":"string"},"enum":{"type":"array","items":{"type":"object"}}},"description":"The login endpoint definition."},"Operation":{"type":"object","properties":{"id":{"type":"string","description":"An identifier","readOnly":true},"title":{"type":"string","description":"Schema title"},"description":{"type":"string","description":"Description of the Schema"},"format":{"type":"string","description":"The format ex: int32, int64, float, double, byte, binary, date, date-time or password"},"required":{"type":"array","description":"Specifies if the parameter is required","items":{"type":"string","description":"Specifies if the parameter is required"}},"properties":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/SchemaObject"},"description":"Not used because our model does not support inline nested types"},"additionalProperties":{"type":"object","description":"Specifies additional schema properties"},"items":{"$ref":"#/components/schemas/SchemaObject"},"example":{"type":"object","description":"Specifies an example of an instance of this schema"},"xml":{"type":"object","description":"Specifies metadata to describe the XML representation format of this schema"},"maxLength":{"type":"integer","description":"Indicates the maximum length of a parameter of type 'string'","format":"int32","example":100},"minLength":{"type":"integer","description":"Indicates the minimum length of a parameter of type 'string'. If not present, assumed default value is 0.","format":"int32","example":3},"pattern":{"type":"string","description":"Specifies a valid regular expression against which a parameter of type 'string' is validated.","example":"3"},"exclusiveMinimum":{"type":"boolean","description":"If true, specifies that the value of the number parameter must be greater than the specified minimum value, otherwise the value must be great than, or equal to, the specified minimum value.","example":true},"exclusiveMaximum":{"type":"boolean","description":"If true, specifies that the value of the number parameter must be less than the specified maximum value, otherwise the value must be less than, or equal to, the specified maximum value.","example":false},"minimum":{"type":"object","description":"Specifies the minimum possible value of the number parameter.","example":1},"maximum":{"type":"object","description":"Specifies the maximum possible value of the number parameter.","example":100},"multipleOf":{"type":"number","description":"Specifies that the value of the number parameter must be divisible by this value. Must be an integer value > 0","example":10},"maxItems":{"type":"integer","description":"Specifies the maximum number of items permitted for array parameters. Must be an integer value greater than, or equal to 0","format":"int32","example":3},"minItems":{"type":"integer","description":"Specifies the minimum number of items permitted for array parameters. Must be an integer value greater than, or equal to 0","format":"int32","example":0},"uniqueItems":{"type":"boolean","description":"Specifies whether or not all array items should be unique.","example":true},"allowEmptyValue":{"type":"boolean","description":"Specifies whether or not an empty value is permitted.","example":false},"maxProperties":{"type":"integer","description":"Specifies the maximum number of items permitted for object parameters. Must be an integer value greater than, or equal to 0","format":"int32","example":3},"minProperties":{"type":"integer","description":"Specifies the minimum number of items permitted for object parameters. Must be an integer value greater than, or equal to 0","format":"int32","example":0},"not":{"$ref":"#/components/schemas/SchemaObject"},"nullable":{"type":"boolean","description":"Specifies whether or not a null value for the defined schema should be allowed","example":false},"readOnly":{"type":"boolean","description":"Specifies whether or not an object property is read only and should not be used as part of the request","example":false},"writeOnly":{"type":"boolean","description":"Specifies whether or not an object property is write only and should not be used as part of the response","example":false},"externalDocs":{"$ref":"#/components/schemas/ExternalDocs"},"discriminator":{"$ref":"#/components/schemas/Discriminator"},"collectionFormat":{"type":"string"},"oneOf":{"type":"array","description":"Specifies that the schema can be one of those listed","items":{"$ref":"#/components/schemas/SchemaObject"}},"anyOf":{"type":"array","description":"Specifies that the schema can be any of those listed","items":{"$ref":"#/components/schemas/SchemaObject"}},"allOf":{"type":"array","description":"Specifies that the schema is a combination of all of those listed","items":{"$ref":"#/components/schemas/SchemaObject"}},"httpMethod":{"type":"string"},"nickname":{"type":"string"},"summary":{"type":"string"},"notes":{"type":"string"},"responseClass":{"type":"string"},"errorResponses":{"type":"array","items":{"$ref":"#/components/schemas/ErrorResponse"}},"consumes":{"type":"array","items":{"type":"string"}},"produces":{"type":"array","items":{"type":"string"}},"authorizations":{"type":"object","additionalProperties":{"type":"array","items":{"type":"object"}}},"tags":{"type":"object","additionalProperties":{"type":"array","description":"The list of tags associated with this API operation. Each tag can have multiple values","example":{"Category":["Social Network","Photos"],"Type":["REST"],"Department":["Development"]},"items":{"type":"string","description":"The list of tags associated with this API operation. Each tag can have multiple values","example":"{\"Category\":[\"Social Network\",\"Photos\"],\"Type\":[\"REST\"],\"Department\":[\"Development\"]}"}},"description":"The list of tags associated with this API operation. Each tag can have multiple values","example":{"Category":["Social Network","Photos"],"Type":["REST"],"Department":["Development"]}},"securityProfile":{"$ref":"#/components/schemas/SwaggerSecurityProfile"},"documentationUrl":{"type":"string","description":"The documentation URL for the operation","example":"http://api.acme.com/docs#method"},"cors":{"type":"boolean","description":"Indicates that the API is CORS enabled","example":true},"parameters":{"type":"array","description":"A list of accepted parameters","items":{"$ref":"#/components/schemas/ParameterV11ex"}},"$ref":{"type":"string","description":"A Reference to a definition on definitions object","example":"#/definitions/User"},"default":{"type":"object","description":"Default value for this schema if it is applicable"},"type":{"type":"string","description":"The return type of the method, e.g. void, array, or a type found in models","example":"User"},"enum":{"type":"array","items":{"type":"object"}}},"description":"An operation available to an API path."},"ParameterV11ex":{"type":"object","properties":{"id":{"type":"string","description":"An identifier","readOnly":true},"title":{"type":"string","description":"Schema title"},"description":{"type":"string","description":"Description of the Schema"},"format":{"type":"string","description":"The format ex: int32, int64, float, double, byte, binary, date, date-time or password"},"required":{"type":"boolean","description":"Indicates that the parameter is required","example":true},"properties":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/SchemaObject"},"description":"Not used because our model does not support inline nested types"},"additionalProperties":{"type":"object","description":"Specifies additional schema properties"},"items":{"$ref":"#/components/schemas/SchemaObject"},"example":{"type":"object","description":"Specifies an example of an instance of this schema"},"xml":{"type":"object","description":"Specifies metadata to describe the XML representation format of this schema"},"maxLength":{"type":"integer","description":"Indicates the maximum length of a parameter of type 'string'","format":"int32","example":100},"minLength":{"type":"integer","description":"Indicates the minimum length of a parameter of type 'string'. If not present, assumed default value is 0.","format":"int32","example":3},"pattern":{"type":"string","description":"Specifies a valid regular expression against which a parameter of type 'string' is validated.","example":"3"},"exclusiveMinimum":{"type":"boolean","description":"If true, specifies that the value of the number parameter must be greater than the specified minimum value, otherwise the value must be great than, or equal to, the specified minimum value.","example":true},"exclusiveMaximum":{"type":"boolean","description":"If true, specifies that the value of the number parameter must be less than the specified maximum value, otherwise the value must be less than, or equal to, the specified maximum value.","example":false},"multipleOf":{"type":"number","description":"Specifies that the value of the number parameter must be divisible by this value. Must be an integer value > 0","example":10},"maxItems":{"type":"integer","description":"Specifies the maximum number of items permitted for array parameters. Must be an integer value greater than, or equal to 0","format":"int32","example":3},"minItems":{"type":"integer","description":"Specifies the minimum number of items permitted for array parameters. Must be an integer value greater than, or equal to 0","format":"int32","example":0},"uniqueItems":{"type":"boolean","description":"Specifies whether or not all array items should be unique.","example":true},"allowEmptyValue":{"type":"boolean","description":"Specifies whether or not an empty value is permitted.","example":false},"maxProperties":{"type":"integer","description":"Specifies the maximum number of items permitted for object parameters. Must be an integer value greater than, or equal to 0","format":"int32","example":3},"minProperties":{"type":"integer","description":"Specifies the minimum number of items permitted for object parameters. Must be an integer value greater than, or equal to 0","format":"int32","example":0},"not":{"$ref":"#/components/schemas/SchemaObject"},"nullable":{"type":"boolean","description":"Specifies whether or not a null value for the defined schema should be allowed","example":false},"readOnly":{"type":"boolean","description":"Specifies whether or not an object property is read only and should not be used as part of the request","example":false},"writeOnly":{"type":"boolean","description":"Specifies whether or not an object property is write only and should not be used as part of the response","example":false},"externalDocs":{"$ref":"#/components/schemas/ExternalDocs"},"discriminator":{"$ref":"#/components/schemas/Discriminator"},"collectionFormat":{"type":"string"},"oneOf":{"type":"array","description":"Specifies that the schema can be one of those listed","items":{"$ref":"#/components/schemas/SchemaObject"}},"anyOf":{"type":"array","description":"Specifies that the schema can be any of those listed","items":{"$ref":"#/components/schemas/SchemaObject"}},"allOf":{"type":"array","description":"Specifies that the schema is a combination of all of those listed","items":{"$ref":"#/components/schemas/SchemaObject"}},"name":{"type":"string","description":"The parameter name","example":"userId"},"dataType":{"type":"string","description":"The parameter data type, e.g. boolean, byte, date, double, float, integer, long, string, or a type name found in models","example":"string"},"paramType":{"type":"string","description":"The parameter type, e.g. query, path, body, header","example":"body"},"allowMultiple":{"type":"boolean","description":"Indicates that the parameter can be included multiple times (e.g. query or form)","example":false,"default":false},"$ref":{"type":"string","description":"A Reference to a definition on definitions object","example":"#/definitions/User"},"default":{"type":"object","description":"Default value for this schema if it is applicable"},"type":{"type":"string","description":"The type ex: array , boolean, integer , null , number, object, string","example":"string"},"enum":{"type":"array","items":{"type":"object"}}},"description":"An operation parameter."},"SchemaObject":{"type":"object","properties":{"id":{"type":"string","description":"An identifier","readOnly":true},"title":{"type":"string","description":"Schema title"},"description":{"type":"string","description":"Description of the Schema"},"format":{"type":"string","description":"The format ex: int32, int64, float, double, byte, binary, date, date-time or password"},"required":{"type":"array","description":"Specifies if the parameter is required","items":{"type":"string","description":"Specifies if the parameter is required"}},"properties":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/SchemaObject"},"description":"Not used because our model does not support inline nested types"},"additionalProperties":{"type":"object","description":"Specifies additional schema properties"},"items":{"$ref":"#/components/schemas/SchemaObject"},"example":{"type":"object","description":"Specifies an example of an instance of this schema"},"xml":{"type":"object","description":"Specifies metadata to describe the XML representation format of this schema"},"maxLength":{"type":"integer","description":"Indicates the maximum length of a parameter of type 'string'","format":"int32","example":100},"minLength":{"type":"integer","description":"Indicates the minimum length of a parameter of type 'string'. If not present, assumed default value is 0.","format":"int32","example":3},"pattern":{"type":"string","description":"Specifies a valid regular expression against which a parameter of type 'string' is validated.","example":"3"},"exclusiveMinimum":{"type":"boolean","description":"If true, specifies that the value of the number parameter must be greater than the specified minimum value, otherwise the value must be great than, or equal to, the specified minimum value.","example":true},"exclusiveMaximum":{"type":"boolean","description":"If true, specifies that the value of the number parameter must be less than the specified maximum value, otherwise the value must be less than, or equal to, the specified maximum value.","example":false},"minimum":{"type":"object","description":"Specifies the minimum possible value of the number parameter.","example":1},"maximum":{"type":"object","description":"Specifies the maximum possible value of the number parameter.","example":100},"multipleOf":{"type":"number","description":"Specifies that the value of the number parameter must be divisible by this value. Must be an integer value > 0","example":10},"maxItems":{"type":"integer","description":"Specifies the maximum number of items permitted for array parameters. Must be an integer value greater than, or equal to 0","format":"int32","example":3},"minItems":{"type":"integer","description":"Specifies the minimum number of items permitted for array parameters. Must be an integer value greater than, or equal to 0","format":"int32","example":0},"uniqueItems":{"type":"boolean","description":"Specifies whether or not all array items should be unique.","example":true},"allowEmptyValue":{"type":"boolean","description":"Specifies whether or not an empty value is permitted.","example":false},"maxProperties":{"type":"integer","description":"Specifies the maximum number of items permitted for object parameters. Must be an integer value greater than, or equal to 0","format":"int32","example":3},"minProperties":{"type":"integer","description":"Specifies the minimum number of items permitted for object parameters. Must be an integer value greater than, or equal to 0","format":"int32","example":0},"not":{"$ref":"#/components/schemas/SchemaObject"},"nullable":{"type":"boolean","description":"Specifies whether or not a null value for the defined schema should be allowed","example":false},"readOnly":{"type":"boolean","description":"Specifies whether or not an object property is read only and should not be used as part of the request","example":false},"writeOnly":{"type":"boolean","description":"Specifies whether or not an object property is write only and should not be used as part of the response","example":false},"deprecated":{"type":"boolean","description":"Specifies whether or not the schema is deprecated. It should be transitioned out of usage","example":false},"externalDocs":{"$ref":"#/components/schemas/ExternalDocs"},"discriminator":{"$ref":"#/components/schemas/Discriminator"},"collectionFormat":{"type":"string"},"oneOf":{"type":"array","description":"Specifies that the schema can be one of those listed","items":{"$ref":"#/components/schemas/SchemaObject"}},"anyOf":{"type":"array","description":"Specifies that the schema can be any of those listed","items":{"$ref":"#/components/schemas/SchemaObject"}},"allOf":{"type":"array","description":"Specifies that the schema is a combination of all of those listed","items":{"$ref":"#/components/schemas/SchemaObject"}},"$ref":{"type":"string","description":"A Reference to a definition on definitions object","example":"#/definitions/User"},"default":{"type":"object","description":"Default value for this schema if it is applicable"},"type":{"type":"string","description":"The type ex: array , boolean, integer , null , number, object, string","example":"string"},"enum":{"type":"array","items":{"type":"object"}}},"description":"Schema Object model"},"Scope":{"type":"object","properties":{"id":{"type":"string","description":"An identifier","readOnly":true},"title":{"type":"string","description":"Schema title"},"description":{"type":"string","description":"Description of the Schema"},"format":{"type":"string","description":"The format ex: int32, int64, float, double, byte, binary, date, date-time or password"},"required":{"type":"array","description":"Specifies if the parameter is required","items":{"type":"string","description":"Specifies if the parameter is required"}},"properties":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/SchemaObject"},"description":"Not used because our model does not support inline nested types"},"additionalProperties":{"type":"object","description":"Specifies additional schema properties"},"items":{"$ref":"#/components/schemas/SchemaObject"},"example":{"type":"object","description":"Specifies an example of an instance of this schema"},"xml":{"type":"object","description":"Specifies metadata to describe the XML representation format of this schema"},"maxLength":{"type":"integer","description":"Indicates the maximum length of a parameter of type 'string'","format":"int32","example":100},"minLength":{"type":"integer","description":"Indicates the minimum length of a parameter of type 'string'. If not present, assumed default value is 0.","format":"int32","example":3},"pattern":{"type":"string","description":"Specifies a valid regular expression against which a parameter of type 'string' is validated.","example":"3"},"exclusiveMinimum":{"type":"boolean","description":"If true, specifies that the value of the number parameter must be greater than the specified minimum value, otherwise the value must be great than, or equal to, the specified minimum value.","example":true},"exclusiveMaximum":{"type":"boolean","description":"If true, specifies that the value of the number parameter must be less than the specified maximum value, otherwise the value must be less than, or equal to, the specified maximum value.","example":false},"minimum":{"type":"object","description":"Specifies the minimum possible value of the number parameter.","example":1},"maximum":{"type":"object","description":"Specifies the maximum possible value of the number parameter.","example":100},"multipleOf":{"type":"number","description":"Specifies that the value of the number parameter must be divisible by this value. Must be an integer value > 0","example":10},"maxItems":{"type":"integer","description":"Specifies the maximum number of items permitted for array parameters. Must be an integer value greater than, or equal to 0","format":"int32","example":3},"minItems":{"type":"integer","description":"Specifies the minimum number of items permitted for array parameters. Must be an integer value greater than, or equal to 0","format":"int32","example":0},"uniqueItems":{"type":"boolean","description":"Specifies whether or not all array items should be unique.","example":true},"allowEmptyValue":{"type":"boolean","description":"Specifies whether or not an empty value is permitted.","example":false},"maxProperties":{"type":"integer","description":"Specifies the maximum number of items permitted for object parameters. Must be an integer value greater than, or equal to 0","format":"int32","example":3},"minProperties":{"type":"integer","description":"Specifies the minimum number of items permitted for object parameters. Must be an integer value greater than, or equal to 0","format":"int32","example":0},"not":{"$ref":"#/components/schemas/SchemaObject"},"nullable":{"type":"boolean","description":"Specifies whether or not a null value for the defined schema should be allowed","example":false},"readOnly":{"type":"boolean","description":"Specifies whether or not an object property is read only and should not be used as part of the request","example":false},"writeOnly":{"type":"boolean","description":"Specifies whether or not an object property is write only and should not be used as part of the response","example":false},"deprecated":{"type":"boolean","description":"Specifies whether or not the schema is deprecated. It should be transitioned out of usage","example":false},"externalDocs":{"$ref":"#/components/schemas/ExternalDocs"},"discriminator":{"$ref":"#/components/schemas/Discriminator"},"collectionFormat":{"type":"string"},"oneOf":{"type":"array","description":"Specifies that the schema can be one of those listed","items":{"$ref":"#/components/schemas/SchemaObject"}},"anyOf":{"type":"array","description":"Specifies that the schema can be any of those listed","items":{"$ref":"#/components/schemas/SchemaObject"}},"allOf":{"type":"array","description":"Specifies that the schema is a combination of all of those listed","items":{"$ref":"#/components/schemas/SchemaObject"}},"scope":{"type":"string","description":"The OAuth2 scope name.","example":"read"},"$ref":{"type":"string","description":"A Reference to a definition on definitions object","example":"#/definitions/User"},"default":{"type":"object","description":"Default value for this schema if it is applicable"},"type":{"type":"string","description":"The type ex: array , boolean, integer , null , number, object, string","example":"string"},"enum":{"type":"array","items":{"type":"object"}}},"description":"The list of OAuth scopes."},"Swagger":{"type":"object","properties":{"id":{"type":"string","description":"An identifier","readOnly":true},"title":{"type":"string","description":"Schema title"},"description":{"type":"string","description":"Description of the Schema"},"format":{"type":"string","description":"The format ex: int32, int64, float, double, byte, binary, date, date-time or password"},"required":{"type":"array","description":"Specifies if the parameter is required","items":{"type":"string","description":"Specifies if the parameter is required"}},"properties":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/SchemaObject"},"description":"Not used because our model does not support inline nested types"},"additionalProperties":{"type":"object","description":"Specifies additional schema properties"},"items":{"$ref":"#/components/schemas/SchemaObject"},"example":{"type":"object","description":"Specifies an example of an instance of this schema"},"xml":{"type":"object","description":"Specifies metadata to describe the XML representation format of this schema"},"maxLength":{"type":"integer","description":"Indicates the maximum length of a parameter of type 'string'","format":"int32","example":100},"minLength":{"type":"integer","description":"Indicates the minimum length of a parameter of type 'string'. If not present, assumed default value is 0.","format":"int32","example":3},"pattern":{"type":"string","description":"Specifies a valid regular expression against which a parameter of type 'string' is validated.","example":"3"},"exclusiveMinimum":{"type":"boolean","description":"If true, specifies that the value of the number parameter must be greater than the specified minimum value, otherwise the value must be great than, or equal to, the specified minimum value.","example":true},"exclusiveMaximum":{"type":"boolean","description":"If true, specifies that the value of the number parameter must be less than the specified maximum value, otherwise the value must be less than, or equal to, the specified maximum value.","example":false},"minimum":{"type":"object","description":"Specifies the minimum possible value of the number parameter.","example":1},"maximum":{"type":"object","description":"Specifies the maximum possible value of the number parameter.","example":100},"multipleOf":{"type":"number","description":"Specifies that the value of the number parameter must be divisible by this value. Must be an integer value > 0","example":10},"maxItems":{"type":"integer","description":"Specifies the maximum number of items permitted for array parameters. Must be an integer value greater than, or equal to 0","format":"int32","example":3},"minItems":{"type":"integer","description":"Specifies the minimum number of items permitted for array parameters. Must be an integer value greater than, or equal to 0","format":"int32","example":0},"uniqueItems":{"type":"boolean","description":"Specifies whether or not all array items should be unique.","example":true},"allowEmptyValue":{"type":"boolean","description":"Specifies whether or not an empty value is permitted.","example":false},"maxProperties":{"type":"integer","description":"Specifies the maximum number of items permitted for object parameters. Must be an integer value greater than, or equal to 0","format":"int32","example":3},"minProperties":{"type":"integer","description":"Specifies the minimum number of items permitted for object parameters. Must be an integer value greater than, or equal to 0","format":"int32","example":0},"not":{"$ref":"#/components/schemas/SchemaObject"},"nullable":{"type":"boolean","description":"Specifies whether or not a null value for the defined schema should be allowed","example":false},"readOnly":{"type":"boolean","description":"Specifies whether or not an object property is read only and should not be used as part of the request","example":false},"writeOnly":{"type":"boolean","description":"Specifies whether or not an object property is write only and should not be used as part of the response","example":false},"deprecated":{"type":"boolean","description":"Indicates that the API is deprecated. If 'true', then the API may have a 'retirementDate'.","example":false},"externalDocs":{"$ref":"#/components/schemas/ExternalDocs"},"discriminator":{"$ref":"#/components/schemas/Discriminator"},"collectionFormat":{"type":"string"},"oneOf":{"type":"array","description":"Specifies that the schema can be one of those listed","items":{"$ref":"#/components/schemas/SchemaObject"}},"anyOf":{"type":"array","description":"Specifies that the schema can be any of those listed","items":{"$ref":"#/components/schemas/SchemaObject"}},"allOf":{"type":"array","description":"Specifies that the schema is a combination of all of those listed","items":{"$ref":"#/components/schemas/SchemaObject"}},"apiVersion":{"type":"string","description":"The API version","example":"1.0"},"swaggerVersion":{"type":"string","description":"The Swagger version","example":"1.1","default":"1.1"},"basePath":{"type":"string","description":"The base path","example":"http://basepath.org"},"resourcePath":{"type":"string","description":"The resource path hosted","example":"/api"},"models":{"type":"object","additionalProperties":{"type":"object","description":"The models/schema for the API","example":{"User":{"type":"object","required":["id","name","email"],"properties":{"id":{"type":"string"},"name":{"type":"string"},"email":{"type":"string"}}}}},"description":"The models/schema for the API","example":{"User":{"type":"object","required":["id","name","email"],"properties":{"id":{"type":"string"},"name":{"type":"string"},"email":{"type":"string"}}}}},"consumes":{"type":"array","description":"The content types that the API consumes","example":["application/json"],"items":{"type":"string","description":"The content types that the API consumes","example":"[\"application/json\"]"}},"produces":{"type":"array","description":"The content types that the API produces","example":["application/json"],"items":{"type":"string","description":"The content types that the API produces","example":"[\"application/json\"]"}},"authorizations":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/Authorization"},"description":"The Authorization schemes provided for this API","example":{}},"name":{"type":"string","description":"The name of the API","example":"Flickr"},"summary":{"type":"string","description":"Brief summary of the API.","example":"The Flickr photo-sharing API"},"securityProfile":{"$ref":"#/components/schemas/SwaggerSecurityProfile"},"basePaths":{"type":"array","description":"Array of basePaths supported for this API/service, based on the configured ports","example":["http://localhost:8080","https://localhost:8081"],"items":{"type":"string","description":"Array of basePaths supported for this API/service, based on the configured ports","example":"[\"http://localhost:8080\",\"https://localhost:8081\"]"}},"image":{"type":"string","description":"API image URL"},"state":{"type":"string","description":"The state of the API. Possible values: 'pending', 'unpublished', or 'published'.","example":"rest"},"cors":{"type":"boolean","description":"Indicates that the API is CORS enabled","example":true},"expired":{"type":"boolean","description":"Indicates that the API is expired.","example":false},"retirementDate":{"type":"integer","description":"Indicates that the API is deprecated and will be retired on the supplied date (in milliseconds).","format":"int64","example":1420070400000},"retired":{"type":"boolean","description":"Indicates that the API is retired.","example":false},"tags":{"type":"object","additionalProperties":{"type":"array","description":"The list of tags associated with this API. Each tag can have multiple values","example":{"Category":["Social Network","Photos"],"Type":["REST"],"Department":["Development"]},"items":{"type":"string","description":"The list of tags associated with this API. Each tag can have multiple values","example":"{\"Category\":[\"Social Network\",\"Photos\"],\"Type\":[\"REST\"],\"Department\":[\"Development\"]}"}},"description":"The list of tags associated with this API. Each tag can have multiple values","example":{"Category":["Social Network","Photos"],"Type":["REST"],"Department":["Development"]}},"documentationUrl":{"type":"string","description":"The documentation URL for the operation","example":"http://api.acme.com/docs#method"},"availableApiDefinitions":{"type":"object","additionalProperties":{"type":"string","description":"The schema definitions that this API supports and links to those definitions.","format":"uri","example":"{}"},"description":"The schema definitions that this API supports and links to those definitions.","example":{}},"availableSDK":{"type":"object","additionalProperties":{"type":"string","description":"The SDK downloads that this API supports and links to those downloads.","format":"uri","example":"{}"},"description":"The SDK downloads that this API supports and links to those downloads.","example":{}},"apis":{"type":"array","description":"The API resources","items":{"$ref":"#/components/schemas/API"}},"customProperties":{"type":"object","additionalProperties":{"type":"string","description":"Dictionary of name/value pairs containing the custom properties defined for this API","example":"{\"customProperty1\":\"value1\",\"customProperty2\":\"value2\"}"},"description":"Dictionary of name/value pairs containing the custom properties defined for this API","example":{"customProperty1":"value1","customProperty2":"value2"}},"createDate":{"type":"integer","description":"Epoch/Unix time stamp when the API was created","format":"int64","example":1364407145321},"accessGrantedDate":{"type":"integer","description":"Epoch/Unix time stamp when the API access was granted","format":"int64","example":1364407145321},"$ref":{"type":"string","description":"A Reference to a definition on definitions object","example":"#/definitions/User"},"default":{"type":"object","description":"Default value for this schema if it is applicable"},"type":{"type":"string","description":"The resource type. Possible values: 'rest', 'wsdl'","example":"rest"},"enum":{"type":"array","items":{"type":"object"}}},"description":"A Swagger API definition."},"SwaggerSecurityDevice":{"type":"object","properties":{"type":{"type":"string","description":"Type identifier for the device. Possible Values: HTTPBasicSecurityDevice, OAuthSecurityDevice, AWSRESTRequestSecurityDevice, AWSQueryStringRequestSecurityDevice, APIKeyOnlySecurityDevice, APIKeyAndSecretSecurityDevice, TwoWaySSLSecurityDevice","example":"HTTPBasicSecurityDevice"},"typeDisplayName":{"type":"string","description":"Textual display name for the device","example":"HTTP Basic Authentication"},"name":{"type":"string","description":"Name of the device","example":"HTTP Basic Device"},"order":{"type":"integer","description":"Order of preference, zero being highest. Devices will attempt to authenticate the incoming request using this order of preference.","format":"int32"},"scopes":{"type":"array","description":"The list of scopes defined for the security device.","example":"resource.READ","items":{"type":"string","description":"The list of scopes defined for the security device.","example":"resource.READ"}},"scopeMatching":{"type":"string","description":"Specifies how scopes will be matched. Possible values: [ Any, All ]","example":"Any"}},"description":"A Swagger API definition.","example":[{"type":"APIKeyOnlySecurityDevice","typeDisplayName":"API Key only","name":"API Key Device","order":1,"keyField":"KeyId"},{"type":"HTTPBasicSecurityDevice","typeDisplayName":"HTTP Basic Authentication","name":"HTTP Basic Device","order":0,"realm":"axway"}]},"SwaggerSecurityProfile":{"type":"object","properties":{"devices":{"type":"array","description":"List of Security Devices associated with this profile","example":[{"type":"APIKeyOnlySecurityDevice","typeDisplayName":"API Key only","name":"API Key Device","order":1,"keyField":"KeyId"},{"type":"HTTPBasicSecurityDevice","typeDisplayName":"HTTP Basic Authentication","name":"HTTP Basic Device","order":0,"realm":"axway"}],"items":{"$ref":"#/components/schemas/SwaggerSecurityDevice"}}},"description":"A Swagger API definition."},"TokenEndpoint":{"type":"object","properties":{"id":{"type":"string","description":"An identifier","readOnly":true},"title":{"type":"string","description":"Schema title"},"description":{"type":"string","description":"Description of the Schema"},"format":{"type":"string","description":"The format ex: int32, int64, float, double, byte, binary, date, date-time or password"},"required":{"type":"array","description":"Specifies if the parameter is required","items":{"type":"string","description":"Specifies if the parameter is required"}},"properties":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/SchemaObject"},"description":"Not used because our model does not support inline nested types"},"additionalProperties":{"type":"object","description":"Specifies additional schema properties"},"items":{"$ref":"#/components/schemas/SchemaObject"},"example":{"type":"object","description":"Specifies an example of an instance of this schema"},"xml":{"type":"object","description":"Specifies metadata to describe the XML representation format of this schema"},"maxLength":{"type":"integer","description":"Indicates the maximum length of a parameter of type 'string'","format":"int32","example":100},"minLength":{"type":"integer","description":"Indicates the minimum length of a parameter of type 'string'. If not present, assumed default value is 0.","format":"int32","example":3},"pattern":{"type":"string","description":"Specifies a valid regular expression against which a parameter of type 'string' is validated.","example":"3"},"exclusiveMinimum":{"type":"boolean","description":"If true, specifies that the value of the number parameter must be greater than the specified minimum value, otherwise the value must be great than, or equal to, the specified minimum value.","example":true},"exclusiveMaximum":{"type":"boolean","description":"If true, specifies that the value of the number parameter must be less than the specified maximum value, otherwise the value must be less than, or equal to, the specified maximum value.","example":false},"minimum":{"type":"object","description":"Specifies the minimum possible value of the number parameter.","example":1},"maximum":{"type":"object","description":"Specifies the maximum possible value of the number parameter.","example":100},"multipleOf":{"type":"number","description":"Specifies that the value of the number parameter must be divisible by this value. Must be an integer value > 0","example":10},"maxItems":{"type":"integer","description":"Specifies the maximum number of items permitted for array parameters. Must be an integer value greater than, or equal to 0","format":"int32","example":3},"minItems":{"type":"integer","description":"Specifies the minimum number of items permitted for array parameters. Must be an integer value greater than, or equal to 0","format":"int32","example":0},"uniqueItems":{"type":"boolean","description":"Specifies whether or not all array items should be unique.","example":true},"allowEmptyValue":{"type":"boolean","description":"Specifies whether or not an empty value is permitted.","example":false},"maxProperties":{"type":"integer","description":"Specifies the maximum number of items permitted for object parameters. Must be an integer value greater than, or equal to 0","format":"int32","example":3},"minProperties":{"type":"integer","description":"Specifies the minimum number of items permitted for object parameters. Must be an integer value greater than, or equal to 0","format":"int32","example":0},"not":{"$ref":"#/components/schemas/SchemaObject"},"nullable":{"type":"boolean","description":"Specifies whether or not a null value for the defined schema should be allowed","example":false},"readOnly":{"type":"boolean","description":"Specifies whether or not an object property is read only and should not be used as part of the request","example":false},"writeOnly":{"type":"boolean","description":"Specifies whether or not an object property is write only and should not be used as part of the response","example":false},"deprecated":{"type":"boolean","description":"Specifies whether or not the schema is deprecated. It should be transitioned out of usage","example":false},"externalDocs":{"$ref":"#/components/schemas/ExternalDocs"},"discriminator":{"$ref":"#/components/schemas/Discriminator"},"collectionFormat":{"type":"string"},"oneOf":{"type":"array","description":"Specifies that the schema can be one of those listed","items":{"$ref":"#/components/schemas/SchemaObject"}},"anyOf":{"type":"array","description":"Specifies that the schema can be any of those listed","items":{"$ref":"#/components/schemas/SchemaObject"}},"allOf":{"type":"array","description":"Specifies that the schema is a combination of all of those listed","items":{"$ref":"#/components/schemas/SchemaObject"}},"url":{"type":"string","description":"The URL of the token endpoint for the authentication code grant flow. The value should be in a URL format.","example":"http://myapi.io/oauth/token"},"tokenName":{"type":"string","description":"An optional alternative name to standard 'access_code' OAuth2 parameter.","example":"access_code"},"$ref":{"type":"string","description":"A Reference to a definition on definitions object","example":"#/definitions/User"},"default":{"type":"object","description":"Default value for this schema if it is applicable"},"type":{"type":"string","description":"The type ex: array , boolean, integer , null , number, object, string","example":"string"},"enum":{"type":"array","items":{"type":"object"}}},"description":"The login endpoint definition."},"TokenRequestEndpoint":{"type":"object","properties":{"id":{"type":"string","description":"An identifier","readOnly":true},"title":{"type":"string","description":"Schema title"},"description":{"type":"string","description":"Description of the Schema"},"format":{"type":"string","description":"The format ex: int32, int64, float, double, byte, binary, date, date-time or password"},"required":{"type":"array","description":"Specifies if the parameter is required","items":{"type":"string","description":"Specifies if the parameter is required"}},"properties":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/SchemaObject"},"description":"Not used because our model does not support inline nested types"},"additionalProperties":{"type":"object","description":"Specifies additional schema properties"},"items":{"$ref":"#/components/schemas/SchemaObject"},"example":{"type":"object","description":"Specifies an example of an instance of this schema"},"xml":{"type":"object","description":"Specifies metadata to describe the XML representation format of this schema"},"maxLength":{"type":"integer","description":"Indicates the maximum length of a parameter of type 'string'","format":"int32","example":100},"minLength":{"type":"integer","description":"Indicates the minimum length of a parameter of type 'string'. If not present, assumed default value is 0.","format":"int32","example":3},"pattern":{"type":"string","description":"Specifies a valid regular expression against which a parameter of type 'string' is validated.","example":"3"},"exclusiveMinimum":{"type":"boolean","description":"If true, specifies that the value of the number parameter must be greater than the specified minimum value, otherwise the value must be great than, or equal to, the specified minimum value.","example":true},"exclusiveMaximum":{"type":"boolean","description":"If true, specifies that the value of the number parameter must be less than the specified maximum value, otherwise the value must be less than, or equal to, the specified maximum value.","example":false},"minimum":{"type":"object","description":"Specifies the minimum possible value of the number parameter.","example":1},"maximum":{"type":"object","description":"Specifies the maximum possible value of the number parameter.","example":100},"multipleOf":{"type":"number","description":"Specifies that the value of the number parameter must be divisible by this value. Must be an integer value > 0","example":10},"maxItems":{"type":"integer","description":"Specifies the maximum number of items permitted for array parameters. Must be an integer value greater than, or equal to 0","format":"int32","example":3},"minItems":{"type":"integer","description":"Specifies the minimum number of items permitted for array parameters. Must be an integer value greater than, or equal to 0","format":"int32","example":0},"uniqueItems":{"type":"boolean","description":"Specifies whether or not all array items should be unique.","example":true},"allowEmptyValue":{"type":"boolean","description":"Specifies whether or not an empty value is permitted.","example":false},"maxProperties":{"type":"integer","description":"Specifies the maximum number of items permitted for object parameters. Must be an integer value greater than, or equal to 0","format":"int32","example":3},"minProperties":{"type":"integer","description":"Specifies the minimum number of items permitted for object parameters. Must be an integer value greater than, or equal to 0","format":"int32","example":0},"not":{"$ref":"#/components/schemas/SchemaObject"},"nullable":{"type":"boolean","description":"Specifies whether or not a null value for the defined schema should be allowed","example":false},"readOnly":{"type":"boolean","description":"Specifies whether or not an object property is read only and should not be used as part of the request","example":false},"writeOnly":{"type":"boolean","description":"Specifies whether or not an object property is write only and should not be used as part of the response","example":false},"deprecated":{"type":"boolean","description":"Specifies whether or not the schema is deprecated. It should be transitioned out of usage","example":false},"externalDocs":{"$ref":"#/components/schemas/ExternalDocs"},"discriminator":{"$ref":"#/components/schemas/Discriminator"},"collectionFormat":{"type":"string"},"oneOf":{"type":"array","description":"Specifies that the schema can be one of those listed","items":{"$ref":"#/components/schemas/SchemaObject"}},"anyOf":{"type":"array","description":"Specifies that the schema can be any of those listed","items":{"$ref":"#/components/schemas/SchemaObject"}},"allOf":{"type":"array","description":"Specifies that the schema is a combination of all of those listed","items":{"$ref":"#/components/schemas/SchemaObject"}},"url":{"type":"string","description":"The URL of the authorization endpoint for the authentication code grant flow. The value should be in a URL format.","example":"."},"clientIdName":{"type":"string","description":"An optional alternative name to standard \"client_id\" OAuth2 parameter.","example":"."},"clientSecretName":{"type":"string","description":"An optional alternative name to standard \"client_secret\" OAuth2 parameter.","example":"."},"$ref":{"type":"string","description":"A Reference to a definition on definitions object","example":"#/definitions/User"},"default":{"type":"object","description":"Default value for this schema if it is applicable"},"type":{"type":"string","description":"The type ex: array , boolean, integer , null , number, object, string","example":"string"},"enum":{"type":"array","items":{"type":"object"}}},"description":"The login endpoint definition."},"ReferencedEntity":{"required":["id","name"],"type":"object","properties":{"name":{"type":"string","description":"Name of the referenced entity (as specified in Policy Studio configuration).","example":"My Request Policy"},"id":{"type":"string","description":"Portable version of the ESPK of this referenced entity, formatted as an XML fragment.","example":"<key type='Example'>...</key>"}},"description":"A referenced entity from the Policy Studio configuration. Entities of this type have a dependency on the Policy Studio configuration."},"PortalTrafficListener":{"required":["address","id","name","port","protocol"],"type":"object","properties":{"id":{"type":"string","description":"The service listener identifier","example":"/[NetService]name=Service/[HTTP]name=API Portal"},"name":{"type":"string","description":"The name of the service listener","example":"API Manager"},"protocol":{"type":"string","description":"The listener protocol","example":"http"},"port":{"type":"integer","description":"The listener port","format":"int32","example":8080},"prefix":{"type":"string","description":"The listener prefix"},"address":{"type":"string","description":"The listener address","example":"localhost"},"url":{"type":"string","description":"The listener URL","example":"http://localhost:8080"}},"description":"A HTTP service listener."},"SystemConfig":{"type":"object","properties":{"disabledApis":{"type":"array","description":"Returns a list of disabled APIs","example":["c1c63d3b-5283-4755-ade7-e2377bd35049"],"items":{"type":"string","description":"Returns a list of disabled APIs","example":"[\"c1c63d3b-5283-4755-ade7-e2377bd35049\"]"}}},"description":"API Manager system configuration"},"Group":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"lock":{"$ref":"#/components/schemas/Lock"},"services":{"type":"array","items":{"$ref":"#/components/schemas/Service"}},"tags":{"type":"object","additionalProperties":{"type":"string"}}}},"Host":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}}},"Lock":{"type":"object","properties":{"locker":{"type":"string"},"timestamp":{"type":"integer","format":"int64"}}},"Service":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"scheme":{"type":"string"},"hostID":{"type":"string"},"managementPort":{"type":"integer","format":"int32"},"tags":{"type":"object","additionalProperties":{"type":"string"}},"type":{"type":"string","enum":["gateway","nodemanager"]},"enabled":{"type":"boolean"}}},"Topology":{"type":"object","properties":{"id":{"type":"string"},"version":{"type":"integer","format":"int32"},"timestamp":{"type":"integer","format":"int64"},"productVersion":{"type":"string"},"emtEnabled":{"type":"boolean"},"hosts":{"type":"array","items":{"$ref":"#/components/schemas/Host"}},"groups":{"type":"array","items":{"$ref":"#/components/schemas/Group"}},"uniqueIdCounters":{"type":"object","additionalProperties":{"type":"integer","format":"int32"}},"services":{"type":"array","items":{"$ref":"#/components/schemas/Service"}}}},"AuthenticationProfile":{"type":"object","properties":{"name":{"type":"string","description":"Unique name of the Profile","example":"Default Security Profile"},"isDefault":{"type":"boolean","description":"Indicates that this is the default profile. There can be only one default.","example":false,"default":false},"parameters":{"type":"object","additionalProperties":{"type":"object","description":"Parameters for the backend authentication profile","example":{"apiKey":"e7812c14-b67a-4eef-84a1-e18c0d8436ba","apiKeyField":"KeyId","httpLocation":"query"}},"description":"Parameters for the backend authentication profile","example":{"apiKey":"e7812c14-b67a-4eef-84a1-e18c0d8436ba","apiKeyField":"KeyId","httpLocation":"query"}},"type":{"type":"string","description":"Type of backend authentication. Possible values: *none*, *http_basic*, *http_digest*, *apiKey*, *oauth*, and *ssl*.","example":"apikey"}},"description":"Profile configuration that provides suport for outbound (backend) authentication, supporting no authentication, HTTP Basic, HTTP Digest, API Key, OAuth, and SSL authentication."},"CORSProfile":{"type":"object","properties":{"name":{"type":"string","description":"Unique name of the Profile","example":"Default Security Profile"},"isDefault":{"type":"boolean","description":"Indicates that this is the default profile. There can be only one default.","example":false,"default":false},"origins":{"type":"array","description":"List of origins for this CORS Profile","example":["http://api.google.com","http://api.flickr.com"],"items":{"type":"string","description":"List of origins for this CORS Profile","example":"[\"http://api.google.com\",\"http://api.flickr.com\"]"}},"allowedHeaders":{"type":"array","description":"List of headers...","example":["X-Request-Value","X-Hello-World"],"items":{"type":"string","description":"List of headers...","example":"[\"X-Request-Value\",\"X-Hello-World\"]"}},"exposedHeaders":{"type":"array","description":"List of headers...","example":["X-Trace","X-CorrelationID"],"items":{"type":"string","description":"List of headers...","example":"[\"X-Trace\",\"X-CorrelationID\"]"}},"supportCredentials":{"type":"boolean","description":"Specifies whether or credentials are supported for APIs/API Methods employing this CORS Profile.","example":false},"maxAgeSeconds":{"type":"integer","description":"Specifies the amount of time responses to OPTIONS requests are stored, in seconds, in the preflight result cache","format":"int64","example":84600}},"description":"Configures cross-origin resource sharing (CORS) as per w3c [CORS specification](http://www.w3.org/TR/cors/#resource-requests)."},"InboundProfiles":{"type":"object","properties":{"securityProfile":{"type":"string","description":"The name of the Security Profile to be used for this Virtualized API.","example":"Default Inbound Security"},"corsProfile":{"type":"string","description":"The name of the CORS Profile to be used for this Virtualized API.","example":"Default CORS profile"},"monitorAPI":{"type":"boolean","description":"Enables metrics monitoring for the API","example":true},"queryStringPassThrough":{"type":"boolean","description":"Enables query string pass through for the API","example":false,"default":false},"monitorSubject":{"type":"string","description":"Identifies the client for metrics monitoring","example":"authentication.subject.id"}},"description":"The inbound profile provides configuration for the frontend. The *\\_default* profile applies to all inbound API calls. However, methods may be overridden using the InboundProfiles.\n\nThe inbound profile overrides are used as part of the [VirtualizedAPI](VirtualizedAPI.html) definition and alters the normal API proxy behavior, allowing complete control over the frontend. Using the InboundProfiles, it is possible to enforce frontend security by setting **securityProfile** to the name of a configured [SecurityProfile](SecurityProfile.html). Monitoring for the API may be enabled/disabled using **monitorAPI**. The subject (client) for monitoring can be obtained from any message attribute, and can be changed using **monitorSubject**. In addition, CORS settings can be set using the **corsProfile**."},"OutboundProfiles":{"type":"object","properties":{"authenticationProfile":{"type":"string","description":"Outbound authentication credentials if __routeType__ is 'proxy'. Can be null to indicate no credentials.","example":"My Backend"},"routeType":{"type":"string","description":"The route type. Values are either: 'proxy' or 'policy'. Can be null and defaults to *proxy*.","example":"proxy"},"requestPolicy":{"type":"string","description":"Request policy that applies to all outbound requests. Can be null to indicate no policy."},"responsePolicy":{"type":"string","description":"Response policy that applies to all responses from outbound requests. Can be null to indicate no policy."},"routePolicy":{"type":"string","description":"Route policy if the routeType is 'policy', in which case it must be a valid policy ID. Can be null if __routeType__ is 'proxy'."},"faultHandlerPolicy":{"type":"string","description":"Fault handler policy that gets executed in the event of an error. Can be null to indicate no policy."},"apiId":{"type":"string","description":"Route to a different API. Can be null. Ignored on the 'default' outbound profile.","example":"9064396e-7743-4644-a0b7-d30b421e2b30"},"apiMethodId":{"type":"string","description":"Route to a different API method. Can be null. Ignored on the 'default' outbound profile.","example":"7fd18d9a-1258-4031-a168-d7f6bf612dc1"},"parameters":{"type":"array","description":"A list of outbound parameters values - maps from frontend parameters to backend parameters.","items":{"$ref":"#/components/schemas/ParamValue"}}},"description":"The outbound profile provides configuration for the backend. The *\\_default* profile applies to all outbound, backend API calls. However, methods may be overridden using the OutboundProfile.\n\nThe outbound profile overrides are used as part of the [VirtualizedAPI](VirtualizedAPI.html) definition and alters the normal API proxy behavior, allowing complete control over the backend. Using the OutboundProfiles, it is possible to provide backend authentication by setting **authenticationProfile** to the name of a configured [AuthenticationProfile](AuthenticationProfile.html). Optionally, a completely different API and method may be invoked using a reference to a different **apiId** and **apiMethodId** from a valid [APIDefinition](APIDefinition.html). Parameters can be added/removed using **parameters**, or their values changed completely. It is also possible to apply a **requestPolicy** or **responsePolicy** that has been configured in Policy Studio. For total control, the **routeType** can be changed to _proxy_ and use the **reoutePolicy** to route to a policy instead of a backend service."},"ParamValue":{"type":"object","properties":{"name":{"type":"string","description":"The parameter name.","example":"id"},"paramType":{"type":"string","description":"The type of parameter type. Can be one of: *body*, *query*, *path*, *form*, or *header*.","example":"query"},"type":{"type":"string","description":"The parameter data type. Can be one of: *string*, *integer*, etc.","example":"string"},"format":{"type":"string","description":"The parameter format","example":"int64"},"value":{"type":"string","description":"The parameter value. Can be a regular value, or a selector, e.g.: ${params.path.id}.","example":"${params.path.id}"},"required":{"type":"boolean","description":"Indicates whether or not the parameter is required for the backend API.","example":true},"exclude":{"type":"boolean","description":"Indicates whether or not the parameter is excluded for the backend API.","example":false},"additional":{"type":"boolean","description":"Indicates whether or not the parameter is an additional parameter (does not replace an existing parameter).","example":false}},"description":"Represents an API method parameter used in [OutboundProfiles](OutboundProfiles.html)."},"SecurityDevice":{"type":"object","properties":{"name":{"type":"string","description":"Unique name of the Security Device.","example":"My Pass-through Device"},"type":{"type":"string","description":"The Security device type. Values are one of: *apiKey*, *awsHeader*, *awsQuery*, *basic*, *authPolicy*, *oauth*, *oauthExternal*, *passThrough*, or *twoWaySSL*.","example":"apiKey"},"order":{"type":"integer","description":"Specifies the order in which this device will be invoked.","format":"int32","example":1},"properties":{"type":"object","additionalProperties":{"type":"string","description":"List of device-specific properties.","example":"{\"apiKeyFieldName\":\"APIKey\",\"takeFrom\":\"HEADER\"}"},"description":"List of device-specific properties.","example":{"apiKeyFieldName":"APIKey","takeFrom":"HEADER"}}},"description":"Inbound security device."},"SecurityProfile":{"type":"object","properties":{"name":{"type":"string","description":"Unique name of the Profile","example":"Default Security Profile"},"isDefault":{"type":"boolean","description":"Indicates that this is the default profile. There can be only one default.","example":false,"default":false},"devices":{"type":"array","description":"List of SecurityDevice for this security profile","items":{"$ref":"#/components/schemas/SecurityDevice"}}},"description":"Inbound security profile."},"ServiceProfiles":{"type":"object","properties":{"apiId":{"type":"string","description":"The backend service API identifier","example":"96f745ae-a41a-41a9-aad8-8bf24b5cc27e"},"basePath":{"type":"string","description":"The backend service base path URL","example":"http://backend.io"}},"description":"Service profile configuration for backend services"},"VirtualizedAPI":{"required":["apiId","apiRoutingKey","authenticationProfiles","caCerts","corsProfiles","deprecated","descriptionManual","descriptionMarkdown","descriptionType","descriptionUrl","expired","id","image","inboundProfiles","name","organizationId","path","retired","retirementDate","securityProfiles","serviceProfiles","state","summary","tags","version","vhost"],"type":"object","properties":{"id":{"type":"string","description":"Unique ID of the virtualized API.","readOnly":true,"example":"bacb827e-e555-43fa-b006-50c7404aa990"},"organizationId":{"type":"string","description":"The organization that created the virtualized API.","example":"b6889722b7-222-b06f-2eaaf1548898"},"apiId":{"type":"string","description":"The identifier of the API that was virtualized. This is the only attribute that is required to create a virtualized API.","example":"9064396e-7743-4644-a0b7-d30b421e2b30"},"name":{"type":"string","description":"The name of this virtualized API.","example":"My virtualized API"},"version":{"type":"string","description":"The API version.","example":"1.0"},"apiRoutingKey":{"type":"string","description":"The key for routing between two APIs on the same path.","example":"1"},"vhost":{"type":"string","description":"The virtual host of this virtualized API.","example":"host.company.com"},"path":{"type":"string","description":"The path that services this virtualized API.","example":"/flikr"},"descriptionType":{"type":"string","description":"Type of descripton to use. One of: _manual_, _markdown_, _url_, or _original_ (default).","example":"manual"},"descriptionManual":{"type":"string","description":"Markdown string to use as the description of the API.","example":"My API\n====\n\nThis is my API."},"descriptionMarkdown":{"type":"string","description":"Markdown file to use as the description of the API within the API Catalog.","example":"${environment.VINSTDIR}/../markdown/flickr/flickr.md"},"descriptionUrl":{"type":"string","description":"External URL to use as the description of the API.","example":"http://doc.api.org/myapi/mymethod#anchor"},"summary":{"type":"string","description":"A short summary description of the API.","example":"My API\n====\n\nThis is my API."},"retired":{"type":"boolean","description":"Immediately retires the virtualized API.","example":false},"expired":{"type":"boolean","description":"Immediately expires the virtualized API.","example":false},"image":{"type":"string","description":"URI of the image to be used for this virtualized API. To update the image, please refer to the API.","example":"resources/photo.jpg"},"retirementDate":{"type":"integer","description":"Date to retire the virtualized API. If _retired_ is true, this is the date on which it was retired.","format":"int64","example":1364287486876},"deprecated":{"type":"boolean","description":"Immediately deprecates the virtualized API. If deprecated, then _retiredOn_ is optionally used to retire the virtualized API on the specified date.","example":true},"state":{"type":"string","description":"The state of the virtualized API. One of: unpublished, pending, or published.","example":"unpublished"},"createdOn":{"type":"integer","description":"Epoch/Unix time stamp when the virtualized API was created.","format":"int64","readOnly":true,"example":1364287486876},"createdBy":{"type":"string","description":"The unique identifier for user that created the virtualized API.","readOnly":true,"example":"de077cd8-83b7-46d1-b06f-2eaaf1548898"},"corsProfiles":{"type":"array","description":"The suite of CORS Profiles for this virtualized API.","items":{"$ref":"#/components/schemas/CORSProfile"}},"securityProfiles":{"type":"array","description":"The suite of Security Profiles for this virtualized API.","items":{"$ref":"#/components/schemas/SecurityProfile"}},"authenticationProfiles":{"type":"array","description":"The suite of Authentication Profiles for this virtualized API.","items":{"$ref":"#/components/schemas/AuthenticationProfile"}},"inboundProfiles":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/InboundProfiles"},"description":"The inbound profiles that apply to the virtualized API. There must always a *\\_default* profile."},"outboundProfiles":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/OutboundProfiles"},"description":"The outbound profiles that apply to the virtualized API. There must always a *\\_default* profile."},"serviceProfiles":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/ServiceProfiles"},"description":"The service profiles that apply to the virtualized API. There must always a *\\_default* profile."},"caCerts":{"type":"array","description":"The outbound profiles that apply to the virtualized API. There must always a *\\_default* profile.","items":{"$ref":"#/components/schemas/CACert"}},"tags":{"type":"object","additionalProperties":{"type":"array","description":"The list of tags associated with this API. Each tag can have multiple values","example":{"Category":["Social Network, Photos"],"Type":["REST"]},"items":{"type":"string","description":"The list of tags associated with this API. Each tag can have multiple values","example":"{\"Category\":[\"Social Network, Photos\"],\"Type\":[\"REST\"]}"}},"description":"The list of tags associated with this API. Each tag can have multiple values","example":{"Category":["Social Network, Photos"],"Type":["REST"]}},"customProperties":{"type":"object","additionalProperties":{"type":"string"},"writeOnly":true}},"description":"A VirtualizedAPI is the frontend exposure of a backend [APIDefinition](APIDefinition.html). The documentation for the original API can be overridden using __descriptionType__. When the documentation is overridden, the API Catalog will reflect the changes, allowing the API's documentation to be maintained even after the API is published. When the __descriptionType__ is *original*, the documentation is obtained from the API from the original API definition. When __descriptionType__ is *manual*, the text is obtained from **descriptionManual** and can use markdown syntax. When __descriptionType__ is *url*, the **descriptionUrl** should point to an externally resolvable resource."},"APIDefinition":{"type":"object","properties":{"id":{"type":"string","description":"A unique identifier.","example":"6d81f576-bf40-4fbd-8625-63d8f206f649"},"name":{"type":"string","description":"The name of the API.","example":"My API"},"summary":{"type":"string","description":"A summary of the API.","example":"This is a summary of my API"},"description":{"type":"string","description":"A detailed description of the API.","example":"This is my API"},"version":{"type":"string","description":"The API version.","example":"1.0"},"basePath":{"type":"string","description":"The base path is where the API service is hosted.","example":"http://basepath.org"},"resourcePath":{"type":"string","description":"The resource path is applied to **basePath** to provide the prefix for all API methods.","example":"/api"},"models":{"type":"object","additionalProperties":{"type":"object","description":"The models/schema the that the API","example":{"User":{"type":"object","required":["id","name","email"],"properties":{"id":{"type":"string"},"name":{"type":"string"},"email":{"type":"string"}}}}},"description":"The models/schema the that the API","example":{"User":{"type":"object","required":["id","name","email"],"properties":{"id":{"type":"string"},"name":{"type":"string"},"email":{"type":"string"}}}}},"consumes":{"type":"array","description":"The content types that the API consumes","example":["application/json"],"items":{"type":"string","description":"The content types that the API consumes","example":"[\"application/json\"]"}},"produces":{"type":"array","description":"The content types that the API produces","example":["application/json"],"items":{"type":"string","description":"The content types that the API produces","example":"[\"application/json\"]"}},"integral":{"type":"boolean","description":"Indicates that the API definition is integral to a frontend API; that the API was imported to define the frontend API.","example":true},"createdOn":{"type":"integer","description":"Epoch/Unix time stamp when the organization was created.","format":"int64","example":1364287486876},"createdBy":{"type":"string","description":"The identifier of the user that created the API.","example":"a1c70859-702b-4f3a-a1ad-a61067fdc4c7"},"organizationId":{"type":"string","description":"The [Organization](Organization.html) identifier.","example":"7d82323230-4fbd-8625-63d8f206f649"},"serviceType":{"type":"string","description":"Indicates the type of service being imported. Possible values: rest, wsdl.","example":"wsdl","default":"rest"},"hasOriginalDefinition":{"type":"boolean","description":"Indicates whether or not an original definition is available","example":true,"default":true},"importUrl":{"type":"string","description":"Specifies the URL used to import the backend API definition.","example":"http://petstore.swagger.io/v1/swagger.json"},"properties":{"type":"object","additionalProperties":{"type":"string","description":"A list of properties associated with this API.","example":"{\"ServiceName\":\"Calculator\",\"Type\":\"WSDL\"}"},"description":"A list of properties associated with this API.","example":{"ServiceName":"Calculator","Type":"WSDL"}}},"description":"The API definition is a representation of a backend serivce. The **name** and **basePath** are required. If the API administrator creates the API definition, then **organizationId** is also required, otherwise it defaults to the [Organization](Organization.html) from which it is created."},"APIPromotion":{"type":"object","properties":{"frontend":{"$ref":"#/components/schemas/FrontendExport"},"backend":{"$ref":"#/components/schemas/BackendExport"},"exportVersion":{"type":"integer","description":"Export version","format":"int32"}},"description":"API promotion package."},"Agnostic":{"type":"object","properties":{"api":{"$ref":"#/components/schemas/APIDefinition"},"methods":{"type":"array","description":"List of agnostic method representation","items":{"$ref":"#/components/schemas/Method"}}},"description":"Backend API agnostic representation"},"BackendBlob":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier","example":"588c51d8-5b6f-4c2f-b0e8-3eeaf25d1458"},"type":{"type":"string","description":"Type of blob","example":"swagger11"},"blob":{"type":"string","description":"Base64 encoded API","example":"YmxvYg=="},"name":{"type":"string","description":"API name","example":"My API"},"importURL":{"type":"string","description":"Original URL","example":"My API"},"agnostic":{"$ref":"#/components/schemas/Agnostic"}},"description":"Backend blob export definition."},"BackendExport":{"type":"object","properties":{"apiBlobs":{"type":"array","description":"List of backend API blobs","items":{"$ref":"#/components/schemas/BackendBlob"}}},"description":"Backend API export definition."},"BackendMethodExport":{"type":"object","properties":{"apiId":{"type":"string","description":"Internal use only.","example":"0a275f85-aec2-4100-8f9e-b4e7abdca108"},"apiMethodId":{"type":"string","description":"Internal use only.","example":"19ec174e-b217-4c60-aa40-c22040569363"},"op":{"type":"string","description":"Internal use only.","example":"MyAPI-1.0:GET:/things"}},"description":"Backend API method export."},"FrontendExport":{"type":"object","properties":{"apis":{"type":"array","description":"List of frontend API","items":{"$ref":"#/components/schemas/VirtualizedAPI"}},"methods":{"type":"array","description":"List of frontend API methods","items":{"$ref":"#/components/schemas/VirtualizedMethodExport"}},"backendMethods":{"type":"array","description":"List of backend API methods","items":{"$ref":"#/components/schemas/BackendMethodExport"}},"imagedata":{"type":"object","additionalProperties":{"type":"string","description":"Image Export","example":"{}"},"description":"Image Export","example":{}}},"description":"Frontend API export definition."},"Method":{"type":"object","properties":{"id":{"type":"string","description":"The method identifier","example":"014d138b-816c-42b8-8a2a-5b63e72ea46d"},"apiId":{"type":"string","description":"The API identifier to which this method belongs","example":"6d81f576-bf40-4fbd-8625-63d8f206f649"},"path":{"type":"string","description":"The API path","example":"/users"},"verb":{"type":"string","description":"The HTTP verb","example":"GET"},"name":{"type":"string","description":"The name of the operation","example":"getUserById"},"summary":{"type":"string","description":"A short summary description of the operation","example":"Gets a user by ID"},"description":{"type":"string","description":"A detailed description of the operation","example":"If the user does not exist, then a *404 Not Found* error is returned"},"returnType":{"type":"string","description":"The return type of the method, e.g. void, array, or a type found in models","example":"User"},"parameters":{"type":"array","description":"A list of accepted parameters","items":{"$ref":"#/components/schemas/Parameter"}},"responseCodes":{"type":"array","description":"A list of possible response messages and their meanings","items":{"$ref":"#/components/schemas/ResponseCode"}},"consumes":{"type":"array","description":"The content types that the operation consumes","example":"application/json","items":{"type":"string","description":"The content types that the operation consumes","example":"application/json"}},"produces":{"type":"array","description":"The content types that the operation produces","example":"application/json","items":{"type":"string","description":"The content types that the operation produces","example":"application/json"}},"properties":{"type":"object","additionalProperties":{"type":"string","description":"A list of properties associated with this API Method. The list of properties may vary, depending on the type of the parent API.","example":"{\"soapOperation\":\"calculator\",\"soapNamespace\":\"\"}"},"description":"A list of properties associated with this API Method. The list of properties may vary, depending on the type of the parent API.","example":{"soapOperation":"calculator","soapNamespace":""}},"blob":{"type":"string"},"responseMessages":{"type":"array","writeOnly":true,"items":{"$ref":"#/components/schemas/ResponseCode"}}},"description":"The method is an API resource and a HTTP verb. The *method*, *nickname*, *summary*, and *type* are required."},"Parameter":{"type":"object","properties":{"name":{"type":"string","description":"The parameter name.","example":"userId"},"type":{"type":"string","description":"The parameter data type, e.g. *boolean*, *byte*, *date*, *double*, *float*, *integer*, *long*, *string*, or a type name found in [APIDefinition models](APIDefinition.html#models).","example":"string"},"format":{"type":"string","example":"string"},"description":{"type":"string"},"required":{"type":"boolean","description":"Indicates that the parameter is required","example":true},"allowMultiple":{"type":"boolean","description":"Indicates that the parameter can be included multiple times (e.g. query or form)","example":false,"default":false},"items":{"$ref":"#/components/schemas/SchemaObject"},"defaultValue":{"type":"object","description":"Provides a default value for the parameter","example":"text"},"maxLength":{"type":"integer","description":"Indicates the maximum length of a parameter of type 'string'","format":"int32","example":100},"minLength":{"type":"integer","description":"Indicates the minimum length of a parameter of type 'string'. If not present, assumed default value is 0.","format":"int32","example":3},"pattern":{"type":"string","description":"Specifies a valid regular expression against which a parameter of type 'string' is validated.","example":"^[a-z]$"},"exclusiveMinimum":{"type":"boolean","description":"If true, specifies that the value of the number parameter must be greater than the specified minimum value, otherwise the value must be great than, or equal to, the specified minimum value.","example":true},"exclusiveMaximum":{"type":"boolean","description":"If true, specifies that the value of the number parameter must be less than the specified maximum value, otherwise the value must be less than, or equal to, the specified maximum value.","example":false},"minimum":{"type":"object","description":"Specifies the minimum possible value of the number parameter.","example":1},"maximum":{"type":"object","description":"Specifies the maximum possible value of the number parameter.","example":100},"multipleOf":{"type":"number","description":"Specifies that the value of the number parameter must be divisible by this value. Must be an integer value > 0","example":10},"maxItems":{"type":"integer","description":"Specifies the maximum number of items permitted for array parameters. Must be an integer value greater than, or equal to 0","format":"int32","example":3},"minItems":{"type":"integer","description":"Specifies the minimum number of items permitted for array parameters. Must be an integer value greater than, or equal to 0","format":"int32","example":0},"uniqueItems":{"type":"boolean","description":"Specifies whether or not all array items should be unique.","example":true},"collectionFormat":{"type":"string","description":"Specifies the format of array parameters. Possible values: [ csv, ssv, tsv, pipes, multi ].","example":"multi"},"schema":{"$ref":"#/components/schemas/SchemaObject"},"allowEmptyValue":{"type":"boolean","description":"Specifies whether or not an empty value is allowed for this parameter. Only relevant for query and form parameters.","example":false},"deprecated":{"type":"boolean","description":"Specifies whether or not an empty value is deprecated for this parameter. It should be transitioned out of usage.","example":false},"style":{"type":"string","description":"Describes how the parameter value will be serialized depending on the type of the parameter value.","example":"form"},"explode":{"type":"boolean","description":"Specifies whether or not a separated parameter is generated. Only relevant for array or object types of parameters.","example":false},"allowReserved":{"type":"boolean","description":"Specifies whether or not the parameter value allows reserved characters","example":false},"mediaType":{"type":"string","description":"Specifies the media type of the parameter. Used specificially to cater for advanced OAS3 parameter definitions","example":"application/json"},"enum":{"type":"array","items":{"type":"object"}},"paramType":{"type":"string","description":"The parameter type, e.g. query, form, path, body, header","example":"body"}},"description":"Parameters describe the inputs for the API operation. The **name**, **paramType**, **required**, and **type** are all required fields."},"ResponseCode":{"type":"object","properties":{"code":{"type":"integer","description":"The response code","format":"int64","example":404},"message":{"type":"string","description":"The response message","example":"Not Found"},"schema":{"$ref":"#/components/schemas/SchemaObject"},"headers":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/SchemaObject"},"description":"The response headers"},"content":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/SchemaObject"},"description":"The response content"}},"description":"The response codes are the HTTP response codes defined in RFC-2616. Typically, a limited set are used for REST."},"VirtualizedMethodExport":{"type":"object","properties":{"id":{"type":"string","description":"Unique ID of the method.","example":"f2a0d13a-51f3-4256-855e-2b1d838a5cd2"},"virtualizedApiId":{"type":"string","description":"The identifier of the [VirtualizedAPI](VirtualizedAPI.html).","example":"bacb827e-e555-43fa-b006-50c7404aa990"},"name":{"type":"string","description":"The virtualized method name. This defaults to the original [APIDefinition](APIDefinition.html) method name.","example":"MyMethod"},"apiId":{"type":"string","description":"The reference identifier for the original [APIDefinition](APIDefinition.html) that was virtualized.","example":"ec5e0a01-832b-4ecb-8cae-b35630527bb4"},"apiMethodId":{"type":"string","description":"The reference identifier for the original API [APIDefinition](APIDefinition.html) method that was virtualized.","example":"21490aa6-ed14-4059-b8b7-d5bf0dc22dc6"},"summary":{"type":"string","description":"A summary of the API Method.","example":"This is a summary of my API Method"},"descriptionType":{"type":"string","description":"The source for the method's description. One of: *original*, *manual*, *markdown*, or *url*. Defaults to *original*.","example":"original"},"descriptionManual":{"type":"string","description":"Specifies a manual description, which can be markdown text.","example":"This is _my_ API method"},"descriptionMarkdown":{"type":"string","description":"specifies a markdown file to use for description.","example":"${environment.VINSTDIR}/../markdown/myapi/method.md"},"descriptionUrl":{"type":"string","description":"Specifies a URL to use instead of description text.","example":"https://myapi.org/docs/api#method"},"tags":{"type":"object","additionalProperties":{"type":"array","description":"The list of tags associated with this API method. Each tag can have multiple values.","example":{"Category":["Social Network, Photos"],"Type":["REST"]},"items":{"type":"string","description":"The list of tags associated with this API method. Each tag can have multiple values.","example":"{\"Category\":[\"Social Network, Photos\"],\"Type\":[\"REST\"]}"}},"description":"The list of tags associated with this API method. Each tag can have multiple values.","example":{"Category":["Social Network, Photos"],"Type":["REST"]}},"op":{"type":"string","description":"Internal use only.","example":"MyAPI-1.0:GET:/things"}},"description":"Frontend API method export."},"VirtualizedAPIMethod":{"type":"object","properties":{"id":{"type":"string","description":"Unique ID of the method.","example":"f2a0d13a-51f3-4256-855e-2b1d838a5cd2"},"virtualizedApiId":{"type":"string","description":"The identifier of the [VirtualizedAPI](VirtualizedAPI.html).","example":"bacb827e-e555-43fa-b006-50c7404aa990"},"name":{"type":"string","description":"The virtualized method name. This defaults to the original [APIDefinition](APIDefinition.html) method name.","example":"MyMethod"},"apiId":{"type":"string","description":"The reference identifier for the original [APIDefinition](APIDefinition.html) that was virtualized.","example":"ec5e0a01-832b-4ecb-8cae-b35630527bb4"},"apiMethodId":{"type":"string","description":"The reference identifier for the original API [APIDefinition](APIDefinition.html) method that was virtualized.","example":"21490aa6-ed14-4059-b8b7-d5bf0dc22dc6"},"summary":{"type":"string","description":"A summary of the API Method.","example":"This is a summary of my API Method"},"descriptionType":{"type":"string","description":"The source for the method's description. One of: *original*, *manual*, *markdown*, or *url*. Defaults to *original*.","example":"original"},"descriptionManual":{"type":"string","description":"Specifies a manual description, which can be markdown text.","example":"This is _my_ API method"},"descriptionMarkdown":{"type":"string","description":"specifies a markdown file to use for description.","example":"${environment.VINSTDIR}/../markdown/myapi/method.md"},"descriptionUrl":{"type":"string","description":"Specifies a URL to use instead of description text.","example":"https://myapi.org/docs/api#method"},"tags":{"type":"object","additionalProperties":{"type":"array","description":"The list of tags associated with this API method. Each tag can have multiple values.","example":{"Category":["Social Network, Photos"],"Type":["REST"]},"items":{"type":"string","description":"The list of tags associated with this API method. Each tag can have multiple values.","example":"{\"Category\":[\"Social Network, Photos\"],\"Type\":[\"REST\"]}"}},"description":"The list of tags associated with this API method. Each tag can have multiple values.","example":{"Category":["Social Network, Photos"],"Type":["REST"]}}},"description":"Referenced entity."},"DiscoveryAPI":{"type":"object","properties":{"name":{"type":"string","description":"The name of the API","example":"Flickr API"},"summary":{"type":"string","description":"Summary of the API","example":"The Flickr photo-sharing API"},"id":{"type":"string","description":"The unique identifier for the API","example":"925129c4-0c4b-4adb-95c4-fdbc741eb333"},"uri":{"type":"string","description":"The URL of where further information of the API is available in the portal","example":"https://localhost:8075/api/portal/v1.0/discovery/swagger/api/Flickr"},"type":{"type":"string","description":"The type of API, either rest or wsdl","example":"rest"}},"description":"Information about virtualized REST API."},"OAuthProtectedResource":{"type":"object","properties":{"uriprefix":{"type":"string","description":"Oauth protected path","example":"/api/oauth/protected"},"scopes":{"uniqueItems":true,"type":"array","description":"List of scopes associated with the OAuth protected path","example":["resource.WRITE","resource.READ"],"items":{"type":"string","description":"List of scopes associated with the OAuth protected path","example":"[\"resource.WRITE\",\"resource.READ\"]"}},"scope":{"type":"string","description":"Oauth Scope","example":"Read"},"description":{"type":"string","description":"Scope Description","example":"Read access to resource"}},"description":"Scope and prefix information for OAuth protected resource."},"Connector":{"type":"object","additionalProperties":{"type":"string"}},"CustomPropertiesConfig":{"type":"object","properties":{"user":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/CustomProperty"},"description":"Dictionary containing the custom properties defined for API Manager User entities"},"organization":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/CustomProperty"},"description":"Dictionary containing the custom properties defined for API Manager Organization entities"},"application":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/CustomProperty"},"description":"Dictionary containing the custom properties defined for API Manager Application entities"},"api":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/CustomProperty"},"description":"Dictionary containing the custom properties defined for API Manager Frontend API entities"}},"description":"Custom property metadata configuration. This data represents the customPropertiesConfig object as defined in the API Manager app.config file."},"CustomProperty":{"type":"object","properties":{"label":{"type":"string","description":"The label for the custom property, which will be displayed in the API Manager UI","example":"My first custom property"},"type":{"type":"string","description":"The type of the custom property. Can be one of the following values: ['custom', 'switch', 'select', 'number']. Default value is 'custom' (i.e. free-form text)","example":"custom","default":"custom"},"disabled":{"type":"boolean","description":"Specifies whether the custom property is disabled. Default value is false","example":false,"default":false},"required":{"type":"boolean","description":"Specifies whether the custom property is required or optional. Default value is false","example":false,"default":false},"help":{"type":"string","description":"Specifies the help text for the custom property that will appear in the API Manager UI. This field is optional","example":"This is the help text for my first custom property"},"permissions":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/CustomPropertyPermission"},"description":"Specifies the read/write permissions per role (admin, oadmin and user) for the custom property. This field is optional. By default all roles have read/write access"},"options":{"type":"array","description":"Specifies the options for 'switch' and 'select' custom properties which will be available in the API Manager UI. This field is conditional and only required for custom properties of type 'switch' or 'select', otherwise it is ignored.","items":{"$ref":"#/components/schemas/CustomPropertyOption"}},"defaultValue":{"type":"object","description":"Specifies the default value for the custom property. This field is optional, but recommended. This type of this field depends on the type of the custom property. It can be one of the following: string, integer, double, boolean","example":"Hello World!"},"regex":{"type":"string","description":"Specifies a validation regular expression for custom properties of type 'custom'. This field is conditional, i.e. optional for custom properties of type 'custom', otherwise ignored","example":"^\\d+$"},"minValue":{"type":"object","description":"Specifies a validation minimum value for custom properties of type 'number'. Can be an integer, a floating point number, or a string represation of an integer or floating point number. This field is conditional, i.e. optional for custom properties of type 'number', otherwise ignored. minValue and maxValue must both be of the same type so as to avoid unexpected behaviour during validation. Scientific notation is not supported.","example":0},"maxValue":{"type":"object","description":"Specifies a validation maximum value for custom properties of type 'number'. Can be an integer, a floating point number, or a string represation of an integer or floating point number. This field is conditional, i.e. optional for custom properties of type 'number', otherwise ignored. minValue and maxValue must both be of the same type so as to avoid unexpected behaviour during validation. Scientific notation is not supported.","example":100},"decimalPlaces":{"type":"integer","description":"Specifies the number of decimal places to be used when validating 'number' fields. Default value is 0, which indicates that the value is a whole number.","format":"int32","example":2},"error":{"type":"string","description":"Specifies an error message which will appear when input validation fails. The format of this field is a string. This field is only valid for custom properties of type 'custom' and 'number', otherwise ignored","example":"Invalid input. Please enter a valid Version 4 UUID"},"custom":{"type":"object","description":"Optional field allowing for the definition of custom metadata for the custom property. This will be used by clients other than API Manager, but API Manager may populate this field with API Manager-specific values in the future. If present, must be a valid JSON 'object'.","example":"{ portalPermissions: { joomlaAdmin: { read: true, write: true }, joomlaUser: { read: true, write: false } } }"}},"description":"Custom property metadata."},"CustomPropertyOption":{"type":"object","properties":{"value":{"type":"object","description":"Specifies the value associated with a custom property option. The field can be of the following formats: string, integer, double, boolean","example":2},"label":{"type":"string","description":"Specifies the label (as displayed in the API Manager UI) associated with a custom property option.","example":"Two"}},"description":"Custom property option configuration for 'switch' and 'select' custom properties."},"CustomPropertyPermission":{"type":"object","properties":{"read":{"type":"boolean","description":"Value specifying the read permission on a custom property for the associated role. Default value is true","example":true,"default":true},"write":{"type":"boolean","description":"Value specifying the write permission on a custom property for the associated role. Default value is true","example":true,"default":true},"visible":{"type":"boolean","description":"Value specifying whether or not the custom property is visible in API Manager for the associated role. Default value is true","example":true,"default":true}},"description":"Custom property permission configuration specifying whether read/write/visible permissions are allowed on the custom property."},"ExternalApi":{"type":"object","additionalProperties":{"type":"object"}}},"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}}}}
/ applications / oauthclient / {clientId}
/ applications / {id} / apis / {apiAccessId} / approve
/ applications / {id} / approve
/ applications / {id} / apikeys
/ applications
/ applications / {id} / extclients
/ applications / {id} / oauth
/ applications / {id} / permissions
/ applications / {id} / oauthresource
/ applications / {id} / quota
/ applications / {id} / scope
/ applications / {id} / apikeys / {apikeyid}
/ applications / {id}
/ applications / {id} / extclients / {objectId}
/ applications / {id} / oauth / {clientId}
/ applications / {id} / permissions / {permId}
/ applications / {id} / oauthresource / {resourceId}
/ applications / {id} / scope / {scopeId}
/ applications / {id} / oauth / {clientid} / newsecret
/ applications / {id} / apis
/ applications / {id} / availablescopes
/ applications / {id} / image
/ applications / {id} / apis / {apiAccessId}
/ authorizations / {authzid}
/ authorizations / owner / {subjectid} / application / {appid}
/ authorizations
/ metrics / fields
/ metrics / reports / {type} / summary / {level}
/ metrics / reports / {type} / timeline / {level} / {metricType}
/ migrate / applications / export / create
/ migrate / applications / export / json
/ migrate / applications / export / download
/ migrate / applications / export
/ migrate / applications / import
/ organizations
/ organizations / {id} / tokens
/ organizations / {id} / apis / {apiAccessId}
/ organizations / {id}
/ organizations / {id} / tokens / {token}
/ organizations / {id} / apis
/ organizations / {id} / image
/ remotehosts
/ license
/ remotehosts / {id}
/ alerts
/ appinfo
/ certinfo
/ certinfoFromUrl
/ config
/ filedata
/ service-discovery / {instance} / {type}
/ oauthclientprofiles
/ policies
/ listeners
/ sysconfig
/ title
/ tokenstores
/ topology
/ proxies / {id}
/ proxies / {id} / operations / {operationId}
/ proxies / {id} / deprecate
/ proxies / export / {id}
/ proxies / export
/ proxies
/ proxies / {id} / operations
/ proxies / {id} / image
/ proxies / grantaccess
/ proxies / import
/ proxies / importFromUrl
/ proxies / promote
/ proxies / {id} / publish
/ proxies / {id} / undeprecate
/ proxies / {id} / unpublish
/ proxies / upgrade / {id}
/ quotas
/ quotas / {id}
/ apirepo
/ apirepo / importFromUrl
/ apirepo / {id} / methods
/ apirepo / {id}
/ apirepo / {id} / methods / {methodId}
/ apirepo / {id} / download
/ apirepo / import
/ apirepo / importFromExternal
/ apirepo / importFromGw
/ users / {id} / approve
/ users / {id} / changepassword
/ users
/ users / {id}
/ users / forgotpassword
/ users / {id} / image
/ users / register
/ users / resetpassword
/ users / {id} / resetpassword
/ users / validateuser
/ currentuser / changepassword
/ currentuser
/ discovery / apis
/ discovery / swagger / apis / {id} / image
/ discovery / swagger / apis / {id} / service-definition
/ discovery / oauthresources
/ discovery / scopes
/ discovery / swagger / api / id / {id}
/ discovery / swagger / apis
/ login
/ connectors
/ config / customproperties
/ connectors / {connectorId}
/ connectors / {connectorId} / login
/ proxies / {id} / applications
/ discovery / sdk / {id} / {platform}
No API Resources

(Product) (Docs)

---

{"class":["gateway"],"properties":{"name":"Azure API Management","provider":"Microsoft Azure","slug":"azure-api-management","rating":1,"license":"Proprietary","status":"Pending Review","researchDate":"2021-10","description":"Azure API Management is a service provided by Microsoft Azure. Its policies are fewer in number than some competitors, and yet it still suits many use cases. Integrations are managed via [Dapr](https://dapr.io/).\n","platformCapabilities":["Gateway","Threat Protection","Monitoring","Portal"],"gatewayCapabilities":["Mediation","Mocking","OpenAPI Integration","Traffic Management","Versioning"],"customCodeSupport":[],"upstreamProtocols":["HTTP/1.1","HTTP/2"],"downstreamProtocols":["HTTP/1.1","HTTP/2"],"policies":[{"category":"Security","capabilities":["IP Access Rules","JWT Validation","Mutual TLS","Basic Authentication","Managed Identity Authentication","CORS"]},{"category":"Traffic Management","capabilities":["Cache Lookup","Cache Storage","Cache Eviction","Rate Limiting","Quota"]},{"category":"Mediation","capabilities":["Request Transformation","Response Transformation","JSON to XML","XML to JSON","URL Rewriting","XSL Tranformations","JSON Validation"]},{"category":"Extension","capabilities":["JSONP","Dapr integration"]}],"deliveryModels":["SaaS","Hybrid"]},"links":[{"rel":["urn:gateway:product"],"title":"Product","href":"https://azure.microsoft.com/en-us/services/api-management/"},{"rel":["urn:gateway:docs"],"title":"Documentation","href":"https://docs.microsoft.com/en-us/azure/api-management/"},{"rel":["urn:gateway:logo"],"title":"Logo","href":"/images/gateways/azure-api-management.jpg"},{"rel":["urn:gateway:screenshot"],"title":"Screenshot","href":"https://kinlane-productions2.s3.amazonaws.com/api-gateways/azure-api-management.png"}]}

Azure API Management

Azure API Management is a service provided by Microsoft Azure. Its policies are fewer in number than some competitors, and yet it still suits many use cases. Integrations are managed via [Dapr](https://dapr.io/).

Platform Capabilities

These are the wider capabilities beyond the gateway they offer.

• Gateway
• Threat Protection
• Monitoring
• Portal

Gateway Capabilities

These are the capabilities the gateway supports.

• Mediation
• Mocking
• OpenAPI Integration
• Traffic Management
• Versioning

Upstream Protocols

The different protocols they support upstream.

• HTTP/1.1
• HTTP/2

Downtream Protocols

The different protocols they support downstream.

• HTTP/1.1
• HTTP/2

Custom Code

If they offer plugin, extension, and custom coding options.

Delivery Models

These are they ways you can deliver this solution.

• SaaS
• Hybrid

Policies

These are the policies available across the gateway capabilities.

Security

• IP Access Rules
• JWT Validation
• Mutual TLS
• Basic Authentication
• Managed Identity Authentication
• CORS

Traffic Management

• Cache Lookup
• Cache Storage
• Cache Eviction
• Rate Limiting
• Quota

Mediation

• Request Transformation
• Response Transformation
• JSON to XML
• XML to JSON
• URL Rewriting
• XSL Tranformations
• JSON Validation

Extension

• JSONP
• Dapr integration

API Resources

Azure API Management - Portal Settings OpenAPI	{"openapi":"3.0.0","info":{"title":"Azure API Management - Portal Settings","description":"Use these REST APIs for performing operations on PortalSettings entity associated with your Azure API Management deployment. Using this entity you can manage settings for a Developer Portal.","version":"2017-03-01"},"security":[{"apim_key":[]}],"paths":{"/portalsettings/signin":{"get":{"tags":["SignInSettings"],"operationId":"SignInSettings_Get","description":"Get Sign-In settings.","parameters":[{"$ref":"./apimanagement.json#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"Sign-In settings.","headers":{"ETag":{"description":"Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PortalSigninSettings"}}}}}},"patch":{"tags":["SignInSettings"],"operationId":"SignInSettings_Update","description":"Update Sign-In settings.","parameters":[{"name":"If-Match","in":"header","required":true,"description":"The entity state (Etag) version of the property to update. A value of \"*\" can be used for If-Match to unconditionally apply the operation.","schema":{"type":"string"}},{"$ref":"./apimanagement.json#/components/parameters/ApiVersionParameter"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PortalSigninSettings"}}},"description":"Update Sign-In settings.","required":true},"responses":{"204":{"description":"Sign-In settings was updated successfully."},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"./apimanagement.json#/definitions/ErrorResponse"}}}}}},"put":{"tags":["SignInSettings"],"operationId":"SignInSettings_CreateOrUpdate","description":"Create or Update Sign-In settings.","parameters":[{"$ref":"./apimanagement.json#/components/parameters/ApiVersionParameter"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PortalSigninSettings"}}},"description":"Create or update parameters.","required":true},"responses":{"204":{"description":"Sign-In settings was successfully updated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PortalSigninSettings"}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"./apimanagement.json#/definitions/ErrorResponse"}}}}}}},"/portalsettings/signup":{"get":{"tags":["SignUpSettings"],"operationId":"SignUpSettings_Get","description":"Get Sign-Up settings.","parameters":[{"$ref":"./apimanagement.json#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"Sign-Up settings.","headers":{"ETag":{"description":"Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PortalSignupSettings"}}}}}},"patch":{"tags":["SignUpSettings"],"operationId":"SignUpSettings_Update","description":"Update Sign-Up settings.","parameters":[{"name":"If-Match","in":"header","required":true,"description":"The entity state (Etag) version of the property to update. A value of \"*\" can be used for If-Match to unconditionally apply the operation.","schema":{"type":"string"}},{"$ref":"./apimanagement.json#/components/parameters/ApiVersionParameter"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PortalSignupSettings"}}},"description":"Update Sign-Up settings.","required":true},"responses":{"204":{"description":"Sign-Up settings was updated successfully."},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"./apimanagement.json#/definitions/ErrorResponse"}}}}}},"put":{"tags":["SignUpSettings"],"operationId":"SignUpSettings_CreateOrUpdate","description":"Create or Update Sign-Up settings.","parameters":[{"$ref":"./apimanagement.json#/components/parameters/ApiVersionParameter"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PortalSignupSettings"}}},"description":"Create or update parameters.","required":true},"responses":{"204":{"description":"Sign-Up settings was successfully updated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PortalSignupSettings"}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"./apimanagement.json#/definitions/ErrorResponse"}}}}}}},"/portalsettings/delegation":{"get":{"tags":["DelegationSettings"],"operationId":"DelegationSettings_Get","description":"Get Delegation settings.","parameters":[{"$ref":"./apimanagement.json#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"Delegation settings.","headers":{"ETag":{"description":"Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PortalDelegationSettings"}}}}}},"patch":{"tags":["DelegationSettings"],"operationId":"DelegationSettings_Update","description":"Update Delegation settings.","parameters":[{"name":"If-Match","in":"header","required":true,"description":"The entity state (Etag) version of the property to update. A value of \"*\" can be used for If-Match to unconditionally apply the operation.","schema":{"type":"string"}},{"$ref":"./apimanagement.json#/components/parameters/ApiVersionParameter"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PortalDelegationSettings"}}},"description":"Update Delegation settings.","required":true},"responses":{"204":{"description":"Delegation settings was updated successfully."},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"./apimanagement.json#/definitions/ErrorResponse"}}}}}},"put":{"tags":["DelegationSettings"],"operationId":"DelegationSettings_CreateOrUpdate","description":"Create or Update Delegation settings.","parameters":[{"$ref":"./apimanagement.json#/components/parameters/ApiVersionParameter"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PortalDelegationSettings"}}},"description":"Create or update parameters.","required":true},"responses":{"204":{"description":"Delegation settings was successfully updated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PortalDelegationSettings"}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"./apimanagement.json#/definitions/ErrorResponse"}}}}}}}},"servers":[{"url":"{apimBaseUrl}","variables":{"apimBaseUrl":{"description":"The management endpoint of the API Management service, for example https://myapimservice.management.azure-api.net.","x-ms-skip-url-encoding":true,"default":""}}}],"components":{"securitySchemes":{"apim_key":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"PortalSigninSettings":{"properties":{"enabled":{"type":"boolean","description":"Redirect Anonymous users to the Sign-In page."}},"description":"Sign-In settings for the Developer Portal."},"PortalSignupSettings":{"properties":{"enabled":{"type":"boolean","description":"Allow users to sign up on a developer portal."},"termsOfService":{"$ref":"#/components/schemas/TermsOfServiceProperties"}},"description":"Sign-up settings contract properties."},"TermsOfServiceProperties":{"properties":{"text":{"type":"string","description":"A terms of service text."},"enabled":{"type":"boolean","description":"Display terms of service during a sign-up process."},"consentRequired":{"type":"boolean","description":"Ask user for consent to the terms of service."}},"description":"Terms of service contract properties."},"PortalDelegationSettings":{"properties":{"url":{"type":"string","description":"A delegation Url."},"validationKey":{"type":"string","description":"A base64-encoded validation key to validate, that a request is coming from Azure API Management."},"subscriptions":{"$ref":"#/components/schemas/SubscriptionsDelegationSettingsProperties"},"userRegistration":{"$ref":"#/components/schemas/RegistrationDelegationSettingsProperties"}},"description":"Delegation settings for a developer portal."},"SubscriptionsDelegationSettingsProperties":{"properties":{"enabled":{"type":"boolean","description":"Enable or disable delegation for subscriptions."}},"description":"Subscriptions delegation settings properties."},"RegistrationDelegationSettingsProperties":{"properties":{"enabled":{"type":"boolean","description":"Enable or disable delegation for user registration."}},"description":"User registration delegation settings properties."}}}}
/ portalsettings / signin
/ portalsettings / signup
/ portalsettings / delegation
Azure API Management - Policies OpenAPI	{"openapi":"3.0.0","info":{"title":"Azure API Management - Policies","description":"Use these REST APIs for performing operations on entities like API, Product, and Subscription associated with your Azure API Management deployment.","version":"2017-03-01"},"security":[{"apim_key":[]}],"paths":{"/policies":{"get":{"tags":["Policy"],"operationId":"Policy_List","description":"Lists all the Global Policy definitions of the Api Management service.","parameters":[{"name":"scope","in":"query","required":false,"description":"Policy scope.","x-ms-enum":{"name":"PolicyScopeContract","modelAsString":false},"schema":{"type":"string","enum":["Tenant","Product","Api","Operation","All"]}},{"$ref":"#/components/parameters/ApiVersionParameter"}],"x-ms-pageable":{},"responses":{"200":{"description":"Returns an array of Policy Contracts.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PolicyCollection"}}}}}}},"/policies/{policyId}":{"get":{"tags":["Policy"],"operationId":"Policy_Get","description":"Get the Global policy definition of the Api Management service.","parameters":[{"$ref":"#/components/parameters/PolicyIdParameter"},{"$ref":"#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"Returns the Policy Contracts.","headers":{"ETag":{"description":"Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PolicyContract"}},"application/vnd.ms-azure-apim.policy+xml":{"schema":{"$ref":"#/components/schemas/PolicyContract"}},"application/vnd.ms-azure-apim.policy.raw+xml":{"schema":{"$ref":"#/components/schemas/PolicyContract"}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}},"application/vnd.ms-azure-apim.policy+xml":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}},"application/vnd.ms-azure-apim.policy.raw+xml":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"put":{"tags":["Policy"],"operationId":"Policy_CreateOrUpdate","description":"Creates or updates the global policy configuration of the Api Management service.","parameters":[{"$ref":"#/components/parameters/PolicyIdParameter"},{"$ref":"#/components/parameters/ApiVersionParameter"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PolicyContract"}},"application/vnd.ms-azure-apim.policy+xml":{"schema":{"$ref":"#/components/schemas/PolicyContract"}},"application/vnd.ms-azure-apim.policy.raw+xml":{"schema":{"$ref":"#/components/schemas/PolicyContract"}}},"description":"The policy contents to apply.","required":true},"responses":{"200":{"description":"Global policy configuration of the Api Management service was successfully updated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PolicyContract"}}}},"201":{"description":"Global policy configuration was successfully created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PolicyContract"}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"delete":{"tags":["Policy"],"operationId":"Policy_Delete","description":"Deletes the global policy configuration of the Api Management Service.","parameters":[{"$ref":"#/components/parameters/PolicyIdParameter"},{"name":"If-Match","in":"header","required":true,"description":"The entity state (Etag) version of the policy to be deleted. A value of \"*\" can be used for If-Match to unconditionally apply the operation.","schema":{"type":"string"}},{"$ref":"#/components/parameters/ApiVersionParameter"}],"responses":{"204":{"description":"Successfully deleted the policy configuration at the Global level."},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/policySnippets":{"get":{"tags":["PolicySnippets"],"operationId":"PolicySnippets_List","description":"Lists all policy snippets.","parameters":[{"name":"scope","in":"query","required":false,"description":"Policy scope.","x-ms-enum":{"name":"PolicyScopeContract","modelAsString":false},"schema":{"type":"string","enum":["Tenant","Product","Api","Operation","All"]}},{"$ref":"#/components/parameters/ApiVersionParameter"}],"x-ms-pageable":{},"responses":{"200":{"description":"Returns an array of Policy Contracts.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PolicySnippetsCollection"}}}}}}},"/regions":{"get":{"tags":["Regions"],"operationId":"Regions_List","description":"Lists all azure regions in which the service exists.","parameters":[{"$ref":"#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"Lists of Regions in which the service is deployed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RegionListResult"}}}}},"x-ms-pageable":{"nextLinkName":""}}}},"servers":[{"url":"{apimBaseUrl}","variables":{"apimBaseUrl":{"description":"The management endpoint of the API Management service, for example https://myapimservice.management.azure-api.net.","x-ms-skip-url-encoding":true,"default":""}}}],"components":{"parameters":{"ApiVersionParameter":{"name":"api-version","in":"query","required":true,"description":"Version of the API to be used with the client request.","schema":{"type":"string"}},"SkipQueryParameter":{"name":"$skip","in":"query","required":false,"description":"Number of records to skip.","x-ms-parameter-location":"method","schema":{"type":"integer","format":"int32","minimum":0}},"TopQueryParameter":{"name":"$top","in":"query","required":false,"description":"Number of records to return.","x-ms-parameter-location":"method","schema":{"type":"integer","format":"int32","minimum":1}},"PolicyIdParameter":{"name":"policyId","in":"path","required":true,"description":"The identifier of the Policy.","x-ms-enum":{"modelAsString":true,"name":"PolicyIdName"},"x-ms-parameter-location":"method","schema":{"type":"string","enum":["policy"]}}},"securitySchemes":{"apim_key":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"ErrorFieldContract":{"properties":{"code":{"type":"string","description":"Property level error code."},"message":{"type":"string","description":"Human-readable representation of property-level error."},"target":{"type":"string","description":"Property name."}},"description":"Error Field contract."},"ErrorResponse":{"properties":{"code":{"type":"string","description":"Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response."},"message":{"type":"string","description":"Human-readable representation of the error."},"details":{"type":"array","items":{"$ref":"#/components/schemas/ErrorFieldContract"},"description":"The list of invalid fields send in request, in case of validation error."}},"description":"Error Body contract."},"PolicyCollection":{"properties":{"value":{"type":"array","items":{"$ref":"#/components/schemas/PolicyContract"},"description":"Policy Contract value."},"count":{"type":"integer","description":"Total number of records"},"nextLink":{"type":"string","description":"Next page link if any."}},"description":"The response of the list policy operation."},"PolicyContract":{"properties":{"id":{"type":"string","description":"Policy identifier."},"policyContent":{"type":"string","description":"Json escaped Xml Encoded contents of the Policy."}},"required":["policyContent"],"description":"Policy contract Properties."},"PolicySnippetsCollection":{"properties":{"value":{"type":"array","items":{"$ref":"#/components/schemas/PolicySnippetContract"},"description":"Policy snippet value."}},"description":"The response of the list policy snippets operation."},"PolicySnippetContract":{"properties":{"name":{"type":"string","description":"Snippet name.","readOnly":true},"content":{"type":"string","description":"Snippet content.","readOnly":true},"toolTip":{"type":"string","description":"Snippet toolTip.","readOnly":true},"scope":{"type":"integer","description":"Binary OR value of the Snippet scope.","readOnly":true}},"description":"Policy snippet."},"RegionContract":{"properties":{"name":{"type":"string","description":"Region name.","readOnly":true},"isMasterRegion":{"description":"whether Region is the master region.","type":"boolean"},"isDeleted":{"description":"whether Region is deleted.","type":"boolean"}},"description":"Region profile."},"RegionListResult":{"properties":{"value":{"type":"array","items":{"$ref":"#/components/schemas/RegionContract"},"description":"Lists of Regions."},"count":{"type":"integer","format":"int64","description":"Total record count number across all pages."},"nextLink":{"type":"string","description":"Next page link if any."}},"description":"Lists Regions operation response details."}}}}
/ policies
/ policies / {policyId}
/ policySnippets
/ regions
Azure API Management - Tenant OpenAPI	{"openapi":"3.0.0","info":{"title":"Azure API Management - Tenant","description":"Use these REST APIs for performing operations on tenant entity associated with your Azure API Management deployment. Using this entity you can manage properties and configuration that apply to the entire API Management service instance.","version":"2017-03-01"},"security":[{"apim_key":[]}],"paths":{"/tenant/{accessName}":{"get":{"tags":["TenantAccess"],"operationId":"TenantAccess_Get","description":"Get tenant access information details.","parameters":[{"$ref":"./apimanagement.json#/components/parameters/ApiVersionParameter"},{"$ref":"#/components/parameters/AccessParameter"}],"responses":{"200":{"description":"Tenant Access information.","headers":{"ETag":{"description":"Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessInformationContract"}}}}}},"patch":{"tags":["TenantAccess"],"operationId":"TenantAccess_Update","description":"Update tenant access information details.","parameters":[{"$ref":"#/components/parameters/AccessParameter"},{"name":"If-Match","in":"header","required":true,"description":"The entity state (Etag) version of the property to update. A value of \"*\" can be used for If-Match to unconditionally apply the operation.","schema":{"type":"string"}},{"$ref":"./apimanagement.json#/components/parameters/ApiVersionParameter"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessInformationUpdateParameters"}}},"description":"Parameters supplied to retrieve the Tenant Access Information.","required":true},"responses":{"204":{"description":"Tenant's access information updated successfully."},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"./apimanagement.json#/definitions/ErrorResponse"}}}}}}},"/tenant/{accessName}/regeneratePrimaryKey":{"post":{"tags":["TenantAccess"],"operationId":"TenantAccess_RegeneratePrimaryKey","description":"Regenerate primary access key.","parameters":[{"$ref":"./apimanagement.json#/components/parameters/ApiVersionParameter"},{"$ref":"#/components/parameters/AccessParameter"}],"responses":{"204":{"description":"The primary key was successfully regenerated."},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"./apimanagement.json#/definitions/ErrorResponse"}}}}}}},"/tenant/{accessName}/regenerateSecondaryKey":{"post":{"tags":["TenantAccess"],"operationId":"TenantAccess_RegenerateSecondaryKey","description":"Regenerate secondary access key.","parameters":[{"$ref":"./apimanagement.json#/components/parameters/ApiVersionParameter"},{"$ref":"#/components/parameters/AccessParameter"}],"responses":{"204":{"description":"The secondary key was successfully regenerated."},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"./apimanagement.json#/definitions/ErrorResponse"}}}}}}},"/tenant/{accessName}/git":{"get":{"tags":["TenantAccessGit"],"operationId":"TenantAccessGit_Get","description":"Gets the Git access configuration for the tenant.","parameters":[{"$ref":"./apimanagement.json#/components/parameters/ApiVersionParameter"},{"$ref":"#/components/parameters/AccessParameter"}],"responses":{"200":{"description":"Git Access Information for the Service.","headers":{"ETag":{"description":"Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessInformationContract"}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"./apimanagement.json#/definitions/ErrorResponse"}}}}}}},"/tenant/{accessName}/git/regeneratePrimaryKey":{"post":{"tags":["TenantAccessGit"],"operationId":"TenantAccessGit_RegeneratePrimaryKey","description":"Regenerate primary access key for GIT.","parameters":[{"$ref":"./apimanagement.json#/components/parameters/ApiVersionParameter"},{"$ref":"#/components/parameters/AccessParameter"}],"responses":{"204":{"description":"The primary key was successfully regenerated."},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"./apimanagement.json#/definitions/ErrorResponse"}}}}}}},"/tenant/{accessName}/git/regenerateSecondaryKey":{"post":{"tags":["TenantAccessGit"],"operationId":"TenantAccessGit_RegenerateSecondaryKey","description":"Regenerate secondary access key for GIT.","parameters":[{"$ref":"./apimanagement.json#/components/parameters/ApiVersionParameter"},{"$ref":"#/components/parameters/AccessParameter"}],"responses":{"204":{"description":"The secondary key was successfully regenerated."},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"./apimanagement.json#/definitions/ErrorResponse"}}}}}}},"/tenant/{configurationName}/deploy":{"post":{"tags":["TenantConfiguration"],"operationId":"TenantConfiguration_Deploy","description":"This operation applies changes from the specified Git branch to the configuration database. This is a long running operation and could take several minutes to complete.","externalDocs":{"description":"To deploy any service configuration changes to the API Management service instance","url":"https://azure.microsoft.com/en-us/documentation/articles/api-management-configuration-repository-git/#to-deploy-any-service-configuration-changes-to-the-api-management-service-instance"},"x-ms-long-running-operation":true,"parameters":[{"$ref":"./apimanagement.json#/components/parameters/ApiVersionParameter"},{"$ref":"#/components/parameters/ConfigurationParameter"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeployConfigurationParameters"}}},"description":"Deploy Configuration parameters.","required":true},"responses":{"200":{"description":"Result of applying changes from Git branch to database.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationResultContract"}}}},"202":{"description":"Accepted: Location header contains the URL where the status of the long running operation can be checked."},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"./apimanagement.json#/definitions/ErrorResponse"}}}}}}},"/tenant/{configurationName}/save":{"post":{"tags":["TenantConfiguration"],"operationId":"TenantConfiguration_Save","description":"This operation creates a commit with the current configuration snapshot to the specified branch in the repository. This is a long running operation and could take several minutes to complete.","externalDocs":{"description":"To save the service configuration to the Git repository","url":"https://azure.microsoft.com/en-us/documentation/articles/api-management-configuration-repository-git/#to-save-the-service-configuration-to-the-git-repository"},"x-ms-long-running-operation":true,"parameters":[{"$ref":"./apimanagement.json#/components/parameters/ApiVersionParameter"},{"$ref":"#/components/parameters/ConfigurationParameter"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SaveConfigurationParameter"}}},"description":"Save Configuration parameters.","required":true},"responses":{"200":{"description":"Result of creating a commit in the repository.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationResultContract"}}}},"202":{"description":"Accepted: Location header contains the URL where the status of the long running operation can be checked."},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"./apimanagement.json#/definitions/ErrorResponse"}}}}}}},"/tenant/{configurationName}/validate":{"post":{"tags":["TenantConfiguration"],"operationId":"TenantConfiguration_Validate","description":"This operation validates the changes in the specified Git branch. This is a long running operation and could take several minutes to complete.","x-ms-long-running-operation":true,"parameters":[{"$ref":"./apimanagement.json#/components/parameters/ApiVersionParameter"},{"$ref":"#/components/parameters/ConfigurationParameter"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeployConfigurationParameters"}}},"description":"Validate Configuration parameters.","required":true},"responses":{"200":{"description":"Result of validating the changes in the specified Git branch.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationResultContract"}}}},"202":{"description":"Accepted: Location header contains the URL where the status of the long running operation can be checked."},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"./apimanagement.json#/definitions/ErrorResponse"}}}}}}},"/tenant/{configurationName}/syncState":{"get":{"tags":["TenantConfigurationSyncState"],"operationId":"TenantConfiguration_GetSyncState","description":"Gets the status of the most recent synchronization between the configuration database and the Git repository.","parameters":[{"$ref":"./apimanagement.json#/components/parameters/ApiVersionParameter"},{"$ref":"#/components/parameters/ConfigurationParameter"}],"responses":{"200":{"description":"Sync state result.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TenantConfigurationSyncStateContract"}}}}}}}},"servers":[{"url":"{apimBaseUrl}","variables":{"apimBaseUrl":{"description":"The management endpoint of the API Management service, for example https://myapimservice.management.azure-api.net.","x-ms-skip-url-encoding":true,"default":""}}}],"components":{"parameters":{"AccessParameter":{"name":"accessName","in":"path","required":true,"x-ms-enum":{"modelAsString":true,"name":"AccessIdName"},"description":"The identifier of the Access configuration.","x-ms-parameter-location":"method","schema":{"type":"string","enum":["access"]}},"ConfigurationParameter":{"name":"configurationName","in":"path","required":true,"x-ms-enum":{"modelAsString":true,"name":"configurationIdName"},"description":"The identifier of the Git Configuration Operation.","x-ms-parameter-location":"method","schema":{"type":"string","enum":["configuration"]}}},"securitySchemes":{"apim_key":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"AccessInformationContract":{"properties":{"id":{"type":"string","description":"Identifier."},"primaryKey":{"type":"string","description":"Primary access key."},"secondaryKey":{"type":"string","description":"Secondary access key."},"enabled":{"type":"boolean","description":"Tenant access information of the API Management service."}},"description":"Tenant access information contract of the API Management service."},"AccessInformationUpdateParameters":{"properties":{"enabled":{"type":"boolean","description":"Tenant access information of the API Management service."}},"description":"Tenant access information update parameters of the API Management service."},"DeployConfigurationParameters":{"properties":{"branch":{"type":"string","description":"The name of the Git branch from which the configuration is to be deployed to the configuration database."},"force":{"type":"boolean","description":"The value enforcing deleting subscriptions to products that are deleted in this update."}},"required":["branch"],"description":"Parameters supplied to the Deploy Configuration operation."},"OperationResultContract":{"properties":{"id":{"type":"string","description":"Operation result identifier."},"status":{"type":"string","description":"Status of an async operation.","enum":["Started","InProgress","Succeeded","Failed"],"x-ms-enum":{"name":"AsyncOperationStatus","modelAsString":false}},"started":{"type":"string","format":"date-time","description":"Start time of an async operation. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard.\n"},"updated":{"type":"string","format":"date-time","description":"Last update time of an async operation. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard.\n"},"resultInfo":{"type":"string","description":"Optional result info."},"error":{"$ref":"./apimanagement.json#/definitions/ErrorResponse"},"actionLog":{"type":"array","items":{"$ref":"#/components/schemas/OperationResultLogItemContract"},"readOnly":true,"description":"This property if only provided as part of the TenantConfiguration_Validate operation. It contains the log the entities which will be updated/created/deleted as part of the TenantConfiguration_Deploy operation."}},"description":"Operation Result."},"OperationResultLogItemContract":{"properties":{"objectType":{"type":"string","description":"The type of entity contract."},"action":{"type":"string","description":"Action like create/update/delete."},"objectKey":{"type":"string","description":"Identifier of the entity being created/updated/deleted."}},"description":"Log of the entity being created, updated or deleted."},"SaveConfigurationParameter":{"properties":{"branch":{"type":"string","description":"The name of the Git branch in which to commit the current configuration snapshot."},"force":{"type":"boolean","description":"The value if true, the current configuration database is committed to the Git repository, even if the Git repository has newer changes that would be overwritten."}},"required":["branch"],"description":"Parameters supplied to the Save Tenant Configuration operation."},"TenantConfigurationSyncStateContract":{"properties":{"branch":{"type":"string","description":"The name of Git branch."},"commitId":{"type":"string","description":"The latest commit Id."},"isExport":{"type":"boolean","description":"value indicating if last sync was save (true) or deploy (false) operation."},"isSynced":{"type":"boolean","description":"value indicating if last synchronization was later than the configuration change."},"isGitEnabled":{"type":"boolean","description":"value indicating whether Git configuration access is enabled."},"syncDate":{"type":"string","format":"date-time","description":"The date of the latest synchronization. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard.\n"},"configurationChangeDate":{"type":"string","format":"date-time","description":"The date of the latest configuration change. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard.\n"}},"description":"Tenant Configuration Synchronization State."}}}}
/ tenant / {accessName}
/ tenant / {accessName} / regeneratePrimaryKey
/ tenant / {accessName} / regenerateSecondaryKey
/ tenant / {accessName} / git
/ tenant / {accessName} / git / regeneratePrimaryKey
/ tenant / {accessName} / git / regenerateSecondaryKey
/ tenant / {configurationName} / deploy
/ tenant / {configurationName} / save
/ tenant / {configurationName} / validate
/ tenant / {configurationName} / syncState
Azure API Management - Reports OpenAPI	{"openapi":"3.0.0","info":{"title":"Azure API Management - Reports","description":"Use these REST APIs to get the analytics reports associated with your Azure API Management deployment.","version":"2017-03-01"},"security":[{"apim_key":[]}],"paths":{"/reports/byApi":{"get":{"tags":["Reports"],"operationId":"Reports_ListByApi","description":"Lists report records by API.","parameters":[{"name":"$filter","in":"query","required":true,"description":"The filter to apply on the operation.","schema":{"type":"string"}},{"$ref":"./apimanagement.json#/components/parameters/TopQueryParameter"},{"$ref":"./apimanagement.json#/components/parameters/SkipQueryParameter"},{"$ref":"./apimanagement.json#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"Lists a collection of Report record.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReportCollection"}}}}},"x-ms-pageable":{"nextLinkName":"nextLink"},"x-ms-odata":"#/components/schemas/ReportRecordContract"}},"/reports/byUser":{"get":{"tags":["Reports"],"operationId":"Reports_ListByUser","description":"Lists report records by User.","parameters":[{"name":"$filter","in":"query","required":true,"description":"The filter to apply on the operation.","schema":{"type":"string"}},{"$ref":"./apimanagement.json#/components/parameters/TopQueryParameter"},{"$ref":"./apimanagement.json#/components/parameters/SkipQueryParameter"},{"$ref":"./apimanagement.json#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"Lists a collection of Report record.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReportCollection"}}}}},"x-ms-pageable":{"nextLinkName":"nextLink"},"x-ms-odata":"#/components/schemas/ReportRecordContract"}},"/reports/byOperation":{"get":{"tags":["Reports"],"operationId":"Reports_ListByOperation","description":"Lists report records by API Operations.","parameters":[{"name":"$filter","in":"query","required":true,"description":"The filter to apply on the operation.","schema":{"type":"string"}},{"$ref":"./apimanagement.json#/components/parameters/TopQueryParameter"},{"$ref":"./apimanagement.json#/components/parameters/SkipQueryParameter"},{"$ref":"./apimanagement.json#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"Lists a collection of Report record.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReportCollection"}}}}},"x-ms-pageable":{"nextLinkName":"nextLink"},"x-ms-odata":"#/components/schemas/ReportRecordContract"}},"/reports/byProduct":{"get":{"tags":["Reports"],"operationId":"Reports_ListByProduct","description":"Lists report records by Product.","parameters":[{"name":"$filter","in":"query","required":true,"description":"The filter to apply on the operation.","schema":{"type":"string"}},{"$ref":"./apimanagement.json#/components/parameters/TopQueryParameter"},{"$ref":"./apimanagement.json#/components/parameters/SkipQueryParameter"},{"$ref":"./apimanagement.json#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"Lists a collection of Report record.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReportCollection"}}}}},"x-ms-pageable":{"nextLinkName":"nextLink"},"x-ms-odata":"#/components/schemas/ReportRecordContract"}},"/reports/byGeo":{"get":{"tags":["Reports"],"operationId":"Reports_ListByGeo","description":"Lists report records by geography.","parameters":[{"name":"$filter","in":"query","required":false,"description":"The filter to apply on the operation.","schema":{"type":"string"}},{"$ref":"./apimanagement.json#/components/parameters/TopQueryParameter"},{"$ref":"./apimanagement.json#/components/parameters/SkipQueryParameter"},{"$ref":"./apimanagement.json#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"Lists a collection of Report record.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReportCollection"}}}}},"x-ms-pageable":{"nextLinkName":"nextLink"},"x-ms-odata":"#/components/schemas/ReportRecordContract"}},"/reports/bySubscription":{"get":{"tags":["Reports"],"operationId":"Reports_ListBySubscription","description":"Lists report records by subscription.","parameters":[{"name":"$filter","in":"query","required":false,"description":"The filter to apply on the operation.","schema":{"type":"string"}},{"$ref":"./apimanagement.json#/components/parameters/TopQueryParameter"},{"$ref":"./apimanagement.json#/components/parameters/SkipQueryParameter"},{"$ref":"./apimanagement.json#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"Lists a collection of Report record.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReportCollection"}}}}},"x-ms-pageable":{"nextLinkName":"nextLink"},"x-ms-odata":"#/components/schemas/ReportRecordContract"}},"/reports/byTime":{"get":{"tags":["Reports"],"operationId":"Reports_ListByTime","description":"Lists report records by Time.","parameters":[{"name":"$filter","in":"query","required":false,"description":"The filter to apply on the operation.","schema":{"type":"string"}},{"$ref":"./apimanagement.json#/components/parameters/TopQueryParameter"},{"$ref":"./apimanagement.json#/components/parameters/SkipQueryParameter"},{"name":"interval","in":"query","required":true,"description":"By time interval. Interval must be multiple of 15 minutes and may not be zero. The value should be in ISO 8601 format (http://en.wikipedia.org/wiki/ISO_8601#Durations).This code can be used to convert TimeSpan to a valid interval string: XmlConvert.ToString(new TimeSpan(hours, minutes, seconds))","schema":{"type":"string","format":"duration"}},{"$ref":"./apimanagement.json#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"Lists a collection of Report record.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReportCollection"}}}}},"x-ms-pageable":{"nextLinkName":"nextLink"},"x-ms-odata":"#/components/schemas/ReportRecordContract"}},"/reports/byRequest":{"get":{"tags":["Reports"],"operationId":"Reports_ListByRequest","description":"Lists report records by Request.","parameters":[{"name":"$filter","in":"query","required":true,"description":"The filter to apply on the operation.","schema":{"type":"string"}},{"$ref":"./apimanagement.json#/components/parameters/TopQueryParameter"},{"$ref":"./apimanagement.json#/components/parameters/SkipQueryParameter"},{"$ref":"./apimanagement.json#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"Lists a collection of Report record.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RequestReportCollection"}}}}},"x-ms-pageable":{},"x-ms-odata":"#/components/schemas/RequestReportRecordContract"}}},"servers":[{"url":"{apimBaseUrl}","variables":{"apimBaseUrl":{"description":"The management endpoint of the API Management service, for example https://myapimservice.management.azure-api.net.","x-ms-skip-url-encoding":true,"default":""}}}],"components":{"securitySchemes":{"apim_key":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"ReportCollection":{"properties":{"value":{"type":"array","items":{"$ref":"#/components/schemas/ReportRecordContract"},"description":"Page values."},"count":{"type":"integer","format":"int64","description":"Total record count number across all pages."},"nextLink":{"type":"string","description":"Next page link if any."}},"description":"Paged Report records list representation."},"ReportRecordContract":{"properties":{"name":{"type":"string","description":"Name depending on report endpoint specifies product, API, operation or developer name."},"timestamp":{"type":"string","format":"date-time","description":"Start of aggregation period. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard.\n"},"interval":{"type":"string","description":"Length of aggregation period. Interval must be multiple of 15 minutes and may not be zero. The value should be in ISO 8601 format (http://en.wikipedia.org/wiki/ISO_8601#Durations)."},"country":{"type":"string","description":"Country to which this record data is related."},"region":{"type":"string","description":"Country region to which this record data is related."},"zip":{"type":"string","description":"Zip code to which this record data is related."},"userId":{"readOnly":true,"type":"string","description":"User identifier path. /users/{userId}"},"productId":{"readOnly":true,"type":"string","description":"Product identifier path. /products/{productId}"},"apiId":{"type":"string","description":"API identifier path. /apis/{apiId}"},"operationId":{"type":"string","description":"Operation identifier path. /apis/{apiId}/operations/{operationId}"},"apiRegion":{"type":"string","description":"API region identifier."},"subscriptionId":{"type":"string","description":"Subscription identifier path. /subscriptions/{subscriptionId}"},"callCountSuccess":{"type":"integer","format":"int32","description":"Number of successful calls. This includes calls returning HttpStatusCode <= 301 and HttpStatusCode.NotModified and HttpStatusCode.TemporaryRedirect"},"callCountBlocked":{"type":"integer","format":"int32","description":"Number of calls blocked due to invalid credentials. This includes calls returning HttpStatusCode.Unauthorized and HttpStatusCode.Forbidden and HttpStatusCode.TooManyRequests"},"callCountFailed":{"type":"integer","format":"int32","description":"Number of calls failed due to proxy or backend errors. This includes calls returning HttpStatusCode.BadRequest(400) and any Code between HttpStatusCode.InternalServerError (500) and 600"},"callCountOther":{"type":"integer","format":"int32","description":"Number of other calls."},"callCountTotal":{"type":"integer","format":"int32","description":"Total number of calls."},"bandwidth":{"type":"integer","format":"int64","description":"Bandwidth consumed."},"cacheHitCount":{"type":"integer","format":"int32","description":"Number of times when content was served from cache policy."},"cacheMissCount":{"type":"integer","format":"int32","description":"Number of times content was fetched from backend."},"apiTimeAvg":{"type":"number","format":"double","description":"Average time it took to process request."},"apiTimeMin":{"type":"number","format":"double","description":"Minimum time it took to process request."},"apiTimeMax":{"type":"number","format":"double","description":"Maximum time it took to process request."},"serviceTimeAvg":{"type":"number","format":"double","description":"Average time it took to process request on backend."},"serviceTimeMin":{"type":"number","format":"double","description":"Minimum time it took to process request on backend."},"serviceTimeMax":{"type":"number","format":"double","description":"Maximum time it took to process request on backend."}},"description":"Report data."},"RequestReportCollection":{"properties":{"value":{"type":"array","items":{"$ref":"#/components/schemas/RequestReportRecordContract"},"description":"Page values."},"count":{"type":"integer","format":"int64","description":"Total record count number across all pages."}},"description":"Paged Report records list representation."},"RequestReportRecordContract":{"properties":{"apiId":{"type":"string","description":"API identifier path. /apis/{apiId}"},"operationId":{"type":"string","description":"Operation identifier path. /apis/{apiId}/operations/{operationId}"},"productId":{"readOnly":true,"type":"string","description":"Product identifier path. /products/{productId}"},"userId":{"readOnly":true,"type":"string","description":"User identifier path. /users/{userId}"},"method":{"type":"string","description":"The HTTP method associated with this request.."},"url":{"type":"string","description":"The full URL associated with this request."},"ipAddress":{"type":"string","description":"The client IP address associated with this request."},"backendResponseCode":{"type":"string","description":"The HTTP status code received by the gateway as a result of forwarding this request to the backend."},"responseCode":{"type":"integer","format":"int32","description":"The HTTP status code returned by the gateway."},"responseSize":{"type":"integer","format":"int32","description":"The size of the response returned by the gateway."},"timestamp":{"type":"string","format":"date-time","description":"The date and time when this request was received by the gateway in ISO 8601 format."},"cache":{"type":"string","description":"Specifies if response cache was involved in generating the response. If the value is none, the cache was not used. If the value is hit, cached response was returned. If the value is miss, the cache was used but lookup resulted in a miss and request was fulfilled by the backend."},"apiTime":{"type":"number","format":"double","description":"The total time it took to process this request."},"serviceTime":{"type":"number","format":"double","description":"he time it took to forward this request to the backend and get the response back."},"apiRegion":{"type":"string","description":"Azure region where the gateway that processed this request is located."},"subscriptionId":{"type":"string","description":"Subscription identifier path. /subscriptions/{subscriptionId}"},"requestId":{"type":"string","description":"Request Identifier."},"requestSize":{"type":"integer","format":"int32","description":"The size of this request.."}},"description":"Request Report data."}}}}
/ reports / byApi
/ reports / byUser
/ reports / byOperation
/ reports / byProduct
/ reports / byGeo
/ reports / bySubscription
/ reports / byTime
/ reports / byRequest
Azure API Management - Users OpenAPI	{"openapi":"3.0.0","info":{"title":"Azure API Management - Users","description":"Use these REST APIs for performing operations on User entity in Azure API Management deployment. The User entity in API Management represents the developers that call the APIs of the products to which they are subscribed.","version":"2017-03-01"},"security":[{"apim_key":[]}],"paths":{"/users":{"get":{"tags":["Users"],"operationId":"User_List","description":"Lists a collection of registered users in the specified service instance.","parameters":[{"name":"$filter","in":"query","required":false,"description":"| Field | Supported operators | Supported functions |\n|------------------|------------------------|-----------------------------------|\n| id | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| firstName | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| lastName | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| email | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| state | eq | N/A |\n| registrationDate | ge, le, eq, ne, gt, lt | N/A |\n| note | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |","schema":{"type":"string"}},{"$ref":"./apimanagement.json#/components/parameters/TopQueryParameter"},{"$ref":"./apimanagement.json#/components/parameters/SkipQueryParameter"},{"$ref":"./apimanagement.json#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"Lists a collection of User entities.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserCollection"}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"./apimanagement.json#/definitions/ErrorResponse"}}}}},"x-ms-pageable":{"nextLinkName":"nextLink"},"x-ms-odata":"#/components/schemas/UserContract"}},"/users/{uid}":{"get":{"tags":["Users"],"operationId":"User_Get","description":"Gets the details of the user specified by its identifier.","parameters":[{"$ref":"#/components/parameters/UserIdParameter"},{"$ref":"./apimanagement.json#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"Gets the specified user entity.","headers":{"ETag":{"description":"Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserContract"}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"./apimanagement.json#/definitions/ErrorResponse"}}}}}},"put":{"tags":["Users"],"operationId":"User_CreateOrUpdate","description":"Creates or Updates a user.","parameters":[{"$ref":"#/components/parameters/UserIdParameter"},{"$ref":"./apimanagement.json#/components/parameters/ApiVersionParameter"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserCreateParameters"}}},"description":"Create or update parameters.","required":true},"responses":{"200":{"description":"User was successfully updated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserContract"}}}},"201":{"description":"User was successfully created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserContract"}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"./apimanagement.json#/definitions/ErrorResponse"}}}}}},"patch":{"tags":["Users"],"operationId":"User_Update","description":"Updates the details of the user specified by its identifier.","parameters":[{"$ref":"#/components/parameters/UserIdParameter"},{"name":"If-Match","in":"header","required":true,"description":"The entity state (Etag) version of the user to update. A value of \"*\" can be used for If-Match to unconditionally apply the operation.","schema":{"type":"string"}},{"$ref":"./apimanagement.json#/components/parameters/ApiVersionParameter"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserUpdateParameters"}}},"description":"Update parameters.","required":true},"responses":{"204":{"description":"The user details were successfully updated."},"default":{"description":"*** Error Responses: ***\n\n * 405 Administrator user cannot be modified\n\n * 4XX Error response giving details why the operation failed.","content":{"application/json":{"schema":{"$ref":"./apimanagement.json#/definitions/ErrorResponse"}}}}}},"delete":{"tags":["Users"],"operationId":"User_Delete","description":"Deletes specific user.","parameters":[{"$ref":"#/components/parameters/UserIdParameter"},{"name":"deleteSubscriptions","in":"query","required":false,"description":"Whether to delete user's subscription or not.","schema":{"type":"string","enum":["False","True"],"default":"False"}},{"name":"notify","in":"query","required":false,"description":"Send an Account Closed Email notification to the User.","schema":{"type":"string","enum":["False","True"],"default":"False"}},{"name":"If-Match","in":"header","required":true,"description":"The entity state (Etag) version of the user to delete. A value of \"*\" can be used for If-Match to unconditionally apply the operation.","schema":{"type":"string"}},{"$ref":"./apimanagement.json#/components/parameters/ApiVersionParameter"}],"responses":{"204":{"description":"The user details were successfully deleted."},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"./apimanagement.json#/definitions/ErrorResponse"}}}}}}},"/users/{uid}/generateSsoUrl":{"post":{"tags":["Users"],"operationId":"User_GenerateSsoUrl","description":"Retrieves a redirection URL containing an authentication token for signing a given user into the developer portal.","parameters":[{"$ref":"#/components/parameters/UserIdParameter"},{"$ref":"./apimanagement.json#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"The response body contains the single sign-on URL.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerateSsoUrlResult"}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"./apimanagement.json#/definitions/ErrorResponse"}}}}}}},"/users/{uid}/groups":{"get":{"tags":["UserGroups"],"operationId":"UserGroup_List","description":"Lists all user groups.","parameters":[{"$ref":"#/components/parameters/UserIdParameter"},{"name":"$filter","in":"query","required":false,"description":"| Field | Supported operators | Supported functions |\n|-------------|------------------------|---------------------------------------------|\n| id | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| name | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| description | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |","schema":{"type":"string"}},{"$ref":"./apimanagement.json#/components/parameters/TopQueryParameter"},{"$ref":"./apimanagement.json#/components/parameters/SkipQueryParameter"},{"$ref":"./apimanagement.json#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"Lists a collection of Group entities.","content":{"application/json":{"schema":{"$ref":"./apimgroups.json#/definitions/GroupCollection"}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"./apimanagement.json#/definitions/ErrorResponse"}}}}},"x-ms-pageable":{"nextLinkName":"nextLink"},"x-ms-odata":"./apimgroups.json#/definitions/GroupContract"}},"/users/{uid}/subscriptions":{"get":{"tags":["UserSubscriptions"],"operationId":"UserSubscription_List","description":"Lists the collection of subscriptions of the specified user.","parameters":[{"$ref":"#/components/parameters/UserIdParameter"},{"name":"$filter","in":"query","required":false,"description":"| Field | Supported operators | Supported functions |\n|--------------|------------------------|---------------------------------------------|\n| id | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| name | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| stateComment | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| userId | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| productId | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| state | eq | |","schema":{"type":"string"}},{"$ref":"./apimanagement.json#/components/parameters/TopQueryParameter"},{"$ref":"./apimanagement.json#/components/parameters/SkipQueryParameter"},{"$ref":"./apimanagement.json#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"Lists a collection of Subscription entities.","content":{"application/json":{"schema":{"$ref":"./apimsubscriptions.json#/definitions/SubscriptionCollection"}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"./apimanagement.json#/definitions/ErrorResponse"}}}}},"x-ms-pageable":{"nextLinkName":"nextLink"},"x-ms-odata":"./apimsubscriptions.json#/definitions/SubscriptionContract"}},"/users/{uid}/identities":{"get":{"tags":["UserIdentities"],"operationId":"UserIdentities_List","description":"Lists all user identities.","parameters":[{"$ref":"#/components/parameters/UserIdParameter"},{"$ref":"./apimanagement.json#/components/parameters/ApiVersionParameter"}],"x-ms-pageable":{},"responses":{"200":{"description":"Lists of User Identities.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserIdentityCollection"}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"./apimanagement.json#/definitions/ErrorResponse"}}}}}}},"/users/{uid}/token":{"post":{"tags":["Users"],"operationId":"User_GetSharedAccessToken","description":"Gets the Shared Access Authorization Token for the User.","parameters":[{"$ref":"#/components/parameters/UserIdParameter"},{"$ref":"./apimanagement.json#/components/parameters/ApiVersionParameter"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserTokenParameters"}}},"description":"Create Authorization Token parameters.","required":true},"responses":{"200":{"description":"The response body contains the authorization token for the user.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserTokenResult"}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"./apimanagement.json#/definitions/ErrorResponse"}}}}}}}},"servers":[{"url":"{apimBaseUrl}","variables":{"apimBaseUrl":{"description":"The management endpoint of the API Management service, for example https://myapimservice.management.azure-api.net.","x-ms-skip-url-encoding":true,"default":""}}}],"components":{"parameters":{"UserIdParameter":{"name":"uid","in":"path","required":true,"description":"User identifier. Must be unique in the current API Management service instance.","x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":256,"pattern":"^[^*#&+:<>?]+$"}}},"securitySchemes":{"apim_key":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"GenerateSsoUrlResult":{"properties":{"value":{"type":"string","description":"Redirect Url containing the SSO URL value."}},"description":"Generate SSO Url operations response details."},"UserCollection":{"properties":{"value":{"type":"array","items":{"$ref":"#/components/schemas/UserContract"},"description":"Page values."},"count":{"type":"integer","description":"Total number of entities"},"nextLink":{"type":"string","description":"Next page link if any."}},"description":"Paged Users list representation."},"UserContract":{"properties":{"id":{"type":"string","description":"Identifier of the entity."}},"allOf":[{"$ref":"#/components/schemas/UserContractProperties"}],"description":"User details."},"UserContractProperties":{"properties":{"firstName":{"type":"string","description":"First name."},"lastName":{"type":"string","description":"Last name."},"email":{"type":"string","description":"Email address."},"registrationDate":{"type":"string","format":"date-time","description":"Date of user registration. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard.\n"},"groups":{"readOnly":true,"type":"array","items":{"$ref":"./apimgroups.json#/definitions/GroupContract"},"description":"Collection of groups user is part of."}},"allOf":[{"$ref":"#/components/schemas/UserEntityBaseParameters"}],"description":"User profile."},"UserCreateParameters":{"properties":{"email":{"type":"string","description":"Email address. Must not be empty and must be unique within the service instance.","minLength":1,"maxLength":254},"firstName":{"type":"string","description":"First name.","minLength":1,"maxLength":100},"lastName":{"type":"string","description":"Last name.","minLength":1,"maxLength":100},"password":{"type":"string","description":"User Password. If no value is provided, a default password is generated."}},"allOf":[{"$ref":"#/components/schemas/UserEntityBaseParameters"}],"required":["email","firstName","lastName"],"description":"Parameters supplied to the Create User operation."},"UserEntityBaseParameters":{"properties":{"state":{"type":"string","description":"Account state. Specifies whether the user is active or not. Blocked users are unable to sign into the developer portal or call any APIs of subscribed products. Default state is Active.","enum":["active","blocked"],"default":"active","x-ms-enum":{"name":"UserState","modelAsString":true}},"note":{"type":"string","description":"Optional note about a user set by the administrator."},"identities":{"readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/UserIdentityContract"},"description":"Collection of user identities."}},"description":"User Entity Base Parameters set."},"UserIdentityCollection":{"properties":{"value":{"type":"array","items":{"$ref":"#/components/schemas/UserIdentityContract"},"description":"User Identity values."},"count":{"type":"integer","format":"int64","description":"Total record count number across all pages."},"nextLink":{"type":"string","description":"Next page link if any."}},"description":"List of Users Identity list representation."},"UserIdentityContract":{"properties":{"provider":{"type":"string","description":"Identity provider name."},"id":{"type":"string","description":"Identifier value within provider."}},"description":"User identity details."},"UserTokenParameters":{"properties":{"keyType":{"type":"string","description":"The Key to be used to generate token for user.","enum":["primary","secondary"],"default":"primary","x-ms-enum":{"name":"KeyType","modelAsString":false}},"expiry":{"type":"string","format":"date-time","description":"The Expiry time of the Token. Maximum token expiry time is set to 30 days. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard.\n"}},"required":["keyType","expiry"],"description":"Parameters supplied to the Get User Token operation."},"UserTokenResult":{"properties":{"value":{"type":"string","description":"Shared Access Authorization token for the User."}},"description":"Get User Token response details."},"UserUpdateParameters":{"properties":{"email":{"type":"string","description":"Email address. Must not be empty and must be unique within the service instance.","minLength":1,"maxLength":254},"password":{"type":"string","description":"User Password."},"firstName":{"type":"string","description":"First name.","minLength":1,"maxLength":100},"lastName":{"type":"string","description":"Last name.","minLength":1,"maxLength":100}},"allOf":[{"$ref":"#/components/schemas/UserEntityBaseParameters"}],"description":"Parameters supplied to the Update User operation."}}}}
/ users
/ users / {uid}
/ users / {uid} / generateSsoUrl
/ users / {uid} / groups
/ users / {uid} / subscriptions
/ users / {uid} / identities
/ users / {uid} / token
Azure API Management - Properties OpenAPI	{"openapi":"3.0.0","info":{"title":"Azure API Management - Properties","description":"Use these REST APIs for performing operations on Property entity associated with your Azure API Management deployment. API Management policies are a powerful capability of the system that allow the publisher to change the behavior of the API through configuration. Policies are a collection of statements that are executed sequentially on the request or response of an API. Policy statements can be constructed using literal text values, policy expressions, and properties. Each API Management service instance has a properties collection of key/value pairs that are global to the service instance. These properties can be used to manage constant string values across all API configuration and policies.","version":"2017-03-01"},"security":[{"apim_key":[]}],"paths":{"/properties":{"get":{"tags":["Property"],"operationId":"Property_List","description":"Lists a collection of properties defined within a service instance.","externalDocs":{"url":"https://docs.microsoft.com/en-us/azure/api-management/api-management-howto-properties"},"parameters":[{"name":"$filter","in":"query","required":false,"description":"| Field | Supported operators | Supported functions |\n|-------|------------------------|-------------------------------------------------------|\n| tags | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith, any, all |\n| name | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |","schema":{"type":"string"}},{"$ref":"./apimanagement.json#/components/parameters/TopQueryParameter"},{"$ref":"./apimanagement.json#/components/parameters/SkipQueryParameter"},{"$ref":"./apimanagement.json#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"A Collection of the Property entities for the specified API Management service instance.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PropertyCollection"}}}}},"x-ms-pageable":{"nextLinkName":"nextLink"},"x-ms-odata":"#/components/schemas/PropertyContract"}},"/properties/{propId}":{"get":{"tags":["Property"],"operationId":"Property_Get","description":"Gets the details of the property specified by its identifier.","parameters":[{"$ref":"#/components/parameters/PropertyIdParameter"},{"$ref":"./apimanagement.json#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"The response body contains the specified Property entity.","headers":{"ETag":{"description":"Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PropertyContract"}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"./apimanagement.json#/definitions/ErrorResponse"}}}}}},"put":{"tags":["Property"],"operationId":"Property_CreateOrUpdate","description":"Creates or updates a property.","parameters":[{"$ref":"#/components/parameters/PropertyIdParameter"},{"$ref":"./apimanagement.json#/components/parameters/ApiVersionParameter"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PropertyContract"}}},"description":"Create parameters.","required":true},"responses":{"200":{"description":"Property was successfully updated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PropertyContract"}}}},"201":{"description":"Property was successfully created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PropertyContract"}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"./apimanagement.json#/definitions/ErrorResponse"}}}}}},"patch":{"tags":["Property"],"operationId":"Property_Update","description":"Updates the specific property.","parameters":[{"$ref":"#/components/parameters/PropertyIdParameter"},{"name":"If-Match","in":"header","required":true,"description":"The entity state (Etag) version of the property to update. A value of \"*\" can be used for If-Match to unconditionally apply the operation.","schema":{"type":"string"}},{"$ref":"./apimanagement.json#/components/parameters/ApiVersionParameter"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PropertyUpdateParameters"}}},"description":"Update parameters.","required":true},"responses":{"204":{"description":"Property was successfully updated."},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"./apimanagement.json#/definitions/ErrorResponse"}}}}}},"delete":{"tags":["Property"],"operationId":"Property_Delete","description":"Deletes specific property from the API Management service instance.","parameters":[{"$ref":"#/components/parameters/PropertyIdParameter"},{"name":"If-Match","in":"header","required":true,"description":"The entity state (Etag) version of the property to delete. A value of \"*\" can be used for If-Match to unconditionally apply the operation.","schema":{"type":"string"}},{"$ref":"./apimanagement.json#/components/parameters/ApiVersionParameter"}],"responses":{"204":{"description":"Property was successfully deleted."},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"./apimanagement.json#/definitions/ErrorResponse"}}}}}}}},"servers":[{"url":"{apimBaseUrl}","variables":{"apimBaseUrl":{"description":"The management endpoint of the API Management service, for example https://myapimservice.management.azure-api.net.","x-ms-skip-url-encoding":true,"default":""}}}],"components":{"parameters":{"PropertyIdParameter":{"name":"propId","in":"path","required":true,"description":"Identifier of the property.","x-ms-parameter-location":"method","schema":{"type":"string","maxLength":256,"pattern":"^[^*#&+:<>?]+$"}}},"securitySchemes":{"apim_key":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"PropertyCollection":{"properties":{"value":{"type":"array","items":{"$ref":"#/components/schemas/PropertyContract"},"description":"Page values."},"count":{"type":"integer","description":"Total number of entities"},"nextLink":{"type":"string","description":"Next page link if any."}},"description":"Paged Property list representation."},"PropertyContract":{"properties":{"id":{"type":"string","description":"Identifier of the Property."}},"allOf":[{"$ref":"#/components/schemas/PropertyContractProperties"}],"description":"Property details."},"PropertyContractProperties":{"properties":{"name":{"type":"string","description":"Unique name of Property. It may contain only letters, digits, period, dash, and underscore characters.","minLength":1,"maxLength":256,"pattern":"^[A-Za-z0-9-._]+$"},"value":{"type":"string","description":"Value of the property. Can contain policy expressions. It may not be empty or consist only of whitespace.","minLength":1,"maxLength":4096}},"allOf":[{"$ref":"#/components/schemas/PropertyEntityBaseParameters"}],"required":["name","value"],"description":"Property Contract properties."},"PropertyUpdateParameters":{"properties":{"name":{"type":"string","description":"Unique name of Property. It may contain only letters, digits, period, dash, and underscore characters.","minLength":1,"maxLength":256,"pattern":"^[A-Za-z0-9-._]+$"},"value":{"type":"string","description":"Value of the property. Can contain policy expressions. It may not be empty or consist only of whitespace.","minLength":1,"maxLength":4096}},"allOf":[{"$ref":"#/components/schemas/PropertyEntityBaseParameters"}],"description":"Property Contract properties."},"PropertyEntityBaseParameters":{"properties":{"tags":{"type":"array","items":{"type":"string"},"maxItems":32,"description":"Optional tags that when provided can be used to filter the property list."},"secret":{"description":"Determines whether the value is a secret and should be encrypted or not. Default value is false.","type":"boolean"}},"description":"Property Entity Base Parameters set."}}}}
/ properties
/ properties / {propId}
Azure API Management - Templates OpenAPI	{"openapi":"3.0.0","info":{"title":"Azure API Management - Templates","description":"Use these REST APIs for performing operations on Email Templates associated with your Azure API Management deployment.","version":"2017-03-01"},"security":[{"apim_key":[]}],"paths":{"/templates":{"get":{"tags":["EmailTemplate"],"operationId":"EmailTemplate_List","description":"Lists a collection of properties defined within a service instance.","parameters":[{"name":"$filter","in":"query","required":false,"description":"| Field | Supported operators | Supported functions |\n|----------------|------------------------|---------------------------------------------|\n| id | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |","schema":{"type":"string"}},{"$ref":"./apimanagement.json#/components/parameters/TopQueryParameter"},{"$ref":"./apimanagement.json#/components/parameters/SkipQueryParameter"},{"$ref":"./apimanagement.json#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"A Collection of the Email Template for the specified API Management service instance.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmailTemplateCollection"}}}}},"x-ms-pageable":{"nextLinkName":"nextLink"}}},"/templates/{templateName}":{"get":{"tags":["EmailTemplates"],"operationId":"EmailTemplate_Get","description":"Gets the details of the email template specified by its identifier.","parameters":[{"$ref":"#/components/parameters/TemplateNameParameter"},{"$ref":"./apimanagement.json#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"The response body contains the specified Email template.","headers":{"ETag":{"description":"Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmailTemplateContract"}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"./apimanagement.json#/definitions/ErrorResponse"}}}}}},"put":{"tags":["EmailTemplates"],"operationId":"EmailTemplate_CreateOrUpdate","description":"Updates an Email Template.","parameters":[{"$ref":"#/components/parameters/TemplateNameParameter"},{"$ref":"./apimanagement.json#/components/parameters/ApiVersionParameter"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmailTemplateUpdateParameters"}}},"description":"Email Template update parameters.","required":true},"responses":{"200":{"description":"Email Template was successfully updated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmailTemplateContract"}}}},"201":{"description":"Email Template was successfully updated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmailTemplateContract"}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"./apimanagement.json#/definitions/ErrorResponse"}}}}}},"patch":{"tags":["EmailTemplates"],"operationId":"EmailTemplate_Update","description":"Updates the specific Email Template.","parameters":[{"$ref":"#/components/parameters/TemplateNameParameter"},{"$ref":"./apimanagement.json#/components/parameters/ApiVersionParameter"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmailTemplateUpdateParameters"}}},"description":"Update parameters.","required":true},"responses":{"204":{"description":"Email Template was successfully updated."},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"./apimanagement.json#/definitions/ErrorResponse"}}}}}},"delete":{"tags":["EmailTemplates"],"operationId":"EmailTemplate_Delete","description":"Reset the Email Template to default template provided by the API Management service instance.","parameters":[{"$ref":"#/components/parameters/TemplateNameParameter"},{"name":"If-Match","in":"header","required":true,"description":"The entity state (Etag) version of the Email Template to delete. A value of \"*\" can be used for If-Match to unconditionally apply the operation.","schema":{"type":"string"}},{"$ref":"./apimanagement.json#/components/parameters/ApiVersionParameter"}],"responses":{"204":{"description":"Email Template was successfully reset to default."},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"./apimanagement.json#/definitions/ErrorResponse"}}}}}}}},"servers":[{"url":"{apimBaseUrl}","variables":{"apimBaseUrl":{"description":"The management endpoint of the API Management service, for example https://myapimservice.management.azure-api.net.","x-ms-skip-url-encoding":true,"default":""}}}],"components":{"parameters":{"TemplateNameParameter":{"name":"templateName","in":"path","required":true,"x-ms-enum":{"name":"TemplateName","modelAsString":true},"description":"Email Template Name Identifier.","x-ms-parameter-location":"method","schema":{"type":"string","enum":["applicationApprovedNotificationMessage","accountClosedDeveloper","quotaLimitApproachingDeveloperNotificationMessage","newDeveloperNotificationMessage","emailChangeIdentityDefault","inviteUserNotificationMessage","newCommentNotificationMessage","confirmSignUpIdentityDefault","newIssueNotificationMessage","purchaseDeveloperNotificationMessage","passwordResetIdentityDefault","passwordResetByAdminNotificationMessage","rejectDeveloperNotificationMessage","requestDeveloperNotificationMessage"]}}},"securitySchemes":{"apim_key":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"EmailTemplateCollection":{"properties":{"value":{"type":"array","items":{"$ref":"#/components/schemas/EmailTemplateContract"},"description":"Page values."},"count":{"type":"integer","description":"Total number of entities"},"nextLink":{"type":"string","description":"Next page link if any."}},"description":"Paged email template list representation."},"EmailTemplateContract":{"properties":{"id":{"type":"string","description":"Identifier of the Template Contract."}},"allOf":[{"$ref":"#/components/schemas/EmailTemplateContractProperties"}],"description":"Email Template details."},"EmailTemplateContractProperties":{"properties":{"subject":{"type":"string","description":"Subject of the Template.","minLength":1,"maxLength":1000},"body":{"type":"string","description":"Email Template Body. This should be a valid XDocument","minLength":1},"title":{"type":"string","description":"Title of the Template."},"description":{"type":"string","description":"Description of the Email Template."},"isDefault":{"type":"boolean","description":"Whether the template is the default template provided by Api Management or has been edited.","readOnly":true},"parameters":{"type":"array","items":{"$ref":"#/components/schemas/EmailTemplateParametersContractProperties"},"description":"Email Template Parameter values."}},"required":["body","subject"],"description":"Email Template Contract properties."},"EmailTemplateUpdateParameters":{"properties":{"subject":{"type":"string","description":"Subject of the Template.","minLength":1,"maxLength":1000},"title":{"type":"string","description":"Title of the Template."},"description":{"type":"string","description":"Description of the Email Template."},"body":{"type":"string","description":"Email Template Body. This should be a valid XDocument","minLength":1},"parameters":{"type":"array","items":{"$ref":"#/components/schemas/EmailTemplateParametersContractProperties"},"description":"Email Template Parameter values."}},"description":"Email Template Update Contract properties."},"EmailTemplateParametersContractProperties":{"properties":{"name":{"type":"string","description":"Template parameter name.","minLength":1,"maxLength":256,"pattern":"^[A-Za-z0-9-._]+$"},"title":{"type":"string","description":"Template parameter title.","minLength":1,"maxLength":4096},"description":{"type":"string","description":"Template parameter description.","minLength":1,"maxLength":256,"pattern":"^[A-Za-z0-9-._]+$"}},"description":"Email Template Parameter contract."}}}}
/ templates
/ templates / {templateName}
Azure API Management - Authorization OpenAPI	{"openapi":"3.0.0","info":{"title":"Azure API Management - Authorization","description":"Use these REST APIs for managing OAuth2 servers configuration in your Azure API Management deployment. OAuth 2.0 can be used to authorize developer accounts for Azure API Management. For more information refer to [How to OAuth2](https://docs.microsoft.com/en-us/azure/api-management/api-management-howto-oauth2).","version":"2017-03-01"},"security":[{"apim_key":[]}],"paths":{"/authorizationServers":{"get":{"tags":["AuthorizationServers"],"operationId":"AuthorizationServer_List","description":"Lists a collection of authorization servers defined within a service instance.","parameters":[{"name":"$filter","in":"query","required":false,"description":"| Field | Supported operators | Supported functions |\n|-------|------------------------|---------------------------------------------|\n| id | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| name | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |","schema":{"type":"string"}},{"$ref":"./apimanagement.json#/components/parameters/TopQueryParameter"},{"$ref":"./apimanagement.json#/components/parameters/SkipQueryParameter"},{"$ref":"./apimanagement.json#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"A Collection of the Authorization Server entities for the specified API Management service instance.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthorizationServerCollection"}}}}},"x-ms-pageable":{"nextLinkName":"nextLink"},"x-ms-odata":"#/components/schemas/AuthorizationServerContract"}},"/authorizationServers/{authsid}":{"get":{"tags":["AuthorizationServers"],"operationId":"AuthorizationServer_Get","description":"Gets the details of the authorization server specified by its identifier.","parameters":[{"$ref":"#/components/parameters/AuthenticationServerIdParameter"},{"$ref":"./apimanagement.json#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"Gets the details of the specified authorization server.","headers":{"ETag":{"description":"Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthorizationServerContract"}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"./apimanagement.json#/definitions/ErrorResponse"}}}}}},"put":{"tags":["AuthorizationServers"],"operationId":"AuthorizationServer_CreateOrUpdate","description":"Creates new authorization server or updates an existing authorization server.","parameters":[{"$ref":"#/components/parameters/AuthenticationServerIdParameter"},{"$ref":"./apimanagement.json#/components/parameters/ApiVersionParameter"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthorizationServerContract"}}},"description":"Create or update parameters.","required":true},"responses":{"200":{"description":"Authorization server is already registered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthorizationServerContract"}}}},"201":{"description":"Authorization server was successfully registered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthorizationServerContract"}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"./apimanagement.json#/definitions/ErrorResponse"}}}}}},"patch":{"tags":["AuthorizationServers"],"operationId":"AuthorizationServer_Update","description":"Updates the details of the authorization server specified by its identifier.","parameters":[{"$ref":"#/components/parameters/AuthenticationServerIdParameter"},{"name":"If-Match","in":"header","required":true,"description":"The entity state (Etag) version of the authorization server to update. A value of \"*\" can be used for If-Match to unconditionally apply the operation.","schema":{"type":"string"}},{"$ref":"./apimanagement.json#/components/parameters/ApiVersionParameter"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthorizationServerUpdateContract"}}},"description":"OAuth2 Server settings Update parameters.","required":true},"responses":{"204":{"description":"The authorization server settings were successfully updated."},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"./apimanagement.json#/definitions/ErrorResponse"}}}}}},"delete":{"tags":["AuthorizationServers"],"operationId":"AuthorizationServer_Delete","description":"Deletes specific authorization server instance.","parameters":[{"$ref":"#/components/parameters/AuthenticationServerIdParameter"},{"name":"If-Match","in":"header","required":true,"description":"The entity state (Etag) version of the authentication server to delete. A value of \"*\" can be used for If-Match to unconditionally apply the operation.","schema":{"type":"string"}},{"$ref":"./apimanagement.json#/components/parameters/ApiVersionParameter"}],"responses":{"204":{"description":"The authorization server settings were successfully deleted."},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"./apimanagement.json#/definitions/ErrorResponse"}}}}}}}},"servers":[{"url":"{apimBaseUrl}","variables":{"apimBaseUrl":{"description":"The management endpoint of the API Management service, for example https://myapimservice.management.azure-api.net.","x-ms-skip-url-encoding":true,"default":""}}}],"components":{"parameters":{"AuthenticationServerIdParameter":{"name":"authsid","in":"path","required":true,"description":"Identifier of the authorization server.","x-ms-parameter-location":"method","schema":{"type":"string","maxLength":256,"pattern":"^[^*#&+:<>?]+$"}}},"securitySchemes":{"apim_key":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"AuthorizationServerCollection":{"properties":{"value":{"type":"array","items":{"$ref":"#/components/schemas/AuthorizationServerContract"},"description":"Page values."},"count":{"type":"integer","format":"int64","description":"Total record count number across all pages."},"nextLink":{"type":"string","description":"Next page link if any."}},"description":"Paged OAuth2 Authorization Servers list representation."},"AuthorizationServerContract":{"properties":{"id":{"type":"string","description":"Identifier of the Authorization Server entity."}},"allOf":[{"$ref":"#/components/schemas/AuthorizationServerContractProperties"}],"description":"External OAuth authorization server settings."},"AuthorizationServerContractProperties":{"properties":{"name":{"type":"string","description":"User-friendly authorization server name.","minLength":1,"maxLength":50},"clientRegistrationEndpoint":{"type":"string","description":"Optional reference to a page where client or app registration for this authorization server is performed. Contains absolute URL to entity being referenced."},"authorizationEndpoint":{"type":"string","description":"OAuth authorization endpoint. See http://tools.ietf.org/html/rfc6749#section-3.2."},"grantTypes":{"type":"array","items":{"type":"string","enum":["authorizationCode","implicit","resourceOwnerPassword","clientCredentials"],"x-ms-enum":{"name":"GrantType","modelAsString":true,"values":[{"value":"authorizationCode","description":"Authorization Code Grant flow as described https://tools.ietf.org/html/rfc6749#section-4.1."},{"value":"implicit","description":"Implicit Code Grant flow as described https://tools.ietf.org/html/rfc6749#section-4.2."},{"value":"resourceOwnerPassword","description":"Resource Owner Password Grant flow as described https://tools.ietf.org/html/rfc6749#section-4.3."},{"value":"clientCredentials","description":"Client Credentials Grant flow as described https://tools.ietf.org/html/rfc6749#section-4.4."}]}},"description":"Form of an authorization grant, which the client uses to request the access token.","externalDocs":{"url":"http://tools.ietf.org/html/rfc6749#section-4"}},"clientId":{"type":"string","description":"Client or app id registered with this authorization server."}},"allOf":[{"$ref":"#/components/schemas/AuthorizationServerContractBaseProperties"}],"required":["name","clientRegistrationEndpoint","authorizationEndpoint","clientId","grantTypes"],"description":"External OAuth authorization server settings Properties."},"AuthorizationServerUpdateContract":{"properties":{"name":{"type":"string","description":"User-friendly authorization server name.","minLength":1,"maxLength":50},"clientRegistrationEndpoint":{"type":"string","description":"Optional reference to a page where client or app registration for this authorization server is performed. Contains absolute URL to entity being referenced."},"authorizationEndpoint":{"type":"string","description":"OAuth authorization endpoint. See http://tools.ietf.org/html/rfc6749#section-3.2."},"grantTypes":{"type":"array","items":{"type":"string","enum":["authorizationCode","implicit","resourceOwnerPassword","clientCredentials"],"x-ms-enum":{"name":"GrantType","modelAsString":true,"values":[{"value":"authorizationCode","description":"Authorization Code Grant flow as described https://tools.ietf.org/html/rfc6749#section-4.1."},{"value":"implicit","description":"Implicit Code Grant flow as described https://tools.ietf.org/html/rfc6749#section-4.2."},{"value":"resourceOwnerPassword","description":"Resource Owner Password Grant flow as described https://tools.ietf.org/html/rfc6749#section-4.3."},{"value":"clientCredentials","description":"Client Credentials Grant flow as described https://tools.ietf.org/html/rfc6749#section-4.4."}]}},"description":"Form of an authorization grant, which the client uses to request the access token.","externalDocs":{"url":"http://tools.ietf.org/html/rfc6749#section-4"}},"clientId":{"type":"string","description":"Client or app id registered with this authorization server."}},"allOf":[{"$ref":"#/components/schemas/AuthorizationServerContractBaseProperties"}],"description":"External OAuth authorization server Update settings contract."},"AuthorizationServerContractBaseProperties":{"properties":{"description":{"type":"string","description":"Description of the authorization server. Can contain HTML formatting tags."},"authorizationMethods":{"type":"array","items":{"type":"string","enum":["HEAD","OPTIONS","TRACE","GET","POST","PUT","PATCH","DELETE"],"x-ms-enum":{"name":"AuthorizationMethod","modelAsString":false}},"description":"HTTP verbs supported by the authorization endpoint. GET must be always present. POST is optional."},"clientAuthenticationMethod":{"type":"array","items":{"type":"string","enum":["Basic","Body"],"x-ms-enum":{"name":"ClientAuthenticationMethod","modelAsString":true,"values":[{"value":"Basic","description":"Basic Client Authentication method."},{"value":"Body","description":"Body based Authentication method."}]}},"description":"Method of authentication supported by the token endpoint of this authorization server. Possible values are Basic and/or Body. When Body is specified, client credentials and other parameters are passed within the request body in the application/x-www-form-urlencoded format."},"tokenBodyParameters":{"type":"array","items":{"$ref":"#/components/schemas/TokenBodyParameterContract"},"description":"Additional parameters required by the token endpoint of this authorization server represented as an array of JSON objects with name and value string properties, i.e. {\"name\" : \"name value\", \"value\": \"a value\"}."},"tokenEndpoint":{"type":"string","description":"OAuth token endpoint. Contains absolute URI to entity being referenced.","externalDocs":{"url":"http://tools.ietf.org/html/rfc6749#section-3.1"}},"supportState":{"type":"boolean","description":"If true, authorization server will include state parameter from the authorization request to its response. Client may use state parameter to raise protocol security.","externalDocs":{"url":"http://tools.ietf.org/html/rfc6749#section-3.1"}},"defaultScope":{"type":"string","description":"Access token scope that is going to be requested by default. Can be overridden at the API level. Should be provided in the form of a string containing space-delimited values.","externalDocs":{"url":"http://tools.ietf.org/html/rfc6749#section-3.3"}},"bearerTokenSendingMethods":{"type":"array","items":{"type":"string","enum":["authorizationHeader","query"],"x-ms-enum":{"name":"BearerTokenSendingMethod","modelAsString":true}},"description":"Specifies the mechanism by which access token is passed to the API. ","externalDocs":{"url":"http://tools.ietf.org/html/rfc6749#section-4"}},"clientSecret":{"type":"string","description":"Client or app secret registered with this authorization server."},"resourceOwnerUsername":{"type":"string","description":"Can be optionally specified when resource owner password grant type is supported by this authorization server. Default resource owner username."},"resourceOwnerPassword":{"type":"string","description":"Can be optionally specified when resource owner password grant type is supported by this authorization server. Default resource owner password."}},"description":"External OAuth authorization server Update settings contract."},"TokenBodyParameterContract":{"properties":{"name":{"type":"string","description":"body parameter name."},"value":{"type":"string","description":"body parameter value."}},"required":["name","value"],"description":"OAuth acquire token request body parameter (www-url-form-encoded)."}}}}
/ authorizationServers
/ authorizationServers / {authsid}
Azure API Management - Backends OpenAPI	{"openapi":"3.0.0","info":{"title":"Azure API Management - Backends","description":"Use these REST APIs for performing operations on Backend entity in Azure API Management deployment. The Backend entity in API Management represents a backend service that is configured to skip certification chain validation when using a self-signed certificate to test mutual certificate authentication.","version":"2017-03-01"},"security":[{"apim_key":[]}],"paths":{"/backends":{"get":{"tags":["Backends"],"operationId":"Backend_List","description":"Lists a collection of backends in the specified service instance.","parameters":[{"name":"$filter","in":"query","required":false,"description":"| Field | Supported operators | Supported functions |\n|-------|------------------------|---------------------------------------------|\n| id | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| host | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |","schema":{"type":"string"}},{"$ref":"./apimanagement.json#/components/parameters/TopQueryParameter"},{"$ref":"./apimanagement.json#/components/parameters/SkipQueryParameter"},{"$ref":"./apimanagement.json#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"Lists a collection of Backend entities.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BackendCollection"}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"./apimanagement.json#/definitions/ErrorResponse"}}}}},"x-ms-pageable":{"nextLinkName":"nextLink"},"x-ms-odata":"#/components/schemas/BackendContract"}},"/backends/{backendid}":{"get":{"tags":["Backends"],"operationId":"Backend_Get","description":"Gets the details of the backend specified by its identifier.","parameters":[{"$ref":"#/components/parameters/BackendIdParameter"},{"$ref":"./apimanagement.json#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"The response body contains the specified Backend entity.","headers":{"ETag":{"description":"Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BackendContract"}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"./apimanagement.json#/definitions/ErrorResponse"}}}}}},"put":{"tags":["Backends"],"operationId":"Backend_CreateOrUpdate","description":"Creates or Updates a backend.","parameters":[{"$ref":"#/components/parameters/BackendIdParameter"},{"$ref":"./apimanagement.json#/components/parameters/ApiVersionParameter"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BackendContract"}}},"description":"Create parameters.","required":true},"responses":{"200":{"description":"The existing backend was successfully updated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BackendContract"}}}},"201":{"description":"Backend was successfully created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BackendContract"}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"./apimanagement.json#/definitions/ErrorResponse"}}}}}},"patch":{"tags":["Backends"],"operationId":"Backend_Update","description":"Updates an existing backend.","parameters":[{"$ref":"#/components/parameters/BackendIdParameter"},{"name":"If-Match","in":"header","required":true,"description":"The entity state (Etag) version of the backend to update. A value of \"*\" can be used for If-Match to unconditionally apply the operation.","schema":{"type":"string"}},{"$ref":"./apimanagement.json#/components/parameters/ApiVersionParameter"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BackendUpdateParameters"}}},"description":"Update parameters.","required":true},"responses":{"204":{"description":"The existing backend was successfully updated."},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"./apimanagement.json#/definitions/ErrorResponse"}}}}}},"delete":{"tags":["Backends"],"operationId":"Backend_Delete","description":"Deletes the specified backend.","parameters":[{"$ref":"#/components/parameters/BackendIdParameter"},{"name":"If-Match","in":"header","required":true,"description":"The entity state (Etag) version of the backend to delete. A value of \"*\" can be used for If-Match to unconditionally apply the operation.","schema":{"type":"string"}},{"$ref":"./apimanagement.json#/components/parameters/ApiVersionParameter"}],"responses":{"204":{"description":"The backend was successfully deleted."},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"./apimanagement.json#/definitions/ErrorResponse"}}}}}}}},"servers":[{"url":"{apimBaseUrl}","variables":{"apimBaseUrl":{"description":"The management endpoint of the API Management service, for example https://myapimservice.management.azure-api.net.","x-ms-skip-url-encoding":true,"default":""}}}],"components":{"parameters":{"BackendIdParameter":{"name":"backendid","in":"path","required":true,"description":"Identifier of the Backend entity. Must be unique in the current API Management service instance.","x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[^*#&+:<>?]+$"}}},"securitySchemes":{"apim_key":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"BackendAuthorizationHeaderCredentials":{"properties":{"scheme":{"type":"string","description":"Authentication Scheme name.","minLength":1,"maxLength":100},"parameter":{"type":"string","description":"Authentication Parameter value.","minLength":1,"maxLength":300}},"required":["scheme","parameter"],"description":"Authorization header information."},"BackendBaseParameters":{"properties":{"title":{"type":"string","description":"Backend Title.","minLength":1,"maxLength":300},"description":{"type":"string","description":"Backend Description.","minLength":1,"maxLength":2000},"resourceId":{"type":"string","description":"Management Uri of the Resource in External System. This url can be the Arm Resource Id of Logic Apps, Function Apps or Api Apps.","minLength":1,"maxLength":2000},"properties":{"$ref":"#/components/schemas/BackendProperties"},"credentials":{"$ref":"#/components/schemas/BackendCredentialsContract"},"proxy":{"$ref":"#/components/schemas/BackendProxyContract"},"tls":{"$ref":"#/components/schemas/BackendTlsProperties"}},"description":"Backend entity base Parameter set."},"BackendCollection":{"properties":{"value":{"type":"array","items":{"$ref":"#/components/schemas/BackendContract"},"description":"Backend values."},"count":{"type":"integer","description":"Total number of entities"},"nextLink":{"type":"string","description":"Next page link if any."}},"description":"Paged Backend list representation."},"BackendContract":{"properties":{"id":{"type":"string","description":"Identifier of the Backend entity."}},"allOf":[{"$ref":"#/components/schemas/BackendContractProperties"}],"description":"Backend details."},"BackendContractProperties":{"properties":{"url":{"type":"string","description":"Runtime Url of the Backend.","minLength":1,"maxLength":2000},"protocol":{"type":"string","enum":["http","soap"],"x-ms-enum":{"name":"BackendProtocol","modelAsString":true,"values":[{"value":"http","description":"The Backend is a RESTful service."},{"value":"soap","description":"The Backend is a SOAP service."}]},"description":"Backend communication protocol."}},"allOf":[{"$ref":"#/components/schemas/BackendBaseParameters"}],"required":["url","protocol"],"description":"Parameters supplied to the Create Backend operation."},"BackendCredentialsContract":{"properties":{"certificate":{"type":"array","items":{"type":"string"},"maxItems":32,"description":"List of Client Certificate Thumbprint."},"query":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}},"description":"Query Parameter description."},"header":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}},"description":"Header Parameter description."},"authorization":{"$ref":"#/components/schemas/BackendAuthorizationHeaderCredentials"}},"description":"Details of the Credentials used to connect to Backend."},"BackendProperties":{"properties":{"serviceFabricCluster":{"$ref":"#/components/schemas/BackendServiceFabricClusterProperties"}},"description":"Properties specific to the Backend Type."},"BackendServiceFabricClusterProperties":{"properties":{"clientCertificateThumbprint":{"description":"The client certificate thumbprint for the management endpoint.","type":"string"},"maxPartitionResolutionRetries":{"description":"Maximum number of retries while attempting resolve the partition.","format":"int32","type":"integer"},"partitionResolutionRequestTimeout":{"type":"string","format":"duration","description":"Maximum time allowed to update partition resolution data. Duration needs to be specified using the format PT[n]H[n]M[n]S as per ISO8601"},"managementEndpoints":{"type":"array","items":{"type":"string"},"description":"The cluster management endpoint."},"serverCertificateThumbprints":{"type":"array","items":{"type":"string"},"description":"Thumbprints of certificates cluster management service uses for tls communication"},"serverX509Names":{"type":"array","items":{"$ref":"#/components/schemas/X509CertificateName"},"description":"Server X509 Certificate Names Collection"}},"required":["managementEndpoints","clientCertificateThumbprint"],"description":"Properties of the Service Fabric Type Backend."},"X509CertificateName":{"properties":{"name":{"description":"Common Name of the Certificate.","type":"string"},"issuerCertificateThumbprint":{"description":"Thumbprint for the Issuer of the Certificate.","type":"string"}},"externalDocs":{"url":"https://docs.microsoft.com/en-us/azure/service-fabric/service-fabric-windows-cluster-x509-security"},"description":"Properties of server X509Names."},"BackendTlsProperties":{"properties":{"validateCertificateChain":{"description":"Flag indicating whether SSL certificate chain validation should be done when using self-signed certificates for this backend host.","type":"boolean","default":true},"validateCertificateName":{"description":"Flag indicating whether SSL certificate name validation should be done when using self-signed certificates for this backend host.","type":"boolean","default":true}},"description":"Properties controlling TLS Certificate Validation."},"BackendProxyContract":{"externalDocs":{"url":"https://msdn.microsoft.com/en-us/library/system.net.webproxy(v=vs.110).aspx","description":"Backend entity uses these details to connect to a WebProxy."},"properties":{"url":{"type":"string","description":"WebProxy Server AbsoluteUri property which includes the entire URI stored in the Uri instance, including all fragments and query strings.","minLength":1,"maxLength":2000},"username":{"type":"string","description":"Username to connect to the WebProxy server"},"password":{"type":"string","description":"Password to connect to the WebProxy Server"}},"required":["url"],"description":"Details of the Backend WebProxy Server to use in the Request to Backend."},"BackendUpdateParameters":{"properties":{"url":{"type":"string","description":"Runtime Url of the Backend.","minLength":1,"maxLength":2000},"protocol":{"type":"string","enum":["http","soap"],"x-ms-enum":{"name":"BackendProtocol","modelAsString":true,"values":[{"value":"http","description":"The Backend is a RESTful service."},{"value":"soap","description":"The Backend is a SOAP service."}]},"description":"Backend communication protocol."}},"allOf":[{"$ref":"#/components/schemas/BackendBaseParameters"}],"description":"Parameters supplied to the Update Backend operation."}}}}
/ backends
/ backends / {backendid}
Azure API Management - Loggers OpenAPI	{"openapi":"3.0.0","info":{"title":"Azure API Management - Loggers","description":"Use these REST APIs for performing operations on logger entity Azure API Management deployment.The Logger entity in API Management represents an event sink that you can use to log API Management events. Currently the Logger entity supports logging API Management events to Azure EventHub.","version":"2017-03-01"},"security":[{"apim_key":[]}],"paths":{"/loggers":{"get":{"tags":["Loggers"],"operationId":"Logger_List","description":"Lists a collection of loggers in the specified service instance.","externalDocs":{"url":"https://docs.microsoft.com/en-us/azure/api-management/api-management-howto-log-event-hubs"},"parameters":[{"name":"$filter","in":"query","required":false,"description":"| Field | Supported operators | Supported functions |\n|-------|------------------------|---------------------------------------------|\n| id | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| type | eq | |","schema":{"type":"string"}},{"$ref":"./apimanagement.json#/components/parameters/TopQueryParameter"},{"$ref":"./apimanagement.json#/components/parameters/SkipQueryParameter"},{"$ref":"./apimanagement.json#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"Lists a collection of Logger entities.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LoggerCollection"}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"./apimanagement.json#/definitions/ErrorResponse"}}}}},"x-ms-pageable":{"nextLinkName":"nextLink"},"x-ms-odata":"#/components/schemas/LoggerContract"}},"/loggers/{loggerid}":{"get":{"tags":["Loggers"],"operationId":"Logger_Get","description":"Gets the details of the logger specified by its identifier.","parameters":[{"$ref":"#/components/parameters/LoggerIdParameter"},{"$ref":"./apimanagement.json#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"The response body contains the specified Logger entity.","headers":{"ETag":{"description":"Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LoggerContract"}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"./apimanagement.json#/definitions/ErrorResponse"}}}}}},"put":{"tags":["Loggers"],"operationId":"Logger_CreateOrUpdate","description":"Creates or Updates a logger.","parameters":[{"$ref":"#/components/parameters/LoggerIdParameter"},{"$ref":"./apimanagement.json#/components/parameters/ApiVersionParameter"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LoggerContract"}}},"description":"Create parameters.","required":true},"responses":{"200":{"description":"The existing logger was successfully updated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LoggerContract"}}}},"201":{"description":"Logger was successfully created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LoggerContract"}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"./apimanagement.json#/definitions/ErrorResponse"}}}}}},"patch":{"tags":["Loggers"],"operationId":"Logger_Update","description":"Updates an existing logger.","parameters":[{"$ref":"#/components/parameters/LoggerIdParameter"},{"name":"If-Match","in":"header","required":true,"description":"The entity state (Etag) version of the logger to update. A value of \"*\" can be used for If-Match to unconditionally apply the operation.","schema":{"type":"string"}},{"$ref":"./apimanagement.json#/components/parameters/ApiVersionParameter"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LoggerUpdateContract"}}},"description":"Update parameters.","required":true},"responses":{"204":{"description":"The existing logger was successfully updated."},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"./apimanagement.json#/definitions/ErrorResponse"}}}}}},"delete":{"tags":["Loggers"],"operationId":"Logger_Delete","description":"Deletes the specified logger.","parameters":[{"$ref":"#/components/parameters/LoggerIdParameter"},{"name":"If-Match","in":"header","required":true,"description":"The entity state (Etag) version of the logger to delete. A value of \"*\" can be used for If-Match to unconditionally apply the operation.","schema":{"type":"string"}},{"$ref":"./apimanagement.json#/components/parameters/ApiVersionParameter"}],"responses":{"204":{"description":"The logger was successfully deleted."},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"./apimanagement.json#/definitions/ErrorResponse"}}}}}}}},"servers":[{"url":"{apimBaseUrl}","variables":{"apimBaseUrl":{"description":"The management endpoint of the API Management service, for example https://myapimservice.management.azure-api.net.","x-ms-skip-url-encoding":true,"default":""}}}],"components":{"parameters":{"LoggerIdParameter":{"name":"loggerid","in":"path","required":true,"description":"Logger identifier. Must be unique in the API Management service instance.","x-ms-parameter-location":"method","schema":{"type":"string","maxLength":256,"pattern":"^[^*#&+:<>?]+$"}}},"securitySchemes":{"apim_key":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"LoggerCollection":{"properties":{"value":{"type":"array","items":{"$ref":"#/components/schemas/LoggerContract"},"description":"Logger values."},"count":{"type":"integer","format":"int64","description":"Total record count number across all pages."},"nextLink":{"type":"string","description":"Next page link if any."}},"description":"Paged Logger list representation."},"LoggerContract":{"properties":{"id":{"type":"string","description":"Identifier of the Logger Entity."}},"allOf":[{"$ref":"#/components/schemas/LoggerContractProperties"}],"description":"Logger details."},"LoggerContractProperties":{"properties":{"loggerType":{"type":"string","description":"Logger type.","enum":["azureEventHub"],"x-ms-enum":{"name":"LoggerType","modelAsString":true,"values":[{"value":"azureEventHub","description":"Azure Event Hub as log destination."}]}},"description":{"type":"string","description":"Logger description.","maxLength":256},"credentials":{"type":"object","additionalProperties":{"type":"string"},"description":"The name and SendRule connection string of the event hub.","example":{"name":"apim","connectionString":"Endpoint=sb://contoso-ns.servicebus.windows.net/;SharedAccessKeyName=Sender;SharedAccessKey=..."}},"isBuffered":{"type":"boolean","description":"Whether records are buffered in the logger before publishing. Default is assumed to be true."}},"required":["loggerType","credentials"],"description":"The Logger entity in API Management represents an event sink that you can use to log API Management events. Currently the Logger entity supports logging API Management events to Azure Event Hubs."},"LoggerUpdateContract":{"properties":{"loggerType":{"type":"string","description":"Logger type.","enum":["azureEventHub"],"x-ms-enum":{"name":"LoggerType","modelAsString":true,"values":[{"value":"azureEventHub","description":"Azure Event Hub as log destination."}]}},"description":{"type":"string","description":"Logger description."},"credentials":{"type":"object","additionalProperties":{"type":"string"},"description":"Logger credentials."},"isBuffered":{"type":"boolean","description":"Whether records are buffered in the logger before publishing. Default is assumed to be true."}},"description":"Parameters supplied to the Update Logger operation."}}}}
/ loggers
/ loggers / {loggerid}
Azure API Management - Certificates OpenAPI	{"openapi":"3.0.0","info":{"title":"Azure API Management - Certificates","description":"Use these REST APIs for performing operations on Certificate entity in your Azure API Management deployment. Certificates can be used to setup mutual authentication with your Backend in API Management. For more information refer to [How to secure backend using Mutual Auth Certificate](https://docs.microsoft.com/en-us/azure/api-management/api-management-howto-mutual-certificates).","version":"2017-03-01"},"security":[{"apim_key":[]}],"paths":{"/certificates":{"get":{"tags":["Certificates"],"operationId":"Certificate_List","description":"Lists a collection of all certificates in the specified service instance.","parameters":[{"name":"$filter","in":"query","required":false,"description":"| Field | Supported operators | Supported functions |\n|----------------|------------------------|---------------------------------------------|\n| id | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| subject | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| thumbprint | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| expirationDate | ge, le, eq, ne, gt, lt | N/A |","schema":{"type":"string"}},{"$ref":"./apimanagement.json#/components/parameters/TopQueryParameter"},{"$ref":"./apimanagement.json#/components/parameters/SkipQueryParameter"},{"$ref":"./apimanagement.json#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"Returns a collection of Certificate entity.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CertificateCollection"}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"./apimanagement.json#/definitions/ErrorResponse"}}}}},"x-ms-pageable":{"nextLinkName":"nextLink"},"x-ms-odata":"#/components/schemas/CertificateContract"}},"/certificates/{certificateId}":{"get":{"tags":["Certificates"],"operationId":"Certificate_Get","description":"Gets the details of the certificate specified by its identifier.","parameters":[{"$ref":"#/components/parameters/CertificateIdParameter"},{"$ref":"./apimanagement.json#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"The response body contains the specified Certificate entity.","headers":{"ETag":{"description":"Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CertificateContract"}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"./apimanagement.json#/definitions/ErrorResponse"}}}}}},"put":{"tags":["Certificates"],"operationId":"Certificate_CreateOrUpdate","description":"Creates or updates the certificate being used for authentication with the backend.","externalDocs":{"description":"How to secure back-end services using client certificate authentication in Azure API Management","url":"https://azure.microsoft.com/en-us/documentation/articles/api-management-howto-mutual-certificates/"},"parameters":[{"$ref":"#/components/parameters/CertificateIdParameter"},{"name":"If-Match","in":"header","required":false,"description":"The entity state (Etag) version of the certificate to update. A value of \"*\" can be used for If-Match to unconditionally apply the operation..","schema":{"type":"string"}},{"$ref":"./apimanagement.json#/components/parameters/ApiVersionParameter"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CertificateCreateOrUpdateParameters"}}},"description":"Create or Update parameters.","required":true},"responses":{"200":{"description":"The certificate details were successfully updated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CertificateContract"}}}},"201":{"description":"The new certificate was successfully added.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CertificateContract"}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"./apimanagement.json#/definitions/ErrorResponse"}}}}}},"delete":{"tags":["Certificates"],"operationId":"Certificate_Delete","description":"Deletes specific certificate.","parameters":[{"$ref":"#/components/parameters/CertificateIdParameter"},{"name":"If-Match","in":"header","required":true,"description":"The entity state (Etag) version of the certificate to delete. A value of \"*\" can be used for If-Match to unconditionally apply the operation.","schema":{"type":"string"}},{"$ref":"./apimanagement.json#/components/parameters/ApiVersionParameter"}],"responses":{"204":{"description":"The certificate was successfully deleted."},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"./apimanagement.json#/definitions/ErrorResponse"}}}}}}}},"servers":[{"url":"{apimBaseUrl}","variables":{"apimBaseUrl":{"description":"The management endpoint of the API Management service, for example https://myapimservice.management.azure-api.net.","x-ms-skip-url-encoding":true,"default":""}}}],"components":{"parameters":{"CertificateIdParameter":{"name":"certificateId","in":"path","required":true,"description":"Identifier of the certificate entity. Must be unique in the current API Management service instance.","x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":256,"pattern":"^[^*#&+:<>?]+$"}}},"securitySchemes":{"apim_key":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"CertificateCollection":{"properties":{"value":{"type":"array","items":{"$ref":"#/components/schemas/CertificateContract"},"description":"Page values."},"count":{"type":"integer","description":"Total number of entities"},"nextLink":{"type":"string","description":"Next page link if any."}},"description":"Paged Certificates list representation."},"CertificateContract":{"properties":{"id":{"type":"string","description":"Identifier of the Certificate entity."}},"allOf":[{"$ref":"#/components/schemas/CertificateContractProperties"}],"description":"Certificate details."},"CertificateContractProperties":{"properties":{"subject":{"type":"string","description":"Subject attribute of the certificate."},"thumbprint":{"type":"string","description":"Thumbprint of the certificate."},"expirationDate":{"type":"string","format":"date-time","description":"Expiration date of the certificate. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard.\n"}},"required":["subject","thumbprint","expirationDate"],"description":"Properties of the Certificate contract."},"CertificateCreateOrUpdateParameters":{"properties":{"data":{"type":"string","description":"Base 64 encoded certificate using the application/x-pkcs12 representation."},"password":{"type":"string","description":"Password for the Certificate"}},"required":["data","password"],"description":"Parameters supplied to the CreateOrUpdate certificate operation."}}}}
/ certificates
/ certificates / {certificateId}
Azure API Management - Quotas OpenAPI	{"openapi":"3.0.0","info":{"title":"Azure API Management - Quotas","description":"Use these REST APIs for performing operations on Quota entity associated with your Azure API Management deployment. To configure call rate limit and quota policies refer to [how to configure call rate limit and quota](https://docs.microsoft.com/en-us/azure/api-management/api-management-howto-product-with-rules#a-namepolicies-ato-configure-call-rate-limit-and-quota-policies).","version":"2017-03-01"},"security":[{"apim_key":[]}],"paths":{"/quotas/{quotaCounterKey}":{"get":{"tags":["QuotaByCounterKeys"],"operationId":"QuotaByCounterKeys_List","description":"Lists a collection of current quota counter periods associated with the counter-key configured in the policy on the specified service instance. The api does not support paging yet.","externalDocs":{"url":"https://docs.microsoft.com/en-us/azure/api-management/api-management-howto-product-with-rules#a-namepolicies-ato-configure-call-rate-limit-and-quota-policies","description":"Document describing how to configure the quota policies."},"parameters":[{"$ref":"#/components/parameters/QuotaCounterKeyParameter"},{"$ref":"./apimanagement.json#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"Lists a collection of the quota counter values.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/QuotaCounterCollection"}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"./apimanagement.json#/definitions/ErrorResponse"}}}}}},"patch":{"tags":["QuotaByCounterKeys"],"operationId":"QuotaByCounterKeys_Update","description":"Updates all the quota counter values specified with the existing quota counter key to a value in the specified service instance. This should be used for reset of the quota counter values.","parameters":[{"$ref":"#/components/parameters/QuotaCounterKeyParameter"},{"$ref":"./apimanagement.json#/components/parameters/ApiVersionParameter"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QuotaCounterValueContractProperties"}}},"description":"The value of the quota counter to be applied to all quota counter periods.","required":true},"responses":{"204":{"description":"Quota counter period was successfully updated."},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"./apimanagement.json#/definitions/ErrorResponse"}}}}}}},"/quotas/{quotaCounterKey}/{quotaPeriodKey}":{"get":{"tags":["QuotaByPeriodKeys"],"operationId":"QuotaByPeriodKeys_Get","description":"Gets the value of the quota counter associated with the counter-key in the policy for the specific period in service instance.","externalDocs":{"url":"https://docs.microsoft.com/en-us/azure/api-management/api-management-howto-product-with-rules#a-namepolicies-ato-configure-call-rate-limit-and-quota-policies","description":"Document describing how to configure the quota policies."},"parameters":[{"$ref":"#/components/parameters/QuotaCounterKeyParameter"},{"$ref":"#/components/parameters/QuotaPeriodKeyParameter"},{"$ref":"./apimanagement.json#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"The response body contains the Quota counter details for the specified period.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/QuotaCounterContract"}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"./apimanagement.json#/definitions/ErrorResponse"}}}}}},"patch":{"tags":["QuotaByPeriodKeys"],"operationId":"QuotaByPeriodKeys_Update","description":"Updates an existing quota counter value in the specified service instance.","parameters":[{"$ref":"#/components/parameters/QuotaCounterKeyParameter"},{"$ref":"#/components/parameters/QuotaPeriodKeyParameter"},{"$ref":"./apimanagement.json#/components/parameters/ApiVersionParameter"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QuotaCounterValueContractProperties"}}},"description":"The value of the Quota counter to be applied on the specified period.","required":true},"responses":{"204":{"description":"The quota counter value was successfully updated."},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"./apimanagement.json#/definitions/ErrorResponse"}}}}}}}},"servers":[{"url":"{apimBaseUrl}","variables":{"apimBaseUrl":{"description":"The management endpoint of the API Management service, for example https://myapimservice.management.azure-api.net.","x-ms-skip-url-encoding":true,"default":""}}}],"components":{"parameters":{"QuotaCounterKeyParameter":{"name":"quotaCounterKey","in":"path","required":true,"description":"Quota counter key identifier.This is the result of expression defined in counter-key attribute of the quota-by-key policy.For Example, if you specify counter-key=\"boo\" in the policy, then it’s accessible by \"boo\" counter key. But if it’s defined as counter-key=\"@(\"b\"+\"a\")\" then it will be accessible by \"ba\" key","x-ms-parameter-location":"method","schema":{"type":"string"}},"QuotaPeriodKeyParameter":{"name":"quotaPeriodKey","in":"path","required":true,"description":"Quota period key identifier.","x-ms-parameter-location":"method","schema":{"type":"string"}}},"securitySchemes":{"apim_key":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"QuotaCounterCollection":{"properties":{"value":{"type":"array","items":{"$ref":"#/components/schemas/QuotaCounterContract"},"description":"Quota counter values."},"count":{"type":"integer","format":"int64","description":"Total record count number across all pages."},"nextLink":{"type":"string","description":"Next page link if any."}},"description":"Paged Quota Counter list representation."},"QuotaCounterContract":{"properties":{"counterKey":{"type":"string","description":"The Key value of the Counter. Must not be empty.","minLength":1},"periodKey":{"type":"string","description":"Identifier of the Period for which the counter was collected. Must not be empty.","minLength":1},"periodStartTime":{"type":"string","format":"date-time","description":"The date of the start of Counter Period. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard.\n"},"periodEndTime":{"type":"string","format":"date-time","description":"The date of the end of Counter Period. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard.\n"},"Value":{"$ref":"#/components/schemas/QuotaCounterValueContractProperties"}},"required":["counterKey","periodKey","periodStartTime","periodEndTime"],"description":"Quota counter details."},"QuotaCounterValueContract":{"properties":{"value":{"$ref":"#/components/schemas/QuotaCounterValueContractProperties"}},"description":"Quota counter value details."},"QuotaCounterValueContractProperties":{"properties":{"callsCount":{"type":"integer","format":"int32","description":"Number of times Counter was called."},"kbTransferred":{"type":"number","format":"double","description":"Data Transferred in KiloBytes."}},"description":"Quota counter value details."}}}}
/ quotas / {quotaCounterKey}
/ quotas / {quotaCounterKey} / {quotaPeriodKey}
Azure API Management - Identity Providers OpenAPI	{"openapi":"3.0.0","info":{"title":"Azure API Management - Identity Providers","description":"Use these REST APIs for performing operations on Identity Provider entity associated with your Azure API Management deployment. Setting up an external Identity Provider for authentication can help you manage the developer portal logins using the OAuth2 flow.","version":"2017-03-01"},"security":[{"apim_key":[]}],"paths":{"/identityProviders":{"get":{"tags":["IdentityProvider"],"operationId":"IdentityProvider_List","description":"Lists a collection of Identity Provider configured in the specified service instance.","externalDocs":{"url":"https://docs.microsoft.com/en-us/azure/api-management/api-management-howto-aad#how-to-authorize-developer-accounts-using-azure-active-directory"},"parameters":[{"$ref":"./apimanagement.json#/components/parameters/ApiVersionParameter"}],"x-ms-pageable":{},"responses":{"200":{"description":"Lists a collection of Identity Providers.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IdentityProviderList"}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"./apimanagement.json#/definitions/ErrorResponse"}}}}}}},"/identityProviders/{identityProviderName}":{"get":{"tags":["IdentityProvider"],"operationId":"IdentityProvider_Get","description":"Gets the configuration details of the identity Provider configured in specified service instance.","parameters":[{"$ref":"#/components/parameters/IdentityProviderNameParameter"},{"$ref":"./apimanagement.json#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"The response body contains the specified IdentityProvider entity configuration details.","headers":{"ETag":{"description":"Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IdentityProviderContract"}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"./apimanagement.json#/definitions/ErrorResponse"}}}}}},"put":{"tags":["IdentityProvider"],"operationId":"IdentityProvider_CreateOrUpdate","description":"Creates or Updates the IdentityProvider configuration.","parameters":[{"$ref":"#/components/parameters/IdentityProviderNameParameter"},{"$ref":"./apimanagement.json#/components/parameters/ApiVersionParameter"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IdentityProviderContract"}}},"description":"Create parameters.","required":true},"responses":{"200":{"description":"The existing Identity Provider was successfully updated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IdentityProviderContract"}}}},"201":{"description":"IdentityProvider configuration were successfully created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IdentityProviderContract"}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"./apimanagement.json#/definitions/ErrorResponse"}}}}}},"patch":{"tags":["IdentityProviders"],"operationId":"IdentityProvider_Update","description":"Updates an existing IdentityProvider configuration.","parameters":[{"$ref":"#/components/parameters/IdentityProviderNameParameter"},{"name":"If-Match","in":"header","required":true,"description":"The entity state (Etag) version of the identity provider configuration to update. A value of \"*\" can be used for If-Match to unconditionally apply the operation.","schema":{"type":"string"}},{"$ref":"./apimanagement.json#/components/parameters/ApiVersionParameter"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IdentityProviderUpdateParameters"}}},"description":"Update parameters.","required":true},"responses":{"204":{"description":"The existing identity provider configuration was successfully updated."},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"./apimanagement.json#/definitions/ErrorResponse"}}}}}},"delete":{"tags":["IdentityProvider"],"operationId":"IdentityProvider_Delete","description":"Deletes the specified identity provider configuration.","parameters":[{"$ref":"#/components/parameters/IdentityProviderNameParameter"},{"name":"If-Match","in":"header","required":true,"description":"The entity state (Etag) version of the backend to delete. A value of \"*\" can be used for If-Match to unconditionally apply the operation.","schema":{"type":"string"}},{"$ref":"./apimanagement.json#/components/parameters/ApiVersionParameter"}],"responses":{"204":{"description":"The identity provider configuration was successfully deleted."},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"./apimanagement.json#/definitions/ErrorResponse"}}}}}}}},"servers":[{"url":"{apimBaseUrl}","variables":{"apimBaseUrl":{"description":"The management endpoint of the API Management service, for example https://myapimservice.management.azure-api.net.","x-ms-skip-url-encoding":true,"default":""}}}],"components":{"parameters":{"IdentityProviderNameParameter":{"name":"identityProviderName","in":"path","required":true,"x-ms-enum":{"name":"IdentityProviderType","modelAsString":true,"values":[{"value":"facebook","description":"Facebook as Identity provider."},{"value":"google","description":"Google as Identity provider."},{"value":"microsoft","description":"Microsoft Live as Identity provider."},{"value":"twitter","description":"Twitter as Identity provider."},{"value":"aad","description":"Azure Active Directory as Identity provider."},{"value":"aadB2C","description":"Azure Active Directory B2C as Identity provider."}]},"description":"Identity Provider Type identifier.","x-ms-parameter-location":"method","schema":{"type":"string","enum":["facebook","google","microsoft","twitter","aad","aadB2C"]}}},"securitySchemes":{"apim_key":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"IdentityProviderContract":{"properties":{"id":{"type":"string","description":"Identifier of the identity provider."}},"allOf":[{"$ref":"#/components/schemas/IdentityProviderContractProperties"}],"description":"Identity Provider details."},"IdentityProviderContractProperties":{"properties":{"clientId":{"type":"string","description":"Client Id of the Application in the external Identity Provider. It is App ID for Facebook login, Client ID for Google login, App ID for Microsoft.","minLength":1},"clientSecret":{"type":"string","description":"Client secret of the Application in external Identity Provider, used to authenticate login request. For example, it is App Secret for Facebook login, API Key for Google login, Public Key for Microsoft.","minLength":1}},"allOf":[{"$ref":"#/components/schemas/IdentityProviderBaseParameters"}],"required":["clientId","clientSecret"],"description":"The external Identity Providers like Facebook, Google, Microsoft, Twitter or Azure Active Directory which can be used to enable access to the API Management service developer portal for all users."},"IdentityProviderList":{"properties":{"value":{"type":"array","items":{"$ref":"#/components/schemas/IdentityProviderContract"},"description":"Identity Provider configuration values."},"count":{"type":"integer","description":"Total number of identity providers"}},"description":"List of all the Identity Providers configured on the service instance."},"IdentityProviderUpdateParameters":{"properties":{"clientId":{"type":"string","description":"Client Id of the Application in the external Identity Provider. It is App ID for Facebook login, Client ID for Google login, App ID for Microsoft.","minLength":1},"clientSecret":{"type":"string","description":"Client secret of the Application in external Identity Provider, used to authenticate login request. For example, it is App Secret for Facebook login, API Key for Google login, Public Key for Microsoft.","minLength":1}},"allOf":[{"$ref":"#/components/schemas/IdentityProviderBaseParameters"}],"description":"Parameters supplied to the Update Identity Provider operation."},"IdentityProviderBaseParameters":{"properties":{"type":{"type":"string","enum":["facebook","google","microsoft","twitter","aad","aadB2C"],"x-ms-enum":{"name":"IdentityProviderType","modelAsString":true,"values":[{"value":"facebook","description":"Facebook as Identity provider."},{"value":"google","description":"Google as Identity provider."},{"value":"microsoft","description":"Microsoft Live as Identity provider."},{"value":"twitter","description":"Twitter as Identity provider."},{"value":"aad","description":"Azure Active Directory as Identity provider."},{"value":"aadB2C","description":"Azure Active Directory B2C as Identity provider."}]},"description":"Identity Provider Type identifier."},"allowedTenants":{"type":"array","items":{"type":"string"},"maxItems":32,"description":"List of Allowed Tenants when configuring Azure Active Directory login."},"signupPolicyName":{"type":"string","description":"Signup Policy Name. Only applies to AAD B2C Identity Provider.","minLength":1},"signinPolicyName":{"type":"string","description":"Signin Policy Name. Only applies to AAD B2C Identity Provider.","minLength":1},"profileEditingPolicyName":{"type":"string","description":"Profile Editing Policy Name. Only applies to AAD B2C Identity Provider.","minLength":1},"passwordResetPolicyName":{"type":"string","description":"Password Reset Policy Name. Only applies to AAD B2C Identity Provider.","minLength":1}},"description":"Identity Provider Base Parameter Properties."}}}}
/ identityProviders
/ identityProviders / {identityProviderName}
Azure API Management - Products OpenAPI	{"openapi":"3.0.0","info":{"title":"Azure API Management - Products","description":"Use these REST APIs for performing operations on Product entity associated with your Azure API Management deployment. The Product entity represents a product in API Management. Products include one or more APIs and their associated terms of use. Once a product is published, developers can subscribe to the product and begin to use the product’s APIs.","version":"2017-03-01"},"security":[{"apim_key":[]}],"paths":{"/products":{"get":{"tags":["Products"],"operationId":"Product_List","description":"Lists a collection of products in the specified service instance.","parameters":[{"name":"$filter","in":"query","required":false,"description":"| Field | Supported operators | Supported functions |\n|-------------|------------------------|---------------------------------------------|\n| id | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| name | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| description | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| terms | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| state | eq | |","schema":{"type":"string"}},{"$ref":"./apimanagement.json#/components/parameters/TopQueryParameter"},{"$ref":"./apimanagement.json#/components/parameters/SkipQueryParameter"},{"name":"expandGroups","in":"query","required":false,"description":"When set to true, the response contains an array of groups that have visibility to the product. The default is false.","schema":{"type":"boolean"}},{"$ref":"./apimanagement.json#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"A Collection of the Product entities for the specified API Management service instance.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductCollection"}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"./apimanagement.json#/definitions/ErrorResponse"}}}}},"x-ms-pageable":{"nextLinkName":"nextLink"},"x-ms-odata":"#/components/schemas/ProductContract"}},"/products/{productId}":{"get":{"tags":["Products"],"operationId":"Product_Get","description":"Gets the details of the product specified by its identifier.","parameters":[{"$ref":"#/components/parameters/ProductIdParameter"},{"$ref":"./apimanagement.json#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"The response body contains the specified Product entity.","headers":{"ETag":{"description":"Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductContract"}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"./apimanagement.json#/definitions/ErrorResponse"}}}}}},"put":{"tags":["Products"],"operationId":"Product_CreateOrUpdate","description":"Creates or Updates a product.","parameters":[{"$ref":"#/components/parameters/ProductIdParameter"},{"$ref":"./apimanagement.json#/components/parameters/ApiVersionParameter"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductContract"}}},"description":"Create or update parameters.","required":true},"responses":{"200":{"description":"Product was successfully updated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductContract"}}}},"201":{"description":"Product was successfully created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductContract"}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"./apimanagement.json#/definitions/ErrorResponse"}}}}}},"patch":{"tags":["Products"],"operationId":"Product_Update","description":"Update product.","parameters":[{"$ref":"#/components/parameters/ProductIdParameter"},{"name":"If-Match","in":"header","required":true,"description":"ETag of the Product Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.","schema":{"type":"string"}},{"$ref":"./apimanagement.json#/components/parameters/ApiVersionParameter"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductUpdateParameters"}}},"description":"Update parameters.","required":true},"responses":{"204":{"description":"No Content in case of Update Successful."},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"./apimanagement.json#/definitions/ErrorResponse"}}}}}},"delete":{"tags":["Products"],"operationId":"Product_Delete","description":"Delete product.","parameters":[{"$ref":"#/components/parameters/ProductIdParameter"},{"name":"deleteSubscriptions","in":"query","required":false,"description":"Delete existing subscriptions to the product or not.","schema":{"type":"boolean"}},{"name":"If-Match","in":"header","required":true,"description":"ETag of the Product Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.","schema":{"type":"string"}},{"$ref":"./apimanagement.json#/components/parameters/ApiVersionParameter"}],"responses":{"204":{"description":"The product was successfully deleted."},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"./apimanagement.json#/definitions/ErrorResponse"}}}}}}},"/products/{productId}/apis":{"get":{"tags":["ProductApis"],"operationId":"ProductApi_ListByProduct","description":"Lists a collection of the APIs associated with a product.","parameters":[{"$ref":"#/components/parameters/ProductIdParameter"},{"name":"$filter","in":"query","required":false,"description":"| Field | Supported operators | Supported functions |\n|-------------|------------------------|---------------------------------------------|\n| id | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| name | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| description | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| serviceUrl | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| path | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n","schema":{"type":"string"}},{"$ref":"./apimanagement.json#/components/parameters/TopQueryParameter"},{"$ref":"./apimanagement.json#/components/parameters/SkipQueryParameter"},{"$ref":"./apimanagement.json#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"The response body contains a collection of Api entities in the product.","content":{"application/json":{"schema":{"$ref":"./apimapis.json#/definitions/ApiCollection"}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"./apimanagement.json#/definitions/ErrorResponse"}}}}},"x-ms-pageable":{"nextLinkName":"nextLink"},"x-ms-odata":"./apimapis.json#/definitions/ApiContract"}},"/products/{productId}/apis/{apiId}":{"put":{"tags":["ProductApis"],"operationId":"ProductApi_CreateOrUpdate","description":"Adds an API to the specified product.","parameters":[{"$ref":"#/components/parameters/ProductIdParameter"},{"$ref":"./apimapis.json#/components/parameters/ApiIdParameter"},{"$ref":"./apimanagement.json#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"The specified API is already added to the product.","content":{"application/json":{"schema":{"$ref":"./apimapis.json#/definitions/ApiContract"}}}},"201":{"description":"The API was successfully added to the product.","content":{"application/json":{"schema":{"$ref":"./apimapis.json#/definitions/ApiContract"}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"./apimanagement.json#/definitions/ErrorResponse"}}}}}},"delete":{"tags":["ProductApis"],"operationId":"ProductApi_Delete","description":"Deletes the specified API from the specified product.","parameters":[{"$ref":"#/components/parameters/ProductIdParameter"},{"$ref":"./apimapis.json#/components/parameters/ApiIdParameter"},{"$ref":"./apimanagement.json#/components/parameters/ApiVersionParameter"}],"responses":{"204":{"description":"The API was successfully removed from the product."},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"./apimanagement.json#/definitions/ErrorResponse"}}}}}}},"/products/{productId}/groups":{"get":{"tags":["ProductGroups"],"operationId":"ProductGroup_ListByProduct","description":"Lists the collection of developer groups associated with the specified product.","parameters":[{"$ref":"#/components/parameters/ProductIdParameter"},{"name":"$filter","in":"query","required":false,"description":"| Field | Supported operators | Supported functions |\n|-------------|------------------------|---------------------------------------------|\n| id | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| name | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| description | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| type | eq, ne | N/A |","schema":{"type":"string"}},{"$ref":"./apimanagement.json#/components/parameters/TopQueryParameter"},{"$ref":"./apimanagement.json#/components/parameters/SkipQueryParameter"},{"$ref":"./apimanagement.json#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"Lists a collection of Group entities.","content":{"application/json":{"schema":{"$ref":"./apimgroups.json#/definitions/GroupCollection"}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"./apimanagement.json#/definitions/ErrorResponse"}}}}},"x-ms-pageable":{"nextLinkName":"nextLink"},"x-ms-odata":"./apimgroups.json#/definitions/GroupContract"}},"/products/{productId}/groups/{groupId}":{"put":{"tags":["ProductGroups"],"operationId":"ProductGroup_CreateOrUpdate","description":"Adds the association between the specified developer group with the specified product.","parameters":[{"$ref":"#/components/parameters/ProductIdParameter"},{"$ref":"./apimgroups.json#/components/parameters/GroupIdParameter"},{"$ref":"./apimanagement.json#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"The specified group is already associated with the product.","content":{"application/json":{"schema":{"$ref":"./apimgroups.json#/definitions/GroupContract"}}}},"201":{"description":"The group was successfully associated with the product.","content":{"application/json":{"schema":{"$ref":"./apimgroups.json#/definitions/GroupContract"}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"./apimanagement.json#/definitions/ErrorResponse"}}}}}},"delete":{"tags":["ProductGroups"],"operationId":"ProductGroup_Delete","description":"Deletes the association between the specified group and product.","parameters":[{"$ref":"#/components/parameters/ProductIdParameter"},{"$ref":"./apimgroups.json#/components/parameters/GroupIdParameter"},{"$ref":"./apimanagement.json#/components/parameters/ApiVersionParameter"}],"responses":{"204":{"description":"The group was successfully disassociated with the product."},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"./apimanagement.json#/definitions/ErrorResponse"}}}}}}},"/products/{productId}/subscriptions":{"get":{"tags":["ProductSubscriptions"],"operationId":"ProductSubscriptions_List","description":"Lists the collection of subscriptions to the specified product.","parameters":[{"$ref":"#/components/parameters/ProductIdParameter"},{"name":"$filter","in":"query","required":false,"description":"| Field | Supported operators | Supported functions |\n|--------------|------------------------|---------------------------------------------|\n| id | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| name | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| stateComment | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| userId | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| productId | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| state | eq | |","schema":{"type":"string"}},{"$ref":"./apimanagement.json#/components/parameters/TopQueryParameter"},{"$ref":"./apimanagement.json#/components/parameters/SkipQueryParameter"},{"$ref":"./apimanagement.json#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"Lists a collection of subscription entities.","content":{"application/json":{"schema":{"$ref":"./apimsubscriptions.json#/definitions/SubscriptionCollection"}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"./apimanagement.json#/definitions/ErrorResponse"}}}}},"x-ms-pageable":{"nextLinkName":"nextLink"},"x-ms-odata":"./apimsubscriptions.json#/definitions/SubscriptionContract"}},"/products/{productId}/policies":{"get":{"tags":["ProductPolicy"],"operationId":"ProductPolicy_ListByProduct","description":"Get the policy configuration at the Product level.","parameters":[{"$ref":"./apimanagement.json#/components/parameters/ApiVersionParameter"},{"$ref":"#/components/parameters/ProductIdParameter"}],"responses":{"200":{"description":"Product Policy information.","headers":{"ETag":{"description":"Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"./apimanagement.json#/definitions/PolicyCollection"}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"./apimanagement.json#/definitions/ErrorResponse"}}}}}}},"/products/{productId}/policies/{policyId}":{"get":{"tags":["ProductPolicy"],"operationId":"ProductPolicy_Get","description":"Get the policy configuration at the Product level.","parameters":[{"$ref":"./apimanagement.json#/components/parameters/ApiVersionParameter"},{"$ref":"#/components/parameters/ProductIdParameter"},{"$ref":"./apimanagement.json#/components/parameters/PolicyIdParameter"}],"responses":{"200":{"description":"Product Policy information.","headers":{"ETag":{"description":"Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"./apimanagement.json#/definitions/PolicyContract"}},"application/vnd.ms-azure-apim.policy+xml":{"schema":{"$ref":"./apimanagement.json#/definitions/PolicyContract"}},"application/vnd.ms-azure-apim.policy.raw+xml":{"schema":{"$ref":"./apimanagement.json#/definitions/PolicyContract"}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"./apimanagement.json#/definitions/ErrorResponse"}},"application/vnd.ms-azure-apim.policy+xml":{"schema":{"$ref":"./apimanagement.json#/definitions/ErrorResponse"}},"application/vnd.ms-azure-apim.policy.raw+xml":{"schema":{"$ref":"./apimanagement.json#/definitions/ErrorResponse"}}}}}},"put":{"tags":["ProductPolicy"],"operationId":"ProductPolicy_CreateOrUpdate","description":"Creates or updates policy configuration for the Product.","parameters":[{"$ref":"#/components/parameters/ProductIdParameter"},{"$ref":"./apimanagement.json#/components/parameters/PolicyIdParameter"},{"$ref":"./apimanagement.json#/components/parameters/ApiVersionParameter"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"./apimanagement.json#/definitions/PolicyContract"}},"application/vnd.ms-azure-apim.policy+xml":{"schema":{"$ref":"./apimanagement.json#/definitions/PolicyContract"}},"application/vnd.ms-azure-apim.policy.raw+xml":{"schema":{"$ref":"./apimanagement.json#/definitions/PolicyContract"}}},"description":"The policy contents to apply.","required":true},"responses":{"200":{"description":"Product policy configuration of the tenant was successfully updated.","content":{"application/json":{"schema":{"$ref":"./apimanagement.json#/definitions/PolicyContract"}}}},"201":{"description":"Product policy configuration was successfully created.","content":{"application/json":{"schema":{"$ref":"./apimanagement.json#/definitions/PolicyContract"}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"./apimanagement.json#/definitions/ErrorResponse"}}}}}},"delete":{"tags":["ProductPolicy"],"operationId":"ProductPolicy_Delete","description":"Deletes the policy configuration at the Product.","parameters":[{"$ref":"#/components/parameters/ProductIdParameter"},{"$ref":"./apimanagement.json#/components/parameters/PolicyIdParameter"},{"name":"If-Match","in":"header","required":true,"description":"The entity state (Etag) version of the product policy to update. A value of \"*\" can be used for If-Match to unconditionally apply the operation.","schema":{"type":"string"}},{"$ref":"./apimanagement.json#/components/parameters/ApiVersionParameter"}],"responses":{"204":{"description":"Successfully deleted the policy configuration at the Product level."},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"./apimanagement.json#/definitions/ErrorResponse"}}}}}}}},"servers":[{"url":"{apimBaseUrl}","variables":{"apimBaseUrl":{"description":"The management endpoint of the API Management service, for example https://myapimservice.management.azure-api.net.","x-ms-skip-url-encoding":true,"default":""}}}],"components":{"parameters":{"ProductIdParameter":{"name":"productId","in":"path","required":true,"description":"Product identifier. Must be unique in the current API Management service instance.","x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":256,"pattern":"^[^*#&+:<>?]+$"}}},"securitySchemes":{"apim_key":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"ProductCollection":{"properties":{"value":{"type":"array","items":{"$ref":"#/components/schemas/ProductContract"},"description":"Page values."},"count":{"type":"integer","description":"Total number of entities"},"nextLink":{"type":"string","description":"Next page link if any."}},"description":"Paged Products list representation."},"ProductContract":{"properties":{"id":{"type":"string","description":"Identifier of the Product entity."}},"allOf":[{"$ref":"#/components/schemas/ProductContractProperties"}],"description":"Product details."},"ProductContractProperties":{"properties":{"name":{"type":"string","description":"Product name.","minLength":1,"maxLength":300}},"allOf":[{"$ref":"#/components/schemas/ProductEntityBaseParameters"}],"required":["name"],"description":"Product profile."},"ProductEntityBaseParameters":{"properties":{"description":{"type":"string","description":"Product description. May include HTML formatting tags.","minLength":1,"maxLength":1000},"terms":{"type":"string","description":"Product terms of use. Developers trying to subscribe to the product will be presented and required to accept these terms before they can complete the subscription process."},"subscriptionRequired":{"description":"Whether a product subscription is required for accessing APIs included in this product. If true, the product is referred to as \"protected\" and a valid subscription key is required for a request to an API included in the product to succeed. If false, the product is referred to as \"open\" and requests to an API included in the product can be made without a subscription key. If property is omitted when creating a new product it's value is assumed to be true.","type":"boolean"},"approvalRequired":{"description":"whether subscription approval is required. If false, new subscriptions will be approved automatically enabling developers to call the product’s APIs immediately after subscribing. If true, administrators must manually approve the subscription before the developer can any of the product’s APIs. Can be present only if subscriptionRequired property is present and has a value of true.","type":"boolean"},"subscriptionsLimit":{"type":"integer","format":"int32","description":"Whether the number of subscriptions a user can have to this product at the same time. Set to null or omit to allow unlimited per user subscriptions. Can be present only if subscriptionRequired property is present and has a value of true."},"state":{"type":"string","description":"whether product is published or not. Published products are discoverable by users of developer portal. Non published products are visible only to administrators. Default state of Product is notPublished.","enum":["notPublished","published"],"x-ms-enum":{"name":"ProductState","modelAsString":false}}},"description":"Product Entity Base Parameters"},"ProductUpdateParameters":{"properties":{"name":{"type":"string","description":"Product name.","maxLength":300,"minLength":1}},"allOf":[{"$ref":"#/components/schemas/ProductEntityBaseParameters"}],"description":"Parameters supplied to the Update Product operation."}}}}
/ products
/ products / {productId}
/ products / {productId} / apis
/ products / {productId} / apis / {apiId}
/ products / {productId} / groups
/ products / {productId} / groups / {groupId}
/ products / {productId} / subscriptions
/ products / {productId} / policies
/ products / {productId} / policies / {policyId}
Azure API Management - Groups OpenAPI	{"openapi":"3.0.0","info":{"title":"Azure API Management - Groups","description":"Use these REST APIs for performing operations on Group entity in your Azure API Management deployment. Groups are used to manage the visibility of products to developers. Each API Management service instance comes with the following immutable system groups whose membership is automatically managed by API Management. - **Administrators** - Azure subscription administrators are members of this group. - **Developers** - Authenticated developer portal users fall into this group. - **Guests** - Unauthenticated developer portal users are placed into this group. In addition to these system groups, administrators can create custom groups or [leverage external groups in associated Azure Active Directory tenants](https://docs.microsoft.com/en-us/azure/api-management/api-management-howto-aad#how-to-add-an-external-azure-active-directory-group). Custom and external groups can be used alongside system groups in giving developers visibility and access to API products. For example, you could create one custom group for developers affiliated with a specific partner organization and allow them access to the APIs from a product containing relevant APIs only. A user can be a member of more than one group.","version":"2017-03-01"},"security":[{"apim_key":[]}],"paths":{"/groups":{"get":{"tags":["Groups"],"operationId":"Group_List","description":"Lists a collection of groups defined within a service instance.","externalDocs":{"url":"https://docs.microsoft.com/en-us/azure/api-management/api-management-howto-create-groups"},"parameters":[{"name":"$filter","in":"query","required":false,"description":"| Field | Supported operators | Supported functions |\n|-------------|------------------------|---------------------------------------------|\n| id | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| name | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| description | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| type | eq, ne | N/A |","schema":{"type":"string"}},{"$ref":"./apimanagement.json#/components/parameters/TopQueryParameter"},{"$ref":"./apimanagement.json#/components/parameters/SkipQueryParameter"},{"$ref":"./apimanagement.json#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"Lists a collection of Group entities.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GroupCollection"}}}}},"x-ms-pageable":{"nextLinkName":"nextLink"},"x-ms-odata":"#/components/schemas/GroupContract"}},"/groups/{groupId}":{"get":{"tags":["Groups"],"operationId":"Group_Get","description":"Gets the details of the group specified by its identifier.","parameters":[{"$ref":"#/components/parameters/GroupIdParameter"},{"$ref":"./apimanagement.json#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"The response body contains the specified Group entity.","headers":{"ETag":{"description":"Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GroupContract"}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"./apimanagement.json#/definitions/ErrorResponse"}}}}}},"put":{"tags":["Groups"],"operationId":"Group_CreateOrUpdate","description":"Creates or Updates a group.","parameters":[{"$ref":"#/components/parameters/GroupIdParameter"},{"$ref":"./apimanagement.json#/components/parameters/ApiVersionParameter"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GroupCreateParameters"}}},"description":"Create parameters.","required":true},"responses":{"200":{"description":"Group already exists.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GroupContract"}}}},"201":{"description":"Group was created successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GroupContract"}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"./apimanagement.json#/definitions/ErrorResponse"}}}}}},"patch":{"tags":["Groups"],"operationId":"Group_Update","description":"Updates the details of the group specified by its identifier.","parameters":[{"$ref":"#/components/parameters/GroupIdParameter"},{"name":"If-Match","in":"header","required":true,"description":"ETag of the Group Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.","schema":{"type":"string"}},{"$ref":"./apimanagement.json#/components/parameters/ApiVersionParameter"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GroupUpdateParameters"}}},"description":"Update parameters.","required":true},"responses":{"204":{"description":"The group details were successfully updated."},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"./apimanagement.json#/definitions/ErrorResponse"}}}}}},"delete":{"tags":["Groups"],"operationId":"Group_Delete","description":"Deletes specific group of the API Management service instance.","parameters":[{"$ref":"#/components/parameters/GroupIdParameter"},{"name":"If-Match","in":"header","required":true,"description":"ETag of the Group Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.","schema":{"type":"string"}},{"$ref":"./apimanagement.json#/components/parameters/ApiVersionParameter"}],"responses":{"204":{"description":"The group was successfully deleted."},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"./apimanagement.json#/definitions/ErrorResponse"}}}}}}},"/groups/{groupId}/users":{"get":{"tags":["GroupUsers"],"operationId":"GroupUser_List","description":"Lists a collection of the members of the group, specified by its identifier.","parameters":[{"$ref":"#/components/parameters/GroupIdParameter"},{"name":"$filter","in":"query","required":false,"description":"| Field | Supported operators | Supported functions |\n|------------------|------------------------|-----------------------------------|\n| id | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| firstName | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| lastName | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| email | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| state | eq | N/A |\n| registrationDate | ge, le, eq, ne, gt, lt | N/A |\n| note | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |","schema":{"type":"string"}},{"$ref":"./apimanagement.json#/components/parameters/TopQueryParameter"},{"$ref":"./apimanagement.json#/components/parameters/SkipQueryParameter"},{"$ref":"./apimanagement.json#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"Lists a collection of user entities associated with the group.","content":{"application/json":{"schema":{"$ref":"./apimusers.json#/definitions/UserCollection"}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"./apimanagement.json#/definitions/ErrorResponse"}}}}},"x-ms-pageable":{"nextLinkName":"nextLink"},"x-ms-odata":"./apimusers.json#/definitions/UserContract"}},"/groups/{groupId}/users/{uid}":{"put":{"tags":["GroupUsers"],"operationId":"GroupUser_Create","description":"Adds a user to the specified group.","parameters":[{"$ref":"#/components/parameters/GroupIdParameter"},{"$ref":"./apimusers.json#/components/parameters/UserIdParameter"},{"$ref":"./apimanagement.json#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"The specified user is already a member of the specified group.","content":{"application/json":{"schema":{"$ref":"./apimusers.json#/definitions/UserContract"}}}},"201":{"description":"The user was successfully added to the group.","content":{"application/json":{"schema":{"$ref":"./apimusers.json#/definitions/UserContract"}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"./apimanagement.json#/definitions/ErrorResponse"}}}}}},"delete":{"tags":["GroupUsers"],"operationId":"GroupUser_Delete","description":"Remove existing user from existing group.","parameters":[{"$ref":"#/components/parameters/GroupIdParameter"},{"$ref":"./apimusers.json#/components/parameters/UserIdParameter"},{"$ref":"./apimanagement.json#/components/parameters/ApiVersionParameter"}],"responses":{"204":{"description":"The user was successfully removed from the group."},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"./apimanagement.json#/definitions/ErrorResponse"}}}}}}}},"servers":[{"url":"{apimBaseUrl}","variables":{"apimBaseUrl":{"description":"The management endpoint of the API Management service, for example https://myapimservice.management.azure-api.net.","x-ms-skip-url-encoding":true,"default":""}}}],"components":{"parameters":{"GroupIdParameter":{"name":"groupId","in":"path","required":true,"description":"Group identifier. Must be unique in the current API Management service instance.","x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":256,"pattern":"^[^*#&+:<>?]+$"}}},"securitySchemes":{"apim_key":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"GroupCollection":{"properties":{"value":{"type":"array","items":{"$ref":"#/components/schemas/GroupContract"},"description":"Page values."},"count":{"type":"integer","description":"Total number of entities"},"nextLink":{"type":"string","description":"Next page link if any."}},"description":"Paged Group list representation."},"GroupContract":{"properties":{"id":{"type":"string","description":"Identifier of the Group entity."}},"allOf":[{"$ref":"#/components/schemas/GroupContractProperties"}],"description":"Contract details."},"GroupContractProperties":{"properties":{"name":{"type":"string","description":"Group name.","maxLength":300,"minLength":1},"description":{"type":"string","description":"Group description. Can contain HTML formatting tags.","maxLength":1000},"builtIn":{"readOnly":true,"type":"boolean","description":"true if the group is one of the three system groups (Administrators, Developers, or Guests); otherwise false."},"type":{"type":"string","description":"Group type.","enum":["custom","system","external"],"x-ms-enum":{"name":"GroupType","modelAsString":false}},"externalId":{"type":"string","description":"For external groups, this property contains the id of the group from the external identity provider, e.g. for Azure Active Directory aad://.onmicrosoft.com/groups/; otherwise the value is null."}},"required":["name"],"description":"Developer group."},"GroupCreateParameters":{"properties":{"name":{"type":"string","description":"Group name.","maxLength":300,"minLength":1},"description":{"type":"string","description":"Group description."},"type":{"type":"string","description":"Group type.","enum":["custom","system","external"],"x-ms-enum":{"name":"GroupType","modelAsString":false}},"externalId":{"type":"string","description":"Identifier of the external groups, this property contains the id of the group from the external identity provider, e.g. for Azure Active Directory aad://.onmicrosoft.com/groups/; otherwise the value is null."}},"required":["name"],"description":"Parameters supplied to the Create Group operation."},"GroupUpdateParameters":{"properties":{"name":{"type":"string","description":"Group name.","maxLength":300,"minLength":1},"description":{"type":"string","description":"Group description."},"type":{"type":"string","description":"Group type.","enum":["custom","system","external"],"x-ms-enum":{"name":"GroupType","modelAsString":false}},"externalId":{"type":"string","description":"Identifier of the external groups, this property contains the id of the group from the external identity provider, e.g. for Azure Active Directory aad://.onmicrosoft.com/groups/; otherwise the value is null."}},"description":"Parameters supplied to the Update Group operation."}}}}
/ groups
/ groups / {groupId}
/ groups / {groupId} / users
/ groups / {groupId} / users / {uid}
Azure API Management - Subscriptions OpenAPI	{"openapi":"3.0.0","info":{"title":"Azure API Management - Subscriptions","description":"Use these REST APIs for performing operations on Subscription entity associated with your Azure API Management deployment. The Subscription entity represents the association between a user and a product in API Management. Products contain one or more APIs, and once a product is published, developers can subscribe to the product and begin to use the product’s APIs.","version":"2017-03-01"},"security":[{"apim_key":[]}],"paths":{"/subscriptions":{"get":{"tags":["Subscriptions"],"operationId":"Subscription_List","description":"Lists all subscriptions of the API Management service instance.","parameters":[{"name":"$filter","in":"query","required":false,"description":"| Field | Supported operators | Supported functions |\n|--------------|------------------------|---------------------------------------------|\n| id | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| name | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| stateComment | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| userId | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| productId | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| state | eq | |","schema":{"type":"string"}},{"$ref":"./apimanagement.json#/components/parameters/TopQueryParameter"},{"$ref":"./apimanagement.json#/components/parameters/SkipQueryParameter"},{"$ref":"./apimanagement.json#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"A collection of the Subscription entities for the specified API Management service instance.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubscriptionCollection"}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"./apimanagement.json#/definitions/ErrorResponse"}}}}},"x-ms-pageable":{"nextLinkName":"nextLink"},"x-ms-odata":"#/components/schemas/SubscriptionContract"}},"/subscriptions/{sid}":{"get":{"tags":["Subscriptions"],"operationId":"Subscription_Get","description":"Gets the specified Subscription entity.","parameters":[{"$ref":"#/components/parameters/SubscriptionEntityIdParameter"},{"$ref":"./apimanagement.json#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"The response body contains the specified Subscription entity.","headers":{"ETag":{"description":"Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubscriptionContract"}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"./apimanagement.json#/definitions/ErrorResponse"}}}}}},"put":{"tags":["Subscriptions"],"operationId":"Subscription_CreateOrUpdate","description":"Creates or updates the subscription of specified user to the specified product.","parameters":[{"$ref":"#/components/parameters/SubscriptionEntityIdParameter"},{"name":"notify","in":"query","required":false,"description":"Notify the subscriber of the subscription state change to Submitted or Active state.","schema":{"type":"string","enum":["False","True"],"default":"False"}},{"$ref":"./apimanagement.json#/components/parameters/ApiVersionParameter"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubscriptionCreateParameters"}}},"description":"Create parameters.","required":true},"responses":{"200":{"description":"The user already subscribed to the product.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubscriptionContract"}}}},"201":{"description":"The user was successfully subscribed to the product.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubscriptionContract"}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"./apimanagement.json#/definitions/ErrorResponse"}}}}}},"patch":{"tags":["Subscriptions"],"operationId":"Subscription_Update","description":"Updates the details of a subscription specified by its identifier.","parameters":[{"$ref":"#/components/parameters/SubscriptionEntityIdParameter"},{"name":"If-Match","in":"header","required":true,"description":"ETag of the Subscription Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.","schema":{"type":"string"}},{"name":"notify","in":"query","required":false,"description":"Notify the subscriber of the subscription state change to Submitted or Active state.","schema":{"type":"string","enum":["False","True"],"default":"False"}},{"$ref":"./apimanagement.json#/components/parameters/ApiVersionParameter"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubscriptionUpdateParameters"}}},"description":"Update parameters.","required":true},"responses":{"204":{"description":"The subscription details were successfully updated."},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"./apimanagement.json#/definitions/ErrorResponse"}}}}}},"delete":{"tags":["Subscriptions"],"operationId":"Subscription_Delete","description":"Deletes the specified subscription.","parameters":[{"$ref":"#/components/parameters/SubscriptionEntityIdParameter"},{"name":"If-Match","in":"header","required":true,"description":"ETag of the Subscription Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.","schema":{"type":"string"}},{"$ref":"./apimanagement.json#/components/parameters/ApiVersionParameter"}],"responses":{"204":{"description":"The subscription details were successfully deleted."},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"./apimanagement.json#/definitions/ErrorResponse"}}}}}}},"/subscriptions/{sid}/regeneratePrimaryKey":{"post":{"tags":["Subscriptions"],"operationId":"Subscription_RegeneratePrimaryKey","description":"Regenerates primary key of existing subscription of the API Management service instance.","parameters":[{"$ref":"#/components/parameters/SubscriptionEntityIdParameter"},{"$ref":"./apimanagement.json#/components/parameters/ApiVersionParameter"}],"responses":{"204":{"description":"The primary key was successfully regenerated."},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"./apimanagement.json#/definitions/ErrorResponse"}}}}}}},"/subscriptions/{sid}/regenerateSecondaryKey":{"post":{"tags":["Subscriptions"],"operationId":"Subscription_RegenerateSecondaryKey","description":"Regenerates secondary key of existing subscription of the API Management service instance.","parameters":[{"$ref":"#/components/parameters/SubscriptionEntityIdParameter"},{"$ref":"./apimanagement.json#/components/parameters/ApiVersionParameter"}],"responses":{"204":{"description":"The secondary key was successfully regenerated."},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"./apimanagement.json#/definitions/ErrorResponse"}}}}}}}},"servers":[{"url":"{apimBaseUrl}","variables":{"apimBaseUrl":{"description":"The management endpoint of the API Management service, for example https://myapimservice.management.azure-api.net.","x-ms-skip-url-encoding":true,"default":""}}}],"components":{"parameters":{"SubscriptionEntityIdParameter":{"name":"sid","in":"path","required":true,"description":"Subscription entity Identifier. The entity represents the association between a user and a product in API Management.","x-ms-parameter-location":"method","schema":{"type":"string","maxLength":256,"pattern":"^[^*#&+:<>?]+$"}}},"securitySchemes":{"apim_key":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"SubscriptionCollection":{"properties":{"value":{"type":"array","items":{"$ref":"#/components/schemas/SubscriptionContract"},"description":"Page values."},"count":{"type":"integer","description":"Total number of entities"},"nextLink":{"type":"string","description":"Next page link if any."}},"description":"Paged Subscriptions list representation."},"SubscriptionContract":{"properties":{"id":{"type":"string","description":"Identifier of the Subscription."}},"allOf":[{"$ref":"#/components/schemas/SubscriptionContractProperties"}],"description":"Subscription details."},"SubscriptionContractProperties":{"properties":{"userId":{"type":"string","description":"The user resource identifier of the subscription owner. The value is a valid relative URL in the format of /users/{uid} where {uid} is a user identifier."},"productId":{"type":"string","description":"The product resource identifier of the subscribed product. The value is a valid relative URL in the format of /products/{productId} where {productId} is a product identifier."},"name":{"type":"string","description":"The name of the subscription, or null if the subscription has no name.","minLength":0,"maxLength":100},"state":{"type":"string","description":"Subscription state. Possible states are * active – the subscription is active, * suspended – the subscription is blocked, and the subscriber cannot call any APIs of the product, * submitted – the subscription request has been made by the developer, but has not yet been approved or rejected, * rejected – the subscription request has been denied by an administrator, * cancelled – the subscription has been cancelled by the developer or administrator, * expired – the subscription reached its expiration date and was deactivated.","enum":["suspended","active","expired","submitted","rejected","cancelled"],"x-ms-enum":{"name":"SubscriptionState","modelAsString":false}},"createdDate":{"type":"string","format":"date-time","description":"Subscription creation date. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard.\n","readOnly":true},"startDate":{"type":"string","format":"date-time","description":"Subscription activation date. The setting is for audit purposes only and the subscription is not automatically activated. The subscription lifecycle can be managed by using the `state` property. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard.\n"},"expirationDate":{"type":"string","format":"date-time","description":"Subscription expiration date. The setting is for audit purposes only and the subscription is not automatically expired. The subscription lifecycle can be managed by using the `state` property. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard.\n"},"endDate":{"type":"string","format":"date-time","description":"Date when subscription was cancelled or expired. The setting is for audit purposes only and the subscription is not automatically cancelled. The subscription lifecycle can be managed by using the `state` property. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard.\n"},"notificationDate":{"type":"string","format":"date-time","description":"Upcoming subscription expiration notification date. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard.\n"},"primaryKey":{"type":"string","description":"Subscription primary key.","minLength":1,"maxLength":256},"secondaryKey":{"type":"string","description":"Subscription secondary key.","minLength":1,"maxLength":256},"stateComment":{"type":"string","description":"Optional subscription comment added by an administrator."}},"required":["userId","productId","state","primaryKey","secondaryKey"],"description":"Subscription details."},"SubscriptionCreateParameters":{"properties":{"userId":{"type":"string","description":"User (user id path) for whom subscription is being created in form /users/{uid}"},"productId":{"type":"string","description":"Product (product id path) for which subscription is being created in form /products/{productId}"},"name":{"type":"string","description":"Subscription name.","minLength":0,"maxLength":100},"primaryKey":{"type":"string","description":"Primary subscription key. If not specified during request key will be generated automatically.","minLength":1,"maxLength":256},"secondaryKey":{"type":"string","description":"Secondary subscription key. If not specified during request key will be generated automatically.","minLength":1,"maxLength":256},"state":{"type":"string","description":"Initial subscription state. If no value is specified, subscription is created with Submitted state. Possible states are * active – the subscription is active, * suspended – the subscription is blocked, and the subscriber cannot call any APIs of the product, * submitted – the subscription request has been made by the developer, but has not yet been approved or rejected, * rejected – the subscription request has been denied by an administrator, * cancelled – the subscription has been cancelled by the developer or administrator, * expired – the subscription reached its expiration date and was deactivated.","enum":["suspended","active","expired","submitted","rejected","cancelled"],"x-ms-enum":{"name":"SubscriptionState","modelAsString":false}}},"required":["userId","productId"],"description":"Parameters supplied to the Create subscription operation."},"SubscriptionUpdateParameters":{"properties":{"userId":{"type":"string","description":"User identifier path: /users/{uid}"},"productId":{"type":"string","description":"Product identifier path: /products/{productId}"},"expirationDate":{"type":"string","format":"date-time","description":"Subscription expiration date. The setting is for audit purposes only and the subscription is not automatically expired. The subscription lifecycle can be managed by using the `state` property. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard."},"name":{"type":"string","description":"Subscription name."},"primaryKey":{"type":"string","description":"Primary subscription key.","minLength":1,"maxLength":256},"secondaryKey":{"type":"string","description":"Secondary subscription key.","minLength":1,"maxLength":256},"state":{"type":"string","description":"Subscription state. Possible states are * active – the subscription is active, * suspended – the subscription is blocked, and the subscriber cannot call any APIs of the product, * submitted – the subscription request has been made by the developer, but has not yet been approved or rejected, * rejected – the subscription request has been denied by an administrator, * cancelled – the subscription has been cancelled by the developer or administrator, * expired – the subscription reached its expiration date and was deactivated.","enum":["suspended","active","expired","submitted","rejected","cancelled"],"x-ms-enum":{"name":"SubscriptionState","modelAsString":false}},"stateComment":{"type":"string","description":"Comments describing subscription state change by the administrator."}},"description":"Parameters supplied to the Update subscription operation."}}}}
/ subscriptions
/ subscriptions / {sid}
/ subscriptions / {sid} / regeneratePrimaryKey
/ subscriptions / {sid} / regenerateSecondaryKey
Azure API Management - OpenID Connect Providers OpenAPI	{"openapi":"3.0.0","info":{"title":"Azure API Management - OpenID Connect Providers","description":"Use these REST APIs for performing operations on OpenId Connect Provider entity associated with your Azure API Management deployment. API Management allows you to access APIs secured with token from [OpenID Connect Provider ](http://openid.net/connect/) to be accessed from the Developer Console.","version":"2017-03-01"},"security":[{"apim_key":[]}],"paths":{"/openidConnectProviders":{"get":{"tags":["OpenIdConnectProviders"],"operationId":"OpenIdConnectProvider_List","description":"Lists all OpenID Connect Providers.","parameters":[{"name":"$filter","in":"query","required":false,"description":"| Field | Supported operators | Supported functions |\n|-------|------------------------|---------------------------------------------|\n| id | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| name | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |","schema":{"type":"string"}},{"$ref":"./apimanagement.json#/components/parameters/TopQueryParameter"},{"$ref":"./apimanagement.json#/components/parameters/SkipQueryParameter"},{"$ref":"./apimanagement.json#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"Lists of all the OpenId Connect Providers.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenIdConnectProviderCollection"}}}}},"x-ms-pageable":{"nextLinkName":"nextLink"},"x-ms-odata":"#/components/schemas/OpenidConnectProviderContract"}},"/openidConnectProviders/{opid}":{"get":{"tags":["OpenIdConnectProviders"],"operationId":"OpenIdConnectProvider_Get","description":"Gets specific OpenID Connect Provider.","parameters":[{"$ref":"#/components/parameters/OpenIdConnectIdParameter"},{"$ref":"./apimanagement.json#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"The response body contains the specified OpenId Connect Provider entity.","headers":{"ETag":{"description":"Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenidConnectProviderContract"}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"./apimanagement.json#/definitions/ErrorResponse"}}}}}},"put":{"tags":["OpenIdConnectProviders"],"operationId":"OpenIdConnectProvider_CreateOrUpdate","description":"Creates or updates the OpenID Connect Provider.","parameters":[{"$ref":"#/components/parameters/OpenIdConnectIdParameter"},{"$ref":"./apimanagement.json#/components/parameters/ApiVersionParameter"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenidConnectProviderContract"}}},"description":"Create parameters.","required":true},"responses":{"200":{"description":"OpenIdConnect Provider was successfully updated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenidConnectProviderContract"}}}},"201":{"description":"OpenIdConnect Provider was successfully created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenidConnectProviderContract"}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"./apimanagement.json#/definitions/ErrorResponse"}}}}}},"patch":{"tags":["OpenIdConnectProviders"],"operationId":"OpenIdConnectProvider_Update","description":"Updates the specific OpenID Connect Provider.","parameters":[{"$ref":"#/components/parameters/OpenIdConnectIdParameter"},{"name":"If-Match","in":"header","required":true,"description":"The entity state (Etag) version of the OpenID Connect Provider to update. A value of \"*\" can be used for If-Match to unconditionally apply the operation.","schema":{"type":"string"}},{"$ref":"./apimanagement.json#/components/parameters/ApiVersionParameter"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenidConnectProviderUpdateContract"}}},"description":"Update parameters.","required":true},"responses":{"204":{"description":"OpenId Connect Provider was successfully updated."},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"./apimanagement.json#/definitions/ErrorResponse"}}}}}},"delete":{"tags":["OpenIdConnectProviders"],"operationId":"OpenIdConnectProvider_Delete","description":"Deletes specific OpenID Connect Provider of the API Management service instance.","parameters":[{"$ref":"#/components/parameters/OpenIdConnectIdParameter"},{"name":"If-Match","in":"header","required":true,"description":"The entity state (Etag) version of the OpenID Connect Provider to delete. A value of \"*\" can be used for If-Match to unconditionally apply the operation.","schema":{"type":"string"}},{"$ref":"./apimanagement.json#/components/parameters/ApiVersionParameter"}],"responses":{"204":{"description":"OpenId Connect Provider was successfully deleted."},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"./apimanagement.json#/definitions/ErrorResponse"}}}}}}}},"servers":[{"url":"{apimBaseUrl}","variables":{"apimBaseUrl":{"description":"The management endpoint of the API Management service, for example https://myapimservice.management.azure-api.net.","x-ms-skip-url-encoding":true,"default":""}}}],"components":{"parameters":{"OpenIdConnectIdParameter":{"name":"opid","in":"path","required":true,"description":"Identifier of the OpenID Connect Provider.","x-ms-parameter-location":"method","schema":{"type":"string","maxLength":256,"pattern":"^[^*#&+:<>?]+$"}}},"securitySchemes":{"apim_key":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"OpenIdConnectProviderCollection":{"properties":{"value":{"type":"array","items":{"$ref":"#/components/schemas/OpenidConnectProviderContract"},"description":"Page values."},"count":{"type":"integer","description":"Total number of entities"},"nextLink":{"type":"string","description":"Next page link if any."}},"description":"Paged OpenIdProviders list representation."},"OpenidConnectProviderContract":{"properties":{"id":{"type":"string","description":"Identifier of the OpenId Connect Provider."}},"allOf":[{"$ref":"#/components/schemas/OpenidConnectProviderContractProperties"}],"description":"OpenId Connect Provider details."},"OpenidConnectProviderContractProperties":{"properties":{"name":{"type":"string","description":"User-friendly OpenID Connect Provider name.","maxLength":50},"description":{"type":"string","description":"User-friendly description of OpenID Connect Provider."},"metadataEndpoint":{"type":"string","description":"Metadata endpoint URI."},"clientId":{"type":"string","description":"Client ID of developer console which is the client application."},"clientSecret":{"type":"string","description":"Client Secret of developer console which is the client application."}},"required":["name","metadataEndpoint","clientId"],"description":"OpenID Connect Providers Contract."},"OpenidConnectProviderUpdateContract":{"properties":{"name":{"type":"string","description":"User-friendly OpenID Connect Provider name.","maxLength":50},"description":{"type":"string","description":"User-friendly description of OpenID Connect Provider."},"metadataEndpoint":{"type":"string","description":"Metadata endpoint URI."},"clientId":{"type":"string","description":"Client ID of developer console which is the client application."},"clientSecret":{"type":"string","description":"Client Secret of developer console which is the client application."}},"description":"Parameters supplied to the Update OpenID Connect Provider operation."}}}}
/ openidConnectProviders
/ openidConnectProviders / {opid}
Azure API Management - APIs OpenAPI	{"openapi":"3.0.0","info":{"title":"Azure API Management - APIs","description":"Use these REST APIs for performing operations on API entity and their Operations associated with your Azure API Management deployment.","version":"2017-03-01"},"security":[{"apim_key":[]}],"paths":{"/apis":{"get":{"tags":["Apis"],"operationId":"Api_List","description":"Lists all APIs of the API Management service instance.","externalDocs":{"url":"https://docs.microsoft.com/en-us/azure/api-management/api-management-howto-create-apis"},"parameters":[{"name":"$filter","in":"query","required":false,"description":"| Field | Supported operators | Supported functions |\n|-------------|------------------------|-----------------------------------|\n| id | ge, le, eq, ne, gt, lt | substringof, startswith, endswith |\n| name | ge, le, eq, ne, gt, lt | substringof, startswith, endswith |\n| description | ge, le, eq, ne, gt, lt | substringof, startswith, endswith |\n| serviceUrl | ge, le, eq, ne, gt, lt | substringof, startswith, endswith |\n| path | ge, le, eq, ne, gt, lt | substringof, startswith, endswith |","schema":{"type":"string"}},{"$ref":"./apimanagement.json#/components/parameters/TopQueryParameter"},{"$ref":"./apimanagement.json#/components/parameters/SkipQueryParameter"},{"$ref":"./apimanagement.json#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"Paged Result response of Apis.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiCollection"}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"./apimanagement.json#/definitions/ErrorResponse"}}}}},"x-ms-pageable":{"nextLinkName":"nextLink"},"x-ms-odata":"#/components/schemas/ApiContract"}},"/apis/{apiId}":{"get":{"tags":["Apis"],"operationId":"Api_Get","description":"Gets the details of the API specified by its identifier.","parameters":[{"$ref":"#/components/parameters/ApiIdParameter"},{"$ref":"./apimanagement.json#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"The response body contains the specified API entity.","headers":{"ETag":{"description":"Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiContract"}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"./apimanagement.json#/definitions/ErrorResponse"}}}}}},"put":{"tags":["Apis"],"operationId":"Api_CreateOrUpdate","description":"Creates new or updates existing specified API of the API Management service instance.","parameters":[{"$ref":"#/components/parameters/ApiIdParameter"},{"name":"If-Match","in":"header","required":false,"description":"ETag of the Api Entity. For Create Api Etag should not be specified. For Update Etag should match the existing Entity or it can be * for unconditional update.","schema":{"type":"string"}},{"$ref":"./apimanagement.json#/components/parameters/ApiVersionParameter"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiCreateOrUpdateParameter"}}},"description":"Create or update parameters.","required":true},"responses":{"200":{"description":"API was successfully updated.","headers":{"ETag":{"description":"Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiContract"}}}},"201":{"description":"API was successfully created.","headers":{"ETag":{"description":"Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiContract"}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"./apimanagement.json#/definitions/ErrorResponse"}}}}}},"patch":{"tags":["Apis"],"operationId":"Api_Update","description":"Updates the specified API of the API Management service instance.","parameters":[{"$ref":"#/components/parameters/ApiIdParameter"},{"name":"If-Match","in":"header","required":true,"description":"ETag of the API entity. ETag should match the current entity state in the header response of the GET request or it should be * for unconditional update.","schema":{"type":"string"}},{"$ref":"./apimanagement.json#/components/parameters/ApiVersionParameter"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiUpdateContract"}}},"description":"API Update Contract parameters.","required":true},"responses":{"204":{"description":"The API was successfully updated."},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"./apimanagement.json#/definitions/ErrorResponse"}}}}}},"delete":{"tags":["Apis"],"operationId":"Api_Delete","description":"Deletes the specified API of the API Management service instance.","parameters":[{"$ref":"#/components/parameters/ApiIdParameter"},{"name":"If-Match","in":"header","required":true,"description":"ETag of the API Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.","schema":{"type":"string"}},{"$ref":"./apimanagement.json#/components/parameters/ApiVersionParameter"}],"responses":{"204":{"description":"The API was successfully deleted."},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"./apimanagement.json#/definitions/ErrorResponse"}}}}}}},"/apis/{apiId}/operations":{"get":{"tags":["Operations"],"operationId":"ApiOperation_ListByApi","description":"Lists a collection of the operations for the specified API.","parameters":[{"$ref":"#/components/parameters/ApiIdParameter"},{"name":"$filter","in":"query","required":false,"description":"| Field | Supported operators | Supported functions |\n|-------------|------------------------|-----------------------------------|\n| name | ge, le, eq, ne, gt, lt | substringof, startswith, endswith |\n| method | ge, le, eq, ne, gt, lt | substringof, startswith, endswith |\n| description | ge, le, eq, ne, gt, lt | substringof, startswith, endswith |\n| urlTemplate | ge, le, eq, ne, gt, lt | substringof, startswith, endswith |","schema":{"type":"string"}},{"$ref":"./apimanagement.json#/components/parameters/TopQueryParameter"},{"$ref":"./apimanagement.json#/components/parameters/SkipQueryParameter"},{"$ref":"./apimanagement.json#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"A collection of operation summary entities at the API level.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationCollection"}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"./apimanagement.json#/definitions/ErrorResponse"}}}}},"x-ms-pageable":{"nextLinkName":"nextLink"},"x-ms-odata":"#/components/schemas/OperationContract"}},"/apis/{apiId}/operations/{operationId}":{"get":{"tags":["Operations"],"operationId":"ApiOperation_Get","description":"Gets the details of the API Operation specified by its identifier.","parameters":[{"$ref":"#/components/parameters/ApiIdParameter"},{"$ref":"#/components/parameters/OperationIdParameter"},{"$ref":"./apimanagement.json#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"The response body contains the specified Operation entity.","headers":{"ETag":{"description":"Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationContract"}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"./apimanagement.json#/definitions/ErrorResponse"}}}}}},"put":{"tags":["Operations"],"operationId":"ApiOperation_CreateOrUpdate","description":"Creates a new operation in the API or updates an existing one.","parameters":[{"$ref":"#/components/parameters/ApiIdParameter"},{"$ref":"#/components/parameters/OperationIdParameter"},{"$ref":"./apimanagement.json#/components/parameters/ApiVersionParameter"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationContract"}}},"description":"Create parameters.","required":true},"responses":{"200":{"description":"Operation was successfully updated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationContract"}}}},"201":{"description":"Operation was successfully created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationContract"}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"./apimanagement.json#/definitions/ErrorResponse"}}}}}},"patch":{"tags":["Operations"],"operationId":"ApiOperation_Update","description":"Updates the details of the operation in the API specified by its identifier.","parameters":[{"$ref":"#/components/parameters/ApiIdParameter"},{"$ref":"#/components/parameters/OperationIdParameter"},{"name":"If-Match","in":"header","required":true,"description":"ETag of the API Operation Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.","schema":{"type":"string"}},{"$ref":"./apimanagement.json#/components/parameters/ApiVersionParameter"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationUpdateContract"}}},"description":"API Operation Update parameters.","required":true},"responses":{"204":{"description":"The operation was successfully updated."},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"./apimanagement.json#/definitions/ErrorResponse"}}}}}},"delete":{"tags":["Operations"],"operationId":"ApiOperation_Delete","description":"Deletes the specified operation in the API.","parameters":[{"$ref":"#/components/parameters/ApiIdParameter"},{"$ref":"#/components/parameters/OperationIdParameter"},{"name":"If-Match","in":"header","required":true,"description":"ETag of the API Operation Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.","schema":{"type":"string"}},{"$ref":"./apimanagement.json#/components/parameters/ApiVersionParameter"}],"responses":{"204":{"description":"The operation was successfully deleted."},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"./apimanagement.json#/definitions/ErrorResponse"}}}}}}},"/apis/{apiId}/operations/{operationId}/policies":{"get":{"tags":["ApiOperationPolicies"],"operationId":"ApiOperationPolicy_ListByOperation","description":"Get the list of policy configuration at the API Operation level.","parameters":[{"$ref":"#/components/parameters/ApiIdParameter"},{"$ref":"#/components/parameters/OperationIdParameter"},{"$ref":"./apimanagement.json#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"Api Operations Policy Collection.","content":{"application/json":{"schema":{"$ref":"./apimanagement.json#/definitions/PolicyCollection"}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"./apimanagement.json#/definitions/ErrorResponse"}}}}}}},"/apis/{apiId}/operations/{operationId}/policies/{policyId}":{"get":{"tags":["ApiOperationPolicies"],"operationId":"ApiOperationPolicy_Get","description":"Get the policy configuration at the API Operation level.","parameters":[{"$ref":"#/components/parameters/ApiIdParameter"},{"$ref":"#/components/parameters/OperationIdParameter"},{"$ref":"./apimanagement.json#/components/parameters/PolicyIdParameter"},{"$ref":"./apimanagement.json#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"Api Operation Policy information.","headers":{"ETag":{"description":"Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"./apimanagement.json#/definitions/PolicyContract"}},"application/vnd.ms-azure-apim.policy+xml":{"schema":{"$ref":"./apimanagement.json#/definitions/PolicyContract"}},"application/vnd.ms-azure-apim.policy.raw+xml":{"schema":{"$ref":"./apimanagement.json#/definitions/PolicyContract"}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"./apimanagement.json#/definitions/ErrorResponse"}},"application/vnd.ms-azure-apim.policy+xml":{"schema":{"$ref":"./apimanagement.json#/definitions/ErrorResponse"}},"application/vnd.ms-azure-apim.policy.raw+xml":{"schema":{"$ref":"./apimanagement.json#/definitions/ErrorResponse"}}}}}},"put":{"tags":["ApiOperationPolicies"],"operationId":"ApiOperationPolicy_CreateOrUpdate","description":"Creates or updates policy configuration for the API Operation level.","parameters":[{"$ref":"#/components/parameters/ApiIdParameter"},{"$ref":"#/components/parameters/OperationIdParameter"},{"$ref":"./apimanagement.json#/components/parameters/PolicyIdParameter"},{"name":"If-Match","in":"header","required":true,"description":"The entity state (Etag) version of the Api Operation policy to update. A value of \"*\" can be used for If-Match to unconditionally apply the operation.","schema":{"type":"string"}},{"$ref":"./apimanagement.json#/components/parameters/ApiVersionParameter"}],"requestBody":{"$ref":"#/components/requestBodies/./apimanagement.json#/definitions/PolicyContract"},"responses":{"200":{"description":"Api Operation policy configuration of the tenant was successfully updated.","content":{"application/json":{"schema":{"$ref":"./apimanagement.json#/definitions/PolicyContract"}}}},"201":{"description":"Api Operation policy configuration was successfully created.","content":{"application/json":{"schema":{"$ref":"./apimanagement.json#/definitions/PolicyContract"}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"./apimanagement.json#/definitions/ErrorResponse"}}}}}},"delete":{"tags":["ApiOperationPolicies"],"operationId":"ApiOperationPolicy_Delete","description":"Deletes the policy configuration at the Api Operation.","parameters":[{"$ref":"#/components/parameters/ApiIdParameter"},{"$ref":"#/components/parameters/OperationIdParameter"},{"name":"If-Match","in":"header","required":true,"description":"The entity state (Etag) version of the Api Operation Policy to delete. A value of \"*\" can be used for If-Match to unconditionally apply the operation.","schema":{"type":"string"}},{"$ref":"./apimanagement.json#/components/parameters/PolicyIdParameter"},{"$ref":"./apimanagement.json#/components/parameters/ApiVersionParameter"}],"responses":{"204":{"description":"Successfully deleted the policy configuration at the API Operation level."},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"./apimanagement.json#/definitions/ErrorResponse"}}}}}}},"/apis/{apiId}/products":{"get":{"tags":["ApiProduct"],"operationId":"ApiProduct_ListByApis","description":"Lists all Products, which the API is part of.","parameters":[{"$ref":"#/components/parameters/ApiIdParameter"},{"name":"$filter","in":"query","required":false,"description":"| Field | Supported operators | Supported functions |\n|-------|------------------------|---------------------------------------------|\n| name | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |","schema":{"type":"string"}},{"$ref":"./apimanagement.json#/components/parameters/TopQueryParameter"},{"$ref":"./apimanagement.json#/components/parameters/SkipQueryParameter"},{"$ref":"./apimanagement.json#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"The operation returns a collection of products which have the Api entity.","content":{"application/json":{"schema":{"$ref":"./apimproducts.json#/definitions/ProductCollection"}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"./apimanagement.json#/definitions/ErrorResponse"}}}}},"x-ms-pageable":{"nextLinkName":"nextLink"},"x-ms-odata":"./apimproducts.json#/definitions/ProductContract"}},"/apis/{apiId}/policies":{"get":{"tags":["ApiPolicy"],"operationId":"ApiPolicy_ListByApi","description":"Get the policy configuration at the API level.","parameters":[{"$ref":"#/components/parameters/ApiIdParameter"},{"$ref":"./apimanagement.json#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"Apis Policy Collection.","headers":{"ETag":{"description":"Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"./apimanagement.json#/definitions/PolicyCollection"}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"./apimanagement.json#/definitions/ErrorResponse"}}}}}}},"/apis/{apiId}/policies/{policyId}":{"get":{"tags":["ApiPolicy"],"operationId":"ApiPolicy_Get","description":"Get the policy configuration at the API level.","parameters":[{"$ref":"#/components/parameters/ApiIdParameter"},{"$ref":"./apimanagement.json#/components/parameters/PolicyIdParameter"},{"$ref":"./apimanagement.json#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"Api Policy information.","headers":{"ETag":{"description":"Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"./apimanagement.json#/definitions/PolicyContract"}},"application/vnd.ms-azure-apim.policy+xml":{"schema":{"$ref":"./apimanagement.json#/definitions/PolicyContract"}},"application/vnd.ms-azure-apim.policy.raw+xml":{"schema":{"$ref":"./apimanagement.json#/definitions/PolicyContract"}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"./apimanagement.json#/definitions/ErrorResponse"}},"application/vnd.ms-azure-apim.policy+xml":{"schema":{"$ref":"./apimanagement.json#/definitions/ErrorResponse"}},"application/vnd.ms-azure-apim.policy.raw+xml":{"schema":{"$ref":"./apimanagement.json#/definitions/ErrorResponse"}}}}}},"put":{"tags":["ApiPolicy"],"operationId":"ApiPolicy_CreateOrUpdate","description":"Creates or updates policy configuration for the API.","parameters":[{"$ref":"#/components/parameters/ApiIdParameter"},{"$ref":"./apimanagement.json#/components/parameters/PolicyIdParameter"},{"name":"If-Match","in":"header","required":true,"description":"The entity state (Etag) version of the Api Policy to update. A value of \"*\" can be used for If-Match to unconditionally apply the operation.","schema":{"type":"string"}},{"$ref":"./apimanagement.json#/components/parameters/ApiVersionParameter"}],"requestBody":{"$ref":"#/components/requestBodies/./apimanagement.json#/definitions/PolicyContract"},"responses":{"200":{"description":"Api policy configuration of the tenant was successfully updated.","content":{"application/json":{"schema":{"$ref":"./apimanagement.json#/definitions/PolicyContract"}}}},"201":{"description":"Api policy configuration was successfully created.","content":{"application/json":{"schema":{"$ref":"./apimanagement.json#/definitions/PolicyContract"}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"./apimanagement.json#/definitions/ErrorResponse"}}}}}},"delete":{"tags":["ApiPolicy"],"operationId":"ApiPolicy_Delete","description":"Deletes the policy configuration at the Api.","parameters":[{"$ref":"#/components/parameters/ApiIdParameter"},{"$ref":"./apimanagement.json#/components/parameters/PolicyIdParameter"},{"name":"If-Match","in":"header","required":true,"description":"The entity state (Etag) version of the Api policy to update. A value of \"*\" can be used for If-Match to unconditionally apply the operation.","schema":{"type":"string"}},{"$ref":"./apimanagement.json#/components/parameters/ApiVersionParameter"}],"responses":{"204":{"description":"Successfully deleted the policy configuration at the API level."},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"./apimanagement.json#/definitions/ErrorResponse"}}}}}}},"/apis/{apiId}/schemas":{"get":{"tags":["ApiSchema"],"operationId":"ApiSchema_ListByApi","description":"Get the schema configuration at the API level.","parameters":[{"$ref":"#/components/parameters/ApiIdParameter"},{"$ref":"./apimanagement.json#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"Apis Schema Collection.","headers":{"ETag":{"description":"Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SchemaCollection"}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"./apimanagement.json#/definitions/ErrorResponse"}}}}},"x-ms-pageable":{"nextLinkName":"nextLink"}}},"/apis/{apiId}/schemas/{schemaId}":{"get":{"tags":["ApiSchema"],"operationId":"ApiSchema_Get","description":"Get the schema configuration at the API level.","parameters":[{"$ref":"#/components/parameters/ApiIdParameter"},{"$ref":"#/components/parameters/SchemaIdParameter"},{"$ref":"./apimanagement.json#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"Api Schema information.","headers":{"ETag":{"description":"Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SchemaContract"}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"./apimanagement.json#/definitions/ErrorResponse"}}}}}},"put":{"tags":["ApiSchema"],"operationId":"ApiSchema_CreateOrUpdate","description":"Creates or updates schema configuration for the API.","parameters":[{"$ref":"#/components/parameters/ApiIdParameter"},{"$ref":"#/components/parameters/SchemaIdParameter"},{"name":"If-Match","in":"header","required":false,"description":"The entity state (Etag) version of the Api Schema to update. A value of \"*\" can be used for If-Match to unconditionally apply the operation.","schema":{"type":"string"}},{"$ref":"./apimanagement.json#/components/parameters/ApiVersionParameter"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SchemaContract"}}},"description":"The schema contents to apply.","required":true},"responses":{"200":{"description":"Api schema configuration of the tenant was successfully updated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SchemaContract"}}}},"201":{"description":"Api schema configuration was successfully created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SchemaContract"}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"./apimanagement.json#/definitions/ErrorResponse"}}}}}},"delete":{"tags":["ApiSchema"],"operationId":"ApiSchema_Delete","description":"Deletes the schema configuration at the Api.","parameters":[{"$ref":"#/components/parameters/ApiIdParameter"},{"$ref":"#/components/parameters/SchemaIdParameter"},{"name":"If-Match","in":"header","required":true,"description":"The entity state (Etag) version of the Api schema to update. A value of \"*\" can be used for If-Match to unconditionally apply the operation.","schema":{"type":"string"}},{"$ref":"./apimanagement.json#/components/parameters/ApiVersionParameter"}],"responses":{"204":{"description":"Successfully deleted the schema configuration at the API level."},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"./apimanagement.json#/definitions/ErrorResponse"}}}}}}}},"x-ms-paths":{"/apis/{apiId}?export=true":{"get":{"tags":["Apis"],"operationId":"ApiExport_Get","description":"Gets the details of the API specified by its identifier in the format specified to the Storage Blob with SAS Key valid for 5 minutes.","parameters":[{"$ref":"#/components/parameters/ApiIdParameter"},{"name":"Accept","in":"header","required":true,"x-ms-enum":{"name":"ExportFormat","modelAsString":true,"values":[{"value":"application/vnd.swagger.link+json","description":"Export the Api Definition in OpenApi Specification 2.0 format to the Storage Blob.","name":"OpenApi2"},{"value":"application/vnd.ms.wsdl.link+xml","description":"Export the Api Definition in WSDL Schema to Storage Blob.","name":"Wsdl"},{"value":"application/vnd.sun.wadl.link+json","description":"Export the Api Definition in WADL Schema to Storage Blob.","name":"Wadl"}]},"description":"Format in which to export the Api Details to the Storage Blob with Sas Key valid for 5 minutes.","schema":{"type":"string","enum":["application/vnd.swagger.link+json","application/vnd.sun.wadl.link+json","application/vnd.ms.wsdl.link+xml"]}},{"name":"export","in":"query","required":true,"x-ms-enum":{"modelAsString":true,"name":"ExportApi"},"description":"Query parameter required to export the API details.","schema":{"type":"string","enum":["true"]}},{"$ref":"./apimanagement.json#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"The response contains a stream with a full set of API metadata and includes API entity with an embedded array of operation entities.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiExportResult"}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"./apimanagement.json#/definitions/ErrorResponse"}}}}}}}},"servers":[{"url":"{apimBaseUrl}","variables":{"apimBaseUrl":{"description":"The management endpoint of the API Management service, for example https://myapimservice.management.azure-api.net.","x-ms-skip-url-encoding":true,"default":""}}}],"components":{"parameters":{"ApiIdParameter":{"name":"apiId","in":"path","required":true,"description":"API identifier. Must be unique in the current API Management service instance.","x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":256,"pattern":"^[^*#&+:<>?]+$"}},"OperationIdParameter":{"name":"operationId","in":"path","required":true,"description":"Operation identifier within an API. Must be unique in the current API Management service instance.","x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":256,"pattern":"^[^*#&+:<>?]+$"}},"SchemaIdParameter":{"name":"schemaId","in":"path","required":true,"description":"Schema identifier within an API. Must be unique in the current API Management service instance.","x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":256,"pattern":"^[^*#&+:<>?]+$"}}},"requestBodies":{"./apimanagement.json#/definitions/PolicyContract":{"content":{"application/json":{"schema":{"$ref":"./apimanagement.json#/definitions/PolicyContract"}},"application/vnd.ms-azure-apim.policy+xml":{"schema":{"$ref":"./apimanagement.json#/definitions/PolicyContract"}},"application/vnd.ms-azure-apim.policy.raw+xml":{"schema":{"$ref":"./apimanagement.json#/definitions/PolicyContract"}}},"description":"The policy contents to apply.","required":true}},"securitySchemes":{"apim_key":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"ApiExportResult":{"properties":{"link":{"type":"string","description":"Link to the Storage Blob containing the result of the export operation. The Blob Uri is only valid for 5 minutes."}},"description":"API Export result Blob Uri."},"ApiCollection":{"properties":{"value":{"type":"array","items":{"$ref":"#/components/schemas/ApiContract"}},"count":{"type":"integer","description":"Total number of entities"},"nextLink":{"type":"string","description":"Next page link if any."}},"description":"Paged Api list representation."},"ApiCreateOrUpdateParameter":{"properties":{"id":{"type":"string","description":"Identifier of the entity"},"contentValue":{"type":"string","description":"Content value when Importing an API."},"contentFormat":{"type":"string","description":"Format of the Content in which the API is getting imported.","enum":["wadl-xml","wadl-link-json","swagger-json","swagger-link-json","wsdl","wsdl-link"],"x-ms-enum":{"name":"ContentFormat","modelAsString":true,"values":[{"value":"wadl-xml","description":"The contents are inline and Content type is a WADL document."},{"value":"wadl-link-json","description":"The WADL document is hosted on a publicly accessible internet address."},{"value":"swagger-json","description":"The contents are inline and Content Type if a OpenApi 2.0 Document."},{"value":"swagger-link-json","description":"The Open Api 2.0 document is hosted on a publicly accessible internet address."},{"value":"wsdl","description":"The contents are inline and the document is a WSDL/Soap document."},{"value":"wsdl-link","description":"The WSDL document is hosted on a publicly accessible internet address."}]}},"wsdlSelector":{"type":"object","description":"Criteria to limit import of WSDL to a subset of the document.","properties":{"wsdlServiceName":{"type":"string","description":"Name of service to import from WSDL"},"wsdlEndpointName":{"type":"string","description":"Name of endpoint(port) to import from WSDL"}}}},"allOf":[{"$ref":"#/components/schemas/ApiContractProperties"}],"description":"Api Create or Update Properties."},"ApiContract":{"properties":{"id":{"type":"string","description":"Identifier of the Entity"}},"allOf":[{"$ref":"#/components/schemas/ApiContractProperties"}],"description":"Api Contract Details"},"ApiContractProperties":{"properties":{"name":{"type":"string","description":"API name.","minLength":1,"maxLength":300},"serviceUrl":{"type":"string","description":"Absolute URL of the backend service implementing this API.","minLength":1,"maxLength":2000},"path":{"type":"string","description":"Relative URL uniquely identifying this API and all of its resource paths within the API Management service instance. It is appended to the API endpoint base URL specified during the service instance creation to form a public URL for this API.","minLength":0,"maxLength":400},"protocols":{"type":"array","items":{"type":"string","enum":["http","https"],"x-ms-enum":{"name":"Protocol","modelAsString":false}},"description":"Describes on which protocols the operations in this API can be invoked."}},"allOf":[{"$ref":"#/components/schemas/ApiEntityBaseContract"}],"required":["path"],"description":"Api Entity Properties"},"ApiUpdateContract":{"properties":{"name":{"type":"string","description":"API name.","minLength":1,"maxLength":300},"serviceUrl":{"type":"string","description":"Absolute URL of the backend service implementing this API.","minLength":1,"maxLength":2000},"path":{"type":"string","description":"Relative URL uniquely identifying this API and all of its resource paths within the API Management service instance. It is appended to the API endpoint base URL specified during the service instance creation to form a public URL for this API.","minLength":0,"maxLength":400},"protocols":{"type":"array","items":{"type":"string","enum":["http","https"],"x-ms-enum":{"name":"Protocol","modelAsString":false}},"description":"Describes on which protocols the operations in this API can be invoked."}},"allOf":[{"$ref":"#/components/schemas/ApiEntityBaseContract"}],"description":"API update contract properties."},"ApiEntityBaseContract":{"properties":{"description":{"type":"string","description":"Description of the API. May include HTML formatting tags."},"authenticationSettings":{"$ref":"#/components/schemas/AuthenticationSettingsContract"},"subscriptionKeyParameterNames":{"$ref":"#/components/schemas/SubscriptionKeyParameterNamesContract"},"type":{"type":"string","description":"Type of API.","enum":["http","soap"],"x-ms-client-name":"ApiType","x-ms-enum":{"name":"ApiType","modelAsString":true}},"apiRevision":{"type":"string","description":"Describes the Revision of the Api. If no value is provided, default revision 1 is created","minLength":1,"maxLength":100},"isCurrent":{"type":"boolean","description":"Indicates if API revision is current api revision."},"isOnline":{"type":"boolean","description":"Indicates if API revision is accessible via the gateway."}},"description":"API base contract details."},"AuthenticationSettingsContract":{"properties":{"oAuth2":{"$ref":"#/components/schemas/OAuth2AuthenticationSettingsContract"}},"description":"API Authentication Settings."},"OAuth2AuthenticationSettingsContract":{"properties":{"authorizationServerId":{"type":"string","description":"OAuth authorization server identifier."},"scope":{"type":"string","description":"operations scope."}},"description":"API OAuth2 Authentication settings details."},"OperationCollection":{"properties":{"value":{"type":"array","items":{"$ref":"#/components/schemas/OperationContract"},"description":"Page values."},"count":{"type":"integer","description":"Total number of entities"},"nextLink":{"type":"string","description":"Next page link if any."}},"description":"Paged Operation list representation."},"OperationContract":{"properties":{"id":{"type":"string","description":"Identifier of the Operation."}},"allOf":[{"$ref":"#/components/schemas/OperationContractProperties"}],"description":"Api Operation details."},"OperationContractProperties":{"properties":{"name":{"type":"string","description":"Operation Name.","minLength":1,"maxLength":300},"method":{"type":"string","description":"A Valid HTTP Operation Method. Typical Http Methods like GET, PUT, POST but not limited by only them.","externalDocs":{"description":"As defined by RFC.","url":"http://www.rfc-editor.org/rfc/rfc7230.txt"}},"urlTemplate":{"type":"string","description":"Relative URL template identifying the target resource for this operation. May include parameters. Example: /customers/{cid}/orders/{oid}/?date={date}","minLength":1,"maxLength":1000}},"allOf":[{"$ref":"#/components/schemas/OperationEntityBaseContract"}],"required":["name","method","urlTemplate"],"description":"Operation Contract Properties"},"OperationUpdateContract":{"properties":{"name":{"type":"string","description":"Operation Name.","minLength":1,"maxLength":300},"method":{"type":"string","description":"A Valid HTTP Operation Method. Typical Http Methods like GET, PUT, POST but not limited by only them.","externalDocs":{"description":"As defined by RFC.","url":"http://www.rfc-editor.org/rfc/rfc7230.txt"}},"urlTemplate":{"type":"string","description":"Relative URL template identifying the target resource for this operation. May include parameters. Example: /customers/{cid}/orders/{oid}/?date={date}","minLength":1,"maxLength":1000}},"allOf":[{"$ref":"#/components/schemas/OperationEntityBaseContract"}],"description":"Operation Update Contract Properties."},"OperationEntityBaseContract":{"properties":{"templateParameters":{"type":"array","items":{"$ref":"#/components/schemas/ParameterContract"},"description":"Collection of URL template parameters."},"description":{"type":"string","description":"Description of the operation. May include HTML formatting tags.","maxLength":1000},"request":{"$ref":"#/components/schemas/RequestContract"},"responses":{"type":"array","items":{"$ref":"#/components/schemas/ResponseContract"},"description":"Array of Operation responses."},"policies":{"type":"string","description":"Operation Policies"}},"description":"Api Operation Entity Base Contract details."},"ParameterContract":{"properties":{"name":{"type":"string","description":"Parameter name."},"description":{"type":"string","description":"Parameter description."},"type":{"type":"string","description":"Parameter type."},"defaultValue":{"type":"string","description":"Default parameter value."},"required":{"type":"boolean","description":"whether parameter is required or not."},"values":{"type":"array","items":{"type":"string"},"description":"Parameter values."}},"required":["name","type"],"description":"Operation parameters details."},"RepresentationContract":{"properties":{"contentType":{"type":"string","description":"Specifies a registered or custom content type for this representation, e.g. application/xml."},"sample":{"type":"string","description":"An example of the representation."},"schemaId":{"type":"string","description":"Schema identifier. Applicable only if 'contentType' value is neither 'application/x-www-form-urlencoded' nor 'multipart/form-data'."},"typeName":{"type":"string","description":"Type name defined by the schema. Applicable only if 'contentType' value is neither 'application/x-www-form-urlencoded' nor 'multipart/form-data'."},"formParameters":{"type":"array","items":{"$ref":"#/components/schemas/ParameterContract"},"description":"Collection of form parameters. Required if 'contentType' value is either 'application/x-www-form-urlencoded' or 'multipart/form-data'.."}},"required":["contentType"],"description":"Operation request/response representation details."},"RequestContract":{"properties":{"description":{"type":"string","description":"Operation request description."},"queryParameters":{"type":"array","items":{"$ref":"#/components/schemas/ParameterContract"},"description":"Collection of operation request query parameters."},"headers":{"type":"array","items":{"$ref":"#/components/schemas/ParameterContract"},"description":"Collection of operation request headers."},"representations":{"type":"array","items":{"$ref":"#/components/schemas/RepresentationContract"},"description":"Collection of operation request representations."}},"description":"Operation request details."},"ResponseContract":{"properties":{"statusCode":{"type":"integer","format":"int32","description":"Operation response HTTP status code."},"description":{"type":"string","description":"Operation response description."},"representations":{"type":"array","items":{"$ref":"#/components/schemas/RepresentationContract"},"description":"Collection of operation response representations."},"headers":{"type":"array","items":{"$ref":"#/components/schemas/ParameterContract"},"description":"Collection of operation response headers."}},"required":["statusCode"],"description":"Operation response details."},"SubscriptionKeyParameterNamesContract":{"properties":{"header":{"type":"string","description":"Subscription key header name."},"query":{"type":"string","description":"Subscription key query string parameter name."}},"description":"Subscription key parameter names details.","example":{"subscriptionKeyParameterNames":{"query":"customQueryParameterName","header":"customHeaderParameterName"}}},"SchemaCollection":{"properties":{"value":{"type":"array","items":{"$ref":"#/components/schemas/SchemaContract"},"description":"Api Schema Contract value."},"count":{"type":"integer","description":"Total number of entities"},"nextLink":{"type":"string","description":"Next page link if any."}},"description":"The response of the list schema operation."},"SchemaContract":{"properties":{"id":{"type":"string","description":"Identifier of the Schema."}},"allOf":[{"$ref":"#/components/schemas/SchemaContractProperties"}],"description":"Schema Contract details."},"SchemaContractProperties":{"properties":{"contentType":{"type":"string","description":"Must be a valid a media type used in a Content-Type header as defined in the RFC 2616. Media type of the schema document (e.g. application/json, application/xml)."},"document":{"$ref":"#/components/schemas/SchemaDocumentProperties"}},"required":["contentType"],"description":"Schema contract Properties."},"SchemaDocumentProperties":{"properties":{"value":{"type":"string","description":"Json escaped string defining the document representing the Schema."}},"description":"Schema Document Properties."}}}}
/ apis
/ apis / {apiId}
/ apis / {apiId} / operations
/ apis / {apiId} / operations / {operationId}
/ apis / {apiId} / operations / {operationId} / policies
/ apis / {apiId} / operations / {operationId} / policies / {policyId}
/ apis / {apiId} / products
/ apis / {apiId} / policies
/ apis / {apiId} / policies / {policyId}
/ apis / {apiId} / schemas
/ apis / {apiId} / schemas / {schemaId}
OpenAPI	{"ApiManagementPatchUsers":{"parameters":{"apimBaseUrl":"apimservice1.management.azure-api.net","uid":"5a58baf0a40f7ef2e05bcf5e","api-version":"2017-03-01","If-Match":"\"AAAAAAAAClEAAAAAAAAKUw==\"","parameters":{"state":"active"}},"responses":{"204":{}}},"ApiManagementPutProducts":{"parameters":{"apimBaseUrl":"apimservice1.management.azure-api.net","productId":"5a58bab1a40f7ef2e05bc75f","api-version":"2017-03-01","parameters":{"name":"product_5a58bab1a40f7ef2e05bc760","description":"product_description_5a58bab1a40f7ef2e05bc761","approvalRequired":false,"state":"notPublished"}},"responses":{"201":{"body":{"id":"/products/5a58bab1a40f7ef2e05bc75f","name":"product_5a58bab1a40f7ef2e05bc760","description":"product_description_5a58bab1a40f7ef2e05bc761","subscriptionRequired":true,"approvalRequired":false,"state":"notPublished"}},"200":{"body":{"id":"/products/5a58bab1a40f7ef2e05bc75f","name":"product_5a58bab1a40f7ef2e05bc760","description":"product_description_5a58bab1a40f7ef2e05bc761","subscriptionRequired":true,"approvalRequired":false,"state":"notPublished"}}}},"ApiManagementPutLoggers":{"parameters":{"apimBaseUrl":"apimservice1.management.azure-api.net","loggerid":"5a58bc28a40f7e10489292a3","api-version":"2017-03-01","parameters":{"loggerType":"azureEventHub","description":"first eventhub logger","credentials":{"name":"testeventhub3","connectionString":"Endpoint=sb://contoso.servicebus.windows.net/;SharedAccessKeyName=SendPolicy;SharedAccessKey=sdfsdfdf"}}},"responses":{"201":{"body":{"id":"/loggers/5a58bc28a40f7e10489292a3","loggerType":"azureEventHub","description":"first eventhub logger","credentials":{"name":"testeventhub3","connectionString":"{{Logger-Credentials-5a58bc31a40f7e10489292a5}}"},"isBuffered":true}},"200":{"body":{"id":"/loggers/5a58bc28a40f7e10489292a3","loggerType":"azureEventHub","description":"first eventhub logger","credentials":{"name":"testeventhub3","connectionString":"{{Logger-Credentials-5a58bc31a40f7e10489292a5}}"},"isBuffered":true}}}},"ApiManagementPostTenantDeploy":{"parameters":{"apimBaseUrl":"apimservice1.management.azure-api.net","api-version":"2017-03-01","configurationName":"configuration","parameters":{"branch":"master"}},"responses":{"202":{"headers":{"location":"https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5a1af4ae2a6d2e0b688d7517?api-version=2017-03-01"}},"200":{"body":{"id":"5a1af4ae2a6d2e0b688d7517","status":"Failed","started":"2017-11-26T17:06:54.303Z","updated":"2017-11-26T17:07:21.777Z","error":{"code":"ValidationError","message":"File not found: 'api-management/configuration.json'"}}}}},"ApiManagementDeleteProducts":{"parameters":{"apimBaseUrl":"apimservice1.management.azure-api.net","productId":"5a58bb0ea40f7ef2e05bd40e","deleteSubscriptions":true,"api-version":"2017-03-01","If-Match":"\"AAAAAAAADJg=\""},"responses":{"204":{}}},"ApiManagementListApisSchemas":{"parameters":{"apimBaseUrl":"apimservice1.management.azure-api.net","apiId":"5a58bde0a40f7e104892ac2c","api-version":"2017-03-01","Accept":"application/json"},"responses":{"200":{"body":{"value":[],"count":0}}}},"ApiManagementPatchTenant":{"parameters":{"apimBaseUrl":"apimservice1.management.azure-api.net","accessName":"access","api-version":"2017-03-01","If-Match":"\"AAAAAAAAB9cAAAAAAAAAAA==\"","parameters":{"enabled":true}},"responses":{"204":{}}},"ApiManagementPatchLoggers":{"parameters":{"apimBaseUrl":"apimservice1.management.azure-api.net","loggerid":"5a58bd45a40f7e104892a3aa","api-version":"2017-03-01","If-Match":"\"AAAAAAAAHDE=\"","parameters":{"credentials":{"connectionString":"{{EventHubConnectionString5a58bd47a40f7e104892a3b0}}","name":"testeventhub3"}}},"responses":{"204":{}}},"ApiManagementPutProperties":{"parameters":{"apimBaseUrl":"apimservice1.management.azure-api.net","propId":"5a58bc49a40f7e10489293ad","api-version":"2017-03-01","parameters":{"name":"cacheDuration5a58bc49a40f7e10489293ae","value":"10","secret":true}},"responses":{"201":{"body":{"id":"/properties/5a58bc49a40f7e10489293ad","name":"cacheDuration5a58bc49a40f7e10489293ae","value":"10","secret":true}},"200":{"body":{"id":"/properties/5a58bc49a40f7e10489293ad","name":"cacheDuration5a58bc49a40f7e10489293ae","value":"10","secret":true}}}},"ApiManagementPatchPortalSettingsDelegation":{"parameters":{"apimBaseUrl":"apimservice1.management.azure-api.net","api-version":"2017-03-01","If-Match":"*","parameters":{"url":"http://contoso.com/delegation","validationKey":"<validationKey>","subscriptions":{"enabled":true},"userRegistration":{"enabled":true}}},"responses":{"204":{}}},"ApiManagementDeleteProductsGroups":{"parameters":{"apimBaseUrl":"apimservice1.management.azure-api.net","productId":"5a58bbf3a40f7e1048928f67","groupId":"5a58bbf3a40f7e1048928f6c","api-version":"2017-03-01"},"responses":{"204":{}}},"ApiManagementListGroups":{"parameters":{"apimBaseUrl":"apimservice1.management.azure-api.net","$skip":0,"$top":10000,"api-version":"2017-03-01","Accept":"application/json"},"responses":{"200":{"body":{"value":[{"id":"/groups/administrators","name":"Administrators","description":"Administrators is a built-in group. Its membership is managed by the system. Microsoft Azure subscription administrators fall into this group.","builtIn":true,"type":"system"},{"id":"/groups/developers","name":"Developers","description":"Developers is a built-in group. Its membership is managed by the system. Signed-in users fall into this group.","builtIn":true,"type":"system"},{"id":"/groups/guests","name":"Guests","description":"Guests is a built-in group. Its membership is managed by the system. Unauthenticated users visiting the developer portal fall into this group.","builtIn":true,"type":"system"}],"count":3}}}},"ApiManagementGetReportsByOperation":{"parameters":{"apimBaseUrl":"apimservice1.management.azure-api.net","api-version":"2017-03-01","$filter":"timestamp ge datetime'2017-06-01T00:00:00' and timestamp le datetime'2017-06-04T00:00:00'"},"responses":{"200":{"body":{"value":[{"name":"get","apiId":"/apis/57a03a13e4bbd5119c8b19e9","operationId":"/apis/57a03a13e4bbd5119c8b19e9/operations/57a03a1dd8d14f0a780d7d14","callCountSuccess":13,"callCountBlocked":1,"callCountFailed":0,"callCountOther":0,"callCountTotal":14,"bandwidth":11019,"cacheHitCount":0,"cacheMissCount":0,"apiTimeAvg":1015.7607923076923,"apiTimeMin":330.3206,"apiTimeMax":1819.2173,"serviceTimeAvg":957.094776923077,"serviceTimeMin":215.24,"serviceTimeMax":1697.3612},{"name":"GetWeatherInformation","apiId":"/apis/57c999d1e4bbd50c988cb2c3","operationId":"/apis/57c999d1e4bbd50c988cb2c3/operations/57c999d1e4bbd50df889c93e","callCountSuccess":0,"callCountBlocked":0,"callCountFailed":0,"callCountOther":0,"callCountTotal":0,"bandwidth":0,"cacheHitCount":0,"cacheMissCount":0,"apiTimeAvg":0,"apiTimeMin":0,"apiTimeMax":0,"serviceTimeAvg":0,"serviceTimeMin":0,"serviceTimeMax":0},{"name":"GetCityForecastByZIP","apiId":"/apis/57c999d1e4bbd50c988cb2c3","operationId":"/apis/57c999d1e4bbd50c988cb2c3/operations/57c999d1e4bbd50df889c93f","callCountSuccess":0,"callCountBlocked":0,"callCountFailed":0,"callCountOther":0,"callCountTotal":0,"bandwidth":0,"cacheHitCount":0,"cacheMissCount":0,"apiTimeAvg":0,"apiTimeMin":0,"apiTimeMax":0,"serviceTimeAvg":0,"serviceTimeMin":0,"serviceTimeMax":0}],"count":3,"nextLink":""}}}},"ApiManagementPostTenantRegeneratePrimaryKey":{"parameters":{"apimBaseUrl":"apimservice1.management.azure-api.net","api-version":"2017-03-01","accessName":"access"},"responses":{"204":{}}},"ApiManagementGetCertificates":{"parameters":{"apimBaseUrl":"apimservice1.management.azure-api.net","certificateId":"5a58be29a40f7e104892af64","api-version":"2017-03-01","Accept":"application/json"},"responses":{"200":{"body":{"id":"/certificates/5a58be29a40f7e104892af64","subject":"CN=localhost","thumbprint":"F71A638FEC037AA826A30755DF2732DB5A4CB776","expirationDate":"2019-01-12T00:00:00Z"}}}},"ApiManagementDeleteGroups":{"parameters":{"apimBaseUrl":"apimservice1.management.azure-api.net","groupId":"5a58bb18a40f7ef2e05bd532","api-version":"2017-03-01","If-Match":"*"},"responses":{"204":{}}},"ApiManagementGetReportsByProduct":{"parameters":{"apimBaseUrl":"apimservice1.management.azure-api.net","api-version":"2017-03-01","$filter":"timestamp ge datetime'2017-06-01T00:00:00' and timestamp le datetime'2017-06-04T00:00:00'"},"responses":{"200":{"body":{"value":[{"name":"Starter","productId":"/products/5600b59475ff190048060001","callCountSuccess":0,"callCountBlocked":0,"callCountFailed":0,"callCountOther":0,"callCountTotal":0,"bandwidth":0,"cacheHitCount":0,"cacheMissCount":0,"apiTimeAvg":0,"apiTimeMin":0,"apiTimeMax":0,"serviceTimeAvg":0,"serviceTimeMin":0,"serviceTimeMax":0},{"name":"Unlimited","productId":"/products/5600b59475ff190048060002","callCountSuccess":13,"callCountBlocked":1,"callCountFailed":0,"callCountOther":0,"callCountTotal":14,"bandwidth":11019,"cacheHitCount":0,"cacheMissCount":0,"apiTimeAvg":1015.7607923076923,"apiTimeMin":330.3206,"apiTimeMax":1819.2173,"serviceTimeAvg":957.094776923077,"serviceTimeMin":215.24,"serviceTimeMax":1697.3612}],"count":2,"nextLink":""}}}},"ApiManagementGetPortalSettingsSignIn":{"parameters":{"apimBaseUrl":"apimservice1.management.azure-api.net","api-version":"2017-03-01"},"responses":{"200":{"body":{"enabled":true}}}},"ApiManagementGetPortalSettingsSignUp":{"parameters":{"apimBaseUrl":"apimservice1.management.azure-api.net","api-version":"2017-03-01"},"responses":{"200":{"body":{"enabled":true,"termsOfService":{"text":"Terms of service text.","enabled":true,"consentRequired":true}}}}},"ApiManagementGetAuthorizationServers":{"parameters":{"apimBaseUrl":"apimservice1.management.azure-api.net","authsid":"5a58bd24a40f7e104892a241","api-version":"2017-03-01","Accept":"application/json"},"responses":{"200":{"body":{"id":"/authorizationServers/5a58bd24a40f7e104892a241","name":"660e8b6e-baa4-443e-ae8d-208b25ee560b","description":"test server","clientRegistrationEndpoint":"https://www.contoso.com/apps","authorizationEndpoint":"https://www.contoso.com/oauth2/auth","authorizationMethods":["GET"],"clientAuthenticationMethod":null,"tokenBodyParameters":null,"tokenEndpoint":"https://www.contoso.com/oauth2/token","supportState":true,"defaultScope":"read write","grantTypes":["authorizationCode","implicit","resourceOwnerPassword"],"bearerTokenSendingMethods":["authorizationHeader"],"clientId":"1","clientSecret":"2","resourceOwnerUsername":"un","resourceOwnerPassword":"pwd"}}}},"ApiManagementGetProperties":{"parameters":{"apimBaseUrl":"apimservice1.management.azure-api.net","propId":"5a58bd11a40f7e104892a06e","api-version":"2017-03-01","Accept":"application/json"},"responses":{"200":{"body":{"id":"/properties/5a58bd11a40f7e104892a06e","name":"5a58bd11a40f7e104892a06f","value":"ODPGOQTTJSCGQQTOYHHRIENMAFDNJQTUDKSCLBQMBSIGMIRQYOQVIURJPDFIMGKSYIDFYQDWQUQQWHZRONOUAYLJTIMHWIZVIPHEFLRHLTENDANHDNTZRPSAWUMQDVAIVVIGAVMDVGJHTXFSUFDIOZDSXGHKZBDPSWSIRGGIBQDKGKHZPTVYRSUVRQJUNCDUDTOXFWBOYUGXWTMMZIVFFFXABWRBXMVYMIHMWKTSSHAWLWZYDWVFGYOXVNVIFZQLZIKNLZPOOCNYEBOFXTXARPROTJRIPKNSQOXDLLMEGGQDKQTUZPLMBPTKQWTBIGZDPVHPELTLGTULZNEDQWJZZAQBVMNPRLWZGMOPJDQNWZFIVIKCSQKLWAEOEFURYDTUWUFMZPTNGWCZUHFNCKXBALCFIZKDIZPSFKLACYCDXXEAXEUWAHPNGSULRZDAEPEHGKUJWFKDIUECGBHEFNDBKCLMQAIDVBYHSXUNKKAUXLEMOREQRZVQMDXEYHTVWGIGVWJJHUUVNJDYXZYYVSMVGIVPZQPCQEXQDYQSIUIXFADDZZGYJVAEUMANBUKQEREILNUZIGQAKOQFESPAJQTVETVRXDQNKRSOVUSMEHQDEZUFVUIJEJHOXJERRDBFPCPSWCJKZDWCAQQEZQVDVHJBKDQMQAVBGLNCJBJTLXJBNENHSZRBHYJISOHSMWUZHUWPCNUYHBRXXINFPITQJUTHBEJVTQHODKTSIYEEFTTFGMLKABDDCDPNBONYEZEQUDTNOVXRDPLQANBOTZUSNDLZUGRUKGAFPDLDSXVFELANSZMNMZEFEMDRRUSIEDGWOFAXCYWWDONBDXHUTDHLCVADZULYFNBAFDZMYPLOCIBQYCNUNXPAWUUTEXYIMYRPMNVAYUVDRSJUTKEWGRKHYAEKJGHBRDCERMDLHNVSCLJDLZZTTBBVNJRLILQSMUMOQEDHHTPSVSFMRAYJGOIPBGRHURCVWDGHYVNHWSMZMJZVEEUHMHMYMWMJNWMQQTVSLYNW","tags":null,"secret":true}}}},"ApiManagementPutOpenIdConnectProviders":{"parameters":{"apimBaseUrl":"apimservice1.management.azure-api.net","api-version":"2017-03-01","opid":"op1","parameters":{"name":"templateoidprovider3","metadataEndpoint":"https://oidprovider-template3.net","clientId":"oidprovidertemplate3"}},"responses":{"201":{"body":{"id":"/openidConnectProviders/op1","name":"templateoidprovider3","metadataEndpoint":"https://oidprovider-template3.net","clientId":"oidprovidertemplate3"}},"200":{"body":{"id":"/openidConnectProviders/op1","name":"templateoidprovider3","metadataEndpoint":"https://oidprovider-template3.net","clientId":"oidprovidertemplate3"}}}},"ApiManagementListApisOperationsPolicies":{"parameters":{"apimBaseUrl":"apimservice1.management.azure-api.net","api-version":"2017-03-01","apiId":"599e2953193c3c0bd0b3e2fa","operationId":"599e29ab193c3c0bd0b3e2fb"},"responses":{"200":{"body":{"value":[{"id":"/apis/599e2953193c3c0bd0b3e2fa/operations/599e29ab193c3c0bd0b3e2fb/policies/policy","policyContent":"<!--\r\n IMPORTANT:\r\n - Policy elements can appear only within the <inbound>, <outbound>, <backend> section elements.\r\n - Only the <forward-request> policy element can appear within the <backend> section element.\r\n - To apply a policy to the incoming request (before it is forwarded to the backend service), place a corresponding policy element within the <inbound> section element.\r\n - To apply a policy to the outgoing response (before it is sent back to the caller), place a corresponding policy element within the <outbound> section element.\r\n - To add a policy position the cursor at the desired insertion point and click on the round button associated with the policy.\r\n - To remove a policy, delete the corresponding policy statement from the policy document.\r\n - Position the <base> element within a section element to inherit all policies from the corresponding section element in the enclosing scope.\r\n - Remove the <base> element to prevent inheriting policies from the corresponding section element in the enclosing scope.\r\n - Policies are applied in the order of their appearance, from the top down.\r\n-->\r\n<policies>\r\n <inbound>\r\n <validate-jwt header-name=\"dd\">\r\n <required-claims>\r\n <claim name=\"bla\" separator=\"\">\r\n <value>xxx</value>\r\n </claim>\r\n </required-claims>\r\n </validate-jwt>\r\n <base />\r\n </inbound>\r\n <backend>\r\n <base />\r\n </backend>\r\n <outbound>\r\n <base />\r\n </outbound>\r\n</policies>"}],"nextLink":""}}}},"ApiManagementPatchOpenIdConnectProviders":{"parameters":{"apimBaseUrl":"apimservice1.management.azure-api.net","api-version":"2017-03-01","opid":"templateOpenIdConnect2","If-Match":"*","parameters":{"clientSecret":"updatedsecret"}},"responses":{"204":{}}},"ApiManagementPatchQuotasByQuotaPeriod":{"parameters":{"apimBaseUrl":"apimservice1.management.azure-api.net","api-version":"2017-03-01","quotaCounterKey":"ba","quotaPeriodKey":"0_P3Y6M4DT12H30M5S","parameters":{"callsCount":0,"kbTransferred":0}},"responses":{"204":{}}},"ApiManagementListProductsSubscriptions":{"parameters":{"apimBaseUrl":"apimservice1.management.azure-api.net","productId":"5a58bb65a40f7ef2e05bdc25","api-version":"2017-03-01","Accept":"application/json"},"responses":{"200":{"body":{"value":[{"id":"/subscriptions/5a58bb65a40f7ef2e05bdc28","userId":"/users/1","productId":"/products/5a58bb65a40f7ef2e05bdc25","state":"active","createdDate":"2018-01-12T13:43:01.113Z","startDate":"2018-01-12T00:00:00Z","primaryKey":"<primaryKey>","secondaryKey":"<secondaryKey>"}],"count":1}}}},"ApiManagementPutProductsGroups":{"parameters":{"apimBaseUrl":"apimservice1.management.azure-api.net","productId":"5a58bac8a40f7ef2e05bcc5e","groupId":"5a58bac8a40f7ef2e05bcc63","api-version":"2017-03-01"},"responses":{"201":{"body":{"id":"/groups/5a58bac8a40f7ef2e05bcc63","name":"5a58bac8a40f7ef2e05bcc64","builtIn":false,"type":"custom"}},"200":{"body":{"id":"/groups/5a58bac8a40f7ef2e05bcc63","name":"5a58bac8a40f7ef2e05bcc64","builtIn":false,"type":"custom"}}}},"ApiManagementGetLoggers":{"parameters":{"apimBaseUrl":"apimservice1.management.azure-api.net","loggerid":"5a58bc37a40f7e1048929319","api-version":"2017-03-01","Accept":"application/json"},"responses":{"200":{"body":{"id":"/loggers/5a58bc37a40f7e1048929319","loggerType":"azureEventHub","description":"first eventhub logger","credentials":{"name":"testeventhub3","connectionString":"{{Logger-Credentials-5a58bc39a40f7e104892931b}}"},"isBuffered":true}}}},"ApiManagementGetProductsPolicies":{"parameters":{"apimBaseUrl":"apimservice1.management.azure-api.net","productId":"5a58bf61a40f7e104892bda4","policyId":"policy","api-version":"2017-03-01","Accept":"application/json"},"responses":{"200":{"body":{"id":"/products/5a58bf61a40f7e104892bda4/policies/policy","policyContent":"<policies>\r\n <inbound>\r\n <rate-limit calls=\"5\" renewal-period=\"60\" />\r\n <quota calls=\"100\" renewal-period=\"604800\" />\r\n <base />\r\n </inbound>\r\n <backend>\r\n <base />\r\n </backend>\r\n <outbound>\r\n <base />\r\n </outbound>\r\n</policies>"}}}},"ApiManagementGetGroups":{"parameters":{"apimBaseUrl":"apimservice1.management.azure-api.net","groupId":"5a58baeea40f7ef2e05bcf5a","api-version":"2017-03-01","Accept":"application/json"},"responses":{"200":{"body":{"id":"/groups/5a58baeea40f7ef2e05bcf5a","name":"5a58baeea40f7ef2e05bcf5b","builtIn":false,"type":"custom"}}}},"ApiManagementGetReportsBySubscription":{"parameters":{"apimBaseUrl":"apimservice1.management.azure-api.net","api-version":"2017-03-01","$filter":"timestamp ge datetime'2017-06-01T00:00:00' and timestamp le datetime'2017-06-04T00:00:00'"},"responses":{"200":{"body":{"value":[{"name":"","userId":"/users/1","productId":"/products/5600b59475ff190048060001","subscriptionId":"/subscriptions/5600b59475ff190048070001","callCountSuccess":0,"callCountBlocked":0,"callCountFailed":0,"callCountOther":0,"callCountTotal":0,"bandwidth":0,"cacheHitCount":0,"cacheMissCount":0,"apiTimeAvg":0,"apiTimeMin":0,"apiTimeMax":0,"serviceTimeAvg":0,"serviceTimeMin":0,"serviceTimeMax":0},{"name":"","userId":"/users/1","productId":"/products/5600b59475ff190048060002","subscriptionId":"/subscriptions/5600b59475ff190048070002","callCountSuccess":13,"callCountBlocked":1,"callCountFailed":0,"callCountOther":0,"callCountTotal":14,"bandwidth":11019,"cacheHitCount":0,"cacheMissCount":0,"apiTimeAvg":1015.7607923076923,"apiTimeMin":330.3206,"apiTimeMax":1819.2173,"serviceTimeAvg":957.094776923077,"serviceTimeMin":215.24,"serviceTimeMax":1697.3612},{"name":"","userId":"/users/1","productId":"/products/5702e97e5157a50f48dce801","subscriptionId":"/subscriptions/5702e97e5157a50a9c733303","callCountSuccess":0,"callCountBlocked":0,"callCountFailed":0,"callCountOther":0,"callCountTotal":0,"bandwidth":0,"cacheHitCount":0,"cacheMissCount":0,"apiTimeAvg":0,"apiTimeMin":0,"apiTimeMax":0,"serviceTimeAvg":0,"serviceTimeMin":0,"serviceTimeMax":0}],"count":3,"nextLink":""}}}},"ApiManagementPutApisPolicies":{"parameters":{"apimBaseUrl":"apimservice1.management.azure-api.net","apiId":"5a58bd43a40f7e104892a398","policyId":"policy","api-version":"2017-03-01","If-Match":"*","parameters":{"policyContent":"<policies>\r\n <inbound>\r\n <base />\r\n <cache-lookup vary-by-developer=\"false\" vary-by-developer-groups=\"false\" downstream-caching-type=\"none\">\r\n <vary-by-query-parameter>version</vary-by-query-parameter>\r\n <vary-by-header>Accept</vary-by-header>\r\n <vary-by-header>Accept-Charset</vary-by-header>\r\n </cache-lookup>\r\n </inbound>\r\n <backend>\r\n <base />\r\n </backend>\r\n <outbound>\r\n <cache-store duration=\"@(10)\" />\r\n <base />\r\n </outbound>\r\n</policies>"}},"responses":{"201":{"body":{"id":"/apis/5a58bd43a40f7e104892a398/policies/policy","policyContent":"<policies>\r\n <inbound>\r\n <base />\r\n <cache-lookup vary-by-developer=\"false\" vary-by-developer-groups=\"false\" downstream-caching-type=\"none\">\r\n <vary-by-query-parameter>version</vary-by-query-parameter>\r\n <vary-by-header>Accept</vary-by-header>\r\n <vary-by-header>Accept-Charset</vary-by-header>\r\n </cache-lookup>\r\n </inbound>\r\n <backend>\r\n <base />\r\n </backend>\r\n <outbound>\r\n <cache-store duration=\"@(10)\" />\r\n <base />\r\n </outbound>\r\n</policies>"}},"200":{"body":{"id":"/apis/5a58bd43a40f7e104892a398/policies/policy","policyContent":"<policies>\r\n <inbound>\r\n <base />\r\n <cache-lookup vary-by-developer=\"false\" vary-by-developer-groups=\"false\" downstream-caching-type=\"none\">\r\n <vary-by-query-parameter>version</vary-by-query-parameter>\r\n <vary-by-header>Accept</vary-by-header>\r\n <vary-by-header>Accept-Charset</vary-by-header>\r\n </cache-lookup>\r\n </inbound>\r\n <backend>\r\n <base />\r\n </backend>\r\n <outbound>\r\n <cache-store duration=\"@(10)\" />\r\n <base />\r\n </outbound>\r\n</policies>"}}}},"ApiManagementPostUsersToken":{"parameters":{"apimBaseUrl":"apimservice1.management.azure-api.net","uid":"1","api-version":"2017-03-01","parameters":{"keyType":"primary","expiry":"2017-05-13T10:39:35Z"}},"responses":{"200":{"body":{"value":"57f2af53bb17172280f44057&201705131039&***************************/tJVExvjA=="}}}},"ApiManagementGetSubscriptions":{"parameters":{"apimBaseUrl":"apimservice1.management.azure-api.net","sid":"5a58baf8a40f7ef2e05bcfb7","api-version":"2017-03-01","Accept":"application/json"},"responses":{"200":{"body":{"id":"/subscriptions/5a58baf8a40f7ef2e05bcfb7","userId":"/users/5a58baf8a40f7ef2e05bcfb1","productId":"/products/5a58baf7a40f7ef2e05bcfa3","name":"product_5a58baf7a40f7ef2e05bcfa4 subscription","state":"active","createdDate":"2018-01-12T13:41:12.18Z","startDate":"2018-01-12T00:00:00Z","primaryKey":"<primaryKey>","secondaryKey":"<secondaryKey>"}}}},"ApiManagementPatchPortalSettingsSignUp":{"parameters":{"apimBaseUrl":"apimservice1.management.azure-api.net","api-version":"2017-03-01","If-Match":"*","parameters":{"enabled":true,"termsOfService":{"enabled":true,"text":"Terms of service text.","consentRequired":true}}},"responses":{"204":{}}},"ApiManagementPatchPortalSettingsSignIn":{"parameters":{"apimBaseUrl":"apimservice1.management.azure-api.net","api-version":"2017-03-01","If-Match":"*","parameters":{"enabled":true}},"responses":{"204":{}}},"ApiManagementGetProducts":{"parameters":{"apimBaseUrl":"apimservice1.management.azure-api.net","productId":"5a58bac9a40f7ef2e05bcc98","api-version":"2017-03-01","Accept":"application/json"},"responses":{"200":{"body":{"id":"/products/5a58bac9a40f7ef2e05bcc98","name":"product_5a58bac9a40f7ef2e05bcc99","description":"product_description_5a58bac9a40f7ef2e05bcc9a","subscriptionRequired":true,"approvalRequired":false,"state":"notPublished"}}}},"ApiManagementListTenantGit":{"parameters":{"apimBaseUrl":"apimservice1.management.azure-api.net","api-version":"2017-03-01","accessName":"access"},"responses":{"200":{"body":{"id":"5600b59375ff190048030003","primaryKey":"<primaryKey>","secondaryKey":"<secondaryKey>","enabled":true}}}},"ApiManagementGetQuotasByQuotaPeriod":{"parameters":{"apimBaseUrl":"apimservice1.management.azure-api.net","api-version":"2017-03-01","quotaCounterKey":"ba","quotaPeriodKey":"0_P3Y6M4DT12H30M5S","parameters":{"callsCount":0,"kbTransferred":0}},"responses":{"200":{"body":{"counterKey":"ba","periodKey":"0_P3Y6M4DT12H30M5S","periodStartTime":"2014-08-04T04:24:35Z","periodEndTime":"2018-02-08T16:54:40Z","Value":{"callsCount":0,"kbTransferred":2.5625}}}}},"ApiManagementListProducts":{"parameters":{"apimBaseUrl":"apimservice1.management.azure-api.net","$skip":0,"$top":10000,"expandGroups":false,"api-version":"2017-03-01","Accept":"application/json"},"responses":{"200":{"body":{"value":[{"id":"/products/5a58badca40f7ef2e05bcd24","name":"product_5a58badca40f7ef2e05bcd25","description":"product_description_5a58badca40f7ef2e05bcd26","subscriptionRequired":true,"approvalRequired":true,"subscriptionsLimit":1,"state":"published"},{"id":"/products/5a58bae0a40f7ef2e05bcd3d","name":"product_5a58bae0a40f7ef2e05bcd3e","description":"product_description_5a58bae0a40f7ef2e05bcd3f","subscriptionRequired":true,"approvalRequired":false,"subscriptionsLimit":1,"state":"published"}],"count":2}}}},"ApiManagementListApisOperations":{"parameters":{"apimBaseUrl":"apimservice1.management.azure-api.net","apiId":"5a58bac3a40f7ef2e05bc7db","api-version":"2017-03-01","Accept":"application/json"},"responses":{"200":{"body":{"value":[{"id":"/apis/5a58bac3a40f7ef2e05bc7db/operations/5a58bad4a40f7ef2e05bccf2","name":"operation_5a58bad4a40f7ef2e05bcce5","method":"PUT","urlTemplate":"/template_5a58bad4a40f7ef2e05bcce7","description":"description_5a58bad4a40f7ef2e05bcce6"},{"id":"/apis/5a58bac3a40f7ef2e05bc7db/operations/5a58bad9a40f7ef2e05bcd0b","name":"operation_5a58bad9a40f7ef2e05bcd09","method":"PATCH","urlTemplate":"/template_5a58bad9a40f7ef2e05bcd0a"},{"id":"/apis/5a58bac3a40f7ef2e05bc7db/operations/5a58bad9a40f7ef2e05bcd0f","name":"operation_5a58bad9a40f7ef2e05bcd0d","method":"PATCH","urlTemplate":"/template_5a58bad9a40f7ef2e05bcd0e"},{"id":"/apis/5a58bac3a40f7ef2e05bc7db/operations/5a58badaa40f7ef2e05bcd1e","name":"operation_5a58badaa40f7ef2e05bcd11","method":"POST","urlTemplate":"/template_5a58badaa40f7ef2e05bcd13","description":"description_5a58badaa40f7ef2e05bcd12"},{"id":"/apis/5a58bac3a40f7ef2e05bc7db/operations/5a58badea40f7ef2e05bcd35","name":"operation_5a58badea40f7ef2e05bcd32","method":"POST","urlTemplate":"/template_5a58badea40f7ef2e05bcd34","description":"description_5a58badea40f7ef2e05bcd33"},{"id":"/apis/5a58bac3a40f7ef2e05bc7db/operations/5a58bb39a40f7ef2e05bd91b","name":"operation_5a58bb39a40f7ef2e05bd90e","method":"CONNECT","urlTemplate":"/template_5a58bb39a40f7ef2e05bd910","description":"description_5a58bb39a40f7ef2e05bd90f"},{"id":"/apis/5a58bac3a40f7ef2e05bc7db/operations/5a58bb46a40f7ef2e05bd97b","name":"operation_5a58bb46a40f7ef2e05bd96e","method":"DELETE","urlTemplate":"/template_5a58bb46a40f7ef2e05bd970","description":"description_5a58bb46a40f7ef2e05bd96f"},{"id":"/apis/5a58bac3a40f7ef2e05bc7db/operations/5a58bb5ba40f7ef2e05bdc00","name":"operation_5a58bb5ba40f7ef2e05bdbf3","method":"DELETE","urlTemplate":"/template_5a58bb5ba40f7ef2e05bdbf5","description":"description_5a58bb5ba40f7ef2e05bdbf4"}],"count":8}}}},"ApiManagementListApisPolicies":{"parameters":{"apimBaseUrl":"apimservice1.management.azure-api.net","$skip":0,"$top":10000,"apiId":"echo-api","api-version":"2017-03-01","Accept":"application/json"},"responses":{"200":{"body":{"value":[{"id":"/policies/policy","policyContent":"<!--\r\n IMPORTANT:\r\n - Policy elements can appear only within the <inbound>, <outbound>, <backend> section elements.\r\n - Only the <forward-request> policy element can appear within the <backend> section element.\r\n - To apply a policy to the incoming request (before it is forwarded to the backend service), place a corresponding policy element within the <inbound> section element.\r\n - To apply a policy to the outgoing response (before it is sent back to the caller), place a corresponding policy element within the <outbound> section element.\r\n - To add a policy position the cursor at the desired insertion point and click on the round button associated with the policy.\r\n - To remove a policy, delete the corresponding policy statement from the policy document.\r\n - Policies are applied in the order of their appearance, from the top down.\r\n-->\r\n<policies>\r\n <inbound />\r\n <backend>\r\n <forward-request />\r\n </backend>\r\n <outbound />\r\n</policies>"}],"count":1}}}},"ApiManagementDeleteApis":{"parameters":{"apimBaseUrl":"apimservice1.management.azure-api.net","apiId":"5a58bb37a40f7ef2e05bd7f2","api-version":"2017-03-01","If-Match":"\"AAAAAAAAD08=\""},"responses":{"204":{}}},"ApiManagementPutProductsPolicies":{"parameters":{"apimBaseUrl":"apimservice1.management.azure-api.net","productId":"5a58be7ba40f7e104892b23a","policyId":"policy","api-version":"2017-03-01","parameters":{"policyContent":"<policies>\r\n <inbound>\r\n <rate-limit calls=\"5\" renewal-period=\"60\" />\r\n <quota calls=\"100\" renewal-period=\"604800\" />\r\n <base />\r\n </inbound>\r\n <backend>\r\n <base />\r\n </backend>\r\n <outbound>\r\n <base />\r\n </outbound>\r\n</policies>"}},"responses":{"201":{"body":{"id":"/products/5a58be7ba40f7e104892b23a/policies/policy","policyContent":"<policies>\r\n <inbound>\r\n <rate-limit calls=\"5\" renewal-period=\"60\" version=\"2\" />\r\n <quota calls=\"100\" renewal-period=\"604800\" version=\"2\" />\r\n <base />\r\n </inbound>\r\n <backend>\r\n <base />\r\n </backend>\r\n <outbound>\r\n <base />\r\n </outbound>\r\n</policies>"}},"200":{"body":{"id":"/products/5a58be7ba40f7e104892b23a/policies/policy","policyContent":"<policies>\r\n <inbound>\r\n <rate-limit calls=\"5\" renewal-period=\"60\" version=\"2\" />\r\n <quota calls=\"100\" renewal-period=\"604800\" version=\"2\" />\r\n <base />\r\n </inbound>\r\n <backend>\r\n <base />\r\n </backend>\r\n <outbound>\r\n <base />\r\n </outbound>\r\n</policies>"}}}},"ApiManagementPostSubscriptionsRegeneratePrimaryKey":{"parameters":{"apimBaseUrl":"apimservice1.management.azure-api.net","sid":"5a58bb98a40f7ef2e05be76e","api-version":"2017-03-01"},"responses":{"204":{}}},"ApiManagementPatchAuthorizationServers":{"parameters":{"apimBaseUrl":"apimservice1.management.azure-api.net","authsid":"5a58be75a40f7e104892b205","api-version":"2017-03-01","If-Match":"\"AAAAAAAAIn4=\"","parameters":{"authorizationEndpoint":"https://www.contoso.com/oauth2/auth1"}},"responses":{"204":{}}},"ApiManagementDeleteLoggers":{"parameters":{"apimBaseUrl":"apimservice1.management.azure-api.net","loggerid":"5a58bc70a40f7e1048929950","api-version":"2017-03-01","If-Match":"\"AAAAAAAAF30=\""},"responses":{"204":{}}},"ApiManagementPutGroupsUsers":{"parameters":{"apimBaseUrl":"apimservice1.management.azure-api.net","groupId":"5a58bacfa40f7ef2e05bccc6","uid":"5a58bacfa40f7ef2e05bccc0","api-version":"2017-03-01"},"responses":{"201":{"body":{"id":"/users/5a58bacfa40f7ef2e05bccc0","firstName":"5a58bacfa40f7ef2e05bccc2","lastName":"5a58bacfa40f7ef2e05bccc3","email":"5a58bacfa40f7ef2e05bccc1@contoso.com","state":"active","registrationDate":"2018-01-12T13:40:31.663Z","groups":[],"identities":[]}},"200":{"body":{"id":"/users/5a58bacfa40f7ef2e05bccc0","firstName":"5a58bacfa40f7ef2e05bccc2","lastName":"5a58bacfa40f7ef2e05bccc3","email":"5a58bacfa40f7ef2e05bccc1@contoso.com","state":"active","registrationDate":"2018-01-12T13:40:31.663Z","groups":[],"identities":[]}}}},"ApiManagementPatchProducts":{"parameters":{"apimBaseUrl":"apimservice1.management.azure-api.net","productId":"5a58badca40f7ef2e05bcd24","api-version":"2017-03-01","If-Match":"\"AAAAAAAACdk=\"","parameters":{"subscriptionsLimit":1,"state":"notPublished"}},"responses":{"204":{}}},"ApiManagementGetApisOperations":{"parameters":{"apimBaseUrl":"apimservice1.management.azure-api.net","apiId":"5a58bac3a40f7ef2e05bc7db","operationId":"5a58bad9a40f7ef2e05bcd0f","api-version":"2017-03-01","Accept":"application/json"},"responses":{"200":{"body":{"id":"/apis/5a58bac3a40f7ef2e05bc7db/operations/5a58bad9a40f7ef2e05bcd0f","name":"operation_5a58bad9a40f7ef2e05bcd0d","method":"PATCH","urlTemplate":"/template_5a58bad9a40f7ef2e05bcd0e","templateParameters":[],"request":{"queryParameters":[],"headers":[],"representations":[]},"responses":[]}}}},"ApiManagementGetReportsByApi":{"parameters":{"apimBaseUrl":"apimservice1.management.azure-api.net","api-version":"2017-03-01","$filter":"timestamp ge datetime'2017-06-01T00:00:00' and timestamp le datetime'2017-06-04T00:00:00'"},"responses":{"200":{"body":{"value":[{"name":"Echo API","apiId":"/apis/5600b59475ff190048040001","callCountSuccess":0,"callCountBlocked":0,"callCountFailed":0,"callCountOther":0,"callCountTotal":0,"bandwidth":0,"cacheHitCount":0,"cacheMissCount":0,"apiTimeAvg":0,"apiTimeMin":0,"apiTimeMax":0,"serviceTimeAvg":0,"serviceTimeMin":0,"serviceTimeMax":0},{"name":"httpbin","apiId":"/apis/57a03a13e4bbd5119c8b19e9","callCountSuccess":13,"callCountBlocked":1,"callCountFailed":0,"callCountOther":0,"callCountTotal":14,"bandwidth":11019,"cacheHitCount":0,"cacheMissCount":0,"apiTimeAvg":1015.7607923076923,"apiTimeMin":330.3206,"apiTimeMax":1819.2173,"serviceTimeAvg":957.094776923077,"serviceTimeMin":215.24,"serviceTimeMax":1697.3612}],"count":2,"nextLink":""}}}},"ApiManagementListAuthorizationServers":{"parameters":{"apimBaseUrl":"apimservice1.management.azure-api.net","api-version":"2017-03-01","Accept":"application/json"},"responses":{"200":{"body":{"value":[{"id":"/authorizationServers/5a58bb95a40f7ef2e05be74b","name":"2d0057b0-bf3a-4c54-9de7-0e5e39789c1b","description":"test server","clientRegistrationEndpoint":"https://www.contoso.com/apps","authorizationEndpoint":"https://www.contoso.com/oauth2/auth","authorizationMethods":["GET"],"clientAuthenticationMethod":["Basic"],"tokenEndpoint":"https://www.contoso.com/oauth2/token","supportState":true,"defaultScope":"read write","grantTypes":["authorizationCode"],"bearerTokenSendingMethods":["authorizationHeader"],"clientId":"1","clientSecret":"2","resourceOwnerUsername":"un","resourceOwnerPassword":"pwd"},{"id":"/authorizationServers/5a58bb37a40f7ef2e05bd7f3","name":"f3e4a805-3d6e-48e1-839d-05da510d84a5","description":"test server","clientRegistrationEndpoint":"https://www.contoso.com/apps","authorizationEndpoint":"https://www.contoso.com/oauth2/auth","authorizationMethods":["GET"],"clientAuthenticationMethod":["Basic"],"tokenEndpoint":"https://www.contoso.com/oauth2/token","supportState":true,"defaultScope":"read write","grantTypes":["authorizationCode"],"bearerTokenSendingMethods":["authorizationHeader"],"clientId":"1","clientSecret":"2","resourceOwnerUsername":"un","resourceOwnerPassword":"pwd"}],"count":2}}}},"ApiManagementDeleteOpenIdConnectProviders":{"parameters":{"apimBaseUrl":"apimservice1.management.azure-api.net","api-version":"2017-03-01","opid":"templateOpenIdConnect3","If-Match":"*"},"responses":{"204":{}}},"ApiManagementListSubscriptions":{"parameters":{"apimBaseUrl":"apimservice1.management.azure-api.net","$skip":0,"$top":10000,"api-version":"2017-03-01","Accept":"application/json"},"responses":{"200":{"body":{"value":[{"id":"/subscriptions/5a58ba90a40f7e0034070001","userId":"/users/1","productId":"/products/starter","state":"active","createdDate":"2018-01-12T13:39:28.57Z","primaryKey":"<primaryKey>","secondaryKey":"<secondaryKey>"}],"count":1}}}},"ApiManagementListUsers":{"parameters":{"apimBaseUrl":"apimservice1.management.azure-api.net","expandGroups":"False","api-version":"2017-03-01","Accept":"application/json"},"responses":{"200":{"body":{"value":[{"id":"/users/1","firstName":"Administrator","lastName":"","email":"admin@contoso.com","state":"active","registrationDate":"2018-01-12T13:39:28.527Z","identities":[{"provider":"Azure","id":"admin@contoso.com"}]}],"count":1}}}},"ApiManagementDeleteProductsPolicies":{"parameters":{"apimBaseUrl":"apimservice1.management.azure-api.net","productId":"starter","policyId":"policy","api-version":"2017-03-01","If-Match":"*"},"responses":{"204":{}}},"ApiManagementListPolicySnippets":{"parameters":{"apimBaseUrl":"apimservice1.management.azure-api.net","scope":"Api","api-version":"2017-03-01","Accept":"application/json"},"responses":{"200":{"body":[{"name":"Authenticate with Basic","content":"<authentication-basic username=\"username\" password=\"password\" />","toolTip":"Authenticate with the backend service using Basic authentication. Use in the inbound section at API scope.","scope":268435471},{"name":"Authenticate with client certificate","content":"<authentication-certificate thumbprint=\"thumbprint\" />","toolTip":"Authenticate with the backend service using a client certificate. Use in the inbound section at API scope.","scope":268435471},{"name":"Check HTTP header","content":"<check-header name=\"header name\"\r\n failed-check-httpcode=\"http status code to return on failure\"\r\n failed-check-error-message=\"error message to return\"\r\n ignore-case=\"true | false\">\r\n <value>value</value> <!-- if there are multiple possible allowed values, then add additional value elements -->\r\n</check-header>","toolTip":"Check header and return specified HTTP status code if it doesn't exist or match expected value. Works for both response and request headers – policy can be applied in inbound or outbound sections at any scope.","scope":268435471},{"name":"Control flow","content":"<choose>\r\n <when condition=\"@(expression to evaluate)\">\r\n </when>\r\n <when condition=\"@(expression to evaluate)\">\r\n </when>\r\n <otherwise>\r\n </otherwise>\r\n</choose>","toolTip":"Conditionally apply policy statements based on the results of the evaluation of Boolean expressions. Use at any scope in the inbound and outbound sections.","scope":268435471},{"name":"Convert JSON to XML","content":"<json-to-xml apply=\"always | content-type-json\" consider-accept-header=\"true | false\"/>","toolTip":"Convert request or response body from JSON to XML. Use in the inbound or outbound sections at API or Operation scopes.","scope":268435471},{"name":"Convert XML to JSON","content":"<xml-to-json kind=\"javascript-friendly | direct\" apply=\"always | content-type-xml\" consider-accept-header=\"true | false\"/>","toolTip":"Convert request or response body from XML to either \"JSON friendly\" or \"XML faithful\" form of JSON. Use in the inbound or outbound sections at API or Operation scopes.","scope":268435471},{"name":"CORS","content":"<cors>\r\n <allowed-origins>\r\n <origin>*</origin> <!-- allow any -->\r\n <!-- OR a list of one or more specific URIs (case-sensitive) -->\r\n <origin>URI</origin> <!-- URI must include scheme, host, and port. If port is omitted, 80 is assumed for http and 443 is assumed for https. -->\r\n </allowed-origins>\r\n <allowed-methods> <!-- allow any -->\r\n <method>*</method>\r\n </allowed-methods>\r\n <allowed-headers> <!-- allow any -->\r\n <header>*</header>\r\n </allowed-headers>\r\n</cors>","toolTip":"CORS stands for cross-origin resource sharing. Add CORS support to an operation or an API to allow cross-domain calls from browser-based clients. Use in the inbound section only.","scope":13},{"name":"Find and replace string in body","content":"<find-and-replace from=\"what to replace\" to=\"replacement\" />","toolTip":"Find a request or response substring and replace it with a different substring. Use in the inbound and outbound sections at any scope.","scope":268435471},{"name":"Forward request to backend service","content":"<forward-request timeout=\"seconds\" />","toolTip":"Forward request to the backend service using information in the context and receive a response, waiting no longer then specified timeout value. Use at any scope in the backend section.","scope":268435471},{"name":"Get from cache","content":"<cache-lookup vary-by-developer=\"true | false\" vary-by-developer-groups=\"true | false\" downstream-caching-type=\"none | private | public\" must-revalidate=\"true | false\" allow-private-response-caching=\"@(expression to evaluate)\">\r\n <vary-by-header>Accept</vary-by-header> <!-- should be present in most cases -->\r\n <vary-by-header>Accept-Charset</vary-by-header> <!-- should be present in most cases -->\r\n <vary-by-header>Authorization</vary-by-header> <!-- should be present when allow-authorized-response-caching is \"true\"-->\r\n <vary-by-header>header name</vary-by-header> <!-- optional, can repeated several times -->\r\n <vary-by-query-parameter>parameter name</vary-by-query-parameter> <!-- optional, can repeated several times -->\r\n</cache-lookup>","toolTip":"Perform cache lookup and return a valid cached response when available. Appropriately respond to cache validation requests from callers. Use anywhere in the inbound section at Product, API, or Operation scopes.","scope":268435471},{"name":"Get value from cache","content":"<cache-lookup-value key=\"@(expression to evaluate)\" default-value=\"@(expression to evaluate)\" variable-name=\"name of a variable to put response into\" />","toolTip":"Perform cache lookup and returned value under the key, if available, or default. If value is not present and no default is specified, variable will not be set. Use at any scope in any section except <backend>.","scope":268435471},{"name":"JSONP","content":"<jsonp callback-parameter-name=\"callback function name\" />","toolTip":"Add support for JSONP to an operation or an API to allow cross-domain calls from JavaScript browser-based clients. Use in the outbound section only.","scope":268435471},{"name":"Limit call rate per key","content":"<rate-limit-by-key calls=\"number\" renewal-period=\"seconds\" \r\n counter-key=\"expression like @(context.Subscription.Id) or a constant string\"\r\n increment-count=\"optional, by default = 1\"\r\n flexible-retry-window=\"optional, by default = false\"\r\n/>","toolTip":"Arrest usage spikes by limiting calls and/or bandwidth consumption rate per calculated key. Use in the inbound section at any scope.","scope":268435471},{"name":"Limit request processing concurrency level","content":"<limit-concurrency key=\"@(expression) or a constant string\" max-count=\"10\" >\r\n</limit-concurrency>","toolTip":"Limit how many calls may be processed in parallel for the duration of this policy's body.","scope":268435471},{"name":"Log to EventHub","content":"<log-to-eventhub logger-id ='logger-id'>\r\n @( string.Join(\",\", DateTime.UtcNow, context.Deployment.ServiceName, context.RequestId, context.Request.IpAddress, context.Operation.Name) ) \r\n </log-to-eventhub>","toolTip":"Send custom messages to Event Hub. Use at any scope in the inbound or outbound sections.","scope":268435471},{"name":"Mask URLs in content","content":"<redirect-content-urls />","toolTip":"Use in the outbound section to re-write response body links and Location header values making them point to the proxy. Use in the inbound section for an opposite effect. Apply at API or Operation scopes.","scope":268435471},{"name":"Mock Response","content":"<mock-response status-code='200' content-type='application/json'/>","toolTip":"Mock response based on operation responses samples/schemas. Use at any scope in the inbound or outbound sections.","scope":268435471},{"name":"Output trace information","content":"<trace source=\"source name\">\r\n @(context.Request.Url.ToUri().ToString()) \r\n</trace>","toolTip":"Output information into trace logs, if request is executed with tracing enabled.","scope":268435471},{"name":"Remove value from cache","content":"<cache-remove-value key=\"@(expression to evaluate)\" />","toolTip":"Remove value from cache under the key. Use at any scope in any section except <backend>.","scope":268435471},{"name":"Restrict caller IPs","content":"<ip-filter action=\"allow | forbid\">\r\n <address>address</address>\r\n <address-range from=\"address\" to=\"address\" />\r\n</ip-filter>","toolTip":"Allow calls only from specific IP addresses and/or address ranges. Forbid calls from specific IP addresses and/or address ranges. Use in the inbound section at any scope.","scope":268435471},{"name":"Retry","content":"<retry condition=\"@( decide whether retry is required )\" count=\"10\" interval=\"seconds\">\r\n <!-- put retryable sequence here -->\r\n</retry>","toolTip":"Retry execution of the enclosed policy statements, if and until the condition is met. Execution will repeat at the specified time interval, up to the specified count.","scope":268435471},{"name":"Return response","content":"<return-response response-variable-name=\"existing response variable\">\r\n <set-status code=\"code\" reason=\"reason\" />\r\n <set-header name=\"header name\" exists-action=\"override | skip | append | delete\">\r\n <value>value</value> <!-- for multiple headers with the same name add additional value elements -->\r\n</set-header>\r\n <set-body>new body value as text</set-body>\r\n</return-response>","toolTip":"Abort pipeline execution and return the specified response directly to the caller. Use at any scope in the inbound and outbound sections.","scope":268435471},{"name":"Rewrite URL","content":"<rewrite-uri template=\"uri template\" />","toolTip":"Convert request URL from its public form to the form expected by the web service. Use anywhere in the inbound section at Operation scope only.","scope":14},{"name":"Send one way request","content":"<send-one-way-request mode=\"new | copy\">\r\n <set-url>service URL to call</set-url>\r\n <set-method>GET</set-method>\r\n <set-header name=\"header name\" exists-action=\"override | skip | append | delete\">\r\n <value>value</value> <!-- for multiple headers with the same name add additional value elements -->\r\n </set-header>\r\n <set-body>new body value as text</set-body>\r\n</send-one-way-request>","toolTip":"Send provided request to the specified URL, without waiting for response. Use at any scope in the inbound and outbound sections.","scope":268435471},{"name":"Send request","content":"<send-request mode=\"new | copy\" response-variable-name=\"name of a variable to put response into\" timeout=\"seconds\" ignore-error=\"false | true\">\r\n <set-url>service URL to call</set-url>\r\n <set-method>GET</set-method>\r\n <set-header name=\"header name\" exists-action=\"override | skip | append | delete\">\r\n <value>value</value> <!-- for multiple headers with the same name add additional value elements -->\r\n </set-header>\r\n <set-body>new body value as text</set-body>\r\n</send-request>","toolTip":"Send provided request to the specified URL, waiting no longer then set timeout value. Use at any scope in the inbound and outbound sections.","scope":268435471},{"name":"Set backend service","content":"<set-backend-service base-url=\"https://backend.com/service\" />","toolTip":"Change backend service where the incoming calls will be directed. Use in the inbound section only at any scope.","scope":268435471},{"name":"Set body","content":"<set-body template=\"none\">new body value as text</set-body>","toolTip":"Set message body to a specific string value. The policy has no effect on the Content-Type header value. Use at any scope in the inbound or outbound sections.","scope":268435471},{"name":"Set context variable","content":"<set-variable name=\"variable name\" value=\"@(expression to evaluate)\" />","toolTip":"Persist a value in a named context variable for later access from expressions. Use at any scope in the inbound and outbound sections.","scope":268435471},{"name":"Set HTTP header","content":"<set-header name=\"header name\" exists-action=\"override | skip | append | delete\">\r\n <value>value</value> <!-- for multiple headers with the same name add additional value elements -->\r\n</set-header>","toolTip":"Add a new header, change the value of an existing header or remove a header. Works for both response and request headers – policy can be applied in inbound or outbound sections at any scope.","scope":268435471},{"name":"Set http proxy for backend request","content":"<proxy url=\"http://localhost:8080\" username=\"username\" password=\"password\" />","toolTip":"Specify http proxy location and credentials.","scope":268435471},{"name":"Set query string parameter","content":"<set-query-parameter name=\"param name\" exists-action=\"override | skip | append | delete\">\r\n <value>value</value> <!-- for multiple parameters with the same name add additional value elements -->\r\n</set-query-parameter>","toolTip":"Add a new query string parameter, change the value of an existing parameter or remove a parameter. Can be applied in the inbound section at any scope.","scope":268435471},{"name":"Set request method","content":"<set-method>METHOD</set-method>","toolTip":"Change HTTP method to the specified value","scope":268435471},{"name":"Set status code","content":"<set-status code=\"code\" reason=\"reason\" />","toolTip":"Change HTTP status code to the specified value. Use at any scope in the outbound sections.","scope":268435471},{"name":"Set usage quota per key","content":"<quota-by-key calls=\"number\" bandwidth=\"kilobytes\" \r\n renewal-period=\"period as number of seconds or xml timespan as 'PxxYxxMxxDTxxHxxMxxS' where xx are numbers\" \r\n counter-key=\"@(expression) or a constant string\"\r\n first-period-start=\"optional, date as 2002-05-30T09:30:10-06:00\"\r\n increment-condition=\"optional boolean expression like @( context.Response.StatusCode >= 200 && context.Response.StatusCode < 400 ) \"\r\n increment-count=\"expression like @(context.Request.Method == \"POST\" ? 1:0) or a constant integer value. Optional, by default = 1.\"\r\n/>","toolTip":"Enforce a renewable or lifetime call volume and/or bandwidth quota per calculated key. Use in the inbound section at any scope.","scope":268435471},{"name":"Store to cache","content":"<cache-store duration=\"seconds\" />","toolTip":"Cache responses according to the specified cache configuration. Use anywhere in the outbound section at Product, API, or Operation scopes.","scope":268435471},{"name":"Store value in cache","content":"<cache-store-value key=\"@(expression to evaluate)\" value=\"@(expression to evaluate)\" duration=\"seconds\" />","toolTip":"Store value in cache under a key for duration. Use at any scope in any section except <backend>.","scope":268435471},{"name":"Transform XML using an XSLT","content":"<xsl-transform>\r\n\t\t\t<parameter name=\"User-Agent\">@(context.Request.Headers.GetValueOrDefault(\"User-Agent\",\"non-specified\"))</parameter>\r\n\t\t\t<xsl:stylesheet version=\"1.0\" xmlns:xsl=\"http://www.w3.org/1999/XSL/Transform\">\r\n\t\t\t\t<xsl:output method=\"xml\" indent=\"yes\" />\r\n\t\t\t\t<xsl:param name=\"User-Agent\" />\r\n\t\t\t\t<xsl:template match=\"* | @* | node()\">\r\n\t\t\t\t\t<xsl:copy>\r\n\t\t\t\t\t\t<xsl:if test=\"self::* and not(parent::*)\">\r\n\t\t\t\t\t\t\t<xsl:attribute name=\"User-Agent\">\r\n\t\t\t\t\t\t\t\t<xsl:value-of select=\"$User-Agent\" />\r\n\t\t\t\t\t\t\t</xsl:attribute>\r\n\t\t\t\t\t\t</xsl:if>\r\n\t\t\t\t\t\t<xsl:apply-templates select=\"* | @* | node()\" />\r\n\t\t\t\t\t</xsl:copy>\r\n\t\t\t\t</xsl:template>\r\n\t\t\t</xsl:stylesheet>\r\n\t\t</xsl-transform>","toolTip":"Transform request or response body using XSLTransform. Use in the inbound, outbound and on-error sections at any scope.","scope":268435471},{"name":"Validate JWT","content":"<validate-jwt header-name=\"Insert HTTP Header Name here\" failed-validation-httpcode=\"401\" failed-validation-error-message=\"Unauthorized\">\r\n <issuer-signing-keys>\r\n <key>Base64 Encoded Key 1</key>\r\n <!-- if there are multiple possible allowed values, then add additional value elements -->\r\n </issuer-signing-keys>\r\n <audiences>\r\n <audience>Audience 1</audience>\r\n <!-- if there are multiple possible allowed values, then add additional value elements -->\r\n </audiences>\r\n <issuers>\r\n <issuer>Issuer 1</issuer>\r\n <!-- if there are multiple possible allowed values, then add additional value elements -->\r\n </issuers>\r\n <required-claims>\r\n <claim name=\"claim1\" match=\"all\">\r\n <value>value1</value>\r\n <value>value2</value>\r\n </claim>\r\n <!-- if there are multiple possible allowed values, then add additional value elements -->\r\n </required-claims>\r\n</validate-jwt>","toolTip":"Check and validate a JWT in a header or query parameter. Use in the inbound section at any scope.","scope":268435471},{"name":"Wait for...","content":"<wait for=\"all|any\">\r\n <send-request ... />\r\n <cache-lookup-value ... />\r\n</wait>","toolTip":"Wait for all or any of the send request policies to complete before proceeding. Use at any scope in the inbound and outbound sections.","scope":268435471}]}}},"ApiManagementPatchApis":{"parameters":{"apimBaseUrl":"apimservice1.management.azure-api.net","apiId":"5a58bac3a40f7ef2e05bc7db","api-version":"2017-03-01","If-Match":"\"AAAAAAAACFc=\"","parameters":{"serviceUrl":"https://api.apim.net"}},"responses":{"204":{}}},"ApiManagementHeadProductsPolicies":{"parameters":{"apimBaseUrl":"apimservice1.management.azure-api.net","productId":"5a58bf24a40f7e104892b5d2","policyId":"policy","api-version":"2017-03-01","Accept":"application/json"},"responses":{"200":{}}},"ApiManagementListLoggers":{"parameters":{"apimBaseUrl":"apimservice1.management.azure-api.net","api-version":"2017-03-01","Accept":"application/json"},"responses":{"200":{"body":{"value":[{"id":"/loggers/5a58bc28a40f7e10489292a3","loggerType":"azureEventHub","description":"first eventhub logger","credentials":{"name":"testeventhub3","connectionString":"{{Logger-Credentials-5a58bc31a40f7e10489292a5}}"},"isBuffered":true},{"id":"/loggers/5a58bc37a40f7e1048929319","loggerType":"azureEventHub","description":"first eventhub logger","credentials":{"name":"testeventhub3","connectionString":"{{Logger-Credentials-5a58bc39a40f7e104892931b}}"},"isBuffered":true}],"count":2}}}},"ApiManagementGetApisOperationsPolicies":{"parameters":{"apimBaseUrl":"apimservice1.management.azure-api.net","apiId":"5a58bfeea40f7e104892c5b6","operationId":"5a58bfeea40f7e104892c5c9","policyId":"policy","api-version":"2017-03-01","Accept":"application/json"},"responses":{"200":{"body":{"id":"/apis/5a58bfeea40f7e104892c5b6/operations/5a58bfeea40f7e104892c5c9/policies/policy","policyContent":"<policies>\r\n <inbound>\r\n <base />\r\n <rewrite-uri template=\"/resource\" />\r\n </inbound>\r\n <backend>\r\n <base />\r\n </backend>\r\n <outbound>\r\n <base />\r\n </outbound>\r\n</policies>"}}}},"ApiManagementDeleteCertificates":{"parameters":{"apimBaseUrl":"apimservice1.management.azure-api.net","certificateId":"5a58bb04a40f7ef2e05bd3a6","api-version":"2017-03-01","If-Match":"*"},"responses":{"204":{}}},"ApiManagementListUsersIdentities":{"parameters":{"apimBaseUrl":"apimservice1.management.azure-api.net","uid":"5a58bb0aa40f7ef2e05bd3c2","api-version":"2017-03-01","Accept":"application/json"},"responses":{"200":{"body":{"value":[{"provider":"Basic","id":"5a58bb09a40f7ef2e05bd3c1@contoso.com"}],"count":1}}}},"ApiManagementGetPortalSettingsDelegation":{"parameters":{"apimBaseUrl":"apimservice1.management.azure-api.net","api-version":"2017-03-01"},"responses":{"200":{"body":{"url":"http://contoso.com/delegation","validationKey":"<validationKey>","subscriptions":{"enabled":true},"userRegistration":{"enabled":true}}}}},"ApiManagementDeleteProductsApis":{"parameters":{"apimBaseUrl":"apimservice1.management.azure-api.net","productId":"5a58bd5aa40f7e104892a53c","apiId":"5a58bd5aa40f7e104892a541","api-version":"2017-03-01"},"responses":{"204":{}}},"ApiManagementPatchQuotas":{"parameters":{"apimBaseUrl":"apimservice1.management.azure-api.net","api-version":"2017-03-01","quotaCounterKey":"ba","parameters":{"callsCount":0,"kbTransferred":2.5630078125}},"responses":{"204":{}}},"ApiManagementDeleteProperties":{"parameters":{"apimBaseUrl":"apimservice1.management.azure-api.net","propId":"5a58bd51a40f7e104892a4cf","api-version":"2017-03-01","If-Match":"*"},"responses":{"204":{}}},"ApiManagementDeleteGroupsUsers":{"parameters":{"apimBaseUrl":"apimservice1.management.azure-api.net","groupId":"5a58bae8a40f7ef2e05bcda2","uid":"5a58bae8a40f7ef2e05bcda5","api-version":"2017-03-01"},"responses":{"204":{}}},"ApiManagementDeleteIdentityProviders":{"parameters":{"apimBaseUrl":"apimservice1.management.azure-api.net","identityProviderName":"aadB2C","api-version":"2017-03-01","If-Match":"*"},"responses":{"204":{}}},"ApiManagementGetApisSchemas":{"parameters":{"apimBaseUrl":"apimservice1.management.azure-api.net","apiId":"5a58bde0a40f7e104892ac24","schemaId":"5a58bde0a40f7e104892ac25","api-version":"2017-03-01","Accept":"application/json"},"responses":{"200":{"body":{"id":"/apis/5a58bde0a40f7e104892ac24/schemas/5a58bde0a40f7e104892ac25","contentType":"application/vnd.ms-azure-apim.xsd+xml","document":{"value":"<s:schema elementFormDefault=\"qualified\" targetNamespace=\"http://ws.cdyne.com/WeatherWS/\" xmlns:tns=\"http://ws.cdyne.com/WeatherWS/\" xmlns:s=\"http://www.w3.org/2001/XMLSchema\" xmlns:soap12=\"http://schemas.xmlsoap.org/wsdl/soap12/\" xmlns:mime=\"http://schemas.xmlsoap.org/wsdl/mime/\" xmlns:soap=\"http://schemas.xmlsoap.org/wsdl/soap/\" xmlns:tm=\"http://microsoft.com/wsdl/mime/textMatching/\" xmlns:http=\"http://schemas.xmlsoap.org/wsdl/http/\" xmlns:soapenc=\"http://schemas.xmlsoap.org/soap/encoding/\" xmlns:wsdl=\"http://schemas.xmlsoap.org/wsdl/\" xmlns:apim-wsdltns=\"http://ws.cdyne.com/WeatherWS/\">\r\n <s:element name=\"GetWeatherInformation\">\r\n <s:complexType />\r\n </s:element>\r\n <s:element name=\"GetWeatherInformationResponse\">\r\n <s:complexType>\r\n <s:sequence>\r\n <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"GetWeatherInformationResult\" type=\"tns:ArrayOfWeatherDescription\" />\r\n </s:sequence>\r\n </s:complexType>\r\n </s:element>\r\n <s:complexType name=\"ArrayOfWeatherDescription\">\r\n <s:sequence>\r\n <s:element minOccurs=\"0\" maxOccurs=\"unbounded\" name=\"WeatherDescription\" type=\"tns:WeatherDescription\" />\r\n </s:sequence>\r\n </s:complexType>\r\n <s:complexType name=\"WeatherDescription\">\r\n <s:sequence>\r\n <s:element minOccurs=\"1\" maxOccurs=\"1\" name=\"WeatherID\" type=\"s:short\" />\r\n <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"Description\" type=\"s:string\" />\r\n <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"PictureURL\" type=\"s:string\" />\r\n </s:sequence>\r\n </s:complexType>\r\n <s:element name=\"GetCityForecastByZIP\">\r\n <s:complexType>\r\n <s:sequence>\r\n <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"ZIP\" type=\"s:string\" />\r\n </s:sequence>\r\n </s:complexType>\r\n </s:element>\r\n <s:element name=\"GetCityForecastByZIPResponse\">\r\n <s:complexType>\r\n <s:sequence>\r\n <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"GetCityForecastByZIPResult\" type=\"tns:ForecastReturn\" />\r\n </s:sequence>\r\n </s:complexType>\r\n </s:element>\r\n <s:complexType name=\"ForecastReturn\">\r\n <s:sequence>\r\n <s:element minOccurs=\"1\" maxOccurs=\"1\" name=\"Success\" type=\"s:boolean\" />\r\n <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"ResponseText\" type=\"s:string\" />\r\n <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"State\" type=\"s:string\" />\r\n <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"City\" type=\"s:string\" />\r\n <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"WeatherStationCity\" type=\"s:string\" />\r\n <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"ForecastResult\" type=\"tns:ArrayOfForecast\" />\r\n </s:sequence>\r\n </s:complexType>\r\n <s:complexType name=\"ArrayOfForecast\">\r\n <s:sequence>\r\n <s:element minOccurs=\"0\" maxOccurs=\"unbounded\" name=\"Forecast\" nillable=\"true\" type=\"tns:Forecast\" />\r\n </s:sequence>\r\n </s:complexType>\r\n <s:complexType name=\"Forecast\">\r\n <s:sequence>\r\n <s:element minOccurs=\"1\" maxOccurs=\"1\" name=\"Date\" type=\"s:dateTime\" />\r\n <s:element minOccurs=\"1\" maxOccurs=\"1\" name=\"WeatherID\" type=\"s:short\" />\r\n <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"Desciption\" type=\"s:string\" />\r\n <s:element minOccurs=\"1\" maxOccurs=\"1\" name=\"Temperatures\" type=\"tns:temp\" />\r\n <s:element minOccurs=\"1\" maxOccurs=\"1\" name=\"ProbabilityOfPrecipiation\" type=\"tns:POP\" />\r\n </s:sequence>\r\n </s:complexType>\r\n <s:complexType name=\"temp\">\r\n <s:sequence>\r\n <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"MorningLow\" type=\"s:string\" />\r\n <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"DaytimeHigh\" type=\"s:string\" />\r\n </s:sequence>\r\n </s:complexType>\r\n <s:complexType name=\"POP\">\r\n <s:sequence>\r\n <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"Nighttime\" type=\"s:string\" />\r\n <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"Daytime\" type=\"s:string\" />\r\n </s:sequence>\r\n </s:complexType>\r\n <s:element name=\"GetCityWeatherByZIP\">\r\n <s:complexType>\r\n <s:sequence>\r\n <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"ZIP\" type=\"s:string\" />\r\n </s:sequence>\r\n </s:complexType>\r\n </s:element>\r\n <s:element name=\"GetCityWeatherByZIPResponse\">\r\n <s:complexType>\r\n <s:sequence>\r\n <s:element minOccurs=\"1\" maxOccurs=\"1\" name=\"GetCityWeatherByZIPResult\" type=\"tns:WeatherReturn\" />\r\n </s:sequence>\r\n </s:complexType>\r\n </s:element>\r\n <s:complexType name=\"WeatherReturn\">\r\n <s:sequence>\r\n <s:element minOccurs=\"1\" maxOccurs=\"1\" name=\"Success\" type=\"s:boolean\" />\r\n <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"ResponseText\" type=\"s:string\" />\r\n <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"State\" type=\"s:string\" />\r\n <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"City\" type=\"s:string\" />\r\n <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"WeatherStationCity\" type=\"s:string\" />\r\n <s:element minOccurs=\"1\" maxOccurs=\"1\" name=\"WeatherID\" type=\"s:short\" />\r\n <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"Description\" type=\"s:string\" />\r\n <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"Temperature\" type=\"s:string\" />\r\n <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"RelativeHumidity\" type=\"s:string\" />\r\n <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"Wind\" type=\"s:string\" />\r\n <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"Pressure\" type=\"s:string\" />\r\n <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"Visibility\" type=\"s:string\" />\r\n <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"WindChill\" type=\"s:string\" />\r\n <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"Remarks\" type=\"s:string\" />\r\n </s:sequence>\r\n </s:complexType>\r\n <s:element name=\"ArrayOfWeatherDescription\" nillable=\"true\" type=\"tns:ArrayOfWeatherDescription\" />\r\n <s:element name=\"ForecastReturn\" nillable=\"true\" type=\"tns:ForecastReturn\" />\r\n <s:element name=\"WeatherReturn\" type=\"tns:WeatherReturn\" />\r\n</s:schema>"}}}}},"ApiManagementListOpenIdConnectProvider":{"parameters":{"apimBaseUrl":"apimservice1.management.azure-api.net","api-version":"2017-03-01"},"responses":{"200":{"body":{"value":[{"id":"/openidConnectProviders/op1","name":"templateoidprovider3","metadataEndpoint":"https://oidprovider-template3.net","clientId":"oidprovidertemplate3"}],"count":1}}}},"ApiManagementPutApisOperationsPolicies":{"parameters":{"apimBaseUrl":"apimservice1.management.azure-api.net","apiId":"5a58bc94a40f7e10489299ac","operationId":"5a58bc94a40f7e10489299bf","policyId":"policy","api-version":"2017-03-01","If-Match":"*","parameters":{"policyContent":"<policies>\r\n <inbound>\r\n <base />\r\n <rewrite-uri template=\"/resource\" />\r\n </inbound>\r\n <backend>\r\n <base />\r\n </backend>\r\n <outbound>\r\n <base />\r\n </outbound>\r\n</policies>"}},"responses":{"201":{"body":{"id":"/apis/5a58bc94a40f7e10489299ac/operations/5a58bc94a40f7e10489299bf/policies/policy","policyContent":"<policies>\r\n <inbound>\r\n <base />\r\n <rewrite-uri template=\"/resource\" />\r\n </inbound>\r\n <backend>\r\n <base />\r\n </backend>\r\n <outbound>\r\n <base />\r\n </outbound>\r\n</policies>"}},"200":{"body":{"id":"/apis/5a58bc94a40f7e10489299ac/operations/5a58bc94a40f7e10489299bf/policies/policy","policyContent":"<policies>\r\n <inbound>\r\n <base />\r\n <rewrite-uri template=\"/resource\" />\r\n </inbound>\r\n <backend>\r\n <base />\r\n </backend>\r\n <outbound>\r\n <base />\r\n </outbound>\r\n</policies>"}}}},"ApiManagementGetUsers":{"parameters":{"apimBaseUrl":"apimservice1.management.azure-api.net","uid":"5a58badfa40f7ef2e05bcd37","api-version":"2017-03-01","Accept":"application/json"},"responses":{"200":{"body":{"id":"/users/5a58badfa40f7ef2e05bcd37","firstName":"5a58badfa40f7ef2e05bcd39","lastName":"5a58badfa40f7ef2e05bcd3a","email":"5a58badfa40f7ef2e05bcd38@contoso.com","state":"active","registrationDate":"2018-01-12T13:40:47.3Z","identities":[{"provider":"Basic","id":"5a58badfa40f7ef2e05bcd38@contoso.com"}]}}}},"ApiManagementPutCertificates":{"parameters":{"apimBaseUrl":"apimservice1.management.azure-api.net","certificateId":"5a58bad2a40f7ef2e05bcce2","api-version":"2017-03-01","parameters":{"data":"Based 64 Encoded Certificate string","password":"<password>"}},"responses":{"201":{"body":{"id":"/certificates/5a58bad2a40f7ef2e05bcce2","subject":"CN=localhost","thumbprint":"C2728598048BE9C8BD559A159BD70525A4EA0367","expirationDate":"2019-01-12T08:00:00Z"}},"200":{"body":{"id":"/certificates/5a58bad2a40f7ef2e05bcce2","subject":"CN=localhost","thumbprint":"C2728598048BE9C8BD559A159BD70525A4EA0367","expirationDate":"2019-01-12T08:00:00Z"}}}},"ApiManagementPostSubscriptionsRegenerateSecondaryKey":{"parameters":{"apimBaseUrl":"apimservice1.management.azure-api.net","sid":"5a58bd09a40f7e1048929de9","api-version":"2017-03-01"},"responses":{"204":{}}},"ApiManagementListApis":{"parameters":{"apimBaseUrl":"apimservice1.management.azure-api.net","api-version":"2017-03-01","Accept":"application/json"},"responses":{"200":{"body":{"value":[{"id":"/apis/5a58bac3a40f7ef2e05bc7db","name":"5a58bac3a40f7ef2e05bc7d7","apiRevision":"1","serviceUrl":"https://5a58bac3a40f7ef2e05bc7dc","path":"suffix_5a58bac3a40f7ef2e05bc7dd","protocols":["https"],"isCurrent":true},{"id":"/apis/5a58bac3a40f7ef2e05bc7de","name":"5a58bac3a40f7ef2e05bc7d8","apiRevision":"1","serviceUrl":"https://5a58bac3a40f7ef2e05bc7df","path":"suffix_5a58bac3a40f7ef2e05bc7e0","protocols":["https"],"isCurrent":true},{"id":"/apis/5a58babfa40f7ef2e05bc7bb","name":"api_5a58babfa40f7ef2e05bc7bc","apiRevision":"1","description":"description_5a58babfa40f7ef2e05bc7bd","serviceUrl":"http://contoso/5a58babfa40f7ef2e05bc7be","path":"suffix_5a58babfa40f7ef2e05bc7bf","protocols":["https"],"isCurrent":true}],"count":71}}}},"ApiManagementPutPolicies":{"parameters":{"apimBaseUrl":"apimservice1.management.azure-api.net","policyId":"policy","api-version":"2017-03-01","parameters":{"policyContent":"<policies>\r\n <inbound>\r\n <find-and-replace from=\"aaa\" to=\"BBB\" />\r\n <set-header name=\"ETag\" exists-action=\"skip\">\r\n <value>bbyby</value>\r\n <!-- for multiple headers with the same name add additional value elements -->\r\n </set-header>\r\n <set-query-parameter name=\"additional\" exists-action=\"append\">\r\n <value>xxbbcczc</value>\r\n <!-- for multiple parameters with the same name add additional value elements -->\r\n </set-query-parameter>\r\n <cross-domain />\r\n </inbound>\r\n <backend>\r\n <forward-request />\r\n </backend>\r\n <outbound />\r\n</policies>"}},"responses":{"201":{"body":{"id":"/policies/policy","policyContent":"<policies>\r\n <inbound>\r\n <find-and-replace from=\"aaa\" to=\"BBB\" />\r\n <set-header name=\"ETag\" exists-action=\"skip\">\r\n <value>bbyby</value>\r\n <!-- for multiple headers with the same name add additional value elements -->\r\n </set-header>\r\n <set-query-parameter name=\"additional\" exists-action=\"append\">\r\n <value>xxbbcczc</value>\r\n <!-- for multiple parameters with the same name add additional value elements -->\r\n </set-query-parameter>\r\n <cross-domain />\r\n </inbound>\r\n <backend>\r\n <forward-request />\r\n </backend>\r\n <outbound />\r\n</policies>"}},"200":{"body":{"id":"/policies/policy","policyContent":"<policies>\r\n <inbound>\r\n <find-and-replace from=\"aaa\" to=\"BBB\" />\r\n <set-header name=\"ETag\" exists-action=\"skip\">\r\n <value>bbyby</value>\r\n <!-- for multiple headers with the same name add additional value elements -->\r\n </set-header>\r\n <set-query-parameter name=\"additional\" exists-action=\"append\">\r\n <value>xxbbcczc</value>\r\n <!-- for multiple parameters with the same name add additional value elements -->\r\n </set-query-parameter>\r\n <cross-domain />\r\n </inbound>\r\n <backend>\r\n <forward-request />\r\n </backend>\r\n <outbound />\r\n</policies>"}}}},"ApiManagementPutProductsApis":{"parameters":{"apimBaseUrl":"apimservice1.management.azure-api.net","productId":"5a58bac7a40f7ef2e05bcafb","apiId":"5a58bac7a40f7ef2e05bcb05","api-version":"2017-03-01"},"responses":{"201":{"body":{"id":"/apis/5a58bac7a40f7ef2e05bcb05","name":"api_5a58bac7a40f7ef2e05bcb06","apiRevision":"1","description":"description_5a58bac7a40f7ef2e05bcb07","serviceUrl":"http://contoso/5a58bac7a40f7ef2e05bcb08","path":"suffix_5a58bac7a40f7ef2e05bcb09","isCurrent":true}},"200":{"body":{"id":"/apis/5a58bac7a40f7ef2e05bcb05","name":"api_5a58bac7a40f7ef2e05bcb06","apiRevision":"1","description":"description_5a58bac7a40f7ef2e05bcb07","serviceUrl":"http://contoso/5a58bac7a40f7ef2e05bcb08","path":"suffix_5a58bac7a40f7ef2e05bcb09","isCurrent":true}}}},"ApiManagementPutAuthorizationServers":{"parameters":{"apimBaseUrl":"apimservice1.management.azure-api.net","authsid":"5a58bb1ca40f7ef2e05bd557","api-version":"2017-03-01","parameters":{"name":"68d89b6f-a724-4035-bc3c-a7ab17d849d8","description":"test server","clientRegistrationEndpoint":"https://www.contoso.com/apps","authorizationEndpoint":"https://www.contoso.com/oauth2/auth","authorizationMethods":["GET"],"clientAuthenticationMethod":["Basic"],"tokenEndpoint":"https://www.contoso.com/oauth2/token","supportState":true,"defaultScope":"read write","grantTypes":["authorizationCode"],"bearerTokenSendingMethods":["authorizationHeader"],"clientId":"1","clientSecret":"2","resourceOwnerUsername":"un","resourceOwnerPassword":"pwd"}},"responses":{"201":{"body":{"id":"/authorizationServers/5a58bb1ca40f7ef2e05bd557","name":"68d89b6f-a724-4035-bc3c-a7ab17d849d8","description":"test server","clientRegistrationEndpoint":"https://www.contoso.com/apps","authorizationEndpoint":"https://www.contoso.com/oauth2/auth","authorizationMethods":["GET"],"clientAuthenticationMethod":["Basic"],"tokenEndpoint":"https://www.contoso.com/oauth2/token","supportState":true,"defaultScope":"read write","grantTypes":["authorizationCode"],"bearerTokenSendingMethods":["authorizationHeader"],"clientId":"1","clientSecret":"2","resourceOwnerUsername":"un","resourceOwnerPassword":"pwd"}},"200":{"body":{"id":"/authorizationServers/5a58bb1ca40f7ef2e05bd557","name":"68d89b6f-a724-4035-bc3c-a7ab17d849d8","description":"test server","clientRegistrationEndpoint":"https://www.contoso.com/apps","authorizationEndpoint":"https://www.contoso.com/oauth2/auth","authorizationMethods":["GET"],"clientAuthenticationMethod":["Basic"],"tokenEndpoint":"https://www.contoso.com/oauth2/token","supportState":true,"defaultScope":"read write","grantTypes":["authorizationCode"],"bearerTokenSendingMethods":["authorizationHeader"],"clientId":"1","clientSecret":"2","resourceOwnerUsername":"un","resourceOwnerPassword":"pwd"}}}},"ApiManagementPutApisOperations":{"parameters":{"apimBaseUrl":"apimservice1.management.azure-api.net","apiId":"5a58bab8a40f7ef2e05bc7a1","operationId":"5a58bab8a40f7ef2e05bc7aa","api-version":"2017-03-01","parameters":{"name":"operation_5a58bab8a40f7ef2e05bc7a7","method":"PATCH","urlTemplate":"template_5a58bab8a40f7ef2e05bc7a9","description":"description_5a58bab8a40f7ef2e05bc7a8"}},"responses":{"201":{"body":{"id":"/apis/5a58bab8a40f7ef2e05bc7a1/operations/5a58bab8a40f7ef2e05bc7aa","name":"operation_5a58bab8a40f7ef2e05bc7a7","method":"PATCH","urlTemplate":"/template_5a58bab8a40f7ef2e05bc7a9","templateParameters":[],"description":"description_5a58bab8a40f7ef2e05bc7a8","request":{"queryParameters":[],"headers":[],"representations":[]},"responses":[]}},"200":{"body":{"id":"/apis/5a58bab8a40f7ef2e05bc7a1/operations/5a58bab8a40f7ef2e05bc7aa","name":"operation_5a58bab8a40f7ef2e05bc7a7","method":"PATCH","urlTemplate":"/template_5a58bab8a40f7ef2e05bc7a9","templateParameters":[],"description":"description_5a58bab8a40f7ef2e05bc7a8","request":{"queryParameters":[],"headers":[],"representations":[]},"responses":[]}}}},"ApiManagementPutPortalSettingsSignIn":{"parameters":{"apimBaseUrl":"apimservice1.management.azure-api.net","api-version":"2017-03-01","If-Match":"*","parameters":{"enabled":true}},"responses":{"204":{}}},"ApiManagementPutPortalSettingsSignUp":{"parameters":{"apimBaseUrl":"apimservice1.management.azure-api.net","portalsettings":"signup","api-version":"2017-03-01","parameters":{"enabled":true,"termsOfService":{"text":"terms of service text","enabled":true,"consentRequired":false}}},"responses":{"204":{}}},"ApiManagementPutTemplates":{"parameters":{"apimBaseUrl":"apimservice1.management.azure-api.net","templateName":"newIssueNotificationMessage","api-version":"2017-03-01","Accept":"application/json","parameters":{"subject":"Your request for $IssueName was successfully received."}},"responses":{"201":{"body":{"id":"/templates/ApplicationApprovedNotificationMessage","subject":"Your application $AppName is published in the application gallery","body":"<!DOCTYPE html >\r\n<html>\r\n <head />\r\n <body>\r\n <p style=\"font-size:12pt;font-family:'Segoe UI'\">Dear $DevFirstName $DevLastName,</p>\r\n <p style=\"font-size:12pt;font-family:'Segoe UI'\">\r\n We are happy to let you know that your request to publish the $AppName application in the application gallery has been approved. Your application has been published and can be viewed <a href=\"http://$DevPortalUrl/Applications/Details/$AppId\">here</a>.\r\n </p>\r\n <p style=\"font-size:12pt;font-family:'Segoe UI'\">Best,</p>\r\n <p style=\"font-size:12pt;font-family:'Segoe UI'\">The $OrganizationName API Team</p>\r\n </body>\r\n</html>","title":"Application gallery submission approved","description":"Developers who submitted their application for publication in the application gallery on the developer portal receive this email after their submission is approved.","isDefault":false,"parameters":[{"name":"AppId","title":"Application id"},{"name":"AppName","title":"Application name"},{"name":"DevFirstName","title":"Developer first name"},{"name":"DevLastName","title":"Developer last name"},{"name":"OrganizationName","title":"Organization name"},{"name":"DevPortalUrl","title":"Developer portal URL"}]}},"200":{"body":{"id":"/templates/ApplicationApprovedNotificationMessage","subject":"Your application $AppName is published in the application gallery","body":"<!DOCTYPE html >\r\n<html>\r\n <head />\r\n <body>\r\n <p style=\"font-size:12pt;font-family:'Segoe UI'\">Dear $DevFirstName $DevLastName,</p>\r\n <p style=\"font-size:12pt;font-family:'Segoe UI'\">\r\n We are happy to let you know that your request to publish the $AppName application in the application gallery has been approved. Your application has been published and can be viewed <a href=\"http://$DevPortalUrl/Applications/Details/$AppId\">here</a>.\r\n </p>\r\n <p style=\"font-size:12pt;font-family:'Segoe UI'\">Best,</p>\r\n <p style=\"font-size:12pt;font-family:'Segoe UI'\">The $OrganizationName API Team</p>\r\n </body>\r\n</html>","title":"Application gallery submission approved","description":"Developers who submitted their application for publication in the application gallery on the developer portal receive this email after their submission is approved.","isDefault":false,"parameters":[{"name":"AppId","title":"Application id"},{"name":"AppName","title":"Application name"},{"name":"DevFirstName","title":"Developer first name"},{"name":"DevLastName","title":"Developer last name"},{"name":"OrganizationName","title":"Organization name"},{"name":"DevPortalUrl","title":"Developer portal URL"}]}}}},"ApiManagementDeleteTemplates":{"parameters":{"apimBaseUrl":"apimservice1.management.azure-api.net","templateName":"newIssueNotificationMessage","api-version":"2017-03-01","Accept":"application/json","If-Match":"*"},"responses":{"204":{}}},"ApiManagementListCertificates":{"parameters":{"apimBaseUrl":"apimservice1.management.azure-api.net","api-version":"2017-03-01","Accept":"application/json"},"responses":{"200":{"body":{"value":[{"id":"/certificates/5a58bad2a40f7ef2e05bcce2","subject":"CN=localhost","thumbprint":"C2728598048BE9C8BD559A159BD70525A4EA0367","expirationDate":"2019-01-12T00:00:00Z"},{"id":"/certificates/5a58bb7ea40f7ef2e05be3d4","subject":"CN=localhost","thumbprint":"FB085F34A60C2AD8EED59C58B961BD5FBEFC38BE","expirationDate":"2019-01-12T00:00:00Z"},{"id":"/certificates/5a58bc74a40f7e1048929958","subject":"CN=localhost","thumbprint":"61EF1C104C1949E219995A2F0628F3D66D595F32","expirationDate":"2019-01-12T00:00:00Z"},{"id":"/certificates/5a58bcd2a40f7e1048929a35","subject":"CN=localhost","thumbprint":"E359B9813314091B0EDED4AD804A9163D0FF3B84","expirationDate":"2019-01-12T00:00:00Z"},{"id":"/certificates/5a58bcd2a40f7e1048929a36","subject":"CN=localhost","thumbprint":"0997AAAF7DB834B9F5726F20FED2F3D3D086DA07","expirationDate":"2019-01-12T00:00:00Z"}],"count":5}}}},"ApiManagementDeleteSubscriptions":{"parameters":{"apimBaseUrl":"apimservice1.management.azure-api.net","sid":"5a58bcd5a40f7e1048929a61","api-version":"2017-03-01","If-Match":"*"},"responses":{"204":{}}},"ApiManagementListProductsApis":{"parameters":{"apimBaseUrl":"apimservice1.management.azure-api.net","productId":"5a58bdf3a40f7e104892acb8","api-version":"2017-03-01","Accept":"application/json"},"responses":{"200":{"body":{"value":[{"id":"/apis/5a58bdf3a40f7e104892acbe","name":"api_5a58bdf3a40f7e104892acbf","apiRevision":"1","description":"description_5a58bdf3a40f7e104892acc0","serviceUrl":"http://contoso/5a58bdf3a40f7e104892acc1","path":"suffix_5a58bdf3a40f7e104892acc2","protocols":["https"],"isCurrent":true}],"count":1}}}},"ApiManagementPutIdentityProviders":{"parameters":{"apimBaseUrl":"apimservice1.management.azure-api.net","identityProviderName":"facebook","api-version":"2017-03-01","parameters":{"clientId":"BDNYXUKKLB","clientSecret":"<clientSecret>","type":"facebook"}},"responses":{"201":{"body":{"id":"/identityProviders/Facebook","clientId":"BDNYXUKKLB","clientSecret":"<clientSecret>","type":"facebook"}},"200":{"body":{"id":"/identityProviders/Facebook","clientId":"BDNYXUKKLB","clientSecret":"<clientSecret>","type":"facebook"}}}},"ApiManagementPutGroups":{"parameters":{"apimBaseUrl":"apimservice1.management.azure-api.net","groupId":"5a58babda40f7ef2e05bc7b6","api-version":"2017-03-01","parameters":{"name":"5a58babda40f7ef2e05bc7b7","type":"custom"}},"responses":{"201":{"body":{"id":"/groups/5a58babda40f7ef2e05bc7b6","name":"5a58babda40f7ef2e05bc7b7","builtIn":false,"type":"custom"}},"200":{"body":{"id":"/groups/5a58babda40f7ef2e05bc7b6","name":"5a58babda40f7ef2e05bc7b7","builtIn":false,"type":"custom"}}}},"ApiManagementDeleteApisSchemas":{"parameters":{"apimBaseUrl":"apimservice1.management.azure-api.net","apiId":"5a58bfd4a40f7e104892c4d2","schemaId":"5a58bfd4a40f7e104892c4d3","force":"True","api-version":"2017-03-01","If-Match":"\"AAAAAAAAKhk=\""},"responses":{"204":{}}},"ApiManagementPatchIdentityProviders":{"parameters":{"apimBaseUrl":"apimservice1.management.azure-api.net","identityProviderName":"facebook","api-version":"2017-03-01","If-Match":"*","parameters":{"clientId":"BDNYXUKKLB","clientSecret":"<clientSecret>"}},"responses":{"204":{}}},"ApiManagementListProductsGroups":{"parameters":{"apimBaseUrl":"apimservice1.management.azure-api.net","productId":"5a58bafca40f7ef2e05bd22d","api-version":"2017-03-01","Accept":"application/json"},"responses":{"200":{"body":{"value":[{"id":"/groups/5a58bafca40f7ef2e05bd232","name":"5a58bafca40f7ef2e05bd233","builtIn":false,"type":"custom"},{"id":"/groups/administrators","name":"Administrators","description":"Administrators is a built-in group. Its membership is managed by the system. Microsoft Azure subscription administrators fall into this group.","builtIn":true,"type":"system"}],"count":2}}}},"ApiManagementDeletePolicies":{"parameters":{"apimBaseUrl":"apimservice1.management.azure-api.net","policyId":"policy","api-version":"2017-03-01","If-Match":"*"},"responses":{"204":{}}},"ApiManagementPatchGroups":{"parameters":{"apimBaseUrl":"apimservice1.management.azure-api.net","groupId":"5a58baf9a40f7ef2e05bcfb9","api-version":"2017-03-01","If-Match":"\"AAAAAAAACo0=\"","parameters":{"name":"5a58baf9a40f7ef2e05bcfbc","description":"some new description"}},"responses":{"204":{}}},"ApiManagementPutApis":{"parameters":{"apimBaseUrl":"apimservice1.management.azure-api.net","apiId":"5a58bab6a40f7ef2e05bc769","apiType":"Http","api-version":"2017-03-01","Accept":"application/json","parameters":{"name":"api_5a58bab6a40f7ef2e05bc76a","description":"description_5a58bab6a40f7ef2e05bc76b","serviceUrl":"http://contoso/5a58bab6a40f7ef2e05bc76c","path":"suffix_5a58bab6a40f7ef2e05bc76d","protocols":["https"]}},"responses":{"201":{"body":{"id":"/apis/5a58bab6a40f7ef2e05bc769","name":"api_5a58bab6a40f7ef2e05bc76a","apiRevision":"1","description":"description_5a58bab6a40f7ef2e05bc76b","serviceUrl":"http://contoso/5a58bab6a40f7ef2e05bc76c","path":"suffix_5a58bab6a40f7ef2e05bc76d","protocols":["https"],"subscriptionKeyParameterNames":{"header":"Ocp-Apim-Subscription-Key","query":"subscription-key"},"isCurrent":true}},"200":{"body":{"id":"/apis/5a58bab6a40f7ef2e05bc769","name":"api_5a58bab6a40f7ef2e05bc76a","apiRevision":"1","description":"description_5a58bab6a40f7ef2e05bc76b","serviceUrl":"http://contoso/5a58bab6a40f7ef2e05bc76c","path":"suffix_5a58bab6a40f7ef2e05bc76d","protocols":["https"],"subscriptionKeyParameterNames":{"header":"Ocp-Apim-Subscription-Key","query":"subscription-key"},"isCurrent":true}}}},"ApiManagementHeadProductsGroups":{"parameters":{"apimBaseUrl":"apimservice1.management.azure-api.net","productId":"5a58beb3a40f7e104892b3e3","sid":"developers","api-version":"2017-03-01"},"responses":{"204":{}}},"ApiManagementGetQuotas":{"parameters":{"apimBaseUrl":"apimservice1.management.azure-api.net","api-version":"2017-03-01","quotaCounterKey":"ba"},"responses":{"200":{"body":{"value":[{"counterKey":"ba","periodKey":"0_P3Y6M4DT12H30M5S","periodStartTime":"2014-08-04T04:24:35Z","periodEndTime":"2018-02-08T16:54:40Z","Value":{"callsCount":5,"kbTransferred":2.5830078125}}],"count":1,"nextLink":""}}}},"ApiManagementListTenantSyncState":{"parameters":{"apimBaseUrl":"apimservice1.management.azure-api.net","api-version":"2017-03-01","configurationName":"configuration"},"responses":{"200":{"body":{"branch":"master","commitId":"44c29c27a876372e2ea18d9c381cc493a6a89fc5","isExport":true,"isSynced":false,"isGitEnabled":true,"syncDate":"2016-10-24T19:17:14.3641403Z","configurationChangeDate":"2017-06-03T00:41:30.9670873Z"}}}},"ApiManagementListRegions":{"parameters":{"apimBaseUrl":"apimservice1.management.azure-api.net","api-version":"2017-03-01"},"responses":{"200":{"body":{"value":[{"name":"West US","isMasterRegion":true,"isDeleted":false}],"count":1,"nextLink":""}}}},"ApiManagementPostTenantValidate":{"parameters":{"apimBaseUrl":"apimservice1.management.azure-api.net","api-version":"2017-03-01","configurationName":"configuration","parameters":{"branch":"master"}},"responses":{"202":{"headers":{"location":"https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5a1af64e2a6d2e0b688d751e?api-version=2017-03-01"}},"200":{"body":{"id":"5a1af64e2a6d2e0b688d751e","status":"Succeeded","started":"2017-11-26T17:13:50.787Z","updated":"2017-11-26T17:13:59.723Z","resultInfo":"Validation is successfull","actionLog":[{"objectType":"ApiSpecificationContract","action":"Updated","objectKey":"57914cb351f68a16889be190;rev=1"},{"objectType":"ProductSpecificationContract","action":"Updated","objectKey":"5768181ea40f7eb6c49f6ac7"},{"objectType":"ProductSpecificationContract","action":"Updated","objectKey":"576819c9a40f7e86289fb3e3"},{"objectType":"ProductSpecificationContract","action":"Updated","objectKey":"576819f1a40f7e86289fb6de"},{"objectType":"ProductSpecificationContract","action":"Updated","objectKey":"57681a67a40f7e72b4132522"},{"objectType":"ProductSpecificationContract","action":"Updated","objectKey":"57681a73a40f7e72b413281d"},{"objectType":"ProductSpecificationContract","action":"Updated","objectKey":"57681a7ea40f7e72b4132b18"},{"objectType":"ProductSpecificationContract","action":"Updated","objectKey":"57681b88a40f7ea0f017f099"},{"objectType":"ProductSpecificationContract","action":"Updated","objectKey":"57681b9fa40f7ea0f017f682"},{"objectType":"ProductSpecificationContract","action":"Updated","objectKey":"57681bb5a40f7ea0f017fc6b"},{"objectType":"ProductSpecificationContract","action":"Updated","objectKey":"57681bcaa40f7ea0f0180254"},{"objectType":"ProductSpecificationContract","action":"Updated","objectKey":"57681bdfa40f7ea0f018083d"},{"objectType":"ProductSpecificationContract","action":"Updated","objectKey":"57681bf5a40f7ea0f0180e26"},{"objectType":"ProductSpecificationContract","action":"Updated","objectKey":"57681c0ea40f7ea0f018140f"},{"objectType":"ProductSpecificationContract","action":"Updated","objectKey":"57681c26a40f7ea0f01819f8"},{"objectType":"ProductSpecificationContract","action":"Updated","objectKey":"57681c83a40f7e85f44db237"},{"objectType":"ProductSpecificationContract","action":"Updated","objectKey":"57681cb2a40f7e85f44dbcd0"},{"objectType":"ProductSpecificationContract","action":"Updated","objectKey":"57681ce3a40f7e85f44dc769"},{"objectType":"ProductSpecificationContract","action":"Updated","objectKey":"57681d1fa40f7e85f44dd202"},{"objectType":"ProductSpecificationContract","action":"Updated","objectKey":"57681d60a40f7e85f44ddc9b"},{"objectType":"ProductSpecificationContract","action":"Updated","objectKey":"57681db4a40f7e85f44de735"},{"objectType":"ProductSpecificationContract","action":"Updated","objectKey":"57681e11a40f7e85f44df1ce"},{"objectType":"ProductSpecificationContract","action":"Updated","objectKey":"57681e73a40f7e85f44dfc67"},{"objectType":"ProductSpecificationContract","action":"Updated","objectKey":"57681f06a40f7e74ec07785c"},{"objectType":"ProductSpecificationContract","action":"Updated","objectKey":"5768211fa40f7e74ec07a74a"},{"objectType":"ProductSpecificationContract","action":"Updated","objectKey":"576823cfa40f7e74ec07d63a"},{"objectType":"ProductSpecificationContract","action":"Updated","objectKey":"5600b57e7e8880006a060001"},{"objectType":"ProductSpecificationContract","action":"Updated","objectKey":"5600b57e7e8880006a060002"}]}}}},"ApiManagementListUsersSubscriptions":{"parameters":{"apimBaseUrl":"apimservice1.management.azure-api.net","uid":"1","$skip":0,"$top":10000,"api-version":"2017-03-01","Accept":"application/json"},"responses":{"200":{"body":{"value":[{"id":"/subscriptions/5a58ba90a40f7e0034070001","userId":"/users/1","productId":"/products/starter","state":"active","createdDate":"2018-01-12T13:39:28.57Z","primaryKey":"<primaryKey>","secondaryKey":"<secondaryKey>"}],"count":1}}}},"ApiManagementPatchBackends":{"parameters":{"apimBaseUrl":"apimservice1.management.azure-api.net","backendid":"5a58bd45a40f7e104892a3aa","api-version":"2017-03-01","If-Match":"\"AAAAAAAAHDE=\"","parameters":{"description":"description5308","tls":{"validateCertificateChain":false,"validateCertificateName":true}}},"responses":{"204":{}}},"ApiManagementPatchProperties":{"parameters":{"apimBaseUrl":"apimservice1.management.azure-api.net","propId":"5a58bd16a40f7e104892a08d","api-version":"2017-03-01","If-Match":"\"AAAAAAAAGaY=\"","parameters":{"name":"5a58bd16a40f7e104892a090","value":"HDNRYZOJPPKUIVYGMJRDXQGFUDEFQXKORLMIDUKRYQERGDPHKZOIZOVQXHXVVITRFVDWIPDRZZEGMPZQNWVQIBPCPWLVXOWQXMMKASYUVWIZJPDHIGHYNCJDFAHLEIULCOJADOPVYAULSPTATEMQHYDVCIFALMQNCXXVGCEURLZMHYLPGHSZWDDDLNYUIPKLKHIVSXUQZSZVYQNEXPTEUQQYTUKSEJLBBOCZPQXJMBAEEIEUATXTVGQTQKBXNCMPGXTKONOGSKRTQMULPQRKLSGVXIJFOZVKOKXGOUFMFQAKPXDDQQIXKBENRYMFEJSSOGEFPNWVKFFURVFAFFOYRYANGJPQIAHVYIWITXOCTNNEWJWVSMAZUTAQFRZFXGMKXKWJZWGHQLFELVQXNUXWZIAFHGDCYJFNADHMMMVVFTIIOWEKABRDIQKOJRBTTEIHGREIOEKBYBRFZRQLBTBWRBEKSSCVKCBALBCWSWVVRQEHZFOSAQSACLPENUPVCOQVZQTYPUTEXFFAXXKMDJVTKBYZLXJYGATCAIHJLQDGXNDWFPHQJDRTTWLYRUMRLUXWMDAOPBBNFPWXYBUWPSODJAIDXIRRDLUCPGKBOTAICENEAOAQZQCSGUNMVWQHKJJUUTHRRSHVSGBFNEDJIARNJCWVTYGRDTYSUTJHGIYGIGZZSIYRTHYJRWLRWLYTMPSZIJKUUWCACLECCXDKZPYVUOAXHRKVKFUSOAQJXEWXFYHGRJPZINUXRXETIMMCLGPWQLNCGUNUSAQWHUFYCLMXLXBRWXAKSTLYIKPGVMSOZZEQGHLOGNZAUSKTKWFJTCCZPRNXEZDPSYXMTKKOLMDFTLEQZWVZHJUXXFBPTOJHJKIVVYAZLQYGYXFDNXXIDEIIDZOOJVUWDWVJCIUAVWNQLOYAZXBWQADFBZSVJMQQVBDBBVBECWMHRSXPBOOLTYGCTPIDQZRJFWUKKWYEWWTUOWOJCCUUXEWXUBIMNYODFDBUXMEEQKPWFMNXBYAOEWLB","secret":true}},"responses":{"204":{}}},"ApiManagementDeleteApisPolicies":{"parameters":{"apimBaseUrl":"apimservice1.management.azure-api.net","api-version":"2017-03-01","apiId":"loggerId","policyId":"policy","If-Match":"*"},"responses":{"204":{}}},"ApiManagementGetReportsByGeo":{"parameters":{"apimBaseUrl":"apimservice1.management.azure-api.net","api-version":"2017-03-01","$filter":"timestamp ge datetime'2017-06-01T00:00:00' and timestamp le datetime'2017-06-04T00:00:00'"},"responses":{"200":{"body":{"value":[{"country":"US","region":"WA","zip":"98052","callCountSuccess":13,"callCountBlocked":1,"callCountFailed":0,"callCountOther":0,"callCountTotal":14,"bandwidth":11019,"cacheHitCount":0,"cacheMissCount":0,"apiTimeAvg":1015.7607923076923,"apiTimeMin":330.3206,"apiTimeMax":1819.2173,"serviceTimeAvg":957.094776923077,"serviceTimeMin":215.24,"serviceTimeMax":1697.3612}],"count":1,"nextLink":""}}}},"ApiManagementPutApisSchemas":{"parameters":{"apimBaseUrl":"apimservice1.management.azure-api.net","apiId":"5a58bdf5a40f7e104892acda","schemaId":"5a58bdf5a40f7e104892ace0","api-version":"2017-03-01","parameters":{"contentType":"application/vnd.ms-azure-apim.xsd+xml","document":{"value":"<s:schema elementFormDefault=\"qualified\" targetNamespace=\"http://ws.cdyne.com/WeatherWS/\" xmlns:tns=\"http://ws.cdyne.com/WeatherWS/\" xmlns:s=\"http://www.w3.org/2001/XMLSchema\" xmlns:soap12=\"http://schemas.xmlsoap.org/wsdl/soap12/\" xmlns:mime=\"http://schemas.xmlsoap.org/wsdl/mime/\" xmlns:soap=\"http://schemas.xmlsoap.org/wsdl/soap/\" xmlns:tm=\"http://microsoft.com/wsdl/mime/textMatching/\" xmlns:http=\"http://schemas.xmlsoap.org/wsdl/http/\" xmlns:soapenc=\"http://schemas.xmlsoap.org/soap/encoding/\" xmlns:wsdl=\"http://schemas.xmlsoap.org/wsdl/\" xmlns:apim-wsdltns=\"http://ws.cdyne.com/WeatherWS/\">\r\n <s:element name=\"GetWeatherInformation\">\r\n <s:complexType />\r\n </s:element>\r\n <s:element name=\"GetWeatherInformationResponse\">\r\n <s:complexType>\r\n <s:sequence>\r\n <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"GetWeatherInformationResult\" type=\"tns:ArrayOfWeatherDescription\" />\r\n </s:sequence>\r\n </s:complexType>\r\n </s:element>\r\n <s:complexType name=\"ArrayOfWeatherDescription\">\r\n <s:sequence>\r\n <s:element minOccurs=\"0\" maxOccurs=\"unbounded\" name=\"WeatherDescription\" type=\"tns:WeatherDescription\" />\r\n </s:sequence>\r\n </s:complexType>\r\n <s:complexType name=\"WeatherDescription\">\r\n <s:sequence>\r\n <s:element minOccurs=\"1\" maxOccurs=\"1\" name=\"WeatherID\" type=\"s:short\" />\r\n <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"Description\" type=\"s:string\" />\r\n <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"PictureURL\" type=\"s:string\" />\r\n </s:sequence>\r\n </s:complexType>\r\n <s:element name=\"GetCityForecastByZIP\">\r\n <s:complexType>\r\n <s:sequence>\r\n <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"ZIP\" type=\"s:string\" />\r\n </s:sequence>\r\n </s:complexType>\r\n </s:element>\r\n <s:element name=\"GetCityForecastByZIPResponse\">\r\n <s:complexType>\r\n <s:sequence>\r\n <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"GetCityForecastByZIPResult\" type=\"tns:ForecastReturn\" />\r\n </s:sequence>\r\n </s:complexType>\r\n </s:element>\r\n <s:complexType name=\"ForecastReturn\">\r\n <s:sequence>\r\n <s:element minOccurs=\"1\" maxOccurs=\"1\" name=\"Success\" type=\"s:boolean\" />\r\n <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"ResponseText\" type=\"s:string\" />\r\n <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"State\" type=\"s:string\" />\r\n <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"City\" type=\"s:string\" />\r\n <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"WeatherStationCity\" type=\"s:string\" />\r\n <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"ForecastResult\" type=\"tns:ArrayOfForecast\" />\r\n </s:sequence>\r\n </s:complexType>\r\n <s:complexType name=\"ArrayOfForecast\">\r\n <s:sequence>\r\n <s:element minOccurs=\"0\" maxOccurs=\"unbounded\" name=\"Forecast\" nillable=\"true\" type=\"tns:Forecast\" />\r\n </s:sequence>\r\n </s:complexType>\r\n <s:complexType name=\"Forecast\">\r\n <s:sequence>\r\n <s:element minOccurs=\"1\" maxOccurs=\"1\" name=\"Date\" type=\"s:dateTime\" />\r\n <s:element minOccurs=\"1\" maxOccurs=\"1\" name=\"WeatherID\" type=\"s:short\" />\r\n <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"Desciption\" type=\"s:string\" />\r\n <s:element minOccurs=\"1\" maxOccurs=\"1\" name=\"Temperatures\" type=\"tns:temp\" />\r\n <s:element minOccurs=\"1\" maxOccurs=\"1\" name=\"ProbabilityOfPrecipiation\" type=\"tns:POP\" />\r\n </s:sequence>\r\n </s:complexType>\r\n <s:complexType name=\"temp\">\r\n <s:sequence>\r\n <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"MorningLow\" type=\"s:string\" />\r\n <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"DaytimeHigh\" type=\"s:string\" />\r\n </s:sequence>\r\n </s:complexType>\r\n <s:complexType name=\"POP\">\r\n <s:sequence>\r\n <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"Nighttime\" type=\"s:string\" />\r\n <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"Daytime\" type=\"s:string\" />\r\n </s:sequence>\r\n </s:complexType>\r\n <s:element name=\"GetCityWeatherByZIP\">\r\n <s:complexType>\r\n <s:sequence>\r\n <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"ZIP\" type=\"s:string\" />\r\n </s:sequence>\r\n </s:complexType>\r\n </s:element>\r\n <s:element name=\"GetCityWeatherByZIPResponse\">\r\n <s:complexType>\r\n <s:sequence>\r\n <s:element minOccurs=\"1\" maxOccurs=\"1\" name=\"GetCityWeatherByZIPResult\" type=\"tns:WeatherReturn\" />\r\n </s:sequence>\r\n </s:complexType>\r\n </s:element>\r\n <s:complexType name=\"WeatherReturn\">\r\n <s:sequence>\r\n <s:element minOccurs=\"1\" maxOccurs=\"1\" name=\"Success\" type=\"s:boolean\" />\r\n <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"ResponseText\" type=\"s:string\" />\r\n <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"State\" type=\"s:string\" />\r\n <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"City\" type=\"s:string\" />\r\n <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"WeatherStationCity\" type=\"s:string\" />\r\n <s:element minOccurs=\"1\" maxOccurs=\"1\" name=\"WeatherID\" type=\"s:short\" />\r\n <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"Description\" type=\"s:string\" />\r\n <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"Temperature\" type=\"s:string\" />\r\n <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"RelativeHumidity\" type=\"s:string\" />\r\n <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"Wind\" type=\"s:string\" />\r\n <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"Pressure\" type=\"s:string\" />\r\n <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"Visibility\" type=\"s:string\" />\r\n <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"WindChill\" type=\"s:string\" />\r\n <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"Remarks\" type=\"s:string\" />\r\n </s:sequence>\r\n </s:complexType>\r\n <s:element name=\"ArrayOfWeatherDescription\" nillable=\"true\" type=\"tns:ArrayOfWeatherDescription\" />\r\n <s:element name=\"ForecastReturn\" nillable=\"true\" type=\"tns:ForecastReturn\" />\r\n <s:element name=\"WeatherReturn\" type=\"tns:WeatherReturn\" />\r\n</s:schema>"}}},"responses":{"201":{"body":{"id":"/apis/5a58bdf5a40f7e104892acda/schemas/5a58bdf5a40f7e104892ace0","contentType":"application/vnd.ms-azure-apim.xsd+xml","document":{"value":"<s:schema elementFormDefault=\"qualified\" targetNamespace=\"http://ws.cdyne.com/WeatherWS/\" xmlns:tns=\"http://ws.cdyne.com/WeatherWS/\" xmlns:s=\"http://www.w3.org/2001/XMLSchema\" xmlns:soap12=\"http://schemas.xmlsoap.org/wsdl/soap12/\" xmlns:mime=\"http://schemas.xmlsoap.org/wsdl/mime/\" xmlns:soap=\"http://schemas.xmlsoap.org/wsdl/soap/\" xmlns:tm=\"http://microsoft.com/wsdl/mime/textMatching/\" xmlns:http=\"http://schemas.xmlsoap.org/wsdl/http/\" xmlns:soapenc=\"http://schemas.xmlsoap.org/soap/encoding/\" xmlns:wsdl=\"http://schemas.xmlsoap.org/wsdl/\" xmlns:apim-wsdltns=\"http://ws.cdyne.com/WeatherWS/\">\r\n <s:element name=\"GetWeatherInformation\">\r\n <s:complexType />\r\n </s:element>\r\n <s:element name=\"GetWeatherInformationResponse\">\r\n <s:complexType>\r\n <s:sequence>\r\n <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"GetWeatherInformationResult\" type=\"tns:ArrayOfWeatherDescription\" />\r\n </s:sequence>\r\n </s:complexType>\r\n </s:element>\r\n <s:complexType name=\"ArrayOfWeatherDescription\">\r\n <s:sequence>\r\n <s:element minOccurs=\"0\" maxOccurs=\"unbounded\" name=\"WeatherDescription\" type=\"tns:WeatherDescription\" />\r\n </s:sequence>\r\n </s:complexType>\r\n <s:complexType name=\"WeatherDescription\">\r\n <s:sequence>\r\n <s:element minOccurs=\"1\" maxOccurs=\"1\" name=\"WeatherID\" type=\"s:short\" />\r\n <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"Description\" type=\"s:string\" />\r\n <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"PictureURL\" type=\"s:string\" />\r\n </s:sequence>\r\n </s:complexType>\r\n <s:element name=\"GetCityForecastByZIP\">\r\n <s:complexType>\r\n <s:sequence>\r\n <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"ZIP\" type=\"s:string\" />\r\n </s:sequence>\r\n </s:complexType>\r\n </s:element>\r\n <s:element name=\"GetCityForecastByZIPResponse\">\r\n <s:complexType>\r\n <s:sequence>\r\n <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"GetCityForecastByZIPResult\" type=\"tns:ForecastReturn\" />\r\n </s:sequence>\r\n </s:complexType>\r\n </s:element>\r\n <s:complexType name=\"ForecastReturn\">\r\n <s:sequence>\r\n <s:element minOccurs=\"1\" maxOccurs=\"1\" name=\"Success\" type=\"s:boolean\" />\r\n <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"ResponseText\" type=\"s:string\" />\r\n <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"State\" type=\"s:string\" />\r\n <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"City\" type=\"s:string\" />\r\n <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"WeatherStationCity\" type=\"s:string\" />\r\n <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"ForecastResult\" type=\"tns:ArrayOfForecast\" />\r\n </s:sequence>\r\n </s:complexType>\r\n <s:complexType name=\"ArrayOfForecast\">\r\n <s:sequence>\r\n <s:element minOccurs=\"0\" maxOccurs=\"unbounded\" name=\"Forecast\" nillable=\"true\" type=\"tns:Forecast\" />\r\n </s:sequence>\r\n </s:complexType>\r\n <s:complexType name=\"Forecast\">\r\n <s:sequence>\r\n <s:element minOccurs=\"1\" maxOccurs=\"1\" name=\"Date\" type=\"s:dateTime\" />\r\n <s:element minOccurs=\"1\" maxOccurs=\"1\" name=\"WeatherID\" type=\"s:short\" />\r\n <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"Desciption\" type=\"s:string\" />\r\n <s:element minOccurs=\"1\" maxOccurs=\"1\" name=\"Temperatures\" type=\"tns:temp\" />\r\n <s:element minOccurs=\"1\" maxOccurs=\"1\" name=\"ProbabilityOfPrecipiation\" type=\"tns:POP\" />\r\n </s:sequence>\r\n </s:complexType>\r\n <s:complexType name=\"temp\">\r\n <s:sequence>\r\n <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"MorningLow\" type=\"s:string\" />\r\n <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"DaytimeHigh\" type=\"s:string\" />\r\n </s:sequence>\r\n </s:complexType>\r\n <s:complexType name=\"POP\">\r\n <s:sequence>\r\n <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"Nighttime\" type=\"s:string\" />\r\n <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"Daytime\" type=\"s:string\" />\r\n </s:sequence>\r\n </s:complexType>\r\n <s:element name=\"GetCityWeatherByZIP\">\r\n <s:complexType>\r\n <s:sequence>\r\n <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"ZIP\" type=\"s:string\" />\r\n </s:sequence>\r\n </s:complexType>\r\n </s:element>\r\n <s:element name=\"GetCityWeatherByZIPResponse\">\r\n <s:complexType>\r\n <s:sequence>\r\n <s:element minOccurs=\"1\" maxOccurs=\"1\" name=\"GetCityWeatherByZIPResult\" type=\"tns:WeatherReturn\" />\r\n </s:sequence>\r\n </s:complexType>\r\n </s:element>\r\n <s:complexType name=\"WeatherReturn\">\r\n <s:sequence>\r\n <s:element minOccurs=\"1\" maxOccurs=\"1\" name=\"Success\" type=\"s:boolean\" />\r\n <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"ResponseText\" type=\"s:string\" />\r\n <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"State\" type=\"s:string\" />\r\n <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"City\" type=\"s:string\" />\r\n <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"WeatherStationCity\" type=\"s:string\" />\r\n <s:element minOccurs=\"1\" maxOccurs=\"1\" name=\"WeatherID\" type=\"s:short\" />\r\n <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"Description\" type=\"s:string\" />\r\n <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"Temperature\" type=\"s:string\" />\r\n <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"RelativeHumidity\" type=\"s:string\" />\r\n <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"Wind\" type=\"s:string\" />\r\n <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"Pressure\" type=\"s:string\" />\r\n <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"Visibility\" type=\"s:string\" />\r\n <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"WindChill\" type=\"s:string\" />\r\n <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"Remarks\" type=\"s:string\" />\r\n </s:sequence>\r\n </s:complexType>\r\n <s:element name=\"ArrayOfWeatherDescription\" nillable=\"true\" type=\"tns:ArrayOfWeatherDescription\" />\r\n <s:element name=\"ForecastReturn\" nillable=\"true\" type=\"tns:ForecastReturn\" />\r\n <s:element name=\"WeatherReturn\" type=\"tns:WeatherReturn\" />\r\n</s:schema>"}}},"200":{"body":{"id":"/apis/5a58bdf5a40f7e104892acda/schemas/5a58bdf5a40f7e104892ace0","contentType":"application/vnd.ms-azure-apim.xsd+xml","document":{"value":"<s:schema elementFormDefault=\"qualified\" targetNamespace=\"http://ws.cdyne.com/WeatherWS/\" xmlns:tns=\"http://ws.cdyne.com/WeatherWS/\" xmlns:s=\"http://www.w3.org/2001/XMLSchema\" xmlns:soap12=\"http://schemas.xmlsoap.org/wsdl/soap12/\" xmlns:mime=\"http://schemas.xmlsoap.org/wsdl/mime/\" xmlns:soap=\"http://schemas.xmlsoap.org/wsdl/soap/\" xmlns:tm=\"http://microsoft.com/wsdl/mime/textMatching/\" xmlns:http=\"http://schemas.xmlsoap.org/wsdl/http/\" xmlns:soapenc=\"http://schemas.xmlsoap.org/soap/encoding/\" xmlns:wsdl=\"http://schemas.xmlsoap.org/wsdl/\" xmlns:apim-wsdltns=\"http://ws.cdyne.com/WeatherWS/\">\r\n <s:element name=\"GetWeatherInformation\">\r\n <s:complexType />\r\n </s:element>\r\n <s:element name=\"GetWeatherInformationResponse\">\r\n <s:complexType>\r\n <s:sequence>\r\n <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"GetWeatherInformationResult\" type=\"tns:ArrayOfWeatherDescription\" />\r\n </s:sequence>\r\n </s:complexType>\r\n </s:element>\r\n <s:complexType name=\"ArrayOfWeatherDescription\">\r\n <s:sequence>\r\n <s:element minOccurs=\"0\" maxOccurs=\"unbounded\" name=\"WeatherDescription\" type=\"tns:WeatherDescription\" />\r\n </s:sequence>\r\n </s:complexType>\r\n <s:complexType name=\"WeatherDescription\">\r\n <s:sequence>\r\n <s:element minOccurs=\"1\" maxOccurs=\"1\" name=\"WeatherID\" type=\"s:short\" />\r\n <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"Description\" type=\"s:string\" />\r\n <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"PictureURL\" type=\"s:string\" />\r\n </s:sequence>\r\n </s:complexType>\r\n <s:element name=\"GetCityForecastByZIP\">\r\n <s:complexType>\r\n <s:sequence>\r\n <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"ZIP\" type=\"s:string\" />\r\n </s:sequence>\r\n </s:complexType>\r\n </s:element>\r\n <s:element name=\"GetCityForecastByZIPResponse\">\r\n <s:complexType>\r\n <s:sequence>\r\n <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"GetCityForecastByZIPResult\" type=\"tns:ForecastReturn\" />\r\n </s:sequence>\r\n </s:complexType>\r\n </s:element>\r\n <s:complexType name=\"ForecastReturn\">\r\n <s:sequence>\r\n <s:element minOccurs=\"1\" maxOccurs=\"1\" name=\"Success\" type=\"s:boolean\" />\r\n <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"ResponseText\" type=\"s:string\" />\r\n <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"State\" type=\"s:string\" />\r\n <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"City\" type=\"s:string\" />\r\n <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"WeatherStationCity\" type=\"s:string\" />\r\n <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"ForecastResult\" type=\"tns:ArrayOfForecast\" />\r\n </s:sequence>\r\n </s:complexType>\r\n <s:complexType name=\"ArrayOfForecast\">\r\n <s:sequence>\r\n <s:element minOccurs=\"0\" maxOccurs=\"unbounded\" name=\"Forecast\" nillable=\"true\" type=\"tns:Forecast\" />\r\n </s:sequence>\r\n </s:complexType>\r\n <s:complexType name=\"Forecast\">\r\n <s:sequence>\r\n <s:element minOccurs=\"1\" maxOccurs=\"1\" name=\"Date\" type=\"s:dateTime\" />\r\n <s:element minOccurs=\"1\" maxOccurs=\"1\" name=\"WeatherID\" type=\"s:short\" />\r\n <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"Desciption\" type=\"s:string\" />\r\n <s:element minOccurs=\"1\" maxOccurs=\"1\" name=\"Temperatures\" type=\"tns:temp\" />\r\n <s:element minOccurs=\"1\" maxOccurs=\"1\" name=\"ProbabilityOfPrecipiation\" type=\"tns:POP\" />\r\n </s:sequence>\r\n </s:complexType>\r\n <s:complexType name=\"temp\">\r\n <s:sequence>\r\n <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"MorningLow\" type=\"s:string\" />\r\n <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"DaytimeHigh\" type=\"s:string\" />\r\n </s:sequence>\r\n </s:complexType>\r\n <s:complexType name=\"POP\">\r\n <s:sequence>\r\n <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"Nighttime\" type=\"s:string\" />\r\n <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"Daytime\" type=\"s:string\" />\r\n </s:sequence>\r\n </s:complexType>\r\n <s:element name=\"GetCityWeatherByZIP\">\r\n <s:complexType>\r\n <s:sequence>\r\n <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"ZIP\" type=\"s:string\" />\r\n </s:sequence>\r\n </s:complexType>\r\n </s:element>\r\n <s:element name=\"GetCityWeatherByZIPResponse\">\r\n <s:complexType>\r\n <s:sequence>\r\n <s:element minOccurs=\"1\" maxOccurs=\"1\" name=\"GetCityWeatherByZIPResult\" type=\"tns:WeatherReturn\" />\r\n </s:sequence>\r\n </s:complexType>\r\n </s:element>\r\n <s:complexType name=\"WeatherReturn\">\r\n <s:sequence>\r\n <s:element minOccurs=\"1\" maxOccurs=\"1\" name=\"Success\" type=\"s:boolean\" />\r\n <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"ResponseText\" type=\"s:string\" />\r\n <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"State\" type=\"s:string\" />\r\n <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"City\" type=\"s:string\" />\r\n <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"WeatherStationCity\" type=\"s:string\" />\r\n <s:element minOccurs=\"1\" maxOccurs=\"1\" name=\"WeatherID\" type=\"s:short\" />\r\n <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"Description\" type=\"s:string\" />\r\n <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"Temperature\" type=\"s:string\" />\r\n <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"RelativeHumidity\" type=\"s:string\" />\r\n <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"Wind\" type=\"s:string\" />\r\n <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"Pressure\" type=\"s:string\" />\r\n <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"Visibility\" type=\"s:string\" />\r\n <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"WindChill\" type=\"s:string\" />\r\n <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"Remarks\" type=\"s:string\" />\r\n </s:sequence>\r\n </s:complexType>\r\n <s:element name=\"ArrayOfWeatherDescription\" nillable=\"true\" type=\"tns:ArrayOfWeatherDescription\" />\r\n <s:element name=\"ForecastReturn\" nillable=\"true\" type=\"tns:ForecastReturn\" />\r\n <s:element name=\"WeatherReturn\" type=\"tns:WeatherReturn\" />\r\n</s:schema>"}}}}},"ApiManagementGetBackends":{"parameters":{"apimBaseUrl":"apimservice1.management.azure-api.net","backendid":"5a58bb49a40f7ef2e05bd990","api-version":"2017-03-01","Accept":"application/json"},"responses":{"200":{"body":{"id":"/backends/5a58bb49a40f7ef2e05bd990","title":null,"description":"Service Fabric Test App: 5a58bb49a40f7ef2e05bd990","url":"fabric:/mytestapp/mytestservice","protocol":"http","properties":{"serviceFabricCluster":{"managementEndpoints":["http://somecluster.com"],"clientCertificateThumbprint":"C0F0AE5B3D8E1DF7A32FCB0BB1B43C8A704C54FF","maxPartitionResolutionRetries":5,"partitionResolutionRequestTimeout":"PT5M"}}}}}},"ApiManagementListBackends":{"parameters":{"apimBaseUrl":"apimservice1.management.azure-api.net","api-version":"2017-03-01","Accept":"application/json"},"responses":{"200":{"body":{"value":[{"id":"/backends/5a58bb7ea40f7ef2e05be3d5","title":"5a58bb7ea40f7ef2e05be3d6","description":"description","url":"https://5a58bb7ea40f7ef2e05be3d6/","protocol":"http","resourceId":"https://manage.azure.com/subscriptions/xxx/blah","credentials":{"certificate":["FB085F34A60C2AD8EED59C58B961BD5FBEFC38BE"],"query":{"sv":["xx","bb","cc"],"se":["2018-01-12"]},"header":{"x-my-1":["val1","val2"],"x-my-2":["val1","val2"]},"authorization":{"scheme":"Basic","parameter":"opensesame"}},"tls":{"validateCertificateChain":false,"validateCertificateName":false}},{"id":"/backends/5a58bc74a40f7e1048929959","title":"5a58bc74a40f7e104892995c","description":"description","url":"https://5a58bc74a40f7e104892995c/","protocol":"http","resourceId":"https://manage.azure.com/subscriptions/xxx/blah","credentials":{"certificate":["61EF1C104C1949E219995A2F0628F3D66D595F32"],"query":{"sv":["xx","bb","cc"],"se":["2018-01-12"]},"header":{"x-my-1":["val1","val2"],"x-my-2":["val1","val2"]},"authorization":{"scheme":"Basic","parameter":"opensesame"}},"tls":{"validateCertificateChain":false,"validateCertificateName":false}},{"id":"/backends/5a58bc74a40f7e104892995a","title":"5a58bc74a40f7e104892995d","description":"description","url":"https://5a58bc74a40f7e104892995d/","protocol":"http","resourceId":"https://manage.azure.com/subscriptions/xxx/blah","credentials":{"certificate":["61EF1C104C1949E219995A2F0628F3D66D595F32"],"query":{"sv":["xx","bb","cc"],"se":["2018-01-12"]},"header":{"x-my-1":["val1","val2"],"x-my-2":["val1","val2"]},"authorization":{"scheme":"Basic","parameter":"opensesame"}},"tls":{"validateCertificateChain":false,"validateCertificateName":false}},{"id":"/backends/5a58bc74a40f7e104892995b","title":"httpbin.org","url":"http://httpbin.org","protocol":"http"}],"count":4}}}},"ApiManagementGetOpenIdConnectProviders":{"parameters":{"apimBaseUrl":"apimservice1.management.azure-api.net","api-version":"2017-03-01","opid":"op1"},"responses":{"200":{"body":{"id":"/openidConnectProviders/op1","name":"templateoidprovider3","metadataEndpoint":"https://oidprovider-template3.net","clientId":"oidprovidertemplate3"}}}},"ApiManagementListPolicies":{"parameters":{"apimBaseUrl":"apimservice1.management.azure-api.net","$skip":0,"$top":10000,"api-version":"2017-03-01","scope":"All","Accept":"application/json"},"responses":{"200":{"body":{"value":[{"id":"/policies/policy","policyContent":"<!--\r\n IMPORTANT:\r\n - Policy elements can appear only within the <inbound>, <outbound>, <backend> section elements.\r\n - Only the <forward-request> policy element can appear within the <backend> section element.\r\n - To apply a policy to the incoming request (before it is forwarded to the backend service), place a corresponding policy element within the <inbound> section element.\r\n - To apply a policy to the outgoing response (before it is sent back to the caller), place a corresponding policy element within the <outbound> section element.\r\n - To add a policy position the cursor at the desired insertion point and click on the round button associated with the policy.\r\n - To remove a policy, delete the corresponding policy statement from the policy document.\r\n - Policies are applied in the order of their appearance, from the top down.\r\n-->\r\n<policies>\r\n <inbound />\r\n <backend>\r\n <forward-request />\r\n </backend>\r\n <outbound />\r\n</policies>"}],"count":1}}}},"ApiManagementGetTenant":{"parameters":{"apimBaseUrl":"apimservice1.management.azure-api.net","accessName":"access","api-version":"2017-03-01","Accept":"application/json"},"responses":{"200":{"body":{"id":"integration","primaryKey":"<primaryKey>","secondaryKey":"<secondaryKey>","enabled":true}}}},"ApiManagementGetPolicies":{"parameters":{"apimBaseUrl":"apimservice1.management.azure-api.net","policyId":"policy","api-version":"2017-03-01","Accept":"application/json"},"responses":{"200":{"body":{"id":"/policies/policy","policyContent":"<!--\r\n IMPORTANT:\r\n - Policy elements can appear only within the <inbound>, <outbound>, <backend> section elements.\r\n - Only the <forward-request> policy element can appear within the <backend> section element.\r\n - To apply a policy to the incoming request (before it is forwarded to the backend service), place a corresponding policy element within the <inbound> section element.\r\n - To apply a policy to the outgoing response (before it is sent back to the caller), place a corresponding policy element within the <outbound> section element.\r\n - To add a policy position the cursor at the desired insertion point and click on the round button associated with the policy.\r\n - To remove a policy, delete the corresponding policy statement from the policy document.\r\n - Policies are applied in the order of their appearance, from the top down.\r\n-->\r\n<policies>\r\n <inbound />\r\n <backend>\r\n <forward-request />\r\n </backend>\r\n <outbound />\r\n</policies>"}}}},"ApiManagementGetApis":{"parameters":{"apimBaseUrl":"apimservice1.management.azure-api.net","apiId":"5a58bafaa40f7ef2e05bcfbe","api-version":"2017-03-01","Accept":"application/json"},"responses":{"200":{"body":{"id":"/apis/5a58bafaa40f7ef2e05bcfbe","name":"api_5a58bafaa40f7ef2e05bcfbf","apiRevision":"1","description":"description_5a58bafaa40f7ef2e05bcfc0","serviceUrl":"http://contoso/5a58bafaa40f7ef2e05bcfc1","path":"suffix_5a58bafaa40f7ef2e05bcfc2","protocols":["https"],"subscriptionKeyParameterNames":{"header":"Ocp-Apim-Subscription-Key","query":"subscription-key"},"isCurrent":true}}}},"ApiManagementPostTenantSave":{"parameters":{"apimBaseUrl":"apimservice1.management.azure-api.net","api-version":"2017-03-01","configurationName":"configuration","parameters":{"branch":"master"}},"responses":{"202":{"headers":{"location":"https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5a1af57d2a6d2e0b688d751b?api-version=2017-03-01"}},"200":{"body":{"id":"5a1af57d2a6d2e0b688d751b","status":"Succeeded","started":"2017-11-26T17:10:21.957Z","updated":"2017-11-26T17:10:36.06Z","resultInfo":"The configuration was successfully saved to master as commit cdb6878db80159cc0e9a53f5ad38581883882974.","actionLog":[]}}}},"ApiManagementGetReportsByTime":{"parameters":{"apimBaseUrl":"apimservice1.management.azure-api.net","api-version":"2017-03-01","$filter":"timestamp ge datetime'2017-06-01T00:00:00' and timestamp le datetime'2017-06-04T00:00:00'","interval":"PT15M"},"responses":{"200":{"body":{"value":[{"timestamp":"2017-06-03T00:15:00Z","interval":"PT15M","callCountSuccess":4,"callCountBlocked":0,"callCountFailed":0,"callCountOther":0,"callCountTotal":4,"bandwidth":3243,"cacheHitCount":0,"cacheMissCount":0,"apiTimeAvg":1337.46335,"apiTimeMin":885.0839000000001,"apiTimeMax":1819.2173,"serviceTimeAvg":1255.917425,"serviceTimeMin":882.8264,"serviceTimeMax":1697.3612},{"timestamp":"2017-06-03T00:30:00Z","interval":"PT15M","callCountSuccess":9,"callCountBlocked":1,"callCountFailed":0,"callCountOther":0,"callCountTotal":10,"bandwidth":7776,"cacheHitCount":0,"cacheMissCount":0,"apiTimeAvg":872.7818777777778,"apiTimeMin":330.3206,"apiTimeMax":1093.8407,"serviceTimeAvg":824.2847111111112,"serviceTimeMin":215.24,"serviceTimeMax":973.2262000000001}],"count":2,"nextLink":""}}}},"ApiManagementPostTenantGit":{"parameters":{"apimBaseUrl":"apimservice1.management.azure-api.net","accessName":"access","api-version":"2017-03-01"},"responses":{"204":{}}},"ApiManagementDeleteApisOperations":{"parameters":{"apimBaseUrl":"apimservice1.management.azure-api.net","apiId":"5a58bb3ea40f7ef2e05bd937","operationId":"5a58bb3ea40f7ef2e05bd938","api-version":"2017-03-01","If-Match":"*"},"responses":{"204":{}}},"ApiManagementPutUsers":{"parameters":{"apimBaseUrl":"apimservice1.management.azure-api.net","uid":"5a58bac2a40f7ef2e05bc7d0","api-version":"2017-03-01","parameters":{"email":"5a58bac2a40f7ef2e05bc7d1@contoso.com","password":"<password>","firstName":"5a58bac2a40f7ef2e05bc7d2","lastName":"5a58bac2a40f7ef2e05bc7d3"}},"responses":{"201":{"body":{"id":"/users/5a58bac2a40f7ef2e05bc7d0","firstName":"5a58bac2a40f7ef2e05bc7d2","lastName":"5a58bac2a40f7ef2e05bc7d3","email":"5a58bac2a40f7ef2e05bc7d1@contoso.com","state":"active","registrationDate":"2018-01-12T13:40:18.223Z","groups":[{"id":"/groups/developers","name":"Developers","description":"Developers is a built-in group. Its membership is managed by the system. Signed-in users fall into this group.","builtIn":true,"type":"system"}],"identities":[{"provider":"Basic","id":"5a58bac2a40f7ef2e05bc7d1@contoso.com"}]}},"200":{"body":{"id":"/users/5a58bac2a40f7ef2e05bc7d0","firstName":"5a58bac2a40f7ef2e05bc7d2","lastName":"5a58bac2a40f7ef2e05bc7d3","email":"5a58bac2a40f7ef2e05bc7d1@contoso.com","state":"active","registrationDate":"2018-01-12T13:40:18.223Z","groups":[{"id":"/groups/developers","name":"Developers","description":"Developers is a built-in group. Its membership is managed by the system. Signed-in users fall into this group.","builtIn":true,"type":"system"}],"identities":[{"provider":"Basic","id":"5a58bac2a40f7ef2e05bc7d1@contoso.com"}]}}}},"ApiManagementDeleteAuthorizationServers":{"parameters":{"apimBaseUrl":"apimservice1.management.azure-api.net","authsid":"5a58bebda40f7e104892b414","api-version":"2017-03-01","If-Match":"\"AAAAAAAAI0Q=\""},"responses":{"204":{}}},"ApiManagementDeleteApisOperationsPolicies":{"parameters":{"apimBaseUrl":"apimservice1.management.azure-api.net","api-version":"2017-03-01","apiId":"testapi","operationId":"testoperation","policyId":"policy","If-Match":"*"},"responses":{"204":{}}},"ApiManagementListApisProducts":{"parameters":{"apimBaseUrl":"apimservice1.management.azure-api.net","apiId":"5a58bddea40f7e104892ac12","api-version":"2017-03-01","Accept":"application/json"},"responses":{"200":{"body":{"value":[{"id":"/products/5a58bddfa40f7e104892ac18","name":"product_5a58bddfa40f7e104892ac19","description":"product_description_5a58bddfa40f7e104892ac1a","subscriptionRequired":true,"approvalRequired":false,"state":"notPublished"},{"id":"/products/5a58bddfa40f7e104892ac1d","name":"product_5a58bddfa40f7e104892ac1e","description":"product_description_5a58bddfa40f7e104892ac1f","subscriptionRequired":true,"approvalRequired":false,"state":"notPublished"}],"count":2}}}},"ApiManagementListProperties":{"parameters":{"apimBaseUrl":"apimservice1.management.azure-api.net","$filter":"tags/any(t: t eq '5a58bd1fa40f7e104892a21f')","api-version":"2017-03-01","Accept":"application/json"},"responses":{"200":{"body":{"value":[{"id":"/properties/5a58bd1fa40f7e104892a220","name":"5a58bd1fa40f7e104892a221","value":"OZPCHNQMWBOXOTZNUPWFIMZDPXLAQKSR","tags":["5a58bd1fa40f7e104892a21f","b"],"secret":true},{"id":"/properties/5a58bd1fa40f7e104892a223","name":"5a58bd1fa40f7e104892a224","value":"GTBYQGFBBXFAXTMCDOOZQQXBALMJBQWM","tags":["5a58bd1fa40f7e104892a21f"],"secret":true}],"count":2}}}},"ApiManagementGetReportsByUser":{"parameters":{"apimBaseUrl":"apimservice1.management.azure-api.net","api-version":"2017-03-01","$filter":"timestamp ge datetime'2017-06-01T00:00:00' and timestamp le datetime'2017-06-04T00:00:00'"},"responses":{"200":{"body":{"value":[{"name":"Administrator","userId":"/users/1","callCountSuccess":13,"callCountBlocked":1,"callCountFailed":0,"callCountOther":0,"callCountTotal":14,"bandwidth":11019,"cacheHitCount":0,"cacheMissCount":0,"apiTimeAvg":1015.7607923076923,"apiTimeMin":330.3206,"apiTimeMax":1819.2173,"serviceTimeAvg":957.094776923077,"serviceTimeMin":215.24,"serviceTimeMax":1697.3612},{"name":"Samir Solanki","userId":"/users/56eaec62baf08b06e46d27fd","callCountSuccess":0,"callCountBlocked":0,"callCountFailed":0,"callCountOther":0,"callCountTotal":0,"bandwidth":0,"cacheHitCount":0,"cacheMissCount":0,"apiTimeAvg":0,"apiTimeMin":0,"apiTimeMax":0,"serviceTimeAvg":0,"serviceTimeMin":0,"serviceTimeMax":0},{"name":"Anonymous","userId":"/users/54c800b332965a0035030000","callCountSuccess":0,"callCountBlocked":0,"callCountFailed":0,"callCountOther":0,"callCountTotal":0,"bandwidth":0,"cacheHitCount":0,"cacheMissCount":0,"apiTimeAvg":0,"apiTimeMin":0,"apiTimeMax":0,"serviceTimeAvg":0,"serviceTimeMin":0,"serviceTimeMax":0}],"count":3,"nextLink":""}}}},"ApiManagementPatchSubscriptions":{"parameters":{"apimBaseUrl":"apimservice1.management.azure-api.net","sid":"5a58bb26a40f7ef2e05bd5e9","notify":"False","api-version":"2017-03-01","If-Match":"\"AAAAAAAADgQ=\"","parameters":{"expirationDate":"2019-01-12T13:41:58.5287235Z"}},"responses":{"204":{}}},"ApiManagementPostUsersGenerateSsoUrl":{"parameters":{"apimBaseUrl":"apimservice1.management.azure-api.net","uid":"5a58bb61a40f7ef2e05bdc0f","api-version":"2017-03-01","Accept":"application/json"},"responses":{"200":{"body":{"value":"https://portal.apim.net/signin-sso?token=5a58bb61a40f7ef2e05bdc0f%26201801121347%26sR2koAEheTKPKakx88NkU1bZe5xmQ4xhX8Tk1CHFKKGVh4BMvy3ltuoSSt4B38L%2fIRxDs0saqAVc0l9I4Z8nLg%3d%3d"}}}},"ApiManagementDeleteBackends":{"parameters":{"apimBaseUrl":"apimservice1.management.azure-api.net","backendid":"5a58bad2a40f7ef2e05bcce3","api-version":"2017-03-01","If-Match":"*"},"responses":{"204":{}}},"ApiManagementListUsersGroups":{"parameters":{"apimBaseUrl":"apimservice1.management.azure-api.net","uid":"5a58bae5a40f7ef2e05bcd76","api-version":"2017-03-01","Accept":"application/json"},"responses":{"200":{"body":{"value":[{"id":"/groups/developers","name":"Developers","description":"Developers is a built-in group. Its membership is managed by the system. Signed-in users fall into this group.","builtIn":true,"type":"system"}],"count":1}}}},"ApiManagementListTemplates":{"parameters":{"apimBaseUrl":"apimservice1.management.azure-api.net","api-version":"2017-03-01"},"responses":{"200":{"body":{"value":[{"id":"/templates/ApplicationApprovedNotificationMessage","subject":"Your application $AppName is published in the application gallery","body":"<!DOCTYPE html >\r\n<html>\r\n <head />\r\n <body>\r\n <p style=\"font-size:12pt;font-family:'Segoe UI'\">Dear $DevFirstName $DevLastName,</p>\r\n <p style=\"font-size:12pt;font-family:'Segoe UI'\">\r\n We are happy to let you know that your request to publish the $AppName application in the application gallery has been approved. Your application has been published and can be viewed <a href=\"http://$DevPortalUrl/Applications/Details/$AppId\">here</a>.\r\n </p>\r\n <p style=\"font-size:12pt;font-family:'Segoe UI'\">Best,</p>\r\n <p style=\"font-size:12pt;font-family:'Segoe UI'\">The $OrganizationName API Team</p>\r\n </body>\r\n</html>","title":"Application gallery submission approved","description":"Developers who submitted their application for publication in the application gallery on the developer portal receive this email after their submission is approved.","isDefault":true,"parameters":[{"name":"AppId","title":"Application id"},{"name":"AppName","title":"Application name"},{"name":"DevFirstName","title":"Developer first name"},{"name":"DevLastName","title":"Developer last name"},{"name":"OrganizationName","title":"Organization name"},{"name":"DevPortalUrl","title":"Developer portal URL"}]},{"id":"/templates/AccountClosedDeveloper","subject":"Thank you for using the $OrganizationName API!","body":"<!DOCTYPE html >\r\n<html>\r\n <head />\r\n <body>\r\n <p style=\"font-size:12pt;font-family:'Segoe UI'\">Dear $DevFirstName $DevLastName,</p>\r\n <p style=\"font-size:12pt;font-family:'Segoe UI'\">\r\n On behalf of $OrganizationName and our customers we thank you for giving us a try. Your $OrganizationName API account is now closed.\r\n </p>\r\n <p style=\"font-size:12pt;font-family:'Segoe UI'\">Thank you,</p>\r\n <p style=\"font-size:12pt;font-family:'Segoe UI'\">Your $OrganizationName Team</p>\r\n <a href=\"$DevPortalUrl\">$DevPortalUrl</a>\r\n <p />\r\n </body>\r\n</html>","title":"Developer farewell letter","description":"Developers receive this fairwell email after they close their account.","isDefault":true,"parameters":[{"name":"DevFirstName","title":"Developer first name"},{"name":"DevLastName","title":"Developer last name"},{"name":"OrganizationName","title":"Organization name"},{"name":"DevPortalUrl","title":"Developer portal URL"}]},{"id":"/templates/QuotaLimitApproachingDeveloperNotificationMessage","subject":"You are approaching an API quota limit","body":"<!DOCTYPE html >\r\n<html>\r\n <head>\r\n <style>\r\n body {font-size:12pt; font-family:\"Segoe UI\",\"Segoe WP\",\"Tahoma\",\"Arial\",\"sans-serif\";}\r\n .alert { color: red; }\r\n .child1 { padding-left: 20px; }\r\n .child2 { padding-left: 40px; }\r\n .number { text-align: right; }\r\n .text { text-align: left; }\r\n th, td { padding: 4px 10px; min-width: 100px; }\r\n th { background-color: #DDDDDD;}\r\n </style>\r\n </head>\r\n <body>\r\n <p>Greetings $DevFirstName $DevLastName!</p>\r\n <p>\r\n You are approaching the quota limit on you subscription to the <strong>$ProdName</strong> product (primary key $SubPrimaryKey).\r\n #if ($QuotaResetDate != \"\")\r\n This quota will be renewed on $QuotaResetDate.\r\n #else\r\n This quota will not be renewed.\r\n #end\r\n </p>\r\n <p>Below are details on quota usage for the subscription:</p>\r\n <p>\r\n <table>\r\n <thead>\r\n <th class=\"text\">Quota Scope</th>\r\n <th class=\"number\">Calls</th>\r\n <th class=\"number\">Call Quota</th>\r\n <th class=\"number\">Bandwidth</th>\r\n <th class=\"number\">Bandwidth Quota</th>\r\n </thead>\r\n <tbody>\r\n <tr>\r\n <td class=\"text\">Subscription</td>\r\n <td class=\"number\">\r\n #if ($CallsAlert == true)\r\n <span class=\"alert\">$Calls</span>\r\n #else\r\n $Calls\r\n #end\r\n </td>\r\n <td class=\"number\">$CallQuota</td>\r\n <td class=\"number\">\r\n #if ($BandwidthAlert == true)\r\n <span class=\"alert\">$Bandwidth</span>\r\n #else\r\n $Bandwidth\r\n #end\r\n </td>\r\n <td class=\"number\">$BandwidthQuota</td>\r\n </tr>\r\n #foreach ($api in $Apis)\r\n <tr><td class=\"child1 text\">API: $api.Name</td><td class=\"number\">\r\n #if ($api.CallsAlert == true)\r\n <span class=\"alert\">$api.Calls</span>\r\n #else\r\n $api.Calls\r\n #end\r\n </td><td class=\"number\">$api.CallQuota</td><td class=\"number\">\r\n #if ($api.BandwidthAlert == true)\r\n <span class=\"alert\">$api.Bandwidth</span>\r\n #else\r\n $api.Bandwidth\r\n #end\r\n </td><td class=\"number\">$api.BandwidthQuota</td></tr>\r\n #foreach ($operation in $api.Operations)\r\n <tr><td class=\"child2 text\">Operation: $operation.Name</td><td class=\"number\">\r\n #if ($operation.CallsAlert == true)\r\n <span class=\"alert\">$operation.Calls</span>\r\n #else\r\n $operation.Calls\r\n #end\r\n </td><td class=\"number\">$operation.CallQuota</td><td class=\"number\">\r\n #if ($operation.BandwidthAlert == true)\r\n <span class=\"alert\">$operation.Bandwidth</span>\r\n #else\r\n $operation.Bandwidth\r\n #end\r\n </td><td class=\"number\">$operation.BandwidthQuota</td></tr>\r\n #end\r\n #end\r\n </tbody>\r\n </table>\r\n </p>\r\n <p>Thank you,</p>\r\n <p>$OrganizationName API Team</p>\r\n <a href=\"$DevPortalUrl\">$DevPortalUrl</a>\r\n <p />\r\n </body>\r\n</html>","title":"Developer quota limit approaching notification","description":"Developers receive this email to alert them when they are approaching a quota limit.","isDefault":true,"parameters":[{"name":"DevFirstName","title":"Developer first name"},{"name":"DevLastName","title":"Developer last name"},{"name":"ProdName","title":"Product name"},{"name":"OrganizationName","title":"Organization name"},{"name":"SubPrimaryKey","title":"Primary Subscription key"},{"name":"DevPortalUrl","title":"Developer portal URL"},{"name":"QuotaResetDate","title":"Quota reset date"}]},{"id":"/templates/NewDeveloperNotificationMessage","subject":"Welcome to the $OrganizationName API!","body":"<!DOCTYPE html >\r\n<html>\r\n <head>\r\n <meta charset=\"UTF-8\" />\r\n <title>Letter</title>\r\n </head>\r\n <body>\r\n <h1 style=\"color:#000505;font-size:18pt;font-family:'Segoe UI'\">\r\n Welcome to <span style=\"color:#003363\">$OrganizationName API!</span></h1>\r\n <p style=\"font-size:12pt;font-family:'Segoe UI'\">Dear $DevFirstName $DevLastName,</p>\r\n <p style=\"font-size:12pt;font-family:'Segoe UI'\">Your $OrganizationName API program registration is completed and we are thrilled to have you as a customer. Here are a few important bits of information for your reference:</p>\r\n <table width=\"100%\" style=\"margin:20px 0\">\r\n <tr>\r\n #if ($IdentityProvider == \"Basic\")\r\n <td width=\"50%\" style=\"height:40px;vertical-align:top;font-family:'Segoe UI';font-size:12pt\">\r\n Please use the following <strong>username</strong> when signing into any of the ${OrganizationName}-hosted developer portals:\r\n </td><td style=\"vertical-align:top;font-family:'Segoe UI';font-size:12pt\"><strong>$DevUsername</strong></td>\r\n #else\r\n <td width=\"50%\" style=\"height:40px;vertical-align:top;font-family:'Segoe UI';font-size:12pt\">\r\n Please use the following <strong>$IdentityProvider account</strong> when signing into any of the ${OrganizationName}-hosted developer portals:\r\n </td><td style=\"vertical-align:top;font-family:'Segoe UI';font-size:12pt\"><strong>$DevUsername</strong></td> \r\n #end\r\n </tr>\r\n <tr>\r\n <td style=\"height:40px;vertical-align:top;font-family:'Segoe UI';font-size:12pt\">\r\n We will direct all communications to the following <strong>email address</strong>:\r\n </td>\r\n <td style=\"vertical-align:top;font-family:'Segoe UI';font-size:12pt\">\r\n <a href=\"mailto:$DevEmail\" style=\"text-decoration:none\">\r\n <strong>$DevEmail</strong>\r\n </a>\r\n </td>\r\n </tr>\r\n </table>\r\n <p style=\"font-size:12pt;font-family:'Segoe UI'\">Best of luck in your API pursuits!</p>\r\n <p style=\"font-size:12pt;font-family:'Segoe UI'\">$OrganizationName API Team</p>\r\n <p style=\"font-size:12pt;font-family:'Segoe UI'\">\r\n <a href=\"$DevPortalUrl\">$DevPortalUrl</a>\r\n </p>\r\n </body>\r\n</html>","title":"Developer welcome letter","description":"Developers receive this “welcome” email after they confirm their new account.","isDefault":true,"parameters":[{"name":"DevFirstName","title":"Developer first name"},{"name":"DevLastName","title":"Developer last name"},{"name":"DevUsername","title":"Developer user name"},{"name":"DevEmail","title":"Developer email"},{"name":"OrganizationName","title":"Organization name"},{"name":"DevPortalUrl","title":"Developer portal URL"},{"name":"IdentityProvider","title":"Identity Provider selected by Organization"}]},{"id":"/templates/EmailChangeIdentityDefault","subject":"Please confirm the new email associated with your $OrganizationName API account","body":"<!DOCTYPE html >\r\n<html>\r\n <head>\r\n <meta charset=\"UTF-8\" />\r\n <title>Letter</title>\r\n </head>\r\n <body>\r\n <table width=\"100%\">\r\n <tr>\r\n <td>\r\n <p style=\"font-size:12pt;font-family:'Segoe UI'\">Dear $DevFirstName $DevLastName,</p>\r\n <p style=\"font-size:12pt;font-family:'Segoe UI'\"></p>\r\n <p style=\"font-size:12pt;font-family:'Segoe UI'\">You are receiving this email because you made a change to the email address on your $OrganizationName API account.</p>\r\n <p style=\"font-size:12pt;font-family:'Segoe UI'\">Please click on the following link to confirm the change:</p>\r\n <p style=\"font-size:12pt;font-family:'Segoe UI'\">\r\n <a id=\"confirmUrl\" href=\"$ConfirmUrl\" style=\"text-decoration:none\">\r\n <strong>$ConfirmUrl</strong>\r\n </a>\r\n </p>\r\n <p style=\"font-size:12pt;font-family:'Segoe UI'\">If clicking the link does not work, please copy-and-paste or re-type it into your browser's address bar and hit \"Enter\".</p>\r\n <p style=\"font-size:12pt;font-family:'Segoe UI'\">Thank you,</p>\r\n <p style=\"font-size:12pt;font-family:'Segoe UI'\">$OrganizationName API Team</p>\r\n <p style=\"font-size:12pt;font-family:'Segoe UI'\">\r\n <a href=\"$DevPortalUrl\">$DevPortalUrl</a>\r\n </p>\r\n </td>\r\n </tr>\r\n </table>\r\n </body>\r\n</html>","title":"Email change confirmation","description":"Developers receive this email to confirm a new e-mail address after they change their existing one associated with their account.","isDefault":true,"parameters":[{"name":"DevFirstName","title":"Developer first name"},{"name":"DevLastName","title":"Developer last name"},{"name":"OrganizationName","title":"Organization name"},{"name":"DevPortalUrl","title":"Developer portal URL"},{"name":"ConfirmUrl","title":"Developer confirmation URL"}]},{"id":"/templates/InviteUserNotificationMessage","subject":"You are invited to join the $OrganizationName developer network","body":"<!DOCTYPE html >\r\n<html>\r\n <head />\r\n <body>\r\n <p style=\"font-size:12pt;font-family:'Segoe UI'\">Dear $DevFirstName $DevLastName,</p>\r\n <p style=\"font-size:12pt;font-family:'Segoe UI'\">\r\n Your account has been created. Please follow the link below to visit the $OrganizationName developer portal and claim it:\r\n </p>\r\n <p style=\"font-size:12pt;font-family:'Segoe UI'\">\r\n <a href=\"$ConfirmUrl\">$ConfirmUrl</a>\r\n </p>\r\n <p style=\"font-size:12pt;font-family:'Segoe UI'\">Best,</p>\r\n <p style=\"font-size:12pt;font-family:'Segoe UI'\">The $OrganizationName API Team</p>\r\n </body>\r\n</html>","title":"Invite user","description":"An e-mail invitation to create an account, sent on request by API publishers.","isDefault":true,"parameters":[{"name":"OrganizationName","title":"Organization name"},{"name":"DevFirstName","title":"Developer first name"},{"name":"DevLastName","title":"Developer last name"},{"name":"ConfirmUrl","title":"Confirmation link"}]}],"count":14}}}},"ApiManagementPatchTemplates":{"parameters":{"apimBaseUrl":"apimservice1.management.azure-api.net","templateName":"newIssueNotificationMessage","api-version":"2017-03-01","Accept":"application/json","parameters":{"subject":"Your request for $IssueName was successfully received."}},"responses":{"204":{}}},"ApiManagementPatchApisOperations":{"parameters":{"apimBaseUrl":"apimservice1.management.azure-api.net","apiId":"5a58bb25a40f7ef2e05bd5b2","operationId":"5a58bb25a40f7ef2e05bd5c5","api-version":"2017-03-01","If-Match":"\"AAAAAAAADfY=\"","parameters":{"method":"DELETE","responses":[{"statusCode":200,"description":"description_5a58bb25a40f7ef2e05bd5d1","representations":[{"contentType":"application/json","sample":"sample_5a58bb25a40f7ef2e05bd5d2"},{"contentType":"application/xml","sample":"sample_5a58bb25a40f7ef2e05bd5d3"}]}]}},"responses":{"204":{}}},"ApiManagementGetApisPolicies":{"parameters":{"apimBaseUrl":"apimservice1.management.azure-api.net","apiId":"5a58bf63a40f7e104892bdaf","policyId":"policy","api-version":"2017-03-01","Accept":"application/json"},"responses":{"200":{"body":{"id":"/apis/5a58bf63a40f7e104892bdaf/policies/policy","policyContent":"<policies>\r\n <inbound>\r\n <base />\r\n <cache-lookup vary-by-developer=\"false\" vary-by-developer-groups=\"false\" downstream-caching-type=\"none\">\r\n <vary-by-query-parameter>version</vary-by-query-parameter>\r\n <vary-by-header>Accept</vary-by-header>\r\n <vary-by-header>Accept-Charset</vary-by-header>\r\n </cache-lookup>\r\n </inbound>\r\n <backend>\r\n <base />\r\n </backend>\r\n <outbound>\r\n <cache-store duration=\"@(10)\" />\r\n <base />\r\n </outbound>\r\n</policies>"}}}},"ApiManagementPutSubscriptions":{"parameters":{"apimBaseUrl":"apimservice1.management.azure-api.net","sid":"%20%E2%99%A5john.5a58bae0a40f7ef2e05bcd51@gmail.com000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000","notify":"False","api-version":"2017-03-01","parameters":{"userId":"/users/5a58bae0a40f7ef2e05bcd4b","productId":"/products/5a58bae0a40f7ef2e05bcd3d"}},"responses":{"201":{"body":{"id":"/subscriptions/ ♥john.5a58bae0a40f7ef2e05bcd51@gmail.com000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000","userId":"/users/5a58bae0a40f7ef2e05bcd4b","productId":"/products/5a58bae0a40f7ef2e05bcd3d","name":"product_5a58bae0a40f7ef2e05bcd3e subscription","state":"active","createdDate":"2018-01-12T13:40:48.276514Z","startDate":"2018-01-12T00:00:00Z","primaryKey":"<primaryKey>","secondaryKey":"<secondaryKey>"}},"200":{"body":{"id":"/subscriptions/ ♥john.5a58bae0a40f7ef2e05bcd51@gmail.com000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000","userId":"/users/5a58bae0a40f7ef2e05bcd4b","productId":"/products/5a58bae0a40f7ef2e05bcd3d","name":"product_5a58bae0a40f7ef2e05bcd3e subscription","state":"active","createdDate":"2018-01-12T13:40:48.276514Z","startDate":"2018-01-12T00:00:00Z","primaryKey":"<primaryKey>","secondaryKey":"<secondaryKey>"}}}},"ApiManagementPostTenantRegenerateSecondaryKey":{"parameters":{"apimBaseUrl":"apimservice1.management.azure-api.net","api-version":"2017-03-01","accessName":"access"},"responses":{"204":{}}},"ApiManagementListProductsPolicies":{"parameters":{"apimBaseUrl":"apimservice1.management.azure-api.net","$skip":0,"$top":10000,"productId":"starter","api-version":"2017-03-01","Accept":"application/json"},"responses":{"200":{"body":{"value":[{"id":"/policies/policy","policyContent":"<!--\r\n IMPORTANT:\r\n - Policy elements can appear only within the <inbound>, <outbound>, <backend> section elements.\r\n - Only the <forward-request> policy element can appear within the <backend> section element.\r\n - To apply a policy to the incoming request (before it is forwarded to the backend service), place a corresponding policy element within the <inbound> section element.\r\n - To apply a policy to the outgoing response (before it is sent back to the caller), place a corresponding policy element within the <outbound> section element.\r\n - To add a policy position the cursor at the desired insertion point and click on the round button associated with the policy.\r\n - To remove a policy, delete the corresponding policy statement from the policy document.\r\n - Policies are applied in the order of their appearance, from the top down.\r\n-->\r\n<policies>\r\n <inbound />\r\n <backend>\r\n <forward-request />\r\n </backend>\r\n <outbound />\r\n</policies>"}],"count":1}}}},"ApiManagementPutPortalSettingsDelegation":{"parameters":{"apimBaseUrl":"apimservice1.management.azure-api.net","api-version":"2017-03-01","If-Match":"*","parameters":{"url":"http://contoso.com/delegation","validationKey":"<validationKey>","subscriptions":{"enabled":true},"userRegistration":{"enabled":true}}},"responses":{"204":{}}},"ApiManagementGetIdentityProviders":{"parameters":{"apimBaseUrl":"apimservice1.management.azure-api.net","identityProviderName":"google","api-version":"2017-03-01","Accept":"application/json"},"responses":{"200":{"body":{"id":"/identityProviders/Google","clientId":"FOLBTMWPUI","clientSecret":"<clientSecret>","type":"google"}}}},"ApiManagementListGroupsUsers":{"parameters":{"apimBaseUrl":"apimservice1.management.azure-api.net","groupId":"5a58bad0a40f7ef2e05bccca","api-version":"2017-03-01","Accept":"application/json"},"responses":{"200":{"body":{"value":[{"id":"/users/5a58bad0a40f7ef2e05bcccd","firstName":"5a58bad0a40f7ef2e05bcccf","lastName":"5a58bad0a40f7ef2e05bccd0","email":"5a58bad0a40f7ef2e05bccce@contoso.com","state":"active","registrationDate":"2018-01-12T13:40:32.81Z","identities":[{"provider":"Basic","id":"5a58bad0a40f7ef2e05bccce@contoso.com"}]},{"id":"/users/5a58bad0a40f7ef2e05bccd2","firstName":"5a58bad0a40f7ef2e05bccd4","lastName":"5a58bad0a40f7ef2e05bccd5","email":"5a58bad0a40f7ef2e05bccd3@contoso.com","state":"active","registrationDate":"2018-01-12T13:40:32.81Z","identities":[{"provider":"Basic","id":"5a58bad0a40f7ef2e05bccd3@contoso.com"}]},{"id":"/users/5a58bad0a40f7ef2e05bccd7","firstName":"5a58bad0a40f7ef2e05bccd9","lastName":"5a58bad0a40f7ef2e05bccda","email":"5a58bad0a40f7ef2e05bccd8@contoso.com","state":"active","registrationDate":"2018-01-12T13:40:32.86Z","identities":[{"provider":"Basic","id":"5a58bad0a40f7ef2e05bccd8@contoso.com"}]}],"count":3}}}},"ApiManagementPutBackends":{"parameters":{"apimBaseUrl":"apimservice1.management.azure-api.net","backendid":"5a58bb16a40f7ef2e05bd52d","api-version":"2017-03-01","parameters":{"description":"Service Fabric Test App: 5a58bb16a40f7ef2e05bd52d","url":"fabric:/mytestapp/mytestservice","protocol":"http","properties":{"serviceFabricCluster":{"managementEndpoints":["https://somecluster.com"],"clientCertificateThumbprint":"C0F0AE5B3D8E1DF7A32FCB0BB1B43C8A704C54FF","serverCertificateThumbprints":["abcxyz123"],"maxPartitionResolutionRetries":5,"partitionResolutionRequestTimeout":"PT5M"}}}},"responses":{"201":{"body":{"id":"/backends/5a58bb16a40f7ef2e05bd52d","description":"Service Fabric Test App: 5a58bb16a40f7ef2e05bd52d","url":"fabric:/mytestapp/mytestservice","protocol":"http","properties":{"serviceFabricCluster":{"managementEndpoints":["https://somecluster.com"],"clientCertificateThumbprint":"C0F0AE5B3D8E1DF7A32FCB0BB1B43C8A704C54FF","serverCertificateThumbprints":["abcxyz123"],"maxPartitionResolutionRetries":5,"partitionResolutionRequestTimeout":"PT5M"}}}},"200":{"body":{"id":"/backends/5a58bb16a40f7ef2e05bd52d","description":"Service Fabric Test App: 5a58bb16a40f7ef2e05bd52d","url":"fabric:/mytestapp/mytestservice","protocol":"http","properties":{"serviceFabricCluster":{"managementEndpoints":["https://somecluster.com"],"clientCertificateThumbprint":"C0F0AE5B3D8E1DF7A32FCB0BB1B43C8A704C54FF","serverCertificateThumbprints":["abcxyz123"],"maxPartitionResolutionRetries":5,"partitionResolutionRequestTimeout":"PT5M"}}}}}},"ApiManagementGetTemplates":{"parameters":{"apimBaseUrl":"apimservice1.management.azure-api.net","templateName":"applicationApprovedNotificationMessage","api-version":"2017-03-01","Accept":"application/json"},"responses":{"200":{"body":{"id":"/templates/ApplicationApprovedNotificationMessage","subject":"Your application $AppName is published in the application gallery","body":"<!DOCTYPE html >\r\n<html>\r\n <head />\r\n <body>\r\n <p style=\"font-size:12pt;font-family:'Segoe UI'\">Dear $DevFirstName $DevLastName,</p>\r\n <p style=\"font-size:12pt;font-family:'Segoe UI'\">\r\n We are happy to let you know that your request to publish the $AppName application in the application gallery has been approved. Your application has been published and can be viewed <a href=\"http://$DevPortalUrl/Applications/Details/$AppId\">here</a>.\r\n </p>\r\n <p style=\"font-size:12pt;font-family:'Segoe UI'\">Best,</p>\r\n <p style=\"font-size:12pt;font-family:'Segoe UI'\">The $OrganizationName API Team</p>\r\n </body>\r\n</html>","title":"Application gallery submission approved","description":"Developers who submitted their application for publication in the application gallery on the developer portal receive this email after their submission is approved.","isDefault":true,"parameters":[{"name":"AppId","title":"Application id"},{"name":"AppName","title":"Application name"},{"name":"DevFirstName","title":"Developer first name"},{"name":"DevLastName","title":"Developer last name"},{"name":"OrganizationName","title":"Organization name"},{"name":"DevPortalUrl","title":"Developer portal URL"}]}}}},"ApiManagementGetReportsByRequest":{"parameters":{"apimBaseUrl":"apimservice1.management.azure-api.net","api-version":"2017-03-01","$filter":"timestamp ge datetime'2017-06-01T00:00:00' and timestamp le datetime'2017-06-04T00:00:00'"},"responses":{"200":{"body":{"value":[{"apiId":"/apis/5931a75ae4bbd512a88c680b","operationId":"/apis/5931a75ae4bbd512a88c680b/operations/-","productId":"/products/-","userId":"/users/1","method":"GET","url":"https://apimService1.azure-api.net/echo/resource?param1=sample","ipAddress":"207.xx.155.xx","responseCode":404,"responseSize":405,"timestamp":"2017-06-03T00:17:00.1649134Z","cache":"none","apiTime":221.1544,"serviceTime":0.0,"apiRegion":"East Asia","subscriptionId":"/subscriptions/5600b59475ff190048070002","requestId":"63e7119c-26aa-433c-96d7-f6f3267ff52f","requestSize":0},{"apiId":"/apis/5931a75ae4bbd512a88c680b","operationId":"/apis/5931a75ae4bbd512a88c680b/operations/-","productId":"/products/-","userId":"/users/1","method":"POST","url":"https://apimService1.azure-api.net/echo/resource","ipAddress":"207.xx.155.xx","responseCode":404,"responseSize":403,"timestamp":"2017-06-03T00:17:20.5255131Z","cache":"none","apiTime":6.675400000000001,"serviceTime":0.0,"apiRegion":"East Asia","subscriptionId":"/subscriptions/5600b59475ff190048070002","requestId":"e581b7f7-c9ec-4fc6-8ab9-3855d9b00b04","requestSize":0}],"count":2}}}},"ApiManagementListIdentityProviders":{"parameters":{"apimBaseUrl":"apimservice1.management.azure-api.net","api-version":"2017-03-01","Accept":"application/json"},"responses":{"200":{"body":{"value":[],"count":0}}}},"ApiManagementDeleteUsers":{"parameters":{"apimBaseUrl":"apimservice1.management.azure-api.net","uid":"5a58bb00a40f7ef2e05bd23e","deleteSubscriptions":"False","notify":"False","api-version":"2017-03-01","If-Match":"\"AAAAAAAACqkAAAAAAAAKqw==\""},"responses":{"204":{}}}}
No API Resources

(Product) (Docs)

---

{"class":["gateway"],"properties":{"name":"CloudFlare","provider":"CloudFlare","slug":"cloudflare","rating":1,"license":"Proprietary","status":"Pending Review","researchDate":"2022-11","description":"At Cloudflare, we know APIs make the world go around. That is why we make our massive global network your API gateway. With API discovery, integrated API management and analytics, and layered API defenses, Cloudflare ensures APIs drive business success like never before.\n","platformCapabilities":["Gateway","Analytics","Threat Protection"],"gatewayCapabilities":["Custom Code Execution","Mediation","Traffic Management","Versioning"],"customCodeSupport":["None"],"upstreamProtocols":["HTTP/1.1"],"downstreamProtocols":["HTTP/1.1"],"deliveryModels":["SaaS"],"policies":[{"category":"Traffic Management","capabilities":["Quota","Quota Reset","Rate Limiting","Request Size Limiting","Spike Control","Throttling","Traffic Optimization"]},{"category":"Mediation","capabilities":["CORS","Request Size Limit","Request Termination","Request Transformation","Response Transformation","Transformation Rules","URL Rewriting"]},{"category":"Security","capabilities":["API Key","API Key Authentication","Access Control Lists (ACL)","Audit Logs","Basic Authentication","CORS","JWT Validation","JWT authorizers","Mutual TLS","OAuth 1.0","OAuth 2.0","OWASP Top 10","WAF"]},{"category":"Extensions","capabilities":["HTTP Callout","HTTP integrations","Serverless"]}]},"links":[{"rel":["urn:gateway:product"],"title":"Product","href":"https://www.cloudflare.com/products/api-gateway/"},{"rel":["urn:gateway:docs"],"title":"Documentation","href":"https://www.cloudflare.com/products/api-gateway/"},{"rel":["urn:gateway:logo"],"title":"Logo","href":"/images/gateways/name.svg"},{"rel":["urn:gateway:screenshot"],"title":"Screenshot","href":"https://kinlane-productions2.s3.amazonaws.com/api-gateways/cloudflare.png"}]}

CloudFlare

At Cloudflare, we know APIs make the world go around. That is why we make our massive global network your API gateway. With API discovery, integrated API management and analytics, and layered API defenses, Cloudflare ensures APIs drive business success like never before.

Platform Capabilities

These are the wider capabilities beyond the gateway they offer.

• Gateway
• Analytics
• Threat Protection

Gateway Capabilities

These are the capabilities the gateway supports.

• Custom Code Execution
• Mediation
• Traffic Management
• Versioning

Upstream Protocols

The different protocols they support upstream.

• HTTP/1.1

Downtream Protocols

The different protocols they support downstream.

• HTTP/1.1

Custom Code

If they offer plugin, extension, and custom coding options.

• None

Delivery Models

These are they ways you can deliver this solution.

• SaaS

Policies

These are the policies available across the gateway capabilities.

Traffic Management

• Quota
• Quota Reset
• Rate Limiting
• Request Size Limiting
• Spike Control
• Throttling
• Traffic Optimization

Mediation

• CORS
• Request Size Limit
• Request Termination
• Request Transformation
• Response Transformation
• Transformation Rules
• URL Rewriting

Security

• API Key
• API Key Authentication
• Access Control Lists (ACL)
• Audit Logs
• Basic Authentication
• CORS
• JWT Validation
• JWT authorizers
• Mutual TLS
• OAuth 1.0
• OAuth 2.0
• OWASP Top 10
• WAF

Extensions

• HTTP Callout
• HTTP integrations
• Serverless

API Resources

Cloudflare API OpenAPI	{"openapi":"3.0.3","components":{"schemas":{"0rtt":{"allOf":[{"$ref":"#/components/schemas/schemas-base"},{"properties":{"id":{"description":"ID of the zone setting.","enum":["0rtt"],"example":"0rtt"},"value":{"$ref":"#/components/schemas/0rtt_value"}}}],"title":"0-RTT Value","description":"0-RTT session resumption enabled for this zone."},"0rtt_value":{"type":"string","description":"Value of the 0-RTT setting.","enum":["on","off"],"default":"off"},"AAAARecord":{"allOf":[{"$ref":"#/components/schemas/dns-record_components-schemas-base"},{"properties":{"content":{"type":"string","format":"ipv6","description":"A valid IPv6 address.","example":"2400:cb00:2049:1::173.245.59.16"},"name":{"$ref":"#/components/schemas/dns-record_components-schemas-name"},"type":{"description":"Record type.","enum":["AAAA"],"example":"AAAA"}}}],"title":"AAAA Record","required":["type","name","content"]},"ARecord":{"allOf":[{"$ref":"#/components/schemas/dns-record_components-schemas-base"},{"properties":{"content":{"type":"string","format":"ipv4","description":"A valid IPv4 address.","example":"198.51.100.4"},"name":{"$ref":"#/components/schemas/dns-record_components-schemas-name"},"type":{"description":"Record type.","enum":["A"],"example":"A"}}}],"title":"A Record","required":["type","name","content"]},"CERTRecord":{"allOf":[{"$ref":"#/components/schemas/dns-record_components-schemas-base"},{"properties":{"content":{"type":"string","description":"Formatted CERT content. See 'data' to set CERT properties.","readOnly":true},"data":{"type":"object","description":"Components of a CERT record.","properties":{"algorithm":{"type":"number","description":"Algorithm.","example":8,"minimum":0,"maximum":255},"certificate":{"type":"string","description":"Certificate."},"key_tag":{"type":"number","description":"Key Tag.","example":1,"minimum":0,"maximum":65535},"type":{"type":"number","description":"Type.","example":9,"minimum":0,"maximum":65535}}},"name":{"$ref":"#/components/schemas/dns-record_components-schemas-name"},"type":{"description":"Record type.","enum":["CERT"],"example":"CERT"}}}],"title":"CERT Record","required":["type","name","data"]},"CNAMERecord":{"allOf":[{"$ref":"#/components/schemas/dns-record_components-schemas-base"},{"properties":{"content":{"description":"A valid hostname."},"name":{"$ref":"#/components/schemas/dns-record_components-schemas-name"},"type":{"description":"Record type.","enum":["CNAME"],"example":"CNAME"}}}],"title":"CNAME Record","required":["type","name","content"]},"Cloudflare Client API_domain-response-collection":{"allOf":[{"$ref":"#/components/schemas/api-response-common"},{"type":"object","properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/domain"}}}}]},"Cloudflare Client API_domain-response-single":{"allOf":[{"$ref":"#/components/schemas/api-response-common"},{"type":"object","properties":{"result":{"$ref":"#/components/schemas/domain"}}}]},"Cloudflare Client API_domain_name":{"type":"string","description":"Domain name.","example":"cloudflare.com"},"Cloudflare Client API_identifier":{"type":"string","description":"Policy identifier.","example":"f267e341f3dd4697bd3b9f71dd96247f","readOnly":true},"CustomNS":{"title":"Custom NS","description":"A single account custom nameserver.","required":["dns_records","ns_name","status","zone_tag"],"properties":{"dns_records":{"type":"array","description":"A and AAAA records associated with the nameserver.","items":{"properties":{"type":{"type":"string","description":"DNS record type.","enum":["A","AAAA"],"example":"A"},"value":{"type":"string","description":"DNS record contents (an IPv4 or IPv6 address).","example":"1.1.1.1"}}}},"ns_name":{"$ref":"#/components/schemas/ns_name"},"status":{"type":"string","description":"Verification status of the nameserver.","enum":["moved","pending","verified"],"example":"verified"},"zone_tag":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}},"CustomNSInput":{"title":"Custom NS Input","required":["ns_name"],"properties":{"ns_name":{"$ref":"#/components/schemas/ns_name"}}},"DNSKEYRecord":{"allOf":[{"$ref":"#/components/schemas/dns-record_components-schemas-base"},{"properties":{"content":{"type":"string","description":"Formatted DNSKEY content. See 'data' to set DNSKEY properties.","readOnly":true},"data":{"type":"object","description":"Components of a DNSKEY record.","properties":{"algorithm":{"type":"number","description":"Algorithm.","example":5,"minimum":0,"maximum":255},"flags":{"type":"number","description":"Flags.","example":1,"minimum":0,"maximum":65535},"protocol":{"type":"number","description":"Protocol.","example":3,"minimum":0,"maximum":255},"public_key":{"type":"string","description":"Public Key."}}},"name":{"$ref":"#/components/schemas/dns-record_components-schemas-name"},"type":{"description":"Record type.","enum":["DNSKEY"],"example":"DNSKEY"}}}],"title":"DNSKEY Record","required":["type","name","data"]},"DSRecord":{"allOf":[{"$ref":"#/components/schemas/dns-record_components-schemas-base"},{"properties":{"content":{"type":"string","description":"Formatted DS content. See 'data' to set DS properties.","readOnly":true},"data":{"type":"object","description":"Components of a DS record.","properties":{"algorithm":{"type":"number","description":"Algorithm.","example":3,"minimum":0,"maximum":255},"digest":{"type":"string","description":"Digest."},"digest_type":{"type":"number","description":"Digest Type.","example":1,"minimum":0,"maximum":255},"key_tag":{"type":"number","description":"Key Tag.","example":1,"minimum":0,"maximum":65535}}},"name":{"$ref":"#/components/schemas/dns-record_components-schemas-name"},"type":{"description":"Record type.","enum":["DS"],"example":"DS"}}}],"title":"DS Record","required":["type","name","data"]},"HTTPSRecord":{"allOf":[{"$ref":"#/components/schemas/dns-record_components-schemas-base"},{"properties":{"content":{"type":"string","description":"Formatted HTTPS content. See 'data' to set HTTPS properties.","readOnly":true},"data":{"type":"object","description":"Components of a HTTPS record.","properties":{"priority":{"type":"number","description":"priority.","example":1,"minimum":0,"maximum":65535},"target":{"type":"string","description":"target.","example":"."},"value":{"type":"string","description":"value.","example":"alpn=\"h3,h2\" ipv4hint=\"127.0.0.1\" ipv6hint=\"::1\""}}},"name":{"$ref":"#/components/schemas/dns-record_components-schemas-name"},"type":{"description":"Record type.","enum":["HTTPS"],"example":"HTTPS"}}}],"title":"HTTPS Record","required":["type","name","data"]},"Host":{"type":"array","description":"The 'Host' header allows to override the hostname set in the HTTP request. Current support is 1 'Host' header override per origin.","items":{"type":"string","example":"example.com"}},"LOCRecord":{"allOf":[{"$ref":"#/components/schemas/dns-record_components-schemas-base"},{"properties":{"content":{"type":"string","description":"Formatted LOC content. See 'data' to set LOC properties.","example":"IN LOC 37 46 46 N 122 23 35 W 0m 100m 0m 0m","readOnly":true},"data":{"type":"object","description":"Components of a LOC record.","properties":{"altitude":{"type":"number","description":"Altitude of location in meters.","example":0,"minimum":-100000,"maximum":42849672.95},"lat_degrees":{"type":"number","description":"Degrees of latitude.","example":37,"minimum":0,"maximum":90},"lat_direction":{"description":"Latitude direction.","enum":["N","S"],"example":"N"},"lat_minutes":{"type":"number","description":"Minutes of latitude.","default":0,"example":46,"minimum":0,"maximum":59},"lat_seconds":{"type":"number","description":"Seconds of latitude.","default":0,"example":46,"minimum":0,"maximum":59.999},"long_degrees":{"type":"number","description":"Degrees of longitude.","example":122,"minimum":0,"maximum":180},"long_direction":{"description":"Longitude direction.","enum":["E","W"],"example":"W"},"long_minutes":{"type":"number","description":"Minutes of longitude.","default":0,"example":23,"minimum":0,"maximum":59},"long_seconds":{"type":"number","description":"Seconds of longitude.","default":0,"example":35,"minimum":0,"maximum":59.999},"precision_horz":{"type":"number","description":"Horizontal precision of location.","default":0,"example":0,"minimum":0,"maximum":"9e+07"},"precision_vert":{"type":"number","description":"Vertical precision of location.","default":0,"example":0,"minimum":0,"maximum":"9e+07"},"size":{"type":"number","description":"Size of location in meters.","default":0,"example":100,"minimum":0,"maximum":"9e+07"}}},"name":{"$ref":"#/components/schemas/dns-record_components-schemas-name"},"type":{"description":"Record type.","enum":["LOC"],"example":"LOC"}}}],"title":"LOC Record","required":["type","name","data"]},"MXRecord":{"allOf":[{"$ref":"#/components/schemas/dns-record_components-schemas-base"},{"properties":{"content":{"type":"string","format":"hostname","description":"A valid mail server hostname.","example":"mx.example.com"},"name":{"$ref":"#/components/schemas/dns-record_components-schemas-name"},"priority":{"$ref":"#/components/schemas/priority"},"type":{"description":"Record type.","enum":["MX"],"example":"MX"}}}],"title":"MX Record","required":["type","name","content","priority"]},"NAPTRRecord":{"allOf":[{"$ref":"#/components/schemas/dns-record_components-schemas-base"},{"properties":{"content":{"type":"string","description":"Formatted NAPTR content. See 'data' to set NAPTR properties.","readOnly":true},"data":{"type":"object","description":"Components of a NAPTR record.","properties":{"flags":{"type":"string","description":"Flags."},"order":{"type":"number","description":"Order.","example":100,"minimum":0,"maximum":65535},"preference":{"type":"number","description":"Preference.","example":10,"minimum":0,"maximum":65535},"regex":{"type":"string","description":"Regex."},"replacement":{"type":"string","description":"Replacement."},"service":{"type":"string","description":"Service."}}},"name":{"$ref":"#/components/schemas/dns-record_components-schemas-name"},"type":{"description":"Record type.","enum":["NAPTR"],"example":"NAPTR"}}}],"title":"NAPTR Record","required":["type","name","data"]},"NSRecord":{"allOf":[{"$ref":"#/components/schemas/dns-record_components-schemas-base"},{"properties":{"content":{"description":"A valid name server host name.","example":"ns1.example.com"},"name":{"$ref":"#/components/schemas/dns-record_components-schemas-name"},"type":{"description":"Record type.","enum":["NS"],"example":"NS"}}}],"title":"NS Record","required":["type","name","content"]},"SMIMEARecord":{"allOf":[{"$ref":"#/components/schemas/dns-record_components-schemas-base"},{"properties":{"content":{"type":"string","description":"Formatted SMIMEA content. See 'data' to set SMIMEA properties.","readOnly":true},"data":{"type":"object","description":"Components of a SMIMEA record.","properties":{"certificate":{"type":"string","description":"Certificate."},"matching_type":{"type":"number","description":"Matching Type.","example":0,"minimum":0,"maximum":255},"selector":{"type":"number","description":"Selector.","example":0,"minimum":0,"maximum":255},"usage":{"type":"number","description":"Usage.","example":3,"minimum":0,"maximum":255}}},"name":{"$ref":"#/components/schemas/dns-record_components-schemas-name"},"type":{"description":"Record type.","enum":["SMIMEA"],"example":"SMIMEA"}}}],"title":"SMIMEA Record","required":["type","name","data"]},"SRVRecord":{"allOf":[{"$ref":"#/components/schemas/dns-record_components-schemas-base"},{"properties":{"content":{"type":"string","description":"Priority, weight, port, and SRV target. See 'data' for setting the individual component values.","example":"10 IN SRV 5 8806 example.com.","readOnly":true},"data":{"type":"object","description":"Components of a SRV record.","properties":{"name":{"type":"string","format":"hostname","description":"A valid hostname.","example":"example.com"},"port":{"type":"number","description":"The port of the service.","example":8806,"minimum":0,"maximum":65535},"priority":{"$ref":"#/components/schemas/priority"},"proto":{"type":"string","description":"A valid protocol.","example":"_tcp"},"service":{"type":"string","description":"A service type, prefixed with an underscore.","example":"_sip"},"target":{"type":"string","format":"hostname","description":"A valid hostname.","example":"example.com"},"weight":{"type":"number","description":"The record weight.","example":5,"minimum":0,"maximum":65535}}},"name":{"type":"string","description":"Service, protocol, and SRV name content. See 'data' for setting the individual component values.","example":"_sip._tcp.example.com","readOnly":true,"maxLength":255},"type":{"description":"Record type.","enum":["SRV"],"example":"SRV"}}}],"title":"SRV Record","required":["type","data"]},"SSHFPRecord":{"allOf":[{"$ref":"#/components/schemas/dns-record_components-schemas-base"},{"properties":{"content":{"type":"string","description":"Formatted SSHFP content. See 'data' to set SSHFP properties.","readOnly":true},"data":{"type":"object","description":"Components of a SSHFP record.","properties":{"algorithm":{"type":"number","description":"algorithm.","example":2,"minimum":0,"maximum":255},"fingerprint":{"type":"string","description":"fingerprint."},"type":{"type":"number","description":"type.","example":1,"minimum":0,"maximum":255}}},"name":{"$ref":"#/components/schemas/dns-record_components-schemas-name"},"type":{"description":"Record type.","enum":["SSHFP"],"example":"SSHFP"}}}],"title":"SSHFP Record","required":["type","name","data"]},"SVCBRecord":{"allOf":[{"$ref":"#/components/schemas/dns-record_components-schemas-base"},{"properties":{"content":{"type":"string","description":"Formatted SVCB content. See 'data' to set SVCB properties.","readOnly":true},"data":{"type":"object","description":"Components of a SVCB record.","properties":{"priority":{"type":"number","description":"priority.","example":1,"minimum":0,"maximum":65535},"target":{"type":"string","description":"target.","example":"."},"value":{"type":"string","description":"value.","example":"alpn=\"h3,h2\" ipv4hint=\"127.0.0.1\" ipv6hint=\"::1\""}}},"name":{"$ref":"#/components/schemas/dns-record_components-schemas-name"},"type":{"description":"Record type.","enum":["SVCB"],"example":"SVCB"}}}],"title":"SVCB Record","required":["type","name","data"]},"TLSARecord":{"allOf":[{"$ref":"#/components/schemas/dns-record_components-schemas-base"},{"properties":{"content":{"type":"string","description":"Formatted TLSA content. See 'data' to set TLSA properties.","readOnly":true},"data":{"type":"object","description":"Components of a TLSA record.","properties":{"certificate":{"type":"string","description":"certificate."},"matching_type":{"type":"number","description":"Matching Type.","example":1,"minimum":0,"maximum":255},"selector":{"type":"number","description":"Selector.","example":0,"minimum":0,"maximum":255},"usage":{"type":"number","description":"Usage.","example":0,"minimum":0,"maximum":255}}},"name":{"$ref":"#/components/schemas/dns-record_components-schemas-name"},"type":{"description":"Record type.","enum":["TLSA"],"example":"TLSA"}}}],"title":"TLSA Record","required":["type","name","data"]},"TXTRecord":{"allOf":[{"$ref":"#/components/schemas/dns-record_components-schemas-base"},{"properties":{"content":{"type":"string","description":"Text content for the record.","example":"example text content"},"name":{"$ref":"#/components/schemas/dns-record_components-schemas-name"},"type":{"description":"Record type.","enum":["TXT"],"example":"TXT"}}}],"title":"TXT Record","required":["type","name","content"]},"URIRecord":{"allOf":[{"$ref":"#/components/schemas/dns-record_components-schemas-base"},{"properties":{"content":{"type":"string","description":"Formatted URI content. See 'data' to set URI properties.","readOnly":true},"data":{"type":"object","description":"Components of a URI record.","properties":{"content":{"type":"string","description":"The record content.","example":"http://example.com/example.html"},"weight":{"type":"number","description":"The record weight.","example":20,"minimum":0,"maximum":65535}}},"name":{"$ref":"#/components/schemas/dns-record_components-schemas-name"},"priority":{"$ref":"#/components/schemas/priority"},"type":{"description":"Record type.","enum":["URI"],"example":"URI"}}}],"title":"URI Record","required":["type","name","data","priority"]},"access-policy":{"oneOf":[{"$ref":"#/components/schemas/policy_with_permission_groups"}],"type":"object"},"access-requests":{"type":"object","properties":{"action":{"$ref":"#/components/schemas/access-requests_components-schemas-action"},"allowed":{"$ref":"#/components/schemas/schemas-allowed"},"app_domain":{"$ref":"#/components/schemas/app_domain"},"app_uid":{"$ref":"#/components/schemas/app_uid"},"connection":{"$ref":"#/components/schemas/components-schemas-connection"},"created_at":{"$ref":"#/components/schemas/timestamp"},"ip_address":{"$ref":"#/components/schemas/components-schemas-ip"},"ray_id":{"$ref":"#/components/schemas/ray_id"},"user_email":{"$ref":"#/components/schemas/schemas-email"}}},"access-requests_components-schemas-action":{"type":"string","description":"The event that occurred, such as a login attempt.","example":"login"},"access-requests_components-schemas-identifier":{"example":"699d98642c564d2e855e9661899b7252"},"access-requests_components-schemas-response_collection":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/access-requests"}}}}]},"access_group_rule":{"type":"object","title":"Access groups","description":"Matches an Access group.","required":["group"],"properties":{"group":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The ID of a previously created Access group.","example":"aa0a4aab-672b-4bdb-bc33-a59f1130a11f"}}}}},"access_seat":{"type":"boolean","description":"True if the seat is part of Access.","example":false},"accessRules":{"type":"object","description":"Defines rules for fine-grained control over content than signed URL tokens alone. Access rules primarily make tokens conditionally valid based on user information. Access Rules are specified on token payloads as the `accessRules` property containing an array of Rule objects.","readOnly":true,"properties":{"action":{"type":"string","description":"The action to take when a request matches a rule. If the action is `block`, the signed token blocks views for viewers matching the rule.","enum":["allow","block"],"example":"allow","readOnly":true},"country":{"type":"array","description":"An array of 2-letter country codes in ISO 3166-1 Alpha-2 format used to match requests.","readOnly":true,"items":{"type":"string"}},"ip":{"type":"array","description":"An array of IPv4 or IPV6 addresses or CIDRs used to match requests.","readOnly":true,"items":{"type":"string"}},"type":{"type":"string","description":"Lists available rule types to match for requests. An `any` type matches all requests and can be used as a wildcard to apply default actions after other rules.","enum":["any","ip.src","ip.geoip.country"],"example":"ip.src","readOnly":true}}},"account":{"type":"object","required":["id","name"],"properties":{"created_on":{"type":"string","format":"date-time","description":"Timestamp for the creation of the account","example":"2014-03-01T12:21:02.0000Z","readOnly":true},"id":{"$ref":"#/components/schemas/common_components-schemas-identifier"},"name":{"type":"string","description":"Account name","example":"Demo Account","maxLength":100},"settings":{"type":"object","description":"Account settings","properties":{"enforce_twofactor":{"type":"boolean","description":"Indicates whether membership in this account requires that\nTwo-Factor Authentication is enabled","default":false},"use_account_custom_ns_by_default":{"type":"boolean","description":"Indicates whether new zones should use the account-level custom\nnameservers by default","default":false}}}}},"account-settings-response":{"allOf":[{"$ref":"#/components/schemas/api-response-common"},{"properties":{"result":{"type":"object","properties":{"default_usage_model":{"readOnly":true},"green_compute":{"readOnly":true}}}}}]},"account_identifier":{},"account_subscription_response_collection":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"type":"object","properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/subscription"}}}}]},"account_subscription_response_single":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"type":"object","properties":{"result":{"type":"object"}}}]},"accounts_components-schemas-identifier":{"example":"699d98642c564d2e855e9661899b7252"},"acl":{"type":"object","required":["id","name","ip_range"],"properties":{"id":{"$ref":"#/components/schemas/acl_components-schemas-identifier"},"ip_range":{"$ref":"#/components/schemas/ip_range"},"name":{"$ref":"#/components/schemas/acl_components-schemas-name"}}},"acl_components-schemas-id_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/acl_components-schemas-identifier"}}}}}]},"acl_components-schemas-identifier":{"example":"23ff594956f20c2a721606e94745a8aa"},"acl_components-schemas-name":{"type":"string","description":"The name of the acl.","example":"my-acl-1"},"acl_components-schemas-response_collection":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/acl"}}}}]},"acl_components-schemas-single_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/acl"}}}]},"acns_response_collection":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"type":"object","properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/CustomNS"}}}}]},"acns_response_single":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"type":"object","properties":{"result":{"$ref":"#/components/schemas/CustomNS"}}}]},"action":{"type":"string","description":"The billing item action.","example":"subscription","readOnly":true,"maxLength":30},"action_mode":{"type":"string","description":"The default action performed by the rules in the WAF package.","enum":["simulate","block","challenge"],"default":"challenge"},"action_parameters":{"type":"object","description":"The parameters configuring the rule action.","example":{"id":"4814384a9e5d4991b9815dcfc25d2f1f"}},"action_parameters_rewrite":{"description":"The configuration parameters for the rewrite action.","properties":{"uri":{"type":"object","description":"The URI rewrite configuration to rewrite the URI path, the query string, or both.","properties":{"path":{"description":"The new URI path sent to the origin."},"query":{"description":"The new query string sent to the origin."}}}}},"action_parameters_serve_error":{"description":"The action parameters for the serve_error action.","properties":{"content":{"type":"string","description":"The new content for the response error.","example":"some html error page"},"content_type":{"type":"string","description":"The content-type of the response error.","example":"text/html"},"status_code":{"type":"number","description":"The HTTP status code of the response error.","example":530}}},"actions":{"type":"array","description":"List actions patterns.","items":{"$ref":"#/components/schemas/schemas-action"}},"activated_on":{"type":"string","format":"date-time","description":"When the Railgun was activated.","example":"2014-01-02T02:20:00Z","readOnly":true},"activation":{"type":"object","readOnly":true,"required":["key"],"properties":{"activated_on":{"$ref":"#/components/schemas/activated_on"},"key":{"$ref":"#/components/schemas/activation_key"},"version":{"type":"object","required":["number"],"properties":{"build":{"$ref":"#/components/schemas/build"},"number":{"$ref":"#/components/schemas/railgun_components-schemas-version"},"revision":{"$ref":"#/components/schemas/revision"}}}}},"activation_key":{"type":"string","example":"e4edc00281cb56ebac22c81be9bac8f3","readOnly":true,"maxLength":32},"active_device_count":{"type":"number","description":"The number of active devices registered to the user.","example":2},"activity-log-settings":{"type":"object","description":"Activity log settings.","properties":{"enabled":{"type":"boolean","description":"Enable activity logging.","example":true}}},"adaptive_routing":{"type":"object","description":"Controls features that modify the routing of requests to pools and origins in response to dynamic conditions, such as during the interval between active health monitoring requests. For example, zero-downtime failover occurs immediately when an origin becomes unavailable due to HTTP 521, 522, or 523 response codes. If there is another healthy origin in the same pool, the request is retried once against this alternate origin.","properties":{"failover_across_pools":{"type":"boolean","description":"Extends zero-downtime failover of requests to healthy origins from alternate pools, when no healthy alternate exists in the same pool, according to the failover order defined by traffic and origin steering. When set false (the default) zero-downtime failover will only occur between origins within the same pool. See `session_affinity_attributes` for control over when sessions are broken or reassigned.","default":false,"example":true}}},"additional_information":{"type":"object","description":"Additional information related to the host name.","properties":{"suspected_malware_family":{"type":"string","description":"Suspected DGA malware family.","example":""}}},"address":{"type":"string","description":"The IP address (IPv4 or IPv6) of the origin, or the publicly addressable hostname. Hostnames entered here should resolve directly to the origin, and not be a hostname proxied by Cloudflare.","example":"0.0.0.0"},"address-maps":{"type":"object","properties":{"can_delete":{"$ref":"#/components/schemas/can_delete"},"can_modify_ips":{"$ref":"#/components/schemas/can_modify_ips"},"created_at":{"$ref":"#/components/schemas/timestamp"},"default_sni":{"$ref":"#/components/schemas/default_sni"},"description":{"$ref":"#/components/schemas/address-maps_components-schemas-description"},"id":{"$ref":"#/components/schemas/common_components-schemas-identifier"},"modified_at":{"$ref":"#/components/schemas/timestamp"}}},"address-maps-ip":{"type":"object","properties":{"created_at":{"$ref":"#/components/schemas/created-on"},"ip":{"$ref":"#/components/schemas/schemas-ip"}}},"address-maps-membership":{"type":"object","properties":{"can_delete":{"$ref":"#/components/schemas/schemas-can_delete"},"created_at":{"$ref":"#/components/schemas/created-on"},"identifier":{"$ref":"#/components/schemas/common_components-schemas-identifier"},"kind":{"$ref":"#/components/schemas/components-schemas-kind"}}},"address-maps_components-schemas-description":{"type":"string","description":"An optional description field which may be used to describe the types of IPs or zones on the map.","example":"My Ecommerce zones","nullable":true},"address-maps_components-schemas-response_collection":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/address-maps"}}}}]},"address-maps_components-schemas-single_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/address-maps"}}}]},"address2":{"type":"string","description":"Optional address line for unit, floor, suite, etc.","example":"Suite 430"},"addresses":{"allOf":[{"$ref":"#/components/schemas/destination_address_properties"}],"type":"object"},"advanced_certificate_pack_response_single":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"type":"object","properties":{"result":{"type":"object","properties":{"certificate_authority":{"$ref":"#/components/schemas/certificate_authority"},"cloudflare_branding":{"$ref":"#/components/schemas/cloudflare_branding"},"hosts":{"$ref":"#/components/schemas/schemas-hosts"},"id":{"$ref":"#/components/schemas/certificate-packs_components-schemas-identifier"},"status":{"$ref":"#/components/schemas/certificate-packs_components-schemas-status"},"type":{"$ref":"#/components/schemas/advanced_type"},"validation_method":{"$ref":"#/components/schemas/validation_method"},"validity_days":{"$ref":"#/components/schemas/validity_days"}}}}}]},"advanced_ddos":{"allOf":[{"$ref":"#/components/schemas/schemas-base"},{"properties":{"id":{"description":"ID of the zone setting.","enum":["advanced_ddos"],"example":"advanced_ddos"},"value":{"$ref":"#/components/schemas/advanced_ddos_value"}}}],"title":"Advanced DDoS Protection","description":"Advanced protection from Distributed Denial of Service (DDoS) attacks on your website. This is an uneditable value that is 'on' in the case of Business and Enterprise zones."},"advanced_ddos_value":{"type":"string","description":"Value of the zone setting.\nNotes: Defaults to on for Business+ plans","enum":["on","off"],"default":"off"},"advanced_type":{"type":"string","description":"Type of certificate pack.","enum":["advanced"],"example":"advanced"},"advertised":{"type":"boolean","description":"Prefix advertisement status to the Internet. This field is only not 'null' if on demand is enabled.","example":true,"nullable":true},"advertised_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"type":"object","properties":{"advertised":{"$ref":"#/components/schemas/schemas-advertised"},"advertised_modified_at":{"$ref":"#/components/schemas/modified_at_nullable"}}}}}]},"alert-types":{"type":"object","properties":{"description":{"$ref":"#/components/schemas/alert-types_components-schemas-description"},"display_name":{"$ref":"#/components/schemas/display_name"},"filter_options":{"$ref":"#/components/schemas/schemas-filter_options"},"type":{"$ref":"#/components/schemas/alert-types_components-schemas-type"}}},"alert-types_components-schemas-description":{"type":"string","description":"Describes the alert type.","example":"High levels of 5xx HTTP errors at your origin"},"alert-types_components-schemas-response_collection":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"type":"object","example":{"Origin Monitoring":[{"description":"High levels of 5xx HTTP errors at your origin.","display_name":"Origin Error Rate Alert","filter_options":[{"ComparisonOperator":"==","Key":"zones","Optional":false},{"ComparisonOperator":">=","Key":"slo","Optional":true}],"type":"http_alert_origin_error"}]}}}}]},"alert-types_components-schemas-type":{"type":"string","description":"Use this value when creating and updating a notification policy.","example":"http_alert_origin_error"},"alert_body":{"type":"string","description":"Message body included in the notification sent.","example":"SSL certificate has expired"},"alert_type":{"type":"string","description":"Refers to which event will trigger a Notification dispatch. You can use the endpoint to get available alert types which then will give you a list of possible values.","example":"universal_ssl_event_type"},"algo":{"type":"string","description":"TSIG algorithm.","example":"hmac-sha512."},"allow_all_headers":{"type":"boolean","description":"Allows all HTTP request headers.","example":true},"allow_all_methods":{"type":"boolean","description":"Allows all HTTP request methods."},"allow_all_origins":{"type":"boolean","description":"Allows all origins."},"allow_credentials":{"type":"boolean","description":"When set to `true`, includes credentials (cookies, authorization headers, or TLS client certificates) with requests."},"allow_insecure":{"type":"boolean","description":"Do not validate the certificate when monitor use HTTPS. This parameter is currently only valid for HTTP and HTTPS monitors.","default":false,"example":true},"allow_mode_switch":{"type":"boolean","description":"Whether to allow the user to switch WARP between modes.","example":true},"allow_null_cipher":{"type":"boolean","description":"When `true`, the tunnel can use a null-cipher (`ENCR_NULL`) in the ESP tunnel (Phase 2).","example":true},"allow_updates":{"type":"boolean","description":"Whether to receive update notifications when a new version of the client is available.","example":true},"allowed":{"type":"number","description":"Cloudflare Images allowed usage.","example":100000,"readOnly":true},"allowed_headers":{"type":"array","description":"Allowed HTTP request headers.","items":{}},"allowed_idps":{"type":"array","description":"The identity providers your users can select when connecting to this application. Defaults to all IdPs configured in your account.","items":{"type":"string","description":"The identity providers selected for application.","example":"699d98642c564d2e855e9661899b7252"}},"allowed_methods":{"type":"array","description":"Allowed HTTP request methods.","example":["GET"],"items":{"type":"string","enum":["GET","POST","HEAD","PUT","DELETE","CONNECT","OPTIONS","TRACE","PATCH"]}},"allowed_modes":{"type":"array","description":"The available states for the rule group.","example":["on","off"],"readOnly":true,"items":{"$ref":"#/components/schemas/components-schemas-mode"}},"allowed_modes_allow_traditional":{"type":"array","description":"Defines the available modes for the current WAF rule.","example":["on","off"],"readOnly":true,"items":{"$ref":"#/components/schemas/mode_allow_traditional"}},"allowed_modes_anomaly":{"type":"array","description":"Defines the available modes for the current WAF rule. Applies to anomaly detection WAF rules.","example":["on","off"],"readOnly":true,"items":{"$ref":"#/components/schemas/mode_anomaly"}},"allowed_modes_deny_traditional":{"type":"array","description":"The list of possible actions of the WAF rule when it is triggered.","example":["default","disable","simulate","block","challenge"],"readOnly":true,"items":{"$ref":"#/components/schemas/mode_deny_traditional"}},"allowed_origins":{"type":"array","description":"Allowed origins.","example":["https://example.com"],"items":{}},"allowed_to_leave":{"type":"boolean","description":"Whether to allow devices to leave the organization.","example":true},"allowedOrigins":{"type":"array","description":"Lists the origins allowed to display the video. Enter allowed origin domains in an array and use `*` for wildcard subdomains. Empty arrays allow the video to be viewed on any origin.","example":["example.com"],"items":{"type":"string"}},"always_online":{"allOf":[{"$ref":"#/components/schemas/schemas-base"},{"properties":{"id":{"description":"ID of the zone setting.","enum":["always_online"],"example":"always_online"},"value":{"$ref":"#/components/schemas/always_online_value"}}}],"title":"Always Online Mode","description":"When enabled, Cloudflare serves limited copies of web pages available from the [Internet Archive's Wayback Machine](https://archive.org/web/) if your server is offline. Refer to [Always Online](https://developers.cloudflare.com/cache/about/always-online) for more information."},"always_online_value":{"type":"string","description":"Value of the zone setting.","enum":["on","off"],"default":"on"},"always_use_https":{"allOf":[{"$ref":"#/components/schemas/schemas-base"},{"properties":{"id":{"description":"ID of the zone setting.","enum":["always_use_https"],"example":"always_use_https"},"value":{"$ref":"#/components/schemas/always_use_https_value"}}}],"title":"Zone Enable Always Use HTTPS","description":"Reply to all requests for URLs that use \"http\" with a 301 redirect to the equivalent \"https\" URL. If you only want to redirect for a subset of requests, consider creating an \"Always use HTTPS\" page rule.","default":"off"},"always_use_https_value":{"type":"string","description":"Value of the zone setting.","enum":["on","off"],"default":"off"},"amount":{"type":"number","description":"The amount associated with this billing item.","example":20.99,"readOnly":true},"analytics":{"type":"object","properties":{"id":{"type":"integer","default":1},"origins":{"type":"array","example":[{"address":"198.51.100.4","changed":true,"enabled":true,"failure_reason":"No failures","healthy":true,"ip":"198.51.100.4","name":"some-origin"}],"items":{}},"pool":{"type":"object","example":{"changed":true,"healthy":true,"id":"74bc6a8b9b0dda3d651707a2928bad0c","minimum_origins":1,"name":"some-pool"}},"timestamp":{"type":"string","format":"date-time","example":"2014-01-01T05:20:00.12345Z"}}},"analytics-aggregate_components-schemas-response_collection":{"allOf":[{"$ref":"#/components/schemas/api-response-common"},{"properties":{"result":{"type":"array","items":{"type":"object"}}}}]},"analytics_components-schemas-response_collection":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/analytics"}}}}]},"anomaly_description":{"type":"string","description":"A summary of the purpose/function of the WAF package.","example":"Covers OWASP Top 10 vulnerabilities and more.","readOnly":true},"anomaly_detection_mode":{"type":"string","description":"When a WAF package uses anomaly detection, each rule is given a score when triggered. If the total score of all triggered rules exceeds the sensitivity defined on the WAF package, the action defined on the package will be taken.","example":"anomaly","readOnly":true},"anomaly_name":{"type":"string","description":"The name of the WAF package.","example":"OWASP ModSecurity Core Rule Set","readOnly":true},"anomaly_package":{"allOf":[{"$ref":"#/components/schemas/package_definition"},{"properties":{"action_mode":{"$ref":"#/components/schemas/action_mode"},"description":{"$ref":"#/components/schemas/anomaly_description"},"detection_mode":{"$ref":"#/components/schemas/anomaly_detection_mode"},"name":{"$ref":"#/components/schemas/anomaly_name"},"sensitivity":{"$ref":"#/components/schemas/sensitivity"}}}],"title":"Anomaly detection WAF package (OWASP)","required":["id","name","description","zone_id","detection_mode","sensitivity","action_mode"]},"anomaly_rule":{"allOf":[{"$ref":"#/components/schemas/rule_components-schemas-base-2"},{"properties":{"allowed_modes":{"$ref":"#/components/schemas/allowed_modes_anomaly"},"mode":{"$ref":"#/components/schemas/mode_anomaly"}}}],"title":"Anomaly detection WAF rule","description":"When triggered, anomaly detection WAF rules contribute to an overall threat score that will determine if a request is considered malicious. You can configure the total scoring threshold through the 'sensitivity' property of the WAF package.","required":["id","description","priority","allowed_modes","mode","group","package_id"]},"anti-virus-settings":{"type":"object","description":"Anti virus settings.","properties":{"enabled_download_phase":{"$ref":"#/components/schemas/enabled_download_phase"},"enabled_upload_phase":{"$ref":"#/components/schemas/enabled_upload_phase"},"fail_closed":{"$ref":"#/components/schemas/fail_closed"}}},"api-response-collection":{"anyOf":[{"$ref":"#/components/schemas/api-response-common"},{"properties":{"result":{"type":"array","nullable":true,"items":{}},"result_info":{"$ref":"#/components/schemas/result_info"}}}],"type":"object"},"api-response-common":{"type":"object","required":["success","errors","messages","result"],"properties":{"errors":{"$ref":"#/components/schemas/messages"},"messages":{"$ref":"#/components/schemas/messages"},"result":{"anyOf":[{"type":"object"},{"type":"array","items":{}},{"type":"string"}]},"success":{"type":"boolean","description":"Whether the API call was successful","enum":[true],"example":true}}},"api-response-common-failure":{"type":"object","required":["success","errors","messages","result"],"properties":{"errors":{"allOf":[{"$ref":"#/components/schemas/messages"}],"example":[{"code":7003,"message":"No route for the URI"}],"minLength":1},"messages":{"allOf":[{"$ref":"#/components/schemas/messages"}],"example":[]},"result":{"enum":[null],"nullable":true},"success":{"type":"boolean","description":"Whether the API call was successful","enum":[false],"example":false}}},"api-response-single":{"allOf":[{"$ref":"#/components/schemas/api-response-common"},{"properties":{"result":{"anyOf":[{"type":"object"},{"type":"string"}],"nullable":true}}}],"type":"object"},"api-response-single-id":{"allOf":[{"$ref":"#/components/schemas/api-response-common"},{"properties":{"result":{"type":"object","nullable":true,"required":["id"],"properties":{"id":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}}}}],"type":"object"},"api-shield":{"allOf":[{"$ref":"#/components/schemas/operation"}]},"api_access_enabled":{"type":"boolean","description":"Enterprise only. Indicates whether or not API access is enabled specifically for this user on a given account.","example":true,"nullable":true},"app-types":{"oneOf":[{"$ref":"#/components/schemas/application"},{"$ref":"#/components/schemas/application_type"}],"type":"object","readOnly":true},"app-types_components-schemas-name":{"type":"string","description":"The name of the application or application type.","example":"Facebook"},"app-types_components-schemas-response_collection":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/app-types"}}}}]},"app_components-schemas-created":{"type":"string","format":"date-time","description":"When the Application was created.","example":"2014-01-02T02:20:00Z","readOnly":true},"app_components-schemas-modified":{"type":"string","format":"date-time","description":"When the Application was last modified.","example":"2014-01-02T02:20:00Z","readOnly":true},"app_components-schemas-response_collection":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"type":"array","items":{"type":"object"}}}}]},"app_domain":{"type":"string","description":"The URL of the Access application.","example":"test.example.com/admin"},"app_id":{"type":"string","description":"Application identifier.","example":"ea95132c15732412d22c1476fa83f27a","readOnly":true,"maxLength":32},"app_launcher_props":{"allOf":[{"$ref":"#/components/schemas/feature_app_props"},{"properties":{"domain":{"example":"authdomain.cloudflareaccess.com","readOnly":true},"name":{"default":"App Launcher","example":"App Launcher","readOnly":true},"type":{"type":"string","description":"The application type.","example":"app_launcher"}}}]},"app_launcher_visible":{"type":"boolean","description":"Displays the application in the App Launcher.","default":true,"example":true},"app_type_id":{"type":"integer","description":"The identifier for the type of this application. There can be many applications with the same type. This refers to the `id` of an Application Type that has been returned."},"app_uid":{"description":"The unique identifier for the Access application.","example":"df7e2w5f-02b7-4d9d-af26-8d1988fca630"},"application":{"type":"object","properties":{"application_type_id":{"$ref":"#/components/schemas/app_type_id"},"created_at":{"$ref":"#/components/schemas/timestamp"},"id":{"$ref":"#/components/schemas/components-schemas-app_id"},"name":{"$ref":"#/components/schemas/app-types_components-schemas-name"}}},"application_type":{"type":"object","properties":{"created_at":{"$ref":"#/components/schemas/timestamp"},"description":{"type":"string","description":"A short summary of applications with this type.","example":"Applications used to communicate or collaborate in a business setting."},"id":{"$ref":"#/components/schemas/app_type_id"},"name":{"$ref":"#/components/schemas/app-types_components-schemas-name"}}},"approval_group":{"type":"object","description":"A group of email addresses that can approve a temporary authentication request.","required":["approvals_needed"],"properties":{"approvals_needed":{"type":"number","description":"The number of approvals needed to obtain access.","example":1,"minimum":0},"email_addresses":{"type":"array","description":"A list of emails that can approve the access request.","example":["test@cloudflare.com","test2@cloudflare.com"],"items":{}},"email_list_uuid":{"type":"string","description":"The UUID of an re-usable email list."}}},"approval_groups":{"type":"array","description":"Administrators who can approve a temporary authentication request.","example":[{"approvals_needed":1,"email_addresses":["test1@cloudflare.com","test2@cloudflare.com"]},{"approvals_needed":3,"email_list_uuid":"597147a1-976b-4ef2-9af0-81d5d007fc34"}],"items":{"$ref":"#/components/schemas/approval_group"}},"approval_required":{"type":"boolean","description":"Requires the user to request access from an administrator at the start of each session.","default":false,"example":true},"approved":{"type":"string","description":"Approval state of the prefix (P = pending, V = active).","example":"P"},"apps":{"anyOf":[{"allOf":[{"$ref":"#/components/schemas/basic_app_response_props"},{"$ref":"#/components/schemas/self_hosted_props"}],"type":"object","title":"Self Hosted Application"},{"allOf":[{"$ref":"#/components/schemas/basic_app_response_props"},{"$ref":"#/components/schemas/saas_props"}],"type":"object","title":"SaaS Application"},{"allOf":[{"$ref":"#/components/schemas/basic_app_response_props"},{"$ref":"#/components/schemas/ssh_props"}],"type":"object","title":"Browser SSH Application"},{"allOf":[{"$ref":"#/components/schemas/basic_app_response_props"},{"$ref":"#/components/schemas/vnc_props"}],"type":"object","title":"Browser VNC Application"},{"allOf":[{"$ref":"#/components/schemas/basic_app_response_props"},{"$ref":"#/components/schemas/app_launcher_props"}],"type":"object","title":"App Launcher Application"},{"allOf":[{"$ref":"#/components/schemas/basic_app_response_props"},{"$ref":"#/components/schemas/warp_props"}],"type":"object","title":"Device Enrollment Permissions Application"},{"allOf":[{"$ref":"#/components/schemas/basic_app_response_props"},{"$ref":"#/components/schemas/biso_props"}],"type":"object","title":"Browser Isolation Permissions Application"},{"allOf":[{"$ref":"#/components/schemas/basic_app_response_props"},{"$ref":"#/components/schemas/bookmark_props"}],"type":"object","title":"Bookmark application"}]},"apps_components-schemas-id_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/uuid"}}}}}]},"apps_components-schemas-identifier":{"example":"699d98642c564d2e855e9661899b7252"},"apps_components-schemas-name":{"type":"string","description":"The name of the application.","example":"Admin Site"},"apps_components-schemas-response_collection":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/apps"}}}}]},"apps_components-schemas-response_collection-2":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/schemas-apps"}}}}]},"apps_components-schemas-single_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/apps"}}}]},"apps_components-schemas-single_response-2":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/schemas-apps"}}}]},"apps_components-schemas-type":{"type":"string","description":"The application type.","enum":["self_hosted","saas","ssh","vnc","app_launcher","warp","biso","bookmark","dash_sso"],"example":"self_hosted"},"arch":{"type":"string","description":"The cloudflared OS architecture used to establish this connection.","example":"linux_amd64"},"argo-tunnel":{"type":"object","required":["id","name","created_at","connections"],"properties":{"connections":{"type":"array","description":"The tunnel connections between your origin and Cloudflare's edge.","items":{"$ref":"#/components/schemas/argo-tunnel_components-schemas-connection"}},"created_at":{"$ref":"#/components/schemas/cloudflare-tunnel_components-schemas-created_at"},"deleted_at":{"$ref":"#/components/schemas/schemas-deleted_at"},"id":{"$ref":"#/components/schemas/tunnel_id"},"name":{"$ref":"#/components/schemas/tunnel_name"}}},"argo-tunnel_components-schemas-connection":{"properties":{"colo_name":{"$ref":"#/components/schemas/schemas-colo_name"},"is_pending_reconnect":{"$ref":"#/components/schemas/is_pending_reconnect"},"uuid":{"$ref":"#/components/schemas/connection_id"}}},"argo-tunnel_components-schemas-empty_response":{"allOf":[{"$ref":"#/components/schemas/api-response-common"},{"type":"object","properties":{"result":{"type":"object"}}}]},"argo_smart_routing":{"type":"boolean","description":"Enables Argo Smart Routing for this application.\nNotes: Only available for TCP applications with traffic_type set to \"direct\".","default":false,"example":true},"asn":{"type":"integer","description":"Autonomous System Number (ASN) the prefix will be advertised under.","nullable":true},"asn_components-schemas-asn":{"properties":{"asn":{"$ref":"#/components/schemas/components-schemas-asn"},"country":{"$ref":"#/components/schemas/asn_country"},"description":{"$ref":"#/components/schemas/asn_description"},"domain_count":{"type":"integer"},"top_domains":{"type":"array","example":["example.com"],"items":{"type":"string"}},"type":{"$ref":"#/components/schemas/asn_type"}}},"asn_components-schemas-response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/asn_components-schemas-asn"}}}]},"asn_configuration":{"title":"An ASN configuration.","properties":{"target":{"description":"The configuration target. You must set the target to `asn` when specifying an Autonomous System Number (ASN) in the rule.","enum":["asn"],"example":"asn"},"value":{"type":"string","description":"The AS number to match.","example":"AS12345"}}},"asn_country":{"type":"string","example":"US"},"asn_description":{"type":"string","example":"CLOUDFLARENET"},"asn_type":{"type":"string","description":"Infrastructure type of this ASN.","enum":["hosting_provider","isp","organization"],"example":"hosting_provider"},"associated_hostnames":{"type":"array","description":"The hostnames of the applications that will use this certificate.","items":{"type":"string","description":"A fully-qualified domain name (FQDN).","example":"admin.example.com"}},"attack_mitigation":{"type":"object","description":"Attack mitigation settings.","nullable":true,"properties":{"enabled":{"type":"boolean","description":"When enabled, random-prefix attacks are automatically mitigated and the origin DNS servers protected.","example":true},"only_when_origin_unhealthy":{"type":"boolean","description":"Only mitigate attacks when origin servers seem unhealthy.","default":true,"example":false}}},"aud":{"type":"string","description":"The Application Audience (AUD) tag. Identifies the application associated with the CA.","example":"737646a56ab1df6ec9bddc7e5ca84eaf3b0768850f3ffb5d74f1534911fe3893","readOnly":true,"maxLength":64},"audit-logs":{"type":"object","properties":{"action":{"type":"object","properties":{"result":{"type":"boolean","description":"A boolean that indicates if the action attempted was successful.","example":true},"type":{"type":"string","description":"A short string that describes the action that was performed.","example":"change_setting"}}},"actor":{"type":"object","properties":{"email":{"type":"string","format":"email","description":"The email of the user that performed the action.","example":"michelle@example.com"},"id":{"type":"string","description":"The ID of the actor that performed the action. If a user performed the action, this will be their User ID.","example":"f6b5de0326bb5182b8a4840ee01ec774"},"ip":{"type":"string","description":"The IP address of the request that performed the action.","example":"198.41.129.166"},"type":{"type":"string","description":"The type of actor, whether a User, Cloudflare Admin, or an Automated System.","enum":["user","admin","Cloudflare"],"example":"user"}}},"id":{"type":"string","description":"A string that uniquely identifies the audit log.","example":"d5b0f326-1232-4452-8858-1089bd7168ef"},"interface":{"type":"string","description":"The source of the event.","example":"API"},"metadata":{"type":"object","description":"An object which can lend more context to the action being logged. This is a flexible value and varies between different actions.","example":{"name":"security_level","type":"firewall","value":"high","zone_name":"example.com"}},"newValue":{"type":"string","description":"The new value of the resource that was modified.","example":"low"},"oldValue":{"type":"string","description":"The value of the resource before it was modified.","example":"high"},"owner":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}},"resource":{"type":"object","properties":{"id":{"type":"string","description":"An identifier for the resource that was affected by the action.","example":"023e105f4ecef8ad9ca31a8372d0c353"},"type":{"type":"string","description":"A short string that describes the resource that was affected by the action.","example":"zone"}}},"when":{"type":"string","format":"date-time","description":"A UTC RFC3339 timestamp that specifies when the action being logged occured.","example":"2017-04-26T17:31:07Z"}}},"audit_logs_response_collection":{"oneOf":[{"properties":{"errors":{"nullable":true},"messages":{"type":"array","example":[],"items":{}},"result":{"type":"array","items":{"$ref":"#/components/schemas/audit-logs"}},"success":{"type":"boolean","example":true}}},{"$ref":"#/components/schemas/api-response-common"}]},"auth_domain":{"type":"string","description":"The unique subdomain assigned to your Zero Trust organization.","example":"test.cloudflareaccess.com"},"auth_id_tokens":{"type":"integer","description":"The total number of auth-ids seen across this calculation.","readOnly":true},"auto_connect":{"type":"number","description":"The amount of time in minutes to reconnect after having been disabled.","example":0},"auto_redirect_to_identity":{"type":"boolean","description":"When set to `true`, users skip the identity provider selection step during login. You must specify only one identity provider in allowed_idps.","default":false},"auto_refresh_seconds":{"type":"number","description":"How often should a secondary zone auto refresh regardless of DNS NOTIFY.\nNot applicable for primary zones.","example":86400},"auto_renew":{"type":"boolean","description":"Auto-renew controls whether subscription is automatically renewed upon domain expiration.","example":true},"automatic_https_rewrites":{"allOf":[{"$ref":"#/components/schemas/schemas-base"},{"properties":{"id":{"description":"ID of the zone setting.","enum":["automatic_https_rewrites"],"example":"automatic_https_rewrites"},"value":{"$ref":"#/components/schemas/automatic_https_rewrites_value"}}}],"title":"Zone Enable Automatic HTTPS Rewrites","description":"Enable the Automatic HTTPS Rewrites feature for this zone.","default":"off"},"automatic_https_rewrites_value":{"type":"string","description":"Value of the zone setting.\nNotes: Default value depends on the zone's plan level.","enum":["on","off"],"default":"on"},"automatic_platform_optimization":{"type":"object","required":["enabled","cf","wordpress","wp_plugin","hostnames","cache_by_device_type"],"properties":{"cache_by_device_type":{"type":"boolean","description":"Indicates whether or not [cache by device type](https://developers.cloudflare.com/automatic-platform-optimization/reference/cache-device-type/) is enabled.","example":false},"cf":{"type":"boolean","description":"Indicates whether or not Cloudflare proxy is enabled.","default":false,"example":true},"enabled":{"type":"boolean","description":"Indicates whether or not Automatic Platform Optimization is enabled.","default":false,"example":true},"hostnames":{"type":"array","description":"An array of hostnames where Automatic Platform Optimization for WordPress is activated.","example":["www.example.com","example.com","shop.example.com"],"items":{"type":"string","format":"hostname"}},"wordpress":{"type":"boolean","description":"Indicates whether or not site is powered by WordPress.","default":false,"example":true},"wp_plugin":{"type":"boolean","description":"Indicates whether or not [Cloudflare for WordPress plugin](https://wordpress.org/plugins/cloudflare/) is installed.","default":false,"example":true}}},"availability_response":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"type":"object","properties":{"result":{"type":"array","items":{"type":"string","format":"hostname","description":"Name of zone based on which account custom nameservers can be created. For example, if example.com is returned, then ns1.example.com can be used as an account custom nameserver.","example":"example.com","readOnly":true}}}}]},"available":{"type":"boolean","description":"When true, the Managed Transform is available in the current Cloudflare plan.","example":true},"available-rate-plan":{"type":"object","properties":{"can_subscribe":{"$ref":"#/components/schemas/can_subscribe"},"currency":{"$ref":"#/components/schemas/currency"},"externally_managed":{"$ref":"#/components/schemas/externally_managed"},"frequency":{"$ref":"#/components/schemas/schemas-frequency"},"id":{"$ref":"#/components/schemas/common_components-schemas-identifier"},"is_subscribed":{"$ref":"#/components/schemas/is_subscribed"},"legacy_discount":{"$ref":"#/components/schemas/legacy_discount"},"legacy_id":{"$ref":"#/components/schemas/legacy_id"},"name":{"$ref":"#/components/schemas/rate-plan_components-schemas-name"},"price":{"$ref":"#/components/schemas/schemas-price"}}},"azure_group_rule":{"type":"object","title":"Azure group","description":"Matches an Azure group.\nRequires an Azure identity provider.","required":["azureAD"],"properties":{"azureAD":{"type":"object","required":["id","connection_id"],"properties":{"connection_id":{"type":"string","description":"The ID of your Azure identity provider.","example":"ea85612a-29c8-46c2-bacb-669d65136971"},"id":{"type":"string","description":"The ID of an Azure group.","example":"aa0a4aab-672b-4bdb-bc33-a59f1130a11f"}}}}},"bandwidth":{"type":"object","description":"Breakdown of totals for bandwidth in the form of bytes.","properties":{"all":{"type":"integer","description":"The total number of bytes served within the time frame."},"cached":{"type":"integer","description":"The number of bytes that were cached (and served) by Cloudflare."},"content_type":{"type":"object","description":"A variable list of key/value pairs where the key represents the type of content served, and the value is the number in bytes served.","example":{"css":237421,"gif":1234242.0,"html":1231290.0,"javascript":123245,"jpeg":784278}},"country":{"type":"object","description":"A variable list of key/value pairs where the key is a two-digit country code and the value is the number of bytes served to that country.","example":{"AG":2342483.0,"GI":984753,"US":123145433.0}},"ssl":{"type":"object","description":"A break down of bytes served over HTTPS.","properties":{"encrypted":{"type":"integer","description":"The number of bytes served over HTTPS."},"unencrypted":{"type":"integer","description":"The number of bytes served over HTTP."}}},"ssl_protocols":{"type":"object","description":"A breakdown of requests by their SSL protocol.","properties":{"TLSv1":{"type":"integer","description":"The number of requests served over TLS v1.0."},"TLSv1.1":{"type":"integer","description":"The number of requests served over TLS v1.1."},"TLSv1.2":{"type":"integer","description":"The number of requests served over TLS v1.2."},"TLSv1.3":{"type":"integer","description":"The number of requests served over TLS v1.3."},"none":{"type":"integer","description":"The number of requests served over HTTP."}}},"uncached":{"type":"integer","description":"The number of bytes that were fetched and served from the origin server."}}},"bandwidth_by_colo":{"type":"object","description":"Breakdown of totals for bandwidth in the form of bytes.","properties":{"all":{"type":"integer","description":"The total number of bytes served within the time frame."},"cached":{"type":"integer","description":"The number of bytes that were cached (and served) by Cloudflare."},"uncached":{"type":"integer","description":"The number of bytes that were fetched and served from the origin server."}}},"base":{"type":"object","required":["invited_member_id","organization_id"],"properties":{"expires_on":{"$ref":"#/components/schemas/schemas-expires_on"},"id":{"$ref":"#/components/schemas/invite_components-schemas-identifier"},"invited_by":{"$ref":"#/components/schemas/invited_by"},"invited_member_email":{"$ref":"#/components/schemas/invited_member_email"},"invited_member_id":{"type":"string","description":"ID of the user to add to the organization.","example":"5a7805061c76ada191ed06f989cc3dac","nullable":true,"readOnly":true,"maxLength":32},"invited_on":{"$ref":"#/components/schemas/invited_on"},"organization_id":{"type":"string","description":"ID of the organization the user will be added to.","example":"5a7805061c76ada191ed06f989cc3dac","readOnly":true,"maxLength":32},"organization_name":{"type":"string","description":"Organization name.","example":"Cloudflare, Inc.","readOnly":true,"maxLength":100},"roles":{"type":"array","description":"Roles to be assigned to this user.","items":{"$ref":"#/components/schemas/schemas-role"}}}},"basic_app_response_props":{"type":"object","properties":{"aud":{"$ref":"#/components/schemas/schemas-aud"},"created_at":{"$ref":"#/components/schemas/timestamp"},"id":{"$ref":"#/components/schemas/uuid"},"updated_at":{"$ref":"#/components/schemas/timestamp"}}},"batch_size":{"type":"number","example":10},"beta":{"type":"boolean","description":"Whether the category is in beta and subject to change.","example":false},"billing-history":{"type":"object","required":["id","type","action","description","occurred_at","amount","currency","zone"],"properties":{"action":{"$ref":"#/components/schemas/action"},"amount":{"$ref":"#/components/schemas/amount"},"currency":{"$ref":"#/components/schemas/currency"},"description":{"$ref":"#/components/schemas/schemas-description"},"id":{"$ref":"#/components/schemas/billing-history_components-schemas-identifier"},"occurred_at":{"$ref":"#/components/schemas/occurred_at"},"type":{"$ref":"#/components/schemas/type"},"zone":{"$ref":"#/components/schemas/schemas-zone"}}},"billing-history_components-schemas-identifier":{"type":"string","description":"Billing item identifier tag.","example":"b69a9f3492637782896352daae219e7d","readOnly":true,"maxLength":32},"billing_history_collection":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/billing-history"}}}}]},"billing_response_single":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"type":"object","properties":{"result":{"type":"object"}}}]},"binding":{"oneOf":[{"$ref":"#/components/schemas/kv_namespace_binding"},{"$ref":"#/components/schemas/wasm_module_binding"}]},"binding_name":{"type":"string","description":"A JavaScript variable name for the binding.","example":"myBinding","readOnly":true},"biso_props":{"allOf":[{"$ref":"#/components/schemas/feature_app_props"},{"properties":{"domain":{"example":"authdomain.cloudflareaccess.com/browser","readOnly":true},"name":{"default":"Clientless Web Isolation","example":"Clientless Web Isolation","readOnly":true},"type":{"type":"string","description":"The application type.","example":"biso"}}}]},"block-page-settings":{"type":"object","description":"Block page layout settings.","properties":{"background_color":{"type":"string","description":"Block page background color in #rrggbb format."},"enabled":{"type":"boolean","description":"Enable only cipher suites and TLS versions compliant with FIPS 140-2.","example":true},"footer_text":{"type":"string","description":"Block page footer text.","example":"--footer--"},"header_text":{"type":"string","description":"Block page header text.","example":"--header--"},"logo_path":{"type":"string","description":"Full URL to the logo file.","example":"https://logos.com/a.png"},"mailto_address":{"type":"string","description":"Admin email for users to contact.","example":"admin@example.com"},"mailto_subject":{"type":"string","description":"Subject line for emails created from block page.","example":"Blocked User Inquiry"},"name":{"type":"string","description":"Block page title.","example":"Cloudflare"},"suppress_footer":{"type":"boolean","description":"Suppress detailed info at the bottom of the block page.","example":false}}},"body":{"type":"string","description":"The response body to return. The value must conform to the configured content type.","example":"<error>This request has been rate-limited.</error>","maxLength":10240},"bookmark_props":{"type":"object","title":"Bookmark application","properties":{"app_launcher_visible":{"default":true},"domain":{"description":"The URL or domain of the bookmark.","example":"https://mybookmark.com"},"logo_url":{"$ref":"#/components/schemas/logo_url"},"name":{"$ref":"#/components/schemas/apps_components-schemas-name"},"type":{"type":"string","description":"The application type.","example":"bookmark"}}},"bookmarks":{"type":"object","properties":{"app_launcher_visible":{"$ref":"#/components/schemas/schemas-app_launcher_visible"},"created_at":{"$ref":"#/components/schemas/timestamp"},"domain":{"$ref":"#/components/schemas/components-schemas-domain"},"id":{"description":"The unique identifier for the Bookmark application."},"logo_url":{"$ref":"#/components/schemas/logo_url"},"name":{"$ref":"#/components/schemas/bookmarks_components-schemas-name"},"updated_at":{"$ref":"#/components/schemas/timestamp"}}},"bookmarks_components-schemas-id_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/uuid"}}}}}]},"bookmarks_components-schemas-identifier":{"example":"699d98642c564d2e855e9661899b7252"},"bookmarks_components-schemas-name":{"type":"string","description":"The name of the Bookmark application.","example":"My Website"},"bookmarks_components-schemas-response_collection":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/bookmarks"}}}}]},"bookmarks_components-schemas-single_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/bookmarks"}}}]},"brand_check":{"type":"boolean","description":"Certificate Authority is manually reviewing the order.","example":false},"brotli":{"allOf":[{"$ref":"#/components/schemas/schemas-base"},{"properties":{"id":{"description":"ID of the zone setting.","enum":["brotli"],"example":"brotli"},"value":{"$ref":"#/components/schemas/brotli_value"}}}],"title":"Brotli Compression","description":"When the client requesting an asset supports the Brotli compression algorithm, Cloudflare will serve a Brotli compressed version of the asset."},"brotli_value":{"type":"string","description":"Value of the zone setting.","enum":["off","on"],"default":"off"},"browser-isolation-settings":{"type":"object","description":"Browser isolation settings.","properties":{"url_browser_isolation_enabled":{"type":"boolean","description":"Enable Browser Isolation.","example":true}}},"browser_cache_ttl":{"allOf":[{"$ref":"#/components/schemas/schemas-base"},{"properties":{"id":{"description":"ID of the zone setting.","enum":["browser_cache_ttl"],"example":"browser_cache_ttl"},"value":{"$ref":"#/components/schemas/browser_cache_ttl_value"}}}],"title":"Browser Cache TTL","description":"Browser Cache TTL (in seconds) specifies how long Cloudflare-cached resources will remain on your visitors' computers. Cloudflare will honor any larger times specified by your server. (https://support.cloudflare.com/hc/en-us/articles/200168276)."},"browser_cache_ttl_value":{"type":"number","description":"Value of the zone setting.\nNotes: Setting a TTL of 0 is equivalent to selecting `Respect Existing Headers`","enum":[0,30,60,120,300,1200,1800,3600,7200,10800,14400,18000,28800,43200,57600,72000,86400,172800,259200,345600,432000,691200,1382400.0,2073600.0,2678400.0,5356800.0,16070400.0,31536000.0],"default":14400},"browser_check":{"allOf":[{"$ref":"#/components/schemas/schemas-base"},{"properties":{"id":{"description":"ID of the zone setting.","enum":["browser_check"],"example":"browser_check"},"value":{"$ref":"#/components/schemas/browser_check_value"}}}],"title":"Browser Check","description":"Browser Integrity Check is similar to Bad Behavior and looks for common HTTP headers abused most commonly by spammers and denies access to your page. It will also challenge visitors that do not have a user agent or a non standard user agent (also commonly used by abuse bots, crawlers or visitors). (https://support.cloudflare.com/hc/en-us/articles/200170086)."},"browser_check_value":{"type":"string","description":"Value of the zone setting.","enum":["on","off"],"default":"on"},"bucket_name":{"type":"string","description":"Name of the bucket. The name must be greater than 2 and less than 64 characters.","example":"example-bucket","pattern":"^[a-z0-9][a-z0-9-]*[a-z0-9]"},"build":{"type":"string","description":"The build identifier for the Railgun receiver.","example":"b1234","readOnly":true},"build_config":{"type":"object","description":"Configs for the project build process.","properties":{"build_command":{"type":"string","description":"Command used to build project.","example":"npm run build","nullable":true},"destination_dir":{"type":"string","description":"Output directory of the build.","example":"build","nullable":true},"root_dir":{"type":"string","description":"Directory to run the command.","example":"/","nullable":true},"web_analytics_tag":{"type":"string","description":"The classifying tag for analytics.","example":"cee1c73f6e4743d0b5e6bb1a0bcaabcc","nullable":true},"web_analytics_token":{"type":"string","description":"The auth token for analytics.","example":"021e1057c18547eca7b79f2516f06o7x","nullable":true}}},"bulk-operation-response-collection":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"type":"object","properties":{"result":{"$ref":"#/components/schemas/schemas-operation"}}}]},"bulk_delete":{"type":"array","items":{"$ref":"#/components/schemas/key_name_bulk"}},"bulk_write":{"type":"array","items":{"type":"object","properties":{"base64":{"type":"boolean","description":"Whether or not the server should base64 decode the value before storing it. Useful for writing values that wouldn't otherwise be valid JSON strings, such as images.","default":false},"expiration":{"$ref":"#/components/schemas/expiration"},"expiration_ttl":{"$ref":"#/components/schemas/expiration_ttl"},"key":{"$ref":"#/components/schemas/key_name_bulk"},"metadata":{"$ref":"#/components/schemas/list_metadata"},"value":{"type":"string","description":"A UTF-8 encoded string to be stored, up to 10 MB in length.","example":"Some string","maxLength":10485760}}},"required":["key","value"]},"bundle_method":{"type":"string","description":"A ubiquitous bundle has the highest probability of being verified everywhere, even by clients using outdated or unusual trust stores. An optimal bundle uses the shortest chain and newest intermediates. And the force bundle verifies the chain, but does not otherwise modify it.","enum":["ubiquitous","optimal","force"],"default":"ubiquitous","example":"ubiquitous"},"bypass":{"type":"array","description":"Criteria specifying when the current rate limit should be bypassed. You can specify that the rate limit should not apply to one or more URLs.","items":{"type":"object","properties":{"name":{"type":"string","enum":["url"],"example":"url"},"value":{"type":"string","description":"The URL to bypass.","example":"api.example.com/*"}}}},"ca":{"type":"object","properties":{"aud":{"$ref":"#/components/schemas/aud"},"id":{"$ref":"#/components/schemas/ca_components-schemas-id"},"public_key":{"$ref":"#/components/schemas/public_key"}}},"ca_components-schemas-id":{"type":"string","description":"The ID of the CA.","example":"7eddae4619b50ab1361ba8ae9bd72269a432fea041529ed9","readOnly":true,"maxLength":48},"ca_components-schemas-id_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/ca_components-schemas-id"}}}}}]},"ca_components-schemas-response_collection":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/ca"}}}}]},"ca_components-schemas-single_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"type":"object"}}}]},"cache_level":{"allOf":[{"$ref":"#/components/schemas/schemas-base"},{"properties":{"id":{"description":"ID of the zone setting.","enum":["cache_level"],"example":"cache_level"},"value":{"$ref":"#/components/schemas/cache_level_value"}}}],"title":"Cloudflare Cache Level","description":"Cache Level functions based off the setting level. The basic setting will cache most static resources (i.e., css, images, and JavaScript). The simplified setting will ignore the query string when delivering a cached resource. The aggressive setting will cache all static resources, including ones with a query string. (https://support.cloudflare.com/hc/en-us/articles/200168256)."},"cache_level_value":{"type":"string","description":"Value of the zone setting.","enum":["aggressive","basic","simplified"],"default":"aggressive"},"cache_reserve":{"allOf":[{"$ref":"#/components/schemas/components-schemas-base"},{"properties":{"id":{"description":"ID of the zone setting.","enum":["cache_reserve"],"example":"cache_reserve"}}}],"title":"Cache Reserve","description":"Increase cache lifetimes by automatically storing all cacheable files into Cloudflare's persistent object storage buckets. Requires Cache Reserve subscription. Note: using Tiered Cache with Cache Reserve is highly recommended to reduce Reserve operations costs. See the [developer docs](https://developers.cloudflare.com/cache/about/cache-reserve) for more information."},"cache_reserve_response_value":{"properties":{"result":{"allOf":[{"$ref":"#/components/schemas/cache_reserve"},{"required":["value"],"properties":{"value":{"$ref":"#/components/schemas/cache_reserve_value"}}}]}}},"cache_reserve_value":{"type":"string","description":"Value of the Cache Reserve zone setting.","enum":["on","off"],"default":"off"},"can_delete":{"type":"boolean","description":"If set to false, then the Address Map cannot be deleted via API. This is true for Cloudflare-managed maps.","example":true,"readOnly":true},"can_modify_ips":{"type":"boolean","description":"If set to false, then the IPs on the Address Map cannot be modified via the API. This is true for Cloudflare-managed maps.","example":true,"readOnly":true},"can_register":{"type":"boolean","description":"Indicates if the domain can be registered as a new domain.","example":false},"can_subscribe":{"type":"boolean","description":"Indicates whether you can subscribe to this plan.","default":false,"example":true},"caption_basic_upload":{"type":"object","required":["file"],"properties":{"file":{"type":"string","description":"The WebVTT file containing the caption or subtitle content.","example":"@/Users/kyle/Desktop/tr.vtt"}}},"captions":{"type":"object","properties":{"label":{"$ref":"#/components/schemas/label"},"language":{"$ref":"#/components/schemas/language"}}},"captive_portal":{"type":"number","description":"Turn on the captive portal after the specified amount of time.","example":180},"catch_all_rule_response_single":{"type":"object","properties":{"actions":{"$ref":"#/components/schemas/catchall-actions"},"enabled":{"$ref":"#/components/schemas/rules_components-schemas-enabled"},"matchers":{"$ref":"#/components/schemas/catchall-matchers"},"name":{"$ref":"#/components/schemas/rules_components-schemas-name"},"tag":{"$ref":"#/components/schemas/rule_identifier"}}},"catchall-action":{"type":"object","description":"Action for the catch-all routing rule.","required":["type"],"properties":{"type":{"type":"string","description":"Type of action for catch-all rule.","enum":["drop","forward","worker"],"example":"forward"},"value":{"type":"array","items":{"type":"string","description":"Input value for action.","example":"destinationaddress@example.net","maxLength":90}}}},"catchall-actions":{"type":"array","description":"List actions for the catch-all routing rule.","items":{"$ref":"#/components/schemas/catchall-action"}},"catchall-matcher":{"type":"object","description":"Matcher for catch-all routing rule.","required":["type"],"properties":{"type":{"type":"string","description":"Type of matcher. Default is 'all'.","enum":["all"],"example":"all"}}},"catchall-matchers":{"type":"array","description":"List of matchers for the catch-all routing rule.","items":{"$ref":"#/components/schemas/catchall-matcher"}},"categories":{"type":"array","description":"The categories of the rule.","example":["directory-traversal","header"],"items":{"$ref":"#/components/schemas/category"}},"categories_components-schemas-description":{"type":"string","description":"A short summary of domains in the category.","example":"Sites related to educational content that are not included in other categories like Science, Technology or Educational institutions."},"categories_components-schemas-id":{"type":"integer","description":"The identifier for this category. There is only one category per id."},"categories_components-schemas-name":{"type":"string","description":"The name of the category.","example":"Education"},"categories_components-schemas-response_collection":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/schemas-categories"}}}}]},"category":{"type":"string","description":"A category of the rule.","example":"directory-traversal"},"cert_pack_uuid":{"type":"string","description":"Certificate Pack UUID.","example":"a77f8bd7-3b47-46b4-a6f1-75cf98109948"},"certificate":{"type":"string","description":"The zone's SSL certificate or certificate and the intermediate(s).","example":"-----BEGIN CERTIFICATE-----\nMIIDtTCCAp2gAwIBAgIJAMHAwfXZ5/PWMA0GCSqGSIb3DQEBCwUAMEUxCzAJBgNV\nBAYTAkFVMRMwEQYDVQQIEwpTb21lLVN0YXRlMSEwHwYDVQQKExhJbnRlcm5ldCBX\naWRnaXRzIFB0eSBMdGQwHhcNMTYwODI0MTY0MzAxWhcNMTYxMTIyMTY0MzAxWjBF\nMQswCQYDVQQGEwJBVTETMBEGA1UECBMKU29tZS1TdGF0ZTEhMB8GA1UEChMYSW50\nZXJuZXQgV2lkZ2l0cyBQdHkgTHRkMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIB\nCgKCAQEAwQHoetcl9+5ikGzV6cMzWtWPJHqXT3wpbEkRU9Yz7lgvddmGdtcGbg/1\nCGZu0jJGkMoppoUo4c3dts3iwqRYmBikUP77wwY2QGmDZw2FvkJCJlKnabIRuGvB\nKwzESIXgKk2016aTP6/dAjEHyo6SeoK8lkIySUvK0fyOVlsiEsCmOpidtnKX/a+5\n0GjB79CJH4ER2lLVZnhePFR/zUOyPxZQQ4naHf7yu/b5jhO0f8fwt+pyFxIXjbEI\ndZliWRkRMtzrHOJIhrmJ2A1J7iOrirbbwillwjjNVUWPf3IJ3M12S9pEewooaeO2\nizNTERcG9HzAacbVRn2Y2SWIyT/18QIDAQABo4GnMIGkMB0GA1UdDgQWBBT/LbE4\n9rWf288N6sJA5BRb6FJIGDB1BgNVHSMEbjBsgBT/LbE49rWf288N6sJA5BRb6FJI\nGKFJpEcwRTELMAkGA1UEBhMCQVUxEzARBgNVBAgTClNvbWUtU3RhdGUxITAfBgNV\nBAoTGEludGVybmV0IFdpZGdpdHMgUHR5IEx0ZIIJAMHAwfXZ5/PWMAwGA1UdEwQF\nMAMBAf8wDQYJKoZIhvcNAQELBQADggEBAHHFwl0tH0quUYZYO0dZYt4R7SJ0pCm2\n2satiyzHl4OnXcHDpekAo7/a09c6Lz6AU83cKy/+x3/djYHXWba7HpEu0dR3ugQP\nMlr4zrhd9xKZ0KZKiYmtJH+ak4OM4L3FbT0owUZPyjLSlhMtJVcoRp5CJsjAMBUG\nSvD8RX+T01wzox/Qb+lnnNnOlaWpqu8eoOenybxKp1a9ULzIVvN/LAcc+14vioFq\n2swRWtmocBAs8QR9n4uvbpiYvS8eYueDCWMM4fvFfBhaDZ3N9IbtySh3SpFdQDhw\nYbjM2rxXiyLGxB4Bol7QTv4zHif7Zt89FReT/NBy4rzaskDJY5L6xmY=\n-----END CERTIFICATE-----\n"},"certificate-packs_components-schemas-identifier":{"type":"string","description":"The unique identifier for a certificate_pack.","example":"3822ff90-ea29-44df-9e55-21300bb9419b","readOnly":true},"certificate-packs_components-schemas-status":{"type":"string","description":"Status of certificate pack.","enum":["initializing","pending_validation","deleted","pending_issuance","pending_deployment","pending_deletion","pending_expiration","expired","active","initializing_timed_out","validation_timed_out","issuance_timed_out","deployment_timed_out","deletion_timed_out","pending_cleanup","staging_deployment","staging_active","deactivating","inactive","backup_issued","holding_deployment"],"example":"initializing"},"certificate_analyze_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"type":"object"}}}]},"certificate_authority":{"type":"string","description":"Certificate Authority selected for the order. Selecting Let's Encrypt will reduce customization of other fields: validation_method must be 'txt', validity_days must be 90, cloudflare_branding must be omitted, and hosts must contain only 2 entries, one for the zone name and one for the subdomain wildcard of the zone name (e.g. example.com, *.example.com).","enum":["digicert","google","lets_encrypt"],"example":"digicert"},"certificate_pack_quota_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"type":"object","properties":{"result":{"type":"object","properties":{"advanced":{"$ref":"#/components/schemas/quota"}}}}}]},"certificate_pack_response_collection":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"type":"array","items":{"type":"object"}}}}]},"certificate_pack_response_single":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"type":"object","properties":{"result":{"type":"object"}}}]},"certificate_response_collection":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/custom-certificate"}}}}]},"certificate_response_id_only":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/custom-certificate_components-schemas-identifier"}}}}}]},"certificate_response_single":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"type":"object"}}}]},"certificate_response_single_id":{"allOf":[{"$ref":"#/components/schemas/schemas-certificate_response_single"},{"properties":{"result":{"properties":{"id":{"$ref":"#/components/schemas/certificates_components-schemas-identifier"}}}}}]},"certificate_rule":{"type":"object","title":"Valid certificate","description":"Matches any valid client certificate.","example":{"certificate":{}},"required":["certificate"],"properties":{"certificate":{"type":"object","example":{}}}},"certificate_status":{"type":"string","description":"Current status of certificate.","enum":["initializing","authorizing","active","expired","issuing","timing_out","pending_deployment"],"example":"active"},"certificateObject":{"properties":{"certificate":{"$ref":"#/components/schemas/zone-authenticated-origin-pull_components-schemas-certificate"},"expires_on":{"$ref":"#/components/schemas/zone-authenticated-origin-pull_components-schemas-expires_on"},"id":{"$ref":"#/components/schemas/zone-authenticated-origin-pull_components-schemas-identifier"},"issuer":{"$ref":"#/components/schemas/issuer"},"signature":{"$ref":"#/components/schemas/signature"},"status":{"$ref":"#/components/schemas/zone-authenticated-origin-pull_components-schemas-status"},"uploaded_on":{"$ref":"#/components/schemas/schemas-uploaded_on"}}},"certificates":{"type":"object","required":["hostnames","csr","requested_validity","request_type"],"properties":{"certificate":{"$ref":"#/components/schemas/components-schemas-certificate"},"csr":{"$ref":"#/components/schemas/csr"},"expires_on":{"$ref":"#/components/schemas/certificates_components-schemas-expires_on"},"hostnames":{"$ref":"#/components/schemas/hostnames"},"id":{"$ref":"#/components/schemas/certificates_components-schemas-identifier"},"request_type":{"$ref":"#/components/schemas/request_type"},"requested_validity":{"$ref":"#/components/schemas/requested_validity"}}},"certificates_components-schemas-expires_on":{"type":"string","format":"date-time","description":"When the certificate will expire.","example":"2014-01-01T05:20:00.12345Z","readOnly":true},"certificates_components-schemas-id_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/uuid"}}}}}]},"certificates_components-schemas-identifier":{"type":"string","description":"The x509 serial number of the Origin CA certificate.","example":"328578533902268680212849205732770752308931942346","readOnly":true},"certificates_components-schemas-name":{"type":"string","description":"The name of the certificate.","example":"Allow devs"},"certificates_components-schemas-response_collection":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/schemas-certificates"}}}}]},"certificates_components-schemas-single_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/schemas-certificates"}}}]},"cf_account_id":{"type":"string","description":"Cloudflare account ID","example":"699d98642c564d2e855e9661899b7252","maxLength":32},"challenge_ttl":{"allOf":[{"$ref":"#/components/schemas/schemas-base"},{"properties":{"id":{"description":"ID of the zone setting.","enum":["challenge_ttl"],"example":"challenge_ttl"},"value":{"$ref":"#/components/schemas/challenge_ttl_value"}}}],"title":"Challenge Page TTL","description":"Specify how long a visitor is allowed access to your site after successfully completing a challenge (such as a CAPTCHA). After the TTL has expired the visitor will have to complete a new challenge. We recommend a 15 - 45 minute setting and will attempt to honor any setting above 45 minutes. (https://support.cloudflare.com/hc/en-us/articles/200170136)."},"challenge_ttl_value":{"type":"number","description":"Value of the zone setting.","enum":[300,900,1800,2700,3600,7200,10800,14400,28800,57600,86400,604800,2592000.0,31536000.0],"default":1800},"characteristics":{"type":"array","uniqueItems":true,"maxItems":10,"items":{"type":"object","required":["type","name"],"properties":{"name":{"$ref":"#/components/schemas/characteristics_components-schemas-name"},"type":{"$ref":"#/components/schemas/schemas-type"}}}},"characteristics_components-schemas-name":{"type":"string","description":"The name of the characteristic field, i.e., the header or cookie name.","example":"authorization","maxLength":128},"check_regions":{"type":"array","description":"A list of regions from which to run health checks. Null means every Cloudflare data center.","example":["WEU","ENAM"],"nullable":true,"items":{"type":"string","description":"WNAM: Western North America, ENAM: Eastern North America, WEU: Western Europe, EEU: Eastern Europe, NSAM: Northern South America, SSAM: Southern South America, OC: Oceania, ME: Middle East, NAF: North Africa, SAF: South Africa, SAS: Southern Asia, SEAS: South East Asia, NEAS: North East Asia, ALL_REGIONS: all regions (ENTERPRISE customers only).","enum":["WNAM","ENAM","WEU","EEU","NSAM","SSAM","OC","ME","NAF","SAF","SAS","SEAS","NEAS","ALL_REGIONS"]}},"cidr":{"type":"string","description":"IP Prefix in Classless Inter-Domain Routing format.","example":"192.0.2.0/24"},"cidr_configuration":{"title":"An IP address range configuration.","properties":{"target":{"description":"The configuration target. You must set the target to `ip_range` when specifying an IP address range in the rule.","enum":["ip_range"],"example":"ip_range"},"value":{"type":"string","description":"The IP address range to match. You can only use prefix lengths `/16` and `/24` for IPv4 ranges, and prefix lengths `/32`, `/48`, and `/64` for IPv6 ranges.","example":"198.51.100.4/16"}}},"cidr_list":{"type":"array","description":"List of IPv4/IPv6 CIDR addresses.","example":["199.27.128.0/21","2400:cb00::/32"],"items":{"type":"string","description":"IPv4/IPv6 CIDR.","example":"199.27.128.0/21"}},"ciphers":{"allOf":[{"$ref":"#/components/schemas/schemas-base"},{"properties":{"id":{"description":"ID of the zone setting.","enum":["ciphers"],"example":"ciphers"},"value":{"$ref":"#/components/schemas/ciphers_value"}}}],"title":"Zone ciphers allowed for TLS termination","description":"An allowlist of ciphers for TLS termination. These ciphers must be in the BoringSSL format.","default":[]},"ciphers_value":{"type":"array","description":"Value of the zone setting.","default":[],"example":["ECDHE-RSA-AES128-GCM-SHA256","AES128-SHA"],"uniqueItems":true,"items":{"type":"string"}},"city":{"type":"string","description":"City.","example":"Austin"},"class":{"type":"string","description":"Which account types are allowed to create policies based on this categories. `blocked` categories are blocked unconditionally for all accounts. `removalPending` categories can be removed from policies but not added. `noBlock` categories cannot be blocked.","enum":["free","premium","blocked","removalPending","noBlock"],"example":"premium"},"client-default":{"type":"boolean","description":"Set if the location is the default one.","example":false},"client_id":{"type":"string","description":"The Client ID for the service token. Access will check for this value in the `CF-Access-Client-ID` request header.","example":"88bf3b6d86161464f6509f7219099e57.access.example.com"},"client_secret":{"type":"string","description":"The Client Secret for the service token. Access will check for this value in the `CF-Access-Client-Secret` request header.","example":"bdd31cbc4dec990953e39163fbbb194c93313ca9f0a6e420346af9d326b1d2a5"},"clipResponseSingle":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"$ref":"#/components/schemas/schemas-output"}}}]},"clipped_from_video_uid":{"type":"string","description":"The unique video identifier (UID).","example":"023e105f4ecef8ad9ca31a8372d0c353","readOnly":true,"maxLength":32},"clipping_components-schemas-created":{"type":"string","format":"date-time","description":"The date and time the live input was created.","example":"2014-01-02T02:20:00Z","readOnly":true},"cloudflare-tunnel_components-schemas-connection":{"properties":{"client_id":{"description":"UUID of the cloudflared instance."},"client_version":{"$ref":"#/components/schemas/cloudflare-tunnel_components-schemas-version"},"colo_name":{"$ref":"#/components/schemas/schemas-colo_name"},"id":{"$ref":"#/components/schemas/connection_id"},"is_pending_reconnect":{"$ref":"#/components/schemas/is_pending_reconnect"},"opened_at":{"type":"string","format":"date-time","description":"Timestamp of when the connection was established.","example":"2021-01-25T18:22:34.317854Z"},"origin_ip":{"type":"string","description":"The public IP address of the host running cloudflared.","example":"85.12.78.6"},"uuid":{"$ref":"#/components/schemas/connection_id"}}},"cloudflare-tunnel_components-schemas-created_at":{"type":"string","format":"date-time","description":"Timestamp of when the tunnel was created.","example":"2021-01-25T18:22:34.317854Z"},"cloudflare-tunnel_components-schemas-empty_response":{"allOf":[{"$ref":"#/components/schemas/api-response-common"},{"type":"object","properties":{"result":{"type":"object"}}}]},"cloudflare-tunnel_components-schemas-metadata":{"type":"object","description":"Metadata associated with the tunnel.","example":{}},"cloudflare-tunnel_components-schemas-status":{"type":"string","description":"The status of the tunnel. Valid values are `active`, `inactive` or `degraded` (active but not all cloudflared instances have 4 connections to Cloudflare's edge).","example":"active"},"cloudflare-tunnel_components-schemas-version":{"type":"string","description":"The cloudflared version used to establish this connection.","example":"2022.7.1"},"cloudflare_branding":{"type":"boolean","description":"Whether or not to add Cloudflare Branding for the order. This will add sni.cloudflaressl.com as the Common Name if set true.","example":false},"cloudflare_gre_endpoint":{"type":"string","description":"The IP address assigned to the Cloudflare side of the GRE tunnel.","example":"203.0.113.1"},"cloudflare_ipsec_endpoint":{"type":"string","description":"The IP address assigned to the Cloudflare side of the IPsec tunnel.","example":"203.0.113.1"},"cname_flattening":{"allOf":[{"$ref":"#/components/schemas/schemas-base"},{"properties":{"id":{"description":"How to flatten the cname destination.","enum":["cname_flattening"],"example":"flatten_at_root"},"value":{"$ref":"#/components/schemas/cname_flattening_value"}}}],"title":"Cloudflare CNAME Flattening","description":"Whether or not cname flattening is on."},"cname_flattening_value":{"type":"string","description":"Value of the cname flattening setting.","enum":["flatten_at_root","flatten_all"],"default":"flatten_at_root"},"code":{"type":"string","description":"The unique activation code for the account membership.","example":"05dd05cce12bbed97c0d87cd78e89bc2fd41a6cee72f27f6fc84af2e45c0fac0","readOnly":true,"maxLength":64},"collection_invite_response":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"type":"object","properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/invite"}}}}]},"collection_member_response":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"type":"object","properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/components-schemas-member"}}}}]},"collection_membership_response":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"type":"object","properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/membership"}}}}]},"collection_organization_response":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"type":"object","properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/organization"}}}}]},"collection_response":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"errors":{"type":"array","items":{}},"messages":{"type":"array","items":{}},"result":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/api-shield"},{"properties":{"features":{}}}]}}}}]},"collection_response_paginated":{"anyOf":[{"allOf":[{"$ref":"#/components/schemas/collection_response"},{"properties":{"result_info":{"type":"object","properties":{"count":{"type":"number","description":"Total results returned based on your search parameters.","example":1},"page":{"type":"number","description":"Current page within paginated list of results.","example":1},"per_page":{"type":"number","description":"Number of results per page of results.","example":20},"total_count":{"type":"number","description":"Total results available without any search parameters.","example":500}}}}},{"properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/api-shield"}}}}]},{"$ref":"#/components/schemas/collection_response"}]},"collection_role_response":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"type":"object","properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/schemas-role"}}}}]},"colo":{"type":"object","properties":{"city":{"$ref":"#/components/schemas/colo_city"},"name":{"$ref":"#/components/schemas/colo_name"}}},"colo_city":{"type":"string","description":"Source colo city.","example":"Denver, CO, US"},"colo_name":{"type":"string","description":"Source colo name.","example":"den01"},"colo_names":{"type":"array","description":"List of colo names for the ECMP scope.","items":{"$ref":"#/components/schemas/components-schemas-colo_name"}},"colo_region":{"type":"string","description":"Scope colo region.","example":"APAC"},"colo_regions":{"type":"array","description":"List of colo regions for the ECMP scope.","items":{"$ref":"#/components/schemas/colo_region"}},"colo_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"query":{"$ref":"#/components/schemas/query_response"},"result":{"$ref":"#/components/schemas/datacenters"}}}]},"colo_result":{"type":"object","properties":{"colo":{"$ref":"#/components/schemas/colo"},"error":{"$ref":"#/components/schemas/error"},"hops":{"type":"array","items":{"$ref":"#/components/schemas/hop_result"}},"target_summary":{"$ref":"#/components/schemas/target_summary"},"traceroute_time_ms":{"$ref":"#/components/schemas/traceroute_time_ms"}}},"colos":{"type":"array","description":"If no source colo names specified, all colos will be used. China colos are unavailable for traceroutes.","example":["den","sin"],"items":{"type":"string","description":"Source colo name."}},"comment":{"type":"string","description":"Optional remark describing the route.","example":"Example comment for this route."},"common_components-schemas-created_on":{"type":"string","format":"date-time","description":"The date and time the tunnel was created.","example":"2017-06-14T00:00:00Z","readOnly":true},"common_components-schemas-identifier":{"type":"string","description":"Identifier","example":"023e105f4ecef8ad9ca31a8372d0c353","readOnly":true,"maxLength":32},"common_components-schemas-identifier-2":{"type":"string","description":"Tunnel identifier tag.","example":"c4a7362d577a6c3019a474fd6f485821","readOnly":true,"maxLength":32},"common_components-schemas-ip":{"anyOf":[{"$ref":"#/components/schemas/ipv4"},{"$ref":"#/components/schemas/schemas-ipv6"}]},"common_components-schemas-modified_on":{"type":"string","format":"date-time","description":"The date and time the tunnel was last modified.","example":"2017-06-14T05:20:00Z","readOnly":true},"component-value":{"type":"object","properties":{"default":{"$ref":"#/components/schemas/default"},"name":{"$ref":"#/components/schemas/component-value_components-schemas-name"},"unit_price":{"$ref":"#/components/schemas/unit_price"}}},"component-value_components-schemas-name":{"description":"The unique component.","enum":["zones","page_rules","dedicated_certificates","dedicated_certificates_custom"],"example":"page_rules"},"component_value":{"type":"object","description":"A component value for a subscription.","properties":{"default":{"type":"number","description":"The default amount assigned.","example":5},"name":{"type":"string","description":"The name of the component value.","example":"page_rules"},"price":{"type":"number","description":"The unit price for the component value.","example":5},"value":{"type":"number","description":"The amount of the component value assigned.","example":20}}},"component_values":{"type":"array","description":"The list of add-ons subscribed to.","items":{"$ref":"#/components/schemas/component_value"}},"components-schemas-account":{"allOf":[{"$ref":"#/components/schemas/account"}]},"components-schemas-account_identifier":{"type":"string","description":"The account identifier tag.","example":"023e105f4ecef8ad9ca31a8372d0c353","readOnly":true,"maxLength":32},"components-schemas-action":{"anyOf":[{"type":"object","properties":{"mode":{"$ref":"#/components/schemas/mode"},"response":{"$ref":"#/components/schemas/custom_response"},"timeout":{"$ref":"#/components/schemas/timeout"}}}],"type":"object","description":"The action to perform when the threshold of matched traffic within the configured period is exceeded."},"components-schemas-address":{"type":"string","description":"Address.","example":"123 Sesame St."},"components-schemas-app_id":{"type":"integer","description":"The identifier for this application. There is only one application per id."},"components-schemas-asn":{"type":"integer"},"components-schemas-base":{"required":["id","modified_on"],"properties":{"id":{"type":"string","description":"Identifier of the zone setting.","example":"development_mode"},"modified_on":{"type":"string","format":"date-time","description":"last time this setting was modified.","example":"2014-01-01T05:20:00.12345Z","nullable":true,"readOnly":true}}},"components-schemas-certificate":{"type":"string","description":"The Origin CA certificate. Will be newline-encoded.","example":"-----BEGIN CERTIFICATE-----\nMIICvDCCAaQCAQAwdzELMAkGA1UEBhMCVVMxDTALBgNVBAgMBFV0YWgxDzANBgNV\nBAcMBkxpbmRvbjEWMBQGA1UECgwNRGlnaUNlcnQgSW5jLjERMA8GA1UECwwIRGln\naUNlcnQxHTAbBgNVBAMMFGV4YW1wbGUuZGlnaWNlcnQuY29tMIIBIjANBgkqhkiG\n9w0BAQEFAAOCAQ8AMIIBCgKCAQEA8+To7d+2kPWeBv/orU3LVbJwDrSQbeKamCmo\nwp5bqDxIwV20zqRb7APUOKYoVEFFOEQs6T6gImnIolhbiH6m4zgZ/CPvWBOkZc+c\n1Po2EmvBz+AD5sBdT5kzGQA6NbWyZGldxRthNLOs1efOhdnWFuhI162qmcflgpiI\nWDuwq4C9f+YkeJhNn9dF5+owm8cOQmDrV8NNdiTqin8q3qYAHHJRW28glJUCZkTZ\nwIaSR6crBQ8TbYNE0dc+Caa3DOIkz1EOsHWzTx+n0zKfqcbgXi4DJx+C1bjptYPR\nBPZL8DAeWuA8ebudVT44yEp82G96/Ggcf7F33xMxe0yc+Xa6owIDAQABoAAwDQYJ\nKoZIhvcNAQEFBQADggEBAB0kcrFccSmFDmxox0Ne01UIqSsDqHgL+XmHTXJwre6D\nhJSZwbvEtOK0G3+dr4Fs11WuUNt5qcLsx5a8uk4G6AKHMzuhLsJ7XZjgmQXGECpY\nQ4mC3yT3ZoCGpIXbw+iP3lmEEXgaQL0Tx5LFl/okKbKYwIqNiyKWOMj7ZR/wxWg/\nZDGRs55xuoeLDJ/ZRFf9bI+IaCUd1YrfYcHIl3G87Av+r49YVwqRDT0VDV7uLgqn\n29XI1PpVUNCPQGn9p/eX6Qo7vpDaPybRtA2R7XLKjQaF9oXWeCUqy1hvJac9QFO2\n97Ob1alpHPoZ7mWiEuJwjBPii6a9M9G30nUo39lBi1w=\n-----END CERTIFICATE-----","readOnly":true},"components-schemas-certificate_response_collection":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/zone-authenticated-origin-pull"}}}}]},"components-schemas-certificate_response_single":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/schemas-certificateObject"}}}]},"components-schemas-collection_response":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/web3-hostname"}}}}]},"components-schemas-colo_name":{"type":"string","description":"Scope colo name.","example":"den01"},"components-schemas-config":{"type":"object","description":"The tunnel configuration and ingress rules in JSON format. For syntax and parameters, refer to the [configuration file documentation](https://developers.cloudflare.com/cloudflare-one/connections/connect-apps/install-and-setup/tunnel-guide/local/local-management/configuration-file/#file-structure)."},"components-schemas-configuration":{"type":"object","description":"The configuration object for the current rule.","properties":{"target":{"type":"string","description":"The configuration target for this rule. You must set the target to `ua` for User Agent Blocking rules.","example":"ua"},"value":{"type":"string","description":"The exact user agent string to match. This value will be compared to the received `User-Agent` HTTP header value.","example":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_5) AppleWebKit/603.2.4 (KHTML, like Gecko) Version/10.1.1 Safari/603.2.4"}}},"components-schemas-connection":{"type":"string","description":"The IdP used to authenticate.","example":"saml"},"components-schemas-created":{"type":"string","format":"date-time","description":"The date and a time a watermark profile was created.","example":"2014-01-02T02:20:00Z","readOnly":true},"components-schemas-created_at":{"type":"string","format":"date-time","description":"Shows time of creation.","example":"2018-08-28T17:26:26Z"},"components-schemas-created_on":{"type":"string","description":"The RFC 3339 timestamp of when the list was created.","example":"2020-01-01T08:00:00Z"},"components-schemas-description":{"type":"string","description":"An informative summary of the rate limit. This value is sanitized and any tags will be removed.","example":"Prevent multiple login failures to mitigate brute force attacks","maxLength":1024},"components-schemas-domain":{"type":"string","description":"The domain of the Bookmark application.","example":"example.com"},"components-schemas-email":{"type":"string","format":"email","description":"The email of the user.","example":"jdoe@example.com"},"components-schemas-empty_response":{"allOf":[{"properties":{"result":{"nullable":true},"success":{"type":"boolean","enum":[true,false],"example":true}}}]},"components-schemas-enabled":{"type":"boolean","description":"Disabling Universal SSL removes any currently active Universal SSL certificates for your zone from the edge and prevents any future Universal SSL certificates from being ordered. If there are no dedicated certificates or custom certificates uploaded for the domain, visitors will be unable to access the domain over HTTPS.\n\nBy disabling Universal SSL, you understand that the following Cloudflare settings and preferences will result in visitors being unable to visit your domain unless you have uploaded a custom certificate or purchased a dedicated certificate.\n\n* HSTS\n* Always Use HTTPS\n* Opportunistic Encryption\n* Onion Routing\n* Any Page Rules redirecting traffic to HTTPS\n\nSimilarly, any HTTP redirect to HTTPS at the origin while the Cloudflare proxy is enabled will result in users being unable to visit your site without a valid certificate at Cloudflare's edge.\n\nIf you do not have a valid custom or dedicated certificate at Cloudflare's edge and are unsure if any of the above Cloudflare settings are enabled, or if any HTTP redirects exist at your origin, we advise leaving Universal SSL enabled for your domain.","example":true},"components-schemas-exclude":{"type":"array","items":{"$ref":"#/components/schemas/split_tunnel"}},"components-schemas-expires_on":{"type":"string","format":"date-time","description":"When the certificate from the authority expires.","example":"2016-01-01T05:20:00Z","readOnly":true},"components-schemas-filters":{"type":"object","example":{"slo":["99.9"]}},"components-schemas-frequency":{"type":"string","description":"The frequency at which Cloudflare sends batches of logs to your destination. Setting frequency to high sends your logs in larger quantities of smaller files. Setting frequency to low sends logs in smaller quantities of larger files.","enum":["high","low"],"default":"high","example":"high","nullable":true},"components-schemas-host":{"type":"string","description":"The host name to which the waiting room will be applied (no wildcards). Please do not include the scheme (http:// or https://). The host and path combination must be unique.","example":"shop.example.com"},"components-schemas-hostname":{"type":"string","description":"Hostname of the Worker Domain.","example":"foo.example.com"},"components-schemas-id":{"type":"string","description":"Identifier for the tail.","example":"03dc9f77817b488fb26c5861ec18f791"},"components-schemas-id_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/tsig_components-schemas-identifier"}}}}}]},"components-schemas-identifier":{"type":"string","description":"Token identifier tag.","example":"ed17574386854bf78a67040be0a770b0","readOnly":true,"maxLength":32},"components-schemas-interval":{"type":"integer","description":"The interval between each health check. Shorter intervals may give quicker notifications if the origin status changes, but will increase load on the origin as we check from multiple locations.","default":60},"components-schemas-ip":{"type":"string","description":"The IP address of the authenticating user.","example":"198.41.129.166"},"components-schemas-ips":{"type":"array","description":"A list of CIDRs to restrict ingress connections.","items":{"type":"string","description":"The IPv4 CIDR or IPv6 CIDR. IPv6 CIDRs are limited to a maximum of /109. IPv4 CIDRs are limited to a maximum of /25.","example":"192.0.2.1/32"}},"components-schemas-kind":{"type":"string","description":"The type of the membership.","enum":["zone","account"],"example":"zone"},"components-schemas-match":{"type":"string","description":"The wirefilter expression to match devices.","example":"user.identity == \"test@cloudflare.com\"","maxLength":500},"components-schemas-member":{"type":"object","required":["id","name","email","status","roles"],"properties":{"email":{"$ref":"#/components/schemas/email"},"id":{"$ref":"#/components/schemas/common_components-schemas-identifier"},"name":{"$ref":"#/components/schemas/member_components-schemas-name"},"roles":{"type":"array","description":"Roles assigned to this Member.","items":{"$ref":"#/components/schemas/schemas-role"}},"status":{"description":"A member's status in the organization.","enum":["accepted","invited"],"example":"accepted"}}},"components-schemas-metadata":{"type":"string","description":"Arbitrary JSON to be associated with a key/value pair.","example":"{\"someMetadataKey\": \"someMetadataValue\"}"},"components-schemas-mode":{"type":"string","description":"The state of the rules contained in the rule group. When `on`, the rules in the group are configurable/usable.","enum":["on","off"],"default":"on"},"components-schemas-modified":{"type":"string","format":"date-time","description":"The date and time the live input was last modified.","example":"2014-01-02T02:20:00Z","readOnly":true},"components-schemas-modified_on":{"type":"string","format":"date-time","description":"When the certificate was last modified.","example":"2014-01-01T05:20:00Z","readOnly":true},"components-schemas-modified_tunnels_collection_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"properties":{"modified":{"type":"boolean","example":true},"modified_interconnects":{"type":"array","items":{"$ref":"#/components/schemas/interconnect"}}}}}}]},"components-schemas-monitor":{"type":"object","properties":{"allow_insecure":{"$ref":"#/components/schemas/allow_insecure"},"consecutive_down":{"$ref":"#/components/schemas/consecutive_down"},"consecutive_up":{"$ref":"#/components/schemas/consecutive_up"},"created_on":{"$ref":"#/components/schemas/timestamp"},"description":{"$ref":"#/components/schemas/monitor_components-schemas-description"},"expected_body":{"$ref":"#/components/schemas/expected_body"},"expected_codes":{"$ref":"#/components/schemas/schemas-expected_codes"},"follow_redirects":{"$ref":"#/components/schemas/follow_redirects"},"header":{"$ref":"#/components/schemas/header"},"id":{"$ref":"#/components/schemas/monitor_components-schemas-identifier"},"interval":{"$ref":"#/components/schemas/interval"},"method":{"$ref":"#/components/schemas/schemas-method"},"modified_on":{"$ref":"#/components/schemas/timestamp"},"path":{"$ref":"#/components/schemas/path"},"port":{"$ref":"#/components/schemas/monitor_components-schemas-port"},"probe_zone":{"$ref":"#/components/schemas/probe_zone"},"retries":{"$ref":"#/components/schemas/retries"},"timeout":{"$ref":"#/components/schemas/schemas-timeout"},"type":{"$ref":"#/components/schemas/monitor_components-schemas-type"}}},"components-schemas-name":{"type":"string","description":"Role Name.","example":"Organization Admin","readOnly":true,"maxLength":120},"components-schemas-pattern":{"type":"object","title":"Pattern","description":"A pattern that matches an entry","required":["regex"],"properties":{"regex":{"type":"string","description":"The regex pattern.","example":"^4[0-9]{6,}$"},"validation":{"type":"string","description":"Validation algorithm for the pattern. This algorithm will get run on potential matches, and if it returns false, the entry will not be matched.","enum":["luhn"],"example":"luhn"}}},"components-schemas-paused":{"type":"boolean","description":"When true, indicates that the rule is currently paused.","example":false},"components-schemas-policies":{"type":"object","properties":{"alert_type":{"$ref":"#/components/schemas/alert_type"},"created":{"$ref":"#/components/schemas/timestamp"},"description":{"$ref":"#/components/schemas/policies_components-schemas-description"},"enabled":{"$ref":"#/components/schemas/policies_components-schemas-enabled"},"filters":{"$ref":"#/components/schemas/components-schemas-filters"},"id":{"$ref":"#/components/schemas/uuid"},"mechanisms":{"$ref":"#/components/schemas/mechanisms"},"modified":{"$ref":"#/components/schemas/timestamp"},"name":{"$ref":"#/components/schemas/policies_components-schemas-name-2"}}},"components-schemas-port":{"type":"integer","description":"Port number to connect to for the health check. Required for TCP, UDP, and SMTP checks. HTTP and HTTPS checks should only define the port when using a non-standard port (HTTP: default 80, HTTPS: default 443).","default":0},"components-schemas-precedence":{"type":"number","description":"The precedence of the policy. Lower values indicate higher precedence. Policies will be evaluated in ascending order of this field.","example":100},"components-schemas-priority":{"type":"number","description":"Priority of the routing rule.","default":0,"minimum":0},"components-schemas-query":{"allOf":[{"$ref":"#/components/schemas/query"},{"properties":{"dimensions":{"example":["namespaceId"],"items":{"enum":["namespaceId"]}},"filters":{"example":"namespaceId==a4e8cbb7-1b58-4990-925e-e026d40c4c64"},"metrics":{"default":"[\"storedBytes\"]","example":["storedBytes","storedKeys"],"items":{"enum":["storedBytes","storedKeys"]}},"sort":{"example":["+storedBytes","-namespaceId"]}}}]},"components-schemas-ratelimit":{"properties":{"action":{"$ref":"#/components/schemas/components-schemas-action"},"bypass":{"$ref":"#/components/schemas/bypass"},"description":{"$ref":"#/components/schemas/components-schemas-description"},"disabled":{"$ref":"#/components/schemas/disabled"},"id":{"$ref":"#/components/schemas/rate-limits_components-schemas-id"},"match":{"$ref":"#/components/schemas/match"},"period":{"$ref":"#/components/schemas/period"},"threshold":{"$ref":"#/components/schemas/threshold"}}},"components-schemas-ref":{"type":"string","description":"The reference of the rule (the rule ID by default).","example":"my_ref"},"components-schemas-response":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/ip-list"}}}}]},"components-schemas-response_collection":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/zone_components-schemas-zone"}}}}]},"components-schemas-response_single":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"type":"object"}}}]},"components-schemas-result":{"allOf":[{"$ref":"#/components/schemas/schemas-result"},{"properties":{"data":{"example":[{"metrics":[[2,4],[16,32]]}]},"max":{"example":{"readKiB":32,"requests":4}},"min":{"example":{"readKiB":16,"requests":2}},"query":{"$ref":"#/components/schemas/schemas-query"},"totals":{"example":{"readKiB":48,"requests":6}}}}]},"components-schemas-rule":{"oneOf":[{"$ref":"#/components/schemas/anomaly_rule"},{"$ref":"#/components/schemas/traditional_deny_rule"},{"$ref":"#/components/schemas/traditional_allow_rule"}],"type":"object"},"components-schemas-rules":{"type":"array","description":"The list of rules in the ruleset.","items":{"$ref":"#/components/schemas/rules_components-schemas-rule"}},"components-schemas-ruleset":{"properties":{"description":{"example":""},"id":{"example":"2f2feab2026849078ba485f918791bdc"},"kind":{"example":"zone"},"name":{"example":"default"},"phase":{"example":"http_custom_errors"},"rules":{"type":"array","description":"The rules in the ruleset.","items":{"$ref":"#/components/schemas/custom-error-responses_components-schemas-rule"}}}},"components-schemas-single_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/tsig"}}}]},"components-schemas-state":{"description":"The custom page state.","enum":["default","customized"],"example":"default"},"components-schemas-status":{"type":"string","description":"Whether the user is a member of the organization or has an inivitation pending.","enum":["member","invited"],"example":"member"},"components-schemas-target":{"type":"string","description":"Target gateway of the hostname.","enum":["ethereum","ipfs","ipfs_universal_path","polygon"],"example":"ipfs"},"components-schemas-ttl":{"type":"integer","description":"Time To Live (TTL) in number of hops of the GRE tunnel.","default":64},"components-schemas-tunnel_modified_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"properties":{"modified":{"type":"boolean","example":true},"modified_interconnect":{"type":"object"}}}}}]},"components-schemas-tunnel_single_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"properties":{"interconnect":{"type":"object"}}}}}]},"components-schemas-tunnel_update_request":{"type":"object","properties":{"description":{"$ref":"#/components/schemas/interconnect_components-schemas-description"},"gre":{"$ref":"#/components/schemas/gre"},"interface_address":{"$ref":"#/components/schemas/interface_address"},"mtu":{"$ref":"#/components/schemas/schemas-mtu"}}},"components-schemas-tunnels_collection_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"properties":{"interconnects":{"type":"array","items":{"$ref":"#/components/schemas/interconnect"}}}}}}]},"components-schemas-type":{"type":"string","description":"A full zone implies that DNS is hosted with Cloudflare. A partial zone is typically a partner-hosted zone or a CNAME setup.","enum":["full","partial"],"example":"full"},"components-schemas-updated_at":{"type":"string","format":"date-time","description":"Last updated.","example":"2018-08-28T17:26:26Z"},"components-schemas-uploaded_on":{"type":"string","format":"date-time","description":"The time when the certificate was uploaded.","example":"2019-10-28T18:11:23.37411Z"},"components-schemas-url":{"type":"string","format":"uri","description":"URL(s) to filter submissions results by","example":"https://www.cloudflare.com"},"components-schemas-uuid":{"type":"string","description":"The policy ID.","example":"f174e90a-fafe-4643-bbbc-4a0ed4fc8415","maxLength":36},"components-schemas-validation_method":{"type":"object","required":["validation_method"],"properties":{"validation_method":{"$ref":"#/components/schemas/validation_method_definition"}}},"components-schemas-value":{"type":"string","enum":["flexible","full","strict"],"example":"strict"},"components-schemas-version":{"type":"object","description":"The version of the analyzed script.","properties":{"fetched_at":{"$ref":"#/components/schemas/fetched_at"},"hash":{"$ref":"#/components/schemas/hash"},"js_integrity_score":{"$ref":"#/components/schemas/js_integrity_score"}}},"components-schemas-zone":{"type":"object","required":["id","name","development_mode","owner","account","meta","original_name_servers","original_registrar","original_dnshost","created_on","modified_on","activated_on"],"properties":{"activated_on":{"type":"string","format":"date-time","description":"The last time proof of ownership was detected and the zone was made\nactive","example":"2014-01-02T00:01:00.12345Z","nullable":true,"readOnly":true},"created_on":{"type":"string","format":"date-time","description":"When the zone was created","example":"2014-01-01T05:20:00.12345Z","readOnly":true},"development_mode":{"type":"number","description":"The interval (in seconds) from when development mode expires\n(positive integer) or last expired (negative integer) for the\ndomain. If development mode has never been enabled, this value is 0.","example":7200,"readOnly":true},"id":{"$ref":"#/components/schemas/common_components-schemas-identifier"},"modified_on":{"type":"string","format":"date-time","description":"When the zone was last modified","example":"2014-01-01T05:20:00.12345Z","readOnly":true},"name":{"type":"string","description":"The domain name","example":"example.com","readOnly":true,"maxLength":253,"pattern":"^([a-zA-Z0-9][\\-a-zA-Z0-9]*\\.)+[\\-a-zA-Z0-9]{2,20}$"},"original_dnshost":{"type":"string","description":"DNS host at the time of switching to Cloudflare","example":"NameCheap","nullable":true,"readOnly":true,"maxLength":50},"original_name_servers":{"type":"array","description":"Original name servers before moving to Cloudflare\nNotes: Is this only available for full zones?","example":["ns1.originaldnshost.com","ns2.originaldnshost.com"],"nullable":true,"readOnly":true,"items":{"type":"string","format":"hostname"}},"original_registrar":{"type":"string","description":"Registrar for the domain at the time of switching to Cloudflare","example":"GoDaddy","nullable":true,"readOnly":true}}},"condition":{"type":"object","properties":{"request.ip":{"$ref":"#/components/schemas/request.ip"}}},"config":{"type":"array","items":{"$ref":"#/components/schemas/hostname_certid_input"}},"config_components-schemas-account_identifier":{"example":"6f91088a406011ed95aed352566e8d4c"},"config_request":{"oneOf":[{"$ref":"#/components/schemas/workspace_one_config_request"},{"$ref":"#/components/schemas/crowdstrike_config_request"},{"$ref":"#/components/schemas/uptycs_config_request"},{"$ref":"#/components/schemas/intune_config_request"}],"type":"object","description":"The configuration object containing third party integration information.","example":{"api_url":"https://as123.awmdm.com/API","auth_url":"https://na.uemauth.vmwservices.com/connect/token","client_id":"example client id","client_secret":"example client secret"}},"config_response":{"oneOf":[{"$ref":"#/components/schemas/workspace_one_config_response"}],"type":"object","description":"The configuration object containing third party integration information.","example":{"api_url":"https://as123.awmdm.com/API","auth_url":"https://na.uemauth.vmwservices.com/connect/token","client_id":"example client id"}},"config_response_single":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"type":"object","properties":{"result":{"type":"object"}}}]},"config_src":{"type":"string","description":"Indicates if this is a locally or remotely configured tunnel. If `local`, manage the tunnel using a YAML file on the origin machine. If `cloudflare`, manage the tunnel on the Zero Trust dashboard or using the [Cloudflare Tunnel configuration](https://api.cloudflare.com/#cloudflare-tunnel-configuration-properties) endpoint.","enum":["local","cloudflare"],"default":"local","example":"cloudflare"},"config_version":{"type":"integer","description":"The version of the remote tunnel configuration. Used internally to sync cloudflared with the Zero Trust dashboard."},"configuration":{"type":"object","properties":{"auth_id_characteristics":{"$ref":"#/components/schemas/characteristics"}}},"configurations":{"anyOf":[{"$ref":"#/components/schemas/schemas-ip_configuration"},{"$ref":"#/components/schemas/schemas-cidr_configuration"}],"type":"array","description":"A list of IP addresses or CIDR ranges that will be allowed to access the URLs specified in the Zone Lockdown rule. You can include any number of `ip` or `ip_range` configurations.","items":{"anyOf":[{"$ref":"#/components/schemas/schemas-ip_configuration"},{"$ref":"#/components/schemas/schemas-cidr_configuration"}]}},"connect_components-schemas-created":{"type":"string","format":"date-time","description":"The date and time the live input was created.","example":"2014-01-02T02:20:00Z","readOnly":true},"connected":{"type":"boolean","description":"A flag indicating whether the given zone is connected to the Railgun.","default":false,"example":true},"connection":{"properties":{"added_at":{"example":"2021-08-18T10:51:10.09615Z"},"domain_reported_malicious":{"example":false},"first_page_url":{"example":"blog.cloudflare.com/page"},"first_seen_at":{"example":"2021-08-18T10:51:08Z"},"host":{"example":"blog.cloudflare.com"},"id":{"example":"c9ef84a6bf5e47138c75d95e2f933e8f"},"last_seen_at":{"example":"2021-09-02T09:57:54Z"},"page_urls":{"example":["blog.cloudflare.com/page1","blog.cloudflare.com/page2"]},"url":{"example":"https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/4.6.0/js/bootstrap.min.js"},"url_contains_cdn_cgi_path":{"example":false}}},"connection_collection_response":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/schemas-connection"}}}}]},"connection_components-schemas-created_on":{"type":"string","format":"date-time","description":"When the connection was created.","example":"2017-06-14T00:00:00Z","readOnly":true},"connection_components-schemas-enabled":{"type":"boolean","description":"A value indicating whether the connection is enabled or not.","default":false,"example":true},"connection_components-schemas-identifier":{"type":"string","description":"Connection identifier tag.","example":"c4a7362d577a6c3019a474fd6f485821","readOnly":true,"maxLength":32},"connection_components-schemas-modified_on":{"type":"string","format":"date-time","description":"When the connection was last modified.","example":"2017-06-14T05:20:00Z","readOnly":true},"connection_components-schemas-zone":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/common_components-schemas-identifier"},"name":{"$ref":"#/components/schemas/properties-name"}}},"connection_id":{"type":"string","description":"UUID of the Cloudflare Tunnel connection.","example":"1bedc50d-42b3-473c-b108-ff3d10c0d925","readOnly":true,"maxLength":36},"connection_single_id_response":{"allOf":[{"$ref":"#/components/schemas/connection_single_response"},{"properties":{"result":{"properties":{"id":{"$ref":"#/components/schemas/connection_components-schemas-identifier"}}}}}]},"connection_single_request":{"type":"object","required":["zone"],"properties":{"enabled":{"$ref":"#/components/schemas/connection_components-schemas-enabled"},"zone":{"properties":{"id":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}}}},"connection_single_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"type":"object"}}}]},"connections":{"type":"array","description":"The Cloudflare Tunnel connections between your origin and Cloudflare's edge.","items":{"$ref":"#/components/schemas/cloudflare-tunnel_components-schemas-connection"}},"conns_active_at":{"type":"string","format":"date-time","description":"Timestamp of when the tunnel established at least one connection to Cloudflare's edge. If `null`, the tunnel is inactive.","example":"2009-11-10T23:00:00Z","nullable":true},"conns_inactive_at":{"type":"string","format":"date-time","description":"Timestamp of when the tunnel became inactive (no connections to Cloudflare's edge). If `null`, the tunnel is active.","example":"2009-11-10T23:00:00Z","nullable":true},"consecutive_down":{"type":"integer","description":"To be marked unhealthy the monitored origin must fail this healthcheck N consecutive times.","default":0},"consecutive_fails":{"type":"integer","description":"The number of consecutive fails required from a health check before changing the health to unhealthy.","default":1},"consecutive_successes":{"type":"integer","description":"The number of consecutive successes required from a health check before changing the health to healthy.","default":1},"consecutive_up":{"type":"integer","description":"To be marked healthy the monitored origin must pass this healthcheck N consecutive times.","default":0},"consumer":{"type":"object","properties":{"created_on":{"readOnly":true},"environment":{"readOnly":true},"queue_name":{"readOnly":true},"service":{"readOnly":true},"settings":{"type":"object","properties":{"batch_size":{"$ref":"#/components/schemas/batch_size"},"max_retries":{"$ref":"#/components/schemas/max_retries"},"max_wait_time_ms":{"$ref":"#/components/schemas/max_wait_time_ms"}}}}},"consumer_created":{"type":"object","properties":{"created_on":{"readOnly":true},"dead_letter_queue":{"$ref":"#/components/schemas/dlq_name"},"environment":{"readOnly":true},"queue_name":{"readOnly":true},"script_name":{"readOnly":true},"settings":{"type":"object","properties":{"batch_size":{"$ref":"#/components/schemas/batch_size"},"max_retries":{"$ref":"#/components/schemas/max_retries"},"max_wait_time_ms":{"$ref":"#/components/schemas/max_wait_time_ms"}}}}},"consumer_name":{"type":"string","example":"example-consumer"},"consumer_updated":{"type":"object","properties":{"created_on":{"readOnly":true},"dead_letter_queue":{"example":"updated-example-dlq"},"environment":{"readOnly":true},"queue_name":{"readOnly":true},"script_name":{"readOnly":true},"settings":{"type":"object","properties":{"batch_size":{"type":"number","example":100},"max_retries":{"$ref":"#/components/schemas/max_retries"},"max_wait_time_ms":{"$ref":"#/components/schemas/max_wait_time_ms"}}}}},"contact_identifier":{"type":"string","description":"Contact Identifier.","example":"ea95132c15732412d22c1476fa83f27a","readOnly":true,"maxLength":32},"contact_properties":{"type":"object","required":["first_name","last_name","address","city","state","zip","country","phone","organization"],"properties":{"address":{"$ref":"#/components/schemas/components-schemas-address"},"address2":{"$ref":"#/components/schemas/address2"},"city":{"$ref":"#/components/schemas/city"},"country":{"$ref":"#/components/schemas/country"},"email":{"$ref":"#/components/schemas/email"},"fax":{"$ref":"#/components/schemas/fax"},"first_name":{"$ref":"#/components/schemas/first_name"},"id":{"$ref":"#/components/schemas/contact_identifier"},"last_name":{"$ref":"#/components/schemas/last_name"},"organization":{"$ref":"#/components/schemas/schemas-organization"},"phone":{"$ref":"#/components/schemas/telephone"},"state":{"$ref":"#/components/schemas/contacts_components-schemas-state"},"zip":{"$ref":"#/components/schemas/zipcode"}}},"contacts":{"allOf":[{"$ref":"#/components/schemas/contact_properties"}],"type":"object"},"contacts_components-schemas-state":{"type":"string","description":"State.","example":"TX"},"content":{"type":"string","description":"DNS record content.","example":"127.0.0.1"},"content_categories":{"description":"Current content categories.","example":[{"id":155,"name":"Technology","super_category_id":26}]},"content_list_action":{"type":"string","description":"Behavior of the content list.","enum":["block"],"example":"block"},"content_list_details":{"type":"object","properties":{"action":{"$ref":"#/components/schemas/content_list_action"}}},"content_list_details_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/content_list_details"}}}]},"content_list_entries":{"type":"array","description":"Content list entries.","items":{"$ref":"#/components/schemas/content_list_entry"}},"content_list_entry":{"type":"object","description":"Content list entry to be blocked.","properties":{"content":{"$ref":"#/components/schemas/content_list_entry_content"},"created_on":{"$ref":"#/components/schemas/timestamp"},"description":{"$ref":"#/components/schemas/content_list_entry_description"},"id":{"$ref":"#/components/schemas/common_components-schemas-identifier"},"modified_on":{"$ref":"#/components/schemas/timestamp"},"type":{"$ref":"#/components/schemas/content_list_entry_type"}}},"content_list_entry_collection_response":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"type":"object","properties":{"entries":{"$ref":"#/components/schemas/content_list_entries"}}}}}]},"content_list_entry_content":{"type":"string","description":"CID or content path of content to block.","example":"QmPZ9gcCEpqKTo6aq61g2nXGUhM4iCL3ewB6LDXZCtioEB","maxLength":500},"content_list_entry_create_request":{"type":"object","required":["type","content"],"properties":{"content":{"$ref":"#/components/schemas/content_list_entry_content"},"description":{"$ref":"#/components/schemas/content_list_entry_description"},"type":{"$ref":"#/components/schemas/content_list_entry_type"}}},"content_list_entry_description":{"type":"string","description":"An optional description of the content list entry.","example":"this is my content list entry","maxLength":500},"content_list_entry_single_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/content_list_entry"}}}]},"content_list_entry_type":{"type":"string","description":"Type of content list entry to block.","enum":["cid","content_path"],"example":"cid"},"content_list_update_request":{"type":"object","required":["action","entries"],"properties":{"action":{"$ref":"#/components/schemas/content_list_action"},"entries":{"$ref":"#/components/schemas/content_list_entries"}}},"content_type":{"type":"string","description":"The content type of the body. Must be one of the following: `text/plain`, `text/xml`, or `application/json`.","example":"text/xml","maxLength":50},"cookie_attributes":{"type":"object","description":"Configures cookie attributes for the waiting room cookie. This encrypted cookie stores a user's status in the waiting room, such as queue position.","properties":{"samesite":{"type":"string","description":"Configures the SameSite attribute on the waiting room cookie. Value `auto` will be translated to `lax` or `none` depending if **Always Use HTTPS** is enabled. Note that when using value `none`, the secure attribute cannot be set to `never`.","enum":["auto","lax","none","strict"],"default":"auto","example":"auto"},"secure":{"type":"string","description":"Configures the Secure attribute on the waiting room cookie. Value `always` indicates that the Secure attribute will be set in the Set-Cookie header, `never` indicates that the Secure attribute will not be set, and `auto` will set the Secure attribute depending if **Always Use HTTPS** is enabled.","enum":["auto","always","never"],"default":"auto","example":"auto"}}},"cors_headers":{"type":"object","properties":{"allow_all_headers":{"$ref":"#/components/schemas/allow_all_headers"},"allow_all_methods":{"$ref":"#/components/schemas/allow_all_methods"},"allow_all_origins":{"$ref":"#/components/schemas/allow_all_origins"},"allow_credentials":{"$ref":"#/components/schemas/allow_credentials"},"allowed_headers":{"$ref":"#/components/schemas/allowed_headers"},"allowed_methods":{"$ref":"#/components/schemas/allowed_methods"},"allowed_origins":{"$ref":"#/components/schemas/allowed_origins"},"max_age":{"$ref":"#/components/schemas/max_age"}}},"count":{"type":"number","description":"The number of items in the List.","example":20,"readOnly":true},"country":{"type":"string","description":"The country in which the user lives.","example":"US","nullable":true,"maxLength":30},"country_configuration":{"title":"A country configuration.","properties":{"target":{"description":"The configuration target. You must set the target to `country` when specifying a country code in the rule.","enum":["country"],"example":"country"},"value":{"type":"string","description":"The two-letter ISO-3166-1 alpha-2 code to match. For more information, refer to [IP Access rules: Parameters](https://developers.cloudflare.com/waf/tools/ip-access-rules/parameters/#country).","example":"US"}}},"country_pools":{"type":"object","description":"A mapping of country codes to a list of pool IDs (ordered by their failover priority) for the given country. Any country not explicitly defined will fall back to using the corresponding region_pool mapping if it exists else to default_pools.","example":{"GB":["abd90f38ced07c2e2f4df50b1f61d4194"],"US":["de90f38ced07c2e2f4df50b1f61d4194","00920f38ce07c2e2f4df50b1f61d4194"]}},"create":{"type":"object","required":["email","roles"],"properties":{"email":{"$ref":"#/components/schemas/email"},"roles":{"type":"array","description":"Array of roles associated with this member.","items":{"$ref":"#/components/schemas/role_components-schemas-identifier"}},"status":{"enum":["accepted","pending"],"default":"pending"}}},"create_custom_profile_response":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/custom_profile"}}}}]},"create_custom_profiles":{"required":["profiles"],"properties":{"profiles":{"type":"array","items":{"$ref":"#/components/schemas/new_custom_profile"},"required":["name","entries"]}}},"create_destination_address_properties":{"type":"object","required":["email"],"properties":{"email":{"$ref":"#/components/schemas/email"}}},"create_input_request":{"properties":{"defaultCreator":{"$ref":"#/components/schemas/live_input_default_creator"},"meta":{"$ref":"#/components/schemas/live_input_metadata"},"recording":{"$ref":"#/components/schemas/live_input_recording_settings"}}},"create_output_request":{"required":["url","streamKey"],"properties":{"enabled":{"$ref":"#/components/schemas/output_enabled"},"streamKey":{"$ref":"#/components/schemas/output_streamKey"},"url":{"$ref":"#/components/schemas/output_url"}}},"create_payload":{"type":"object","required":["name","policies"],"properties":{"condition":{"$ref":"#/components/schemas/condition"},"expires_on":{"$ref":"#/components/schemas/expires_on"},"name":{"$ref":"#/components/schemas/name"},"not_before":{"$ref":"#/components/schemas/not_before"},"policies":{"$ref":"#/components/schemas/policies"}}},"create_rename_namespace_body":{"type":"object","required":["title"],"properties":{"title":{"$ref":"#/components/schemas/namespace_title"}}},"create_request":{"type":"object","required":["name","target"],"properties":{"description":{"$ref":"#/components/schemas/web3-hostname_components-schemas-description"},"dnslink":{"$ref":"#/components/schemas/dnslink"},"name":{"$ref":"#/components/schemas/web3-hostname_components-schemas-name"},"target":{"$ref":"#/components/schemas/components-schemas-target"}}},"create_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"properties":{"client_id":{"$ref":"#/components/schemas/client_id"},"client_secret":{"$ref":"#/components/schemas/client_secret"},"created_at":{"$ref":"#/components/schemas/timestamp"},"id":{"description":"The ID of the service token."},"name":{"$ref":"#/components/schemas/service-tokens_components-schemas-name"},"updated_at":{"$ref":"#/components/schemas/timestamp"}}}}}]},"create_rule":{"required":["action","expression"],"properties":{"action":{"$ref":"#/components/schemas/rule_action"},"description":{"$ref":"#/components/schemas/rule_description"},"enabled":{"$ref":"#/components/schemas/rule_enabled"},"expression":{"$ref":"#/components/schemas/rule_expression"}}},"create_rule_properties":{"type":"object","required":["actions","matchers"],"properties":{"actions":{"$ref":"#/components/schemas/actions"},"enabled":{"$ref":"#/components/schemas/rules_components-schemas-enabled"},"matchers":{"$ref":"#/components/schemas/matchers"},"name":{"$ref":"#/components/schemas/rules_components-schemas-name"},"priority":{"$ref":"#/components/schemas/components-schemas-priority"}}},"create_ruleset":{"type":"object","description":"A ruleset object.","required":["name","kind","phase","rules"],"properties":{"description":{"$ref":"#/components/schemas/rulesets_components-schemas-description"},"kind":{"$ref":"#/components/schemas/schemas-kind"},"name":{"$ref":"#/components/schemas/rulesets_components-schemas-name"},"phase":{"$ref":"#/components/schemas/phase"},"rules":{"$ref":"#/components/schemas/create_update_rules"}}},"create_update_rule":{"type":"object","description":"A rule object.","required":["expression","action"],"properties":{"action":{"$ref":"#/components/schemas/rules_components-schemas-action"},"action_parameters":{"$ref":"#/components/schemas/action_parameters"},"description":{"$ref":"#/components/schemas/rules_components-schemas-description"},"enabled":{"$ref":"#/components/schemas/rules_components-schemas-enabled-2"},"expression":{"$ref":"#/components/schemas/schemas-expression"},"logging":{"$ref":"#/components/schemas/logging"},"ref":{"$ref":"#/components/schemas/components-schemas-ref"}}},"create_update_rules":{"type":"array","description":"The list of rules in the ruleset.","items":{"anyOf":[{"$ref":"#/components/schemas/create_update_rule"},{"description":"The unique ID of a rule."}]}},"created":{"type":"string","format":"date-time","description":"The date and time the destination address has been created.","example":"2014-01-02T02:20:00Z","readOnly":true},"created-on":{"type":"string","format":"date-time","example":"2014-01-01T05:20:00.12345Z","readOnly":true},"created_at":{"type":"string","format":"date-time","description":"This is the time the hostname was created.","example":"2020-02-06T18:11:23.531995Z"},"created_on":{"type":"string","format":"date-time","description":"The timestamp of when the Page Rule was created.","example":"2014-01-01T05:20:00.12345Z","readOnly":true},"creator":{"type":"string","description":"A user-defined identifier for the media creator.","example":"creator-id_abcde12345","maxLength":64},"cron-trigger-response-collection":{"allOf":[{"$ref":"#/components/schemas/api-response-common"},{"properties":{"result":{"type":"object","properties":{"schedules":{"type":"array","items":{"properties":{"created_on":{"readOnly":true},"cron":{"readOnly":true},"modified_on":{"readOnly":true}}}}}}}}]},"crowdstrike_config_request":{"type":"object","required":["api_url","customer_id","client_id","client_secret"],"properties":{"api_url":{"type":"string","description":"The Crowdstrike API URL.","example":"https://api.us-2.crowdstrike.com"},"client_id":{"type":"string","description":"The Crowdstrike client ID.","example":"example client id"},"client_secret":{"type":"string","description":"The Crowdstrike client secret.","example":"example client secret"},"customer_id":{"type":"string","description":"The Crowdstrike customer ID.","example":"example customer id"}}},"csr":{"type":"string","description":"The Certificate Signing Request (CSR). Must be newline-encoded.","example":"-----BEGIN CERTIFICATE REQUEST-----\nMIICxzCCAa8CAQAwSDELMAkGA1UEBhMCVVMxFjAUBgNVBAgTDVNhbiBGcmFuY2lz\nY28xCzAJBgNVBAcTAkNBMRQwEgYDVQQDEwtleGFtcGxlLm5ldDCCASIwDQYJKoZI\nhvcNAQEBBQADggEPADCCAQoCggEBALxejtu4b+jPdFeFi6OUsye8TYJQBm3WfCvL\nHu5EvijMO/4Z2TImwASbwUF7Ir8OLgH+mGlQZeqyNvGoSOMEaZVXcYfpR1hlVak8\n4GGVr+04IGfOCqaBokaBFIwzclGZbzKmLGwIQioNxGfqFm6RGYGA3be2Je2iseBc\nN8GV1wYmvYE0RR+yWweJCTJ157exyRzu7sVxaEW9F87zBQLyOnwXc64rflXslRqi\ng7F7w5IaQYOl8yvmk/jEPCAha7fkiUfEpj4N12+oPRiMvleJF98chxjD4MH39c5I\nuOslULhrWunfh7GB1jwWNA9y44H0snrf+xvoy2TcHmxvma9Eln8CAwEAAaA6MDgG\nCSqGSIb3DQEJDjErMCkwJwYDVR0RBCAwHoILZXhhbXBsZS5uZXSCD3d3dy5leGFt\ncGxlLm5ldDANBgkqhkiG9w0BAQsFAAOCAQEAcBaX6dOnI8ncARrI9ZSF2AJX+8mx\npTHY2+Y2C0VvrVDGMtbBRH8R9yMbqWtlxeeNGf//LeMkSKSFa4kbpdx226lfui8/\nauRDBTJGx2R1ccUxmLZXx4my0W5iIMxunu+kez+BDlu7bTT2io0uXMRHue4i6quH\nyc5ibxvbJMjR7dqbcanVE10/34oprzXQsJ/VmSuZNXtjbtSKDlmcpw6To/eeAJ+J\nhXykcUihvHyG4A1m2R6qpANBjnA0pHexfwM/SgfzvpbvUg0T1ubmer8BgTwCKIWs\ndcWYTthM51JIqRBfNqy4QcBnX+GY05yltEEswQI55wdiS3CjTTA67sdbcQ==\n-----END CERTIFICATE REQUEST-----"},"currency":{"type":"string","description":"The monetary unit in which pricing information is displayed.","example":"USD","readOnly":true},"current":{"type":"number","description":"Cloudflare Images current usage.","example":1000,"readOnly":true},"current_period_end":{"type":"string","format":"date-time","description":"The end of the current period and also when the next billing is due.","example":"2014-03-31T12:20:00Z","readOnly":true},"current_period_start":{"type":"string","format":"date-time","description":"When the current billing period started. May match initial_period_start if this is the first period.","example":"2014-05-11T12:20:00Z","readOnly":true},"current_registrar":{"type":"string","description":"Shows name of current registrar.","example":"Cloudflare"},"cursor":{"type":"string","description":"Opaque token indicating the position from which to continue when requesting the next set of records if the amount of list results was limited by the limit parameter. A valid value for the cursor can be obtained from the cursors object in the result_info structure.","example":"6Ck1la0VxJ0djhidm1MdX2FyDGxLKVeeHZZmORS_8XeSuhz9SjIJRaSa2lnsF01tQOHrfTGAP3R5X1Kv5iVUuMbNKhWNAXHOl6ePB0TUL8nw"},"custom-certificate":{"type":"object","required":["id","hosts","issuer","signature","status","bundle_method","zone_id","uploaded_on","modified_on","expires_on","priority"],"properties":{"bundle_method":{"$ref":"#/components/schemas/bundle_method"},"expires_on":{"$ref":"#/components/schemas/components-schemas-expires_on"},"geo_restrictions":{"$ref":"#/components/schemas/geo_restrictions"},"hosts":{"$ref":"#/components/schemas/hosts"},"id":{"$ref":"#/components/schemas/custom-certificate_components-schemas-identifier"},"issuer":{"$ref":"#/components/schemas/issuer"},"keyless_server":{"$ref":"#/components/schemas/keyless-certificate"},"modified_on":{"$ref":"#/components/schemas/components-schemas-modified_on"},"policy":{"$ref":"#/components/schemas/policy"},"priority":{"$ref":"#/components/schemas/schemas-priority"},"signature":{"$ref":"#/components/schemas/signature"},"status":{"$ref":"#/components/schemas/custom-certificate_components-schemas-status"},"uploaded_on":{"$ref":"#/components/schemas/uploaded_on"},"zone_id":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}},"custom-certificate_components-schemas-identifier":{"type":"string","description":"Custom certificate identifier tag.","example":"2458ce5a-0c35-4c7f-82c7-8e9487d3ff60","readOnly":true,"maxLength":36},"custom-certificate_components-schemas-status":{"description":"Status of the zone's custom SSL.","enum":["active","expired","deleted","pending","initializing"],"example":"active","readOnly":true},"custom-certificate_components-schemas-type":{"type":"string","description":"The type 'legacy_custom' enables support for legacy clients which do not include SNI in the TLS handshake.","enum":["legacy_custom","sni_custom"],"default":"legacy_custom","example":"sni_custom"},"custom-error-responses_components-schemas-rule":{"properties":{"action":{"example":"serve_error"},"action_parameters":{"$ref":"#/components/schemas/action_parameters_serve_error"},"description":{"example":"Change error response based on geolocation"},"expression":{"example":"ip.geoip.country eq \"AL\""},"id":{"example":"3a03d665bac047339bb530ecb439a90d"},"version":{"example":"1"}}},"custom-hostname":{"allOf":[{"$ref":"#/components/schemas/customhostname"}],"type":"object","required":["id","hostname","ssl"],"properties":{"hostname":{"$ref":"#/components/schemas/hostname"},"id":{"$ref":"#/components/schemas/custom-hostname_components-schemas-identifier"},"ssl":{"$ref":"#/components/schemas/schemas-ssl"}}},"custom-hostname_components-schemas-identifier":{"type":"string","description":"Custom hostname identifier tag.","example":"0d89c70d-ad9f-4843-b99f-6cc0252067e9","readOnly":true,"minLength":36,"maxLength":36},"custom-hostname_components-schemas-status":{"description":"Status of the hostname's activation.","enum":["active","pending","active_redeploying","moved","pending_deletion","deleted","pending_blocked","pending_migration","pending_provisioned","test_pending","test_active","test_active_apex","test_blocked","test_failed","provisioned","blocked"],"example":"pending"},"custom-ns_components-schemas-identifier":{"type":"string","description":"Account identifier tag.","example":"372e67954025e0ba6aaa6d586b9e0b59","readOnly":true,"maxLength":32},"custom-pages_components-schemas-identifier":{"description":"The name of the custom page type.","enum":["basic_challenge","managed_challenge","waf_block","ratelimit_block","country_challenge","ip_block","under_attack","500_errors","1000_errors"],"example":"basic_challenge","readOnly":true},"custom-pages_components-schemas-identifier-2":{"description":"The name of the custom page type.","enum":["basic_challenge","managed_challenge","waf_block","country_challenge","ip_block","under_attack","ratelimit_block","500_errors","1000_errors"],"example":"basic_challenge","readOnly":true},"custom_deny_message":{"type":"string","description":"The custom error message shown to a user when they are denied access to the application."},"custom_deny_url":{"type":"string","description":"The custom URL a user is redirected to when they are denied access to the application."},"custom_entry":{"type":"object","title":"Custom entry","description":"A custom entry that matches a profile","properties":{"created_at":{"$ref":"#/components/schemas/timestamp"},"enabled":{"type":"boolean","description":"Whether the entry is enabled or not.","example":true},"id":{"$ref":"#/components/schemas/entry_id"},"name":{"type":"string","description":"The name of the entry.","example":"Credit card (Visa)"},"pattern":{"$ref":"#/components/schemas/components-schemas-pattern"},"profile_id":{"description":"ID of the parent profile"},"updated_at":{"$ref":"#/components/schemas/timestamp"}}},"custom_hostname_response_collection":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/custom-hostname"}}}}]},"custom_hostname_response_single":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"type":"object"}}}]},"custom_metadata":{"anyOf":[{"type":"object","properties":{"key":{"type":"string","description":"Unique metadata for this hostname.","example":"value"}}}],"type":"object","description":"These are per-hostname (customer) settings."},"custom_origin_server":{"type":"string","description":"a valid hostname that’s been added to your DNS zone as an A, AAAA, or CNAME record.","example":"origin2.example.com"},"custom_origin_sni":{"type":"string","description":"A hostname that will be sent to your custom origin server as SNI for TLS handshake. This can be a valid subdomain of the zone or custom origin server name or the string ':request_host_header:' which will cause the host header in the request to be used as SNI. Not configurable with default/fallback origin server.","example":"sni.example.com"},"custom_page_html":{"type":"string","description":"Only available for the Waiting Room Advanced subscription. This is a template html file that will be rendered at the edge. If no custom_page_html is provided, the default waiting room will be used. The template is based on mustache ( https://mustache.github.io/ ). There are several variables that are evaluated by the Cloudflare edge:\n1. {{`waitTimeKnown`}} Acts like a boolean value that indicates the behavior to take when wait time is not available, for instance when queue_all is **true**. \n2. {{`waitTimeFormatted`}} Estimated wait time for the user. For example, five minutes. Alternatively, you can use: \n3. {{`waitTime`}} Number of minutes of estimated wait for a user.\n4. {{`waitTimeHours`}} Number of hours of estimated wait for a user (`Math.floor(waitTime/60)`). \n5. {{`waitTimeHourMinutes`}} Number of minutes above the `waitTimeHours` value (`waitTime%60`). \n6. {{`queueIsFull`}} Changes to **true** when no more people can be added to the queue.\n\nTo view the full list of variables, look at the `cfWaitingRoom` object described under the `json_response_enabled` property in other Waiting Room API calls.","default":"","example":"{{#waitTimeKnown}} {{waitTime}} mins {{/waitTimeKnown}} {{^waitTimeKnown}} Queue all enabled {{/waitTimeKnown}}"},"custom_pages_response_collection":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"type":"array","items":{"type":"object"}}}}]},"custom_pages_response_single":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"type":"object"}}}]},"custom_profile":{"type":"object","title":"Custom profile","properties":{"created_at":{"$ref":"#/components/schemas/timestamp"},"description":{"type":"string","description":"The description of the profile.","example":"A standard CVV card number"},"entries":{"type":"array","description":"The entries for this profile.","items":{"$ref":"#/components/schemas/custom_entry"}},"id":{"$ref":"#/components/schemas/profile_id"},"name":{"type":"string","description":"The name of the profile.","example":"Generic CVV Card Number"},"type":{"type":"string","description":"The type of the profile.","enum":["custom"],"example":"custom"},"updated_at":{"$ref":"#/components/schemas/timestamp"}}},"custom_profile_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"allOf":[{"$ref":"#/components/schemas/custom_profile"}]}}}]},"custom_response":{"anyOf":[{"type":"object","properties":{"body":{"$ref":"#/components/schemas/body"},"content_type":{"$ref":"#/components/schemas/content_type"}}}],"type":"object","description":"A custom content type and reponse to return when the threshold is exceeded. The custom response configured in this object will override the custom error for the zone. This object is optional.\nNotes: If you omit this object, Cloudflare will use the default HTML error page. If \"mode\" is \"challenge\", \"managed_challenge\", or \"js_challenge\", Cloudflare will use the zone challenge pages and you should not provide the \"response\" object."},"customer_gre_endpoint":{"type":"string","description":"The IP address assigned to the customer side of the GRE tunnel.","example":"203.0.113.1"},"customer_ipsec_endpoint":{"type":"string","description":"The IP address assigned to the customer side of the IPsec tunnel.","example":"203.0.113.1"},"customhostname":{"properties":{"created_at":{"$ref":"#/components/schemas/created_at"},"custom_metadata":{"$ref":"#/components/schemas/custom_metadata"},"custom_origin_server":{"$ref":"#/components/schemas/custom_origin_server"},"custom_origin_sni":{"$ref":"#/components/schemas/custom_origin_sni"},"hostname":{"$ref":"#/components/schemas/hostname"},"id":{"$ref":"#/components/schemas/custom-hostname_components-schemas-identifier"},"ownership_verification":{"$ref":"#/components/schemas/ownership_verification"},"ownership_verification_http":{"$ref":"#/components/schemas/ownership_verification_http"},"ssl":{"$ref":"#/components/schemas/schemas-ssl"},"status":{"$ref":"#/components/schemas/custom-hostname_components-schemas-status"},"verification_errors":{"$ref":"#/components/schemas/verification_errors"}}},"dashboard":{"type":"object","title":"Dashboard response","description":"Totals and timeseries data.","properties":{"timeseries":{"$ref":"#/components/schemas/timeseries"},"totals":{"$ref":"#/components/schemas/totals"}}},"dashboard_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"query":{"$ref":"#/components/schemas/query_response"},"result":{"$ref":"#/components/schemas/dashboard"}}}]},"data_points":{"type":"integer","description":"The number of data points used for the threshold suggestion calculation.","readOnly":true},"datacenters":{"type":"array","title":"Analytics data by datacenter","description":"A breakdown of all dashboard analytics data by co-locations. This is limited to Enterprise zones only.","items":{"type":"object","properties":{"colo_id":{"type":"string","description":"The airport code identifer for the co-location.","example":"SFO"},"timeseries":{"$ref":"#/components/schemas/timeseries_by_colo"},"totals":{"$ref":"#/components/schemas/totals_by_colo"}}}},"dataset":{"type":"string","description":"Dataset to be pulled.","example":"http_requests","nullable":true,"maxLength":256,"pattern":"^[a-zA-Z0-9_\\-]*$"},"days_until_next_rotation":{"type":"number","description":"The number of days until the next key rotation.","example":1,"readOnly":true},"decision":{"type":"string","description":"The action Access will take if a user matches this policy.","enum":["allow","deny","non_identity","bypass"],"example":"allow"},"default":{"type":"number","description":"The default amount allocated.","example":5},"default_device_settings_policy":{"type":"object","properties":{"allow_mode_switch":{"$ref":"#/components/schemas/allow_mode_switch"},"allow_updates":{"$ref":"#/components/schemas/allow_updates"},"allowed_to_leave":{"$ref":"#/components/schemas/allowed_to_leave"},"auto_connect":{"$ref":"#/components/schemas/auto_connect"},"captive_portal":{"$ref":"#/components/schemas/captive_portal"},"default":{"type":"boolean","description":"Whether the policy will be applied to matching devices.","example":true},"disable_auto_fallback":{"$ref":"#/components/schemas/disable_auto_fallback"},"enabled":{"type":"boolean","description":"Whether the policy will be applied to matching devices.","example":true},"exclude":{"$ref":"#/components/schemas/components-schemas-exclude"},"fallback_domains":{"$ref":"#/components/schemas/fallback_domains"},"gateway_unique_id":{"$ref":"#/components/schemas/gateway_unique_id"},"include":{"$ref":"#/components/schemas/schemas-include"},"service_mode_v2":{"$ref":"#/components/schemas/service_mode_v2"},"support_url":{"$ref":"#/components/schemas/support_url"},"switch_locked":{"$ref":"#/components/schemas/switch_locked"}}},"default_device_settings_response":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"$ref":"#/components/schemas/default_device_settings_policy"}}}]},"default_mode":{"description":"The default action/mode of a rule.","enum":["disable","simulate","block","challenge"],"example":"block","readOnly":true},"default_pools":{"type":"array","description":"A list of pool IDs ordered by their failover priority. Pools defined here are used by default, or when region_pools are not configured for a given region.","example":["17b5962d775c646f3f9725cbc7a53df4","9290f38c5d07c2e2f4df57b1f61d4196","00920f38ce07c2e2f4df50b1f61d4194"],"items":{"type":"string","description":"A pool ID."}},"default_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"errors":{"type":"array","items":{}},"messages":{"type":"array","items":{}}}}]},"default_sni":{"type":"string","description":"If you have legacy TLS clients which do not send the TLS server name indicator, then you can specify one default SNI on the map. If Cloudflare receives a TLS handshake from a client without an SNI, it will respond with the default SNI on those IPs. The default SNI can be any valid zone or subdomain owned by the account.","example":"*.example.com","nullable":true},"default_template_language":{"type":"string","description":"The language of the default page template. If no default_template_language is provided, then `en-US` (English) will be used.","enum":["en-US","es-ES","de-DE","fr-FR","it-IT","ja-JP","ko-KR","pt-BR","zh-CN","zh-TW","nl-NL","pl-PL","id-ID","tr-TR","ar-EG"],"default":"en-US","example":"es-ES"},"delegated_account_identifier":{"type":"string","description":"Account identifier for the account to which prefix is being delegated.","example":"b1946ac92492d2347c6235b4d2611184","readOnly":true,"maxLength":32},"delegation_identifier":{"type":"string","description":"Delegation identifier tag.","example":"d933b1530bc56c9953cf8ce166da8004","readOnly":true,"maxLength":32},"delete_advanced_certificate_pack_response_single":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"type":"object","properties":{"result":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/certificate-packs_components-schemas-identifier"}}}}}]},"delete_dnssec_response_single":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"type":"string","example":""}}}]},"delete_filter_if_unused":{"type":"boolean","description":"When true, indicates that Cloudflare should also delete the associated filter if there are no other firewall rules referencing the filter."},"deleted":{"type":"boolean","description":"When true, indicates that the firewall rule was deleted.","example":true},"deleted-filter":{"required":["id","deleted"],"properties":{"deleted":{"$ref":"#/components/schemas/deleted"},"id":{"$ref":"#/components/schemas/filters_components-schemas-id"}}},"deleted_at":{"type":"string","format":"date-time","description":"Date of deletion, if any.","nullable":true,"readOnly":true},"deleted_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"type":"string","example":""}}}]},"deployment-list-response":{"allOf":[{"$ref":"#/components/schemas/api-response-common"},{"properties":{"result_info":{"type":"object","properties":{"count":{"example":1},"page":{"example":1},"per_page":{"example":100},"total_count":{"example":1}}}}},{"properties":{"result":{"type":"array","items":{"type":"object"}}}}]},"deployment-new-deployment":{"allOf":[{"$ref":"#/components/schemas/api-response-common"},{"properties":{"result":{"$ref":"#/components/schemas/deployments"}}}]},"deployment-response-details":{"allOf":[{"$ref":"#/components/schemas/api-response-common"},{"properties":{"result":{"$ref":"#/components/schemas/deployments"}}}]},"deployment-response-logs":{"allOf":[{"$ref":"#/components/schemas/api-response-common"},{"properties":{"result":{"type":"object","example":{"data":[{"line":"Cloning repository...","ts":"2021-04-20T19:35:29.0749819Z"},{"line":"From https://github.com/cloudflare/example","ts":"2021-04-20T19:35:30.0749819Z"},{"line":" * branch 209c5bb11d89533f426b2f8469bcae12fdccf71b -> FETCH_HEAD","ts":"2021-04-20T19:35:30.0749819Z"},{"line":"","ts":"2021-04-20T19:35:30.0749819Z"},{"line":"HEAD is now at 209c5bb Update index.html","ts":"2021-04-20T19:35:30.0749819Z"},{"line":"","ts":"2021-04-20T19:35:30.0749819Z"},{"line":"","ts":"2021-04-20T19:35:30.0749819Z"},{"line":"Success: Finished cloning repository files","ts":"2021-04-20T19:35:30.0749819Z"},{"line":"Installing dependencies","ts":"2021-04-20T19:35:59.0749819Z"},{"line":"Python version set to 2.7","ts":"2021-04-20T19:35:59.0931208Z"},{"line":"v12.18.0 is already installed.","ts":"2021-04-20T19:36:02.2369501Z"},{"line":"Now using node v12.18.0 (npm v6.14.4)","ts":"2021-04-20T19:36:02.6028886Z"},{"line":"Started restoring cached build plugins","ts":"2021-04-20T19:36:02.624555Z"},{"line":"Finished restoring cached build plugins","ts":"2021-04-20T19:36:02.6340688Z"},{"line":"Attempting ruby version 2.7.1, read from environment","ts":"2021-04-20T19:36:02.963095Z"},{"line":"Using ruby version 2.7.1","ts":"2021-04-20T19:36:04.2236084Z"},{"line":"Using PHP version 5.6","ts":"2021-04-20T19:36:04.5450152Z"},{"line":"5.2 is already installed.","ts":"2021-04-20T19:36:04.5740509Z"},{"line":"Using Swift version 5.2","ts":"2021-04-20T19:36:04.577035Z"},{"line":"Installing Hugo 0.54.0","ts":"2021-04-20T19:36:04.5771615Z"},{"line":"Hugo Static Site Generator v0.54.0-B1A82C61A/extended linux/amd64 BuildDate: 2019-02-01T10:04:38Z","ts":"2021-04-20T19:36:05.4786868Z"},{"line":"Started restoring cached go cache","ts":"2021-04-20T19:36:05.4794366Z"},{"line":"Finished restoring cached go cache","ts":"2021-04-20T19:36:05.481977Z"},{"line":"go version go1.14.4 linux/amd64","ts":"2021-04-20T19:36:05.9049776Z"},{"line":"go version go1.14.4 linux/amd64","ts":"2021-04-20T19:36:05.9086053Z"},{"line":"Installing missing commands","ts":"2021-04-20T19:36:05.9163568Z"},{"line":"Verify run directory","ts":"2021-04-20T19:36:05.9163934Z"},{"line":"Executing user command: echo \"skipping build step: no build command specified\"","ts":"2021-04-20T19:36:05.9164636Z"},{"line":"skipping build step: no build command specified","ts":"2021-04-20T19:36:05.9165087Z"},{"line":"Finished","ts":"2021-04-20T19:36:05.917412Z"}],"includes_container_logs":true,"total":30}}}}]},"deployment-response-stage-logs":{"allOf":[{"$ref":"#/components/schemas/api-response-common"},{"properties":{"result":{"type":"object","example":{"data":[{"id":15,"message":"Installing dependencies","timestamp":"2021-04-20T19:35:59.0749819Z"},{"id":16,"message":"Python version set to 2.7","timestamp":"2021-04-20T19:35:59.0931208Z"},{"id":17,"message":"v12.18.0 is already installed.","timestamp":"2021-04-20T19:36:02.2369501Z"},{"id":18,"message":"Now using node v12.18.0 (npm v6.14.4)","timestamp":"2021-04-20T19:36:02.6028886Z"},{"id":19,"message":"Started restoring cached build plugins","timestamp":"2021-04-20T19:36:02.624555Z"},{"id":20,"message":"Finished restoring cached build plugins","timestamp":"2021-04-20T19:36:02.6340688Z"},{"id":21,"message":"Attempting ruby version 2.7.1, read from environment","timestamp":"2021-04-20T19:36:02.963095Z"},{"id":22,"message":"Using ruby version 2.7.1","timestamp":"2021-04-20T19:36:04.2236084Z"},{"id":23,"message":"Using PHP version 5.6","timestamp":"2021-04-20T19:36:04.5450152Z"},{"id":24,"message":"5.2 is already installed.","timestamp":"2021-04-20T19:36:04.5740509Z"},{"id":25,"message":"Using Swift version 5.2","timestamp":"2021-04-20T19:36:04.577035Z"},{"id":26,"message":"Installing Hugo 0.54.0","timestamp":"2021-04-20T19:36:04.5771615Z"},{"id":27,"message":"Hugo Static Site Generator v0.54.0-B1A82C61A/extended linux/amd64 BuildDate: 2019-02-01T10:04:38Z","timestamp":"2021-04-20T19:36:05.4786868Z"},{"id":28,"message":"Started restoring cached go cache","timestamp":"2021-04-20T19:36:05.4794366Z"},{"id":29,"message":"Finished restoring cached go cache","timestamp":"2021-04-20T19:36:05.481977Z"},{"id":30,"message":"go version go1.14.4 linux/amd64","timestamp":"2021-04-20T19:36:05.9049776Z"},{"id":31,"message":"go version go1.14.4 linux/amd64","timestamp":"2021-04-20T19:36:05.9086053Z"},{"id":32,"message":"Installing missing commands","timestamp":"2021-04-20T19:36:05.9163568Z"},{"id":33,"message":"Verify run directory","timestamp":"2021-04-20T19:36:05.9163934Z"},{"id":34,"message":"Executing user command: echo \"skipping build step: no build command specified\"","timestamp":"2021-04-20T19:36:05.9164636Z"},{"id":35,"message":"skipping build step: no build command specified","timestamp":"2021-04-20T19:36:05.9165087Z"},{"id":36,"message":"Finished","timestamp":"2021-04-20T19:36:05.917412Z"}],"end":37,"ended_on":"2021-04-20T19:36:06.38889Z","name":"build","start":0,"started_on":"2021-04-20T19:35:58.238757Z","status":"success","total":37}}}}]},"deployment_configs":{"type":"object","description":"Configs for deployments in a project.","properties":{"preview":{"anyOf":[{"$ref":"#/components/schemas/deployment_configs_values"}],"type":"object","description":"Configs for preview deploys."},"production":{"anyOf":[{"$ref":"#/components/schemas/deployment_configs_values"}],"type":"object","description":"Configs for production deploys."}}},"deployment_configs_values":{"type":"object","properties":{"compatibility_date":{"type":"string","description":"Compatibility date used for Pages Functions.","example":"2022-01-01"},"compatibility_flags":{"type":"array","description":"Compatibility flags used for Pages Functions.","example":["url_standard"]},"d1_databases":{"type":"object","description":"D1 databases used for Pages Functions.","nullable":true,"properties":{"D1_BINDING":{"type":"object","description":"D1 binding.","example":{"id":"445e2955-951a-43f8-a35b-a4d0c8138f63"},"properties":{"id":{"type":"string","description":"UUID of the D1 database.","example":"445e2955-951a-43f8-a35b-a4d0c8138f63"}}}}},"durable_object_namespaces":{"type":"object","description":"Durabble Object namespaces used for Pages Functions.","nullable":true,"properties":{"DO_BINDING":{"type":"object","description":"Durabble Object binding.","example":{"namespace_id":"5eb63bbbe01eeed093cb22bb8f5acdc3"},"properties":{"namespace_id":{"type":"string","description":"ID of the Durabble Object namespace.","example":"5eb63bbbe01eeed093cb22bb8f5acdc3"}}}}},"env_vars":{"type":"object","description":"Environment variables for build configs.","nullable":true,"properties":{"ENVIRONMENT_VARIABLE":{"type":"object","description":"Environment variable.","example":{"type":"plain_text","value":"hello world"},"properties":{"type":{"type":"string","description":"The type of environment variable (plain text or secret)","enum":["plain_text","secret_text"]},"value":{"type":"string","description":"Environment variable value."}}}}},"kv_namespaces":{"type":"object","description":"KV namespaces used for Pages Functions.","properties":{"KV_BINDING":{"type":"object","description":"KV binding.","example":{"namespace_id":"5eb63bbbe01eeed093cb22bb8f5acdc3"},"properties":{"namespace_id":{"type":"string","description":"ID of the KV namespace.","example":"5eb63bbbe01eeed093cb22bb8f5acdc3"}}}}},"r2_buckets":{"type":"object","description":"R2 buckets used for Pages Functions.","nullable":true,"properties":{"R2_BINDING":{"type":"object","description":"R2 binding.","example":{"name":"some-bucket"},"properties":{"name":{"type":"string","description":"Name of the R2 bucket.","example":"some-bucket"}}}}},"service_bindings":{"type":"object","description":"Services used for Pages Functions.","nullable":true,"properties":{"SERVICE_BINDING":{"type":"object","description":"Service binding.","example":{"environment":"production","service":"example-worker"},"properties":{"environment":{"type":"string","description":"The Service environment."},"service":{"type":"string","description":"The Service name."}}}}}}},"deployment_identifier":{"type":"string","example":"bcf48806-b317-4351-9ee7-36e7d557d4de","readOnly":true,"maxLength":36},"deployment_stage_name":{"type":"string","description":"Deployment stage name.","example":"deploy","pattern":"queued|initialize|clone_repo|build|deploy"},"deployments":{"type":"object","properties":{"aliases":{"type":"array","description":"A list of alias URLs pointing to this deployment.","example":["https://branchname.projectname.pages.dev"],"nullable":true,"readOnly":true,"items":{}},"build_config":{"readOnly":true},"created_on":{"type":"string","format":"date-time","description":"When the deployment was created.","example":"2021-03-09T00:55:03.923456Z","readOnly":true},"deployment_trigger":{"type":"object","description":"Info about what caused the deployment.","readOnly":true,"properties":{"metadata":{"type":"object","description":"Additional info about the trigger.","properties":{"branch":{"type":"string","description":"Where the trigger happened.","example":"main","readOnly":true},"commit_hash":{"type":"string","description":"Hash of the deployment trigger commit.","example":"ad9ccd918a81025731e10e40267e11273a263421","readOnly":true},"commit_message":{"type":"string","description":"Message of the deployment trigger commit.","example":"Update index.html","readOnly":true}}},"type":{"type":"string","description":"What caused the deployment.","example":"ad_hoc","readOnly":true,"pattern":"push|ad_hoc"}}},"env_vars":{"type":"object","description":"A dict of env variables to build this deploy.","example":{"BUILD_VERSION":{"value":"3.3"},"ENV":{"value":"STAGING"}},"readOnly":true},"environment":{"type":"string","description":"Type of deploy.","example":"preview","readOnly":true,"pattern":"preview|production"},"id":{"type":"string","description":"Id of the deployment.","example":"f64788e9-fccd-4d4a-a28a-cb84f88f6","readOnly":true},"is_skipped":{"type":"boolean","description":"If the deployment has been skipped.","example":true,"readOnly":true},"latest_stage":{"readOnly":true},"modified_on":{"type":"string","format":"date-time","description":"When the deployment was last modified.","example":"2021-03-09 00:58:59 +0000","readOnly":true},"project_id":{"type":"string","description":"Id of the project.","example":"7b162ea7-7367-4d67-bcde-1160995d5","readOnly":true},"project_name":{"type":"string","description":"Name of the project.","example":"ninjakittens","readOnly":true},"short_id":{"type":"string","description":"Short Id (8 character) of the deployment.","example":"f64788e9","readOnly":true},"source":{"readOnly":true},"stages":{"type":"array","description":"List of past stages.","example":[{"ended_on":"2021-06-03T15:39:03.134378Z","name":"queued","started_on":"2021-06-03T15:38:15.608194Z","status":"active"},{"ended_on":null,"name":"initialize","started_on":null,"status":"idle"},{"ended_on":null,"name":"clone_repo","started_on":null,"status":"idle"},{"ended_on":null,"name":"build","started_on":null,"status":"idle"},{"ended_on":null,"name":"deploy","started_on":null,"status":"idle"}],"readOnly":true,"items":{"$ref":"#/components/schemas/stage"}},"url":{"type":"string","description":"The live URL to view this deployment.","example":"https://f64788e9.ninjakittens.pages.dev","readOnly":true}}},"deployments-list-response":{"allOf":[{"$ref":"#/components/schemas/api-response-common"},{"properties":{"items":{"type":"array","example":[{"id":"bcf48806-b317-4351-9ee7-36e7d557d4de","metadata":{"author_email":"user@example.com","author_id":"408cbcdfd4dda4617efef40b04d168a1","created_on":"2022-11-15T18:25:44.442097Z","modified_on":"2022-11-15T18:25:44.442097Z","source":"api"},"number":2},{"id":"18f97339-c287-4872-9bdd-e2135c07ec12","metadata":{"author_email":"user@example.com","author_id":"408cbcdfd4dda4617efef40b04d168a1","created_on":"2022-11-08T17:30:56.968096Z","modified_on":"2022-11-08T17:30:56.968096Z","source":"api"},"number":1}],"items":{}},"latest":{"type":"object","example":{"id":"bcf48806-b317-4351-9ee7-36e7d557d4de","metadata":{"author_email":"user@example.com","author_id":"408cbcdfd4dda4617efef40b04d168a1","created_on":"2022-11-15T18:25:44.442097Z","modified_on":"2022-11-15T18:25:44.442097Z","source":"api"},"number":2,"resources":{"bindings":[{"json":"example_binding","name":"JSON_VAR","type":"json"}],"script":{"etag":"13a3240e8fb414561b0366813b0b8f42b3e6cfa0d9e70e99835dae83d0d8a794","handlers":["fetch"],"last_deployed_from":"api"},"script_runtime":{"usage_model":"bundled"}}}}}}]},"deployments-single-response":{"allOf":[{"$ref":"#/components/schemas/api-response-common"},{"properties":{"id":{"type":"string","example":"18f97339-c287-4872-9bdd-e2135c07ec12"},"metadata":{"type":"object","example":{"author_email":"user@example.com","author_id":"408cbcdfd4dda4617efef40b04d168a1","created_on":"2022-11-08T17:19:29.176266Z","modified_on":"2022-11-08T17:19:29.176266Z","source":"api"}},"number":{"type":"number","example":1},"resources":{"type":"object","example":{"bindings":[{"json":"example_binding","name":"JSON_VAR","type":"json"}],"script":{"etag":"13a3240e8fb414561b0366813b0b8f42b3e6cfa0d9e70e99835dae83d0d8a794","handlers":["fetch"],"last_deployed_from":"api"},"script_runtime":{"usage_model":"bundled"}}}}}]},"deprecate_any_requests":{"type":"boolean","description":"Deprecate the response to ANY requests.","example":true},"description":{"type":"string","description":"Description of role's permissions.","example":"Administrative access to the entire Organization","readOnly":true},"destination_address_identifier":{"type":"string","description":"Destination address identifier.","example":"ea95132c15732412d22c1476fa83f27a","readOnly":true,"maxLength":32},"destination_address_properties":{"type":"object","properties":{"created":{"$ref":"#/components/schemas/created"},"email":{"$ref":"#/components/schemas/email"},"modified":{"$ref":"#/components/schemas/modified"},"tag":{"$ref":"#/components/schemas/destination_address_identifier"},"verified":{"$ref":"#/components/schemas/verified"}}},"destination_address_response_single":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"type":"object"}}}]},"destination_addresses_response_collection":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/addresses"}},"result_info":{"type":"object","properties":{"count":{"example":1},"page":{"example":1},"per_page":{"example":20},"total_count":{"example":1}}}}}]},"destination_conf":{"type":"string","format":"uri","description":"Uniquely identifies a resource (such as an s3 bucket) where data will be pushed. Additional configuration parameters supported by the destination may be included.","example":"s3://mybucket/logs?region=us-west-2","maxLength":4096},"destination_exists_response":{"allOf":[{"$ref":"#/components/schemas/api-response-common"},{"properties":{"result":{"type":"object","nullable":true,"properties":{"exists":{"type":"boolean","example":false}}}}}]},"detection_mode":{"type":"string","description":"The mode that defines how rules within the package are evaluated during the course of a request. When a package uses anomaly detection mode (`anomaly` value), each rule is given a score when triggered. If the total score of all triggered rules exceeds the sensitivity defined in the WAF package, the action configured in the package will be performed. Traditional detection mode (`traditional` value) will decide the action to take when it is triggered by the request. If multiple rules are triggered, the action providing the highest protection will be applied (for example, a 'block' action will win over a 'challenge' action).","enum":["anomaly","traditional"],"example":"traditional","readOnly":true},"development_mode":{"allOf":[{"$ref":"#/components/schemas/schemas-base"},{"properties":{"id":{"description":"ID of the zone setting.","enum":["development_mode"],"example":"development_mode"},"time_remaining":{"type":"number","description":"Value of the zone setting.\nNotes: The interval (in seconds) from when development mode expires (positive integer) or last expired (negative integer) for the domain. If development mode has never been enabled, this value is false.","example":3600,"readOnly":true},"value":{"$ref":"#/components/schemas/development_mode_value"}}}],"title":"Development Mode","description":"Development Mode temporarily allows you to enter development mode for your websites if you need to make changes to your site. This will bypass Cloudflare's accelerated cache and slow down your site, but is useful if you are making changes to cacheable content (like images, css, or JavaScript) and would like to see those changes right away. Once entered, development mode will last for 3 hours and then automatically toggle off."},"development_mode_value":{"type":"string","description":"Value of the zone setting.","enum":["on","off"],"default":"off"},"device-posture-integrations":{"type":"object","properties":{"config":{"$ref":"#/components/schemas/config_response"},"id":{"$ref":"#/components/schemas/device-posture-integrations_components-schemas-uuid"},"interval":{"$ref":"#/components/schemas/schemas-interval"},"name":{"$ref":"#/components/schemas/device-posture-integrations_components-schemas-name"},"type":{"$ref":"#/components/schemas/device-posture-integrations_components-schemas-type"}}},"device-posture-integrations_components-schemas-id_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"nullable":true}}}]},"device-posture-integrations_components-schemas-identifier":{"example":"699d98642c564d2e855e9661899b7252"},"device-posture-integrations_components-schemas-name":{"type":"string","description":"The name of the Device Posture Integration.","example":"My Workspace One Integration"},"device-posture-integrations_components-schemas-response_collection":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/device-posture-integrations"}}}}]},"device-posture-integrations_components-schemas-single_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/device-posture-integrations"}}}]},"device-posture-integrations_components-schemas-type":{"type":"string","description":"The type of Device Posture Integration.","enum":["workspace_one","crowdstrike_s2s","uptycs","intune"],"example":"workspace_one"},"device-posture-integrations_components-schemas-uuid":{"type":"string","description":"API uuid tag.","example":"f174e90a-fafe-4643-bbbc-4a0ed4fc8415","maxLength":36},"device-posture-rules":{"type":"object","properties":{"description":{"$ref":"#/components/schemas/device-posture-rules_components-schemas-description"},"expiration":{"$ref":"#/components/schemas/schemas-expiration"},"id":{"$ref":"#/components/schemas/device-posture-rules_components-schemas-uuid"},"input":{"$ref":"#/components/schemas/schemas-input"},"match":{"$ref":"#/components/schemas/schemas-match"},"name":{"$ref":"#/components/schemas/device-posture-rules_components-schemas-name"},"schedule":{"$ref":"#/components/schemas/schedule"},"type":{"$ref":"#/components/schemas/device-posture-rules_components-schemas-type"}}},"device-posture-rules_components-schemas-description":{"type":"string","description":"The description of the Device Posture Rule.","example":"The rule for admin serial numbers"},"device-posture-rules_components-schemas-id_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/device-posture-rules_components-schemas-uuid"}}}}}]},"device-posture-rules_components-schemas-identifier":{"example":"699d98642c564d2e855e9661899b7252"},"device-posture-rules_components-schemas-name":{"type":"string","description":"The name of the Device Posture Rule.","example":"Admin Serial Numbers"},"device-posture-rules_components-schemas-response_collection":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/device-posture-rules"}}}}]},"device-posture-rules_components-schemas-single_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/device-posture-rules"}}}]},"device-posture-rules_components-schemas-type":{"type":"string","description":"The type of Device Posture Rule.","enum":["file","application","serial_number","tanium","gateway","warp"],"example":"file"},"device-posture-rules_components-schemas-uuid":{"type":"string","description":"API uuid tag.","example":"f174e90a-fafe-4643-bbbc-4a0ed4fc8415","maxLength":36},"device_posture":{"type":"string","description":"The wirefilter expression to be used for device posture check matching.","example":"any(device_posture.checks.passed[*] in {\"1308749e-fcfb-4ebc-b051-fe022b632644\"})"},"device_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"type":"object"}}}]},"device_settings_policy":{"type":"object","properties":{"allow_mode_switch":{"$ref":"#/components/schemas/allow_mode_switch"},"allow_updates":{"$ref":"#/components/schemas/allow_updates"},"allowed_to_leave":{"$ref":"#/components/schemas/allowed_to_leave"},"auto_connect":{"$ref":"#/components/schemas/auto_connect"},"captive_portal":{"$ref":"#/components/schemas/captive_portal"},"default":{"$ref":"#/components/schemas/schemas-default"},"disable_auto_fallback":{"$ref":"#/components/schemas/disable_auto_fallback"},"enabled":{"type":"boolean","description":"Whether the policy will be applied to matching devices.","example":true},"exclude":{"$ref":"#/components/schemas/components-schemas-exclude"},"fallback_domains":{"$ref":"#/components/schemas/fallback_domains"},"gateway_unique_id":{"$ref":"#/components/schemas/gateway_unique_id"},"include":{"$ref":"#/components/schemas/schemas-include"},"match":{"$ref":"#/components/schemas/components-schemas-match"},"name":{"type":"string","description":"The name of the device settings policy.","example":"Allow Developers","maxLength":100},"policy_id":{"$ref":"#/components/schemas/uuid"},"precedence":{"$ref":"#/components/schemas/components-schemas-precedence"},"service_mode_v2":{"$ref":"#/components/schemas/service_mode_v2"},"support_url":{"$ref":"#/components/schemas/support_url"},"switch_locked":{"$ref":"#/components/schemas/switch_locked"}}},"device_settings_response":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"$ref":"#/components/schemas/device_settings_policy"}}}]},"device_settings_response_collection":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/device_settings_policy"}}}}]},"devices":{"type":"object","properties":{"created":{"$ref":"#/components/schemas/devices_components-schemas-created"},"deleted":{"$ref":"#/components/schemas/schemas-deleted"},"device_type":{"$ref":"#/components/schemas/platform"},"id":{"$ref":"#/components/schemas/devices_components-schemas-uuid"},"ip":{"$ref":"#/components/schemas/devices_components-schemas-ip"},"key":{"$ref":"#/components/schemas/schemas-key"},"last_seen":{"$ref":"#/components/schemas/last_seen"},"mac_address":{"$ref":"#/components/schemas/mac_address"},"manufacturer":{"$ref":"#/components/schemas/manufacturer"},"model":{"$ref":"#/components/schemas/model"},"name":{"$ref":"#/components/schemas/devices_components-schemas-name"},"os_distro_name":{"$ref":"#/components/schemas/os_distro_name"},"os_distro_revision":{"$ref":"#/components/schemas/os_distro_revision"},"os_version":{"$ref":"#/components/schemas/os_version"},"revoked_at":{"$ref":"#/components/schemas/revoked_at"},"serial_number":{"$ref":"#/components/schemas/schemas-serial_number"},"updated":{"$ref":"#/components/schemas/updated"},"user":{"$ref":"#/components/schemas/user"},"version":{"$ref":"#/components/schemas/devices_components-schemas-version"}}},"devices_components-schemas-created":{"type":"string","format":"date-time","description":"When the device was created.","example":"2017-06-14T00:00:00Z"},"devices_components-schemas-identifier":{"example":"699d98642c564d2e855e9661899b7252"},"devices_components-schemas-ip":{"type":"string","description":"IPv4 or IPv6 address.","example":"1.1.1.1"},"devices_components-schemas-name":{"type":"string","description":"The device name.","example":"My mobile device"},"devices_components-schemas-uuid":{"type":"string","description":"Device ID.","example":"f174e90a-fafe-4643-bbbc-4a0ed4fc8415","maxLength":36},"devices_components-schemas-version":{"type":"string","description":"The WARP client version.","example":"1.0.0"},"devices_response":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/devices"}}}}]},"dimension_value":{"anyOf":[{"type":"object","description":"Dimension value, may contain dimension identifier for drill down.","required":["name"],"properties":{"id":{"type":"string","description":"Dimension value identifier that can be used for drill down."},"name":{"type":"string","description":"Dimension value.","example":"NODATA"}}},{"type":"string","description":"Dimension value.","example":"NODATA"}]},"direct_upload_request":{"type":"object","required":["maxDurationSeconds"],"properties":{"allowedOrigins":{"$ref":"#/components/schemas/allowedOrigins"},"creator":{"$ref":"#/components/schemas/creator"},"expiry":{"type":"string","format":"date-time","description":"The date and time after upload when videos will not be accepted.","default":"Now + 30 minutes","example":"2021-01-02T02:20:00Z"},"maxDurationSeconds":{"type":"integer","description":"Calculates the amount of time a video occupies before the video is uploaded. Direct uploads occupy minutes of videos on your Stream account until they are expired. After upload, the upload duration is used instead. If a video longer than the value is uploaded, the video results in an error.","minimum":1,"maximum":21600},"requireSignedURLs":{"$ref":"#/components/schemas/requireSignedURLs"},"thumbnailTimestampPct":{"$ref":"#/components/schemas/thumbnailTimestampPct"},"watermark":{"$ref":"#/components/schemas/watermark_at_upload"}}},"direct_upload_request_v2":{"type":"object","properties":{"expiry":{"type":"string","format":"date-time","description":"The date after which the upload will not be accepted. Minimum: Now + 2 minutes. Maximum: Now + 6 hours.","default":"Now + 30 minutes","example":"2021-01-02T02:20:00Z"},"metadata":{"type":"object","description":"User modifiable key-value store. Can be used for keeping references to another system of record, for managing images."},"requireSignedURLs":{"type":"boolean","description":"Indicates whether the image requires a signature token to be accessed.","default":false,"example":true}}},"direct_upload_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"properties":{"uid":{"$ref":"#/components/schemas/videos_components-schemas-identifier"},"uploadURL":{"type":"string","description":"The URL an unauthenticated upload can use for a single `HTTP POST multipart/form-data` request.","example":"www.example.com/samplepath"},"watermark":{"$ref":"#/components/schemas/watermarks"}}}}}]},"direct_upload_response_v2":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"properties":{"id":{"type":"string","description":"Image unique identifier.","example":"e22e9e6b-c02b-42fd-c405-6c32af5fe600","readOnly":true,"maxLength":32},"uploadURL":{"type":"string","description":"The URL the unauthenticated upload can be performed to using a single HTTP POST (multipart/form-data) request.","example":"https://upload.imagedelivery.net/FxUufywByo0m2v3xhKSiU8/e22e9e6b-c02b-42fd-c405-6c32af5fe600"}}}}}]},"disable_auto_fallback":{"type":"boolean","description":"If the dns_server field of a fallback domain is not present, the client will fall back to a best guess of the default/system DNS resolvers, unless this policy option is set.","example":true},"disable_for_time":{"type":"object","properties":{"1":{"description":"Override code that is valid for 1 hour.","example":"9106681"},"3":{"description":"Override code that is valid for 3 hours.","example":"5356247"},"6":{"description":"Override code that is valid for 6 hours.","example":"9478972"},"12":{"description":"Override code that is valid for 12 hour2.","example":"3424359"},"24":{"description":"Override code that is valid for 24 hour.2.","example":"2887634"}}},"disable_session_renewal":{"type":"boolean","description":"Only available for the Waiting Room Advanced subscription. Disables automatic renewal of session cookies. If `true`, an accepted user will have session_duration minutes to browse the site. After that, they will have to go through the waiting room again. If `false`, a user's session cookie will be automatically renewed on every request.","default":false,"example":false},"disable_transfer_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/disable_transfer_result"}}}]},"disable_transfer_result":{"type":"string","description":"The zone transfer status of a primary zone","example":"Disabled"},"disabled":{"type":"boolean","description":"When true, indicates that the rate limit is currently disabled.","example":false},"disabled_at":{"type":"string","format":"date-time","description":"This field shows up only if the origin is disabled. This field is set with the time the origin was disabled.","readOnly":true},"display_name":{"type":"string","description":"Alert type name.","example":"Origin Error Rate Alert"},"dlq_name":{"type":"string","example":"example-dlq"},"dns":{"type":"object","description":"The name and type of DNS record for the Spectrum application.","properties":{"name":{"$ref":"#/components/schemas/dns_name"},"type":{"$ref":"#/components/schemas/dns_type"}}},"dns-firewall":{"type":"object","required":["id","name","origin_ips","dns_firewall_ips","minimum_cache_ttl","maximum_cache_ttl","deprecate_any_requests","ecs_fallback","modified_on"],"properties":{"attack_mitigation":{"$ref":"#/components/schemas/attack_mitigation"},"deprecate_any_requests":{"$ref":"#/components/schemas/deprecate_any_requests"},"dns_firewall_ips":{"$ref":"#/components/schemas/dns_firewall_ips"},"ecs_fallback":{"$ref":"#/components/schemas/ecs_fallback"},"id":{"$ref":"#/components/schemas/common_components-schemas-identifier"},"maximum_cache_ttl":{"$ref":"#/components/schemas/maximum_cache_ttl"},"minimum_cache_ttl":{"$ref":"#/components/schemas/minimum_cache_ttl"},"modified_on":{"$ref":"#/components/schemas/schemas-modified_on"},"name":{"$ref":"#/components/schemas/dns-firewall_components-schemas-name"},"negative_cache_ttl":{"$ref":"#/components/schemas/negative_cache_ttl"},"origin_ips":{"$ref":"#/components/schemas/origin_ips"},"ratelimit":{"$ref":"#/components/schemas/ratelimit"}}},"dns-firewall_components-schemas-name":{"type":"string","description":"DNS Firewall Cluster Name.","example":"My Awesome DNS Firewall cluster","maxLength":160},"dns-record":{"oneOf":[{"$ref":"#/components/schemas/ARecord"},{"$ref":"#/components/schemas/AAAARecord"},{"$ref":"#/components/schemas/CNAMERecord"},{"$ref":"#/components/schemas/HTTPSRecord"},{"$ref":"#/components/schemas/NSRecord"},{"$ref":"#/components/schemas/MXRecord"},{"$ref":"#/components/schemas/TXTRecord"},{"$ref":"#/components/schemas/LOCRecord"},{"$ref":"#/components/schemas/SRVRecord"},{"$ref":"#/components/schemas/CERTRecord"},{"$ref":"#/components/schemas/DNSKEYRecord"},{"$ref":"#/components/schemas/DSRecord"},{"$ref":"#/components/schemas/NAPTRRecord"},{"$ref":"#/components/schemas/SMIMEARecord"},{"$ref":"#/components/schemas/SSHFPRecord"},{"$ref":"#/components/schemas/SVCBRecord"},{"$ref":"#/components/schemas/TLSARecord"},{"$ref":"#/components/schemas/URIRecord"}],"type":"object","required":["id","type","name","content","proxiable","proxied","ttl","locked","zone_name","created_on","modified_on"]},"dns-record_components-schemas-base":{"properties":{"content":{"$ref":"#/components/schemas/content"},"created_on":{"type":"string","format":"date-time","description":"When the record was created.","example":"2014-01-01T05:20:00.12345Z","readOnly":true},"data":{"type":"object","description":"Metadata about the record.","example":{}},"id":{"$ref":"#/components/schemas/dns-record_components-schemas-identifier"},"locked":{"type":"boolean","description":"Whether this record can be modified/deleted (true means it's managed by Cloudflare).","example":false,"readOnly":true},"meta":{"type":"object","description":"Extra Cloudflare-specific information about the record.","properties":{"auto_added":{"type":"boolean","description":"Will exist if Cloudflare automatically added this DNS record during initial setup.","example":true},"source":{"type":"string","description":"Where the record originated from.","example":"primary"}}},"modified_on":{"type":"string","format":"date-time","description":"When the record was last modified.","example":"2014-01-01T05:20:00.12345Z","readOnly":true},"name":{"$ref":"#/components/schemas/dns-record_components-schemas-name"},"proxiable":{"type":"boolean","description":"Whether the record can be proxied by Cloudflare or not.","example":true,"readOnly":true},"proxied":{"$ref":"#/components/schemas/proxied"},"ttl":{"$ref":"#/components/schemas/ttl"},"type":{"$ref":"#/components/schemas/dns-record_components-schemas-type"},"zone_id":{"$ref":"#/components/schemas/common_components-schemas-identifier"},"zone_name":{"type":"string","format":"hostname","description":"The domain of the record.","example":"example.com","readOnly":true}}},"dns-record_components-schemas-identifier":{"type":"string","description":"DNS record identifier tag.","example":"372e67954025e0ba6aaa6d586b9e0b59","readOnly":true,"maxLength":32},"dns-record_components-schemas-name":{"type":"string","description":"DNS record name (or @ for the zone apex).","example":"example.com","maxLength":255},"dns-record_components-schemas-type":{"type":"string","description":"DNS record type.","enum":["A","AAAA","CNAME","HTTPS","TXT","SRV","LOC","MX","NS","CERT","DNSKEY","DS","NAPTR","SMIMEA","SSHFP","SVCB","TLSA","URI"],"example":"A","readOnly":true},"dns-secondary-primary-zone_components-schemas-identifier":{"example":"269d8f4853475ca241c4e730be286b20"},"dns-secondary-primary-zone_components-schemas-name":{"type":"string","description":"Zone name.","example":"www.example.com."},"dns-secondary-secondary-zone":{"type":"object","required":["id","name","peers","auto_refresh_seconds"],"properties":{"auto_refresh_seconds":{"$ref":"#/components/schemas/auto_refresh_seconds"},"id":{"$ref":"#/components/schemas/dns-secondary-secondary-zone_components-schemas-identifier"},"name":{"$ref":"#/components/schemas/dns-secondary-secondary-zone_components-schemas-name"},"peers":{"$ref":"#/components/schemas/peers"}}},"dns-secondary-secondary-zone_components-schemas-identifier":{"example":"269d8f4853475ca241c4e730be286b20"},"dns-secondary-secondary-zone_components-schemas-name":{"type":"string","description":"Zone name.","example":"www.example.com."},"dns-settings_response_collection":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/schemas-dns-record"}}}}]},"dns_firewall_ips":{"type":"array","example":["203.0.113.1","203.0.113.254","2001:DB8:AB::CF","2001:DB8:CD::CF"],"items":{"anyOf":[{"type":"string","format":"ipv4","description":"Origin DNS Server IPv4 Address.","example":"203.0.113.1"},{"type":"string","format":"ipv6","description":"Origin DNS Server IPv6 Address.","example":"2001:DB8:ab::CF"}]}},"dns_firewall_response_collection":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/dns-firewall"}}}}]},"dns_firewall_single_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/dns-firewall"}}}]},"dns_name":{"type":"string","format":"hostname","description":"The name of the DNS record associated with the application.","example":"ssh.example.com"},"dns_response_collection":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"type":"object","properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/dns-record"}}}}]},"dns_response_import_scan":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"type":"object","properties":{"result":{"type":"object","properties":{"recs_added":{"type":"number","description":"Number of DNS records added.","example":5},"total_records_parsed":{"type":"number","description":"Total number of DNS records parsed.","example":5}}},"timing":{"type":"object","properties":{"end_time":{"type":"string","format":"date-time","description":"When the file parsing ended.","example":"2014-03-01T12:20:01Z"},"process_time":{"type":"number","description":"Processing time of the file in seconds.","example":1},"start_time":{"type":"string","format":"date-time","description":"When the file parsing started.","example":"2014-03-01T12:20:00Z"}}}}}]},"dns_response_single":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"type":"object","properties":{"result":{"type":"object"}}}]},"dns_ttl":{"type":"integer","description":"The TTL of our resolution of your DNS record in seconds.","minimum":600},"dns_type":{"type":"string","description":"The type of DNS record associated with the application.","enum":["CNAME","ADDRESS"],"example":"CNAME"},"dnslink":{"type":"string","description":"DNSLink value used if the target is ipfs.","example":"/ipns/onboarding.ipfs.cloudflare.com"},"dnssec_response_single":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"type":"object"}}}]},"domain":{"type":"object","properties":{"environment":{"$ref":"#/components/schemas/environment"},"hostname":{"$ref":"#/components/schemas/components-schemas-hostname"},"id":{"$ref":"#/components/schemas/domain_identifier"},"service":{"$ref":"#/components/schemas/service"},"zone_id":{"$ref":"#/components/schemas/zone_identifier"},"zone_name":{"$ref":"#/components/schemas/zone_name"}}},"domain-history":{"properties":{"categorizations":{"type":"array","items":{"type":"object","properties":{"categories":{"example":[{"id":155,"name":"Technology"}]},"end":{"type":"string","format":"date","example":"2021-04-30"},"start":{"type":"string","format":"date","example":"2021-04-01"}}}},"domain":{"$ref":"#/components/schemas/schemas-domain_name"}}},"domain-response-collection":{"allOf":[{"$ref":"#/components/schemas/api-response-common"},{"properties":{"result_info":{"type":"object","properties":{"count":{"example":1},"page":{"example":1},"per_page":{"example":100},"total_count":{"example":1}}}}},{"properties":{"result":{"type":"array","items":{"type":"object"}}}}]},"domain-response-single":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"type":"object"}}}]},"domain_components-schemas-domain":{"properties":{"additional_information":{"$ref":"#/components/schemas/additional_information"},"application":{"$ref":"#/components/schemas/schemas-application"},"content_categories":{"$ref":"#/components/schemas/content_categories"},"domain":{"$ref":"#/components/schemas/schemas-domain_name"},"popularity_rank":{"$ref":"#/components/schemas/popularity_rank"},"resolves_to_refs":{"$ref":"#/components/schemas/resolves_to_refs"},"risk_score":{"$ref":"#/components/schemas/risk_score"},"risk_types":{"$ref":"#/components/schemas/risk_types"}}},"domain_components-schemas-single_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/domain_components-schemas-domain"}}}]},"domain_identifier":{"description":"Identifer of the Worker Domain.","example":"dbe10b4bc17c295377eabd600e1787fd"},"domain_name":{"type":"string","description":"Name of the domain.","example":"this-is-my-domain-01.com","pattern":"^[a-z0-9][a-z0-9-]*$"},"domain_names":{"type":"array","description":"List of domain names.","example":["cloudflare.com","cloudflare.net"],"items":{"type":"string"}},"domain_properties":{"type":"object","properties":{"available":{"$ref":"#/components/schemas/schemas-available"},"can_register":{"$ref":"#/components/schemas/can_register"},"created_at":{"$ref":"#/components/schemas/components-schemas-created_at"},"current_registrar":{"$ref":"#/components/schemas/current_registrar"},"expires_at":{"$ref":"#/components/schemas/expires_at"},"id":{"$ref":"#/components/schemas/schemas-domain_identifier"},"locked":{"$ref":"#/components/schemas/locked"},"registrant_contact":{"$ref":"#/components/schemas/registrant_contact"},"registry_statuses":{"$ref":"#/components/schemas/registry_statuses"},"supported_tld":{"$ref":"#/components/schemas/supported_tld"},"transfer_in":{"$ref":"#/components/schemas/transfer_in"},"updated_at":{"$ref":"#/components/schemas/components-schemas-updated_at"}}},"domain_response_collection":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/domains"}}}}]},"domain_response_single":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"type":"object"}}}]},"domain_rule":{"type":"object","title":"Email domain","description":"Match an entire email domain.","required":["email_domain"],"properties":{"email_domain":{"type":"object","required":["domain"],"properties":{"domain":{"type":"string","description":"The email domain to match.","example":"example.com"}}}}},"domain_update_properties":{"type":"object","properties":{"auto_renew":{"$ref":"#/components/schemas/auto_renew"},"locked":{"$ref":"#/components/schemas/locked"},"name_servers":{"$ref":"#/components/schemas/name_servers"},"privacy":{"$ref":"#/components/schemas/privacy"}}},"domains":{"allOf":[{"$ref":"#/components/schemas/domain_properties"}],"type":"object"},"domains-post":{"example":{"name":"example.com"}},"domains_components-schemas-account_identifier":{"example":"9a7806061c88ada191ed06f989cc3dac"},"downloadedFrom":{"type":"string","description":"The source URL for a downloaded image. If the watermark profile was created via direct upload, this field is null.","example":"https://company.com/logo.png","readOnly":true},"downloads_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"type":"object"}}}]},"duration":{"type":"number","description":"The duration of the plan subscription.","example":1},"early_hints":{"allOf":[{"$ref":"#/components/schemas/schemas-base"},{"properties":{"id":{"description":"ID of the zone setting.","enum":["early_hints"],"example":"early_hints"},"value":{"$ref":"#/components/schemas/early_hints_value"}}}],"title":"Early Hints","description":"When enabled, Cloudflare will attempt to speed up overall page loads by serving `103` responses with `Link` headers from the final response. Refer to [Early Hints](https://developers.cloudflare.com/cache/about/early-hints) for more information."},"early_hints_value":{"type":"string","description":"Value of the zone setting.","enum":["on","off"],"default":"off"},"ecs-support":{"type":"boolean","description":"Set if the location needs to resolve EDNS queries.","example":false},"ecs_fallback":{"type":"boolean","description":"Forward client IP (resolver) subnet if no EDNS Client Subnet is sent.","example":false},"edge_cache_ttl":{"allOf":[{"$ref":"#/components/schemas/schemas-base"},{"properties":{"id":{"description":"ID of the zone setting.","enum":["edge_cache_ttl"],"example":"edge_cache_ttl"},"value":{"$ref":"#/components/schemas/edge_cache_ttl_value"}}}],"title":"Edge Cache TTL","description":"Time (in seconds) that a resource will be ensured to remain on Cloudflare's cache servers."},"edge_cache_ttl_value":{"type":"number","description":"Value of the zone setting.\nNotes: The minimum TTL available depends on the plan level of the zone. (Enterprise = 30, Business = 1800, Pro = 3600, Free = 7200)","enum":[30,60,300,1200,1800,3600,7200,10800,14400,18000,28800,43200,57600,72000,86400,172800,259200,345600,432000,518400,604800],"default":7200},"edge_ips":{"oneOf":[{"type":"object","properties":{"connectivity":{"type":"string","description":"The IP versions supported for inbound connections on Spectrum anycast IPs.","enum":["all","ipv4","ipv6"],"example":"all"},"type":{"type":"string","description":"The type of edge IP configuration specified. Dynamically allocated edge IPs use Spectrum anycast IPs in accordance with the connectivity you specify. Only valid with CNAME DNS names.","enum":["dynamic"],"example":"dynamic"}}},{"type":"object","properties":{"ips":{"type":"array","description":"The array of customer owned IPs we broadcast via anycast for this hostname and application.","example":["192.0.2.1"],"items":{"type":"string","description":"Edge anycast IPs.","example":"192.0.2.1"}},"type":{"type":"string","description":"The type of edge IP configuration specified. Statically allocated edge IPs use customer IPs in accordance with the ips array you specify. Only valid with ADDRESS DNS names.","enum":["static"],"example":"static"}}}],"description":"The anycast edge IP configuration for the hostname of this application.","default":{"connectivity":"all","type":"dynamic"}},"editable":{"type":"boolean","description":"Whether or not this setting can be modified for this zone (based on your Cloudflare plan level).","enum":[true,false],"default":true,"readOnly":true},"effect":{"type":"string","description":"Allow or deny operations against the resources.","enum":["allow","deny"],"example":"allow"},"either_profile_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"anyOf":[{"$ref":"#/components/schemas/predefined_profile"},{"$ref":"#/components/schemas/custom_profile"}]}}}]},"eligibility":{"type":"object","properties":{"eligible":{"$ref":"#/components/schemas/eligible"},"ready":{"$ref":"#/components/schemas/ready"},"type":{"$ref":"#/components/schemas/eligibility_components-schemas-type"}}},"eligibility_components-schemas-response_collection":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"type":"object","example":{"email":{"eligible":true,"ready":true,"type":"email"}}}}}]},"eligibility_components-schemas-type":{"type":"string","description":"Determines type of delivery mechanism.","enum":["email","pagerduty","webhook"],"example":"email"},"eligible":{"type":"boolean","description":"Determines whether or not the account is eligible for the delivery mechanism.","example":true},"email":{"type":"string","description":"The contact email address of the user.","example":"user@example.com","maxLength":90},"email-settings_response_single":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"type":"object"}}}]},"email_obfuscation":{"allOf":[{"$ref":"#/components/schemas/schemas-base"},{"properties":{"id":{"description":"ID of the zone setting.","enum":["email_obfuscation"],"example":"email_obfuscation"},"value":{"$ref":"#/components/schemas/email_obfuscation_value"}}}],"title":"Email Obfuscation","description":"Encrypt email adresses on your web page from bots, while keeping them visible to humans. (https://support.cloudflare.com/hc/en-us/articles/200170016)."},"email_obfuscation_value":{"type":"string","description":"Value of the zone setting.","enum":["on","off"],"default":"on"},"email_rule":{"type":"object","title":"Email","description":"Matches a specific email.","required":["email"],"properties":{"email":{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","description":"The email of the user.","example":"test@example.com"}}}}},"empty_response":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"type":"object","properties":{"result":{"type":"array","maxItems":0,"items":{}}}}]},"enable_binding_cookie":{"type":"boolean","description":"Enables the binding cookie, which increases security against compromised authorization tokens and CSRF attacks.","default":false},"enable_transfer_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/enable_transfer_result"}}}]},"enable_transfer_result":{"type":"string","description":"The zone transfer status of a primary zone","example":"Enabled"},"enabled":{"type":"boolean","description":"Flag that indicates if the job was enabled.","example":false},"enabled_download_phase":{"type":"boolean","description":"Set to enable antivirus scan on downloads.","example":false},"enabled_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"properties":{"enabled":{"$ref":"#/components/schemas/zone-authenticated-origin-pull_components-schemas-enabled"}}}}}]},"enabled_upload_phase":{"type":"boolean","description":"Set to enable antivirus scan on uploads.","example":false},"end_time_seconds":{"type":"integer","description":"Specifies the end time for the video clip in seconds.","readOnly":true},"endpoint":{"type":"string","format":"uri-template","description":"The endpoint which can contain path parameter templates in curly braces, each will be replaced from left to right with {varN}, starting with {var1}, during insertion. This will further be Cloudflare-normalized upon insertion. See: https://developers.cloudflare.com/rules/normalization/how-it-works/.","example":"/api/v1/users/{var1}","maxLength":4096,"pattern":"^/.*$"},"entry_id":{"allOf":[{"$ref":"#/components/schemas/uuid"}],"description":"The ID for this entry","example":"719d1215-260f-41d0-8c32-eb320ad107f7"},"environment":{"type":"string","description":"Worker environment associated with the zone and hostname.","example":"production"},"error":{"type":"string","description":"Errors resulting from collecting traceroute from colo to target.","enum":["","Could not gather traceroute data: Code 1","Could not gather traceroute data: Code 2","Could not gather traceroute data: Code 3","Could not gather traceroute data: Code 4"],"example":""},"errorReasonCode":{"type":"string","description":"Specifies why the video failed to encode. This field is empty if the video is not in an `error` state. Preferred for programmatic use.","example":"ERR_NON_VIDEO","readOnly":true},"errorReasonText":{"type":"string","description":"Specifies why the video failed to encode using a human readable error message in English. This field is empty if the video is not in an `error` state.","example":"The file was not recognized as a valid video file.","readOnly":true},"estimated_queued_users":{"type":"integer"},"estimated_total_active_users":{"type":"integer"},"event_custom_page_html":{"type":"string","description":"If set, the event will override the waiting room's `custom_page_html` property while it is active. If null, the event will inherit it.","example":"{{#waitTimeKnown}} {{waitTime}} mins {{/waitTimeKnown}} {{^waitTimeKnown}} Event is prequeueing / Queue all enabled {{/waitTimeKnown}}","nullable":true},"event_description":{"type":"string","description":"A note that you can use to add more details about the event.","default":"","example":"Production event - DO NOT MODIFY"},"event_details_custom_page_html":{"type":"string","example":"{{#waitTimeKnown}} {{waitTime}} mins {{/waitTimeKnown}} {{^waitTimeKnown}} Event is prequeueing / Queue all enabled {{/waitTimeKnown}}"},"event_details_disable_session_renewal":{"type":"boolean","example":false},"event_details_new_users_per_minute":{"type":"integer"},"event_details_queueing_method":{"type":"string","example":"random"},"event_details_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/event_details_result"}}}]},"event_details_result":{"type":"object","properties":{"created_on":{"$ref":"#/components/schemas/timestamp"},"custom_page_html":{"$ref":"#/components/schemas/event_details_custom_page_html"},"description":{"$ref":"#/components/schemas/event_description"},"disable_session_renewal":{"$ref":"#/components/schemas/event_details_disable_session_renewal"},"event_end_time":{"$ref":"#/components/schemas/event_end_time"},"event_start_time":{"$ref":"#/components/schemas/event_start_time"},"id":{"$ref":"#/components/schemas/event_id"},"modified_on":{"$ref":"#/components/schemas/timestamp"},"name":{"$ref":"#/components/schemas/event_name"},"new_users_per_minute":{"$ref":"#/components/schemas/event_details_new_users_per_minute"},"prequeue_start_time":{"$ref":"#/components/schemas/event_prequeue_start_time"},"queueing_method":{"$ref":"#/components/schemas/event_details_queueing_method"},"session_duration":{"$ref":"#/components/schemas/event_details_session_duration"},"shuffle_at_event_start":{"$ref":"#/components/schemas/event_shuffle_at_event_start"},"suspended":{"$ref":"#/components/schemas/event_suspended"},"total_active_users":{"$ref":"#/components/schemas/event_details_total_active_users"}}},"event_details_session_duration":{"type":"integer"},"event_details_total_active_users":{"type":"integer"},"event_disable_session_renewal":{"type":"boolean","description":"If set, the event will override the waiting room's `disable_session_renewal` property while it is active. If null, the event will inherit it.","nullable":true},"event_end_time":{"type":"string","description":"An ISO 8601 timestamp that marks the end of the event.","example":"2021-09-28T17:00:00.000Z"},"event_id":{"example":"25756b2dfe6e378a06b033b670413757"},"event_id_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/event_id"}}}}}]},"event_name":{"type":"string","description":"A unique name to identify the event. Only alphanumeric characters, hyphens and underscores are allowed.","example":"production_webinar_event"},"event_new_users_per_minute":{"type":"integer","description":"If set, the event will override the waiting room's `new_users_per_minute` property while it is active. If null, the event will inherit it. This can only be set if the event's `total_active_users` property is also set.","nullable":true,"minimum":200,"maximum":2147483647.0},"event_prequeue_start_time":{"type":"string","description":"An ISO 8601 timestamp that marks when to begin queueing all users before the event starts. The prequeue must start at least five minutes before `event_start_time`.","example":"2021-09-28T15:00:00.000Z","nullable":true},"event_queueing_method":{"type":"string","description":"If set, the event will override the waiting room's `queueing_method` property while it is active. If null, the event will inherit it.","example":"random","nullable":true},"event_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/event_result"}}}]},"event_response_collection":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/event_result"}}}}]},"event_result":{"type":"object","properties":{"created_on":{"$ref":"#/components/schemas/timestamp"},"custom_page_html":{"$ref":"#/components/schemas/event_custom_page_html"},"description":{"$ref":"#/components/schemas/event_description"},"disable_session_renewal":{"$ref":"#/components/schemas/event_disable_session_renewal"},"event_end_time":{"$ref":"#/components/schemas/event_end_time"},"event_start_time":{"$ref":"#/components/schemas/event_start_time"},"id":{"$ref":"#/components/schemas/event_id"},"modified_on":{"$ref":"#/components/schemas/timestamp"},"name":{"$ref":"#/components/schemas/event_name"},"new_users_per_minute":{"$ref":"#/components/schemas/event_new_users_per_minute"},"prequeue_start_time":{"$ref":"#/components/schemas/event_prequeue_start_time"},"queueing_method":{"$ref":"#/components/schemas/event_queueing_method"},"session_duration":{"$ref":"#/components/schemas/event_session_duration"},"shuffle_at_event_start":{"$ref":"#/components/schemas/event_shuffle_at_event_start"},"suspended":{"$ref":"#/components/schemas/event_suspended"},"total_active_users":{"$ref":"#/components/schemas/event_total_active_users"}}},"event_session_duration":{"type":"integer","description":"If set, the event will override the waiting room's `session_duration` property while it is active. If null, the event will inherit it.","nullable":true,"minimum":1,"maximum":30},"event_shuffle_at_event_start":{"type":"boolean","description":"If enabled, users in the prequeue will be shuffled randomly at the `event_start_time`. Requires that `prequeue_start_time` is not null. This is useful for situations when many users will join the event prequeue at the same time and you want to shuffle them to ensure fairness. Naturally, it makes the most sense to enable this feature when the `queueing_method` during the event respects ordering such as **fifo**, or else the shuffling may be unnecessary.","default":false},"event_start_time":{"type":"string","description":"An ISO 8601 timestamp that marks the start of the event. At this time, queued users will be processed with the event's configuration. The start time must be at least one minute before `event_end_time`.","example":"2021-09-28T15:30:00.000Z"},"event_suspended":{"type":"boolean","description":"Suspends or allows an event. If set to `true`, the event is ignored and traffic will be handled based on the waiting room configuration.","default":false},"event_total_active_users":{"type":"integer","description":"If set, the event will override the waiting room's `total_active_users` property while it is active. If null, the event will inherit it. This can only be set if the event's `new_users_per_minute` property is also set.","nullable":true,"minimum":200,"maximum":2147483647.0},"everyone_rule":{"type":"object","title":"Everyone","description":"Matches everyone.","required":["everyone"],"properties":{"everyone":{"type":"object","description":"An empty object which matches on all users.","example":{}}}},"exclude":{"type":"array","description":"Rules evaluated with a NOT logical operator. To match a policy, a user cannot meet any of the Exclude rules.","items":{"$ref":"#/components/schemas/rule_components-schemas-rule"}},"expected_body":{"type":"string","description":"A case-insensitive sub-string to look for in the response body. If this string is not found, the origin will be marked as unhealthy. This parameter is only valid for HTTP and HTTPS monitors.","example":"alive"},"expected_codes":{"type":"string","description":"The expected HTTP response code or code range of the health check. This parameter is only valid for HTTP and HTTPS monitors.","default":"200","example":"2xx"},"expiration":{"type":"number","description":"The time, measured in number of seconds since the UNIX epoch, at which the key should expire.","example":1578435000.0},"expiration_ttl":{"type":"number","description":"The number of seconds for which the key should be visible before it expires. At least 60.","example":300},"expires_at":{"type":"string","format":"date-time","description":"Shows when domain name registration expires.","example":"2019-08-28T23:59:59Z"},"expires_on":{"type":"string","format":"date-time","description":"The expiration time on or after which the JWT MUST NOT be accepted for processing.","example":"2020-01-01T00:00:00Z"},"expression":{"type":"string","description":"The filter expression. For more information, refer to [Expressions](https://developers.cloudflare.com/ruleset-engine/rules-language/expressions/).","example":"(http.request.uri.path ~ \".*wp-login.php\" or http.request.uri.path ~ \".*xmlrpc.php\") and ip.addr ne 172.16.22.155"},"externally_managed":{"type":"boolean","description":"Indicates whether this plan is managed externally.","default":false,"example":false},"fail_closed":{"type":"boolean","description":"Block requests for files that cannot be scanned.","example":false},"failed_login_response":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"type":"array","items":{"type":"object","properties":{"expiration":{"type":"integer"},"metadata":{"type":"object","example":{"app_name":"Test App","aud":"39691c1480a2352a18ece567debc2b32552686cbd38eec0887aa18d5d3f00c04","datetime":"2022-02-02T21:54:34.914Z","ray_id":"6d76a8a42ead4133","user_email":"test@cloudflare.com","user_uuid":"57171132-e453-4ee8-b2a5-8cbaad333207"}}}}}}}]},"failure_reason":{"type":"string","description":"The current failure reason if status is unhealthy.","example":"","readOnly":true},"fallback_domain":{"type":"object","required":["suffix"],"properties":{"description":{"type":"string","description":"A description of the fallback domain, displayed in the client UI.","example":"Domain bypass for local development","maxLength":100},"dns_server":{"type":"array","description":"A list of IP addresses to handle domain resolution.","items":{}},"suffix":{"type":"string","description":"The domain suffix to match when resolving locally.","example":"example.com"}}},"fallback_domain_response_collection":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/fallback_domain"}}}}]},"fallback_domains":{"type":"array","items":{"$ref":"#/components/schemas/fallback_domain"}},"fallback_origin_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"type":"object"}}}]},"fallback_pool":{"description":"The pool ID to use when all other pools are detected as unhealthy."},"fax":{"type":"string","description":"Contact fax number.","example":"123-867-5309"},"feature_app_props":{"type":"object","properties":{"allowed_idps":{"$ref":"#/components/schemas/allowed_idps"},"auto_redirect_to_identity":{"$ref":"#/components/schemas/auto_redirect_to_identity"},"domain":{"$ref":"#/components/schemas/schemas-domain"},"name":{"$ref":"#/components/schemas/apps_components-schemas-name"},"session_duration":{"$ref":"#/components/schemas/session_duration"},"type":{"$ref":"#/components/schemas/apps_components-schemas-type"}}},"features":{"anyOf":[{"$ref":"#/components/schemas/thresholds"}],"type":"object","readOnly":true},"fetched_at":{"type":"string","description":"The timestamp of when the script was last fetched.","nullable":true},"fields_response":{"type":"object","properties":{"key":{"type":"string","example":"value"}}},"filename":{"type":"string","description":"Image file name.","example":"logo.png","readOnly":true,"maxLength":32},"filter":{"type":"object","properties":{"description":{"$ref":"#/components/schemas/filters_components-schemas-description"},"expression":{"$ref":"#/components/schemas/expression"},"id":{"$ref":"#/components/schemas/filters_components-schemas-id"},"paused":{"$ref":"#/components/schemas/filters_components-schemas-paused"},"ref":{"$ref":"#/components/schemas/schemas-ref"}}},"filter-delete-response-collection":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"type":"object","properties":{"result":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/filter"},{"type":"object","required":["id"]}]}}}}]},"filter-delete-response-single":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"type":"object","required":["result"],"properties":{"result":{"allOf":[{"$ref":"#/components/schemas/filter"},{"type":"object","required":["id"]}]}}}]},"filter-no-id":{"required":["pattern","enabled"],"properties":{"enabled":{"$ref":"#/components/schemas/filters_components-schemas-enabled"},"pattern":{"$ref":"#/components/schemas/schemas-pattern"}}},"filter-response-collection":{"allOf":[{"$ref":"#/components/schemas/api-response-common"},{"properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/filters"}}}}]},"filter-response-single":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/filters"}}}]},"filter-rule-base":{"type":"object","properties":{"action":{"$ref":"#/components/schemas/firewall-rules_components-schemas-action"},"description":{"$ref":"#/components/schemas/firewall-rules_components-schemas-description"},"id":{"$ref":"#/components/schemas/firewall-rules_components-schemas-id"},"paused":{"$ref":"#/components/schemas/firewall-rules_components-schemas-paused"},"priority":{"$ref":"#/components/schemas/firewall-rules_components-schemas-priority"},"products":{"$ref":"#/components/schemas/products"},"ref":{"$ref":"#/components/schemas/ref"}}},"filter-rule-response":{"allOf":[{"$ref":"#/components/schemas/filter-rule-base"},{"properties":{"filter":{"oneOf":[{"$ref":"#/components/schemas/filter"},{"$ref":"#/components/schemas/deleted-filter"}]}}}],"type":"object"},"filter-rules-response-collection":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"type":"object","required":["result"],"properties":{"result":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/filter-rule-response"},{"type":"object","required":["id","filter","action","paused"]}]}}}}]},"filter-rules-response-collection-delete":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"type":"object","required":["result"],"properties":{"result":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/filter-rule-response"},{"type":"object","required":["id"]}]}}}}]},"filter-rules-single-response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"type":"object","required":["result"],"properties":{"result":{"allOf":[{"$ref":"#/components/schemas/filter-rule-response"},{"type":"object","required":["id","filter","action","paused"]}]}}}]},"filter-rules-single-response-delete":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"type":"object","required":["result"],"properties":{"result":{"allOf":[{"$ref":"#/components/schemas/filter-rule-response"},{"type":"object","required":["id"]}]}}}]},"filter_options":{"type":"object","description":"Filter options for a particular resource type (pool or origin). Use null to reset.","nullable":true,"properties":{"disable":{"type":"boolean","description":"If set true, disable notifications for this type of resource (pool or origin).","default":false},"healthy":{"type":"boolean","description":"If present, send notifications only for this health status (e.g. false for only DOWN events). Use null to reset (all events).","nullable":true}}},"filters":{"type":"object","required":["id","pattern","enabled"],"properties":{"enabled":{"$ref":"#/components/schemas/filters_components-schemas-enabled"},"id":{"$ref":"#/components/schemas/common_components-schemas-identifier"},"pattern":{"$ref":"#/components/schemas/schemas-pattern"}}},"filters_components-schemas-description":{"type":"string","description":"An informative summary of the filter.","example":"Restrict access from these browsers on this address range.","maxLength":500},"filters_components-schemas-enabled":{"type":"boolean","title":"Whether or not this filter will run a script","example":true},"filters_components-schemas-id":{"type":"string","description":"The unique identifier of the filter.","example":"372e67954025e0ba6aaa6d586b9e0b61","readOnly":true,"minLength":32,"maxLength":32},"filters_components-schemas-paused":{"type":"boolean","description":"When true, indicates that the filter is currently paused.","example":false},"fingerprint":{"type":"string","description":"The MD5 fingerprint of the certificate.","example":"MD5 Fingerprint=1E:80:0F:7A:FD:31:55:96:DE:D5:CB:E2:F0:91:F6:91"},"fips-settings":{"type":"object","description":"FIPS settings.","properties":{"tls":{"type":"boolean","description":"Enable only cipher suites and TLS versions compliant with FIPS 140-2.","example":true}}},"firewall-rules_components-schemas-action":{"type":"string","description":"The action to apply to a matched request. The `log` action is only available on an Enterprise plan.","enum":["block","challenge","js_challenge","managed_challenge","allow","log","bypass"],"example":"block"},"firewall-rules_components-schemas-description":{"type":"string","description":"An informative summary of the firewall rule.","example":"Blocks traffic identified during investigation for MIR-31","maxLength":500},"firewall-rules_components-schemas-id":{"type":"string","description":"The unique identifier of the firewall rule.","example":"372e67954025e0ba6aaa6d586b9e0b60","readOnly":true,"maxLength":32},"firewall-rules_components-schemas-paused":{"type":"boolean","description":"When true, indicates that the firewall rule is currently paused.","example":false},"firewall-rules_components-schemas-priority":{"type":"number","description":"The priority of the rule. Optional value used to define the processing order. A lower number indicates a higher priority. If not provided, rules with a defined priority will be processed before rules without a priority.","example":50,"minimum":0,"maximum":2147483647.0},"firewalluablock":{"properties":{"configuration":{"$ref":"#/components/schemas/components-schemas-configuration"},"description":{"$ref":"#/components/schemas/ua-rules_components-schemas-description"},"id":{"$ref":"#/components/schemas/ua-rules_components-schemas-id"},"mode":{"$ref":"#/components/schemas/ua-rules_components-schemas-mode"},"paused":{"$ref":"#/components/schemas/components-schemas-paused"}}},"firewalluablock_response_collection":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"type":"object","properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/ua-rules"}}}}]},"firewalluablock_response_single":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"type":"object","properties":{"result":{"type":"object"}}}]},"first_name":{"type":"string","description":"User's first name","example":"John","nullable":true,"maxLength":60},"fit":{"type":"string","description":"The fit property describes how the width and height dimensions should be interpreted.","enum":["scale-down","contain","cover","crop","pad"],"example":"scale-down"},"flag":{"type":"boolean","description":"The log retention flag for Logpull API.","example":true},"flag_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"type":"object","properties":{"flag":{"type":"boolean","example":true}}}}}]},"follow_redirects":{"type":"boolean","description":"Follow redirects if returned by the origin. This parameter is only valid for HTTP and HTTPS monitors.","default":false,"example":true},"force_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/force_result"}}}]},"force_result":{"type":"string","description":"When force_axfr query parameter is set to true, the response is a simple string","example":"OK"},"frequency":{"type":"string","description":"How often the subscription is renewed automatically.","enum":["weekly","monthly","quarterly","yearly"],"example":"monthly"},"full_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"type":"object","properties":{"result":{"allOf":[{"$ref":"#/components/schemas/address-maps"},{"type":"object","properties":{"ips":{"$ref":"#/components/schemas/schemas-ips"},"memberships":{"$ref":"#/components/schemas/memberships"}}}]}}}]},"gateway-account-device-settings":{"type":"object","properties":{"gateway_proxy_enabled":{"type":"boolean","description":"Enable gateway proxy filtering on TCP.","example":true},"gateway_udp_proxy_enabled":{"type":"boolean","description":"Enable gateway proxy filtering on UDP.","example":true}}},"gateway-account-device-settings-response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/gateway-account-device-settings"}}}],"type":"object"},"gateway-account-logging-settings":{"type":"object","properties":{"redact_pii":{"type":"boolean","description":"Redact personally identifiable information from activity logging (PII fields are: source IP, user email, user ID, device ID, URL, referrer, user agent).","example":true},"settings_by_rule_type":{"type":"object","description":"Logging settings by rule type.","properties":{"dns":{"type":"object","description":"Logging settings for DNS firewall."},"http":{"type":"object","description":"Logging settings for HTTP/HTTPS firewall."},"l4":{"type":"object","description":"Logging settings for Network firewall."}}}}},"gateway-account-logging-settings-response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/gateway-account-logging-settings"}}}],"type":"object"},"gateway-account-settings":{"type":"object","description":"account settings.","properties":{"settings":{"type":"object","description":"account settings.","properties":{"activity_log":{"$ref":"#/components/schemas/activity-log-settings"},"antivirus":{"$ref":"#/components/schemas/anti-virus-settings"},"block_page":{"$ref":"#/components/schemas/block-page-settings"},"browser_isolation":{"$ref":"#/components/schemas/browser-isolation-settings"},"fips":{"$ref":"#/components/schemas/fips-settings"},"tls_decrypt":{"$ref":"#/components/schemas/tls-settings"}}}}},"gateway_account":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"type":"object","properties":{"gateway_tag":{"$ref":"#/components/schemas/gateway_tag"},"id":{"$ref":"#/components/schemas/cf_account_id"},"provider_name":{"$ref":"#/components/schemas/provider_name"}}}}}],"type":"object"},"gateway_account_config":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"allOf":[{"$ref":"#/components/schemas/gateway-account-settings"},{"properties":{"created_at":{"$ref":"#/components/schemas/timestamp"},"updated_at":{"$ref":"#/components/schemas/timestamp"}}}],"type":"object"}}}],"type":"object"},"gateway_seat":{"type":"boolean","description":"True if the seat is part of Gateway.","example":false},"gateway_tag":{"type":"string","description":"Gateway internal id.","example":"f174e90afafe4643bbbc4a0ed4fc8415","maxLength":32},"gateway_unique_id":{"type":"string","example":"699d98642c564d2e855e9661899b7252"},"geo_restrictions":{"type":"object","description":"Specify the region where your private key can be held locally for optimal TLS performance. HTTPS connections to any excluded data center will still be fully encrypted, but will incur some latency while Keyless SSL is used to complete the handshake with the nearest allowed data center. Options allow distribution to only to U.S. data centers, only to E.U. data centers, or only to highest security data centers. Default distribution is to all Cloudflare datacenters, for optimal performance.","properties":{"label":{"enum":["us","eu","highest_security"],"example":"us"}}},"get-zone-connection-response":{"allOf":[{"$ref":"#/components/schemas/connection"}]},"get-zone-script-response":{"allOf":[{"$ref":"#/components/schemas/script"},{"properties":{"versions":{"type":"array","example":[{"fetched_at":"2021-08-18T10:51:08Z","hash":"e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b423","js_integrity_score":2}],"nullable":true,"items":{"$ref":"#/components/schemas/components-schemas-version"}}}}]},"get-zone-settings-response":{"properties":{"enabled":{"$ref":"#/components/schemas/script-monitor_components-schemas-enabled"},"updated_at":{"$ref":"#/components/schemas/schemas-updated_at"},"use_cloudflare_reporting_endpoint":{"$ref":"#/components/schemas/use_cloudflare_reporting_endpoint"},"use_connection_url_path":{"$ref":"#/components/schemas/use_connection_url_path"}}},"get_ownership_response":{"allOf":[{"$ref":"#/components/schemas/api-response-common"},{"properties":{"result":{"type":"object","nullable":true,"properties":{"filename":{"type":"string","example":"logs/challenge-filename.txt"},"message":{"type":"string","example":""},"valid":{"type":"boolean","example":true}}}}}]},"get_response":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"$ref":"#/components/schemas/zone_metadata"}]},"github_organization_rule":{"type":"object","title":"Github organization","description":"Matches a Github organization.\nRequires a Github identity provider.","required":["github-organization"],"properties":{"github-organization":{"type":"object","required":["name","connection_id"],"properties":{"connection_id":{"type":"string","description":"The ID of your Github identity provider.","example":"ea85612a-29c8-46c2-bacb-669d65136971"},"name":{"type":"string","description":"The name of the organization.","example":"cloudflare"}}}}},"grants":{"type":"object","example":{"read":true,"write":false},"properties":{"read":{"type":"boolean","example":true},"write":{"type":"boolean","example":true}}},"gre":{"type":"object","description":"The configuration specific to GRE interconnects.","properties":{"cloudflare_endpoint":{"type":"string","description":"The IP address assigned to the Cloudflare side of the GRE tunnel created as part of the Interconnect.","example":"203.0.113.1"},"customer_endpoint":{"type":"string","description":"The IP address assigned to the customer side of the GRE tunnel created as part of the Interconnect.","example":"203.0.113.1"}}},"gre-tunnel":{"type":"object","required":["name","customer_gre_endpoint","cloudflare_gre_endpoint","interface_address"],"properties":{"cloudflare_gre_endpoint":{"$ref":"#/components/schemas/cloudflare_gre_endpoint"},"created_on":{"$ref":"#/components/schemas/common_components-schemas-created_on"},"customer_gre_endpoint":{"$ref":"#/components/schemas/customer_gre_endpoint"},"description":{"$ref":"#/components/schemas/gre-tunnel_components-schemas-description"},"health_check":{"$ref":"#/components/schemas/health_check"},"id":{"$ref":"#/components/schemas/common_components-schemas-identifier-2"},"interface_address":{"$ref":"#/components/schemas/interface_address"},"modified_on":{"$ref":"#/components/schemas/common_components-schemas-modified_on"},"mtu":{"$ref":"#/components/schemas/mtu"},"name":{"$ref":"#/components/schemas/gre-tunnel_components-schemas-name"},"ttl":{"$ref":"#/components/schemas/components-schemas-ttl"}}},"gre-tunnel_components-schemas-description":{"type":"string","description":"An optional description of the GRE tunnel.","example":"Tunnel for ISP X"},"gre-tunnel_components-schemas-name":{"type":"string","description":"The name of the tunnel. The name cannot contain spaces or special characters, must be 15 characters or less, and cannot share a name with another GRE tunnel.","example":"GRE_1"},"group":{"type":"object","properties":{"description":{"$ref":"#/components/schemas/group_components-schemas-description"},"id":{"$ref":"#/components/schemas/group_components-schemas-identifier"},"modified_rules_count":{"$ref":"#/components/schemas/modified_rules_count"},"name":{"$ref":"#/components/schemas/group_components-schemas-name"},"package_id":{"$ref":"#/components/schemas/package_components-schemas-identifier"},"rules_count":{"$ref":"#/components/schemas/rules_count"}}},"group_components-schemas-description":{"type":"string","description":"An informative summary of what the rule group does.","example":"Group designed to protect against IP addresses that are a threat and typically used to launch DDoS attacks","nullable":true,"readOnly":true},"group_components-schemas-identifier":{"type":"string","description":"The unique identifier of the rule group.","example":"de677e5818985db1285d0e80225f06e5","readOnly":true,"maxLength":32},"group_components-schemas-name":{"type":"string","description":"The name of the rule group.","example":"Project Honey Pot","readOnly":true},"groups":{"type":"object","description":"An object that allows you to enable or disable WAF rule groups for the current WAF override. Each key of this object must be the ID of a WAF rule group, and each value must be a valid WAF action (usually `default` or `disable`). When creating a new URI-based WAF override, you must provide a `groups` object or a `rules` object.","example":{"ea8687e59929c1fd05ba97574ad43f77":"default"}},"groups_components-schemas-id_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/schemas-uuid"}}}}}]},"groups_components-schemas-name":{"type":"string","description":"The name of the Access group.","example":"Allow devs"},"groups_components-schemas-response_collection":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/schemas-groups"}}}}]},"groups_components-schemas-single_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/schemas-groups"}}}]},"gsuite_group_rule":{"type":"object","title":"Google Workspace group","description":"Matches a group in Google Workspace.\nRequires a Google Workspace identity provider.","required":["gsuite"],"properties":{"gsuite":{"type":"object","required":["email","connection_id"],"properties":{"connection_id":{"type":"string","description":"The ID of your Google Workspace identity provider.","example":"ea85612a-29c8-46c2-bacb-669d65136971"},"email":{"type":"string","description":"The email of the Google Workspace group.","example":"devs@cloudflare.com"}}}}},"h2_prioritization":{"allOf":[{"$ref":"#/components/schemas/schemas-base"},{"properties":{"id":{"description":"ID of the zone setting.","enum":["h2_prioritization"],"example":"h2_prioritization"},"value":{"$ref":"#/components/schemas/h2_prioritization_value"}}}],"title":"HTTP/2 Edge Prioritization","description":"HTTP/2 Edge Prioritization optimises the delivery of resources served through HTTP/2 to improve page load performance. It also supports fine control of content delivery when used in conjunction with Workers."},"h2_prioritization_value":{"type":"string","description":"Value of the zone setting.","enum":["on","off","custom"],"default":"off"},"hash":{"type":"string","description":"The computed hash of the analyzed script.","nullable":true,"minLength":64,"maxLength":64},"header":{"type":"object","description":"The HTTP request headers to send in the health check. It is recommended you set a Host header by default. The User-Agent header cannot be overridden. This parameter is only valid for HTTP and HTTPS monitors.","example":{"Host":["example.com"],"X-App-ID":["abc123"]}},"header_name":{"type":"string","description":"The name of the response header to match.","example":"Cf-Cache-Status"},"header_op":{"type":"string","description":"The operator used when matching: `eq` means \"equal\" and `ne` means \"not equal\".","enum":["eq","ne"],"example":"ne"},"header_value":{"type":"string","description":"The value of the response header, which must match exactly.","example":"HIT"},"health_check":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Determines whether to run healthchecks for a tunnel.","default":true,"example":true},"target":{"type":"string","description":"The address used to run healthchecks for a tunnel. This field defaults to `customer_gre_endpoint address`.","example":"203.0.113.1"},"type":{"type":"string","description":"The type of healthcheck to run, reply or request. The default value is `reply`.","enum":["reply","request"],"default":"reply","example":"request"}}},"health_details":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"type":"object","description":"A list of regions from which to run health checks. Null means every Cloudflare data center.","example":{"pool_id":"17b5962d775c646f3f9725cbc7a53df4","pop_health":{"Amsterdam, NL":{"healthy":true,"origins":[{"2001:DB8::5":{"failure_reason":"No failures","healthy":true,"response_code":401,"rtt":"12.1ms"}}]}}}}}}]},"healthchecks":{"type":"object","properties":{"address":{"$ref":"#/components/schemas/schemas-address"},"check_regions":{"$ref":"#/components/schemas/schemas-check_regions"},"consecutive_fails":{"$ref":"#/components/schemas/consecutive_fails"},"consecutive_successes":{"$ref":"#/components/schemas/consecutive_successes"},"created_on":{"$ref":"#/components/schemas/timestamp"},"description":{"$ref":"#/components/schemas/healthchecks_components-schemas-description"},"failure_reason":{"$ref":"#/components/schemas/failure_reason"},"http_config":{"$ref":"#/components/schemas/http_config"},"id":{"$ref":"#/components/schemas/healthchecks_components-schemas-identifier"},"interval":{"$ref":"#/components/schemas/components-schemas-interval"},"modified_on":{"$ref":"#/components/schemas/timestamp"},"name":{"$ref":"#/components/schemas/healthchecks_components-schemas-name"},"retries":{"$ref":"#/components/schemas/retries"},"status":{"$ref":"#/components/schemas/healthchecks_components-schemas-status"},"suspended":{"$ref":"#/components/schemas/suspended"},"tcp_config":{"$ref":"#/components/schemas/tcp_config"},"timeout":{"$ref":"#/components/schemas/schemas-timeout"},"type":{"$ref":"#/components/schemas/healthchecks_components-schemas-type"}}},"healthchecks_components-schemas-description":{"type":"string","description":"A human-readable description of the health check.","example":"Health check for www.example.com"},"healthchecks_components-schemas-id_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/healthchecks_components-schemas-identifier"}}}}}]},"healthchecks_components-schemas-identifier":{"example":"699d98642c564d2e855e9661899b7252"},"healthchecks_components-schemas-name":{"type":"string","description":"A short name to identify the health check. Only alphanumeric characters, hyphens and underscores are allowed.","example":"server-1"},"healthchecks_components-schemas-response_collection":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/healthchecks"}}}}]},"healthchecks_components-schemas-single_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/healthchecks"}}}]},"healthchecks_components-schemas-status":{"type":"string","description":"The current status of the origin server according to the health check.","enum":["unknown","healthy","unhealthy","suspended"],"example":"healthy","readOnly":true},"healthchecks_components-schemas-type":{"type":"string","description":"The protocol to use for the health check. Currently supported protocols are 'HTTP', 'HTTPS' and 'TCP'.","default":"HTTP","example":"HTTPS"},"height":{"type":"integer","description":"The height of the image in pixels.","readOnly":true},"hero_url":{"type":"string","format":"uri","description":"URI to hero variant for an image.","example":"https://imagedelivery.net/MTt4OTd0b0w5aj/107b9558-dd06-4bbd-5fef-9c2c16bb7900/hero","readOnly":true},"history":{"type":"object","properties":{"alert_body":{"$ref":"#/components/schemas/alert_body"},"alert_type":{"$ref":"#/components/schemas/schemas-alert_type"},"description":{"$ref":"#/components/schemas/history_components-schemas-description"},"id":{"$ref":"#/components/schemas/uuid"},"mechanism":{"$ref":"#/components/schemas/mechanism"},"mechanism_type":{"$ref":"#/components/schemas/mechanism_type"},"name":{"$ref":"#/components/schemas/history_components-schemas-name"},"sent":{"$ref":"#/components/schemas/sent"}}},"history_components-schemas-description":{"type":"string","description":"Description of the notification policy (if present).","example":"Universal Certificate validation status, issuance, renewal, and expiration notices"},"history_components-schemas-name":{"type":"string","description":"Name of the policy.","example":"SSL Notification Event Policy"},"history_components-schemas-response_collection":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"type":"array","example":[{"alert_body":"SSL certificate has expired","alert_type":"universal_ssl_event_type","description":"Universal Certificate validation status, issuance, renewal, and expiration notices.","id":"f174e90a-fafe-4643-bbbc-4a0ed4fc8415","mechanism":"test@example.com","mechanism_type":"email","name":"SSL Notification Event Policy","sent":"2021-10-08T17:52:17.571336Z"}],"items":{"$ref":"#/components/schemas/history"}},"result_info":{"type":"object","example":{"count":1,"page":1,"per_page":20}}}}]},"hop_result":{"type":"object","properties":{"nodes":{"type":"array","description":"An array of node objects.","items":{"$ref":"#/components/schemas/node_result"}},"packets_lost":{"$ref":"#/components/schemas/packets_lost"},"packets_sent":{"$ref":"#/components/schemas/packets_sent"},"packets_ttl":{"$ref":"#/components/schemas/packets_ttl"}}},"host":{"type":"string","format":"hostname","description":"RFC3986-compliant host.","example":"www.example.com","maxLength":255},"hostname":{"type":"string","description":"The custom hostname that will point to your hostname via CNAME.","example":"app.example.com","readOnly":true,"maxLength":255},"hostname-authenticated-origin-pull":{"allOf":[{"$ref":"#/components/schemas/hostname_certid_object"}],"type":"object","properties":{"cert_id":{"$ref":"#/components/schemas/hostname-authenticated-origin-pull_components-schemas-identifier"},"certificate":{"$ref":"#/components/schemas/hostname-authenticated-origin-pull_components-schemas-certificate"},"enabled":{"$ref":"#/components/schemas/hostname-authenticated-origin-pull_components-schemas-enabled"},"hostname":{"$ref":"#/components/schemas/schemas-hostname"},"id":{"$ref":"#/components/schemas/hostname-authenticated-origin-pull_components-schemas-identifier"},"private_key":{"$ref":"#/components/schemas/schemas-private_key"}}},"hostname-authenticated-origin-pull_components-schemas-certificate":{"type":"string","description":"The hostname certificate.","example":"-----BEGIN CERTIFICATE-----\nMIIDtTCCAp2gAwIBAgIJAMHAwfXZ5/PWMA0GCSqGSIb3DQEBCwUAMEUxCzAJBgNV\nBAYTAkFVMRMwEQYDVQQIEwpTb21lLVN0YXRlMSEwHwYDVQQKExhJbnRlcm5ldCBX\naWRnaXRzIFB0eSBMdGQwHhcNMTYwODI0MTY0MzAxWhcNMTYxMTIyMTY0MzAxWjBF\nMQswCQYDVQQGEwJBVTETMBEGA1UECBMKU29tZS1TdGF0ZTEhMB8GA1UEChMYSW50\nZXJuZXQgV2lkZ2l0cyBQdHkgTHRkMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIB\nCgKCAQEAwQHoetcl9+5ikGzV6cMzWtWPJHqXT3wpbEkRU9Yz7lgvddmGdtcGbg/1\nCGZu0jJGkMoppoUo4c3dts3iwqRYmBikUP77wwY2QGmDZw2FvkJCJlKnabIRuGvB\nKwzESIXgKk2016aTP6/dAjEHyo6SeoK8lkIySUvK0fyOVlsiEsCmOpidtnKX/a+5\n0GjB79CJH4ER2lLVZnhePFR/zUOyPxZQQ4naHf7yu/b5jhO0f8fwt+pyFxIXjbEI\ndZliWRkRMtzrHOJIhrmJ2A1J7iOrirbbwillwjjNVUWPf3IJ3M12S9pEewooaeO2\nizNTERcG9HzAacbVRn2Y2SWIyT/18QIDAQABo4GnMIGkMB0GA1UdDgQWBBT/LbE4\n9rWf288N6sJA5BRb6FJIGDB1BgNVHSMEbjBsgBT/LbE49rWf288N6sJA5BRb6FJI\nGKFJpEcwRTELMAkGA1UEBhMCQVUxEzARBgNVBAgTClNvbWUtU3RhdGUxITAfBgNV\nBAoTGEludGVybmV0IFdpZGdpdHMgUHR5IEx0ZIIJAMHAwfXZ5/PWMAwGA1UdEwQF\nMAMBAf8wDQYJKoZIhvcNAQELBQADggEBAHHFwl0tH0quUYZYO0dZYt4R7SJ0pCm2\n2satiyzHl4OnXcHDpekAo7/a09c6Lz6AU83cKy/+x3/djYHXWba7HpEu0dR3ugQP\nMlr4zrhd9xKZ0KZKiYmtJH+ak4OM4L3FbT0owUZPyjLSlhMtJVcoRp5CJsjAMBUG\nSvD8RX+T01wzox/Qb+lnnNnOlaWpqu8eoOenybxKp1a9ULzIVvN/LAcc+14vioFq\n2swRWtmocBAs8QR9n4uvbpiYvS8eYueDCWMM4fvFfBhaDZ3N9IbtySh3SpFdQDhw\nYbjM2rxXiyLGxB4Bol7QTv4zHif7Zt89FReT/NBy4rzaskDJY5L6xmY=\n-----END CERTIFICATE-----\n"},"hostname-authenticated-origin-pull_components-schemas-certificate_response_collection":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/hostname-authenticated-origin-pull"}}}}]},"hostname-authenticated-origin-pull_components-schemas-enabled":{"type":"boolean","description":"Indicates whether hostname-level authenticated origin pulls is enabled. A null value voids the association.","example":true,"nullable":true},"hostname-authenticated-origin-pull_components-schemas-expires_on":{"type":"string","format":"date-time","description":"The date when the certificate expires.","example":"2100-01-01T05:20:00Z","readOnly":true},"hostname-authenticated-origin-pull_components-schemas-identifier":{"type":"string","description":"Certificate identifier tag.","example":"2458ce5a-0c35-4c7f-82c7-8e9487d3ff60","readOnly":true,"maxLength":36},"hostname-authenticated-origin-pull_components-schemas-status":{"description":"Status of the certificate or the association.","enum":["initializing","pending_deployment","pending_deletion","active","deleted","deployment_timed_out","deletion_timed_out"],"example":"active","readOnly":true},"hostname_aop_response_collection":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/hostname-authenticated-origin-pull"}}}}]},"hostname_aop_single_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/hostname_certid_object"}}}]},"hostname_certid_input":{"type":"object","properties":{"cert_id":{"$ref":"#/components/schemas/hostname-authenticated-origin-pull_components-schemas-identifier"},"enabled":{"$ref":"#/components/schemas/hostname-authenticated-origin-pull_components-schemas-enabled"},"hostname":{"$ref":"#/components/schemas/schemas-hostname"}}},"hostname_certid_object":{"properties":{"cert_id":{"$ref":"#/components/schemas/hostname-authenticated-origin-pull_components-schemas-identifier"},"cert_status":{"$ref":"#/components/schemas/hostname-authenticated-origin-pull_components-schemas-status"},"cert_updated_at":{"$ref":"#/components/schemas/updated_at"},"cert_uploaded_on":{"$ref":"#/components/schemas/components-schemas-uploaded_on"},"certificate":{"$ref":"#/components/schemas/hostname-authenticated-origin-pull_components-schemas-certificate"},"created_at":{"$ref":"#/components/schemas/schemas-created_at"},"enabled":{"$ref":"#/components/schemas/hostname-authenticated-origin-pull_components-schemas-enabled"},"expires_on":{"$ref":"#/components/schemas/hostname-authenticated-origin-pull_components-schemas-expires_on"},"hostname":{"$ref":"#/components/schemas/schemas-hostname"},"issuer":{"$ref":"#/components/schemas/issuer"},"serial_number":{"$ref":"#/components/schemas/serial_number"},"signature":{"$ref":"#/components/schemas/signature"},"status":{"$ref":"#/components/schemas/hostname-authenticated-origin-pull_components-schemas-status"},"updated_at":{"$ref":"#/components/schemas/updated_at"}}},"hostnames":{"type":"array","description":"Array of hostnames or wildcard names (e.g., *.example.com) bound to the certificate.","example":["example.com","*.example.com"],"items":{}},"hosts":{"type":"array","items":{"type":"string","description":"The valid hosts for the certificates.","example":"example.com","readOnly":true,"maxLength":253}},"hotlink_protection":{"allOf":[{"$ref":"#/components/schemas/schemas-base"},{"properties":{"id":{"description":"ID of the zone setting.","enum":["hotlink_protection"],"example":"hotlink_protection"},"value":{"$ref":"#/components/schemas/hotlink_protection_value"}}}],"title":"Hotlink Protection","description":"When enabled, the Hotlink Protection option ensures that other sites cannot suck up your bandwidth by building pages that use images hosted on your site. Anytime a request for an image on your site hits Cloudflare, we check to ensure that it's not another site requesting them. People will still be able to download and view images from your page, but other sites won't be able to steal them for use on their own pages. (https://support.cloudflare.com/hc/en-us/articles/200170026)."},"hotlink_protection_value":{"type":"string","description":"Value of the zone setting.","enum":["on","off"],"default":"off"},"http_config":{"type":"object","description":"Parameters specific to an HTTP or HTTPS health check.","nullable":true,"properties":{"allow_insecure":{"type":"boolean","description":"Do not validate the certificate when the health check uses HTTPS.","default":false},"expected_body":{"type":"string","description":"A case-insensitive sub-string to look for in the response body. If this string is not found, the origin will be marked as unhealthy.","example":"success"},"expected_codes":{"type":"array","description":"The expected HTTP response codes (e.g. \"200\") or code ranges (e.g. \"2xx\" for all codes starting with 2) of the health check.","default":"200","example":["2xx","302"],"nullable":true,"items":{"type":"string"}},"follow_redirects":{"type":"boolean","description":"Follow redirects if the origin returns a 3xx status code.","default":false},"header":{"type":"object","description":"The HTTP request headers to send in the health check. It is recommended you set a Host header by default. The User-Agent header cannot be overridden.","example":{"Host":["example.com"],"X-App-ID":["abc123"]},"nullable":true},"method":{"type":"string","description":"The HTTP method to use for the health check.","enum":["GET","HEAD"],"default":"GET"},"path":{"type":"string","description":"The endpoint path to health check against.","default":"/","example":"/health"},"port":{"type":"integer","description":"Port number to connect to for the health check. Defaults to 80 if type is HTTP or 443 if type is HTTPS.","default":80}}},"http_only_cookie_attribute":{"type":"boolean","description":"Enables the HttpOnly cookie attribute, which increases security against XSS attacks.","default":true,"example":true},"http2":{"allOf":[{"$ref":"#/components/schemas/schemas-base"},{"properties":{"id":{"description":"ID of the zone setting.","enum":["http2"],"example":"http2"},"value":{"$ref":"#/components/schemas/http2_value"}}}],"title":"HTTP2 Value","description":"HTTP2 enabled for this zone."},"http2_value":{"type":"string","description":"Value of the HTTP2 setting.","enum":["on","off"],"default":"off"},"http3":{"allOf":[{"$ref":"#/components/schemas/schemas-base"},{"properties":{"id":{"description":"ID of the zone setting.","enum":["http3"],"example":"http3"},"value":{"$ref":"#/components/schemas/http3_value"}}}],"title":"HTTP3 Value","description":"HTTP3 enabled for this zone."},"http3_value":{"type":"string","description":"Value of the HTTP3 setting.","enum":["on","off"],"default":"off"},"id":{"type":"integer","description":"Unique id of the job.","minimum":1},"id_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/dns-secondary-secondary-zone_components-schemas-identifier"}}}}}]},"identifier":{"type":"string","description":"Identifier","example":"023e105f4ecef8ad9ca31a8372d0c353","readOnly":true,"maxLength":32},"identity":{"type":"string","description":"The wirefilter expression to be used for identity matching.","example":"any(identity.groups.name[*] in {\"finance\"})"},"identity-providers":{"type":"object","properties":{"config":{"$ref":"#/components/schemas/schemas-config"},"id":{"$ref":"#/components/schemas/uuid"},"name":{"$ref":"#/components/schemas/identity-providers_components-schemas-name"},"type":{"$ref":"#/components/schemas/identity-providers_components-schemas-type"}}},"identity-providers_components-schemas-identifier":{"example":"699d98642c564d2e855e9661899b7252"},"identity-providers_components-schemas-name":{"type":"string","description":"The name of the identity provider, shown to users on the login page.","example":"Widget Corps OTP"},"identity-providers_components-schemas-response_collection":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/identity-providers"}}}}]},"identity-providers_components-schemas-single_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/identity-providers"}}}]},"identity-providers_components-schemas-type":{"type":"string","description":"The type of identity provider. To determine the value for a specific provider, refer to our [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/).","example":"onetimepin"},"image_basic_upload_via_url":{"type":"object","required":["url"],"properties":{"metadata":{"type":"object","description":"User modifiable key-value store. Can use used for keeping references to another system of record for managing images."},"requireSignedURLs":{"type":"boolean","description":"Indicates whether the image requires a signature token for the access.","default":false,"example":true},"url":{"type":"string","description":"A URL to fetch an image from origin.","example":"https://example.com/path/to/logo.png"}}},"image_patch_request":{"type":"object","properties":{"metadata":{"type":"object","description":"User modifiable key-value store. Can be used for keeping references to another system of record for managing images. No change if not specified."},"requireSignedURLs":{"type":"boolean","description":"Indicates whether the image can be accessed using only its UID. If set to `true`, a signed token needs to be generated with a signing key to view the image. Returns a new UID on a change. No change if not specified.","example":true}}},"image_resizing":{"allOf":[{"$ref":"#/components/schemas/schemas-base"},{"properties":{"id":{"description":"ID of the zone setting.","enum":["image_resizing"],"example":"image_resizing"},"value":{"$ref":"#/components/schemas/image_resizing_value"}}}],"title":"Image Resizing","description":"Image Resizing provides on-demand resizing, conversion and optimisation for images served through Cloudflare's network. Refer to the [Image Resizing documentation](https://developers.cloudflare.com/images/) for more information."},"image_resizing_value":{"type":"string","description":"Whether the feature is enabled, disabled, or enabled in `open proxy` mode.","enum":["on","off","open"],"default":"off"},"image_response_blob":{"anyOf":[{"type":"string"},{"type":"object"}],"example":"<image blob data>"},"image_response_collection":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/images"}}}}]},"image_response_single":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"type":"object"}}}]},"images":{"type":"object","properties":{"filename":{"$ref":"#/components/schemas/filename"},"id":{"$ref":"#/components/schemas/images_components-schemas-identifier"},"metadata":{"$ref":"#/components/schemas/metadata"},"requireSignedURLs":{"$ref":"#/components/schemas/schemas-requireSignedURLs"},"uploaded":{"$ref":"#/components/schemas/schemas-uploaded"},"variants":{"$ref":"#/components/schemas/schemas-variants"}}},"images_components-schemas-account_identifier":{"type":"string","description":"Account identifier tag.","example":"023e105f4ecef8ad9ca31a8372d0c353","readOnly":true,"maxLength":32},"images_components-schemas-identifier":{"type":"string","description":"Image unique identifier.","example":"107b9558-dd06-4bbd-5fef-9c2c16bb7900","readOnly":true,"maxLength":32},"images_count":{"type":"object","properties":{"allowed":{"$ref":"#/components/schemas/allowed"},"current":{"$ref":"#/components/schemas/current"}}},"images_stats":{"type":"object","properties":{"count":{"$ref":"#/components/schemas/images_count"}}},"include":{"type":"array","description":"Rules evaluated with an OR logical operator. A user needs to meet only one of the Include rules.","items":{"$ref":"#/components/schemas/rule_components-schemas-rule"}},"input":{"type":"object","readOnly":true,"properties":{"height":{"type":"integer","description":"The video height in pixels. A value of `-1` means the height is unknown. The value becomes available after the upload and before the video is ready.","readOnly":true},"width":{"type":"integer","description":"The video width in pixels. A value of `-1` means the width is unknown. The value becomes available after the upload and before the video is ready.","readOnly":true}}},"install_id":{"type":"string","description":"app install id."},"interconnect":{"type":"object","properties":{"colo_name":{"$ref":"#/components/schemas/interconnect_components-schemas-name"},"created_on":{"$ref":"#/components/schemas/common_components-schemas-created_on"},"description":{"$ref":"#/components/schemas/interconnect_components-schemas-description"},"gre":{"$ref":"#/components/schemas/gre"},"health_check":{"$ref":"#/components/schemas/schemas-health_check"},"id":{"$ref":"#/components/schemas/common_components-schemas-identifier-2"},"interface_address":{"$ref":"#/components/schemas/interface_address"},"modified_on":{"$ref":"#/components/schemas/common_components-schemas-modified_on"},"mtu":{"$ref":"#/components/schemas/schemas-mtu"},"name":{"$ref":"#/components/schemas/interconnect_components-schemas-name"}}},"interconnect_components-schemas-description":{"type":"string","description":"An optional description of the interconnect.","example":"Tunnel for Interconnect to ORD"},"interconnect_components-schemas-name":{"type":"string","description":"The name of the interconnect. The name cannot share a name with other tunnels.","example":"pni_ord"},"interface_address":{"type":"string","description":"A 31-bit prefix (/31 in CIDR notation) supporting two hosts, one for each side of the tunnel. Select the subnet from the following private IP space: 10.0.0.0–10.255.255.255, 172.16.0.0–172.31.255.255, 192.168.0.0–192.168.255.255.","example":"192.0.2.0/31"},"interval":{"type":"integer","description":"The interval between each health check. Shorter intervals may improve failover time, but will increase load on the origins as we check from multiple locations.","default":60},"intune_config_request":{"type":"object","required":["customer_id","client_id","client_secret"],"properties":{"client_id":{"type":"string","description":"The Intune client ID.","example":"example client id"},"client_secret":{"type":"string","description":"The Intune client secret.","example":"example client secret"},"customer_id":{"type":"string","description":"The Intune customer ID.","example":"example customer id"}}},"invite":{"allOf":[{"$ref":"#/components/schemas/organization_invite"}],"type":"object"},"invite_components-schemas-identifier":{"type":"string","description":"Invite identifier tag.","example":"4f5f0c14a2a41d5063dd301b2f829f04","readOnly":true,"maxLength":32},"invited_by":{"type":"string","description":"The email address of the user who created the invite.","example":"user@example.com","maxLength":90},"invited_member_email":{"type":"string","description":"Email address of the user to add to the organization.","example":"user@example.com","maxLength":90},"invited_on":{"type":"string","format":"date-time","description":"When the invite was sent.","example":"2014-01-01T05:20:00Z","readOnly":true},"ip":{"type":"string","description":"IPv4/IPv6 address of primary or secondary nameserver, depending on what zone this peer is linked to. For primary zones this IP defines the IP of the secondary nameserver Cloudflare will NOTIFY upon zone changes. For secondary zones this IP defines the IP of the primary nameserver Cloudflare will send AXFR/IXFR requests to.","example":"192.0.2.53"},"ip-list":{"properties":{"description":{"type":"string"},"id":{"type":"integer"},"name":{"type":"string","example":"Malware"}}},"ip_address":{"type":"string","description":"An IPv4 or IPv6 address.","example":"192.0.2.1"},"ip_components-schemas-ip":{"properties":{"belongs_to_ref":{"type":"object","description":"Specifies a reference to the autonomous systems (AS) that the IP address belongs to.","properties":{"country":{"type":"string","example":"US"},"description":{"type":"string","example":"CLOUDFLARENET"},"id":{"example":"autonomous-system--2fa28d71-3549-5a38-af05-770b79ad6ea8"},"type":{"type":"string","description":"Infrastructure type of this ASN.","enum":["hosting_provider","isp","organization"],"example":"hosting_provider"},"value":{"type":"string"}}},"ip":{"$ref":"#/components/schemas/common_components-schemas-ip"},"risk_types":{"example":[{"id":131,"name":"Phishing","super_category_id":21}]}}},"ip_configuration":{"title":"An IP address configuration.","properties":{"target":{"description":"The configuration target. You must set the target to `ip` when specifying an IP address in the rule.","enum":["ip"],"example":"ip"},"value":{"type":"string","description":"The IP address to match. This address will be compared to the IP address of incoming requests.","example":"198.51.100.4"}}},"ip_firewall":{"type":"boolean","description":"Enables IP Access Rules for this application.\nNotes: Only available for TCP applications.","example":true},"ip_geolocation":{"allOf":[{"$ref":"#/components/schemas/schemas-base"},{"properties":{"id":{"description":"ID of the zone setting.","enum":["ip_geolocation"],"example":"ip_geolocation"},"value":{"$ref":"#/components/schemas/ip_geolocation_value"}}}],"title":"IP Geolocation","description":"Enable IP Geolocation to have Cloudflare geolocate visitors to your website and pass the country code to you. (https://support.cloudflare.com/hc/en-us/articles/200168236)."},"ip_geolocation_value":{"type":"string","description":"Value of the zone setting.","enum":["on","off"],"default":"on"},"ip_list_rule":{"type":"object","title":"IP list","description":"Matches an IP address from a list.","required":["ip_list"],"properties":{"ip_list":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The ID of a previously created IP list.","example":"aa0a4aab-672b-4bdb-bc33-a59f1130a11f"}}}}},"ip_network":{"type":"string","description":"The private IPv4 or IPv6 range connected by the route, in CIDR notation.","example":"172.16.0.0/16"},"ip_network_encoded":{"type":"string","description":"IP/CIDR range in URL-encoded format","example":"172.16.0.0%2F16"},"ip_range":{"type":"string","description":"Allowed IPv4/IPv6 address range of primary or secondary nameservers. This will be applied for the entire account. The IP range is used to allow additional NOTIFY IPs for secondary zones and IPs Cloudflare allows AXFR/IXFR requests from for primary zones. CIDRs are limited to a maximum of /24 for IPv4 and /64 for IPv6 respectively.","example":"192.0.2.53/28"},"ip_rule":{"type":"object","title":"IP ranges","description":"Matches an IP address block.","required":["ip"],"properties":{"ip":{"type":"object","required":["ip"],"properties":{"ip":{"type":"string","description":"An IPv4 or IPv6 CIDR block.","example":"2400:cb00:21:10a::/64"}}}}},"ipam-delegations":{"type":"object","properties":{"cidr":{"$ref":"#/components/schemas/cidr"},"created_at":{"$ref":"#/components/schemas/timestamp"},"delegated_account_id":{"$ref":"#/components/schemas/delegated_account_identifier"},"id":{"$ref":"#/components/schemas/delegation_identifier"},"modified_at":{"$ref":"#/components/schemas/timestamp"},"parent_prefix_id":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}},"ipam-delegations_components-schemas-id_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/delegation_identifier"}}}}}]},"ipam-delegations_components-schemas-response_collection":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/ipam-delegations"}}}}]},"ipam-delegations_components-schemas-single_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/ipam-delegations"}}}]},"ipam-prefixes":{"type":"object","properties":{"account_id":{"$ref":"#/components/schemas/common_components-schemas-identifier"},"advertised":{"$ref":"#/components/schemas/advertised"},"advertised_modified_at":{"$ref":"#/components/schemas/modified_at_nullable"},"approved":{"$ref":"#/components/schemas/approved"},"asn":{"$ref":"#/components/schemas/asn"},"cidr":{"$ref":"#/components/schemas/cidr"},"created_at":{"$ref":"#/components/schemas/timestamp"},"description":{"$ref":"#/components/schemas/ipam-prefixes_components-schemas-description"},"id":{"$ref":"#/components/schemas/common_components-schemas-identifier"},"loa_document_id":{"$ref":"#/components/schemas/loa_document_identifier"},"modified_at":{"$ref":"#/components/schemas/timestamp"},"on_demand_enabled":{"$ref":"#/components/schemas/on_demand_enabled"},"on_demand_locked":{"$ref":"#/components/schemas/on_demand_locked"}}},"ipam-prefixes_components-schemas-description":{"type":"string","description":"Description of the prefix.","example":"Internal test prefix","maxLength":1000},"ipam-prefixes_components-schemas-response_collection":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/ipam-prefixes"}}}}]},"ipam-prefixes_components-schemas-single_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/ipam-prefixes"}}}]},"ips":{"type":"object","properties":{"etag":{"type":"string","description":"A digest of the IP data. Useful for determining if the data has changed.","example":"a8e453d9d129a3769407127936edfdb0"},"ipv4_cidrs":{"type":"array","description":"List of Cloudflare IPv4 CIDR addresses.","items":{"type":"string","description":"IPv4 CIDR.","example":"199.27.128.0/21"}},"ipv6_cidrs":{"type":"array","description":"List of Cloudflare IPv6 CIDR addresses.","items":{"type":"string","description":"IPv6 CIDR.","example":"2400:cb00::/32"}}}},"ipsec-tunnel":{"type":"object","required":["name","cloudflare_endpoint","interface_address"],"properties":{"allow_null_cipher":{"$ref":"#/components/schemas/allow_null_cipher"},"cloudflare_endpoint":{"$ref":"#/components/schemas/cloudflare_ipsec_endpoint"},"created_on":{"$ref":"#/components/schemas/common_components-schemas-created_on"},"customer_endpoint":{"$ref":"#/components/schemas/customer_ipsec_endpoint"},"description":{"$ref":"#/components/schemas/ipsec-tunnel_components-schemas-description"},"id":{"$ref":"#/components/schemas/common_components-schemas-identifier-2"},"interface_address":{"$ref":"#/components/schemas/interface_address"},"modified_on":{"$ref":"#/components/schemas/common_components-schemas-modified_on"},"name":{"$ref":"#/components/schemas/ipsec-tunnel_components-schemas-name"},"psk_metadata":{"$ref":"#/components/schemas/psk_metadata"},"tunnel_health_check":{"$ref":"#/components/schemas/tunnel_health_check"}}},"ipsec-tunnel_components-schemas-description":{"type":"string","description":"An optional description forthe IPsec tunnel.","example":"Tunnel for ISP X"},"ipsec-tunnel_components-schemas-name":{"type":"string","description":"The name of the IPsec tunnel. The name cannot share a name with other tunnels.","example":"IPsec_1"},"ipv4":{"type":"string","format":"ipv4","example":"192.0.2.0"},"ipv6":{"allOf":[{"$ref":"#/components/schemas/schemas-base"},{"properties":{"id":{"description":"ID of the zone setting.","enum":["ipv6"],"example":"ipv6"},"value":{"$ref":"#/components/schemas/ipv6_value"}}}],"title":"IPv6","description":"Enable IPv6 on all subdomains that are Cloudflare enabled. (https://support.cloudflare.com/hc/en-us/articles/200168586)."},"ipv6_configuration":{"title":"An IPv6 address configuration.","properties":{"target":{"description":"The configuration target. You must set the target to `ip6` when specifying an IPv6 address in the rule.","enum":["ip6"],"example":"ip6"},"value":{"type":"string","description":"The IPv6 address to match.","example":"2001:DB8:100::CF"}}},"ipv6_value":{"type":"string","description":"Value of the zone setting.","enum":["off","on"],"default":"off"},"is_default_network":{"type":"boolean","description":"If `true`, this virtual network is the default for the account.","example":true},"is_pending_reconnect":{"type":"boolean","description":"Cloudflare continues to track connections for several minutes after they disconnect. This is an optimization to improve latency and reliability of reconnecting. If `true`, the connection has disconnected but is still being tracked. If `false`, the connection is actively serving traffic.","example":false},"is_subscribed":{"type":"boolean","description":"Indicates whether you are currently subscribed to this plan.","default":false,"example":false},"is_ui_read_only":{"type":"boolean","description":"Lock all settings as Read-Only in the Dashboard, regardless of user permission. Updates may only be made via the API or Terraform for this account when enabled.","example":"false"},"issued_on":{"type":"string","format":"date-time","description":"The time on which the token was created.","example":"2018-07-01T05:20:00Z","readOnly":true},"issuer":{"type":"string","description":"The certificate authority that issued the certificate.","example":"GlobalSign","readOnly":true},"item":{"oneOf":[{"required":["ip"]},{"required":["redirect"]}],"type":"object","example":{"comment":"Private IP address","created_on":"2020-01-01T08:00:00Z","id":"2c0fc9fa937b11eaa1b71c4d701ab86e","ip":"10.0.0.1","modified_on":"2020-01-10T14:00:00Z"},"properties":{"comment":{"$ref":"#/components/schemas/item_comment"},"created_on":{"type":"string","description":"The RFC 3339 timestamp of when the item was created.","example":"2020-01-01T08:00:00Z","readOnly":true},"id":{"$ref":"#/components/schemas/list_id"},"ip":{"$ref":"#/components/schemas/item_ip"},"modified_on":{"type":"string","description":"The RFC 3339 timestamp of when the item was last modified.","example":"2020-01-10T14:00:00Z","readOnly":true},"redirect":{"$ref":"#/components/schemas/item_redirect"}}},"item-response-collection":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"type":"object","properties":{"result":{"$ref":"#/components/schemas/item"}}}]},"item_comment":{"type":"string","description":"An informative summary of the list item.","example":"Private IP address"},"item_id":{"type":"string","description":"The unique ID of the item in the List.","example":"34b12448945f11eaa1b71c4d701ab86e"},"item_ip":{"type":"string","description":"An IPv4 address, an IPv4 CIDR, or an IPv6 CIDR. IPv6 CIDRs are limited to a maximum of /64.","example":"10.0.0.1"},"item_redirect":{"type":"object","description":"The definition of the redirect.","required":["source_url","target_url"],"properties":{"include_subdomains":{"type":"boolean","default":false},"preserve_path_suffix":{"type":"boolean","default":true},"preserve_query_string":{"type":"boolean","default":false},"source_url":{"type":"string","example":"example.com/arch"},"status_code":{"type":"integer","enum":[301,302,307,308],"default":301},"subpath_matching":{"type":"boolean","default":false},"target_url":{"type":"string","example":"https://archlinux.org/"}}},"items":{"type":"array","items":{"$ref":"#/components/schemas/item"}},"items-list-response-collection":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"type":"object","properties":{"result":{"$ref":"#/components/schemas/items"},"result_info":{"type":"object","properties":{"cursors":{"type":"object","properties":{"after":{"type":"string","example":"yyy"},"before":{"type":"string","example":"xxx"}}}}}}}]},"items-update-request-collection":{"type":"array","items":{"allOf":[{"oneOf":[{"required":["ip"]},{"required":["redirect"]}],"type":"object","properties":{"comment":{"$ref":"#/components/schemas/item_comment"},"ip":{"$ref":"#/components/schemas/item_ip"},"redirect":{"$ref":"#/components/schemas/item_redirect"}}}]}},"ixfr_enable":{"type":"boolean","description":"Enable IXFR transfer protocol, default is AXFR. Only applicable to secondary zones.","example":false},"js_integrity_score":{"type":"integer","description":"The integrity score of the JavaScript content.","nullable":true,"minimum":1,"maximum":99},"json_response_enabled":{"type":"boolean","description":"Only available for the Waiting Room Advanced subscription. If `true`, requests to the waiting room with the header `Accept: application/json` will receive a JSON response object with information on the user's status in the waiting room as opposed to the configured static HTML page. This JSON response object has one property `cfWaitingRoom` which is an object containing the following fields:\n1. `inWaitingRoom`: Boolean indicating if the user is in the waiting room (always **true**).\n2. `waitTimeKnown`: Boolean indicating if the current estimated wait times are accurate. If **false**, they are not available.\n3. `waitTime`: Valid only when `waitTimeKnown` is **true**. Integer indicating the current estimated time in minutes the user will wait in the waiting room. When `queueingMethod` is **random**, this is set to `waitTime50Percentile`.\n4. `waitTime25Percentile`: Valid only when `queueingMethod` is **random** and `waitTimeKnown` is **true**. Integer indicating the current estimated maximum wait time for the 25% of users that gain entry the fastest (25th percentile).\n5. `waitTime50Percentile`: Valid only when `queueingMethod` is **random** and `waitTimeKnown` is **true**. Integer indicating the current estimated maximum wait time for the 50% of users that gain entry the fastest (50th percentile). In other words, half of the queued users are expected to let into the origin website before `waitTime50Percentile` and half are expected to be let in after it.\n6. `waitTime75Percentile`: Valid only when `queueingMethod` is **random** and `waitTimeKnown` is **true**. Integer indicating the current estimated maximum wait time for the 75% of users that gain entry the fastest (75th percentile).\n7. `waitTimeFormatted`: String displaying the `waitTime` formatted in English for users. If `waitTimeKnown` is **false**, `waitTimeFormatted` will display **unavailable**.\n8. `queueIsFull`: Boolean indicating if the waiting room's queue is currently full and not accepting new users at the moment.\n9. `queueAll`: Boolean indicating if all users will be queued in the waiting room and no one will be let into the origin website.\n10. `lastUpdated`: String displaying the timestamp as an ISO 8601 string of the user's last attempt to leave the waiting room and be let into the origin website. The user is able to make another attempt after `refreshIntervalSeconds` past this time. If the user makes a request too soon, it will be ignored and `lastUpdated` will not change.\n11. `refreshIntervalSeconds`: Integer indicating the number of seconds after `lastUpdated` until the user is able to make another attempt to leave the waiting room and be let into the origin website. When the `queueingMethod` is `reject`, there is no specified refresh time — it will always be **zero**.\n12. `queueingMethod`: The queueing method currently used by the waiting room. It is either **fifo**, **random**, **passthrough**, or **reject**.\n13. `isFIFOQueue`: Boolean indicating if the waiting room uses a FIFO (First-In-First-Out) queue.\n14. `isRandomQueue`: Boolean indicating if the waiting room uses a Random queue where users gain access randomly.\n15. `isPassthroughQueue`: Boolean indicating if the waiting room uses a passthrough queue. Keep in mind that when passthrough is enabled, this JSON response will only exist when `queueAll` is **true** or `isEventPrequeueing` is **true** because in all other cases requests will go directly to the origin.\n16. `isRejectQueue`: Boolean indicating if the waiting room uses a reject queue.\n17. `isEventActive`: Boolean indicating if an event is currently occurring. Events are able to change a waiting room's behavior during a specified period of time. For additional information, look at the event properties `prequeue_start_time`, `event_start_time`, and `event_end_time` in the documentation for creating waiting room events. Events are considered active between these start and end times, as well as during the prequeueing period if it exists.\n18. `isEventPrequeueing`: Valid only when `isEventActive` is **true**. Boolean indicating if an event is currently prequeueing users before it starts.\n19. `timeUntilEventStart`: Valid only when `isEventPrequeueing` is **true**. Integer indicating the number of minutes until the event starts.\n20. `timeUntilEventStartFormatted`: String displaying the `timeUntilEventStart` formatted in English for users. If `isEventPrequeueing` is **false**, `timeUntilEventStartFormatted` will display **unavailable**.\n21. `timeUntilEventEnd`: Valid only when `isEventActive` is **true**. Integer indicating the number of minutes until the event ends.\n22. `timeUntilEventEndFormatted`: String displaying the `timeUntilEventEnd` formatted in English for users. If `isEventActive` is **false**, `timeUntilEventEndFormatted` will display **unavailable**.\n23. `shuffleAtEventStart`: Valid only when `isEventActive` is **true**. Boolean indicating if the users in the prequeue are shuffled randomly when the event starts.\n\nAn example cURL to a waiting room could be:\n\n\tcurl -X GET \"https://example.com/waitingroom\" \\\n\t\t-H \"Accept: application/json\"\n\nIf `json_response_enabled` is **true** and the request hits the waiting room, an example JSON response when `queueingMethod` is **fifo** and no event is active could be:\n\n\t{\n\t\t\"cfWaitingRoom\": {\n\t\t\t\"inWaitingRoom\": true,\n\t\t\t\"waitTimeKnown\": true,\n\t\t\t\"waitTime\": 10,\n\t\t\t\"waitTime25Percentile\": 0,\n\t\t\t\"waitTime50Percentile\": 0,\n\t\t\t\"waitTime75Percentile\": 0,\n\t\t\t\"waitTimeFormatted\": \"10 minutes\",\n\t\t\t\"queueIsFull\": false,\n\t\t\t\"queueAll\": false,\n\t\t\t\"lastUpdated\": \"2020-08-03T23:46:00.000Z\",\n\t\t\t\"refreshIntervalSeconds\": 20,\n\t\t\t\"queueingMethod\": \"fifo\",\n\t\t\t\"isFIFOQueue\": true,\n\t\t\t\"isRandomQueue\": false,\n\t\t\t\"isPassthroughQueue\": false,\n\t\t\t\"isRejectQueue\": false,\n\t\t\t\"isEventActive\": false,\n\t\t\t\"isEventPrequeueing\": false,\n\t\t\t\"timeUntilEventStart\": 0,\n\t\t\t\"timeUntilEventStartFormatted\": \"unavailable\",\n\t\t\t\"timeUntilEventEnd\": 0,\n\t\t\t\"timeUntilEventEndFormatted\": \"unavailable\",\n\t\t\t\"shuffleAtEventStart\": false\n\t\t}\n\t}\n\nIf `json_response_enabled` is **true** and the request hits the waiting room, an example JSON response when `queueingMethod` is **random** and an event is active could be:\n\n\t{\n\t\t\"cfWaitingRoom\": {\n\t\t\t\"inWaitingRoom\": true,\n\t\t\t\"waitTimeKnown\": true,\n\t\t\t\"waitTime\": 10,\n\t\t\t\"waitTime25Percentile\": 5,\n\t\t\t\"waitTime50Percentile\": 10,\n\t\t\t\"waitTime75Percentile\": 15,\n\t\t\t\"waitTimeFormatted\": \"5 minutes to 15 minutes\",\n\t\t\t\"queueIsFull\": false,\n\t\t\t\"queueAll\": false,\n\t\t\t\"lastUpdated\": \"2020-08-03T23:46:00.000Z\",\n\t\t\t\"refreshIntervalSeconds\": 20,\n\t\t\t\"queueingMethod\": \"random\",\n\t\t\t\"isFIFOQueue\": false,\n\t\t\t\"isRandomQueue\": true,\n\t\t\t\"isPassthroughQueue\": false,\n\t\t\t\"isRejectQueue\": false,\n\t\t\t\"isEventActive\": true,\n\t\t\t\"isEventPrequeueing\": false,\n\t\t\t\"timeUntilEventStart\": 0,\n\t\t\t\"timeUntilEventStartFormatted\": \"unavailable\",\n\t\t\t\"timeUntilEventEnd\": 15,\n\t\t\t\"timeUntilEventEndFormatted\": \"15 minutes\",\n\t\t\t\"shuffleAtEventStart\": true\n\t\t}\n\t}.","default":false,"example":false},"jwk":{"type":"string","description":"The signing key in JWK format.","example":"eyJ1c2UiOiJzaWciLCJrdHkiOiJSU0EiLCJraWQiOiI1MjEzY2ZhMTIxZjcwYjhjMTM4MDY4NmZmYzM3MWJhMyIsImFsZyI6IlJTMjU2IiwibiI6IjBUandqT2laV21KNDN2ZjNUbzREb1htWFd0SkdOR3lYZmh5dHRMYUJnRjEtRVFXUURLaG9LYm9hS21xakNBc21za3V0YkxVN1BVOGRrUU5ER1p3S3VWczA4elNaNGt4aTR0RWdQUFp5dDdkWEMtbFlSWW95ckFHRjRBWGh5MzI5YkhDUDFJbHJCQl9Ba0dnbmRMQWd1bnhZMHJSZ2N2T3ppYXc2S0p4Rm5jMlVLMFdVOGIwcDRLS0hHcDFLTDlkazBXVDhkVllxYmVSaUpqQ2xVRW1oOHl2OUNsT1ZhUzRLeGlYNnhUUTREWnc2RGFKZklWM1F0Tmd2cG1ieWxOSmFQSG5zc3JodDJHS1A5NjJlS2poUVJsaWd2SFhKTE9uSm9KZkxlSUVIWi1peFdmY1RETUg5MnNHdm93MURPanhMaUNOMXpISy1oN2JMb1hUaUxnYzRrdyIsImUiOiJBUUFCIiwiZCI6IndpQWEwaU5mWnNYSGNOcVMxSWhnUmdzVHJHay1TcFlYV2lReDZHTU9kWlJKekhGazN0bkRERFJvNHNKZTBxX0dEOWkzNlEyZkVadS15elpEcEJkc3U5OHNtaHhNU19Ta0s5X3VFYUo1Zm96V2IyN3JRRnFoLVliUU9MUThkUnNPRHZmQl9Hb2txWWJzblJDR3kzWkFaOGZJZ25ocXBUNEpiOHdsaWxpMUgxeFpzM3RnTWtkTEluTm1yMFAtcTYxZEtNd3JYZVRoSWNEc0kyb2Z1LTFtRm1MWndQb2ZGbmxaTW9QN1pfRU5pUGNfWGtWNzFhaHBOZE9pcW5ablZtMHBCNE5QS1UweDRWTjQyYlAzWEhMUmpkV2hJOGt3SC1BdXhqb3BLaHJ0R2tvcG1jZFRkM1ZRdElaOGRpZHByMXpBaEpvQi16ZVlIaTFUel9ZSFFld0FRUSIsInAiOiIyVTZFVUJka3U3TndDYXoyNzZuWGMxRXgwVHpNZjU4U0UtU2M2eUNaYWk2TkwzVURpWi1mNHlIdkRLYnFGUXdLWDNwZ0l2aVE3Y05QYUpkbE9NeS1mU21GTXU3V3hlbVZYamFlTjJCMkRDazhQY0NEOVgxU2hhR3E1ZUdSSHNObVUtSDNxTG1FRGpjLWliazRHZ0RNb2lVYjQ2OGxFZHAwU2pIOXdsOUdsYTgiLCJxIjoiOW5ucXg5ZnNNY2dIZ29DemhfVjJmaDhoRUxUSUM5aFlIOVBCTG9aQjZIaE1TWG1ja1BSazVnUlpPWlFEN002TzlMaWZjNmFDVXdEbjBlQzU2YkFDNUNrcWxjODJsVDhzTWlMeWJyTjh3bWotcjNjSTBGQTlfSGQySEY1ZkgycnJmenVqd0NWM3czb09Ud3p4d1g3c2xKbklRanphel91SzEyWEtucVZZcUYwIiwiZHAiOiJxQklTUTlfVUNWaV9Ucng0UU9VYnZoVU9jc2FUWkNHajJiNzNudU9YeElnOHFuZldSSnN4RG5zd2FKaXdjNWJjYnZ3M1h0VGhRd1BNWnhpeE1UMHFGNlFGWVY5WXZibnJ6UEp4YkdNdTZqajZYc2lIUjFlbWU3U09lVDM4Xzg0aFZyOXV6UkN2RWstb0R0MHlodW9YVzFGWVFNRTE2cGtMV0ZkUjdRUERsQUUiLCJkcSI6Im5zQUp3eXZFbW8tdW5wU01qYjVBMHB6MExCRjBZNFMxeGRJYXNfLVBSYzd0dThsVFdWMl8teExEOFR6dmhqX0lmY0RJR3JJZGNKNjlzVVZnR1M3ZnZkcng3Y21uNjFyai1XcmU0UVJFRC1lV1dxZDlpc2FVRmg5UGVKZ2tCbFZVVnYtdnladVlWdFF2a1NUU05ZR3RtVXl2V2xKZDBPWEFHRm9jdGlfak9aVSIsInFpIjoib0dYaWxLQ2NKRXNFdEE1eG54WUdGQW5UUjNwdkZLUXR5S0F0UGhHaHkybm5ya2VzN1RRaEFxMGhLRWZtU1RzaE1hNFhfd05aMEstX1F0dkdoNDhpeHdTTDVLTEwxZnFsY0k2TF9XUnF0cFQxS21LRERlUHR2bDVCUzFGbjgwSGFwR215cmZRWUU4S09QR2UwUl82S1BOZE1vc3dYQ3Nfd0RYMF92ZzNoNUxRIn0=","readOnly":true},"key":{"type":"object","description":"A name for a value. A value stored under a given key may be retrieved via the same key.","required":["name"],"properties":{"expiration":{"type":"number","description":"The time, measured in number of seconds since the UNIX epoch, at which the key will expire. This property is omitted for keys that will not expire.","example":1577836800.0},"metadata":{"$ref":"#/components/schemas/list_metadata"},"name":{"$ref":"#/components/schemas/key_name"}}},"key_config":{"type":"object","properties":{"days_until_next_rotation":{"$ref":"#/components/schemas/days_until_next_rotation"},"key_rotation_interval_days":{"$ref":"#/components/schemas/key_rotation_interval_days"},"last_key_rotation_at":{"$ref":"#/components/schemas/last_key_rotation_at"}}},"key_generation_response":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"$ref":"#/components/schemas/keys"}}}]},"key_name":{"type":"string","description":"A key's name. The name may be at most 512 bytes. All printable, non-whitespace characters are valid. Use percent-encoding to define key names as part of a URL.","example":"My-Key","maxLength":512},"key_name_bulk":{"type":"string","description":"A key's name. The name may be at most 512 bytes. All printable, non-whitespace characters are valid.","example":"My-Key","maxLength":512},"key_response_collection":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"type":"array","items":{"type":"object","properties":{"created":{"$ref":"#/components/schemas/keys_components-schemas-created"},"id":{"$ref":"#/components/schemas/keys_components-schemas-identifier"}}}}}}]},"key_rotation_interval_days":{"type":"number","description":"The number of days between key rotations.","example":30,"minimum":21,"maximum":365},"keyless-certificate":{"allOf":[{"$ref":"#/components/schemas/keyless-certificate_components-schemas-base"}],"type":"object"},"keyless-certificate_components-schemas-base":{"type":"object","required":["id","name","host","port","status","enabled","permissions","created_on","modified_on"],"properties":{"created_on":{"type":"string","format":"date-time","description":"When the Keyless SSL was created.","example":"2014-01-01T05:20:00Z","readOnly":true},"enabled":{"$ref":"#/components/schemas/schemas-enabled"},"host":{"$ref":"#/components/schemas/schemas-host"},"id":{"$ref":"#/components/schemas/keyless-certificate_components-schemas-identifier"},"modified_on":{"type":"string","format":"date-time","description":"When the Keyless SSL was last modified.","example":"2014-01-01T05:20:00Z","readOnly":true},"name":{"$ref":"#/components/schemas/keyless-certificate_components-schemas-name"},"permissions":{"type":"array","description":"Available permissions for the Keyless SSL for the current user requesting the item.","example":["#ssl:read","#ssl:edit"],"readOnly":true,"items":{}},"port":{"$ref":"#/components/schemas/schemas-port"},"status":{"$ref":"#/components/schemas/keyless-certificate_components-schemas-status"}}},"keyless-certificate_components-schemas-identifier":{"type":"string","description":"Keyless certificate identifier tag.","example":"4d2844d2ce78891c34d0b6c0535a291e","readOnly":true,"maxLength":32},"keyless-certificate_components-schemas-name":{"type":"string","description":"The keyless SSL name.","example":"example.com Keyless SSL","readOnly":true,"maxLength":180},"keyless-certificate_components-schemas-status":{"type":"string","description":"Status of the Keyless SSL.","enum":["active","deleted"],"example":"active","readOnly":true},"keyless_response_collection":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/keyless-certificate"}}}}]},"keyless_response_single":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"type":"object"}}}]},"keyless_response_single_id":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/keyless-certificate_components-schemas-identifier"}}}}}]},"keys":{"type":"object","properties":{"created":{"$ref":"#/components/schemas/keys_components-schemas-created"},"id":{"$ref":"#/components/schemas/keys_components-schemas-identifier"},"jwk":{"$ref":"#/components/schemas/jwk"},"pem":{"$ref":"#/components/schemas/pem"}}},"keys_components-schemas-created":{"type":"string","format":"date-time","description":"The date and time a signing key was created.","example":"2014-01-02T02:20:00Z","readOnly":true},"keys_components-schemas-identifier":{"example":"5213cfa121f70b8c1380686ffc371ba3"},"keys_components-schemas-identifier-2":{"example":"699d98642c564d2e855e9661899b7252"},"keys_components-schemas-name":{"type":"string","description":"Key name.","example":"default","readOnly":true},"keys_components-schemas-single_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"$ref":"#/components/schemas/key_config"}]},"keys_components-schemas-value":{"type":"string","description":"Key value.","example":"Oix0bbNaT8Rge9PuyxUBrjI6zrgnsyJ5=","readOnly":true},"keys_response":{"type":"object","properties":{"keys":{"type":"array","items":{"$ref":"#/components/schemas/schemas-keys"}}}},"kind":{"type":"string","description":"The type of the list. Each type supports specific list items (IP addresses or redirects).","enum":["ip","redirect"],"example":"ip"},"kv_components-schemas-value":{"type":"string","description":"A byte sequence to be stored, up to 10 MB in length.","example":"Some Value"},"kv_namespace_binding":{"type":"object","required":["name","type","namespace_id"],"properties":{"name":{"$ref":"#/components/schemas/binding_name"},"namespace_id":{"$ref":"#/components/schemas/namespace_identifier"},"type":{"type":"string","description":"The class of resource that the binding provides.","enum":["kv_namespace"],"example":"kv_namespace"}}},"label":{"type":"string","description":"The language label displayed in the native language to users.","example":"Türkçe","readOnly":true},"labels":{"type":"array","description":"Field appears if there is an additional annotation printed when the probe returns. Field also appears when running a GRE+ICMP traceroute to denote which traceroute a node comes from.","items":{"type":"string"}},"language":{"type":"string","description":"The language tag in BCP 47 format.","example":"tr","readOnly":true},"language_response_collection":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/captions"}}}}]},"language_response_single":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"type":"object"}}}]},"last_failure":{"type":"string","format":"date-time","description":"Timestamp of the last time an attempt to dispatch a notification to this webhook failed.","example":"2020-10-26T18:25:04.532316Z","readOnly":true},"last_key_rotation_at":{"type":"string","format":"date-time","description":"The timestamp of the previous key rotation.","example":"2014-01-01T05:20:00.12345Z"},"last_name":{"type":"string","description":"User's last name","example":"Appleseed","nullable":true,"maxLength":60},"last_seen":{"type":"string","format":"date-time","description":"When the device last connected to Cloudflare services.","example":"2017-06-14T00:00:00Z"},"last_success":{"type":"string","format":"date-time","description":"Timestamp of the last time Cloudflare was able to successfully dispatch a notification using this webhook.","example":"2020-10-26T18:25:04.532316Z","readOnly":true},"last_successful_login":{"type":"string","format":"date-time","description":"The time at which the user last successfully logged in.","example":"2020-07-01T05:20:00Z"},"last_updated":{"type":"string","description":"The timestamp of when the ruleset was last modified.","example":"2000-01-01T00:00:00.000000Z"},"latitude":{"type":"number","description":"The latitude of the data center containing the origins used in this pool in decimal degrees. If this is set, longitude must also be set."},"legacy_discount":{"type":"boolean","description":"Indicates whether this plan has a legacy discount applied.","default":false,"example":false},"legacy_id":{"type":"string","description":"The legacy identifier for this rate plan, if any.","example":"free","readOnly":true},"list":{"properties":{"created_on":{"$ref":"#/components/schemas/components-schemas-created_on"},"description":{"$ref":"#/components/schemas/lists_components-schemas-description"},"id":{"$ref":"#/components/schemas/list_id"},"kind":{"$ref":"#/components/schemas/kind"},"modified_on":{"$ref":"#/components/schemas/lists_components-schemas-modified_on"},"name":{"$ref":"#/components/schemas/lists_components-schemas-name"},"num_items":{"$ref":"#/components/schemas/num_items"},"num_referencing_filters":{"$ref":"#/components/schemas/num_referencing_filters"}}},"list-delete-response-collection":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"type":"object","properties":{"result":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/item_id"}}}}}]},"list-response-collection":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"type":"object","properties":{"result":{"$ref":"#/components/schemas/list"}}}]},"list-zone-connections-response":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"type":"object","properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/connection"}},"result_info":{"$ref":"#/components/schemas/result_info"}}}]},"list-zone-scripts-response":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"type":"object","properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/script"}},"result_info":{"$ref":"#/components/schemas/result_info"}}}]},"list_id":{"type":"string","description":"The unique ID of the list.","example":"2c0fc9fa937b11eaa1b71c4d701ab86e","readOnly":true,"minLength":32,"maxLength":32},"list_item_response_collection":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/schemas-items"}}}},{"properties":{"result_info":{"type":"object","properties":{"count":{"type":"number","description":"Total results returned based on your search parameters.","example":1},"page":{"type":"number","description":"Current page within paginated list of results.","example":1},"per_page":{"type":"number","description":"Number of results per page of results.","example":20},"total_count":{"type":"number","description":"Total results available without any search parameters.","example":2000}}}}}]},"list_metadata":{"type":"object","description":"Arbitrary JSON that is associated with a key.","example":{"someMetadataKey":"someMetadataValue"}},"lists":{"type":"object","properties":{"count":{"$ref":"#/components/schemas/count"},"created_at":{"$ref":"#/components/schemas/timestamp"},"description":{"$ref":"#/components/schemas/lists_components-schemas-description-2"},"id":{"$ref":"#/components/schemas/lists_components-schemas-uuid"},"name":{"$ref":"#/components/schemas/lists_components-schemas-name-2"},"type":{"$ref":"#/components/schemas/lists_components-schemas-type"},"updated_at":{"$ref":"#/components/schemas/timestamp"}}},"lists-async-response":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"type":"object","properties":{"result":{"type":"object","properties":{"operation_id":{"$ref":"#/components/schemas/schemas-operation_id"}}}}}]},"lists-response-collection":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"type":"object","properties":{"result":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/list"},{"type":"object","required":["id","name","kind","num_items","created_on","modified_on"]}]}}}}]},"lists_components-schemas-description":{"type":"string","description":"An informative summary of the list.","example":"This is a note.","maxLength":500},"lists_components-schemas-description-2":{"type":"string","description":"The description of the List.","example":"The serial numbers for administrators"},"lists_components-schemas-empty_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"type":"object"}}}]},"lists_components-schemas-identifier":{"example":"699d98642c564d2e855e9661899b7252"},"lists_components-schemas-modified_on":{"type":"string","description":"The RFC 3339 timestamp of when the list was last modified.","example":"2020-01-10T14:00:00Z"},"lists_components-schemas-name":{"type":"string","description":"An informative name for the list. Use this name in filter and rule expressions.","example":"list1","maxLength":50,"pattern":"^[a-zA-Z0-9_]+$"},"lists_components-schemas-name-2":{"type":"string","description":"The name of the List.","example":"Admin Serial Numbers"},"lists_components-schemas-response_collection":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/lists"}}}}]},"lists_components-schemas-single_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/lists"}}}]},"lists_components-schemas-type":{"type":"string","description":"The type of List.","enum":["SERIAL","URL","DOMAIN","EMAIL","IP"],"example":"SERIAL"},"lists_components-schemas-uuid":{"type":"string","description":"API Resource UUID tag.","example":"f174e90a-fafe-4643-bbbc-4a0ed4fc8415","maxLength":36},"lists_components-schemas-value":{"type":"string","description":"The value of the item in a List.","example":"8GE8721REF"},"live_input_default_creator":{"type":"string","description":"Sets the creator ID asssociated with this live input."},"live_input_identifier":{"type":"string","description":"A unique identifier for a live input.","example":"66be4bf738797e01e1fca35a7bdecdcd","readOnly":true,"maxLength":32},"live_input_metadata":{"type":"object","description":"A user modifiable key-value store used to reference other systems of record for managing live inputs.","example":{"name":"test stream 1"}},"live_input_object_without_url":{"properties":{"created":{"$ref":"#/components/schemas/connect_components-schemas-created"},"meta":{"$ref":"#/components/schemas/live_input_metadata"},"modified":{"$ref":"#/components/schemas/components-schemas-modified"},"uid":{"$ref":"#/components/schemas/live_input_identifier"}}},"live_input_recording_allowedOrigins":{"type":"array","description":"Lists the origins allowed to display videos created with this input. Enter allowed origin domains in an array and use `*` for wildcard subdomains. An empty array allows videos to be viewed on any origin.","example":["example.com"],"items":{"type":"string"}},"live_input_recording_mode":{"type":"string","description":"Specifies the recording behavior for the live input. Set this value to `off` to prevent a recording. Set the value to `automatic` to begin a recording and transition to on-demand after Stream Live stops receiving input.","enum":["off","automatic"],"default":"off","example":"automatic"},"live_input_recording_requireSignedURLs":{"type":"boolean","description":"Indicates if a video using the live input has the `requireSignedURLs` property set. Also enforces access controls on any video recording of the livestream with the live input.","default":false,"example":true},"live_input_recording_settings":{"type":"object","description":"Records the input to a Cloudflare Stream video. Behavior depends on the mode. In most cases, the video will initially be viewable as a live video and transition to on-demand after a condition is satisfied.","example":{"mode":"off","requireSignedURLs":false,"timeoutSeconds":0},"properties":{"allowedOrigins":{"$ref":"#/components/schemas/live_input_recording_allowedOrigins"},"mode":{"$ref":"#/components/schemas/live_input_recording_mode"},"requireSignedURLs":{"$ref":"#/components/schemas/live_input_recording_requireSignedURLs"},"timeoutSeconds":{"$ref":"#/components/schemas/live_input_recording_timeoutSeconds"}}},"live_input_recording_timeoutSeconds":{"type":"integer","description":"Determines the amount of time a live input configured in `automatic` mode should wait before a recording transitions from live to on-demand. `0` is recommended for most use cases and indicates the platform default should be used.","default":0},"live_input_response_collection":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"type":"object","properties":{"liveInputs":{"type":"array","items":{"$ref":"#/components/schemas/live_input_object_without_url"}},"range":{"type":"integer","description":"The total number of remaining live inputs based on cursor position.","example":1000,"readOnly":true},"total":{"type":"integer","description":"The total number of live inputs that match the provided filters.","example":35586,"readOnly":true}}}}}]},"live_input_response_single":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"type":"object"}}}]},"liveInput":{"type":"string","description":"The live input ID used to upload a video with Stream Live.","example":"fc0a8dc887b16759bfd9ad922230a014","readOnly":true,"maxLength":32},"loa_document_identifier":{"type":"string","description":"Identifier for the uploaded LOA document.","example":"d933b1530bc56c9953cf8ce166da8004","nullable":true,"readOnly":true,"maxLength":32},"loa_upload_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"type":"object","properties":{"filename":{"type":"string","description":"Name of LOA document.","example":"document.pdf"}}}}}]},"load-balancer":{"type":"object","properties":{"adaptive_routing":{"$ref":"#/components/schemas/adaptive_routing"},"country_pools":{"$ref":"#/components/schemas/country_pools"},"created_on":{"$ref":"#/components/schemas/timestamp"},"default_pools":{"$ref":"#/components/schemas/default_pools"},"description":{"$ref":"#/components/schemas/load-balancer_components-schemas-description"},"enabled":{"$ref":"#/components/schemas/load-balancer_components-schemas-enabled"},"fallback_pool":{"$ref":"#/components/schemas/fallback_pool"},"id":{"$ref":"#/components/schemas/load-balancer_components-schemas-identifier"},"location_strategy":{"$ref":"#/components/schemas/location_strategy"},"modified_on":{"$ref":"#/components/schemas/timestamp"},"name":{"$ref":"#/components/schemas/load-balancer_components-schemas-name"},"pop_pools":{"$ref":"#/components/schemas/pop_pools"},"proxied":{"$ref":"#/components/schemas/schemas-proxied"},"random_steering":{"$ref":"#/components/schemas/random_steering"},"region_pools":{"$ref":"#/components/schemas/region_pools"},"rules":{"$ref":"#/components/schemas/load-balancer_components-schemas-rules"},"session_affinity":{"$ref":"#/components/schemas/session_affinity"},"session_affinity_attributes":{"$ref":"#/components/schemas/session_affinity_attributes"},"session_affinity_ttl":{"$ref":"#/components/schemas/session_affinity_ttl"},"steering_policy":{"$ref":"#/components/schemas/steering_policy"},"ttl":{"$ref":"#/components/schemas/schemas-ttl"}}},"load-balancer_components-schemas-description":{"type":"string","description":"Object description.","example":"Load Balancer for www.example.com"},"load-balancer_components-schemas-enabled":{"type":"boolean","description":"Whether to enable (the default) this load balancer.","default":true,"example":true},"load-balancer_components-schemas-id_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/load-balancer_components-schemas-identifier"}}}}}]},"load-balancer_components-schemas-identifier":{"example":"699d98642c564d2e855e9661899b7252"},"load-balancer_components-schemas-name":{"type":"string","description":"The DNS hostname to associate with your Load Balancer. If this hostname already exists as a DNS record in Cloudflare's DNS, the Load Balancer will take precedence and the DNS record will not be used.","example":"www.example.com"},"load-balancer_components-schemas-response_collection":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/load-balancer"}}}}]},"load-balancer_components-schemas-rules":{"type":"array","description":"BETA Field Not General Access: A list of rules for this load balancer to execute.","items":{"type":"object","description":"A rule object containing conditions and overrides for this load balancer to evaluate.","properties":{"condition":{"type":"string","description":"The condition expressions to evaluate. If the condition evaluates to true, the overrides or fixed_response in this rule will be applied. An empty condition is always true. For more details on condition expressions, please see https://developers.cloudflare.com/load-balancing/understand-basics/load-balancing-rules/expressions.","example":"http.request.uri.path contains \"/testing\""},"disabled":{"type":"boolean","description":"Disable this specific rule. It will no longer be evaluated by this load balancer.","default":false},"fixed_response":{"type":"object","description":"A collection of fields used to directly respond to the eyeball instead of routing to a pool. If a fixed_response is supplied the rule will be marked as terminates.","properties":{"content_type":{"type":"string","description":"The http 'Content-Type' header to include in the response.","example":"application/json","maxLength":32},"location":{"type":"string","description":"The http 'Location' header to include in the response.","example":"www.example.com","maxLength":2048},"message_body":{"type":"string","description":"Text to include as the http body.","example":"Testing Hello","maxLength":1024},"status_code":{"type":"integer","description":"The http status code to respond with."}}},"name":{"type":"string","description":"Name of this rule. Only used for human readability.","example":"route the path /testing to testing datacenter.","maxLength":200},"overrides":{"type":"object","description":"A collection of overrides to apply to the load balancer when this rule's condition is true. All fields are optional.","properties":{"adaptive_routing":{"$ref":"#/components/schemas/adaptive_routing"},"country_pools":{"$ref":"#/components/schemas/country_pools"},"default_pools":{"$ref":"#/components/schemas/default_pools"},"fallback_pool":{"$ref":"#/components/schemas/fallback_pool"},"location_strategy":{"$ref":"#/components/schemas/location_strategy"},"pop_pools":{"$ref":"#/components/schemas/pop_pools"},"random_steering":{"$ref":"#/components/schemas/random_steering"},"region_pools":{"$ref":"#/components/schemas/region_pools"},"session_affinity":{"$ref":"#/components/schemas/session_affinity"},"session_affinity_attributes":{"$ref":"#/components/schemas/session_affinity_attributes"},"session_affinity_ttl":{"$ref":"#/components/schemas/session_affinity_ttl"},"steering_policy":{"$ref":"#/components/schemas/steering_policy"},"ttl":{"$ref":"#/components/schemas/schemas-ttl"}}},"priority":{"type":"integer","description":"The order in which rules should be executed in relation to each other. Lower values are executed first. Values do not need to be sequential. If no value is provided for any rule the array order of the rules field will be used to assign a priority.","default":0},"terminates":{"type":"boolean","description":"If this rule's condition is true, this causes rule evaluation to stop after processing this rule.","default":false}}}},"load-balancer_components-schemas-single_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/load-balancer"}}}]},"load_shedding":{"type":"object","description":"Configures load shedding policies and percentages for the pool.","properties":{"default_percent":{"type":"number","description":"The percent of traffic to shed from the pool, according to the default policy. Applies to new sessions and traffic without session affinity.","default":0,"minimum":0,"maximum":100},"default_policy":{"type":"string","description":"The default policy to use when load shedding. A random policy randomly sheds a given percent of requests. A hash policy computes a hash over the CF-Connecting-IP address and sheds all requests originating from a percent of IPs.","enum":["random","hash"],"default":"random"},"session_percent":{"type":"number","description":"The percent of existing sessions to shed from the pool, according to the session policy.","default":0,"minimum":0,"maximum":100},"session_policy":{"type":"string","description":"Only the hash policy is supported for existing sessions (to avoid exponential decay).","enum":["hash"],"default":"hash"}}},"location_strategy":{"type":"object","description":"Controls location-based steering for non-proxied requests. See `steering_policy` to learn how steering is affected.","properties":{"mode":{"type":"string","description":"Determines the authoritative location when ECS is not preferred, does not exist in the request, or its GeoIP lookup is unsuccessful.\n- `\"pop\"`: Use the Cloudflare PoP location.\n- `\"resolver_ip\"`: Use the DNS resolver GeoIP location. If the GeoIP lookup is unsuccessful, use the Cloudflare PoP location.","enum":["pop","resolver_ip"],"default":"pop","example":"resolver_ip"},"prefer_ecs":{"type":"string","description":"Whether the EDNS Client Subnet (ECS) GeoIP should be preferred as the authoritative location.\n- `\"always\"`: Always prefer ECS.\n- `\"never\"`: Never prefer ECS.\n- `\"proximity\"`: Prefer ECS only when `steering_policy=\"proximity\"`.\n- `\"geo\"`: Prefer ECS only when `steering_policy=\"geo\"`.","enum":["always","never","proximity","geo"],"default":"proximity","example":"always"}}},"locations":{"type":"object","properties":{"client_default":{"$ref":"#/components/schemas/client-default"},"created_at":{"$ref":"#/components/schemas/timestamp"},"doh_subdomain":{"$ref":"#/components/schemas/subdomain"},"ecs_support":{"$ref":"#/components/schemas/ecs-support"},"id":{"$ref":"#/components/schemas/locations_components-schemas-uuid"},"ip":{"$ref":"#/components/schemas/locations_components-schemas-ip"},"name":{"$ref":"#/components/schemas/locations_components-schemas-name"},"networks":{"$ref":"#/components/schemas/network"},"updated_at":{"$ref":"#/components/schemas/timestamp"}}},"locations_components-schemas-empty_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"type":"object"}}}]},"locations_components-schemas-identifier":{"example":"699d98642c564d2e855e9661899b7252"},"locations_components-schemas-ip":{"type":"string","description":"IPV6 destination ip assigned to this location. DNS requests sent to this IP will counted as the request under this location. (auto-generated).","example":"2001:0db8:85a3:0000:0000:8a2e:0370:7334"},"locations_components-schemas-name":{"type":"string","description":"The name of the Location.","example":"Austin Office Location"},"locations_components-schemas-response_collection":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/locations"}}}}]},"locations_components-schemas-single_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/locations"}}}]},"locations_components-schemas-uuid":{"example":"ed35569b41ce4d1facfe683550f54086"},"lockdowns_components-schemas-description":{"type":"string","description":"An informative summary of the rule.","example":"Restrict access to these endpoints to requests from a known IP address","maxLength":1024},"lockdowns_components-schemas-id":{"type":"string","description":"The unique identifier of the Zone Lockdown rule.","example":"372e67954025e0ba6aaa6d586b9e0b59","readOnly":true,"maxLength":32},"lockdowns_components-schemas-modified_on":{"type":"string","format":"date-time","description":"The timestamp of when the rule was last modified.","example":"2014-01-01T05:20:00.12345Z","readOnly":true},"locked":{"type":"boolean","description":"Shows whether a registrar lock is in place for a domain.","example":false},"logging":{"type":"object","description":"An object configuring the rule's logging behavior.","example":{"enabled":true},"properties":{"enabled":{"type":"boolean","description":"Whether to generate a log when the rule matches.","example":true}}},"login_design":{"properties":{"background_color":{"type":"string","description":"The background color on your login page.","example":"#c5ed1b"},"footer_text":{"type":"string","description":"The text at the bottom of your login page.","example":"This is an example description."},"header_text":{"type":"string","description":"The text at the top of your login page.","example":"This is an example description."},"logo_path":{"type":"string","description":"The URL of the logo on your login page.","example":"https://example.com/logo.png"},"text_color":{"type":"string","description":"The text color on your login page.","example":"#c5ed1b"}}},"logo_url":{"type":"string","description":"The image URL for the logo shown in the App Launcher dashboard.","example":"https://www.cloudflare.com/img/logo-web-badges/cf-logo-on-white-bg.svg"},"logpull_options":{"type":"string","format":"uri-reference","description":"Configuration string. It specifies things like requested fields and timestamp formats. If migrating from the logpull api, copy the url (full url or just the query string) of your call here, and logpush will keep on making this call for you, setting start and end times appropriately.","example":"fields=RayID,ClientIP,EdgeStartTimestamp×tamps=rfc3339","nullable":true,"maxLength":4096},"logpush_components-schemas-name":{"type":"string","description":"Optional human readable job name. Not unique. Cloudflare suggests that you set this to a meaningful string, like the domain name, to make it easier to identify your job.","example":"example.com","nullable":true,"maxLength":512,"pattern":"^[a-zA-Z0-9\\-\\.]*$"},"logpush_field_response_collection":{"allOf":[{"$ref":"#/components/schemas/api-response-common"},{"properties":{"result":{"type":"object","items":{"type":"object","nullable":true,"properties":{"key":{"type":"string","example":"value"}}}}}}]},"logpush_job_response_collection":{"allOf":[{"$ref":"#/components/schemas/api-response-common"},{"properties":{"result":{"type":"array","items":{"type":"object","nullable":true}}}}]},"logpush_job_response_single":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"type":"object","nullable":true}}}]},"logs":{"anyOf":[{"type":"string"},{"type":"object"}],"example":"{\"ClientIP\":\"192.0.2.1\",\"RayID\":\"41ddf1740f67442d\",\"EdgeStartTimestamp\":1526810289280000000}\n{\"ClientIP\":\"192.0.2.1\",\"RayID\":\"41ddf1740f67442d\",\"EdgeStartTimestamp\":1526810289280000000}\n{\"ClientIP\":\"192.0.2.1\",\"RayID\":\"41ddf1740f67442d\",\"EdgeStartTimestamp\":1526810289280000000}"},"longitude":{"type":"number","description":"The longitude of the data center containing the origins used in this pool in decimal degrees. If this is set, latitude must also be set."},"mac_address":{"type":"string","description":"The device mac address.","example":"00-00-5E-00-53-00"},"managed_headers_components-schemas-enabled":{"type":"boolean","description":"When true, the Managed Transform is enabled.","example":true},"managed_headers_components-schemas-id":{"type":"string","description":"Human-readable identifier of the Managed Transform.","example":"add_cf-bot-score_header"},"manufacturer":{"type":"string","description":"The device manufacturer name.","example":"My phone corp"},"match":{"oneOf":[{"type":"object","properties":{"headers":{"type":"array","items":{"type":"object","properties":{"name":{"$ref":"#/components/schemas/header_name"},"op":{"$ref":"#/components/schemas/header_op"},"value":{"$ref":"#/components/schemas/header_value"}}}},"request":{"type":"object","properties":{"methods":{"$ref":"#/components/schemas/methods"},"schemes":{"$ref":"#/components/schemas/schemes"},"url":{"$ref":"#/components/schemas/schemas-url"}}},"response":{"type":"object","properties":{"origin_traffic":{"$ref":"#/components/schemas/origin_traffic"}}}}}],"type":"object","description":"Determines which traffic the rate limit counts towards the threshold."},"match_item":{"type":"object","properties":{"platform":{"$ref":"#/components/schemas/platform"}}},"matcher":{"type":"object","description":"Matching pattern to forward your actions.","required":["type","field","value"],"properties":{"field":{"type":"string","description":"Field for type matcher.","enum":["to"],"example":"to"},"type":{"type":"string","description":"Type of matcher.","enum":["literal"],"example":"literal"},"value":{"type":"string","description":"Value for matcher.","example":"test@example.com","maxLength":90}}},"matchers":{"type":"array","description":"Matching patterns to forward to your actions.","items":{"$ref":"#/components/schemas/matcher"}},"max_age":{"type":"number","description":"The maximum number of seconds the results of a preflight request can be cached.","example":-1,"minimum":-1,"maximum":86400},"max_estimated_time_minutes":{"type":"integer"},"max_retries":{"type":"number","example":3},"max_rtt_ms":{"type":"number","description":"Maximum RTT in ms."},"max_ttl":{"type":"integer","description":"Max TTL.","default":15,"minimum":0,"maximum":64},"max_upload":{"allOf":[{"$ref":"#/components/schemas/schemas-base"},{"properties":{"id":{"description":"identifier of the zone setting.","enum":["max_upload"],"example":"max_upload"},"value":{"$ref":"#/components/schemas/max_upload_value"}}}],"title":"Max Upload","description":"Maximum size of an allowable upload."},"max_upload_value":{"type":"number","description":"Value of the zone setting.\nNotes: The size depends on the plan level of the zone. (Enterprise = 500, Business = 200, Pro = 100, Free = 100)","enum":[100,200,500],"default":100},"max_wait_time_ms":{"type":"number","example":5000},"maxDurationSeconds":{"type":"integer","description":"The maximum duration in seconds for a video upload. Can be set for a video that is not yet uploaded to limit its duration. Uploads that exceed the specified duration will fail during processing. A value of `-1` means the value is unknown."},"maximum_cache_ttl":{"type":"number","description":"Maximum DNS Cache TTL.","default":900,"example":900,"minimum":30,"maximum":36000},"mean_rtt_ms":{"type":"number","description":"Mean RTT in ms."},"mechanism":{"type":"string","description":"The mechanism to which the notification has been dispatched.","example":"test@example.com"},"mechanism_type":{"type":"string","description":"The type of mechanism to which the notification has been dispatched. This can be email/pagerduty/webhook based on the mechanism configured.","enum":["email","pagerduty","webhook"],"example":"email"},"mechanisms":{"type":"object","description":"List of IDs that will be used when dispatching a notification. IDs for email type will be the email address.","example":{"email":[{"id":"test@example.com"}],"pagerduty":[{"id":"e8133a15-00a4-4d69-aec1-32f70c51f6e5"}],"webhooks":[{"id":"14cc1190-5d2b-4b98-a696-c424cb2ad05f"}]}},"media_metadata":{"type":"object","description":"A user modifiable key-value store used to reference other systems of record for managing videos.","example":{}},"media_state":{"type":"string","description":"Specifies the processing status of the video.","enum":["pendingupload","downloading","queued","inprogress","ready","error"],"example":"inprogress","readOnly":true},"media_status":{"description":"Specifies a detailed status for a video. If the `state` is `inprogress` or `error`, the `step` field returns `encoding` or `manifest`. If the `state` is `inprogress`, `pctComplete` returns a number between 0 and 100 to indicate the approximate percent of completion. If the `state` is `error`, `errorReasonCode` and `errorReasonText` provide additional details.","readOnly":true,"properties":{"errorReasonCode":{"$ref":"#/components/schemas/errorReasonCode"},"errorReasonText":{"$ref":"#/components/schemas/errorReasonText"},"pctComplete":{"$ref":"#/components/schemas/pctComplete"},"state":{"$ref":"#/components/schemas/media_state"}}},"member":{"type":"object","required":["id","user","status","roles"],"properties":{"code":{"$ref":"#/components/schemas/code"},"id":{"$ref":"#/components/schemas/membership_components-schemas-identifier"},"roles":{"type":"array","description":"Roles assigned to this member.","items":{"$ref":"#/components/schemas/role"}},"status":{"readOnly":true},"user":{"type":"object","readOnly":true,"required":["email"],"properties":{"email":{"$ref":"#/components/schemas/email"},"first_name":{"$ref":"#/components/schemas/first_name"},"id":{"$ref":"#/components/schemas/common_components-schemas-identifier"},"last_name":{"$ref":"#/components/schemas/last_name"},"two_factor_authentication_enabled":{"$ref":"#/components/schemas/two_factor_authentication_enabled"}}}}},"member_components-schemas-name":{"type":"string","description":"Member Name.","example":"John Smith","nullable":true,"maxLength":100},"membership":{"type":"object","properties":{"account":{"$ref":"#/components/schemas/schemas-account"},"api_access_enabled":{"$ref":"#/components/schemas/api_access_enabled"},"code":{"$ref":"#/components/schemas/code"},"id":{"$ref":"#/components/schemas/membership_components-schemas-identifier"},"permissions":{"allOf":[{"$ref":"#/components/schemas/permissions"}],"description":"All access permissions for the user at the account.","readOnly":true},"roles":{"$ref":"#/components/schemas/roles"},"status":{"$ref":"#/components/schemas/schemas-status"}}},"membership_components-schemas-identifier":{"type":"string","description":"Membership identifier tag.","example":"4536bcfad5faccb111b47003c79917fa","readOnly":true,"maxLength":32},"memberships":{"type":"array","description":"Zones and Accounts which will be assigned IPs on this Address Map. A zone membership will take priority over an account membership.","items":{"$ref":"#/components/schemas/address-maps-membership"}},"messages":{"type":"array","example":[],"items":{"type":"object","uniqueItems":true,"required":["code","message"],"properties":{"code":{"type":"integer","minimum":1000},"message":{"type":"string"}}}},"metadata":{"type":"object","description":"User modifiable key-value store. Can be used for keeping references to another system of record for managing images. Metadata must not exceed 1024 bytes.","example":{"key":"value"}},"method":{"type":"string","description":"The HTTP method used to access the endpoint.","enum":["GET","POST","HEAD","OPTIONS","PUT","DELETE","CONNECT","PATCH","TRACE"],"example":"GET"},"methods":{"type":"array","description":"The HTTP methods to match. You can specify a subset (for example, `['POST','PUT']`) or all methods (`['_ALL_']`). This field is optional when creating a rate limit.","example":["GET","POST"],"items":{"type":"string","description":"An HTTP method or `_ALL_` to indicate all methods.","enum":["GET","POST","PUT","DELETE","PATCH","HEAD","_ALL_"],"example":"GET"}},"min_rtt_ms":{"type":"number","description":"Minimum RTT in ms."},"min_tls_version":{"allOf":[{"$ref":"#/components/schemas/schemas-base"},{"properties":{"id":{"description":"ID of the zone setting.","enum":["min_tls_version"],"example":"min_tls_version"},"value":{"$ref":"#/components/schemas/min_tls_version_value"}}}],"title":"Zone Minimum TLS Version value","description":"Only accepts HTTPS requests that use at least the TLS protocol version specified. For example, if TLS 1.1 is selected, TLS 1.0 connections will be rejected, while 1.1, 1.2, and 1.3 (if enabled) will be permitted.","default":"1.0"},"min_tls_version_value":{"type":"string","description":"Value of the zone setting.","enum":["1.0","1.1","1.2","1.3"],"default":"1.0"},"minify":{"allOf":[{"$ref":"#/components/schemas/schemas-base"},{"properties":{"id":{"description":"Zone setting identifier.","enum":["minify"],"example":"minify"},"value":{"$ref":"#/components/schemas/minify_value"}}}],"title":"Auto-Minify Assets","description":"Automatically minify certain assets for your website. Refer to [Using Cloudflare Auto Minify](https://support.cloudflare.com/hc/en-us/articles/200168196) for more information."},"minify_value":{"type":"object","description":"Value of the zone setting.","properties":{"css":{"description":"Automatically minify all CSS files for your website.","enum":["on","off"],"default":"off"},"html":{"description":"Automatically minify all HTML files for your website.","enum":["on","off"],"default":"off"},"js":{"description":"Automatically minify all JavaScript files for your website.","enum":["on","off"],"default":"off"}}},"minimum_cache_ttl":{"type":"number","description":"Minimum DNS Cache TTL.","default":60,"example":60,"minimum":30,"maximum":36000},"minimum_origins":{"type":"integer","description":"The minimum number of origins that must be healthy for this pool to serve traffic. If the number of healthy origins falls below this number, the pool will be marked unhealthy and will failover to the next available pool.","default":1},"mirage":{"allOf":[{"$ref":"#/components/schemas/schemas-base"},{"properties":{"id":{"description":"ID of the zone setting.","enum":["mirage"],"example":"mirage"},"value":{"$ref":"#/components/schemas/mirage_value"}}}],"title":"Mirage Image Optimization","description":"Automatically optimize image loading for website visitors on mobile devices. Refer to [our blog post](http://blog.cloudflare.com/mirage2-solving-mobile-speed) for more information."},"mirage_value":{"type":"string","description":"Value of the zone setting.","enum":["on","off"],"default":"off"},"miscategorization":{"properties":{"content_adds":{"description":"Content category IDs to add.","example":[82]},"content_removes":{"description":"Content category IDs to remove.","example":[155]},"indicator_type":{"enum":["domain","ipv4","ipv6","url"],"example":"domain"},"ip":{"description":"Provide only if indicator_type is `ipv4` or `ipv6`."},"security_adds":{"description":"Security category IDs to add.","example":[117,131]},"security_removes":{"description":"Security category IDs to remove.","example":[83]},"url":{"type":"string","description":"Provide only if indicator_type is `domain` or `url`. Example if indicator_type is `domain`: `example.com`. Example if indicator_type is `url`: `https://example.com/news/`."}}},"mnm_config":{"type":"object","required":["name","default_sampling","router_ips"],"properties":{"default_sampling":{"$ref":"#/components/schemas/mnm_config_default_sampling"},"name":{"$ref":"#/components/schemas/mnm_config_name"},"router_ips":{"$ref":"#/components/schemas/mnm_config_router_ips"}}},"mnm_config_default_sampling":{"type":"number","description":"Fallback sampling rate of flow messages being sent in packets per second. This should match the packet sampling rate configured on the router.","default":1,"minimum":1},"mnm_config_name":{"type":"string","description":"The account name.","example":"cloudflare user's account"},"mnm_config_router_ip":{"type":"string","description":"IPv4 CIDR of the router sourcing flow data. Only /32 addresses are currently supported.","example":"203.0.113.1/32"},"mnm_config_router_ips":{"type":"array","items":{"$ref":"#/components/schemas/mnm_config_router_ip"}},"mnm_rule":{"type":"object","required":["name","prefixes","automatic_advertisement","duration"],"properties":{"automatic_advertisement":{"$ref":"#/components/schemas/mnm_rule_automatic_advertisement"},"bandwidth_threshold":{"$ref":"#/components/schemas/mnm_rule_bandwidth_threshold"},"duration":{"$ref":"#/components/schemas/mnm_rule_duration"},"id":{"$ref":"#/components/schemas/schemas-rule_identifier"},"name":{"$ref":"#/components/schemas/mnm_rule_name"},"packet_threshold":{"$ref":"#/components/schemas/mnm_rule_packet_threshold"},"prefixes":{"$ref":"#/components/schemas/mnm_rule_ip_prefixes"}}},"mnm_rule_automatic_advertisement":{"type":"boolean","description":"Toggle on if you would like Cloudflare to automatically advertise the IP Prefixes within the rule via Magic Transit when the rule is triggered. Only available for users of Magic Transit.","example":"false"},"mnm_rule_bandwidth_threshold":{"type":"number","description":"The number of bits per second for the rule. When this value is exceeded for the set duration, an alert notification is sent. Minimum of 1 and no maximum.","example":1000,"minimum":1},"mnm_rule_duration":{"type":"string","description":"The amount of time that the rule threshold must be exceeded to send an alert notification. The minimum is 60 seconds and maximum is 21600 seconds. The format is XhYmZs where X, Y, and Z durations are optional; however at least one unit must be provided.","default":"60s","example":"1h2m3s"},"mnm_rule_ip_prefix":{"type":"string","description":"The IP prefixes that are monitored for this rule. Must be a CIDR range like 203.0.113.0/24. Max 5000 different CIDR ranges.","example":"203.0.113.1/32"},"mnm_rule_ip_prefixes":{"type":"array","items":{"$ref":"#/components/schemas/mnm_rule_ip_prefix"}},"mnm_rule_name":{"type":"string","description":"The name of the rule. Must be unique. Supports characters A-Z, a-z, 0-9, underscore (_), dash (-), period (.), and tilde (~). You can’t have a space in the rule name. Max 256 characters.","example":"my_rule_1"},"mnm_rule_packet_threshold":{"type":"number","description":"The number of packets per second for the rule. When this value is exceeded for the set duration, an alert notification is sent. Minimum of 1 and no maximum.","example":10000,"minimum":1},"mnm_rules":{"type":"array","items":{"$ref":"#/components/schemas/mnm_rule"}},"mobile_redirect":{"allOf":[{"$ref":"#/components/schemas/schemas-base"},{"properties":{"id":{"description":"Identifier of the zone setting.","enum":["mobile_redirect"],"example":"mobile_redirect"},"value":{"$ref":"#/components/schemas/mobile_redirect_value"}}}],"title":"Mobile Redirect","description":"Automatically redirect visitors on mobile devices to a mobile-optimized subdomain. Refer to [Understanding Cloudflare Mobile Redirect](https://support.cloudflare.com/hc/articles/200168336) for more information."},"mobile_redirect_value":{"type":"object","description":"Value of the zone setting.","properties":{"mobile_subdomain":{"type":"string","description":"Which subdomain prefix you wish to redirect visitors on mobile devices to (subdomain must already exist).","example":"m","nullable":true,"minLength":1},"status":{"description":"Whether or not mobile redirect is enabled.","enum":["on","off"],"default":"off"},"strip_uri":{"type":"boolean","description":"Whether to drop the current page path and redirect to the mobile subdomain URL root, or keep the path and redirect to the same page on the mobile subdomain.","default":false,"example":false}}},"mode":{"type":"string","description":"The action to perform.","enum":["simulate","ban","challenge","js_challenge","managed_challenge"],"example":"challenge"},"mode_allow_traditional":{"type":"string","description":"When set to `on`, the current rule will be used when evaluating the request. Applies to traditional (allow) WAF rules.","enum":["on","off"],"example":"on"},"mode_anomaly":{"type":"string","description":"When set to `on`, the current WAF rule will be used when evaluating the request. Applies to anomaly detection WAF rules.","enum":["on","off"],"example":"on"},"mode_deny_traditional":{"type":"string","description":"The action that the current WAF rule will perform when triggered. Applies to traditional (deny) WAF rules.","enum":["default","disable","simulate","block","challenge"],"example":"block"},"model":{"type":"string","description":"The device model name.","example":"MyPhone(pro-X)"},"modified":{"type":"string","format":"date-time","description":"The date and time the destination address was last modified.","example":"2014-01-02T02:20:00Z","readOnly":true},"modified_at_nullable":{"type":"string","format":"date-time","description":"Last time the advertisement status was changed. This field is only not 'null' if on demand is enabled.","example":"2014-01-01T05:20:00.12345Z","nullable":true},"modified_on":{"type":"string","format":"date-time","description":"Last time the token was modified.","example":"2018-07-02T05:20:00Z","readOnly":true},"modified_rules_count":{"type":"number","description":"The number of rules within the group that have been modified from their default configuration.","default":0,"example":2,"readOnly":true},"modified_tunnels_collection_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"properties":{"modified":{"type":"boolean","example":true},"modified_gre_tunnels":{"type":"array","items":{"$ref":"#/components/schemas/gre-tunnel"}}}}}}]},"modify_request":{"type":"object","properties":{"description":{"$ref":"#/components/schemas/web3-hostname_components-schemas-description"},"dnslink":{"$ref":"#/components/schemas/dnslink"}}},"monitor":{"type":"object","properties":{"allow_insecure":{"$ref":"#/components/schemas/allow_insecure"},"created_on":{"$ref":"#/components/schemas/timestamp"},"description":{"$ref":"#/components/schemas/monitor_components-schemas-description"},"expected_body":{"$ref":"#/components/schemas/expected_body"},"expected_codes":{"$ref":"#/components/schemas/expected_codes"},"follow_redirects":{"$ref":"#/components/schemas/follow_redirects"},"header":{"$ref":"#/components/schemas/header"},"id":{"$ref":"#/components/schemas/monitor_components-schemas-identifier"},"interval":{"$ref":"#/components/schemas/interval"},"method":{"$ref":"#/components/schemas/schemas-method"},"modified_on":{"$ref":"#/components/schemas/timestamp"},"path":{"$ref":"#/components/schemas/path"},"port":{"$ref":"#/components/schemas/components-schemas-port"},"retries":{"$ref":"#/components/schemas/retries"},"timeout":{"$ref":"#/components/schemas/schemas-timeout"},"type":{"$ref":"#/components/schemas/monitor_components-schemas-type"}}},"monitor_components-schemas-description":{"type":"string","description":"Object description.","example":"Login page monitor"},"monitor_components-schemas-id_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/monitor_components-schemas-identifier"}}}}}]},"monitor_components-schemas-identifier":{"example":"f1aba936b94213e5b8dca0c0dbf1f9cc"},"monitor_components-schemas-port":{"type":"integer","description":"The port number to connect to for the health check. Required for TCP, UDP, and SMTP checks. HTTP and HTTPS checks should only define the port when using a non-standard port (HTTP: default 80, HTTPS: default 443).","default":0},"monitor_components-schemas-response_collection":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/monitor"}}}}]},"monitor_components-schemas-response_collection-2":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/components-schemas-monitor"}}}}]},"monitor_components-schemas-single_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/monitor"}}}]},"monitor_components-schemas-single_response-2":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/components-schemas-monitor"}}}]},"monitor_components-schemas-type":{"type":"string","description":"The protocol to use for the health check. Currently supported protocols are 'HTTP','HTTPS', 'TCP', 'ICMP-PING', 'UDP-ICMP', and 'SMTP'.","enum":["http","https","tcp","udp_icmp","icmp_ping","smtp"],"default":"http","example":"https"},"mtu":{"type":"integer","description":"Maximum Transmission Unit (MTU) in bytes for the GRE tunnel. The minimum value is 576.","default":1476},"multiple_route_modified_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"properties":{"modified":{"type":"boolean","example":true},"modified_routes":{"type":"array","items":{"$ref":"#/components/schemas/schemas-route"}}}}}}]},"name":{"type":"string","description":"Token name.","example":"readonly token","maxLength":120},"name_servers":{"type":"array","description":"List of name servers.","example":["preston.ns.cloudflare.com","oli.ns.cloudflare.com"],"items":{"type":"string"}},"namespace":{"type":"object","required":["id","title"],"properties":{"id":{"$ref":"#/components/schemas/namespace_identifier"},"supports_url_encoding":{"type":"boolean","description":"True if keys written on the URL will be URL-decoded before storing. For example, if set to \"true\", a key written on the URL as \"%3F\" will be stored as \"?\".","example":true,"readOnly":true},"title":{"$ref":"#/components/schemas/namespace_title"}}},"namespace_identifier":{"type":"string","description":"Namespace identifier tag.","example":"0f2ac74b498b48028cb68387c421e279","readOnly":true,"maxLength":32},"namespace_title":{"type":"string","description":"A human-readable string name for a Namespace.","example":"My Own Namespace"},"namespaces_components-schemas-id":{"type":"string","description":"ID of the namespace.","example":"5fd1cafff895419c8bcc647fc64ab8f0"},"negative_cache_ttl":{"type":"number","description":"Negative DNS Cache TTL.","example":900,"nullable":true,"minimum":30,"maximum":36000},"nel":{"allOf":[{"$ref":"#/components/schemas/schemas-base"},{"properties":{"id":{"description":"Zone setting identifier.","enum":["nel"],"example":"nel"},"value":{"$ref":"#/components/schemas/nel_value"}}}],"title":"Network Error Logging","description":"Enable Network Error Logging reporting on your zone. (Beta) "},"nel_value":{"type":"object","description":"Value of the zone setting.","properties":{"enabled":{"type":"boolean","default":false,"example":false}}},"network":{"type":"array","description":"A list of network ranges that requests from this location would originate from.","items":{"type":"string","description":"The IPv4 address or IPv4 CIDR. IPv4 CIDRs are limited to a maximum of /24.","example":"192.0.2.1/32"}},"neverRequireSignedURLs":{"type":"boolean","description":"Indicates whether the variant can access an image without a signature, regardless of image access control.","default":false,"example":true},"new-project-response":{"allOf":[{"$ref":"#/components/schemas/api-response-common"},{"properties":{"result":{"type":"object"}}}]},"new_custom_entry":{"type":"object","title":"Custom entry","description":"A custom entry create payload","required":["name","enabled","pattern"],"properties":{"enabled":{"type":"boolean","description":"Whether the entry is enabled or not.","example":true},"name":{"type":"string","description":"The name of the entry.","example":"Credit card (Visa)"},"pattern":{"$ref":"#/components/schemas/components-schemas-pattern"}}},"new_custom_profile":{"type":"object","properties":{"description":{"type":"string","description":"The description of the profile.","example":"A standard CVV card number"},"entries":{"type":"array","description":"The entries for this profile.","items":{"$ref":"#/components/schemas/new_custom_entry"}},"name":{"type":"string","description":"The name of the profile.","example":"Generic CVV Card Number"}}},"new_users_per_minute":{"type":"integer","description":"Sets the number of new users that will be let into the route every minute. This value is used as baseline for the number of users that are let in per minute. So it is possible that there is a little more or little less traffic coming to the route based on the traffic patterns at that time around the world.","minimum":200,"maximum":2147483647.0},"next_event_prequeue_start_time":{"type":"string","description":"An ISO 8601 timestamp that marks when the next event will begin queueing.","example":"2021-09-28T15:00:00.000Z","nullable":true},"next_event_start_time":{"type":"string","description":"An ISO 8601 timestamp that marks when the next event will start.","example":"2021-09-28T15:00:00.000Z","nullable":true},"nexthop":{"type":"string","description":"The next-hop IP Address for the static route.","example":"203.0.113.1"},"nft":{"type":"object","readOnly":true,"properties":{"contract":{"type":"string","description":"The ERC-721 compatible contract address.","example":502068565625872582926498748998639441147775675013,"readOnly":true,"minLength":42,"maxLength":42},"token":{"type":"integer","description":"The token ID for the NFT.","readOnly":true}}},"node_result":{"type":"object","example":{"asn":"AS13335","ip":"1.1.1.1","max_latency_ms":0.034,"mean_latency_ms":0.021,"min_latency_ms":0.014,"name":"one.one.one.one","packet_count":3,"std_dev_latency_ms":0.011269427669584647},"properties":{"asn":{"$ref":"#/components/schemas/schemas-asn"},"ip":{"$ref":"#/components/schemas/traceroute_components-schemas-ip"},"labels":{"$ref":"#/components/schemas/labels"},"max_rtt_ms":{"$ref":"#/components/schemas/max_rtt_ms"},"mean_rtt_ms":{"$ref":"#/components/schemas/mean_rtt_ms"},"min_rtt_ms":{"$ref":"#/components/schemas/min_rtt_ms"},"name":{"$ref":"#/components/schemas/traceroute_components-schemas-name"},"packet_count":{"$ref":"#/components/schemas/packet_count"},"std_dev_rtt_ms":{"$ref":"#/components/schemas/std_dev_rtt_ms"}}},"not_before":{"type":"string","format":"date-time","description":"The time before which the token MUST NOT be accepted for processing.","example":"2018-07-01T05:20:00Z"},"notes":{"type":"string","description":"An informative summary of the rule, typically used as a reminder or explanation.","example":"This rule is enabled because of an event that occurred on date X."},"notification_email":{"type":"string","description":"The email address to send health status notifications to. This can be an individual mailbox or a mailing list. Multiple emails can be supplied as a comma delimited list.","example":"someone@example.com,sometwo@example.com"},"notification_filter":{"type":"object","description":"Filter pool and origin health notifications by resource type or health status. Use null to reset.","example":{"origin":{"disable":true},"pool":{"healthy":false}},"nullable":true,"properties":{"origin":{"$ref":"#/components/schemas/filter_options"},"pool":{"$ref":"#/components/schemas/filter_options"}}},"notificationUrl":{"type":"string","format":"uri","description":"The URL where webhooks will be sent.","example":"https://example.com"},"ns_name":{"type":"string","format":"hostname","description":"The FQDN of the name server.","example":"ns1.example.com"},"num_items":{"type":"number","description":"The number of items in the list.","example":10},"num_referencing_filters":{"type":"number","description":"The number of [filters](#filters) referencing the list.","example":2},"object":{"type":"object","properties":{"hasStoredData":{"type":"boolean","description":"Whether the Durable Object has stored data.","example":true,"readOnly":true},"id":{"type":"string","description":"ID of the Durable Object.","example":"fe7803fc55b964e09d94666545aab688d360c6bda69ba349ced1e5f28d2fc2c8","readOnly":true}}},"occurred_at":{"type":"string","format":"date-time","description":"When the billing item was created.","example":"2014-03-01T12:21:59.3456Z","readOnly":true},"okta_group_rule":{"type":"object","title":"Okta group","description":"Matches an Okta group.\nRequires an Okta identity provider.","required":["okta"],"properties":{"okta":{"type":"object","required":["email","connection_id"],"properties":{"connection_id":{"type":"string","description":"The ID of your Okta identity provider.","example":"ea85612a-29c8-46c2-bacb-669d65136971"},"email":{"type":"string","description":"The email of the Okta group.","example":"devs@cloudflare.com"}}}}},"on_demand_enabled":{"type":"boolean","description":"Whether advertisement of the prefix to the Internet may be dynamically enabled or disabled.","example":true},"on_demand_locked":{"type":"boolean","description":"Whether advertisement status of the prefix is locked, meaning it cannot be changed.","example":false},"oneTimeUploadExpiry":{"type":"string","format":"date-time","description":"The date and time when the video upload URL is no longer valid for direct user uploads.","example":"2014-01-02T02:20:00Z"},"opacity":{"type":"number","description":"The translucency of the image. A value of `0.0` makes the image completely transparent, and `1.0` makes the image completely opaque. Note that if the image is already semi-transparent, setting this to `1.0` will not make the image completely opaque.","default":1,"example":0.75,"readOnly":true,"minimum":0,"maximum":1},"openapi":{"type":"object","description":"A OpenAPI 3.0.0 compliant schema.","example":{"info":{"title":"OpenAPI JSON schema for www.example.com","version":"1.0"},"openapi":"3.0.0","paths":{"... Further paths ...":{},"/api/v1/users/{var1}":{"get":{"parameters":[{"in":"path","name":"var1","required":true,"schema":{"type":"string"}}]}}},"servers":[{"url":"www.example.com"}]}},"openapiwiththresholds":{"type":"object","description":"A OpenAPI 3.0.0 compliant schema.","example":{"info":{"title":"OpenAPI JSON schema for www.example.com","version":"1.0"},"openapi":"3.0.0","paths":{"... Further paths ...":{},"/api/v1/users/{var1}":{"get":{"parameters":[{"in":"path","name":"var1","required":true,"schema":{"type":"string"}}]}}},"servers":[{"url":"www.example.com"}]}},"operation":{"type":"object","required":["operation_id","method","host","endpoint","last_updated"],"properties":{"endpoint":{"$ref":"#/components/schemas/endpoint"},"features":{"$ref":"#/components/schemas/features"},"host":{"$ref":"#/components/schemas/host"},"last_updated":{"$ref":"#/components/schemas/timestamp"},"method":{"$ref":"#/components/schemas/method"},"operation_id":{"$ref":"#/components/schemas/operation_id"}}},"operation_id":{"description":"The ID that identifies the API operation."},"opportunistic_encryption":{"allOf":[{"$ref":"#/components/schemas/schemas-base"},{"properties":{"id":{"description":"ID of the zone setting.","enum":["opportunistic_encryption"],"example":"opportunistic_encryption"},"value":{"$ref":"#/components/schemas/opportunistic_encryption_value"}}}],"title":"Enable Opportunistic Encryption for a zone","description":"Enables the Opportunistic Encryption feature for a zone."},"opportunistic_encryption_value":{"type":"string","description":"Value of the zone setting.\nNotes: Default value depends on the zone's plan level.","enum":["on","off"],"default":"on"},"opportunistic_onion":{"allOf":[{"$ref":"#/components/schemas/schemas-base"},{"properties":{"id":{"description":"ID of the zone setting.","enum":["opportunistic_onion"],"example":"opportunistic_onion"},"value":{"$ref":"#/components/schemas/opportunistic_onion_value"}}}],"title":"Zone Enable Onion Routing","description":"Add an Alt-Svc header to all legitimate requests from Tor, allowing the connection to use our onion services instead of exit nodes.","default":"off"},"opportunistic_onion_value":{"type":"string","description":"Value of the zone setting.\nNotes: Default value depends on the zone's plan level.","enum":["on","off"],"default":"off"},"options":{"type":"object","description":"Allows you to define image resizing sizes for different use cases.","required":["fit","metadata","width","height"],"properties":{"fit":{"$ref":"#/components/schemas/fit"},"height":{"$ref":"#/components/schemas/schemas-height"},"metadata":{"$ref":"#/components/schemas/schemas-metadata"},"width":{"$ref":"#/components/schemas/schemas-width"}}},"orange_to_orange":{"allOf":[{"$ref":"#/components/schemas/schemas-base"},{"properties":{"id":{"description":"ID of the zone setting.","enum":["orange_to_orange"],"example":"orange_to_orange"},"value":{"$ref":"#/components/schemas/orange_to_orange_value"}}}],"title":"Orange to Orange","description":"Orange to Orange (O2O) allows zones on Cloudflare to CNAME to other zones also on Cloudflare."},"orange_to_orange_value":{"type":"string","description":"Value of the zone setting.","enum":["on","off"],"default":"on"},"organization":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/common_components-schemas-identifier"},"name":{"$ref":"#/components/schemas/schemas-name"},"permissions":{"$ref":"#/components/schemas/schemas-permissions"},"roles":{"type":"array","description":"List of roles that a user has within an organization.","readOnly":true,"items":{"type":"string","example":"All Privileges - Super Administrator","maxLength":120}},"status":{"$ref":"#/components/schemas/components-schemas-status"}}},"organization_components-schemas-identifier":{"type":"string","description":"Organization identifier tag.","example":"01a7362d577a6c3019a474fd6f485823","readOnly":true,"maxLength":32},"organization_invite":{"allOf":[{"$ref":"#/components/schemas/base"},{"properties":{"organization_is_enforcing_twofactor":{"type":"boolean","description":"Current status of two-factor enforcement on the organization.","default":false,"example":true},"status":{"type":"string","description":"Current status of the invitation.","enum":["pending","accepted","rejected","canceled","left","expired"],"example":"accepted"}}}]},"organizations":{"type":"object","properties":{"auth_domain":{"$ref":"#/components/schemas/auth_domain"},"created_at":{"$ref":"#/components/schemas/timestamp"},"is_ui_read_only":{"$ref":"#/components/schemas/is_ui_read_only"},"login_design":{"$ref":"#/components/schemas/login_design"},"name":{"$ref":"#/components/schemas/organizations_components-schemas-name"},"updated_at":{"$ref":"#/components/schemas/timestamp"}}},"organizations_components-schemas-identifier":{"example":"699d98642c564d2e855e9661899b7252"},"organizations_components-schemas-name":{"type":"string","description":"The name of your Zero Trust organization.","example":"Widget Corps Internal Applications"},"organizations_components-schemas-single_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/organizations"}}}]},"origin":{"type":"string","description":"Your origin hostname that requests to your custom hostnames will be sent to.","example":"fallback.example.com","maxLength":255},"origin_components-schemas-enabled":{"type":"boolean","description":"Whether to enable (the default) this origin within the pool. Disabled origins will not receive traffic and are excluded from health checks. The origin will only be disabled for the current pool.","default":true,"example":true},"origin_components-schemas-name":{"type":"string","description":"A human-identifiable name for the origin.","example":"app-server-1"},"origin_dns":{"type":"object","description":"The name and type of DNS record for the Spectrum application.","properties":{"name":{"$ref":"#/components/schemas/origin_dns_name"},"ttl":{"$ref":"#/components/schemas/dns_ttl"},"type":{"$ref":"#/components/schemas/origin_dns_type"}}},"origin_dns_name":{"type":"string","format":"hostname","description":"The name of the DNS record associated with the origin.","example":"origin.example.com"},"origin_dns_type":{"type":"string","description":"The type of DNS record associated with the origin. \"\" is used to specify a combination of A/AAAA records.","enum":["","A","AAAA","SRV"],"example":""},"origin_error_page_pass_thru":{"allOf":[{"$ref":"#/components/schemas/schemas-base"},{"properties":{"id":{"description":"ID of the zone setting.","enum":["origin_error_page_pass_thru"],"example":"origin_error_page_pass_thru"},"value":{"$ref":"#/components/schemas/origin_error_page_pass_thru_value"}}}],"title":"Error Pages On","description":"Cloudflare will proxy customer error pages on any 502,504 errors on origin server instead of showing a default Cloudflare error page. This does not apply to 522 errors and is limited to Enterprise Zones.","default":"off"},"origin_error_page_pass_thru_value":{"type":"string","description":"Value of the zone setting.","enum":["on","off"],"default":"off"},"origin_ips":{"type":"array","example":["192.0.2.1","198.51.100.1","2001:DB8:100::CF"],"items":{"anyOf":[{"type":"string","format":"ipv4","description":"Origin DNS Server IPv4 Address.","example":"192.0.2.1"},{"type":"string","format":"ipv6","description":"Origin DNS Server IPv6 Address.","example":"2001:DB8:100::CF"}]}},"origin_max_http_version":{"allOf":[{"required":["id"],"properties":{"id":{"description":"Identifier of the zone setting.","enum":["origin_max_http_version"],"example":"origin_max_http_version"},"modified_on":{"type":"string","format":"date-time","description":"last time this setting was modified.","example":"2014-01-01T05:20:00.12345Z","nullable":true,"readOnly":true}}}],"title":"Origin Max HTTP version","description":"The highest HTTP version Cloudflare will attempt to use with your origin. This setting allows Cloudflare to make HTTP/2 requests to your origin. (Refer to [Enable HTTP/2 to Origin](https://developers.cloudflare.com/cache/how-to/enable-http2-to-origin/), for more information.)."},"origin_max_http_version_response_value":{"properties":{"result":{"allOf":[{"$ref":"#/components/schemas/origin_max_http_version"},{"required":["value"],"properties":{"value":{"$ref":"#/components/schemas/origin_max_http_version_value"}}}]}}},"origin_max_http_version_value":{"type":"string","description":"Value of the Origin Max HTTP version setting (Note that the default value for Enterprise is \"1\").","enum":["1","2"],"default":"2"},"origin_port":{"anyOf":[{"type":"integer"},{"type":"string"}],"description":"The destination port at the origin. Only specified in conjunction with origin_dns. May use an integer to specify a single origin port, for example `1000`, or a string to specify a range of origin ports, for example `\"1000-2000\"`.\nNotes: If specifying a port range, the number of ports in the range must match the number of ports specified in the \"protocol\" field.","example":22,"minimum":1,"maximum":65535},"origin_steering":{"type":"object","description":"Configures origin steering for the pool. Controls how origins are selected for new sessions and traffic without session affinity.","properties":{"policy":{"type":"string","description":"The type of origin steering policy to use, either \"random\" or \"hash\" (based on CF-Connecting-IP).","enum":["random","hash"],"default":"random"}}},"origin_traffic":{"type":"boolean","description":"When true, only the uncached traffic served from your origin servers will count towards rate limiting. In this case, any cached traffic served by Cloudflare will not count towards rate limiting. This field is optional.\nNotes: This field is deprecated. Instead, use response headers and set \"origin_traffic\" to \"false\" to avoid legacy behaviour interacting with the \"response_headers\" property."},"original_url":{"type":"string","format":"uri","description":"URI to original variant for an image.","example":"https://imagedelivery.net/MTt4OTd0b0w5aj/107b9558-dd06-4bbd-5fef-9c2c16bb7900/original","readOnly":true},"origins":{"type":"array","description":"The list of origins within this pool. Traffic directed at this pool is balanced across all currently healthy origins, provided the pool itself is healthy.","items":{"$ref":"#/components/schemas/schemas-origin"}},"os_distro_name":{"type":"string","description":"The Linux distro name.","example":"ubuntu"},"os_distro_revision":{"type":"string","description":"The Linux distro revision.","example":"1.0.0"},"os_version":{"type":"string","description":"The operating system version.","example":"10.0.0"},"output":{"properties":{"enabled":{"$ref":"#/components/schemas/output_enabled"},"streamKey":{"$ref":"#/components/schemas/output_streamKey"},"uid":{"$ref":"#/components/schemas/output_identifier"},"url":{"$ref":"#/components/schemas/output_url"}}},"output_enabled":{"type":"boolean","description":"When enabled, live video streamed to the associated live input will be sent to the output URL. When disabled, live video will not be sent to the output URL, even when streaming to the associated live input. Use this to control precisely when you start and stop simulcasting to specific destinations like YouTube and Twitch.","default":true,"example":true},"output_identifier":{"type":"string","description":"A unique identifier for the output.","example":"baea4d9c515887b80289d5c33cf01145","readOnly":true,"maxLength":32},"output_response_collection":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/output"}}}}]},"output_response_single":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/output"}}}]},"output_streamKey":{"type":"string","description":"The streamKey used to authenticate against an output's target.","example":"uzya-f19y-g2g9-a2ee-51j2","readOnly":true},"output_url":{"type":"string","description":"The URL an output uses to restream.","example":"rtmp://a.rtmp.youtube.com/live2","readOnly":true},"override":{"properties":{"description":{"$ref":"#/components/schemas/overrides_components-schemas-description"},"groups":{"$ref":"#/components/schemas/groups"},"id":{"$ref":"#/components/schemas/overrides_components-schemas-id"},"paused":{"$ref":"#/components/schemas/schemas-paused"},"priority":{"$ref":"#/components/schemas/overrides_components-schemas-priority"},"rewrite_action":{"$ref":"#/components/schemas/rewrite_action"},"rules":{"$ref":"#/components/schemas/schemas-rules"},"urls":{"$ref":"#/components/schemas/urls"}}},"override_codes_response":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"type":"object","properties":{"disable_for_time":{"$ref":"#/components/schemas/disable_for_time"}}}}}]},"override_response_collection":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"type":"object","required":["result"],"properties":{"result":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/override"},{"type":"object","required":["id","paused","urls","priority"]}]}}}}]},"override_response_single":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"type":"object","required":["result"],"properties":{"result":{"$ref":"#/components/schemas/override"}}}]},"overrides_components-schemas-description":{"type":"string","description":"An informative summary of the current URI-based WAF override.","example":"Enable Cloudflare Magento ruleset for shop.example.com","nullable":true,"maxLength":1024},"overrides_components-schemas-id":{"type":"string","description":"The unique identifier of the WAF override.","example":"de677e5818985db1285d0e80225f06e5","readOnly":true,"maxLength":32},"overrides_components-schemas-priority":{"type":"number","description":"The relative priority of the current URI-based WAF override when multiple overrides match a single URL. A lower number indicates higher priority. Higher priority overrides may overwrite values set by lower priority overrides.","example":1,"minimum":"-1e+09","maximum":"1e+09"},"ownership_challenge":{"type":"string","description":"Ownership challenge token to prove destination ownership.","example":"00000000000000000000","maxLength":4096,"pattern":"^[a-zA-Z0-9/\\+\\.\\-_]*$"},"ownership_verification":{"oneOf":[{"type":"object","properties":{"name":{"type":"string","description":"DNS Name for record.","example":"_cf-custom-hostname.app.example.com"},"type":{"description":"DNS Record type.","enum":["txt"],"example":"txt"},"value":{"type":"string","description":"Content for the record.","example":"5cc07c04-ea62-4a5a-95f0-419334a875a4"}}}],"type":"object","description":"This is a record which can be placed to activate a hostname."},"ownership_verification_http":{"oneOf":[{"type":"object","properties":{"http_body":{"type":"string","description":"Token to be served.","example":"5cc07c04-ea62-4a5a-95f0-419334a875a4"},"http_url":{"type":"string","description":"The HTTP URL that will be checked during custom hostname verification and where the customer should host the token.","example":"http://custom.test.com/.well-known/cf-custom-hostname-challenge/0d89c70d-ad9f-4843-b99f-6cc0252067e9"}}}],"type":"object","description":"This presents the token to be served by the given http url to activate a hostname."},"p50":{"type":"integer","description":"The p50 quantile of requests (in period_seconds).","readOnly":true},"p90":{"type":"integer","description":"The p90 quantile of requests (in period_seconds).","readOnly":true},"p99":{"type":"integer","description":"The p99 quantile of requests (in period_seconds).","readOnly":true},"package":{"oneOf":[{"$ref":"#/components/schemas/package_definition"},{"$ref":"#/components/schemas/anomaly_package"}],"type":"object"},"package_components-schemas-description":{"type":"string","description":"A summary of the purpose/function of the WAF package.","example":"null","readOnly":true},"package_components-schemas-identifier":{"type":"string","description":"The unique identifier of a WAF package.","example":"a25a9a7e9c00afc1fb2e0245519d725b","readOnly":true,"maxLength":32},"package_components-schemas-name":{"type":"string","description":"The name of the WAF package.","example":"USER","readOnly":true},"package_components-schemas-status":{"type":"string","description":"When set to `active`, indicates that the WAF package will be applied to the zone.","enum":["active"],"default":"active","readOnly":true},"package_definition":{"title":"Traditional WAF package","required":["id","name","description","detection_mode","zone_id"],"properties":{"description":{"$ref":"#/components/schemas/package_components-schemas-description"},"detection_mode":{"$ref":"#/components/schemas/detection_mode"},"id":{"$ref":"#/components/schemas/package_components-schemas-identifier"},"name":{"$ref":"#/components/schemas/package_components-schemas-name"},"status":{"$ref":"#/components/schemas/package_components-schemas-status"},"zone_id":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}},"package_response_collection":{"anyOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/package"}}}}]},"package_response_single":{"oneOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"type":"object"}}}]},"packet_count":{"type":"integer","description":"Number of packets with a response from this node."},"packet_type":{"type":"string","description":"Type of packet sent.","enum":["icmp","tcp","udp","gre","gre+icmp"],"default":"icmp","example":"icmp"},"packets_lost":{"type":"integer","description":"Number of packets where no response was received."},"packets_per_ttl":{"type":"integer","description":"Number of packets sent at each TTL.","default":3,"minimum":0,"maximum":10},"packets_sent":{"type":"integer","description":"Number of packets sent with specified TTL."},"packets_ttl":{"type":"integer","description":"The time to live (TTL)."},"padding":{"type":"number","description":"The whitespace between the adjacent edges (determined by position) of the video and the image. `0.0` indicates no padding, and `1.0` indicates a fully padded video width or length, as determined by the algorithm.","default":0.05,"example":0.1,"readOnly":true,"minimum":0,"maximum":1},"page":{"type":"number","description":"Current page within paginated list of results.","example":1},"page-rule":{"type":"object","required":["id","targets","actions","priority","status","modified_on","created_on"],"properties":{"actions":{"$ref":"#/components/schemas/schemas-actions"},"created_on":{"$ref":"#/components/schemas/created_on"},"id":{"$ref":"#/components/schemas/common_components-schemas-identifier"},"modified_on":{"$ref":"#/components/schemas/page-rule_components-schemas-modified_on"},"priority":{"$ref":"#/components/schemas/page-rule_components-schemas-priority"},"status":{"$ref":"#/components/schemas/page-rule_components-schemas-status"},"targets":{"$ref":"#/components/schemas/targets"}}},"page-rule_components-schemas-modified_on":{"type":"string","format":"date-time","description":"The timestamp of when the Page Rule was last modified.","example":"2014-01-01T05:20:00.12345Z","readOnly":true},"page-rule_components-schemas-priority":{"type":"integer","description":"The priority of the rule, used to define which Page Rule is processed over another. A higher number indicates a higher priority. For example, if you have a catch-all Page Rule (rule A: `/images/*`) but want a more specific Page Rule to take precedence (rule B: `/images/special/*`), specify a higher priority for rule B so it overrides rule A.","default":1},"page-rule_components-schemas-status":{"type":"string","description":"The status of the Page Rule.","enum":["active","disabled"],"default":"disabled","example":"active"},"pagerduty":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/uuid"},"name":{"$ref":"#/components/schemas/pagerduty_components-schemas-name"}}},"pagerduty_components-schemas-name":{"type":"string","description":"The name of the pagerduty service.","example":"My PagerDuty Service"},"pagerduty_components-schemas-response_collection":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/pagerduty"}}}}]},"pagerule_response_collection":{"allOf":[{"$ref":"#/components/schemas/api-response-common"},{"properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/page-rule"}}}}]},"pagerule_response_single":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"type":"object"}}}]},"pagerule_settings_response_collection":{"allOf":[{"$ref":"#/components/schemas/api-response-common"},{"properties":{"result":{"$ref":"#/components/schemas/settings"}}}]},"pageviews":{"type":"object","description":"Breakdown of totals for pageviews.","properties":{"all":{"type":"integer","description":"The total number of pageviews served within the time range."},"search_engine":{"type":"object","description":"A variable list of key/value pairs representing the search engine and number of hits.","example":{"baidubot":1345,"bingbot":5372,"googlebot":35272,"pingdom":13435}}}},"passive-dns-by-ip":{"properties":{"count":{"type":"number","description":"Total results returned based on your search parameters.","example":1},"page":{"type":"number","description":"Current page within paginated list of results.","example":1},"per_page":{"type":"number","description":"Number of results per page of results.","example":20},"reverse_records":{"type":"array","description":"Reverse DNS look-ups observed during the time period.","items":{"type":"object","properties":{"first_seen":{"type":"string","format":"date","description":"First seen date of the DNS record during the time period.","example":"2021-04-01"},"hostname":{"description":"Hostname that the IP was observed resolving to."},"last_seen":{"type":"string","format":"date","description":"Last seen date of the DNS record during the time period.","example":"2021-04-30"}}}}}},"passive-dns-by-ip_components-schemas-single_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/passive-dns-by-ip"}}}]},"patch":{"type":"object","description":"Update enablement of Argo Smart Routing","required":["value"],"properties":{"value":{"$ref":"#/components/schemas/schemas-value"}}},"patch_pools_notification_email":{"type":"string","description":"The email address to send health status notifications to. This field is now deprecated in favor of Cloudflare Notifications for Load Balancing, so only resetting this field with an empty string `\"\"` is accepted.","enum":["\"\""],"example":""},"patch_rule":{"required":["action","expression"],"properties":{"action":{"$ref":"#/components/schemas/rule_action"},"description":{"$ref":"#/components/schemas/rule_description"},"enabled":{"$ref":"#/components/schemas/rule_enabled"},"expression":{"$ref":"#/components/schemas/rule_expression"},"position":{"$ref":"#/components/schemas/rule_position"}}},"path":{"type":"string","description":"The endpoint path you want to conduct a health check against. This parameter is only valid for HTTP and HTTPS monitors.","default":"/","example":"/health"},"pattern":{"type":"string","title":"Route pattern","example":"example.net/*"},"paused":{"type":"boolean","description":"Indicates whether the zone is only using Cloudflare DNS services. A true value means the zone will not receive security or performance benefits.","default":false,"readOnly":true},"pcaps_byte_limit":{"type":"number","description":"The maximum number of bytes to capture. This field only applies to `full` packet captures.","example":500000,"minimum":1,"maximum":"1e+09"},"pcaps_collection_response":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/pcaps_response_simple"},{"$ref":"#/components/schemas/pcaps_response_full"}]}}}}]},"pcaps_colo_name":{"type":"string","description":"The name of the data center used for the packet capture. This can be a specific colo (ord02) or a multi-colo name (ORD). This field only applies to `full` packet captures.","example":"ord02"},"pcaps_destination_conf":{"type":"string","description":"The full URI for the bucket. This field only applies to `full` packet captures.","example":"s3://pcaps-bucket?region=us-east-1"},"pcaps_error_message":{"type":"string","description":"An error message that describes why the packet capture failed. This field only applies to `full` packet captures.","example":"No packets matched the filter in the time limit given. Please modify the filter or try again."},"pcaps_filter_v1":{"type":"object","description":"The packet capture filter. When this field is empty, all packets are captured.","properties":{"destination_address":{"type":"string","description":"The destination IP address of the packet.","example":"1.2.3.4"},"destination_port":{"type":"number","description":"The destination port of the packet.","example":80},"protocol":{"type":"number","description":"The protocol number of the packet.","example":6},"source_address":{"type":"string","description":"The source IP address of the packet.","example":"1.2.3.4"},"source_port":{"type":"number","description":"The source port of the packet.","example":123}}},"pcaps_id":{"type":"string","description":"The ID for the packet capture.","example":"66802ca5668e47a2b82c2e6746e45037","minLength":32,"maxLength":32},"pcaps_ownership_challenge":{"type":"string","description":"The ownership challenge filename stored in the bucket.","example":"ownership-challenge-9883874ecac311ec8475433579a6bf5f.txt"},"pcaps_ownership_collection":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/pcaps_ownership_response"}}}}]},"pcaps_ownership_request":{"type":"object","required":["destination_conf"],"properties":{"destination_conf":{"$ref":"#/components/schemas/pcaps_destination_conf"}}},"pcaps_ownership_response":{"type":"object","required":["id","status","submitted","destination_conf","filename"],"properties":{"destination_conf":{"$ref":"#/components/schemas/pcaps_destination_conf"},"filename":{"$ref":"#/components/schemas/pcaps_ownership_challenge"},"id":{"type":"string","description":"The bucket ID associated with the packet captures API.","example":"9883874ecac311ec8475433579a6bf5f","minLength":32,"maxLength":32},"status":{"type":"string","description":"The status of the ownership challenge. Can be pending, success or failed.","enum":["pending","success","failed"],"example":"success"},"submitted":{"type":"string","description":"The RFC 3339 timestamp when the bucket was added to packet captures API.","example":"2020-01-01T08:00:00Z"},"validated":{"type":"string","description":"The RFC 3339 timestamp when the bucket was validated.","example":"2020-01-01T08:00:00Z"}}},"pcaps_ownership_single_response":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"$ref":"#/components/schemas/pcaps_ownership_response"}}}]},"pcaps_ownership_validate_request":{"type":"object","required":["destination_conf","ownership_challenge"],"properties":{"destination_conf":{"$ref":"#/components/schemas/pcaps_destination_conf"},"ownership_challenge":{"$ref":"#/components/schemas/pcaps_ownership_challenge"}}},"pcaps_packet_limit":{"type":"number","description":"The limit of packets contained in a packet capture.","example":10000,"minimum":1,"maximum":10000},"pcaps_request_full":{"type":"object","required":["time_limit","type","system","colo_name","destination_conf"],"properties":{"byte_limit":{"$ref":"#/components/schemas/pcaps_byte_limit"},"colo_name":{"$ref":"#/components/schemas/pcaps_colo_name"},"destination_conf":{"$ref":"#/components/schemas/pcaps_destination_conf"},"filter_v1":{"$ref":"#/components/schemas/pcaps_filter_v1"},"packet_limit":{"$ref":"#/components/schemas/pcaps_packet_limit"},"system":{"$ref":"#/components/schemas/pcaps_system"},"time_limit":{"$ref":"#/components/schemas/pcaps_time_limit"},"type":{"$ref":"#/components/schemas/pcaps_type"}}},"pcaps_request_pcap":{"anyOf":[{"$ref":"#/components/schemas/pcaps_request_simple"},{"$ref":"#/components/schemas/pcaps_request_full"}]},"pcaps_request_simple":{"type":"object","required":["time_limit","packet_limit","type","system"],"properties":{"filter_v1":{"$ref":"#/components/schemas/pcaps_filter_v1"},"packet_limit":{"$ref":"#/components/schemas/pcaps_packet_limit"},"system":{"$ref":"#/components/schemas/pcaps_system"},"time_limit":{"$ref":"#/components/schemas/pcaps_time_limit"},"type":{"$ref":"#/components/schemas/pcaps_type"}}},"pcaps_response_full":{"type":"object","properties":{"byte_limit":{"$ref":"#/components/schemas/pcaps_byte_limit"},"colo_name":{"$ref":"#/components/schemas/pcaps_colo_name"},"destination_conf":{"$ref":"#/components/schemas/pcaps_destination_conf"},"error_message":{"$ref":"#/components/schemas/pcaps_error_message"},"filter_v1":{"$ref":"#/components/schemas/pcaps_filter_v1"},"id":{"$ref":"#/components/schemas/pcaps_id"},"status":{"$ref":"#/components/schemas/pcaps_status"},"submitted":{"$ref":"#/components/schemas/pcaps_submitted"},"system":{"$ref":"#/components/schemas/pcaps_system"},"time_limit":{"$ref":"#/components/schemas/pcaps_time_limit"},"type":{"$ref":"#/components/schemas/pcaps_type"}}},"pcaps_response_simple":{"type":"object","properties":{"filter_v1":{"$ref":"#/components/schemas/pcaps_filter_v1"},"id":{"$ref":"#/components/schemas/pcaps_id"},"status":{"$ref":"#/components/schemas/pcaps_status"},"submitted":{"$ref":"#/components/schemas/pcaps_submitted"},"system":{"$ref":"#/components/schemas/pcaps_system"},"time_limit":{"$ref":"#/components/schemas/pcaps_time_limit"},"type":{"$ref":"#/components/schemas/pcaps_type"}}},"pcaps_single_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"anyOf":[{"$ref":"#/components/schemas/pcaps_response_simple"},{"$ref":"#/components/schemas/pcaps_response_full"}]}}}]},"pcaps_status":{"type":"string","description":"The status of the packet capture request.","enum":["unknown","success","pending","running","conversion_pending","conversion_running","complete","failed"],"example":"success"},"pcaps_submitted":{"type":"string","description":"The RFC 3339 timestamp when the packet capture was created.","example":"2020-01-01T08:00:00Z"},"pcaps_system":{"type":"string","description":"The system used to collect packet captures.","enum":["magic-transit"],"example":"magic-transit"},"pcaps_time_limit":{"type":"number","description":"The packet capture duration in seconds.","example":300,"minimum":1,"maximum":300},"pcaps_type":{"type":"string","description":"The type of packet capture. `Simple` captures sampled packets, and `full` captures entire payloads and non-sampled packets.","enum":["simple","full"],"example":"simple"},"pctComplete":{"type":"string","description":"Indicates the size of the entire upload in bytes. The value must be a non-negative integer.","readOnly":true,"minimum":0,"maximum":100},"peer":{"type":"object","required":["id","name"],"properties":{"id":{"$ref":"#/components/schemas/peer_components-schemas-identifier"},"ip":{"$ref":"#/components/schemas/ip"},"ixfr_enable":{"$ref":"#/components/schemas/ixfr_enable"},"name":{"$ref":"#/components/schemas/peer_components-schemas-name"},"port":{"$ref":"#/components/schemas/port"},"tsig_id":{"$ref":"#/components/schemas/tsig_id"}}},"peer_components-schemas-id_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/peer_components-schemas-identifier"}}}}}]},"peer_components-schemas-identifier":{"example":"23ff594956f20c2a721606e94745a8aa"},"peer_components-schemas-name":{"type":"string","description":"The name of the peer.","example":"my-peer-1"},"peer_components-schemas-response_collection":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/peer"}}}}]},"peer_components-schemas-single_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/peer"}}}]},"peers":{"type":"array","description":"A list of peer tags.","example":["23ff594956f20c2a721606e94745a8aa","00920f38ce07c2e2f4df50b1f61d4194"],"items":{}},"pem":{"type":"string","description":"The signing key in PEM format.","example":"LS0tLS1CRUdJTiBSU0EgUFJJVkFURSBLRVktLS0tLQpNSUlFcGdJQkFBS0NBUUVBMFRqd2pPaVpXbUo0M3ZmM1RvNERvWG1YV3RKR05HeVhmaHl0dExhQmdGMStFUVdRCkRLaG9LYm9hS21xakNBc21za3V0YkxVN1BVOGRrUU5ER1p3S3VWczA4elNaNGt4aTR0RWdQUFp5dDdkWEMrbFkKUllveXJBR0Y0QVhoeTMyOWJIQ1AxSWxyQkIvQWtHZ25kTEFndW54WTByUmdjdk96aWF3NktKeEZuYzJVSzBXVQo4YjBwNEtLSEdwMUtMOWRrMFdUOGRWWXFiZVJpSmpDbFVFbWg4eXY5Q2xPVmFTNEt4aVg2eFRRNERadzZEYUpmCklWM1F0Tmd2cG1ieWxOSmFQSG5zc3JodDJHS1A5NjJlS2poUVJsaWd2SFhKTE9uSm9KZkxlSUVIWitpeFdmY1QKRE1IOTJzR3ZvdzFET2p4TGlDTjF6SEsraDdiTG9YVGlMZ2M0a3dJREFRQUJBb0lCQVFEQ0lCclNJMTlteGNkdwoycExVaUdCR0N4T3NhVDVLbGhkYUpESG9ZdzUxbEVuTWNXVGUyY01NTkdqaXdsN1NyOFlQMkxmcERaOFJtNzdMCk5rT2tGMnk3M3l5YUhFeEw5S1FyMys0Um9ubCtqTlp2YnV0QVdxSDVodEE0dER4MUd3NE85OEg4YWlTcGh1eWQKRUliTGRrQm54OGlDZUdxbFBnbHZ6Q1dLV0xVZlhGbXplMkF5UjBzaWMyYXZRLzZyclYwb3pDdGQ1T0Vod093agphaCs3N1dZV1l0bkEraDhXZVZreWcvdG44UTJJOXo5ZVJYdlZxR2sxMDZLcWRtZFdiU2tIZzA4cFRUSGhVM2paCnMvZGNjdEdOMWFFanlUQWY0QzdHT2lrcUd1MGFTaW1aeDFOM2RWQzBobngySjJtdlhNQ0VtZ0g3TjVnZUxWUFAKOWdkQjdBQkJBb0dCQU5sT2hGQVhaTHV6Y0Ftczl1K3AxM05STWRFOHpIK2ZFaFBrbk9zZ21Xb3VqUzkxQTRtZgpuK01oN3d5bTZoVU1DbDk2WUNMNGtPM0RUMmlYWlRqTXZuMHBoVEx1MXNYcGxWNDJuamRnZGd3cFBEM0FnL1Y5ClVvV2hxdVhoa1I3RFpsUGg5Nmk1aEE0M1BvbTVPQm9BektJbEcrT3ZKUkhhZEVveC9jSmZScFd2QW9HQkFQWjUKNnNmWDdESElCNEtBczRmMWRuNGZJUkMweUF2WVdCL1R3UzZHUWVoNFRFbDVuSkQwWk9ZRVdUbVVBK3pPanZTNApuM09tZ2xNQTU5SGd1ZW13QXVRcEtwWFBOcFUvTERJaThtNnpmTUpvL3E5M0NOQlFQZngzZGh4ZVh4OXE2Mzg3Cm84QWxkOE42RGs4TThjRis3SlNaeUVJODJzLzdpdGRseXA2bFdLaGRBb0dCQUtnU0VrUGYxQWxZdjA2OGVFRGwKRzc0VkRuTEdrMlFobzltKzk1N2psOFNJUEtwMzFrU2JNUTU3TUdpWXNIT1czRzc4TjE3VTRVTUR6R2NZc1RFOQpLaGVrQldGZldMMjU2OHp5Y1d4akx1bzQrbDdJaDBkWHBudTBqbms5L1AvT0lWYS9iczBRcnhKUHFBN2RNb2JxCkYxdFJXRURCTmVxWkMxaFhVZTBEdzVRQkFvR0JBSjdBQ2NNcnhKcVBycDZVakkyK1FOS2M5Q3dSZEdPRXRjWFMKR3JQL2owWE83YnZKVTFsZHYvc1N3L0U4NzRZL3lIM0F5QnF5SFhDZXZiRkZZQmt1MzczYThlM0pwK3RhNC9scQozdUVFUkEvbmxscW5mWXJHbEJZZlQzaVlKQVpWVkZiL3I4bWJtRmJVTDVFazBqV0JyWmxNcjFwU1hkRGx3QmhhCkhMWXY0em1WQW9HQkFLQmw0cFNnbkNSTEJMUU9jWjhXQmhRSjAwZDZieFNrTGNpZ0xUNFJvY3RwNTY1SHJPMDAKSVFLdElTaEg1a2s3SVRHdUYvOERXZEN2djBMYnhvZVBJc2NFaStTaXk5WDZwWENPaS8xa2FyYVU5U3BpZ3czago3YjVlUVV0UlovTkIycVJwc3EzMEdCUENqanhudEVmK2lqelhUS0xNRndyUDhBMTlQNzRONGVTMAotLS0tLUVORCBSU0EgUFJJVkFURSBLRVktLS0tLQo=","readOnly":true},"per_page":{"type":"number","description":"Number of results per page of results.","example":20},"period":{"type":"number","description":"The time in seconds (an integer value) to count matching traffic. If the count exceeds the configured threshold within this period, Cloudflare will perform the configured action.","example":900,"minimum":10,"maximum":86400},"period_seconds":{"type":"integer","description":"The period over which this threshold is suggested.","readOnly":true},"permission_group":{"type":"object","description":"A named group of permissions that map to a group of operations against resources.","required":["id"],"properties":{"id":{"type":"string","description":"Identifier of the group.","example":"6d7f2f5f5b1d4a0e9081fdc98d432fd1","readOnly":true},"name":{"type":"string","description":"Name of the group.","example":"Load Balancers Write","readOnly":true}}},"permission_groups":{"type":"array","description":"A set of permission groups that are specified to the policy.","example":[{"id":"c8fed203ed3043cba015a93ad1616f1f","name":"Zone Read"},{"id":"82e64a83756745bbbb1c9c2701bf816b","name":"DNS Read"}],"items":{"$ref":"#/components/schemas/permission_group"}},"permissions":{"type":"object","example":{"analytics":{"read":true,"write":false},"zones":{"read":true,"write":true}},"properties":{"analytics":{"$ref":"#/components/schemas/grants"},"billing":{"$ref":"#/components/schemas/grants"},"cache_purge":{"$ref":"#/components/schemas/grants"},"dns":{"$ref":"#/components/schemas/grants"},"dns_records":{"$ref":"#/components/schemas/grants"},"lb":{"$ref":"#/components/schemas/grants"},"logs":{"$ref":"#/components/schemas/grants"},"organization":{"$ref":"#/components/schemas/grants"},"ssl":{"$ref":"#/components/schemas/grants"},"waf":{"$ref":"#/components/schemas/grants"},"zone_settings":{"$ref":"#/components/schemas/grants"},"zones":{"$ref":"#/components/schemas/grants"}}},"phase":{"type":"string","description":"The phase of the ruleset.","example":"http_request_firewall_managed","pattern":"^[a-z_]+$"},"phishing-url-info":{"properties":{"categorizations":{"type":"array","description":"List of categorizations applied to this submission.","items":{"type":"object","properties":{"category":{"type":"string","description":"Name of the category applied.","example":"PHISHING"},"verification_status":{"type":"string","description":"Result of human review for this categorization.","example":"confirmed"}}}},"model_results":{"type":"array","description":"List of model results for completed scans.","items":{"type":"object","properties":{"model_name":{"type":"string","description":"Name of the model.","example":"MACHINE_LEARNING_v2"},"model_score":{"type":"number","description":"Score output by the model for this submission.","example":0.024}}}},"rule_matches":{"type":"array","description":"List of signatures that matched against site content found when crawling the URL.","items":{"type":"object","properties":{"banning":{"type":"boolean","description":"For internal use."},"blocking":{"type":"boolean","description":"For internal use."},"description":{"type":"string","description":"Description of the signature that matched.","example":"Match frequently used social followers phishing kit"},"name":{"type":"string","description":"Name of the signature that matched.","example":"phishkit.social_followers"}}}},"scan_status":{"type":"object","description":"Status of the most recent scan found.","properties":{"last_processed":{"type":"string","description":"Timestamp of when the submission was processed.","example":"Wed, 26 Oct 2022 16:04:51 GMT"},"scan_complete":{"type":"boolean","description":"For internal use."},"status_code":{"type":"integer","description":"Status code that the crawler received when loading the submitted URL."},"submission_id":{"type":"integer","description":"ID of the most recent submission."}}},"screenshot_download_signature":{"type":"string","description":"For internal use."},"screenshot_path":{"type":"string","description":"For internal use."},"url":{"type":"string","description":"URL that was submitted.","example":"https://www.cloudflare.com"}}},"phishing-url-info_components-schemas-single_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/phishing-url-info"}}}]},"phishing-url-submit":{"properties":{"excluded_urls":{"type":"array","description":"URLs that were excluded from scanning because their domain is in our no-scan list.","items":{"type":"object","properties":{"url":{"type":"string","description":"URL that was excluded.","example":"https://developers.cloudflare.com"}}}},"skipped_urls":{"type":"array","description":"URLs that were skipped because the same URL is currently being scanned","items":{"type":"object","properties":{"url":{"type":"string","description":"URL that was skipped.","example":"https://www.cloudflare.com/developer-week/"},"url_id":{"type":"integer","description":"ID of the submission of that URL that is currently scanning.","example":2}}}},"submitted_urls":{"type":"array","description":"URLs that were successfully submitted for scanning.","items":{"type":"object","properties":{"url":{"type":"string","description":"URL that was submitted.","example":"https://www.cloudflare.com"},"url_id":{"type":"integer","description":"ID assigned to this URL submission. Used to retrieve scanning results.","example":1}}}}}},"phishing-url-submit_components-schemas-single_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/phishing-url-submit"}}}]},"plan_response_collection":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"type":"object","properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/schemas-rate-plan"}}}}]},"platform":{"type":"string","enum":["windows","mac","linux","android","ios"],"example":"windows"},"playback":{"type":"object","readOnly":true,"properties":{"dash":{"type":"string","description":"DASH Media Presentation Description for the video.","example":"https://customer-m033z5x00ks6nunl.cloudflarestream.com/ea95132c15732412d22c1476fa83f27a/manifest/video.mpd","readOnly":true},"hls":{"type":"string","description":"The HLS manifest for the video.","example":"https://customer-m033z5x00ks6nunl.cloudflarestream.com/ea95132c15732412d22c1476fa83f27a/manifest/video.m3u8","readOnly":true}}},"policies":{"type":"array","description":"List of access policies assigned to the token.","items":{"$ref":"#/components/schemas/access-policy"}},"policies_components-schemas-description":{"type":"string","description":"Optional description for the Notification policy.","example":"Something describing the policy."},"policies_components-schemas-enabled":{"type":"boolean","description":"Whether or not the Notification policy is enabled.","default":true,"example":true},"policies_components-schemas-id_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/components-schemas-uuid"}}}}}]},"policies_components-schemas-id_response-2":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/uuid"}}}}}]},"policies_components-schemas-identifier":{"example":"699d98642c564d2e855e9661899b7252"},"policies_components-schemas-name":{"type":"string","description":"The name of the Access policy.","example":"Allow devs"},"policies_components-schemas-name-2":{"type":"string","description":"Name of the policy.","example":"SSL Notification Event Policy"},"policies_components-schemas-response_collection":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/schemas-policies"}}}}]},"policies_components-schemas-response_collection-2":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/components-schemas-policies"}}}}]},"policies_components-schemas-single_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/schemas-policies"}}}]},"policies_components-schemas-single_response-2":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/components-schemas-policies"}}}]},"policy":{"type":"string","description":"Specify the policy that determines the region where your private key will be held locally. HTTPS connections to any excluded data center will still be fully encrypted, but will incur some latency while Keyless SSL is used to complete the handshake with the nearest allowed data center. Any combination of countries, specified by their two letter country code (https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements) can be chosen, such as 'country: IN', as well as 'region: EU' which refers to the EU region. If there are too few data centers satisfying the policy, it will be rejected.","example":"(country: US) or (region: EU)"},"policy_check_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"type":"object","properties":{"app_state":{"type":"object","properties":{"app_uid":{"$ref":"#/components/schemas/uuid"},"aud":{"type":"string","example":"737646a56ab1df6ec9bddc7e5ca84eaf3b0768850f3ffb5d74f1534911fe389"},"hostname":{"type":"string","example":"test.com"},"name":{"type":"string","example":"Test App"},"policies":{"type":"array","example":[{"decision":"allow","exclude":[],"include":[{"_type":"email","email":"testuser@gmail.com"}],"precedence":0,"require":[],"status":"Success"}],"items":{}},"status":{"type":"string","example":"Success"}}},"user_identity":{"type":"object","properties":{"account_id":{"type":"string","example":"41ecfbb341f033e52b46742756aabb8b"},"device_sessions":{"type":"object","example":{}},"email":{"type":"string","example":"testuser@gmail.com"},"geo":{"type":"object","properties":{"country":{"type":"string","example":"US"}}},"iat":{"type":"integer"},"id":{"type":"string","example":"1164449231815010287495"},"is_gateway":{"type":"boolean","example":false},"is_warp":{"type":"boolean","example":false},"name":{"type":"string","example":"Test User"},"user_uuid":{"$ref":"#/components/schemas/uuid"},"version":{"type":"integer"}}}}}}}]},"policy_with_permission_groups":{"title":"policy_with_permission_groups","required":["id","effect","resources","permission_groups"],"properties":{"effect":{"$ref":"#/components/schemas/effect"},"id":{"$ref":"#/components/schemas/Cloudflare Client API_identifier"},"permission_groups":{"$ref":"#/components/schemas/permission_groups"},"resources":{"$ref":"#/components/schemas/resources"}}},"polish":{"allOf":[{"$ref":"#/components/schemas/schemas-base"},{"properties":{"id":{"description":"ID of the zone setting.","enum":["polish"],"example":"polish"},"value":{"$ref":"#/components/schemas/polish_value"}}}],"title":"Polish Image Optimization","description":"Removes metadata and compresses your images for faster page load times. Basic (Lossless): Reduce the size of PNG, JPEG, and GIF files - no impact on visual quality. Basic + JPEG (Lossy): Further reduce the size of JPEG files for faster image loading. Larger JPEGs are converted to progressive images, loading a lower-resolution image first and ending in a higher-resolution version. Not recommended for hi-res photography sites."},"polish_value":{"type":"string","description":"Value of the zone setting.","enum":["off","lossless","lossy"],"default":"off"},"pool":{"type":"object","properties":{"check_regions":{"$ref":"#/components/schemas/check_regions"},"created_on":{"$ref":"#/components/schemas/timestamp"},"description":{"$ref":"#/components/schemas/pool_components-schemas-description"},"disabled_at":{"$ref":"#/components/schemas/schemas-disabled_at"},"enabled":{"$ref":"#/components/schemas/pool_components-schemas-enabled"},"id":{"$ref":"#/components/schemas/pool_components-schemas-identifier"},"latitude":{"$ref":"#/components/schemas/latitude"},"load_shedding":{"$ref":"#/components/schemas/load_shedding"},"longitude":{"$ref":"#/components/schemas/longitude"},"minimum_origins":{"$ref":"#/components/schemas/minimum_origins"},"modified_on":{"$ref":"#/components/schemas/timestamp"},"monitor":{"$ref":"#/components/schemas/schemas-monitor"},"name":{"$ref":"#/components/schemas/pool_components-schemas-name"},"notification_email":{"$ref":"#/components/schemas/notification_email"},"notification_filter":{"$ref":"#/components/schemas/notification_filter"},"origin_steering":{"$ref":"#/components/schemas/origin_steering"},"origins":{"$ref":"#/components/schemas/origins"}}},"pool_components-schemas-description":{"type":"string","description":"A human-readable description of the pool.","example":"Primary data center - Provider XYZ"},"pool_components-schemas-enabled":{"type":"boolean","description":"Whether to enable (the default) or disable this pool. Disabled pools will not receive traffic and are excluded from health checks. Disabling a pool will cause any load balancers using it to failover to the next pool (if any).","default":true,"example":false},"pool_components-schemas-id_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/pool_components-schemas-identifier"}}}}}]},"pool_components-schemas-identifier":{"example":"17b5962d775c646f3f9725cbc7a53df4"},"pool_components-schemas-name":{"type":"string","description":"A short name (tag) for the pool. Only alphanumeric characters, hyphens, and underscores are allowed.","example":"primary-dc-1"},"pool_components-schemas-response_collection":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/pool"}}}}]},"pool_components-schemas-single_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/pool"}}}]},"pop_pools":{"type":"object","description":"(Enterprise only): A mapping of Cloudflare PoP identifiers to a list of pool IDs (ordered by their failover priority) for the PoP (datacenter). Any PoPs not explicitly defined will fall back to using the corresponding country_pool, then region_pool mapping if it exists else to default_pools.","example":{"LAX":["de90f38ced07c2e2f4df50b1f61d4194","9290f38c5d07c2e2f4df57b1f61d4196"],"LHR":["abd90f38ced07c2e2f4df50b1f61d4194","f9138c5d07c2e2f4df57b1f61d4196"],"SJC":["00920f38ce07c2e2f4df50b1f61d4194"]}},"popularity_rank":{"type":"integer","description":"Global Cloudflare 100k ranking for the last 30 days, if available for the hostname. The top ranked domain is 1, the lowest ranked domain is 100,000."},"port":{"type":"number","description":"DNS port of primary or secondary nameserver, depending on what zone this peer is linked to.","example":53},"position":{"type":"string","description":"The location of the image. Valid positions are: `upperRight`, `upperLeft`, `lowerLeft`, `lowerRight`, and `center`. Note that `center` ignores the `padding` parameter.","default":"upperRight","example":"center","readOnly":true},"precedence":{"type":"integer","description":"The order of execution for this policy. Must be unique for each policy."},"predefined_entry":{"type":"object","title":"Predefined entry","description":"A predefined entry that matches a profile","properties":{"enabled":{"type":"boolean","description":"Whether the entry is enabled or not.","example":true},"id":{"$ref":"#/components/schemas/entry_id"},"name":{"type":"string","description":"The name of the entry.","example":"Credit card (Visa)"},"profile_id":{"description":"ID of the parent profile"}}},"predefined_profile":{"type":"object","title":"Predefined profile","properties":{"entries":{"type":"array","description":"The entries for this profile.","items":{"$ref":"#/components/schemas/predefined_entry"}},"id":{"$ref":"#/components/schemas/profile_id"},"name":{"type":"string","description":"The name of the profile.","example":"Generic CVV Card Number"},"type":{"type":"string","description":"The type of the profile.","enum":["predefined"],"example":"predefined"}}},"predefined_profile_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"allOf":[{"$ref":"#/components/schemas/predefined_profile"}]}}}]},"prefetch_preload":{"allOf":[{"$ref":"#/components/schemas/schemas-base"},{"properties":{"id":{"description":"ID of the zone setting.","enum":["prefetch_preload"],"example":"prefetch_preload"},"value":{"$ref":"#/components/schemas/prefetch_preload_value"}}}],"title":"Prefetch preload","description":"Cloudflare will prefetch any URLs that are included in the response headers. This is limited to Enterprise Zones.","default":"off"},"prefetch_preload_value":{"type":"string","description":"Value of the zone setting.","enum":["on","off"],"default":"off"},"prefix":{"type":"string","description":"IP Prefix in Classless Inter-Domain Routing format.","example":"192.0.2.0/24"},"preview":{"type":"string","format":"uri","description":"The video's preview page URI. This field is omitted until encoding is complete.","example":"https://customer-m033z5x00ks6nunl.cloudflarestream.com/ea95132c15732412d22c1476fa83f27a/watch","readOnly":true},"preview_id":{"example":"f1aba936b94213e5b8dca0c0dbf1f9cc"},"preview_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"type":"object","properties":{"pools":{"type":"object","example":{"abwlnp5jbqn45ecgxd03erbgtxtqai0d":"WNAM Datacenter","ve8h9lrcip5n5bbga9yqmdws28ay5d0l":"EEU Datacenter"}},"preview_id":{"$ref":"#/components/schemas/monitor_components-schemas-identifier"}}}}}]},"preview_result":{"type":"object","description":"Resulting health data from a preview operation.","example":{"abwlnp5jbqn45ecgxd03erbgtxtqai0d":{"healthy":true,"origins":[{"originone.example.com.":{"$ref":"#/components/schemas/origin_health_data/example"}}]}}},"preview_result_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"$ref":"#/components/schemas/preview_result"}]},"preview_url":{"type":"string","description":"URL where the custom waiting room page can temporarily be previewed.","example":"http://waitingrooms.dev/preview/35af8c12-6d68-4608-babb-b53435a5ddfb"},"price":{"type":"number","description":"The price of the subscription that will be billed, in US dollars.","example":20,"readOnly":true},"priority":{"type":"number","description":"Required for MX, SRV and URI records; unused by other record types. Records with lower priorities are preferred.","example":10,"minimum":0,"maximum":65535},"privacy":{"type":"boolean","description":"Privacy option controls redacting WHOIS information.","example":true},"privacy_pass":{"allOf":[{"$ref":"#/components/schemas/schemas-base"},{"properties":{"id":{"description":"ID of the zone setting.","enum":["privacy_pass"],"example":"privacy_pass"},"value":{"$ref":"#/components/schemas/privacy_pass_value"}}}],"title":"Privacy Pass","description":"Privacy Pass is a browser extension developed by the Privacy Pass Team to improve the browsing experience for your visitors. Enabling Privacy Pass will reduce the number of CAPTCHAs shown to your visitors. (https://support.cloudflare.com/hc/en-us/articles/115001992652-Privacy-Pass)."},"privacy_pass_value":{"type":"string","description":"Value of the zone setting.","enum":["on","off"],"default":"on"},"private_key":{"type":"string","description":"The zone's private key.","example":"-----BEGIN RSA PRIVATE KEY-----\nMIIEowIBAAKCAQEAwQHoetcl9+5ikGzV6cMzWtWPJHqXT3wpbEkRU9Yz7lgvddmG\ndtcGbg/1CGZu0jJGkMoppoUo4c3dts3iwqRYmBikUP77wwY2QGmDZw2FvkJCJlKn\nabIRuGvBKwzESIXgKk2016aTP6/dAjEHyo6SeoK8lkIySUvK0fyOVlsiEsCmOpid\ntnKX/a+50GjB79CJH4ER2lLVZnhePFR/zUOyPxZQQ4naHf7yu/b5jhO0f8fwt+py\nFxIXjbEIdZliWRkRMtzrHOJIhrmJ2A1J7iOrirbbwillwjjNVUWPf3IJ3M12S9pE\newooaeO2izNTERcG9HzAacbVRn2Y2SWIyT/18QIDAQABAoIBACbhTYXBZYKmYPCb\nHBR1IBlCQA2nLGf0qRuJNJZg5iEzXows/6tc8YymZkQE7nolapWsQ+upk2y5Xdp/\naxiuprIs9JzkYK8Ox0r+dlwCG1kSW+UAbX0bQ/qUqlsTvU6muVuMP8vZYHxJ3wmb\n+ufRBKztPTQ/rYWaYQcgC0RWI20HTFBMxlTAyNxYNWzX7RKFkGVVyB9RsAtmcc8g\n+j4OdosbfNoJPS0HeIfNpAznDfHKdxDk2Yc1tV6RHBrC1ynyLE9+TaflIAdo2MVv\nKLMLq51GqYKtgJFIlBRPQqKoyXdz3fGvXrTkf/WY9QNq0J1Vk5ERePZ54mN8iZB7\n9lwy/AkCgYEA6FXzosxswaJ2wQLeoYc7ceaweX/SwTvxHgXzRyJIIT0eJWgx13Wo\n/WA3Iziimsjf6qE+SI/8laxPp2A86VMaIt3Z3mJN/CqSVGw8LK2AQst+OwdPyDMu\niacE8lj/IFGC8mwNUAb9CzGU3JpU4PxxGFjS/eMtGeRXCWkK4NE+G08CgYEA1Kp9\nN2JrVlqUz+gAX+LPmE9OEMAS9WQSQsfCHGogIFDGGcNf7+uwBM7GAaSJIP01zcoe\nVAgWdzXCv3FLhsaZoJ6RyLOLay5phbu1iaTr4UNYm5WtYTzMzqh8l1+MFFDl9xDB\nvULuCIIrglM5MeS/qnSg1uMoH2oVPj9TVst/ir8CgYEAxrI7Ws9Zc4Bt70N1As+U\nlySjaEVZCMkqvHJ6TCuVZFfQoE0r0whdLdRLU2PsLFP+q7qaeZQqgBaNSKeVcDYR\n9B+nY/jOmQoPewPVsp/vQTCnE/R81spu0mp0YI6cIheT1Z9zAy322svcc43JaWB7\nmEbeqyLOP4Z4qSOcmghZBSECgYACvR9Xs0DGn+wCsW4vze/2ei77MD4OQvepPIFX\ndFZtlBy5ADcgE9z0cuVB6CiL8DbdK5kwY9pGNr8HUCI03iHkW6Zs+0L0YmihfEVe\nPG19PSzK9CaDdhD9KFZSbLyVFmWfxOt50H7YRTTiPMgjyFpfi5j2q348yVT0tEQS\nfhRqaQKBgAcWPokmJ7EbYQGeMbS7HC8eWO/RyamlnSffdCdSc7ue3zdVJxpAkQ8W\nqu80pEIF6raIQfAf8MXiiZ7auFOSnHQTXUbhCpvDLKi0Mwq3G8Pl07l+2s6dQG6T\nlv6XTQaMyf6n1yjzL+fzDrH3qXMxHMO/b13EePXpDMpY7HQpoLDi\n-----END RSA PRIVATE KEY-----\n"},"probe_zone":{"type":"string","description":"Assign this monitor to emulate the specified zone while probing. This parameter is only valid for HTTP and HTTPS monitors.","example":"example.com"},"products":{"type":"array","items":{"type":"string","description":"A list of products to bypass for a request when using the `bypass` action.","enum":["zoneLockdown","uaBlock","bic","hot","securityLevel","rateLimit","waf"],"example":"waf"}},"profile_id":{"allOf":[{"$ref":"#/components/schemas/uuid"}],"description":"The ID for this profile","example":"384e129d-25bd-403c-8019-bc19eb7a8a5f"},"profiles":{"anyOf":[{"$ref":"#/components/schemas/predefined_profile"},{"$ref":"#/components/schemas/custom_profile"}]},"profiles_components-schemas-response_collection":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/profiles"}}}}]},"project-patch":{"example":{"deployment_configs":{"production":{"compatibility_date":"2022-01-01","compatibility_flags":["url_standard"],"env_vars":{"BUILD_VERSION":{"value":"3.3"},"delete_this_env_var":null}}}}},"project-response":{"allOf":[{"$ref":"#/components/schemas/api-response-common"},{"properties":{"result":{"type":"object"}}}]},"project_name":{"type":"string","description":"Name of the project.","example":"this-is-my-project-01","pattern":"^[a-z0-9][a-z0-9-]*$"},"projects":{"type":"object","properties":{"build_config":{"$ref":"#/components/schemas/build_config"},"canonical_deployment":{"oneOf":[{"nullable":true},{"$ref":"#/components/schemas/deployments"}],"description":"Most recent deployment to the repo.","readOnly":true},"created_on":{"type":"string","format":"date-time","description":"When the project was created.","example":"2017-01-01T00:00:00Z","readOnly":true},"deployment_configs":{"$ref":"#/components/schemas/deployment_configs"},"domains":{"type":"array","description":"A list of associated custom domains for the project.","example":["customdomain.com","customdomain.org"],"readOnly":true,"items":{}},"id":{"type":"string","description":"Id of the project.","example":"7b162ea7-7367-4d67-bcde-1160995d5","readOnly":true},"latest_deployment":{"oneOf":[{"nullable":true},{"$ref":"#/components/schemas/deployments"}],"description":"Most recent deployment to the repo.","readOnly":true},"name":{"type":"string","description":"Name of the project.","example":"NextJS Blog"},"production_branch":{"type":"string","description":"Production branch of the project. Used to identify production deployments.","example":"main"},"source":{"readOnly":true},"subdomain":{"type":"string","description":"The Cloudflare subdomain associated with the project.","example":"helloworld.pages.dev","readOnly":true}}},"projects-response":{"allOf":[{"$ref":"#/components/schemas/api-response-common"},{"properties":{"result_info":{"type":"object","properties":{"count":{"example":1},"page":{"example":1},"per_page":{"example":100},"total_count":{"example":1}}}}},{"properties":{"result":{"type":"array","items":{"type":"object"}}}}]},"properties-modified_on":{"type":"string","format":"date-time","description":"last time this setting was modified.","example":"2014-01-01T05:20:00.12345Z","nullable":true,"readOnly":true},"properties-name":{"type":"string","description":"The domain name","example":"example.com","readOnly":true,"maxLength":253,"pattern":"^([a-zA-Z0-9][\\-a-zA-Z0-9]*\\.)+[\\-a-zA-Z0-9]{2,20}$"},"protocol":{"type":"string","description":"The port configuration at Cloudflare’s edge. May specify a single port, for example `\"tcp/1000\"`, or a range of ports, for example `\"tcp/1000-2000\"`.","example":"tcp/22"},"provider_name":{"type":"string","description":"The name of provider. Usually cloudflare.","example":"Cloudflare"},"proxied":{"type":"boolean","description":"Whether the record is receiving the performance and security benefits of Cloudflare.","example":false},"proxy-endpoints":{"type":"object","properties":{"created_at":{"$ref":"#/components/schemas/timestamp"},"id":{"$ref":"#/components/schemas/proxy-endpoints_components-schemas-uuid"},"ips":{"$ref":"#/components/schemas/components-schemas-ips"},"name":{"$ref":"#/components/schemas/proxy-endpoints_components-schemas-name"},"subdomain":{"$ref":"#/components/schemas/schemas-subdomain"},"updated_at":{"$ref":"#/components/schemas/timestamp"}}},"proxy-endpoints_components-schemas-empty_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"type":"object"}}}]},"proxy-endpoints_components-schemas-identifier":{"example":"699d98642c564d2e855e9661899b7252"},"proxy-endpoints_components-schemas-name":{"type":"string","description":"The name of the Proxy Endpoint.","example":"Devops team"},"proxy-endpoints_components-schemas-response_collection":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/proxy-endpoints"}}}}]},"proxy-endpoints_components-schemas-single_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/proxy-endpoints"}}}]},"proxy-endpoints_components-schemas-uuid":{"example":"ed35569b41ce4d1facfe683550f54086"},"proxy_protocol":{"type":"string","description":"Enables Proxy Protocol to the origin. Refer to [Enable Proxy protocol](https://developers.cloudflare.com/spectrum/getting-started/proxy-protocol/) for implementation details on PROXY Protocol V1, PROXY Protocol V2, and Simple Proxy Protocol.","enum":["off","v1","v2","simple"],"default":"off","example":"off"},"proxy_read_timeout":{"allOf":[{"$ref":"#/components/schemas/schemas-base"},{"properties":{"id":{"description":"ID of the zone setting.","enum":["proxy_read_timeout"],"example":"proxy_read_timeout"},"value":{"$ref":"#/components/schemas/proxy_read_timeout_value"}}}],"title":"Proxy Read Timeout","description":"Maximum time between two read operations from origin."},"proxy_read_timeout_value":{"type":"number","description":"Value of the zone setting.\nNotes: Value must be between 1 and 6000","default":100},"pseudo_ipv4":{"allOf":[{"$ref":"#/components/schemas/schemas-base"},{"properties":{"id":{"description":"Value of the Pseudo IPv4 setting.","enum":["pseudo_ipv4"],"default":"pseudo_ipv4"},"value":{"$ref":"#/components/schemas/pseudo_ipv4_value"}}}],"title":"Pseudo IPv4 Value","description":"The value set for the Pseudo IPv4 setting."},"pseudo_ipv4_value":{"type":"string","description":"Value of the Pseudo IPv4 setting.","enum":["off","add_header","overwrite_header"],"default":"off"},"psk":{"type":"string","description":"A randomly generated or provided string for use in the IPsec tunnel.","example":"O3bwKSjnaoCxDoUxjcq4Rk8ZKkezQUiy"},"psk_generation_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"properties":{"ipsec_tunnel_id":{"$ref":"#/components/schemas/common_components-schemas-identifier"},"psk":{"$ref":"#/components/schemas/psk"},"psk_metadata":{"$ref":"#/components/schemas/psk_metadata"}}}}}]},"psk_metadata":{"type":"object","description":"The PSK metadata that includes when the PSK was generated.","properties":{"last_generated_on":{"$ref":"#/components/schemas/common_components-schemas-modified_on"}}},"public_key":{"type":"string","description":"The public key to add to your SSH server configuration.","example":"ecdsa-sha2-nistp256 xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx/xxxxxxxxxxxxxxxxxxxxx/xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx= open-ssh-ca@cloudflareaccess.org","readOnly":true},"purge_by_cache_tags_or_hosts_or_prefixes":{"properties":{"hosts":{"type":"array","description":"Any assets at URLs with a host that matches one of the provided values will be purged from the Cloudflare cache.","example":["www.example.com","images.example.com"],"maxLength":30,"items":{"type":"string"}},"prefixes":{"type":"array","description":"Any assets at URLs that match the prefix will be purged from the Cloudflare cache. For example, a.com/b will purge a.com/b/c/d.png but not a.com/bc.png. The prefixes a.com/b and a.com/b/c are redundant.","example":["www.example.com/foo","images.example.com/bar/baz"],"maxLength":30,"items":{"type":"string"}},"tags":{"type":"array","description":"Any assets served with a Cache-Tag header that matches one of the provided values will be purged from the Cloudflare cache.","example":["some-tag","another-tag"],"maxLength":30,"items":{"type":"string"}}}},"purpose_justification_prompt":{"type":"string","description":"A custom message that will appear on the purpose justification screen.","example":"Please enter a justification for entering this protected domain."},"purpose_justification_required":{"type":"boolean","description":"Require users to enter a justification when they log in to the application.","default":false,"example":true},"query":{"type":"object","description":"For specifying result metrics.","properties":{"dimensions":{"type":"array","description":"Can be used to break down the data by given attributes.","default":"[]","items":{"type":"string","description":"For drilling down on metrics."}},"filters":{"type":"string","description":"Used to filter rows by one or more dimensions. Filters can be combined using OR and AND boolean logic. AND takes precedence over OR in all the expressions. The OR operator is defined using a comma (,) or OR keyword surrounded by whitespace. The AND operator is defined using a semicolon (;) or AND keyword surrounded by whitespace. Note that the semicolon is a reserved character in URLs (rfc1738) and needs to be percent-encoded as %3B. Comparison options are: \n\nOperator | Name | URL Encoded\n--------------------------|---------------------------------|--------------------------\n== | Equals | %3D%3D\n!= | Does not equals | !%3D\n> | Greater Than | %3E\n< | Less Than | %3C\n>= | Greater than or equal to | %3E%3D\n<= | Less than or equal to | %3C%3D .","default":"\"\""},"limit":{"type":"integer","description":"Limit number of returned metrics.","default":10000},"metrics":{"type":"array","description":"One or more metrics to compute.","items":{"type":"string","description":"A quantitative measurement of KV usage."}},"since":{"type":"string","format":"date-time","description":"Start of time interval to query, defaults to 6 hours before request received.","default":"<6 hours ago>","example":"2019-01-02T02:20:00Z"},"sort":{"type":"array","description":"Array of dimensions or metrics to sort by, each dimension/metric may be prefixed by - (descending) or + (ascending).","default":"[]","items":{}},"until":{"type":"string","format":"date-time","description":"End of time interval to query, defaults to current time.","default":"<now>","example":"2019-01-02T03:20:00Z"}}},"query_event":{"type":"object","required":["name","event_start_time","event_end_time"],"properties":{"custom_page_html":{"$ref":"#/components/schemas/event_custom_page_html"},"description":{"$ref":"#/components/schemas/event_description"},"disable_session_renewal":{"$ref":"#/components/schemas/event_disable_session_renewal"},"event_end_time":{"$ref":"#/components/schemas/event_end_time"},"event_start_time":{"$ref":"#/components/schemas/event_start_time"},"name":{"$ref":"#/components/schemas/event_name"},"new_users_per_minute":{"$ref":"#/components/schemas/event_new_users_per_minute"},"prequeue_start_time":{"$ref":"#/components/schemas/event_prequeue_start_time"},"queueing_method":{"$ref":"#/components/schemas/event_queueing_method"},"session_duration":{"$ref":"#/components/schemas/event_session_duration"},"shuffle_at_event_start":{"$ref":"#/components/schemas/event_shuffle_at_event_start"},"suspended":{"$ref":"#/components/schemas/event_suspended"},"total_active_users":{"$ref":"#/components/schemas/event_total_active_users"}}},"query_healthcheck":{"type":"object","required":["name","address"],"properties":{"address":{"$ref":"#/components/schemas/schemas-address"},"check_regions":{"$ref":"#/components/schemas/schemas-check_regions"},"consecutive_fails":{"$ref":"#/components/schemas/consecutive_fails"},"consecutive_successes":{"$ref":"#/components/schemas/consecutive_successes"},"description":{"$ref":"#/components/schemas/healthchecks_components-schemas-description"},"http_config":{"$ref":"#/components/schemas/http_config"},"interval":{"$ref":"#/components/schemas/components-schemas-interval"},"name":{"$ref":"#/components/schemas/healthchecks_components-schemas-name"},"retries":{"$ref":"#/components/schemas/retries"},"suspended":{"$ref":"#/components/schemas/suspended"},"tcp_config":{"$ref":"#/components/schemas/tcp_config"},"timeout":{"$ref":"#/components/schemas/schemas-timeout"},"type":{"$ref":"#/components/schemas/healthchecks_components-schemas-type"}}},"query_preview":{"type":"object","required":["custom_html"],"properties":{"custom_html":{"$ref":"#/components/schemas/custom_page_html"}}},"query_response":{"type":"object","description":"The exact parameters/timestamps the analytics service used to return data.","readOnly":true,"properties":{"since":{"$ref":"#/components/schemas/since"},"time_delta":{"type":"integer","description":"The amount of time (in minutes) that each data point in the timeseries represents. The granularity of the time-series returned (e.g. each bucket in the time series representing 1-minute vs 1-day) is calculated by the API based on the time-range provided to the API."},"until":{"$ref":"#/components/schemas/until"}}},"query_waitingroom":{"type":"object","required":["name","host","new_users_per_minute","total_active_users"],"properties":{"cookie_attributes":{"$ref":"#/components/schemas/cookie_attributes"},"custom_page_html":{"$ref":"#/components/schemas/custom_page_html"},"default_template_language":{"$ref":"#/components/schemas/default_template_language"},"description":{"$ref":"#/components/schemas/waitingroom_components-schemas-description"},"disable_session_renewal":{"$ref":"#/components/schemas/disable_session_renewal"},"host":{"$ref":"#/components/schemas/components-schemas-host"},"json_response_enabled":{"$ref":"#/components/schemas/json_response_enabled"},"name":{"$ref":"#/components/schemas/waitingroom_components-schemas-name"},"new_users_per_minute":{"$ref":"#/components/schemas/new_users_per_minute"},"path":{"$ref":"#/components/schemas/schemas-path"},"queue_all":{"$ref":"#/components/schemas/queue_all"},"queueing_method":{"$ref":"#/components/schemas/queueing_method"},"session_duration":{"$ref":"#/components/schemas/schemas-session_duration"},"suspended":{"$ref":"#/components/schemas/schemas-suspended"},"total_active_users":{"$ref":"#/components/schemas/total_active_users"}}},"queue":{"type":"object","properties":{"consumers":{"readOnly":true},"consumers_total_count":{"readOnly":true},"created_on":{"readOnly":true},"modified_on":{"readOnly":true},"producers":{"readOnly":true},"producers_total_count":{"readOnly":true},"queue_id":{"readOnly":true},"queue_name":{"$ref":"#/components/schemas/queues_components-schemas-name"}}},"queue_all":{"type":"boolean","description":"If queue_all is `true`, all the traffic that is coming to a route will be sent to the waiting room. No new traffic can get to the route once this field is set and estimated time will become unavailable.","default":false,"example":true},"queue_created":{"type":"object","properties":{"created_on":{"readOnly":true},"modified_on":{"readOnly":true},"queue_id":{"readOnly":true},"queue_name":{"$ref":"#/components/schemas/queues_components-schemas-name"}}},"queue_updated":{"type":"object","properties":{"created_on":{"readOnly":true},"modified_on":{"readOnly":true},"queue_id":{"readOnly":true},"queue_name":{"$ref":"#/components/schemas/renamed_name"}}},"queueing_method":{"type":"string","description":"Sets the queueing method used by the waiting room. Changing this parameter from the **default** queueing method is only available for the Waiting Room Advanced subscription. Regardless of the queueing method, if `queue_all` is enabled or an event is prequeueing, users in the waiting room will not be accepted to the origin. These users will always see a waiting room page that refreshes automatically. The valid queueing methods are:\n1. `fifo` **(default)**: First-In-First-Out queue where customers gain access in the order they arrived.\n2. `random`: Random queue where customers gain access randomly, regardless of arrival time.\n3. `passthrough`: Users will pass directly through the waiting room and into the origin website. As a result, any configured limits will not be respected while this is enabled. This method can be used as an alternative to disabling a waiting room (with `suspended`) so that analytics are still reported. This can be used if you wish to allow all traffic normally, but want to restrict traffic during a waiting room event, or vice versa.\n4. `reject`: Users will be immediately rejected from the waiting room. As a result, no users will reach the origin website while this is enabled. This can be used if you wish to reject all traffic while performing maintenance, block traffic during a specified period of time (an event), or block traffic while events are not occurring. Consider a waiting room used for vaccine distribution that only allows traffic during sign-up events, and otherwise blocks all traffic. For this case, the waiting room uses `reject`, and its events override this with `fifo`, `random`, or `passthrough`. When this queueing method is enabled and neither `queueAll` is enabled nor an event is prequeueing, the waiting room page **will not refresh automatically**.","enum":["fifo","random","passthrough","reject"],"default":"fifo","example":"fifo"},"queues_components-schemas-name":{"type":"string","example":"example-queue"},"quota":{"type":"object","properties":{"allocated":{"type":"integer","description":"Quantity Allocated."},"used":{"type":"integer","description":"Quantity Used."}}},"r2-single-bucket-operation-response":{"allOf":[{"$ref":"#/components/schemas/api-response-common"},{"properties":{"result":{"type":"object"}}}]},"railgun":{"type":"object","required":["id","name","status","enabled","zones_connected","build","version","revision","activation_key","activated_on","created_on","modified_on"],"properties":{"activated_on":{"$ref":"#/components/schemas/activated_on"},"activation_key":{"$ref":"#/components/schemas/activation_key"},"build":{"$ref":"#/components/schemas/build"},"created_on":{"$ref":"#/components/schemas/railgun_components-schemas-created_on"},"enabled":{"$ref":"#/components/schemas/railgun_components-schemas-enabled"},"id":{"$ref":"#/components/schemas/railgun_components-schemas-identifier"},"modified_on":{"$ref":"#/components/schemas/railgun_components-schemas-modified_on"},"name":{"$ref":"#/components/schemas/railgun_components-schemas-name"},"revision":{"$ref":"#/components/schemas/revision"},"status":{"$ref":"#/components/schemas/railgun_components-schemas-status"},"upgrade_info":{"$ref":"#/components/schemas/upgrade_info"},"version":{"$ref":"#/components/schemas/railgun_components-schemas-version"},"zones_connected":{"$ref":"#/components/schemas/zones_connected"}}},"railgun_components-schemas-created_on":{"type":"string","format":"date-time","description":"When the Railgun was created.","example":"2014-01-01T05:20:00Z","readOnly":true},"railgun_components-schemas-enabled":{"type":"boolean","description":"Flag to determine if the Railgun is accepting connections.","default":false,"example":true},"railgun_components-schemas-identifier":{"type":"string","description":"Railgun identifier tag.","example":"e928d310693a83094309acf9ead50448","readOnly":true,"maxLength":32},"railgun_components-schemas-identifier-2":{"type":"string","description":"Railgun connection identifier tag.","example":"e928d310693a83094309acf9ead50448","readOnly":true,"maxLength":32},"railgun_components-schemas-modified_on":{"type":"string","format":"date-time","description":"When the Railgun was last modified.","example":"2014-01-01T05:20:00Z","readOnly":true},"railgun_components-schemas-name":{"type":"string","description":"Readable identifier of the Railgun.","example":"My Railgun.","maxLength":160},"railgun_components-schemas-status":{"type":"string","description":"Status of the Railgun.","enum":["initializing","active"],"example":"active","readOnly":true},"railgun_components-schemas-version":{"type":"string","description":"The version of the Railgun receiver.","example":"2.1","readOnly":true},"railgun_response_collection":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/railgun"}}}}]},"railgun_response_single":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"type":"object"}}}]},"railgun_response_single_id":{"allOf":[{"$ref":"#/components/schemas/railgun_response_single"},{"properties":{"result":{"properties":{"id":{"$ref":"#/components/schemas/railgun_components-schemas-identifier"}}}}}]},"random_steering":{"type":"object","description":"Configures pool weights for random steering. When steering_policy is 'random', a random pool is selected with probability proportional to these pool weights.","properties":{"default_weight":{"type":"number","description":"The default weight for pools in the load balancer that are not specified in the pool_weights map.","default":1,"example":0.2,"minimum":0,"maximum":1,"multipleOf":0.1},"pool_weights":{"type":"object","description":"A mapping of pool IDs to custom weights. The weight is relative to other pools in the load balancer.","example":{"9290f38c5d07c2e2f4df57b1f61d4196":0.5,"de90f38ced07c2e2f4df50b1f61d4194":0.3}}}},"rate-limits":{"allOf":[{"$ref":"#/components/schemas/components-schemas-ratelimit"}],"type":"object"},"rate-limits_components-schemas-id":{"type":"string","description":"The unique identifier of the rate limit.","example":"372e67954025e0ba6aaa6d586b9e0b59","readOnly":true,"maxLength":32},"rate-plan":{"type":"object","properties":{"components":{"$ref":"#/components/schemas/schemas-component_values"},"currency":{"$ref":"#/components/schemas/currency"},"duration":{"$ref":"#/components/schemas/duration"},"frequency":{"$ref":"#/components/schemas/schemas-frequency"},"id":{"$ref":"#/components/schemas/rate-plan_components-schemas-identifier"},"name":{"$ref":"#/components/schemas/rate-plan_components-schemas-name"}}},"rate-plan_components-schemas-identifier":{"type":"string","description":"Plan identifier tag.","example":"free","readOnly":true},"rate-plan_components-schemas-name":{"type":"string","description":"The plan name.","example":"Free Plan","readOnly":true,"maxLength":80},"rate_plan":{"type":"object","description":"The rate plan applied to the subscription.","properties":{"currency":{"type":"string","description":"The currency applied to the rate plan subscription.","example":"USD"},"externally_managed":{"type":"boolean","description":"Whether this rate plan is managed externally from Cloudflare.","example":false},"id":{"description":"The ID of the rate plan.","example":"free"},"is_contract":{"type":"boolean","description":"Whether a rate plan is enterprise-based (or newly adopted term contract).","example":false},"public_name":{"type":"string","description":"The full name of the rate plan.","example":"Business Plan"},"scope":{"type":"string","description":"The scope that this rate plan applies to.","example":"zone"},"sets":{"type":"array","description":"The list of sets this rate plan applies to.","items":{"type":"string"}}}},"ratelimit":{"type":"number","description":"Ratelimit in queries per second per datacenter (applies to DNS queries sent to the origin nameservers configured on the cluster).","example":600,"nullable":true,"minimum":100,"maximum":"1e+09"},"ratelimit_response_collection":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"type":"object","properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/rate-limits"}}}}]},"ratelimit_response_single":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"type":"object","properties":{"result":{"type":"object"}}}]},"ray_id":{"type":"string","description":"The unique identifier for the request to Cloudflare.","example":"187d944c61940c77","maxLength":16},"ray_identifier":{"type":"string","description":"Ray identifier.","example":"41ddf1740f67442d","readOnly":true,"maxLength":16},"ready":{"type":"boolean","description":"Beta flag. Users can create a policy with a mechanism that is not ready, but we cannot guarantee successful delivery of notifications.","example":true},"readyToStream":{"type":"boolean","description":"Indicates whether the video is ready for viewing.","example":true,"readOnly":true},"ref":{"type":"string","description":"A short reference tag. Allows you to select related firewall rules.","example":"MIR-31","maxLength":50},"references_response":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"type":"array","description":"List of resources that reference a given monitor.","example":[{"reference_type":"referrer","resource_id":"17b5962d775c646f3f9725cbc7a53df4","resource_name":"primary-dc-1","resource_type":"pool"}],"items":{"type":"object","properties":{"reference_type":{"type":"string","enum":["*","referral","referrer"]},"resource_id":{"type":"string"},"resource_name":{"type":"string"},"resource_type":{"type":"string"}}}}}}]},"region_code":{"type":"string","description":"A list of Cloudflare regions. WNAM: Western North America, ENAM: Eastern North America, WEU: Western Europe, EEU: Eastern Europe, NSAM: Northern South America, SSAM: Southern South America, OC: Oceania, ME: Middle East, NAF: North Africa, SAF: South Africa, SAS: Southern Asia, SEAS: South East Asia, NEAS: North East Asia).","enum":["WNAM","ENAM","WEU","EEU","NSAM","SSAM","OC","ME","NAF","SAF","SAS","SEAS","NEAS"],"example":"WNAM"},"region_components-schemas-response_collection":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"type":"object"}}}]},"region_components-schemas-single_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"type":"object","description":"A list of countries and subdivisions mapped to a region.","example":{"iso_standard":"Country and subdivision codes follow ISO 3166-1 alpha-2 and ISO 3166-2","regions":[{"countries":[{"country_code_a2":"CA","country_name":"Canada","country_subdivisions":[{"subdivision_code_a2":"AB","subdivision_name":"Alberta"},{"subdivision_code_a2":"BC","subdivision_name":"British Columbia"}]},{"country_code_a2":"HT","country_name":"Haiti"},{"country_code_a2":"MX","country_name":"Mexico"},{"country_code_a2":"US","country_name":"United States","country_subdivisions":[{"subdivision_code_a2":"AZ","subdivision_name":"Arizona"},{"subdivision_code_a2":"CA","subdivision_name":"California"},{"subdivision_code_a2":"CO","subdivision_name":"Colorado"},{"subdivision_code_a2":"HI","subdivision_name":"Hawaii"},{"subdivision_code_a2":"MN","subdivision_name":"Minnesota"},{"subdivision_code_a2":"MO","subdivision_name":"Missouri"},{"subdivision_code_a2":"NV","subdivision_name":"Nevada"},{"subdivision_code_a2":"OR","subdivision_name":"Oregon"},{"subdivision_code_a2":"TX","subdivision_name":"Texas"},{"subdivision_code_a2":"UT","subdivision_name":"Utah"},{"subdivision_code_a2":"WA","subdivision_name":"Washington"}]}],"region_code":"WNAM"}]}}}}]},"region_pools":{"type":"object","description":"A mapping of region codes to a list of pool IDs (ordered by their failover priority) for the given region. Any regions not explicitly defined will fall back to using default_pools.","example":{"ENAM":["00920f38ce07c2e2f4df50b1f61d4194"],"WNAM":["de90f38ced07c2e2f4df50b1f61d4194","9290f38c5d07c2e2f4df57b1f61d4196"]}},"registrant_contact":{"allOf":[{"$ref":"#/components/schemas/contacts"}],"description":"Shows contact information for domain registrant."},"registry_statuses":{"type":"string","description":"A comma-separated list of registry status codes. A full list of status codes can be found at [EPP Status Codes](https://www.icann.org/resources/pages/epp-status-codes-2014-06-16-en).","example":"ok,serverTransferProhibited"},"remote_config":{"type":"boolean","description":"If `true`, the tunnel can be configured remotely from the Zero Trust dashboard. If `false`, the tunnel must be configured locally on the origin machine.","example":true},"renamed_name":{"type":"string","example":"renamed-example-queue"},"request.ip":{"type":"object","description":"Client IP restrictions.","example":{"in":["123.123.123.0/24","2606:4700::/32"],"not_in":["123.123.123.100/24","2606:4700:4700::/48"]},"properties":{"in":{"$ref":"#/components/schemas/cidr_list"},"not_in":{"$ref":"#/components/schemas/cidr_list"}}},"request_list":{"type":"array","items":{"$ref":"#/components/schemas/request_model"}},"request_model":{"type":"object","properties":{"enabled":{"$ref":"#/components/schemas/managed_headers_components-schemas-enabled"},"id":{"$ref":"#/components/schemas/managed_headers_components-schemas-id"}}},"request_type":{"type":"string","description":"Signature type desired on certificate (\"origin-rsa\" (rsa), \"origin-ecc\" (ecdsa), or \"keyless-certificate\" (for Keyless SSL servers).","enum":["origin-rsa","origin-ecc","keyless-certificate"],"example":"origin-rsa"},"requested_validity":{"type":"number","description":"The number of days for which the certificate should be valid.","enum":[7,30,90,365,730,1095,5475],"default":5475,"example":5475},"requests":{"type":"integer","description":"The estimated number of requests covered by these calculations.","readOnly":true},"requests_by_colo":{"type":"object","description":"Breakdown of totals for requests.","properties":{"all":{"type":"integer","description":"Total number of requests served."},"cached":{"type":"integer","description":"Total number of cached requests served."},"country":{"type":"object","description":"Key/value pairs where the key is a two-digit country code and the value is the number of requests served to that country.","example":{"AG":37298,"GI":293846,"US":4181364.0}},"http_status":{"type":"object","description":"A variable list of key/value pairs where the key is a HTTP status code and the value is the number of requests with that code served.","example":{"200":13496983.0,"301":283,"400":187936,"402":1828,"404":1293}},"uncached":{"type":"integer","description":"Total number of requests served from the origin."}}},"require":{"type":"array","description":"Rules evaluated with an AND logical operator. To match a policy, a user must meet all of the Require rules.","items":{"$ref":"#/components/schemas/rule_components-schemas-rule"}},"requireSignedURLs":{"type":"boolean","description":"Indicates whether the video can be a accessed using the UID. When set to `true`, a signed token must be generated with a signing key to view the video.","default":false,"example":true,"readOnly":true},"resolves_to_ref":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/stix_identifier"},"value":{"type":"string","description":"IP address or domain name.","example":"192.0.2.0"}}},"resolves_to_refs":{"type":"array","description":"Specifies a list of references to one or more IP addresses or domain names that the domain name currently resolves to.","items":{"$ref":"#/components/schemas/resolves_to_ref"}},"resource_reference":{"type":"object","description":"A reference to a load balancer resource.","properties":{"reference_type":{"type":"string","description":"When listed as a reference, the type (direction) of the reference.","enum":["referral","referrer"]},"references":{"type":"array","description":"A list of references to (referrer) or from (referral) this resource.","example":[{"reference_type":"referrer","resource_id":"699d98642c564d2e855e9661899b7252","resource_name":"www.example.com","resource_type":"load_balancer"},{"reference_type":"referral","resource_id":"f1aba936b94213e5b8dca0c0dbf1f9cc","resource_name":"Login page monitor","resource_type":"monitor"}],"items":{"type":"object","description":"A reference to a load balancer resource."}},"resource_id":{"example":"17b5962d775c646f3f9725cbc7a53df4"},"resource_name":{"type":"string","description":"The human-identifiable name of the resource.","example":"primary-dc-1"},"resource_type":{"type":"string","description":"The type of the resource.","enum":["load_balancer","monitor","pool"],"example":"pool"}}},"resources":{"type":"object","description":"A list of resource names that the policy applies to.","example":{"com.cloudflare.api.account.zone.22b1de5f1c0e4b3ea97bb1e963b06a43":"*","com.cloudflare.api.account.zone.eb78d65290b24279ba6f44721b3ea3c4":"*"}},"response":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/domain-history"}}}}]},"response_buffering":{"allOf":[{"$ref":"#/components/schemas/schemas-base"},{"properties":{"id":{"description":"ID of the zone setting.","enum":["response_buffering"],"example":"response_buffering"},"value":{"$ref":"#/components/schemas/response_buffering_value"}}}],"title":"Response Buffering","description":"Enables or disables buffering of responses from the proxied server. Cloudflare may buffer the whole payload to deliver it at once to the client versus allowing it to be delivered in chunks. By default, the proxied server streams directly and is not buffered by Cloudflare. This is limited to Enterprise Zones.","default":"off"},"response_buffering_value":{"type":"string","description":"Value of the zone setting.","enum":["on","off"],"default":"off"},"response_collection":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"type":"object","properties":{"result":{"type":"array","items":{"type":"object"}}}}]},"response_create":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"type":"object","properties":{"result":{"allOf":[{"type":"object"},{"type":"object","properties":{"value":{"$ref":"#/components/schemas/value"}}}]}}}]},"response_list":{"type":"array","items":{"$ref":"#/components/schemas/response_model"}},"response_model":{"type":"object","properties":{"available":{"$ref":"#/components/schemas/available"},"enabled":{"$ref":"#/components/schemas/managed_headers_components-schemas-enabled"},"id":{"$ref":"#/components/schemas/managed_headers_components-schemas-id"}}},"response_single":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"type":"object","properties":{"result":{"type":"object"}}}]},"response_single_origin_dns":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"properties":{"argo_smart_routing":{"$ref":"#/components/schemas/argo_smart_routing"},"created_on":{"$ref":"#/components/schemas/app_components-schemas-created"},"dns":{"$ref":"#/components/schemas/dns"},"edge_ips":{"$ref":"#/components/schemas/edge_ips"},"id":{"$ref":"#/components/schemas/app_id"},"ip_firewall":{"$ref":"#/components/schemas/ip_firewall"},"modified_on":{"$ref":"#/components/schemas/app_components-schemas-modified"},"origin_dns":{"$ref":"#/components/schemas/origin_dns"},"origin_port":{"$ref":"#/components/schemas/origin_port"},"protocol":{"$ref":"#/components/schemas/protocol"},"proxy_protocol":{"$ref":"#/components/schemas/proxy_protocol"},"tls":{"$ref":"#/components/schemas/tls"},"traffic_type":{"$ref":"#/components/schemas/traffic_type"}}}}}]},"response_single_segment":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"type":"object","properties":{"result":{"required":["id","status"],"properties":{"expires_on":{"$ref":"#/components/schemas/expires_on"},"id":{"$ref":"#/components/schemas/components-schemas-identifier"},"not_before":{"$ref":"#/components/schemas/not_before"},"status":{"$ref":"#/components/schemas/status"}}}}}]},"response_single_value":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"type":"object","properties":{"result":{"$ref":"#/components/schemas/value"}}}]},"result":{"type":"object","required":["rows","data","totals"],"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["dimensions","metrics"],"properties":{"dimensions":{"type":"array","description":"Array of dimension values for this row.","example":[{"name":"NODATA"}],"items":{"$ref":"#/components/schemas/dimension_value"}},"metrics":{"type":"array","items":{}}}}},"data_lag":{"type":"number","description":"Number of seconds between current time and last processed event, in another words how many seconds of data could be missing.","example":60,"minimum":0},"max":{"description":"Maximum results for each metric."},"min":{"description":"Minimum results for each metric."},"rows":{"type":"number","description":"Total number of rows in the result.","example":100,"minimum":0},"totals":{"description":"Total results for metrics across all data."}}},"result_info":{"type":"object","properties":{"count":{"type":"number","description":"Total number of results for the requested service","example":1},"page":{"type":"number","description":"Current page within paginated list of results","example":1},"per_page":{"type":"number","description":"Number of results per page of results","example":20},"total_count":{"type":"number","description":"Total results available without any search parameters","example":2000}}},"retries":{"type":"integer","description":"The number of retries to attempt in case of a timeout before marking the origin as unhealthy. Retries are attempted immediately.","default":2},"revision":{"type":"string","description":"The revision of the Railgun receiver.","example":"123","readOnly":true},"revoke_devices_request":{"type":"array","description":"A list of device ids to revoke.","maxLength":200,"items":{"$ref":"#/components/schemas/uuid"}},"revoked_at":{"type":"string","format":"date-time","description":"When the device was revoked.","example":"2017-06-14T00:00:00Z"},"rewrite_action":{"type":"object","description":"Specifies that, when a WAF rule matches, its configured action will be replaced by the action configured in this object.","properties":{"block":{"$ref":"#/components/schemas/waf_rewrite_action"},"challenge":{"example":"block"},"default":{"example":"block"},"disable":{"$ref":"#/components/schemas/waf_rewrite_action"},"simulate":{"example":"disable"}}},"risk_score":{"type":"number","description":"Hostname risk score, which is a value between 0 (lowest risk) to 1 (highest risk)."},"risk_types":{"example":[]},"rocket_loader":{"allOf":[{"$ref":"#/components/schemas/schemas-base"},{"properties":{"id":{"description":"ID of the zone setting.","enum":["rocket_loader"],"example":"rocket_loader"},"value":{"$ref":"#/components/schemas/rocket_loader_value"}}}],"title":"Rocket Loader","description":"Rocket Loader is a general-purpose asynchronous JavaScript optimisation that prioritises rendering your content while loading your site's Javascript asynchronously. Turning on Rocket Loader will immediately improve a web page's rendering time sometimes measured as Time to First Paint (TTFP), and also the `window.onload` time (assuming there is JavaScript on the page). This can have a positive impact on your Google search ranking. When turned on, Rocket Loader will automatically defer the loading of all Javascript referenced in your HTML, with no configuration required. Refer to [Understanding Rocket Loader](https://support.cloudflare.com/hc/articles/200168056) for more information."},"rocket_loader_value":{"type":"string","description":"Value of the zone setting.","enum":["on","off"],"default":"off"},"role":{"type":"object","required":["id","name","description","permissions"],"properties":{"description":{"type":"string","description":"Description of role's permissions.","example":"Administrative access to the entire Account","readOnly":true},"id":{"$ref":"#/components/schemas/role_components-schemas-identifier"},"name":{"type":"string","description":"Role name.","example":"Account Administrator","readOnly":true,"maxLength":120},"permissions":{"$ref":"#/components/schemas/permissions"}}},"role_components-schemas-identifier":{"type":"string","description":"Role identifier tag.","example":"3536bcfad5faccb999b47003c79917fb","readOnly":true,"maxLength":32},"roles":{"type":"array","description":"List of role names for the user at the account.","readOnly":true,"items":{"type":"string","example":"Account Administrator","maxLength":120}},"route":{"type":"object","properties":{"modified_on":{"type":"string","format":"date-time","description":"The timestamp of when the override was last modified.","example":"2014-01-01T05:20:00.12345Z","readOnly":true},"name":{"description":"The type of route.","enum":["forward_url"],"example":"forward_url"},"value":{"properties":{"type":{"description":"The response type for the URL redirect.","enum":["temporary","permanent"],"example":"temporary"},"url":{"type":"string","description":"The URL to redirect the request to.\nNotes: ${num} refers to the position of '*' in the constraint value.","example":"http://www.example.com/somewhere/$1/astring/$2/anotherstring/$3"}}}}},"route-no-id":{"required":["pattern"],"properties":{"pattern":{"$ref":"#/components/schemas/pattern"},"script":{"$ref":"#/components/schemas/schemas-script_name"}}},"route-response-collection":{"allOf":[{"$ref":"#/components/schemas/api-response-common"},{"properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/routes"}}}}]},"route-response-single":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/routes"}}}]},"route_add_single_request":{"type":"object","required":["prefix","nexthop","priority"],"properties":{"description":{"$ref":"#/components/schemas/route_components-schemas-description"},"nexthop":{"$ref":"#/components/schemas/nexthop"},"prefix":{"$ref":"#/components/schemas/prefix"},"priority":{"$ref":"#/components/schemas/route_components-schemas-priority"},"scope":{"$ref":"#/components/schemas/schemas-scope"},"weight":{"$ref":"#/components/schemas/schemas-weight"}}},"route_components-schemas-created_on":{"type":"string","format":"date-time","description":"When the route was created.","example":"2017-06-14T00:00:00Z","readOnly":true},"route_components-schemas-description":{"type":"string","description":"An optional human provided description of the static route.","example":"New route for new prefix 203.0.113.1"},"route_components-schemas-identifier":{"type":"string","description":"Route identifier tag.","example":"c4a7362d577a6c3019a474fd6f485821","readOnly":true,"maxLength":32},"route_components-schemas-modified_on":{"type":"string","format":"date-time","description":"When the route was last modified.","example":"2017-06-14T05:20:00Z","readOnly":true},"route_components-schemas-priority":{"type":"integer","description":"Priority of the static route."},"route_deleted_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"properties":{"deleted":{"type":"boolean","example":true},"deleted_route":{"type":"object"}}}}}]},"route_modified_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"properties":{"modified":{"type":"boolean","example":true},"modified_route":{"type":"object"}}}}}]},"route_response_collection":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"type":"object","properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/teamnet"}}}}]},"route_response_single":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"type":"object","properties":{"result":{"type":"object"}}}]},"route_single_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"properties":{"route":{"type":"object"}}}}}]},"route_update_many_request":{"type":"object","required":["routes"],"properties":{"routes":{"type":"array","items":{"$ref":"#/components/schemas/route_update_single_request"}}}},"route_update_request":{"allOf":[{"$ref":"#/components/schemas/route_add_single_request"}]},"route_update_single_request":{"allOf":[{"required":["id"],"properties":{"id":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}},{"$ref":"#/components/schemas/route_add_single_request"}]},"routes":{"type":"object","required":["id","pattern","script"],"properties":{"id":{"$ref":"#/components/schemas/common_components-schemas-identifier"},"pattern":{"$ref":"#/components/schemas/pattern"},"script":{"$ref":"#/components/schemas/schemas-script_name"}}},"routes_collection_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"properties":{"routes":{"type":"array","items":{"$ref":"#/components/schemas/schemas-route"}}}}}}]},"rule":{"type":"object","required":["id","mode","allowed_modes","configuration"],"properties":{"allowed_modes":{"type":"array","description":"The available actions that a rule can apply to a matched request.","example":["whitelist","block","challenge","js_challenge","managed_challenge"],"readOnly":true,"items":{"$ref":"#/components/schemas/schemas-mode"}},"configuration":{"$ref":"#/components/schemas/schemas-configuration"},"created_on":{"type":"string","format":"date-time","description":"The timestamp of when the rule was created.","example":"2014-01-01T05:20:00.12345Z","readOnly":true},"id":{"$ref":"#/components/schemas/rule_components-schemas-identifier"},"mode":{"$ref":"#/components/schemas/schemas-mode"},"modified_on":{"type":"string","format":"date-time","description":"The timestamp of when the rule was last modified.","example":"2014-01-01T05:20:00.12345Z","readOnly":true},"notes":{"$ref":"#/components/schemas/notes"}}},"rule-settings":{"type":"object","description":"Additional settings that modify the rule's action.","properties":{"add_headers":{"type":"object","description":"Add custom headers to allowed requests, in the form of key-value pairs. Keys are header names, pointing to an array with its header value(s).","example":{"My-Next-Header":["foo","bar"],"X-Custom-Header-Name":["somecustomvalue"]}},"biso_admin_controls":{"type":"object","description":"Configure how browser isolation behaves.","properties":{"dcp":{"type":"boolean","description":"Disable copy-paste.","example":false},"dd":{"type":"boolean","description":"Disable download.","example":false},"dk":{"type":"boolean","description":"Disable keyboard usage.","example":false},"dp":{"type":"boolean","description":"Disable printing.","example":false},"du":{"type":"boolean","description":"Disable upload.","example":false}}},"block_page_enabled":{"type":"boolean","description":"Enable the custom block page.","example":true},"block_reason":{"type":"string","description":"The text describing why this block occurred that will be displayed on the custom block page (if enabled).","example":"This website is a security risk"},"check_session":{"type":"object","description":"Configure how session check behaves.","properties":{"duration":{"type":"string","description":"Configure how fresh the session needs to be to be considered valid.","example":"300s"},"enforce":{"type":"boolean","description":"Enable session enforcement for this fule.","example":true}}},"insecure_disable_dnssec_validation":{"type":"boolean","description":"INSECURE - disable DNSSEC validation (for allow actions).","example":false},"ip_categories":{"type":"boolean","description":"Include IPs in DNS resolver category blocks. By default categories only block on domain names.","example":true},"l4override":{"type":"object","description":"Send matching traffic to the supplied destination IP address and port.","properties":{"ip":{"type":"string","description":"IPv4 or IPv6 address.","example":"1.1.1.1"},"port":{"type":"integer","description":"A port number to use for TCP/UDP overrides."}}},"override_host":{"type":"string","description":"Override matching DNS queries with this.","example":"example.com"},"override_ips":{"type":"array","description":"Override matching DNS queries with this.","example":["1.1.1.1","2.2.2.2"],"items":{"type":"string","description":"IPv4 or IPv6 address.","example":"1.1.1.1"}}}},"rule_action":{"type":"string","description":"The action to take when the expression matches.","enum":["bypass_waiting_room"],"example":"bypass_waiting_room"},"rule_collection_response":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/rule"}}}}]},"rule_components-schemas-base":{"properties":{"description":{"$ref":"#/components/schemas/rule_components-schemas-description"},"group":{"type":"object","description":"The rule group to which the current WAF rule belongs.","readOnly":true,"properties":{"id":{"$ref":"#/components/schemas/group_components-schemas-identifier"},"name":{"$ref":"#/components/schemas/group_components-schemas-name"}}},"id":{"$ref":"#/components/schemas/rule_components-schemas-identifier-2"},"package_id":{"$ref":"#/components/schemas/package_components-schemas-identifier"},"priority":{"$ref":"#/components/schemas/rule_components-schemas-priority"}}},"rule_components-schemas-base-2":{"allOf":[{"$ref":"#/components/schemas/rule_components-schemas-base"}]},"rule_components-schemas-description":{"type":"string","description":"The public description of the WAF rule.","example":"SQL injection prevention for SELECT statements","readOnly":true},"rule_components-schemas-identifier":{"type":"string","description":"The unique identifier of the IP Access rule.","example":"92f17202ed8bd63d69a66b86a49a8f6b","readOnly":true,"maxLength":32},"rule_components-schemas-identifier-2":{"type":"string","description":"The unique identifier of the WAF rule.","example":"f939de3be84e66e757adcdcb87908023","readOnly":true,"maxLength":32},"rule_components-schemas-priority":{"type":"string","description":"The order in which the individual WAF rule is executed within its rule group.","readOnly":true},"rule_components-schemas-rule":{"oneOf":[{"$ref":"#/components/schemas/email_rule"},{"$ref":"#/components/schemas/domain_rule"},{"$ref":"#/components/schemas/everyone_rule"},{"$ref":"#/components/schemas/ip_rule"},{"$ref":"#/components/schemas/ip_list_rule"},{"$ref":"#/components/schemas/certificate_rule"},{"$ref":"#/components/schemas/access_group_rule"},{"$ref":"#/components/schemas/azure_group_rule"},{"$ref":"#/components/schemas/github_organization_rule"},{"$ref":"#/components/schemas/gsuite_group_rule"},{"$ref":"#/components/schemas/okta_group_rule"},{"$ref":"#/components/schemas/saml_group_rule"}],"type":"object"},"rule_description":{"type":"string","description":"The description of the rule.","default":"","example":"allow all traffic from 10.20.30.40"},"rule_enabled":{"type":"boolean","description":"When set to true, the rule is enabled.","default":true,"example":true},"rule_expression":{"type":"string","description":"Criteria defining when there is a match for the current rule.","example":"ip.src in {10.20.30.40}"},"rule_group_response_collection":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/schemas-group"}}}}]},"rule_group_response_single":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"type":"object"}}}]},"rule_id":{"type":"string","description":"The ID of the rule.","example":"25756b2dfe6e378a06b033b670413757"},"rule_identifier":{"type":"string","description":"Routing rule identifier.","example":"a7e6fb77503c41d8a7f3113c6918f10c","readOnly":true,"maxLength":32},"rule_position":{"oneOf":[{"type":"object","properties":{"index":{"type":"integer","description":" Places the rule in the exact position specified by the integer number <POSITION_NUMBER>. Position numbers start with 1. Existing rules in the ruleset from the specified position number onward are shifted one position (no rule is overwritten)."}}},{"type":"object","properties":{"before":{"type":"string","description":" Places the rule before rule <RULE_ID>. Use this argument with an empty rule ID value (\"\") to set the rule as the first rule in the ruleset.","example":"<RULE_ID>"}}},{"type":"object","properties":{"after":{"type":"string","description":"Places the rule after rule <RULE_ID>. Use this argument with an empty rule ID value (\"\") to set the rule as the last rule in the ruleset.","example":"<RULE_ID>"}}}],"type":"object","description":"Reorder the position of a rule"},"rule_properties":{"type":"object","properties":{"actions":{"$ref":"#/components/schemas/actions"},"enabled":{"$ref":"#/components/schemas/rules_components-schemas-enabled"},"matchers":{"$ref":"#/components/schemas/matchers"},"name":{"$ref":"#/components/schemas/rules_components-schemas-name"},"priority":{"$ref":"#/components/schemas/components-schemas-priority"},"tag":{"$ref":"#/components/schemas/rule_identifier"}}},"rule_response_collection":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/components-schemas-rule"}}}}]},"rule_response_single":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"type":"object"}}}]},"rule_result":{"type":"object","properties":{"action":{"$ref":"#/components/schemas/rule_action"},"description":{"$ref":"#/components/schemas/rule_description"},"enabled":{"$ref":"#/components/schemas/rule_enabled"},"expression":{"$ref":"#/components/schemas/rule_expression"},"id":{"$ref":"#/components/schemas/rule_id"},"last_updated":{"$ref":"#/components/schemas/timestamp"},"version":{"$ref":"#/components/schemas/rule_version"}}},"rule_single_id_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/rule_components-schemas-identifier"}}}}}]},"rule_single_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/rule"}}}]},"rule_version":{"type":"string","description":"The version of the rule.","example":"1"},"rules":{"allOf":[{"$ref":"#/components/schemas/rule_properties"}],"type":"object"},"rules_components-schemas-account_identifier":{"example":"6f91088a406011ed95aed352566e8d4c"},"rules_components-schemas-action":{"type":"string","description":"The action to perform when the rule matches.","example":"execute","pattern":"^[a-z_]+$"},"rules_components-schemas-action-2":{"type":"string","description":"The action to preform when the associated traffic, identity, and device posture expressions are either absent or evaluate to 'true'.","enum":["on","off","allow","block","scan","noscan","safesearch","ytrestricted","isolate","noisolate","override","l4_override"],"example":"allow"},"rules_components-schemas-description":{"type":"string","description":"An informative description of the rule.","default":"","example":"Execute the OWASP ruleset when the IP address is not 1.1.1.1"},"rules_components-schemas-description-2":{"type":"string","description":"The description of the Rule.","example":"Block the bad websites based on host name"},"rules_components-schemas-empty_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"type":"object"}}}]},"rules_components-schemas-enabled":{"type":"boolean","description":"Routing rule status.","enum":[true,false],"default":true,"example":true},"rules_components-schemas-enabled-2":{"type":"boolean","description":"Whether the rule should be executed.","default":"true","example":true},"rules_components-schemas-enabled-3":{"type":"boolean","description":"Set if the rule is enabled.","example":true},"rules_components-schemas-id":{"type":"string","description":"The unique ID of the rule.","example":"3a03d665bac047339bb530ecb439a90d"},"rules_components-schemas-identifier":{"example":"699d98642c564d2e855e9661899b7252"},"rules_components-schemas-name":{"type":"string","description":"Routing rule name.","example":"Send to user@example.net rule.","maxLength":256},"rules_components-schemas-name-2":{"type":"string","description":"The name of the Rule.","example":"block bad websites"},"rules_components-schemas-response_collection":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/rules_components-schemas-rules"}}}}]},"rules_components-schemas-rule":{"type":"object","description":"A rule object.","properties":{"action":{"$ref":"#/components/schemas/rules_components-schemas-action"},"action_parameters":{"$ref":"#/components/schemas/action_parameters"},"categories":{"$ref":"#/components/schemas/categories"},"description":{"$ref":"#/components/schemas/rules_components-schemas-description"},"enabled":{"$ref":"#/components/schemas/rules_components-schemas-enabled-2"},"expression":{"$ref":"#/components/schemas/schemas-expression"},"id":{"$ref":"#/components/schemas/rules_components-schemas-id"},"last_updated":{"$ref":"#/components/schemas/schemas-last_updated"},"logging":{"$ref":"#/components/schemas/logging"},"ref":{"$ref":"#/components/schemas/components-schemas-ref"},"version":{"$ref":"#/components/schemas/schemas-version"}}},"rules_components-schemas-rules":{"type":"object","properties":{"action":{"$ref":"#/components/schemas/rules_components-schemas-action-2"},"created_at":{"$ref":"#/components/schemas/timestamp"},"deleted_at":{"$ref":"#/components/schemas/deleted_at"},"description":{"$ref":"#/components/schemas/rules_components-schemas-description-2"},"device_posture":{"$ref":"#/components/schemas/device_posture"},"enabled":{"$ref":"#/components/schemas/rules_components-schemas-enabled-3"},"filters":{"$ref":"#/components/schemas/schemas-filters"},"id":{"$ref":"#/components/schemas/rules_components-schemas-uuid"},"identity":{"$ref":"#/components/schemas/identity"},"name":{"$ref":"#/components/schemas/rules_components-schemas-name-2"},"precedence":{"$ref":"#/components/schemas/schemas-precedence"},"rule_settings":{"$ref":"#/components/schemas/rule-settings"},"traffic":{"$ref":"#/components/schemas/traffic"},"updated_at":{"$ref":"#/components/schemas/timestamp"}}},"rules_components-schemas-single_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/rules_components-schemas-rules"}}}]},"rules_components-schemas-uuid":{"type":"string","description":"API Resource UUID tag.","example":"f174e90a-fafe-4643-bbbc-4a0ed4fc8415","maxLength":36},"rules_count":{"type":"number","description":"The number of rules in the current rule group.","default":0,"example":10,"readOnly":true},"rules_response_collection":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/rules"}},"result_info":{"type":"object","properties":{"count":{"example":1},"page":{"example":1},"per_page":{"example":20},"total_count":{"example":1}}}}}]},"ruleset":{"type":"object","description":"A ruleset object.","properties":{"description":{"$ref":"#/components/schemas/rulesets_components-schemas-description"},"id":{"$ref":"#/components/schemas/rulesets_components-schemas-id"},"kind":{"$ref":"#/components/schemas/schemas-kind"},"last_updated":{"$ref":"#/components/schemas/last_updated"},"name":{"$ref":"#/components/schemas/rulesets_components-schemas-name"},"phase":{"$ref":"#/components/schemas/phase"},"rules":{"$ref":"#/components/schemas/components-schemas-rules"},"version":{"$ref":"#/components/schemas/version"}}},"ruleset_response":{"allOf":[{"$ref":"#/components/schemas/api-response-common"},{"type":"object","properties":{"result":{"$ref":"#/components/schemas/ruleset"}}}]},"ruleset_without_rules":{"type":"object","description":"A ruleset object.","properties":{"description":{"$ref":"#/components/schemas/rulesets_components-schemas-description"},"id":{"$ref":"#/components/schemas/rulesets_components-schemas-id"},"kind":{"$ref":"#/components/schemas/schemas-kind"},"last_updated":{"$ref":"#/components/schemas/last_updated"},"name":{"$ref":"#/components/schemas/rulesets_components-schemas-name"},"phase":{"$ref":"#/components/schemas/phase"},"version":{"$ref":"#/components/schemas/version"}}},"rulesets_components-schemas-description":{"type":"string","description":"An informative description of the ruleset.","default":"","example":"My ruleset to execute managed rulesets"},"rulesets_components-schemas-id":{"type":"string","description":"The unique ID of the ruleset.","example":"2f2feab2026849078ba485f918791bdc","pattern":"^[0-9a-f]{32}$"},"rulesets_components-schemas-name":{"type":"string","description":"The human-readable name of the ruleset.","example":"My ruleset"},"rulesets_response":{"allOf":[{"$ref":"#/components/schemas/api-response-common"},{"type":"object","properties":{"result":{"type":"array","description":"A list of rulesets. The returned information will not include the rules in each ruleset.","items":{"$ref":"#/components/schemas/ruleset_without_rules"}}}}]},"run_at":{"type":"string","format":"date-time","description":"Timestamp of when the tunnel connection was started.","example":"2009-11-10T23:00:00Z"},"saas_app":{"type":"object","properties":{"consumer_service_url":{"type":"string","description":"The service provider's endpoint that is responsible for receiving and parsing a SAML assertion.","example":"https://example.com"},"created_at":{"$ref":"#/components/schemas/timestamp"},"custom_attributes":{"type":"object","properties":{"name":{"type":"string","description":"The name of the attribute.","example":"family_name"},"name_format":{"type":"string","description":"A globally unique name for an identity or service provider.","enum":["urn:oasis:names:tc:SAML:2.0:attrname-format:unspecified","urn:oasis:names:tc:SAML:2.0:attrname-format:basic","urn:oasis:names:tc:SAML:2.0:attrname-format:uri"],"example":"urn:oasis:names:tc:SAML:2.0:attrname-format:basic"},"source":{"type":"object","properties":{"name":{"type":"string","description":"The name of the IdP attribute.","example":"last_name"}}}}},"idp_entity_id":{"type":"string","description":"The unique identifier for your SaaS application.","example":"https://example.cloudflareaccess.com"},"name_id_format":{"type":"string","description":"The format of the name identifier sent to the SaaS application.","enum":["id","email"],"example":"id"},"public_key":{"type":"string","description":"The Access public certificate that will be used to verify your identity.","example":"example unique name"},"sp_entity_id":{"type":"string","description":"A globally unique name for an identity or service provider.","example":"example unique name"},"sso_endpoint":{"type":"string","description":"The endpoint where your SaaS application will send login requests.","example":"https://example.cloudflareaccess.com/cdn-cgi/access/sso/saml/b3f58a2b414e0b51d45c8c2af26fccca0e27c63763c426fa52f98dcf0b3b3bfd"},"updated_at":{"$ref":"#/components/schemas/timestamp"}}},"saas_props":{"type":"object","title":"SaaS Application","properties":{"allowed_idps":{"$ref":"#/components/schemas/allowed_idps"},"app_launcher_visible":{"$ref":"#/components/schemas/app_launcher_visible"},"auto_redirect_to_identity":{"$ref":"#/components/schemas/auto_redirect_to_identity"},"logo_url":{"$ref":"#/components/schemas/logo_url"},"name":{"$ref":"#/components/schemas/apps_components-schemas-name"},"saas_app":{"$ref":"#/components/schemas/saas_app"},"type":{"type":"string","description":"The application type.","example":"saas"}}},"same_site_cookie_attribute":{"type":"string","description":"Sets the SameSite cookie setting, which provides increased security against CSRF attacks.","example":"strict"},"saml_group_rule":{"type":"object","title":"SAML group","description":"Matches a SAML group.\nRequires a SAML identity provider.","required":["saml"],"properties":{"saml":{"type":"object","required":["attribute_name","attribute_value"],"properties":{"attribute_name":{"type":"string","description":"The name of the SAML attribute.","example":"group"},"attribute_value":{"type":"string","description":"The SAML attribute value to look for.","example":"devs@cloudflare.com"}}}}},"scale":{"type":"number","description":"The size of the image relative to the overall size of the video. This parameter will adapt to horizontal and vertical videos automatically. `0.0` indicates no scaling (use the size of the image as-is), and `1.0 `fills the entire video.","default":0.15,"example":0.1,"readOnly":true,"minimum":0,"maximum":1},"schedule":{"type":"string","description":"Polling frequency for the WARP client posture check. Default: `5m` (poll every five minutes). Minimum: `1m`.","example":"1h"},"schema_response_discovery":{"allOf":[{"$ref":"#/components/schemas/default_response"},{"properties":{"result":{"type":"object","properties":{"schemas":{"type":"array","items":{"$ref":"#/components/schemas/openapi"}},"timestamp":{"type":"string"}}}}}]},"schema_response_with_thresholds":{"allOf":[{"$ref":"#/components/schemas/default_response"},{"properties":{"result":{"type":"object","properties":{"schemas":{"type":"array","items":{"$ref":"#/components/schemas/openapiwiththresholds"}},"timestamp":{"type":"string"}}}}}]},"schemas-access_seat":{"type":"boolean","description":"True if the user has authenticated with Cloudflare Access.","example":false},"schemas-account":{"allOf":[{"$ref":"#/components/schemas/account"}],"readOnly":true},"schemas-account_identifier":{"example":"01a7362d577a6c3019a474fd6f485823"},"schemas-action":{"type":"object","description":"Actions pattern.","required":["type","value"],"properties":{"type":{"type":"string","description":"Type of supported action.","enum":["forward","worker"],"example":"forward"},"value":{"type":"array","items":{"type":"string","description":"Value for action.","example":"destinationaddress@example.net","maxLength":90}}}},"schemas-action_parameters":{"oneOf":[{"$ref":"#/components/schemas/action_parameters_rewrite"}],"type":"object","description":"The parameters configuring the action."},"schemas-actions":{"type":"array","description":"The set of actions to perform if the targets of this rule match the request. Actions can redirect to another URL or override settings, but not both.","example":[{"id":"browser_check","value":"on"}],"items":{"oneOf":[{"$ref":"#/components/schemas/route"}]}},"schemas-address":{"type":"string","description":"The hostname or IP address of the origin server to run health checks on.","example":"www.example.com"},"schemas-advertised":{"type":"boolean","description":"Enablement of prefix advertisement to the Internet.","example":true},"schemas-alert_type":{"type":"string","description":"Type of notification that has been dispatched.","example":"universal_ssl_event_type"},"schemas-allowed":{"type":"boolean","description":"The result of the authentication event.","default":false},"schemas-app_id":{"example":"699d98642c564d2e855e9661899b7252"},"schemas-app_launcher_visible":{"type":"boolean","description":"Displays the application in the App Launcher.","example":true},"schemas-application":{"type":"object","description":"Application that the hostname belongs to.","properties":{"id":{"type":"integer"},"name":{"type":"string","example":"CLOUDFLARE"}}},"schemas-apps":{"anyOf":[{"allOf":[{"$ref":"#/components/schemas/basic_app_response_props"},{"$ref":"#/components/schemas/self_hosted_props"}],"type":"object","title":"Self Hosted Application"},{"allOf":[{"$ref":"#/components/schemas/basic_app_response_props"},{"$ref":"#/components/schemas/saas_props"}],"type":"object","title":"SaaS Application"},{"allOf":[{"$ref":"#/components/schemas/basic_app_response_props"},{"$ref":"#/components/schemas/ssh_props"}],"type":"object","title":"Browser SSH Application"},{"allOf":[{"$ref":"#/components/schemas/basic_app_response_props"},{"$ref":"#/components/schemas/vnc_props"}],"type":"object","title":"Browser VNC Application"},{"allOf":[{"$ref":"#/components/schemas/basic_app_response_props"},{"$ref":"#/components/schemas/app_launcher_props"}],"type":"object","title":"App Launcher Application"},{"allOf":[{"$ref":"#/components/schemas/basic_app_response_props"},{"$ref":"#/components/schemas/warp_props"}],"type":"object","title":"Device Enrollment Permissions Application"},{"allOf":[{"$ref":"#/components/schemas/basic_app_response_props"},{"$ref":"#/components/schemas/biso_props"}],"type":"object","title":"Browser Isolation Permissions Application"},{"allOf":[{"$ref":"#/components/schemas/basic_app_response_props"},{"$ref":"#/components/schemas/schemas-bookmark_props"}],"type":"object","title":"Bookmark application"}],"type":"object"},"schemas-asn":{"type":"string","description":"AS number associated with the node object."},"schemas-aud":{"type":"string","description":"Audience tag.","example":"737646a56ab1df6ec9bddc7e5ca84eaf3b0768850f3ffb5d74f1534911fe3893","readOnly":true,"maxLength":64},"schemas-automatic_platform_optimization":{"allOf":[{"$ref":"#/components/schemas/schemas-base"},{"properties":{"id":{"description":"ID of the zone setting.","enum":["automatic_platform_optimization"],"example":"automatic_platform_optimization"},"value":{"$ref":"#/components/schemas/automatic_platform_optimization"}}}],"title":"Automatic Platform Optimization for WordPress","description":"[Automatic Platform Optimization for WordPress](https://developers.cloudflare.com/automatic-platform-optimization/) serves your WordPress site from Cloudflare's edge network and caches third-party fonts."},"schemas-available":{"type":"boolean","description":"Shows if a domain is available for transferring into Cloudflare Registrar.","example":false},"schemas-base":{"required":["id","value"],"properties":{"editable":{"type":"boolean","description":"Whether or not this setting can be modified for this zone (based on your Cloudflare plan level).","enum":[true,false],"default":true,"readOnly":true},"id":{"type":"string","description":"Identifier of the zone setting.","example":"development_mode"},"modified_on":{"type":"string","format":"date-time","description":"last time this setting was modified.","example":"2014-01-01T05:20:00.12345Z","nullable":true,"readOnly":true},"value":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"object"},{"type":"array","items":{}}],"description":"Current value of the zone setting.","example":"on"}}},"schemas-bookmark_props":{"type":"object","title":"Bookmark Application","properties":{"app_launcher_visible":{"default":true},"domain":{"description":"The URL or domain of the bookmark.","example":"https://mybookmark.com"},"logo_url":{"$ref":"#/components/schemas/logo_url"},"name":{"$ref":"#/components/schemas/apps_components-schemas-name"},"type":{"type":"string","description":"The application type.","example":"bookmark"}}},"schemas-can_delete":{"type":"boolean","description":"Controls whether the membership can be deleted via the API or not.","example":true},"schemas-categories":{"type":"object","readOnly":true,"properties":{"beta":{"$ref":"#/components/schemas/beta"},"class":{"$ref":"#/components/schemas/class"},"description":{"$ref":"#/components/schemas/categories_components-schemas-description"},"id":{"$ref":"#/components/schemas/categories_components-schemas-id"},"name":{"$ref":"#/components/schemas/categories_components-schemas-name"},"subcategories":{"type":"array","description":"All subcategories for this category.","items":{"$ref":"#/components/schemas/subcategory"}}}},"schemas-certificate":{"type":"string","description":"The zone's SSL certificate or SSL certificate and intermediate(s).","example":"-----BEGIN CERTIFICATE----- MIIDtTCCAp2gAwIBAgIJAM15n7fdxhRtMA0GCSqGSIb3DQEBBQUAMEUxCzAJBgNV BAYTAlVTMRMwEQYDVQQIEwpTb21lLVN0YXRlMSEwHwYDVQQKExhJbnRlcm5ldCBX aWRnaXRzIFB0eSBMdGQwHhcNMTQwMzExMTkyMTU5WhcNMTQwNDEwMTkyMTU5WjBF MQswCQYDVQQGEwJVUzETMBEGA1UECBMKU29tZS1TdGF0ZTEhMB8GA1UEChMYSW50 ZXJuZXQgV2lkZ2l0cyBQdHkgTHRkMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIB CgKCAQEAvq3sKsHpeduJHimOK+fvQdKsI8z8A05MZyyLp2/R/GE8FjNv+hkVY1WQ LIyTNNQH7CJecE1nbTfo8Y56S7x/rhxC6/DJ8MIulapFPnorq46KU6yRxiM0MQ3N nTJHlHA2ozZta6YBBfVfhHWl1F0IfNbXCLKvGwWWMbCx43OfW6KTkbRnE6gFWKuO fSO5h2u5TaWVuSIzBvYs7Vza6m+gtYAvKAJV2nSZ+eSEFPDo29corOy8+huEOUL8 5FAw4BFPsr1TlrlGPFitduQUHGrSL7skk1ESGza0to3bOtrodKei2s9bk5MXm7lZ qI+WZJX4Zu9+mzZhc9pCVi8r/qlXuQIDAQABo4GnMIGkMB0GA1UdDgQWBBRvavf+ sWM4IwKiH9X9w1vl6nUVRDB1BgNVHSMEbjBsgBRvavf+sWM4IwKiH9X9w1vl6nUV RKFJpEcwRTELMAkGA1UEBhMCVVMxEzARBgNVBAgTClNvbWUtU3RhdGUxITAfBgNV BAoTGEludGVybmV0IFdpZGdpdHMgUHR5IEx0ZIIJAM15n7fdxhRtMAwGA1UdEwQF MAMBAf8wDQYJKoZIhvcNAQEFBQADggEBABY2ZzBaW0dMsAAT7tPJzrVWVzQx6KU4 UEBLudIlWPlkAwTnINCWR/8eNjCCmGA4heUdHmazdpPa8RzwOmc0NT1NQqzSyktt vTqb4iHD7+8f9MqJ9/FssCfTtqr/Qst/hGH4Wmdf1EJ/6FqYAAb5iRlPgshFZxU8 uXtA8hWn6fK6eISD9HBdcAFToUvKNZ1BIDPvh9f95Ine8ar6yGd56TUNrHR8eHBs ESxz5ddVR/oWRysNJ+aGAyYqHS8S/ttmC7r4XCAHqXptkHPCGRqkAhsterYhd4I8 /cBzejUobNCjjHFbtkAL/SjxZOLW+pNkZwfeYdM8iPkD54Uua1v2tdw= -----END CERTIFICATE-----"},"schemas-certificate_authority":{"type":"string","description":"The Certificate Authority that Total TLS certificates will be issued through.","enum":["google","lets_encrypt"],"example":"google"},"schemas-certificate_response_collection":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"type":"object","properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/certificates"}}}}]},"schemas-certificate_response_single":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"type":"object","properties":{"result":{"type":"object"}}}]},"schemas-certificateObject":{"properties":{"certificate":{"$ref":"#/components/schemas/hostname-authenticated-origin-pull_components-schemas-certificate"},"expires_on":{"$ref":"#/components/schemas/hostname-authenticated-origin-pull_components-schemas-expires_on"},"id":{"$ref":"#/components/schemas/hostname-authenticated-origin-pull_components-schemas-identifier"},"issuer":{"$ref":"#/components/schemas/issuer"},"serial_number":{"$ref":"#/components/schemas/serial_number"},"signature":{"$ref":"#/components/schemas/signature"},"status":{"$ref":"#/components/schemas/hostname-authenticated-origin-pull_components-schemas-status"},"uploaded_on":{"$ref":"#/components/schemas/components-schemas-uploaded_on"}}},"schemas-certificates":{"type":"object","properties":{"associated_hostnames":{"$ref":"#/components/schemas/associated_hostnames"},"created_at":{"$ref":"#/components/schemas/timestamp"},"expires_on":{"$ref":"#/components/schemas/timestamp"},"fingerprint":{"$ref":"#/components/schemas/fingerprint"},"id":{"description":"The ID of the application that will use this certificate."},"name":{"$ref":"#/components/schemas/certificates_components-schemas-name"},"updated_at":{"$ref":"#/components/schemas/timestamp"}}},"schemas-check_regions":{"type":"array","description":"A list of regions from which to run health checks. Null means Cloudflare will pick a default region.","example":["WEU","ENAM"],"nullable":true,"items":{"type":"string","description":"WNAM: Western North America, ENAM: Eastern North America, WEU: Western Europe, EEU: Eastern Europe, NSAM: Northern South America, SSAM: Southern South America, OC: Oceania, ME: Middle East, NAF: North Africa, SAF: South Africa, IN: India, SEAS: South East Asia, NEAS: North East Asia, ALL_REGIONS: all regions (BUSINESS and ENTERPRISE customers only).","enum":["WNAM","ENAM","WEU","EEU","NSAM","SSAM","OC","ME","NAF","SAF","IN","SEAS","NEAS","ALL_REGIONS"]}},"schemas-cidr_configuration":{"title":"An IP address range configuration.","properties":{"target":{"description":"The configuration target. You must set the target to `ip_range` when specifying an IP address range in the Zone Lockdown rule.","enum":["ip_range"],"example":"ip_range"},"value":{"type":"string","description":"The IP address range to match. You can only use prefix lengths `/16` and `/24`.","example":"198.51.100.4/16"}}},"schemas-collection_invite_response":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"type":"object","properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/schemas-invite"}}}}]},"schemas-collection_response":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"type":"array","items":{"properties":{"additional_information":{"$ref":"#/components/schemas/additional_information"},"application":{"$ref":"#/components/schemas/schemas-application"},"content_categories":{"$ref":"#/components/schemas/content_categories"},"domain":{"$ref":"#/components/schemas/schemas-domain_name"},"popularity_rank":{"$ref":"#/components/schemas/popularity_rank"},"risk_score":{"$ref":"#/components/schemas/risk_score"},"risk_types":{"$ref":"#/components/schemas/risk_types"}}}}}}]},"schemas-colo_name":{"type":"string","description":"The Cloudflare data center used for this connection.","example":"DFW"},"schemas-comment":{"type":"string","description":"Optional remark describing the virtual network.","example":"Staging VPC for data science"},"schemas-component_values":{"type":"array","description":"Array of available components values for the plan.","items":{"$ref":"#/components/schemas/component-value"}},"schemas-config":{"type":"object","description":"The configuration parameters for the identity provider. To view the required parameters for a specific provider, refer to our [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/)."},"schemas-configuration":{"oneOf":[{"$ref":"#/components/schemas/ip_configuration"},{"$ref":"#/components/schemas/ipv6_configuration"},{"$ref":"#/components/schemas/cidr_configuration"},{"$ref":"#/components/schemas/asn_configuration"},{"$ref":"#/components/schemas/country_configuration"}],"type":"object","description":"The rule configuration."},"schemas-connection":{"type":"object","required":["id","zone","enabled"],"properties":{"created_on":{"$ref":"#/components/schemas/connection_components-schemas-created_on"},"enabled":{"$ref":"#/components/schemas/connection_components-schemas-enabled"},"id":{"$ref":"#/components/schemas/connection_components-schemas-identifier"},"modified_on":{"$ref":"#/components/schemas/connection_components-schemas-modified_on"},"zone":{"$ref":"#/components/schemas/connection_components-schemas-zone"}}},"schemas-count":{"type":"number","description":"Total results returned based on your search parameters.","example":1},"schemas-create":{"type":"object","required":["name","account"],"properties":{"account":{"type":"object","description":"Account in which the zone was created.","properties":{"id":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}},"name":{"$ref":"#/components/schemas/properties-name"},"type":{"$ref":"#/components/schemas/components-schemas-type"}}},"schemas-created":{"type":"string","format":"date-time","description":"The date and time the media item was created.","example":"2014-01-02T02:20:00Z","readOnly":true},"schemas-created_at":{"type":"string","format":"date-time","description":"The time when the certificate was created.","example":"2100-01-01T05:20:00Z","readOnly":true},"schemas-created_on":{"type":"string","format":"date-time","description":"The timestamp of when the rule was created.","example":"2014-01-01T05:20:00.12345Z","readOnly":true},"schemas-cursor":{"type":"string","description":"Opaque token indicating the position from which to continue when requesting the next set of records. A valid value for the cursor can be obtained from the cursors object in the result_info structure.","example":"AAAAANuhDN7SjacTnSVsDu3WW1Lvst6dxJGTjRY5BhxPXdf6L6uTcpd_NVtjhn11OUYRsVEykxoUwF-JQU4dn6QylZSKTOJuG0indrdn_MlHpMRtsxgXjs-RPdHYIVm3odE_uvEQ_dTQGFm8oikZMohns34DLBgrQpc"},"schemas-default":{"type":"boolean","description":"Whether the policy is the default policy for an account.","example":false},"schemas-deleted":{"type":"boolean","description":"True if the device was deleted.","example":true},"schemas-deleted_at":{"type":"string","format":"date-time","description":"Timestamp of when the tunnel was deleted. If `null`, the tunnel has not been deleted.","example":"2009-11-10T23:00:00Z","nullable":true},"schemas-deleted_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"type":"object","example":{}}}}]},"schemas-description":{"type":"string","description":"The billing item description.","example":"The billing item description","readOnly":true,"maxLength":255},"schemas-direct_upload_request":{"type":"object","properties":{"expiry":{"type":"string","format":"date-time","description":"The date after which the upload will not be accepted. Minimum: Now + 2 minutes. Maximum: Now + 6 hours.","default":"Now + 30 minutes","example":"2021-01-02T02:20:00Z"}}},"schemas-direct_upload_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"properties":{"id":{"$ref":"#/components/schemas/images_components-schemas-identifier"},"uploadURL":{"type":"string","description":"The URL the unauthenticated upload can be performed to using a single HTTP POST (multipart/form-data) request.","example":"https://upload.imagedelivery.net/e22e9e6b-c02b-42fd-c405-6c32af5fe623"}}}}}]},"schemas-disabled_at":{"type":"string","format":"date-time","description":"This field shows up only if the pool is disabled. This field is set with the time the pool was disabled at.","readOnly":true},"schemas-dns-firewall":{"allOf":[{"$ref":"#/components/schemas/dns-firewall"}],"type":"object"},"schemas-dns-record":{"type":"object","description":"List of records needed to enable an Email Routing zone.","properties":{"content":{"type":"string","description":"DNS record content.","example":"127.0.0.1"},"name":{"type":"string","description":"DNS record name (or @ for the zone apex).","example":"example.com","maxLength":255},"priority":{"type":"number","description":"Required for MX, SRV and URI records. Unused by other record types. Records with lower priorities are preferred.","example":10,"minimum":0,"maximum":65535},"ttl":{"anyOf":[{"type":"number","example":3600,"minimum":60,"maximum":86400},{"type":"number","enum":[1]}],"type":"number","description":"Time to live, in seconds, of the DNS record. Must be between 60 and 86400, or 1 for 'automatic'.","example":3600},"type":{"type":"string","description":"DNS record type.","enum":["A","AAAA","CNAME","HTTPS","TXT","SRV","LOC","MX","NS","CERT","DNSKEY","DS","NAPTR","SMIMEA","SSHFP","SVCB","TLSA","URI"],"example":"A","readOnly":true}}},"schemas-domain":{"type":"string","description":"The domain and path that Access will secure.","example":"test.example.com/admin"},"schemas-domain_identifier":{"type":"string","description":"Domain identifier.","example":"ea95132c15732412d22c1476fa83f27a","readOnly":true,"maxLength":32},"schemas-domain_name":{"type":"string","example":"cloudflare.com"},"schemas-duration":{"type":"integer","description":"The duration of the video in seconds. A value of `-1` means the duration is unknown. The duration becomes available after the upload and before the video is ready.","readOnly":true},"schemas-email":{"type":"string","format":"email","description":"The email address of the authenticating user.","example":"user@example.com"},"schemas-empty_response":{"allOf":[{"properties":{"result":{"type":"boolean","enum":[true,false],"example":true},"success":{"type":"boolean","enum":[true,false],"example":true}}}]},"schemas-enabled":{"type":"boolean","description":"Whether or not the Keyless SSL is on or off.","example":false,"readOnly":true},"schemas-exclude":{"type":"array","description":"Rules evaluated with a NOT logical operator. To match the policy, a user cannot meet any of the Exclude rules.","items":{"$ref":"#/components/schemas/rule_components-schemas-rule"}},"schemas-expected_codes":{"type":"string","description":"The expected HTTP response codes or code ranges of the health check, comma-separated. This parameter is only valid for HTTP and HTTPS monitors.","default":"200","example":"2xx"},"schemas-expiration":{"type":"string","description":"Sets the expiration time for a posture check result. If empty, the result remains valid until it is overwritten by new data from the WARP client.","example":"1h"},"schemas-expires_on":{"type":"string","format":"date-time","description":"When the invite is no longer active.","example":"2014-01-01T05:20:00Z","readOnly":true},"schemas-expression":{"type":"string","description":"The expression defining which traffic will match the rule.","example":"ip.src ne 1.1.1.1"},"schemas-features":{"type":"array","description":"Features enabled for the Cloudflare Tunnel.","items":{"type":"string","example":"ha-origin"}},"schemas-filter-response-collection":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"type":"object","properties":{"result":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/filter"},{"type":"object","required":["id","expression","paused"]}]}}}}]},"schemas-filter-response-single":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"type":"object","required":["result"],"properties":{"result":{"oneOf":[{"allOf":[{"$ref":"#/components/schemas/filter"},{"type":"object","required":["id","expression","paused"]}]},{"nullable":true}]}}}]},"schemas-filter_options":{"type":"array","description":"Format of additional configuration options (filters) for the alert type. Data type of filters during policy creation: Array of strings.","example":[{"ComparisonOperator":"==","Key":"zones","Optional":false},{"ComparisonOperator":">=","Key":"slo","Optional":true}],"items":{}},"schemas-filters":{"type":"array","description":"The protocol or layer to evaluate the traffic, identity, and device posture expressions.","example":["http"],"items":{"type":"string","description":"The protocol or layer to use.","enum":["http","dns","l4"],"example":"http"}},"schemas-force_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/schemas-force_result"}}}]},"schemas-force_result":{"type":"string","description":"When force_notify query parameter is set to true, the response is a simple string","example":"OK"},"schemas-frequency":{"type":"string","description":"The frequency at which you will be billed for this plan.","enum":["weekly","monthly","quarterly","yearly"],"example":"monthly","readOnly":true},"schemas-gateway_seat":{"type":"boolean","description":"True if the user has logged into the WARP client.","example":false},"schemas-group":{"allOf":[{"$ref":"#/components/schemas/group"},{"properties":{"allowed_modes":{"$ref":"#/components/schemas/allowed_modes"},"mode":{"$ref":"#/components/schemas/components-schemas-mode"}}}],"type":"object","required":["id","name","description","mode","rules_count"]},"schemas-groups":{"type":"object","properties":{"created_at":{"$ref":"#/components/schemas/timestamp"},"exclude":{"$ref":"#/components/schemas/exclude"},"id":{"$ref":"#/components/schemas/schemas-uuid"},"include":{"$ref":"#/components/schemas/include"},"name":{"$ref":"#/components/schemas/groups_components-schemas-name"},"require":{"$ref":"#/components/schemas/require"},"updated_at":{"$ref":"#/components/schemas/timestamp"}}},"schemas-header":{"type":"object","description":"The request header is used to pass additional information with an HTTP request. Currently supported header is 'Host'.","properties":{"Host":{"$ref":"#/components/schemas/Host"}}},"schemas-health_check":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Determines whether to run healthchecks for a tunnel.","default":true,"example":true},"target":{"type":"string","description":"The address used to run healthchecks for a tunnel.","example":"203.0.113.1"},"type":{"type":"string","description":"The type of healthcheck to run, reply or request. The default value is `reply`.","enum":["reply","request"],"default":"reply","example":"request"}}},"schemas-height":{"type":"number","description":"Maximum height in image pixels.","example":768,"minimum":1},"schemas-host":{"type":"string","format":"hostname","description":"The keyless SSL name.","example":"example.com","maxLength":253},"schemas-hostname":{"type":"string","description":"The hostname on the origin for which the client certificate uploaded will be used.","example":"app.example.com","maxLength":255},"schemas-hosts":{"type":"array","description":"Comma separated list of valid host names for the certificate packs. Must contain the zone apex, may not contain more than 50 hosts, and may not be empty.","example":["example.com","*.example.com","www.example.com"],"items":{"type":"string"}},"schemas-id":{"type":"string","description":"Identifier of a recommedation result.","example":"ssl_recommendation"},"schemas-id_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/dns-secondary-primary-zone_components-schemas-identifier"}}}}}]},"schemas-identifier":{},"schemas-include":{"type":"array","items":{"$ref":"#/components/schemas/split_tunnel_include"}},"schemas-input":{"type":"object","description":"The value to be checked against.","properties":{"id":{"$ref":"#/components/schemas/device-posture-rules_components-schemas-uuid"}}},"schemas-interval":{"type":"string","description":"The interval between each posture check with the third party API. Use \"m\" for minutes (e.g. \"5m\") and \"h\" for hours (e.g. \"12h\").","example":"10m"},"schemas-invite":{"allOf":[{"$ref":"#/components/schemas/user_invite"}],"type":"object"},"schemas-ip":{"type":"string","description":"An IPv4 or IPv6 address.","example":"192.0.2.1"},"schemas-ip_configuration":{"title":"An IP address configuration.","properties":{"target":{"description":"The configuration target. You must set the target to `ip` when specifying an IP address in the Zone Lockdown rule.","enum":["ip"],"example":"ip"},"value":{"type":"string","description":"The IP address to match. This address will be compared to the IP address of incoming requests.","example":"198.51.100.4"}}},"schemas-ips":{"type":"array","description":"The set of IPs on the Address Map.","items":{"$ref":"#/components/schemas/address-maps-ip"}},"schemas-ipv6":{"type":"string","format":"ipv6","example":"2001:0DB8::"},"schemas-items":{"type":"array","description":"The items in the List.","items":{"type":"object","properties":{"created_at":{"$ref":"#/components/schemas/timestamp"},"value":{"$ref":"#/components/schemas/lists_components-schemas-value"}}}},"schemas-key":{"type":"string","description":"The device's public key.","example":"yek0SUYoOQ10vMGsIYAevozXUQpQtNFJFfFGqER/BGc="},"schemas-key_response_collection":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"$ref":"#/components/schemas/keys_response"}}}]},"schemas-keys":{"type":"object","properties":{"name":{"$ref":"#/components/schemas/keys_components-schemas-name"},"value":{"$ref":"#/components/schemas/keys_components-schemas-value"}}},"schemas-kind":{"type":"string","description":"The kind of the ruleset.","enum":["custom","root","zone"],"example":"root"},"schemas-last_updated":{"type":"string","description":"The timestamp of when the rule was last modified.","example":"2000-01-01T00:00:00.000000Z"},"schemas-match":{"type":"array","description":"The conditions that the client must match to run the rule.","items":{"$ref":"#/components/schemas/match_item"}},"schemas-maxDurationSeconds":{"type":"integer","description":"Calculates the amount of time a video occupies before the video is uploaded. Direct uploads occupy minutes of videos on your Stream account until they are expired. After upload, the upload duration is used instead. If a video longer than the value is uploaded, the video results in an error.","minimum":1,"maximum":21600},"schemas-media_metadata":{"type":"object","description":"A user modifiable key-value store used to reference other systems of record for managing videos.","example":{"name":"example_filename.mp4"}},"schemas-member":{"allOf":[{"$ref":"#/components/schemas/member"}]},"schemas-metadata":{"type":"string","description":"What EXIF data should be preserved in the output image.","enum":["keep","copyright","none"],"example":"none"},"schemas-method":{"type":"string","description":"The method to use for the health check. This defaults to 'GET' for HTTP/HTTPS based checks and 'connection_established' for TCP based health checks.","default":"GET","example":"GET"},"schemas-mode":{"type":"string","description":"The action to apply to a matched request.","enum":["block","challenge","whitelist","js_challenge","managed_challenge"],"example":"challenge"},"schemas-modified":{"type":"string","format":"date-time","description":"The date and time the media item was last modified.","example":"2014-01-02T02:20:00Z","readOnly":true},"schemas-modified_on":{"type":"string","format":"date-time","description":"Last modification of DNS Firewall cluster.","example":"2014-01-01T05:20:00.12345Z","readOnly":true},"schemas-modified_tunnels_collection_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"properties":{"modified":{"type":"boolean","example":true},"modified_ipsec_tunnels":{"type":"array","items":{"$ref":"#/components/schemas/ipsec-tunnel"}}}}}}]},"schemas-monitor":{"description":"The ID of the Monitor to use for checking the health of origins within this pool."},"schemas-mtu":{"type":"integer","description":"The Maximum Transmission Unit (MTU) in bytes for the interconnect. The minimum value is 576.","default":1476},"schemas-name":{"type":"string","description":"Organization name.","example":"Cloudflare, Inc.","maxLength":100},"schemas-namespace":{"type":"object","properties":{"class":{"readOnly":true},"id":{"readOnly":true},"name":{"readOnly":true},"script":{"readOnly":true}}},"schemas-negative_cache_ttl":{"type":"number","description":"Negative DNS Cache TTL.","default":900,"example":900,"nullable":true,"minimum":30,"maximum":36000},"schemas-operation":{"type":"object","required":["id","status"],"properties":{"completed":{"type":"string","description":"The RFC 3339 timestamp of when the operation was completed.","example":"2020-01-01T08:00:00Z","readOnly":true},"error":{"type":"string","description":"A message describing the error when the status is `failed`.","example":"This list is at the maximum number of items","readOnly":true},"id":{"$ref":"#/components/schemas/schemas-operation_id"},"status":{"type":"string","description":"The current status of the asynchronous operation.","enum":["pending","running","completed","failed"],"example":"failed","readOnly":true}}},"schemas-operation_id":{"type":"string","description":"The unique operation ID of the asynchronous action.","example":"4da8780eeb215e6cb7f48dd981c4ea02","readOnly":true},"schemas-options":{"example":{"max_ttl":15,"packet_type":"icmp"},"properties":{"max_ttl":{"$ref":"#/components/schemas/max_ttl"},"packet_type":{"$ref":"#/components/schemas/packet_type"},"packets_per_ttl":{"$ref":"#/components/schemas/packets_per_ttl"},"port":{"$ref":"#/components/schemas/traceroute_components-schemas-port"},"wait_time":{"$ref":"#/components/schemas/wait_time"}}},"schemas-organization":{"type":"string","description":"Name of organization.","example":"Cloudflare, Inc."},"schemas-origin":{"type":"object","properties":{"address":{"$ref":"#/components/schemas/address"},"disabled_at":{"$ref":"#/components/schemas/disabled_at"},"enabled":{"$ref":"#/components/schemas/origin_components-schemas-enabled"},"header":{"$ref":"#/components/schemas/schemas-header"},"name":{"$ref":"#/components/schemas/origin_components-schemas-name"},"weight":{"$ref":"#/components/schemas/weight"}}},"schemas-output":{"properties":{"allowedOrigins":{"$ref":"#/components/schemas/allowedOrigins"},"clippedFromVideoUID":{"$ref":"#/components/schemas/clipped_from_video_uid"},"created":{"$ref":"#/components/schemas/clipping_components-schemas-created"},"creator":{"$ref":"#/components/schemas/creator"},"endTimeSeconds":{"$ref":"#/components/schemas/end_time_seconds"},"maxDurationSeconds":{"$ref":"#/components/schemas/schemas-maxDurationSeconds"},"meta":{"$ref":"#/components/schemas/schemas-media_metadata"},"modified":{"$ref":"#/components/schemas/components-schemas-modified"},"playback":{"$ref":"#/components/schemas/playback"},"preview":{"$ref":"#/components/schemas/preview"},"requireSignedURLs":{"$ref":"#/components/schemas/requireSignedURLs"},"startTimeSeconds":{"$ref":"#/components/schemas/start_time_seconds"},"status":{"$ref":"#/components/schemas/media_state"},"thumbnailTimestampPct":{"$ref":"#/components/schemas/thumbnailTimestampPct"},"watermark":{"$ref":"#/components/schemas/watermarkAtUpload"}}},"schemas-patch":{"type":"object","example":{"paused":true},"properties":{"paused":{"$ref":"#/components/schemas/paused"},"plan":{"type":"object","description":"(Deprecated) Please use the /zones/:identifier/subscription API to update a zone's plan.\nThe desired plan for the zone. Changing this value will create/cancel associated subscriptions. To view available plans for this zone, see Zone Plans.","properties":{"id":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}},"type":{"type":"string","description":"A full zone implies that DNS is hosted with Cloudflare. A partial zone is typically a partner-hosted zone or a CNAME setup. This parameter is only available to Enterprise customers or if it has been explicitly enabled on a zone.","enum":["full","partial"],"example":"full"},"vanity_name_servers":{"$ref":"#/components/schemas/vanity_name_servers"}}},"schemas-path":{"type":"string","description":"Sets the path within the host to enable the waiting room on. The waiting room will be enabled for all subpaths as well. If there are two waiting rooms on the same subpath, the waiting room for the most specific path will be chosen. Wildcards and query parameters are not supported.","default":"/","example":"/shop/checkout"},"schemas-pattern":{"type":"string","title":"Filter pattern","example":"example.net/*"},"schemas-paused":{"type":"boolean","description":"When true, indicates that the WAF package is currently paused."},"schemas-permissions":{"type":"array","description":"Access permissions for this User.","readOnly":true,"items":{"type":"string","example":"#zones:read","maxLength":160}},"schemas-phase":{"type":"string","description":"The phase where the ruleset is executed.","enum":["http_request_transform","http_request_late_transform","http_response_headers_transform"]},"schemas-policies":{"type":"object","properties":{"approval_groups":{"$ref":"#/components/schemas/approval_groups"},"approval_required":{"$ref":"#/components/schemas/approval_required"},"created_at":{"$ref":"#/components/schemas/timestamp"},"decision":{"$ref":"#/components/schemas/decision"},"exclude":{"$ref":"#/components/schemas/schemas-exclude"},"id":{"$ref":"#/components/schemas/components-schemas-uuid"},"include":{"$ref":"#/components/schemas/include"},"name":{"$ref":"#/components/schemas/policies_components-schemas-name"},"precedence":{"$ref":"#/components/schemas/precedence"},"purpose_justification_prompt":{"$ref":"#/components/schemas/purpose_justification_prompt"},"purpose_justification_required":{"$ref":"#/components/schemas/purpose_justification_required"},"require":{"$ref":"#/components/schemas/schemas-require"},"updated_at":{"$ref":"#/components/schemas/timestamp"}}},"schemas-port":{"type":"number","description":"The keyless SSL port used to commmunicate between Cloudflare and the client's Keyless SSL server.","default":24008,"example":24008,"maxLength":65535},"schemas-precedence":{"type":"integer","description":"Precedence sets the ordering of the rules. Lower values indicate higher precedence. At each processing phase, applicable rules are evaluated in ascending order of this value."},"schemas-preview_id":{"example":"p1aba936b94213e5b8dca0c0dbf1f9cc"},"schemas-preview_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"type":"object","properties":{"preview_url":{"$ref":"#/components/schemas/preview_url"}}}}}]},"schemas-price":{"type":"number","description":"The amount you will be billed for this plan.","example":0},"schemas-priority":{"type":"number","description":"The order/priority in which the certificate will be used in a request. The higher priority will break ties across overlapping 'legacy_custom' certificates, but 'legacy_custom' certificates will always supercede 'sni_custom' certificates.","default":20,"example":1},"schemas-private_key":{"type":"string","description":"The hostname certificate's private key.","example":"-----BEGIN RSA PRIVATE KEY-----\nMIIEowIBAAKCAQEAwQHoetcl9+5ikGzV6cMzWtWPJHqXT3wpbEkRU9Yz7lgvddmG\ndtcGbg/1CGZu0jJGkMoppoUo4c3dts3iwqRYmBikUP77wwY2QGmDZw2FvkJCJlKn\nabIRuGvBKwzESIXgKk2016aTP6/dAjEHyo6SeoK8lkIySUvK0fyOVlsiEsCmOpid\ntnKX/a+50GjB79CJH4ER2lLVZnhePFR/zUOyPxZQQ4naHf7yu/b5jhO0f8fwt+py\nFxIXjbEIdZliWRkRMtzrHOJIhrmJ2A1J7iOrirbbwillwjjNVUWPf3IJ3M12S9pE\newooaeO2izNTERcG9HzAacbVRn2Y2SWIyT/18QIDAQABAoIBACbhTYXBZYKmYPCb\nHBR1IBlCQA2nLGf0qRuJNJZg5iEzXows/6tc8YymZkQE7nolapWsQ+upk2y5Xdp/\naxiuprIs9JzkYK8Ox0r+dlwCG1kSW+UAbX0bQ/qUqlsTvU6muVuMP8vZYHxJ3wmb\n+ufRBKztPTQ/rYWaYQcgC0RWI20HTFBMxlTAyNxYNWzX7RKFkGVVyB9RsAtmcc8g\n+j4OdosbfNoJPS0HeIfNpAznDfHKdxDk2Yc1tV6RHBrC1ynyLE9+TaflIAdo2MVv\nKLMLq51GqYKtgJFIlBRPQqKoyXdz3fGvXrTkf/WY9QNq0J1Vk5ERePZ54mN8iZB7\n9lwy/AkCgYEA6FXzosxswaJ2wQLeoYc7ceaweX/SwTvxHgXzRyJIIT0eJWgx13Wo\n/WA3Iziimsjf6qE+SI/8laxPp2A86VMaIt3Z3mJN/CqSVGw8LK2AQst+OwdPyDMu\niacE8lj/IFGC8mwNUAb9CzGU3JpU4PxxGFjS/eMtGeRXCWkK4NE+G08CgYEA1Kp9\nN2JrVlqUz+gAX+LPmE9OEMAS9WQSQsfCHGogIFDGGcNf7+uwBM7GAaSJIP01zcoe\nVAgWdzXCv3FLhsaZoJ6RyLOLay5phbu1iaTr4UNYm5WtYTzMzqh8l1+MFFDl9xDB\nvULuCIIrglM5MeS/qnSg1uMoH2oVPj9TVst/ir8CgYEAxrI7Ws9Zc4Bt70N1As+U\nlySjaEVZCMkqvHJ6TCuVZFfQoE0r0whdLdRLU2PsLFP+q7qaeZQqgBaNSKeVcDYR\n9B+nY/jOmQoPewPVsp/vQTCnE/R81spu0mp0YI6cIheT1Z9zAy322svcc43JaWB7\nmEbeqyLOP4Z4qSOcmghZBSECgYACvR9Xs0DGn+wCsW4vze/2ei77MD4OQvepPIFX\ndFZtlBy5ADcgE9z0cuVB6CiL8DbdK5kwY9pGNr8HUCI03iHkW6Zs+0L0YmihfEVe\nPG19PSzK9CaDdhD9KFZSbLyVFmWfxOt50H7YRTTiPMgjyFpfi5j2q348yVT0tEQS\nfhRqaQKBgAcWPokmJ7EbYQGeMbS7HC8eWO/RyamlnSffdCdSc7ue3zdVJxpAkQ8W\nqu80pEIF6raIQfAf8MXiiZ7auFOSnHQTXUbhCpvDLKi0Mwq3G8Pl07l+2s6dQG6T\nlv6XTQaMyf6n1yjzL+fzDrH3qXMxHMO/b13EePXpDMpY7HQpoLDi\n-----END RSA PRIVATE KEY-----\n"},"schemas-proxied":{"type":"boolean","description":"Whether the hostname should be gray clouded (false) or orange clouded (true).","default":false,"example":true},"schemas-query":{"allOf":[{"$ref":"#/components/schemas/query"},{"properties":{"dimensions":{"example":["accountId","responseCode"],"items":{"enum":["accountId","responseCode","requestType"]}},"filters":{"example":"requestType==read AND responseCode!=200"},"metrics":{"default":"[\"requests\"]","example":["requests","readKiB"],"items":{"enum":["requests","writeKiB","readKiB"]}},"sort":{"example":["+requests","-responseCode"]}}}]},"schemas-railgun":{"type":"object","required":["id","name","status","enabled","zones_connected","activation"],"properties":{"activation":{"$ref":"#/components/schemas/activation"},"created_on":{"$ref":"#/components/schemas/railgun_components-schemas-created_on"},"enabled":{"$ref":"#/components/schemas/railgun_components-schemas-enabled"},"id":{"$ref":"#/components/schemas/railgun_components-schemas-identifier"},"modified_on":{"$ref":"#/components/schemas/railgun_components-schemas-modified_on"},"name":{"$ref":"#/components/schemas/railgun_components-schemas-name"},"status":{"$ref":"#/components/schemas/railgun_components-schemas-status"},"upgrade_info":{"$ref":"#/components/schemas/upgrade_info"},"zones_connected":{"$ref":"#/components/schemas/zones_connected"}}},"schemas-railgun_response_collection":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"type":"array","items":{"type":"object"}}}}]},"schemas-rate-plan":{"allOf":[{"$ref":"#/components/schemas/rate-plan"}],"type":"object"},"schemas-ratelimit":{"type":"number","description":"Ratelimit in queries per second per datacenter (applies to DNS queries sent to the origin nameservers configured on the cluster).\nNotes: A ratelimit of 0 turns off the ratelimit. Otherwise the minimum is 100.","example":600,"maximum":"1e+08"},"schemas-ref":{"type":"string","description":"A short reference tag. Allows you to select related filters.","example":"FIL-100","maxLength":50},"schemas-references_response":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"type":"array","description":"List of resources that reference a given pool.","example":[{"reference_type":"referrer","resource_id":"699d98642c564d2e855e9661899b7252","resource_name":"www.example.com","resource_type":"load_balancer"},{"reference_type":"referral","resource_id":"f1aba936b94213e5b8dca0c0dbf1f9cc","resource_name":"Login page monitor","resource_type":"monitor"}],"items":{"type":"object","properties":{"reference_type":{"type":"string","enum":["*","referral","referrer"]},"resource_id":{"type":"string"},"resource_name":{"type":"string"},"resource_type":{"type":"string"}}}}}}]},"schemas-request_model":{"type":"object","properties":{"scope":{"$ref":"#/components/schemas/scope"},"type":{"$ref":"#/components/schemas/url_normalization_components-schemas-type"}}},"schemas-requests":{"type":"object","description":"Breakdown of totals for requests.","properties":{"all":{"type":"integer","description":"Total number of requests served."},"cached":{"type":"integer","description":"Total number of cached requests served."},"content_type":{"type":"object","description":"A variable list of key/value pairs where the key represents the type of content served, and the value is the number of requests.","example":{"css":15343,"gif":23178,"html":1234213.0,"javascript":318236,"jpeg":1982048.0}},"country":{"type":"object","description":"A variable list of key/value pairs where the key is a two-digit country code and the value is the number of requests served to that country.","example":{"AG":37298,"GI":293846,"US":4181364.0}},"http_status":{"type":"object","description":"Key/value pairs where the key is a HTTP status code and the value is the number of requests served with that code.","example":{"200":13496983.0,"301":283,"400":187936,"402":1828,"404":1293}},"ssl":{"type":"object","description":"A break down of requests served over HTTPS.","properties":{"encrypted":{"type":"integer","description":"The number of requests served over HTTPS."},"unencrypted":{"type":"integer","description":"The number of requests served over HTTP."}}},"ssl_protocols":{"type":"object","description":"A breakdown of requests by their SSL protocol.","properties":{"TLSv1":{"type":"integer","description":"The number of requests served over TLS v1.0."},"TLSv1.1":{"type":"integer","description":"The number of requests served over TLS v1.1."},"TLSv1.2":{"type":"integer","description":"The number of requests served over TLS v1.2."},"TLSv1.3":{"type":"integer","description":"The number of requests served over TLS v1.3."},"none":{"type":"integer","description":"The number of requests served over HTTP."}}},"uncached":{"type":"integer","description":"Total number of requests served from the origin."}}},"schemas-require":{"type":"array","description":"Rules evaluated with an AND logical operator. To match the policy, a user must meet all of the Require rules.","items":{"$ref":"#/components/schemas/rule_components-schemas-rule"}},"schemas-requireSignedURLs":{"type":"boolean","description":"Indicates whether the image can be a accessed only using it's UID. If set to true, a signed token needs to be generated with a signing key to view the image.","default":false,"example":true},"schemas-response":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/ip_components-schemas-ip"}}}}]},"schemas-response_collection":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"type":"object","properties":{"result":{"type":"array","example":[{"id":"7cf72faf220841aabcfdfab81c43c4f6","name":"Billing Read","scopes":["com.cloudflare.api.account"]},{"id":"9d24387c6e8544e2bc4024a03991339f","name":"Load Balancing: Monitors and Pools Read","scopes":["com.cloudflare.api.account"]},{"id":"d2a1802cc9a34e30852f8b33869b2f3c","name":"Load Balancing: Monitors and Pools Write","scopes":["com.cloudflare.api.account"]},{"id":"8b47d2786a534c08a1f94ee8f9f599ef","name":"Workers KV Storage Read","scopes":["com.cloudflare.api.account"]},{"id":"f7f0eda5697f475c90846e879bab8666","name":"Workers KV Storage Write","scopes":["com.cloudflare.api.account"]},{"id":"1a71c399035b4950a1bd1466bbe4f420","name":"Workers Scripts Read","scopes":["com.cloudflare.api.account"]},{"id":"e086da7e2179491d91ee5f35b3ca210a","name":"Workers Scripts Write","scopes":["com.cloudflare.api.account"]}],"items":{"type":"object"}}}}]},"schemas-response_model":{"type":"object","properties":{"scope":{"$ref":"#/components/schemas/scope"},"type":{"$ref":"#/components/schemas/url_normalization_components-schemas-type"}}},"schemas-response_single":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"type":"object","properties":{"result":{"type":"object"}}}]},"schemas-result":{"type":"object","description":"Metrics on Workers KV requests.","required":["rows","data","data_lag","min","max","totals","query"],"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["metrics"],"properties":{"metrics":{"type":"array","description":"List of metrics returned by the query.","items":{}}}}},"data_lag":{"type":"number","description":"Number of seconds between current time and last processed event, i.e. how many seconds of data could be missing.","example":0,"minimum":0},"max":{"description":"Maximum results for each metric."},"min":{"description":"Minimum results for each metric."},"query":{"$ref":"#/components/schemas/query"},"rows":{"type":"number","description":"Total number of rows in the result.","example":2,"minimum":0},"totals":{"description":"Total results for metrics across all data."}}},"schemas-role":{"type":"object","required":["id","name","description","permissions"],"properties":{"description":{"$ref":"#/components/schemas/description"},"id":{"$ref":"#/components/schemas/role_components-schemas-identifier"},"name":{"$ref":"#/components/schemas/components-schemas-name"},"permissions":{"$ref":"#/components/schemas/schemas-permissions"}}},"schemas-route":{"type":"object","required":["prefix","nexthop","priority"],"properties":{"created_on":{"$ref":"#/components/schemas/route_components-schemas-created_on"},"description":{"$ref":"#/components/schemas/route_components-schemas-description"},"id":{"$ref":"#/components/schemas/route_components-schemas-identifier"},"modified_on":{"$ref":"#/components/schemas/route_components-schemas-modified_on"},"nexthop":{"$ref":"#/components/schemas/nexthop"},"prefix":{"$ref":"#/components/schemas/prefix"},"priority":{"$ref":"#/components/schemas/route_components-schemas-priority"},"scope":{"$ref":"#/components/schemas/schemas-scope"},"weight":{"$ref":"#/components/schemas/schemas-weight"}}},"schemas-rule":{"allOf":[{"$ref":"#/components/schemas/rule"},{"properties":{"scope":{"type":"object","description":"All zones owned by the user will have the rule applied.","readOnly":true,"properties":{"email":{"$ref":"#/components/schemas/email"},"id":{"$ref":"#/components/schemas/common_components-schemas-identifier"},"type":{"description":"The scope of the rule.","enum":["user","organization"],"example":"user","readOnly":true}}}}}],"type":"object","required":["id","mode","allowed_modes","configuration","scope"]},"schemas-rule_identifier":{"example":"2890e6fa406311ed9b5a23f70f6fb8cf"},"schemas-rules":{"type":"object","description":"An object that allows you to override the action of specific WAF rules. Each key of this object must be the ID of a WAF rule, and each value must be a valid WAF action. Unless you are disabling a rule, ensure that you also enable the rule group that this WAF rule belongs to. When creating a new URI-based WAF override, you must provide a `groups` object or a `rules` object.","example":{"100015":"disable"}},"schemas-rules_response_collection":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/rule_result"}}}}]},"schemas-ruleset":{"properties":{"description":{"example":""},"id":{"example":"2f2feab2026849078ba485f918791bdc"},"kind":{"example":"zone"},"name":{"example":"default"},"phase":{"example":"http_request_transform"},"rules":{"type":"array","description":"The rules in the ruleset.","items":{"$ref":"#/components/schemas/transform-rules_components-schemas-rule"}}}},"schemas-scope":{"type":"object","description":"Used only for ECMP routes.","properties":{"colo_names":{"$ref":"#/components/schemas/colo_names"},"colo_regions":{"$ref":"#/components/schemas/colo_regions"}}},"schemas-script_name":{"type":"string","description":"Name of the script to apply when the route is matched. The route is skipped when this is blank/missing.","example":"this-is_my_script-01","pattern":"^[a-z0-9_][a-z0-9-_]*$"},"schemas-secret":{"type":"string","description":"Optional secret that will be passed in the `cf-webhook-auth` header when dispatching a webhook notification. Secrets are not returned in any API response body."},"schemas-serial_number":{"type":"string","description":"The device serial number.","example":"EXAMPLEHMD6R"},"schemas-session_duration":{"type":"integer","description":"Lifetime of a cookie (in minutes) set by Cloudflare for users who get access to the route. If a user is not seen by Cloudflare again in that time period, they will be treated as a new user that visits the route.","default":5,"minimum":1,"maximum":30},"schemas-signature":{"type":"string","description":"Certificate's signature algorithm.","enum":["ECDSAWithSHA256","SHA1WithRSA","SHA256WithRSA"]},"schemas-single_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"errors":{"type":"array","items":{}},"messages":{"type":"array","items":{}},"result":{"$ref":"#/components/schemas/api-shield"}}}]},"schemas-size":{"type":"number","description":"The size of the image in bytes.","example":29472,"readOnly":true},"schemas-ssl":{"oneOf":[{"type":"object","properties":{"bundle_method":{"type":"string","description":"A ubiquitous bundle has the highest probability of being verified everywhere, even by clients using outdated or unusual trust stores. An optimal bundle uses the shortest chain and newest intermediates. And the force bundle verifies the chain, but does not otherwise modify it.","enum":["ubiquitous","optimal","force"],"default":"ubiquitous","example":"ubiquitous"},"certificate_authority":{"type":"string","description":"The Certificate Authority that has issued this certificate.","enum":["digicert","google","lets_encrypt"],"example":"digicert"},"custom_certificate":{"type":"string","description":"If a custom uploaded certificate is used.","example":"-----BEGIN CERTIFICATE-----\\nMIIFJDCCBAygAwIBAgIQD0ifmj/Yi5NP/2gdUySbfzANBgkqhkiG9w0BAQsFADBN\\nMQswCQYDVQQGEwJVUzEVMBMGA1UEChMMRGlnaUNlcnQgSW5jMScwJQYDVQQDEx5E...SzSHfXp5lnu/3V08I72q1QNzOCgY1XeL4GKVcj4or6cT6tX6oJH7ePPmfrBfqI/O\\nOeH8gMJ+FuwtXYEPa4hBf38M5eU5xWG7\\n-----END CERTIFICATE-----\\n"},"custom_csr_id":{"type":"string","description":"The identifier for the Custom CSR that was used.","example":"7b163417-1d2b-4c84-a38a-2fb7a0cd7752"},"custom_key":{"type":"string","description":"The key for a custom uploaded certificate.","example":"-----BEGIN RSA PRIVATE KEY-----\nMIIEowIBAAKCAQEAwQHoetcl9+5ikGzV6cMzWtWPJHqXT3wpbEkRU9Yz7lgvddmG\ndtcGbg/1CGZu0jJGkMoppoUo4c3dts3iwqRYmBikUP77wwY2QGmDZw2FvkJCJlKn\nabIRuGvBKwzESIXgKk2016aTP6/dAjEHyo6SeoK8lkIySUvK0fyOVlsiEsCmOpid\ntnKX/a+50GjB79CJH4ER2lLVZnhePFR/zUOyPxZQQ4naHf7yu/b5jhO0f8fwt+py\nFxIXjbEIdZliWRkRMtzrHOJIhrmJ2A1J7iOrirbbwillwjjNVUWPf3IJ3M12S9pE\newooaeO2izNTERcG9HzAacbVRn2Y2SWIyT/18QIDAQABAoIBACbhTYXBZYKmYPCb\nHBR1IBlCQA2nLGf0qRuJNJZg5iEzXows/6tc8YymZkQE7nolapWsQ+upk2y5Xdp/\naxiuprIs9JzkYK8Ox0r+dlwCG1kSW+UAbX0bQ/qUqlsTvU6muVuMP8vZYHxJ3wmb\n+ufRBKztPTQ/rYWaYQcgC0RWI20HTFBMxlTAyNxYNWzX7RKFkGVVyB9RsAtmcc8g\n+j4OdosbfNoJPS0HeIfNpAznDfHKdxDk2Yc1tV6RHBrC1ynyLE9+TaflIAdo2MVv\nKLMLq51GqYKtgJFIlBRPQqKoyXdz3fGvXrTkf/WY9QNq0J1Vk5ERePZ54mN8iZB7\n9lwy/AkCgYEA6FXzosxswaJ2wQLeoYc7ceaweX/SwTvxHgXzRyJIIT0eJWgx13Wo\n/WA3Iziimsjf6qE+SI/8laxPp2A86VMaIt3Z3mJN/CqSVGw8LK2AQst+OwdPyDMu\niacE8lj/IFGC8mwNUAb9CzGU3JpU4PxxGFjS/eMtGeRXCWkK4NE+G08CgYEA1Kp9\nN2JrVlqUz+gAX+LPmE9OEMAS9WQSQsfCHGogIFDGGcNf7+uwBM7GAaSJIP01zcoe\nVAgWdzXCv3FLhsaZoJ6RyLOLay5phbu1iaTr4UNYm5WtYTzMzqh8l1+MFFDl9xDB\nvULuCIIrglM5MeS/qnSg1uMoH2oVPj9TVst/ir8CgYEAxrI7Ws9Zc4Bt70N1As+U\nlySjaEVZCMkqvHJ6TCuVZFfQoE0r0whdLdRLU2PsLFP+q7qaeZQqgBaNSKeVcDYR\n9B+nY/jOmQoPewPVsp/vQTCnE/R81spu0mp0YI6cIheT1Z9zAy322svcc43JaWB7\nmEbeqyLOP4Z4qSOcmghZBSECgYACvR9Xs0DGn+wCsW4vze/2ei77MD4OQvepPIFX\ndFZtlBy5ADcgE9z0cuVB6CiL8DbdK5kwY9pGNr8HUCI03iHkW6Zs+0L0YmihfEVe\nPG19PSzK9CaDdhD9KFZSbLyVFmWfxOt50H7YRTTiPMgjyFpfi5j2q348yVT0tEQS\nfhRqaQKBgAcWPokmJ7EbYQGeMbS7HC8eWO/RyamlnSffdCdSc7ue3zdVJxpAkQ8W\nqu80pEIF6raIQfAf8MXiiZ7auFOSnHQTXUbhCpvDLKi0Mwq3G8Pl07l+2s6dQG6T\nlv6XTQaMyf6n1yjzL+fzDrH3qXMxHMO/b13EePXpDMpY7HQpoLDi\n-----END RSA PRIVATE KEY-----\n"},"expires_on":{"type":"string","format":"date-time","description":"The time the custom certificate expires on.","example":"2021-02-06T18:11:23.531995Z"},"hosts":{"type":"array","description":"A list of Hostnames on a custom uploaded certificate.","example":["app.example.com","*.app.example.com"],"items":{}},"id":{"type":"string","description":"Custom hostname SSL identifier tag.","example":"0d89c70d-ad9f-4843-b99f-6cc0252067e9","minLength":36,"maxLength":36},"issuer":{"type":"string","description":"The issuer on a custom uploaded certificate.","example":"DigiCertInc"},"method":{"description":"Domain control validation (DCV) method used for this hostname.","enum":["http","txt","email"],"example":"txt"},"serial_number":{"type":"string","description":"The serial number on a custom uploaded certificate.","example":"6743787633689793699141714808227354901"},"settings":{"$ref":"#/components/schemas/sslsettings"},"signature":{"type":"string","description":"The signature on a custom uploaded certificate.","example":"SHA256WithRSA"},"status":{"description":"Status of the hostname's SSL certificates.","enum":["initializing","pending_validation","deleted","pending_issuance","pending_deployment","pending_deletion","pending_expiration","expired","active","initializing_timed_out","validation_timed_out","issuance_timed_out","deployment_timed_out","deletion_timed_out","pending_cleanup","staging_deployment","staging_active","deactivating","inactive","backup_issued","holding_deployment"],"example":"pending_validation","readOnly":true},"type":{"description":"Level of validation to be used for this hostname. Domain validation (dv) must be used.","enum":["dv"],"example":"dv","readOnly":true},"uploaded_on":{"type":"string","format":"date-time","description":"The time the custom certificate was uploaded.","example":"2020-02-06T18:11:23.531995Z"},"validation_errors":{"type":"array","description":"Domain validation errors that have been received by the certificate authority (CA).","items":{"type":"object","properties":{"message":{"type":"string","description":"A domain validation error.","example":"SERVFAIL looking up CAA for app.example.com"}}}},"validation_records":{"type":"array","items":{"$ref":"#/components/schemas/validation_record"}},"wildcard":{"type":"boolean","description":"Indicates whether the certificate covers a wildcard.","example":false}}}],"type":"object","description":"SSL properties for the custom hostname."},"schemas-state":{"type":"string","description":"The custom page state.","enum":["default","customized"],"example":"default"},"schemas-status":{"type":"string","description":"Status of this membership.","enum":["accepted","pending","rejected"],"example":"accepted"},"schemas-subdomain":{"type":"string","description":"The subdomain to be used as the destination in the proxy client.","example":"oli3n9zkz5.proxy.cloudflare-gateway.com"},"schemas-suspended":{"type":"boolean","description":"Suspends or allows traffic going to the waiting room. If set to `true`, the traffic will not go to the waiting room.","default":false},"schemas-target":{"type":"string","description":"The target hostname, IPv6, or IPv6 address.","example":"1.1.1.1"},"schemas-targets":{"type":"array","example":["203.0.113.1","cloudflare.com"],"maxLength":10,"items":{"type":"string","description":"Hosts as a hostname or IPv4/IPv6 address represented by strings.","example":"203.0.113.1"}},"schemas-thumbnail_url":{"type":"string","format":"uri","description":"URI to thumbnail variant for an image.","example":"https://imagedelivery.net/MTt4OTd0b0w5aj/107b9558-dd06-4bbd-5fef-9c2c16bb7900/thumbnail","readOnly":true},"schemas-timeout":{"type":"integer","description":"The timeout (in seconds) before marking the health check as failed.","default":5},"schemas-token":{"allOf":[{"$ref":"#/components/schemas/token"}]},"schemas-ttl":{"type":"number","description":"Time to live (TTL) of the DNS entry for the IP address returned by this load balancer. This only applies to gray-clouded (unproxied) load balancers.","example":30},"schemas-tunnel_add_single_request":{"type":"object","required":["name","cloudflare_endpoint","interface_address"],"properties":{"cloudflare_endpoint":{"$ref":"#/components/schemas/cloudflare_ipsec_endpoint"},"customer_endpoint":{"$ref":"#/components/schemas/customer_ipsec_endpoint"},"description":{"$ref":"#/components/schemas/ipsec-tunnel_components-schemas-description"},"interface_address":{"$ref":"#/components/schemas/interface_address"},"name":{"$ref":"#/components/schemas/ipsec-tunnel_components-schemas-name"},"psk":{"$ref":"#/components/schemas/psk"}}},"schemas-tunnel_deleted_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"properties":{"deleted":{"type":"boolean","example":true},"deleted_ipsec_tunnel":{"type":"object"}}}}}]},"schemas-tunnel_id":{"description":"UUID of the Cloudflare Tunnel serving the route."},"schemas-tunnel_modified_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"properties":{"modified":{"type":"boolean","example":true},"modified_ipsec_tunnel":{"type":"object"}}}}}]},"schemas-tunnel_name":{"description":"The user-friendly name of the Cloudflare Tunnel serving the route."},"schemas-tunnel_response_collection":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"type":"object","properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/tunnel"}}}}]},"schemas-tunnel_response_single":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"type":"object","properties":{"result":{"$ref":"#/components/schemas/tunnel"}}}]},"schemas-tunnel_single_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"properties":{"ipsec_tunnel":{"type":"object"}}}}}]},"schemas-tunnel_update_request":{"allOf":[{"$ref":"#/components/schemas/schemas-tunnel_add_single_request"}]},"schemas-tunnels_collection_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"properties":{"ipsec_tunnels":{"type":"array","items":{"$ref":"#/components/schemas/ipsec-tunnel"}}}}}}]},"schemas-type":{"type":"string","description":"The type of characteristic.","enum":["header","cookie"],"example":"header"},"schemas-updated_at":{"type":"string","description":"The timestamp of when Page Shield was last updated.","example":"2022-10-12T17:56:52.083582+01:00"},"schemas-uploaded":{"type":"string","format":"date-time","description":"When the media item was uploaded.","example":"2014-01-02T02:20:00Z","readOnly":true},"schemas-uploaded_on":{"type":"string","format":"date-time","description":"This is the time the certificate was uploaded.","example":"2019-10-28T18:11:23.37411Z"},"schemas-url":{"type":"string","description":"The URL pattern to match, composed of a host and a path such as `example.org/path*`. Normalization is applied before the pattern is matched. `*` wildcards are expanded to match applicable traffic. Query strings are not matched. Set the value to `*` to match all traffic to your zone.","example":"*.example.org/path*","maxLength":1024},"schemas-urls":{"type":"array","description":"The URLs to include in the rule definition. You can use wildcards. Each entered URL will be escaped before use, which means you can only use simple wildcard patterns.","items":{"type":"string","example":"api.mysite.com/some/endpoint*"}},"schemas-uuid":{"description":"The unique identifier for the Access group."},"schemas-validate_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"properties":{"valid":{"type":"boolean","example":true}}}}}]},"schemas-validation_method":{"type":"string","description":"Validation method in use for a certificate pack order.","enum":["http","cname","txt"],"example":"txt"},"schemas-validity_days":{"type":"integer","description":"The validity period in days for the certificates ordered via Total TLS.","enum":[90]},"schemas-value":{"type":"string","description":"Enables Argo Smart Routing.","enum":["on","off"],"example":"on"},"schemas-variants":{"type":"array","description":"Object specifying available variants for an image.","example":["https://imagedelivery.net/MTt4OTd0b0w5aj/107b9558-dd06-4bbd-5fef-9c2c16bb7900/thumbnail","https://imagedelivery.net/MTt4OTd0b0w5aj/107b9558-dd06-4bbd-5fef-9c2c16bb7900/hero","https://imagedelivery.net/MTt4OTd0b0w5aj/107b9558-dd06-4bbd-5fef-9c2c16bb7900/original"],"readOnly":true,"items":{"anyOf":[{"$ref":"#/components/schemas/schemas-thumbnail_url"},{"$ref":"#/components/schemas/hero_url"},{"$ref":"#/components/schemas/original_url"}]}},"schemas-version":{"type":"string","description":"The version of the rule.","example":"1","pattern":"^[0-9]+$"},"schemas-video_identifier":{"type":"string","description":"A unique identifier for the media file.","example":"ea95132c15732412d22c1476fa83f27a","readOnly":true,"maxLength":32},"schemas-virtual-dns":{"allOf":[{"$ref":"#/components/schemas/virtual-dns"}],"type":"object"},"schemas-weight":{"type":"integer","description":"Optional weight of the ECMP scope - if provided."},"schemas-width":{"type":"number","description":"Maximum width in image pixels.","example":1366,"minimum":1},"schemas-zone":{"type":"object","properties":{"name":{"readOnly":true}}},"schemes":{"type":"array","description":"The HTTP schemes to match. You can specify one scheme (`['HTTPS']`), both schemes (`['HTTP','HTTPS']`), or all schemes (`['_ALL_']`). This field is optional.","example":["HTTP","HTTPS"],"items":{"type":"string","description":"An HTTP scheme or `_ALL_` to indicate all schemes.","example":"HTTPS"}},"scope":{"type":"string","description":"The scope of the URL normalization.","example":"incoming"},"script":{"properties":{"added_at":{"example":"2021-08-18T10:51:10.09615Z"},"domain_reported_malicious":{"example":false},"fetched_at":{"example":"2021-09-02T10:17:54Z"},"first_page_url":{"example":"blog.cloudflare.com/page"},"first_seen_at":{"example":"2021-08-18T10:51:08Z"},"hash":{"example":"e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855"},"host":{"example":"blog.cloudflare.com"},"id":{"example":"c9ef84a6bf5e47138c75d95e2f933e8f"},"js_integrity_score":{"example":10},"last_seen_at":{"example":"2021-09-02T09:57:54Z"},"page_urls":{"example":["blog.cloudflare.com/page1","blog.cloudflare.com/page2"]},"url":{"example":"https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/4.6.0/js/bootstrap.min.js"},"url_contains_cdn_cgi_path":{"example":false}}},"script-monitor_components-schemas-enabled":{"type":"boolean","description":"When true, indicates that Page Shield is enabled.","example":true},"script-monitor_components-schemas-id":{"type":"string","description":"The ID of the resource.","example":"c9ef84a6bf5e47138c75d95e2f933e8f","minLength":32,"maxLength":32},"script-response-collection":{"allOf":[{"$ref":"#/components/schemas/api-response-common"},{"properties":{"result":{"type":"array","items":{"properties":{"created_on":{"readOnly":true},"etag":{"readOnly":true},"id":{"readOnly":true},"modified_on":{"readOnly":true},"usage_model":{"readOnly":true}}}}}}]},"script-response-single":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"type":"object"}}}]},"script_identifier":{"type":"string","example":"8ee82b3a2c0f42928b8f14dae4a97121","readOnly":true,"maxLength":32},"script_name":{"type":"string","description":"Name of the script, used in URLs and route configuration.","example":"this-is_my_script-01","pattern":"^[a-z0-9_][a-z0-9-_]*$"},"search":{"type":"object","properties":{"resources":{"type":"array","description":"A list of resources matching the search query.","items":{"$ref":"#/components/schemas/resource_reference"}}}},"search_result":{"type":"object","properties":{"result":{"$ref":"#/components/schemas/search"}}},"seat":{"type":"object","required":["seat_uid","gateway_seat","access_seat"],"properties":{"access_seat":{"$ref":"#/components/schemas/access_seat"},"gateway_seat":{"$ref":"#/components/schemas/gateway_seat"},"seat_uid":{"$ref":"#/components/schemas/seat_uid"}}},"seat_uid":{"description":"The unique API identifier for the Zero Trust seat."},"seats":{"type":"object","properties":{"access_seat":{"$ref":"#/components/schemas/access_seat"},"created_at":{"$ref":"#/components/schemas/timestamp"},"gateway_seat":{"$ref":"#/components/schemas/gateway_seat"},"seat_uid":{"$ref":"#/components/schemas/seat_uid"},"updated_at":{"$ref":"#/components/schemas/timestamp"}}},"seats_components-schemas-identifier":{"example":"699d98642c564d2e855e9661899b7252"},"seats_components-schemas-response_collection":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/seats"}}}}]},"seats_definition":{"type":"array","items":{"$ref":"#/components/schemas/seat"},"required":["seat_uid","gateway_seat","access_seat"]},"secret":{"type":"string","description":"TSIG secret.","example":"caf79a7804b04337c9c66ccd7bef9190a1e1679b5dd03d8aa10f7ad45e1a9dab92b417896c15d4d007c7c14194538d2a5d0feffdecc5a7f0e1c570cfa700837c"},"security_header":{"allOf":[{"$ref":"#/components/schemas/schemas-base"},{"properties":{"id":{"description":"ID of the zone's security header.","enum":["security_header"],"example":"security_header"},"value":{"$ref":"#/components/schemas/security_header_value"}}}],"title":"Security Header","description":"Cloudflare security header for a zone."},"security_header_value":{"type":"object","properties":{"strict_transport_security":{"type":"object","description":"Strict Transport Security.","properties":{"enabled":{"type":"boolean","description":"Whether or not strict transport security is enabled.","example":true},"include_subdomains":{"type":"boolean","description":"Include all subdomains for strict transport security.","example":true},"max_age":{"type":"number","description":"Max age in seconds of the strict transport security.","example":86400},"nosniff":{"type":"boolean","description":"Whether or not to include 'X-Content-Type-Options: nosniff' header.","example":true}}}}},"security_level":{"allOf":[{"$ref":"#/components/schemas/schemas-base"},{"properties":{"id":{"description":"ID of the zone setting.","enum":["security_level"],"example":"security_level"},"value":{"$ref":"#/components/schemas/security_level_value"}}}],"title":"Security Level","description":"Choose the appropriate security profile for your website, which will automatically adjust each of the security settings. If you choose to customize an individual security setting, the profile will become Custom. (https://support.cloudflare.com/hc/en-us/articles/200170056)."},"security_level_value":{"type":"string","description":"Value of the zone setting.","enum":["off","essentially_off","low","medium","high","under_attack"],"default":"medium"},"self_hosted_props":{"type":"object","title":"Self Hosted Application","properties":{"allowed_idps":{"$ref":"#/components/schemas/allowed_idps"},"app_launcher_visible":{"$ref":"#/components/schemas/app_launcher_visible"},"auto_redirect_to_identity":{"$ref":"#/components/schemas/auto_redirect_to_identity"},"cors_headers":{"$ref":"#/components/schemas/cors_headers"},"custom_deny_message":{"$ref":"#/components/schemas/custom_deny_message"},"custom_deny_url":{"$ref":"#/components/schemas/custom_deny_url"},"domain":{"$ref":"#/components/schemas/schemas-domain"},"enable_binding_cookie":{"$ref":"#/components/schemas/enable_binding_cookie"},"http_only_cookie_attribute":{"$ref":"#/components/schemas/http_only_cookie_attribute"},"logo_url":{"$ref":"#/components/schemas/logo_url"},"name":{"$ref":"#/components/schemas/apps_components-schemas-name"},"same_site_cookie_attribute":{"$ref":"#/components/schemas/same_site_cookie_attribute"},"service_auth_401_redirect":{"$ref":"#/components/schemas/service_auth_401_redirect"},"session_duration":{"$ref":"#/components/schemas/session_duration"},"skip_interstitial":{"$ref":"#/components/schemas/skip_interstitial"},"type":{"type":"string","description":"The application type.","example":"self_hosted"}}},"sensitivity":{"type":"string","description":"The sensitivity of the WAF package.","enum":["high","medium","low","off"],"default":"high"},"sent":{"type":"string","format":"date-time","description":"Timestamp of when the notification was dispatched in ISO 8601 format.","example":"2021-10-08T17:52:17.571336Z"},"serial_number":{"type":"string","description":"The serial number on the uploaded certificate.","example":"6743787633689793699141714808227354901"},"server_side_exclude":{"allOf":[{"$ref":"#/components/schemas/schemas-base"},{"properties":{"id":{"description":"ID of the zone setting.","enum":["server_side_exclude"],"example":"server_side_exclude"},"value":{"$ref":"#/components/schemas/server_side_exclude_value"}}}],"title":"Server Side Exclude","description":"If there is sensitive content on your website that you want visible to real visitors, but that you want to hide from suspicious visitors, all you have to do is wrap the content with Cloudflare SSE tags. Wrap any content that you want to be excluded from suspicious visitors in the following SSE tags: <!--sse--><!--/sse-->. For example: <!--sse--> Bad visitors won't see my phone number, 555-555-5555 <!--/sse-->. Note: SSE only will work with HTML. If you have HTML minification enabled, you won't see the SSE tags in your HTML source when it's served through Cloudflare. SSE will still function in this case, as Cloudflare's HTML minification and SSE functionality occur on-the-fly as the resource moves through our network to the visitor's computer. (https://support.cloudflare.com/hc/en-us/articles/200170036)."},"server_side_exclude_value":{"type":"string","description":"Value of the zone setting.","enum":["on","off"],"default":"on"},"service":{"type":"string","description":"Worker service associated with the zone and hostname.","example":"foo"},"service-tokens":{"type":"object","properties":{"client_id":{"$ref":"#/components/schemas/client_id"},"created_at":{"$ref":"#/components/schemas/timestamp"},"id":{"description":"The ID of the service token."},"name":{"$ref":"#/components/schemas/service-tokens_components-schemas-name"},"updated_at":{"$ref":"#/components/schemas/timestamp"}}},"service-tokens_components-schemas-name":{"type":"string","description":"The name of the service token.","example":"CI/CD token"},"service-tokens_components-schemas-response_collection":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/service-tokens"}}}}]},"service-tokens_components-schemas-single_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/service-tokens"}}}]},"service_auth_401_redirect":{"type":"boolean","description":"Returns a 401 status code when the request is blocked by a Service Auth policy.","example":true},"service_mode_v2":{"type":"object","properties":{"mode":{"type":"string","description":"The mode to run the WARP client under.","example":"proxy"},"port":{"type":"number","description":"The port number when used with proxy mode.","example":3000}}},"session_affinity":{"type":"string","description":"The session_affinity specifies the type of session affinity the load balancer should use unless specified as \"none\" or \"\"(default). The supported types are \"cookie\" and \"ip_cookie\". \"cookie\" - On the first request to a proxied load balancer, a cookie is generated, encoding information of which origin the request will be forwarded to. Subsequent requests, by the same client to the same load balancer, will be sent to the origin server the cookie encodes, for the duration of the cookie and as long as the origin server remains healthy. If the cookie has expired or the origin server is unhealthy then a new origin server is calculated and used. \"ip_cookie\" behaves the same as \"cookie\" except the initial origin selection is stable and based on the client’s ip address.","enum":["none","cookie","ip_cookie","\"\""],"default":"\"\"","example":"cookie"},"session_affinity_attributes":{"type":"object","description":"Configures cookie attributes for session affinity cookie.","properties":{"drain_duration":{"type":"number","description":"Configures the drain duration in seconds. This field is only used when session affinity is enabled on the load balancer.","example":100},"samesite":{"type":"string","description":"Configures the SameSite attribute on session affinity cookie. Value \"Auto\" will be translated to \"Lax\" or \"None\" depending if Always Use HTTPS is enabled. Note: when using value \"None\", the secure attribute can not be set to \"Never\".","enum":["Auto","Lax","None","Strict"],"default":"Auto","example":"Auto"},"secure":{"type":"string","description":"Configures the Secure attribute on session affinity cookie. Value \"Always\" indicates the Secure attribute will be set in the Set-Cookie header, \"Never\" indicates the Secure attribute will not be set, and \"Auto\" will set the Secure attribute depending if Always Use HTTPS is enabled.","enum":["Auto","Always","Never"],"default":"Auto","example":"Auto"},"zero_downtime_failover":{"type":"string","description":"Configures the zero-downtime failover between origins within a pool when session affinity is enabled. Value \"none\" means no failover takes place for sessions pinned to the origin (default). Value \"temporary\" means traffic will be sent to another other healthy origin until the originally pinned origin is available; note that this can potentially result in heavy origin flapping. Value \"sticky\" means the session affinity cookie is updated and subsequent requests are sent to the new origin. This feature is currently incompatible with Argo, Tiered Cache, and Bandwidth Alliance.","enum":["none","temporary","sticky"],"default":"none","example":"sticky"}}},"session_affinity_ttl":{"type":"number","description":"Time, in seconds, until this load balancer's session affinity cookie expires after being created. This parameter is ignored unless a supported session affinity policy is set. The current default of 23 hours will be used unless session_affinity_ttl is explicitly set. The accepted range of values is between [1800, 604800]. Once the expiry time has been reached, subsequent requests may get sent to a different origin server.","example":5000},"session_duration":{"type":"string","description":"The amount of time that tokens issued for this application will be valid. Must be in the format `300ms` or `2h45m`. Valid time units are: ns, us (or µs), ms, s, m, h.","default":"24h","example":"24h"},"setting":{"oneOf":[{"$ref":"#/components/schemas/always_online"},{"$ref":"#/components/schemas/advanced_ddos"},{"$ref":"#/components/schemas/brotli"},{"$ref":"#/components/schemas/browser_cache_ttl"},{"$ref":"#/components/schemas/browser_check"},{"$ref":"#/components/schemas/cname_flattening"},{"$ref":"#/components/schemas/cache_level"},{"$ref":"#/components/schemas/challenge_ttl"},{"$ref":"#/components/schemas/development_mode"},{"$ref":"#/components/schemas/early_hints"},{"$ref":"#/components/schemas/edge_cache_ttl"},{"$ref":"#/components/schemas/origin_error_page_pass_thru"},{"$ref":"#/components/schemas/sort_query_string_for_cache"},{"$ref":"#/components/schemas/email_obfuscation"},{"$ref":"#/components/schemas/hotlink_protection"},{"$ref":"#/components/schemas/ip_geolocation"},{"$ref":"#/components/schemas/ipv6"},{"$ref":"#/components/schemas/websockets"},{"$ref":"#/components/schemas/sha1_support"},{"$ref":"#/components/schemas/tls_1_2_only"},{"$ref":"#/components/schemas/minify"},{"$ref":"#/components/schemas/max_upload"},{"$ref":"#/components/schemas/mobile_redirect"},{"$ref":"#/components/schemas/mirage"},{"$ref":"#/components/schemas/nel"},{"$ref":"#/components/schemas/polish"},{"$ref":"#/components/schemas/webp"},{"$ref":"#/components/schemas/prefetch_preload"},{"$ref":"#/components/schemas/privacy_pass"},{"$ref":"#/components/schemas/response_buffering"},{"$ref":"#/components/schemas/rocket_loader"},{"$ref":"#/components/schemas/security_header"},{"$ref":"#/components/schemas/security_level"},{"$ref":"#/components/schemas/server_side_exclude"},{"$ref":"#/components/schemas/ssl"},{"$ref":"#/components/schemas/ssl_recommender"},{"$ref":"#/components/schemas/tls_client_auth"},{"$ref":"#/components/schemas/true_client_ip_header"},{"$ref":"#/components/schemas/proxy_read_timeout"},{"$ref":"#/components/schemas/waf"},{"$ref":"#/components/schemas/min_tls_version"},{"$ref":"#/components/schemas/ciphers"},{"$ref":"#/components/schemas/tls_1_3"},{"$ref":"#/components/schemas/opportunistic_encryption"},{"$ref":"#/components/schemas/automatic_https_rewrites"},{"$ref":"#/components/schemas/http2"},{"$ref":"#/components/schemas/http3"},{"$ref":"#/components/schemas/origin_max_http_version"},{"$ref":"#/components/schemas/0rtt"},{"$ref":"#/components/schemas/pseudo_ipv4"},{"$ref":"#/components/schemas/always_use_https"},{"$ref":"#/components/schemas/opportunistic_onion"},{"$ref":"#/components/schemas/orange_to_orange"},{"$ref":"#/components/schemas/image_resizing"},{"$ref":"#/components/schemas/h2_prioritization"},{"$ref":"#/components/schemas/schemas-automatic_platform_optimization"}],"type":"object"},"settings":{"type":"array","description":"Settings available for the zone.","example":[{"id":"browser_check","properties":[{"name":"value","type":"toggle"}]},{"id":"browser_cache_ttl","properties":[{"max":31536000.0,"min":1800,"name":"value","suggested_values":[1800,3600,7200,10800,14400,18000,28800,43200,57600,72000,86400,172800,259200,345600,432000,691200,1382400.0,2073600.0,2678400.0,5356800.0,16070400.0,31536000.0],"type":"range"}]},{"id":"browser_check","properties":[{"name":"value","type":"toggle"}]},{"id":"cache_key_fields","properties":[{"name":"value","properties":[{"allowEmpty":true,"choices":["include","exclude"],"multiple":false,"name":"query_string","type":"select"},{"allowEmpty":true,"choices":["include","exclude","check_presence"],"multiple":true,"name":"header","type":"select"},{"allowEmpty":false,"choices":["resolved"],"multiple":true,"name":"host","type":"select"},{"allowEmpty":true,"choices":["include","check_presence"],"multiple":true,"name":"cookie","type":"select"},{"allowEmpty":false,"choices":["device_type","geo","lang"],"multiple":true,"name":"user","type":"select"}],"type":"object"}]},{"id":"cache_deception_armor","properties":[{"name":"value","type":"toggle"}]},{"id":"cache_level","properties":[{"choices":["bypass","basic","simplified","aggressive","cache_everything"],"multiple":false,"name":"value","type":"select"}]},{"id":"cache_ttl_by_status","properties":[{"allowEmpty":false,"name":"value","type":"object"}]},{"id":"disable_apps","properties":[]},{"id":"disable_performance","properties":[]},{"id":"disable_security","properties":[]},{"id":"edge_cache_ttl","properties":[{"max":2419200.0,"min":7200,"name":"value","suggested_values":[7200,10800,14400,18000,28800,43200,57600,72000,86400,172800,259200,345600,432000,518400,604800,1209600.0,2419200.0],"type":"range"}]},{"id":"email_obfuscation","properties":[{"name":"value","type":"toggle"}]},{"id":"forwarding_url","properties":[{"choices":[301,302],"multiple":false,"name":"status_code","type":"choice"},{"name":"url","type":"forwardingUrl"}]},{"id":"ip_geolocation","properties":[{"name":"value","type":"toggle"}]},{"id":"minify","properties":[{"allowEmpty":true,"choices":["html","css","js"],"multiple":true,"name":"value","type":"select"}]},{"id":"explicit_cache_control","properties":[{"name":"value","type":"toggle"}]},{"id":"rocket_loader","properties":[{"name":"value","type":"toggle"}]},{"id":"security_level","properties":[{"choices":["essentially_off","low","medium","high","under_attack"],"multiple":false,"name":"value","type":"select"}]},{"id":"server_side_exclude","properties":[{"name":"value","type":"toggle"}]},{"id":"ssl","properties":[{"choices":["off","flexible","full","strict"],"multiple":false,"name":"value","type":"choice"}]}],"items":{"type":"object"}},"sha1_support":{"allOf":[{"$ref":"#/components/schemas/schemas-base"},{"properties":{"id":{"description":"Zone setting identifier.","enum":["sha1_support"],"example":"sha1_support"},"value":{"$ref":"#/components/schemas/sha1_support_value"}}}],"title":"Toggle SHA1 support","description":"Allow SHA1 support."},"sha1_support_value":{"type":"string","description":"Value of the zone setting.","enum":["off","on"],"default":"off"},"signature":{"type":"string","description":"The type of hash used for the certificate.","example":"SHA256WithRSA","readOnly":true},"signed_token_request":{"type":"object","readOnly":true,"properties":{"accessRules":{"type":"array","description":"The optional list of access rule constraints on the token. Access can be blocked or allowed based on an IP, IP range, or by country. Access rules are evaluated from first to last. If a rule matches, the associated action is applied and no further rules are evaluated.","example":[{"action":"block","country":["US","MX"],"type":"ip.geoip.country"},{"action":"allow","ip":["93.184.216.0/24","2400:cb00::/32"],"type":"ip.src"},{"action":"block","type":"any"}],"readOnly":true,"items":{"$ref":"#/components/schemas/accessRules"}},"downloadable":{"type":"boolean","description":"The optional boolean value that enables using signed tokens to access MP4 download links for a video.","default":false,"readOnly":true},"exp":{"type":"integer","description":"The optional unix epoch timestamp that specficies the time after a token is not accepted. The maximum time specification is 24 hours from issuing time. If this field is not set, the default is one hour after issuing.","readOnly":true},"id":{"type":"string","description":"The optional ID of a Stream signing key. If present, the `pem` field is also required.","example":"ab0d4ef71g4425f8dcba9041231813000","readOnly":true},"nbf":{"type":"integer","description":"The optional unix epoch timestamp that specifies the time before a the token is not accepted. If this field is not set, the default is one hour before issuing.","readOnly":true},"pem":{"type":"string","description":"The optional base64 encoded private key in PEM format associated with a Stream signing key. If present, the `id` field is also required.","example":"LS0tLS1CRUdJTiBSU0EgUFJJVkFURSBLRVktLS0tLQpNSUlFcEFJQkFBS0NBUUVBc284dnBvOFpEWXRkOUgzbWlPaW1qYXAzVXlVM0oyZ3kwTUYvN1R4blJuRnkwRHpDCkxqUk9naFZsQ0hPQmxsd3NVaE9GU0lyYnN4K05tUTdBeS90TFpXSGxuVGF3UWJ5WGZGOStJeDhVSnNlSHBGV1oKNVF5Z1JYd2liSjh1MVVsZ2xlcmZHMkpueldjVXpZTzEySktZN3doSkw1ajROMWgxZFJNUXQ5Q1pkZFlCQWRzOQpCdk02cjRFMDcxQkhQekhWeDMrUTI1VWtubGdUNXIwS3FiM1E1Y0dlTlBXY1JreW1ybkJEWWR0OXR4eFFMb1dPCllzNXdsMnVYWFVYL0VGcDMwajU0Nmp6czllWExLYlNDbjJjTDZFVE96Y2x3aG9DRGx2a2VQT05rUE9LMDVKNUMKTm1TdFdhMG9hV1VGRzM0MFl3cVVrWGt4OU9tNndXd1JldU1uU1FJREFRQUJBb0lCQUFJOHo1ck5kOEdtOGJBMgo1S3pxQjI1R2lOVENwbUNJeW53NXRJWHZTQmNHcEdydUcvdlN2WG9kVlFVSVY0TWdHQkVXUEFrVzdsNWVBcHI4CnA1ZFd5SkRXYTNkdklFSE9vSEpYU3dBYksxZzZEMTNVa2NkZ1EyRGpoNVhuWDhHZCtBY2c2SmRTQWgxOWtYSHEKMk54RUtBVDB6Ri83a1g2MkRkREFBcWxmQkpGSXJodVIvZUdEVWh4L2piTTRhQ2JCcFdiM0pnRE9OYm5tS1ZoMwpxS2ZwZmRZZENZU1lzWUxrNTlxRDF2VFNwUVFUQ0VadW9VKzNzRVNhdkJzaUs1bU0vTzY5ZkRMRXNURG1MeTVQCmhEK3BMQXI0SlhNNjFwRGVBS0l3cUVqWWJybXlDRHRXTUdJNnZzZ0E1eXQzUUJaME9vV2w5QUkwdWxoZ3p4dXQKZ2ZFNTRRRUNnWUVBN0F3a0lhVEEzYmQ4Nk9jSVZnNFlrWGk1cm5aNDdsM1k4V24zcjIzUmVISXhLdkllRUtSbgp5bUlFNDFtRVBBSmlGWFpLK1VPTXdkeS9EcnFJUithT1JiT2NiV01jWUg2QzgvbG1wdVJFaXE3SW1Ub3VWcnA4CnlnUkprMWprVDA4cTIvNmg4eTBEdjJqMitsaHFXNzRNOUt0cmwxcTRlWmZRUFREL01tR1NnTWtDZ1lFQXdhY04KaSttN1p6dnJtL3NuekF2VlZ5SEtwZHVUUjNERk1naC9maC9tZ0ZHZ1RwZWtUOVV5b3FleGNYQXdwMVlhL01iQQoyNTVJVDZRbXZZTm5yNXp6Wmxic2tMV0hsYllvbWhmWnVXTHhXR3hRaEFORWdaMFVVdUVTRGMvbWx2UXZHbEtSCkZoaGhBUWlVSmdDamhPaHk1SlBiNGFldGRKd0UxK09lVWRFaE1vRUNnWUVBNG8yZ25CM1o4ck5xa3NzemlBek4KYmNuMlJVbDJOaW9pejBwS3JMaDFaT29NNE5BekpQdjJsaHRQMzdtS0htS1hLMHczRjFqTEgwSTBxZmxFVmVZbQpSU1huakdHazJjUnpBYUVzOGgrQzNheDE0Z01pZUtGU3BqNUpNOEFNbVVZOXQ1cUVhN2FYc3o0V1ZoOUlMYmVTCkRiNzlhKzVwd21LQVBrcnBsTHhyZFdrQ2dZQlNNSHVBWVdBbmJYZ1BDS2FZWklGVWJNUWNacmY0ZnpWQ2lmYksKYWZHampvRlNPZXdEOGdGK3BWdWJRTGwxbkFieU44ek1xVDRaaHhybUhpcFlqMjJDaHV2NmN3RXJtbGRiSnpwQwpBMnRaVXdkTk1ESFlMUG5lUHlZeGRJWnlsUXFVeW14SGkydElUQUxNcWtLOGV3ZWdXZHpkeGhQSlJScU5JazhrCmZIVHhnUUtCZ1FEUFc2UXIxY3F3QjNUdnVWdWR4WGRqUTdIcDFodXhrNEVWaEFJZllKNFhSTW1NUE5YS28wdHUKdUt6LzE0QW14R0dvSWJxYVc1bDMzeFNteUxhem84clNUN0tSTjVKME9JSHcrZkR5SFgxdHpVSjZCTldDcEFTcwpjbWdNK0htSzVON0w2bkNaZFJQY2IwU1hGaVRQUGhCUG1PVWFDUnpER0ZMK2JYM1VwajJKbWc9PQotLS0tLUVORCBSU0EgUFJJVkFURSBLRVktLS0tLQo=","readOnly":true}}},"signed_token_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"properties":{"token":{"type":"string","description":"The signed token used with the signed URLs feature.","example":"eyJhbGciOiJSUzI1NiIsImtpZCI6ImU5ZGI5OTBhODI2NjZkZDU3MWM3N2Y5NDRhNWM1YzhkIn0.eyJzdWIiOiJlYTk1MTMyYzE1NzMyNDEyZDIyYzE0NzZmYTgzZjI3YSIsImtpZCI6ImU5ZGI5OTBhODI2NjZkZDU3MWM3N2Y5NDRhNWM1YzhkIiwiZXhwIjoiMTUzNzQ2MDM2NSIsIm5iZiI6IjE1Mzc0NTMxNjUifQ.OZhqOARADn1iubK6GKcn25hN3nU-hCFF5q9w2C4yup0C4diG7aMIowiRpP-eDod8dbAJubsiFuTKrqPcmyCKWYsiv0TQueukqbQlF7HCO1TV-oF6El5-7ldJ46eD-ZQ0XgcIYEKrQOYFF8iDQbqPm3REWd6BnjKZdeVrLzuRaiSnZ9qqFpGu5dfxIY9-nZKDubJHqCr3Imtb211VIG_b9MdtO92JjvkDS-rxT_pkEfTZSafl1OU-98A7KBGtPSJHz2dHORIrUiTA6on4eIXTj9aFhGiir4rSn-rn0OjPRTtJMWIDMoQyE_fwrSYzB7MPuzL2t82BWaEbHZTfixBm5A"}}}}}]},"since":{"anyOf":[{"type":"string"},{"type":"integer"}],"description":"The (inclusive) beginning of the requested time frame. This value can be a negative integer representing the number of minutes in the past relative to time the request is made, or can be an absolute timestamp that conforms to RFC 3339. At this point in time, it cannot exceed a time in the past greater than one year.\n\nRanges that the Cloudflare web application provides will provide the following period length for each point:\n- Last 60 minutes (from -59 to -1): 1 minute resolution\n- Last 7 hours (from -419 to -60): 15 minutes resolution\n- Last 15 hours (from -899 to -420): 30 minutes resolution\n- Last 72 hours (from -4320 to -900): 1 hour resolution\n- Older than 3 days (-525600 to -4320): 1 day resolution.","default":-10080,"example":"2015-01-01T12:23:00Z"},"single_invite_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"type":"object","properties":{"result":{"type":"object"}}}]},"single_member_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"type":"object","properties":{"result":{"type":"object"}}}]},"single_membership_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"type":"object","properties":{"result":{"type":"object"}}}]},"single_organization_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"type":"object","properties":{"result":{"type":"object"}}}]},"single_request_outgoing":{"required":["id","name","peers"],"properties":{"id":{"$ref":"#/components/schemas/dns-secondary-primary-zone_components-schemas-identifier"},"name":{"$ref":"#/components/schemas/dns-secondary-primary-zone_components-schemas-name"},"peers":{"$ref":"#/components/schemas/peers"}}},"single_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"errors":{"type":"array","items":{}},"messages":{"type":"array","items":{}},"result":{"$ref":"#/components/schemas/configuration"}}}]},"single_response_incoming":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"type":"object","properties":{"auto_refresh_seconds":{"$ref":"#/components/schemas/auto_refresh_seconds"},"checked_time":{"$ref":"#/components/schemas/time"},"created_time":{"$ref":"#/components/schemas/time"},"id":{"$ref":"#/components/schemas/dns-secondary-secondary-zone_components-schemas-identifier"},"modified_time":{"$ref":"#/components/schemas/time"},"name":{"$ref":"#/components/schemas/dns-secondary-secondary-zone_components-schemas-name"},"peers":{"$ref":"#/components/schemas/peers"},"soa_serial":{"$ref":"#/components/schemas/soa_serial"}}}}}]},"single_response_outgoing":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"type":"object","properties":{"checked_time":{"$ref":"#/components/schemas/time"},"created_time":{"$ref":"#/components/schemas/time"},"id":{"$ref":"#/components/schemas/dns-secondary-primary-zone_components-schemas-identifier"},"last_transferred_time":{"$ref":"#/components/schemas/time"},"name":{"$ref":"#/components/schemas/dns-secondary-primary-zone_components-schemas-name"},"peers":{"$ref":"#/components/schemas/peers"},"soa_serial":{"$ref":"#/components/schemas/soa_serial"}}}}}]},"single_response_with_list_items":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"properties":{"created_at":{"$ref":"#/components/schemas/timestamp"},"description":{"$ref":"#/components/schemas/lists_components-schemas-description-2"},"id":{"$ref":"#/components/schemas/lists_components-schemas-uuid"},"items":{"$ref":"#/components/schemas/schemas-items"},"name":{"$ref":"#/components/schemas/lists_components-schemas-name-2"},"type":{"$ref":"#/components/schemas/lists_components-schemas-type"},"updated_at":{"$ref":"#/components/schemas/timestamp"}}}}}]},"single_role_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"type":"object","properties":{"result":{"type":"object"}}}]},"single_user_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"type":"object","properties":{"result":{"type":"object"}}}]},"size":{"type":"number","description":"The size of the media item in bytes.","example":4190963.0,"readOnly":true},"skip_interstitial":{"type":"boolean","description":"Enables automatic authentication through cloudflared.","example":true},"soa_serial":{"type":"number","description":"The serial number of the SOA for the given zone.","example":2019102400.0},"sort_query_string_for_cache":{"allOf":[{"$ref":"#/components/schemas/schemas-base"},{"properties":{"id":{"description":"ID of the zone setting.","enum":["sort_query_string_for_cache"],"example":"sort_query_string_for_cache"},"value":{"$ref":"#/components/schemas/sort_query_string_for_cache_value"}}}],"title":"Get String Sort","description":"Cloudflare will treat files with the same query strings as the same file in cache, regardless of the order of the query strings. This is limited to Enterprise Zones.","default":"off"},"sort_query_string_for_cache_value":{"type":"string","description":"Value of the zone setting.","enum":["on","off"],"default":"off"},"split_tunnel":{"type":"object","required":["address","description"],"properties":{"address":{"type":"string","description":"The address in CIDR format to exclude from the tunnel. If address is present, host must not be present.","example":"192.0.2.0/24"},"description":{"type":"string","description":"A description of the split tunnel item, displayed in the client UI.","example":"Exclude testing domains from the tunnel","maxLength":100},"host":{"type":"string","description":"The domain name to exclude from the tunnel. If host is present, address must not be present.","example":"*.example.com"}}},"split_tunnel_include":{"type":"object","required":["address","description"],"properties":{"address":{"type":"string","description":"The address in CIDR format to include in the tunnel. If address is present, host must not be present.","example":"192.0.2.0/24"},"description":{"type":"string","description":"A description of the split tunnel item, displayed in the client UI.","example":"Include testing domains from the tunnel","maxLength":100},"host":{"type":"string","description":"The domain name to include in the tunnel. If host is present, address must not be present.","example":"*.example.com"}}},"split_tunnel_include_response_collection":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/split_tunnel_include"}}}}]},"split_tunnel_response_collection":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/split_tunnel"}}}}]},"ssh_props":{"allOf":[{"$ref":"#/components/schemas/self_hosted_props"},{"properties":{"type":{"type":"string","description":"The application type.","example":"ssh"}}}]},"ssl":{"allOf":[{"$ref":"#/components/schemas/schemas-base"},{"properties":{"id":{"description":"ID of the zone setting.","enum":["ssl"],"example":"ssl"},"value":{"$ref":"#/components/schemas/ssl_value"}}}],"title":"SSL","description":"SSL encrypts your visitor's connection and safeguards credit card numbers and other personal data to and from your website. SSL can take up to 5 minutes to fully activate. Requires Cloudflare active on your root domain or www domain. Off: no SSL between the visitor and Cloudflare, and no SSL between Cloudflare and your web server (all HTTP traffic). Flexible: SSL between the visitor and Cloudflare -- visitor sees HTTPS on your site, but no SSL between Cloudflare and your web server. You don't need to have an SSL cert on your web server, but your vistors will still see the site as being HTTPS enabled. Full: SSL between the visitor and Cloudflare -- visitor sees HTTPS on your site, and SSL between Cloudflare and your web server. You'll need to have your own SSL cert or self-signed cert at the very least. Full (Strict): SSL between the visitor and Cloudflare -- visitor sees HTTPS on your site, and SSL between Cloudflare and your web server. You'll need to have a valid SSL certificate installed on your web server. This certificate must be signed by a certificate authority, have an expiration date in the future, and respond for the request domain name (hostname). (https://support.cloudflare.com/hc/en-us/articles/200170416)."},"ssl_recommender":{"allOf":[{"properties":{"enabled":{"$ref":"#/components/schemas/ssl_recommender_enabled"},"id":{"description":"Enrollment value for SSL/TLS Recommender.","enum":["ssl_recommender"],"example":"ssl_recommender"}}},{"properties":{"editable":{"$ref":"#/components/schemas/editable"},"modified_on":{"$ref":"#/components/schemas/properties-modified_on"}}}],"title":"SSL/TLS Recommender","description":"Enrollment in the SSL/TLS Recommender service which tries to detect and recommend (by sending periodic emails) the most secure SSL/TLS setting your origin servers support."},"ssl_recommender_enabled":{"type":"boolean","description":"ssl-recommender enrollment setting.","default":false},"ssl_universal_settings_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/universal"}}}]},"ssl_validation_method_response_collection":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"properties":{"status":{"$ref":"#/components/schemas/validation_method_components-schemas-status"},"validation_method":{"$ref":"#/components/schemas/validation_method_definition"}}}}}]},"ssl_value":{"type":"string","description":"Value of the zone setting.\nNotes: Depends on the zone's plan level","enum":["off","flexible","full","strict"],"default":"off"},"ssl_verification_response_collection":{"allOf":[{"properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/verification"}}}}]},"sslpost":{"oneOf":[{"type":"object","properties":{"bundle_method":{"type":"string","description":"A ubiquitous bundle has the highest probability of being verified everywhere, even by clients using outdated or unusual trust stores. An optimal bundle uses the shortest chain and newest intermediates. And the force bundle verifies the chain, but does not otherwise modify it.","enum":["ubiquitous","optimal","force"],"default":"ubiquitous","example":"ubiquitous"},"custom_certificate":{"type":"string","description":"If a custom uploaded certificate is used.","example":"-----BEGIN CERTIFICATE-----\\nMIIFJDCCBAygAwIBAgIQD0ifmj/Yi5NP/2gdUySbfzANBgkqhkiG9w0BAQsFADBN\\nMQswCQYDVQQGEwJVUzEVMBMGA1UEChMMRGlnaUNlcnQgSW5jMScwJQYDVQQDEx5E...SzSHfXp5lnu/3V08I72q1QNzOCgY1XeL4GKVcj4or6cT6tX6oJH7ePPmfrBfqI/O\\nOeH8gMJ+FuwtXYEPa4hBf38M5eU5xWG7\\n-----END CERTIFICATE-----\\n"},"custom_key":{"type":"string","description":"The key for a custom uploaded certificate.","example":"-----BEGIN RSA PRIVATE KEY-----\nMIIEowIBAAKCAQEAwQHoetcl9+5ikGzV6cMzWtWPJHqXT3wpbEkRU9Yz7lgvddmG\ndtcGbg/1CGZu0jJGkMoppoUo4c3dts3iwqRYmBikUP77wwY2QGmDZw2FvkJCJlKn\nabIRuGvBKwzESIXgKk2016aTP6/dAjEHyo6SeoK8lkIySUvK0fyOVlsiEsCmOpid\ntnKX/a+50GjB79CJH4ER2lLVZnhePFR/zUOyPxZQQ4naHf7yu/b5jhO0f8fwt+py\nFxIXjbEIdZliWRkRMtzrHOJIhrmJ2A1J7iOrirbbwillwjjNVUWPf3IJ3M12S9pE\newooaeO2izNTERcG9HzAacbVRn2Y2SWIyT/18QIDAQABAoIBACbhTYXBZYKmYPCb\nHBR1IBlCQA2nLGf0qRuJNJZg5iEzXows/6tc8YymZkQE7nolapWsQ+upk2y5Xdp/\naxiuprIs9JzkYK8Ox0r+dlwCG1kSW+UAbX0bQ/qUqlsTvU6muVuMP8vZYHxJ3wmb\n+ufRBKztPTQ/rYWaYQcgC0RWI20HTFBMxlTAyNxYNWzX7RKFkGVVyB9RsAtmcc8g\n+j4OdosbfNoJPS0HeIfNpAznDfHKdxDk2Yc1tV6RHBrC1ynyLE9+TaflIAdo2MVv\nKLMLq51GqYKtgJFIlBRPQqKoyXdz3fGvXrTkf/WY9QNq0J1Vk5ERePZ54mN8iZB7\n9lwy/AkCgYEA6FXzosxswaJ2wQLeoYc7ceaweX/SwTvxHgXzRyJIIT0eJWgx13Wo\n/WA3Iziimsjf6qE+SI/8laxPp2A86VMaIt3Z3mJN/CqSVGw8LK2AQst+OwdPyDMu\niacE8lj/IFGC8mwNUAb9CzGU3JpU4PxxGFjS/eMtGeRXCWkK4NE+G08CgYEA1Kp9\nN2JrVlqUz+gAX+LPmE9OEMAS9WQSQsfCHGogIFDGGcNf7+uwBM7GAaSJIP01zcoe\nVAgWdzXCv3FLhsaZoJ6RyLOLay5phbu1iaTr4UNYm5WtYTzMzqh8l1+MFFDl9xDB\nvULuCIIrglM5MeS/qnSg1uMoH2oVPj9TVst/ir8CgYEAxrI7Ws9Zc4Bt70N1As+U\nlySjaEVZCMkqvHJ6TCuVZFfQoE0r0whdLdRLU2PsLFP+q7qaeZQqgBaNSKeVcDYR\n9B+nY/jOmQoPewPVsp/vQTCnE/R81spu0mp0YI6cIheT1Z9zAy322svcc43JaWB7\nmEbeqyLOP4Z4qSOcmghZBSECgYACvR9Xs0DGn+wCsW4vze/2ei77MD4OQvepPIFX\ndFZtlBy5ADcgE9z0cuVB6CiL8DbdK5kwY9pGNr8HUCI03iHkW6Zs+0L0YmihfEVe\nPG19PSzK9CaDdhD9KFZSbLyVFmWfxOt50H7YRTTiPMgjyFpfi5j2q348yVT0tEQS\nfhRqaQKBgAcWPokmJ7EbYQGeMbS7HC8eWO/RyamlnSffdCdSc7ue3zdVJxpAkQ8W\nqu80pEIF6raIQfAf8MXiiZ7auFOSnHQTXUbhCpvDLKi0Mwq3G8Pl07l+2s6dQG6T\nlv6XTQaMyf6n1yjzL+fzDrH3qXMxHMO/b13EePXpDMpY7HQpoLDi\n-----END RSA PRIVATE KEY-----\n"},"method":{"description":"Domain control validation (DCV) method used for this hostname.","enum":["http","txt","email"],"example":"http"},"settings":{"$ref":"#/components/schemas/sslsettings"},"type":{"description":"Level of validation to be used for this hostname. Domain validation (dv) must be used.","enum":["dv"],"example":"dv","readOnly":true},"wildcard":{"type":"boolean","description":"Indicates whether the certificate covers a wildcard.","example":false}}}],"type":"object","description":"SSL properties used when creating the custom hostname."},"sslsettings":{"type":"object","description":"SSL specific settings.","properties":{"ciphers":{"type":"array","description":"An allowlist of ciphers for TLS termination. These ciphers must be in the BoringSSL format.","example":["ECDHE-RSA-AES128-GCM-SHA256","AES128-SHA"],"uniqueItems":true,"items":{"type":"string"}},"early_hints":{"description":"Whether or not Early Hints is enabled.","enum":["on","off"],"example":"on"},"http2":{"description":"Whether or not HTTP2 is enabled.","enum":["on","off"],"example":"on"},"min_tls_version":{"description":"The minimum TLS version supported.","enum":["1.0","1.1","1.2","1.3"],"example":"1.2"},"tls_1_3":{"description":"Whether or not TLS 1.3 is enabled.","enum":["on","off"],"example":"on"}}},"stage":{"type":"object","description":"The status of the deployment.","readOnly":true,"properties":{"ended_on":{"type":"string","format":"date-time","description":"When the stage ended.","example":"2021-03-09 00:58:59 +0000","nullable":true,"readOnly":true},"name":{"type":"string","description":"The current build stage.","example":"deploy","pattern":"queued|initialize|clone_repo|build|deploy"},"started_on":{"type":"string","format":"date-time","description":"When the stage started.","example":"2021-03-09T00:55:03.923456Z","nullable":true,"readOnly":true},"status":{"type":"string","description":"State of the current stage.","example":"success","readOnly":true,"pattern":"success|idle|active|failure|canceled"}}},"start_time_seconds":{"type":"integer","description":"Specifies the start time for the video clip in seconds.","readOnly":true},"state":{"type":"string","description":"The state that the subscription is in.","enum":["Trial","Provisioned","Paid","AwaitingPayment","Cancelled","Failed","Expired"],"example":"Paid","readOnly":true},"status":{"type":"string","description":"Status of the token.","enum":["active","disabled","expired"],"example":"active"},"status_event_id":{"type":"string","example":"25756b2dfe6e378a06b033b670413757"},"status_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"type":"object","properties":{"estimated_queued_users":{"$ref":"#/components/schemas/estimated_queued_users"},"estimated_total_active_users":{"$ref":"#/components/schemas/estimated_total_active_users"},"event_id":{"$ref":"#/components/schemas/status_event_id"},"max_estimated_time_minutes":{"$ref":"#/components/schemas/max_estimated_time_minutes"},"status":{"$ref":"#/components/schemas/waitingroom_components-schemas-status"}}}}}]},"std_dev_rtt_ms":{"type":"number","description":"Standard deviation of the RTTs in ms."},"steering_policy":{"type":"string","description":"Steering Policy for this load balancer.\n- `\"off\"`: Use `default_pools`.\n- `\"geo\"`: Use `region_pools`/`country_pools`/`pop_pools`. For non-proxied requests, the country for `country_pools` is determined by `location_strategy`.\n- `\"random\"`: Select a pool randomly.\n- `\"dynamic_latency\"`: Use round trip time to select the closest pool in default_pools (requires pool health checks).\n- `\"proximity\"`: Use the pools' latitude and longitude to select the closest pool using the Cloudflare PoP location for proxied requests or the location determined by `location_strategy` for non-proxied requests.\n- `\"\"`: Will map to `\"geo\"` if you use `region_pools`/`country_pools`/`pop_pools` otherwise `\"off\"`.","enum":["off","geo","random","dynamic_latency","proximity","\"\""],"default":"\"\"","example":"dynamic_latency"},"stix_identifier":{"type":"string","description":"STIX 2.1 identifier: https://docs.oasis-open.org/cti/stix/v2.1/cs02/stix-v2.1-cs02.html#_64yvzeku5a5c","example":"ipv4-addr--baa568ec-6efe-5902-be55-0663833db537"},"stored_components-schemas-result":{"allOf":[{"$ref":"#/components/schemas/schemas-result"},{"properties":{"data":{"example":[{"metrics":[[2,4],[16,32]]}]},"max":{"example":{"storedBytes":32,"storedKeys":4}},"min":{"example":{"storedBytes":16,"storedKeys":2}},"query":{"$ref":"#/components/schemas/components-schemas-query"},"totals":{"example":{"storedBytes":48,"storedKeys":6}}}}]},"string_constraint":{"type":"object","description":"String constraint.","required":["operator","value"],"properties":{"operator":{"description":"The matches operator can use asterisks and pipes as wildcard and 'or' operators.","enum":["matches","contains","equals","not_equal","not_contain"],"default":"contains"},"value":{"type":"string","description":"The value to apply the operator to."}}},"subcategory":{"type":"object","properties":{"beta":{"$ref":"#/components/schemas/beta"},"class":{"$ref":"#/components/schemas/class"},"description":{"$ref":"#/components/schemas/categories_components-schemas-description"},"id":{"$ref":"#/components/schemas/categories_components-schemas-id"},"name":{"$ref":"#/components/schemas/categories_components-schemas-name"}}},"subdomain":{"type":"string","description":"The DNS Over HTTPS domain to send DNS requests to. (auto-generated).","example":"oli3n9zkz5"},"subdomain-response":{"allOf":[{"$ref":"#/components/schemas/api-response-common"},{"properties":{"result":{"type":"object","properties":{"name":{"readOnly":true}}}}}]},"subscription":{"allOf":[{"$ref":"#/components/schemas/subscription-v2"}],"type":"object"},"subscription-v2":{"type":"object","properties":{"app":{"properties":{"install_id":{"$ref":"#/components/schemas/install_id"}}},"component_values":{"$ref":"#/components/schemas/component_values"},"currency":{"$ref":"#/components/schemas/currency"},"current_period_end":{"$ref":"#/components/schemas/current_period_end"},"current_period_start":{"$ref":"#/components/schemas/current_period_start"},"frequency":{"$ref":"#/components/schemas/frequency"},"id":{"$ref":"#/components/schemas/subscription-v2_components-schemas-identifier"},"price":{"$ref":"#/components/schemas/price"},"rate_plan":{"$ref":"#/components/schemas/rate_plan"},"state":{"$ref":"#/components/schemas/state"},"zone":{"$ref":"#/components/schemas/zone"}}},"subscription-v2_components-schemas-identifier":{"type":"string","description":"Subscription identifier tag.","example":"506e3185e9c882d175a2d0cb0093d9f2","readOnly":true,"maxLength":32},"suggested_threshold":{"type":"integer","description":"The suggested threshold in requests done by the same auth_id or period_seconds.","readOnly":true},"support_url":{"type":"string","description":"The URL to launch when the Send Feedback button is clicked.","example":"https://1.1.1.1/help"},"supported_tld":{"type":"boolean","description":"Whether a particular TLD is currently supported by Cloudflare Registrar. Refer to [TLD Policies](https://www.cloudflare.com/tld-policies/) for a list of supported TLDs.","example":true},"suspended":{"type":"boolean","description":"If suspended, no health checks are sent to the origin.","default":false},"switch_locked":{"type":"boolean","description":"Whether to allow the user to turn off the WARP switch and disconnect the client.","example":true},"tail-response":{"allOf":[{"$ref":"#/components/schemas/api-response-common"},{"properties":{"result":{"type":"object","properties":{"expires_at":{"readOnly":true},"id":{"readOnly":true},"url":{"readOnly":true}}}}}]},"target":{"oneOf":[{"$ref":"#/components/schemas/url_target"}],"description":"A request condition target.","required":["target","constraint"]},"target_result":{"type":"object","properties":{"colos":{"type":"array","items":{"$ref":"#/components/schemas/colo_result"}},"target":{"$ref":"#/components/schemas/schemas-target"}}},"target_summary":{"type":"object","description":"Aggregated statistics from all hops about the target.","example":{"asn":"","ip":"1.1.1.1","max_latency_ms":0.034,"mean_latency_ms":0.021,"min_latency_ms":0.014,"name":"1.1.1.1","packet_count":3,"std_dev_latency_ms":0.011269427669584647}},"targets":{"type":"array","description":"The rule targets to evaluate on each request.","example":[{"constraint":{"operator":"matches","value":"*example.com/images/*"},"target":"url"}],"items":{"$ref":"#/components/schemas/target"}},"tcp_config":{"type":"object","description":"Parameters specific to TCP health check.","nullable":true,"properties":{"method":{"type":"string","description":"The TCP connection method to use for the health check.","enum":["connection_established"],"default":"connection_established"},"port":{"type":"integer","description":"Port number to connect to for the health check. Defaults to 80.","default":80}}},"teamnet":{"type":"object","required":["network","tunnel_id","comment","created_at"],"properties":{"comment":{"$ref":"#/components/schemas/comment"},"created_at":{"description":"Timestamp of when the route was created."},"deleted_at":{"type":"string","format":"date-time","description":"Timestamp of when the route was deleted. If `null`, the route has not been deleted.","example":"2021-01-25T18:22:34.317854Z","nullable":true,"readOnly":true},"network":{"$ref":"#/components/schemas/ip_network"},"tunnel_id":{"$ref":"#/components/schemas/schemas-tunnel_id"},"tunnel_name":{"$ref":"#/components/schemas/schemas-tunnel_name"},"virtual_network_id":{"$ref":"#/components/schemas/virtual_network_id"}}},"teamnet_components-schemas-ip":{"type":"string","example":"10.1.0.137"},"telephone":{"type":"string","description":"User's telephone number","example":"+1 123-123-1234","nullable":true,"maxLength":20},"test_connection_properties":{"type":"object","properties":{"body_hash":{"type":"string","description":"Hash version of body.","example":"be27f2429421e12f200cab1da43ba301bdc70e1d"},"body_size":{"type":"string","description":"Size of the body in bytes.","example":"63910 bytes"},"cf-cache-status":{"type":"string","description":"Lists any `cf-cache-status` present."},"cf-ray":{"type":"string","description":"Lists any `cf-ray` present.","example":"1ddd7570575207d9-LAX"},"cf-wan-error":{"type":"string","description":"Lists any `cf-wan-error` present."},"cloudflare":{"type":"string","description":"Whether Cloudflare is enabled on the host.","example":"on"},"connection_close":{"type":"boolean","description":"Connection closed or open.","default":true,"example":false},"elapsed_time":{"type":"string","description":"Amount of seconds that the test lasted.","example":"0.239013s"},"host_name":{"type":"string","description":"The hostname queried.","example":"www.example.com"},"http_status":{"type":"number","description":"The HTTP status response code.","example":200},"method":{"description":"HTTP Method used to test the connection.","enum":["GET","POST"],"example":"GET"},"missing_headers":{"type":"string","description":"What headers are missing.","example":"No Content-Length or Transfer-Encoding."},"protocol":{"type":"string","description":"Protocol used to test the connection.","example":"HTTP/1.1"},"railgun":{"type":"string","description":"Indicates if Railgun is enabled on the queried hostname.","example":"on"},"response_status":{"type":"string","description":"HTTP Status code.","example":"200 OK"},"url":{"type":"string","description":"Url of the domain you can compare the connection to.","example":"https://www.cloudflare.com"}}},"test_connection_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/test_connection_properties"}}}]},"threats":{"type":"object","description":"Breakdown of totals for threats.","properties":{"all":{"type":"integer","description":"The total number of identifiable threats received over the time frame."},"country":{"type":"object","description":"A list of key/value pairs where the key is a two-digit country code and the value is the number of malicious requests received from that country.","example":{"AU":91,"CN":523423,"US":123}},"type":{"type":"object","description":"The list of key/value pairs where the key is a threat category and the value is the number of requests.","example":{"hot.ban.unknown":5324,"macro.chl.captchaErr":1341,"macro.chl.jschlErr":5323,"user.ban.ip":123}}}},"threshold":{"type":"number","description":"The threshold that will trigger the configured mitigation action. Configure this value along with the `period` property to establish a threshold per period.","example":60,"minimum":1},"thresholds":{"type":"object","readOnly":true,"required":["period_seconds","suggested_threshold","p50","p90","p99","requests","auth_id_tokens","data_points","last_updated"],"properties":{"thresholds":{"type":"object","properties":{"auth_id_tokens":{"$ref":"#/components/schemas/auth_id_tokens"},"data_points":{"$ref":"#/components/schemas/data_points"},"last_updated":{"$ref":"#/components/schemas/timestamp"},"p50":{"$ref":"#/components/schemas/p50"},"p90":{"$ref":"#/components/schemas/p90"},"p99":{"$ref":"#/components/schemas/p99"},"period_seconds":{"$ref":"#/components/schemas/period_seconds"},"requests":{"$ref":"#/components/schemas/requests"},"suggested_threshold":{"$ref":"#/components/schemas/suggested_threshold"}}}}},"thumbnail_url":{"type":"string","format":"uri","description":"The media item's thumbnail URI. This field is omitted until encoding is complete.","example":"https://customer-m033z5x00ks6nunl.cloudflarestream.com/ea95132c15732412d22c1476fa83f27a/thumbnails/thumbnail.jpg","readOnly":true},"thumbnailTimestampPct":{"type":"number","description":"The timestamp for a thumbnail image calculated as a percentage value of the video's duration. To convert from a second-wise timestamp to a percentage, divide the desired timestamp by the total duration of the video. If this value is not set, the default thumbnail image is taken from 0s of the video.","default":0,"example":0.529241,"minimum":0,"maximum":1},"time":{"type":"string","description":"The time for a specific event.","example":"2019-10-24T17:09:42.883908+01:00"},"timeout":{"type":"number","description":"The time in seconds during which Cloudflare will perform the mitigation action. Must be an integer value greater than or equal to the period.\nNotes: If \"mode\" is \"challenge\", \"managed_challenge\", or \"js_challenge\", Cloudflare will use the zone's Challenge Passage time and you should not provide this value.","example":86400,"minimum":1,"maximum":86400},"timeseries":{"type":"array","description":"Time deltas containing metadata about each bucket of time. The number of buckets (resolution) is determined by the amount of time between the since and until parameters.","items":{"type":"object","properties":{"bandwidth":{"$ref":"#/components/schemas/bandwidth"},"pageviews":{"$ref":"#/components/schemas/pageviews"},"requests":{"$ref":"#/components/schemas/schemas-requests"},"since":{"$ref":"#/components/schemas/since"},"threats":{"$ref":"#/components/schemas/threats"},"uniques":{"$ref":"#/components/schemas/uniques"},"until":{"$ref":"#/components/schemas/until"}}}},"timeseries_by_colo":{"type":"array","description":"Time deltas containing metadata about each bucket of time. The number of buckets (resolution) is determined by the amount of time between the since and until parameters.","items":{"type":"object","properties":{"bandwidth":{"$ref":"#/components/schemas/bandwidth_by_colo"},"requests":{"$ref":"#/components/schemas/requests_by_colo"},"since":{"$ref":"#/components/schemas/since"},"threats":{"$ref":"#/components/schemas/threats"},"until":{"$ref":"#/components/schemas/until"}}}},"timestamp":{"type":"string","format":"date-time","example":"2014-01-01T05:20:00.12345Z","readOnly":true},"tls":{"type":"string","description":"The type of TLS termination associated with the application.","enum":["off","flexible","full","strict"],"example":"full"},"tls-settings":{"type":"object","description":"TLS interception settings.","properties":{"enabled":{"type":"boolean","description":"Enable inspecting encrypted HTTP traffic.","example":true}}},"tls_1_2_only":{"allOf":[{"$ref":"#/components/schemas/schemas-base"},{"properties":{"id":{"description":"Zone setting identifier.","enum":["tls_1_2_only"],"example":"tls_1_2_only"},"value":{"$ref":"#/components/schemas/tls_1_2_only_value"}}}],"title":"TLS1.2 only","description":"Only allows TLS1.2."},"tls_1_2_only_value":{"type":"string","description":"Value of the zone setting.","enum":["off","on"],"default":"off"},"tls_1_3":{"allOf":[{"$ref":"#/components/schemas/schemas-base"},{"properties":{"id":{"description":"ID of the zone setting.","enum":["tls_1_3"],"example":"tls_1_3"},"value":{"$ref":"#/components/schemas/tls_1_3_value"}}}],"title":"Enable TLS 1.3 value for a zone","description":"Enables Crypto TLS 1.3 feature for a zone.","default":"off"},"tls_1_3_value":{"type":"string","description":"Value of the zone setting.\nNotes: Default value depends on the zone's plan level.","enum":["on","off","zrt"],"default":"off"},"tls_client_auth":{"allOf":[{"$ref":"#/components/schemas/schemas-base"},{"properties":{"id":{"description":"ID of the zone setting.","enum":["tls_client_auth"],"example":"tls_client_auth"},"value":{"$ref":"#/components/schemas/tls_client_auth_value"}}}],"title":"TLS Client Authentication","description":"TLS Client Auth requires Cloudflare to connect to your origin server using a client certificate (Enterprise Only)."},"tls_client_auth_value":{"type":"string","description":"value of the zone setting.","enum":["on","off"],"default":"on"},"token":{"type":"object","required":["id","name","status","policies"],"properties":{"condition":{"$ref":"#/components/schemas/condition"},"expires_on":{"$ref":"#/components/schemas/expires_on"},"id":{"$ref":"#/components/schemas/components-schemas-identifier"},"issued_on":{"$ref":"#/components/schemas/issued_on"},"modified_on":{"$ref":"#/components/schemas/modified_on"},"name":{"$ref":"#/components/schemas/name"},"not_before":{"$ref":"#/components/schemas/not_before"},"policies":{"$ref":"#/components/schemas/policies"},"status":{"$ref":"#/components/schemas/status"}}},"total-tls_components-schemas-enabled":{"type":"boolean","description":"If enabled, Total TLS will order a hostname specific TLS certificate for any proxied A, AAAA, or CNAME record in your zone.","example":true},"total_active_users":{"type":"integer","description":"Sets the total number of active user sessions on the route at a point in time. A route is a combination of host and path on which a waiting room is available. This value is used as a baseline for the total number of active user sessions on the route. It is possible to have a situation where there are more or less active users sessions on the route based on the traffic patterns at that time around the world.","minimum":200,"maximum":2147483647.0},"total_tls_settings_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"properties":{"certificate_authority":{"$ref":"#/components/schemas/schemas-certificate_authority"},"enabled":{"$ref":"#/components/schemas/total-tls_components-schemas-enabled"},"validity_days":{"$ref":"#/components/schemas/schemas-validity_days"}}}}}]},"totals":{"type":"object","description":"Breakdown of totals by data type.","properties":{"bandwidth":{"$ref":"#/components/schemas/bandwidth"},"pageviews":{"$ref":"#/components/schemas/pageviews"},"requests":{"$ref":"#/components/schemas/schemas-requests"},"since":{"$ref":"#/components/schemas/since"},"threats":{"$ref":"#/components/schemas/threats"},"uniques":{"$ref":"#/components/schemas/uniques"},"until":{"$ref":"#/components/schemas/until"}}},"totals_by_colo":{"type":"object","description":"Breakdown of totals by data type.","properties":{"bandwidth":{"$ref":"#/components/schemas/bandwidth_by_colo"},"requests":{"$ref":"#/components/schemas/requests_by_colo"},"since":{"$ref":"#/components/schemas/since"},"threats":{"$ref":"#/components/schemas/threats"},"until":{"$ref":"#/components/schemas/until"}}},"traceroute_components-schemas-ip":{"type":"string","description":"IP address of the node."},"traceroute_components-schemas-name":{"type":"string","description":"Host name of the address, this may be the same as the IP address."},"traceroute_components-schemas-port":{"type":"integer","description":"For UDP and TCP, specifies the destination port. For ICMP, specifies the initial ICMP sequence value. Default value 0 will choose the best value to use for each protocol.","default":0,"minimum":0,"maximum":65535},"traceroute_response_collection":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/target_result"}}}}]},"traceroute_time_ms":{"type":"integer","description":"Total time of traceroute in ms."},"traditional_allow_rule":{"allOf":[{"$ref":"#/components/schemas/rule_components-schemas-base-2"},{"properties":{"allowed_modes":{"$ref":"#/components/schemas/allowed_modes_allow_traditional"},"mode":{"$ref":"#/components/schemas/mode_allow_traditional"}}}],"title":"Traditional (allow) WAF rule","description":"When triggered, traditional WAF rules cause the firewall to immediately act on the request based on the rule configuration. An 'allow' rule will immediately allow the request and no other rules will be processed.","required":["id","description","priority","allowed_modes","default_mode","mode","group","package_id"]},"traditional_deny_rule":{"allOf":[{"$ref":"#/components/schemas/rule_components-schemas-base-2"},{"properties":{"allowed_modes":{"$ref":"#/components/schemas/allowed_modes_deny_traditional"},"default_mode":{"$ref":"#/components/schemas/default_mode"},"mode":{"$ref":"#/components/schemas/mode_deny_traditional"}}}],"title":"Traditional (deny) WAF rule","description":"When triggered, traditional WAF rules cause the firewall to immediately act upon the request based on the configuration of the rule. A 'deny' rule will immediately respond to the request based on the configured rule action/mode (for example, 'block') and no other rules will be processed.","required":["id","description","priority","allowed_modes","default_mode","mode","group","package_id"]},"traffic":{"type":"string","description":"The wirefilter expression to be used for traffic matching.","example":"http.request.uri matches \".*a/partial/uri.*\" and http.request.host in $01302951-49f9-47c9-a400-0297e60b6a10"},"traffic_type":{"type":"string","description":"Determines how data travels from the edge to your origin. When set to \"direct\", Spectrum will send traffic directly to your origin, and the application's type is derived from the `protocol`. When set to \"http\" or \"https\", Spectrum will apply Cloudflare's HTTP/HTTPS features as it sends traffic to your origin, and the application type matches this property exactly.","enum":["direct","http","https"],"default":"direct","example":"direct"},"transfer_in":{"description":"Statuses for domain transfers into Cloudflare Registrar.","properties":{"accept_foa":{"description":"Form of authorization has been accepted by the registrant.","example":"needed"},"approve_transfer":{"description":"Shows transfer status with the registry.","example":"unknown"},"can_cancel_transfer":{"type":"boolean","description":"Indicates if cancellation is still possible.","example":true},"disable_privacy":{"description":"Privacy guards are disabled at the foreign registrar."},"enter_auth_code":{"description":"Auth code has been entered and verified.","example":"needed"},"unlock_domain":{"description":"Domain is unlocked at the foreign registrar."}}},"transform-rules_components-schemas-rule":{"properties":{"action":{"example":"rewrite"},"action_parameters":{"$ref":"#/components/schemas/schemas-action_parameters"},"description":{"example":"change request based on ip location"},"expression":{"example":"ip.geoip.country eq \"AL\""},"id":{"example":"3a03d665bac047339bb530ecb439a90d"},"version":{"example":"1"}}},"true_client_ip_header":{"allOf":[{"$ref":"#/components/schemas/schemas-base"},{"properties":{"id":{"description":"ID of the zone setting.","enum":["true_client_ip_header"],"example":"true_client_ip_header"},"value":{"$ref":"#/components/schemas/true_client_ip_header_value"}}}],"title":"True Client IP Header","description":"Allows customer to continue to use True Client IP (Akamai feature) in the headers we send to the origin. This is limited to Enterprise Zones.","default":"off"},"true_client_ip_header_value":{"type":"string","description":"Value of the zone setting.","enum":["on","off"],"default":"off"},"tsig":{"type":"object","required":["id","name","secret","algo"],"properties":{"algo":{"$ref":"#/components/schemas/algo"},"id":{"$ref":"#/components/schemas/tsig_components-schemas-identifier"},"name":{"$ref":"#/components/schemas/tsig_components-schemas-name"},"secret":{"$ref":"#/components/schemas/secret"}}},"tsig_components-schemas-identifier":{"example":"69cd1e104af3e6ed3cb344f263fd0d5a"},"tsig_components-schemas-name":{"type":"string","description":"TSIG key name.","example":"tsig.customer.cf."},"tsig_components-schemas-response_collection":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/tsig"}}}}]},"tsig_id":{"type":"string","description":"TSIG authentication will be used for zone transfer if configured.","example":"69cd1e104af3e6ed3cb344f263fd0d5a"},"ttl":{"anyOf":[{"type":"number","example":3600,"minimum":60,"maximum":86400},{"type":"number","enum":[1]}],"type":"number","description":"Time to live, in seconds, of the DNS record. Must be between 60 and 86400, or 1 for 'automatic'.","example":3600},"tunnel":{"type":"object","description":"A Cloudflare Tunnel that connects your origin to Cloudflare's edge.","properties":{"account_tag":{"$ref":"#/components/schemas/cf_account_id"},"connections":{"$ref":"#/components/schemas/connections"},"conns_active_at":{"$ref":"#/components/schemas/conns_active_at"},"conns_inactive_at":{"$ref":"#/components/schemas/conns_inactive_at"},"created_at":{"$ref":"#/components/schemas/cloudflare-tunnel_components-schemas-created_at"},"deleted_at":{"$ref":"#/components/schemas/schemas-deleted_at"},"id":{"$ref":"#/components/schemas/tunnel_id"},"metadata":{"$ref":"#/components/schemas/cloudflare-tunnel_components-schemas-metadata"},"name":{"$ref":"#/components/schemas/tunnel_name"},"remote_config":{"$ref":"#/components/schemas/remote_config"},"status":{"$ref":"#/components/schemas/cloudflare-tunnel_components-schemas-status"},"tun_type":{"$ref":"#/components/schemas/tunnel_type"}}},"tunnel_add_single_request":{"type":"object","required":["name","customer_gre_endpoint","cloudflare_gre_endpoint","interface_address"],"properties":{"cloudflare_gre_endpoint":{"$ref":"#/components/schemas/cloudflare_gre_endpoint"},"customer_gre_endpoint":{"$ref":"#/components/schemas/customer_gre_endpoint"},"description":{"$ref":"#/components/schemas/gre-tunnel_components-schemas-description"},"health_check":{"$ref":"#/components/schemas/health_check"},"interface_address":{"$ref":"#/components/schemas/interface_address"},"mtu":{"$ref":"#/components/schemas/mtu"},"name":{"$ref":"#/components/schemas/gre-tunnel_components-schemas-name"},"ttl":{"$ref":"#/components/schemas/components-schemas-ttl"}}},"tunnel_connection":{"type":"object","description":"A connection between cloudflared and a Cloudflare data center.","properties":{"arch":{"$ref":"#/components/schemas/arch"},"config_version":{"$ref":"#/components/schemas/config_version"},"conns":{"$ref":"#/components/schemas/connections"},"features":{"$ref":"#/components/schemas/schemas-features"},"id":{"$ref":"#/components/schemas/connection_id"},"run_at":{"$ref":"#/components/schemas/run_at"},"version":{"$ref":"#/components/schemas/cloudflare-tunnel_components-schemas-version"}}},"tunnel_connections_response":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"type":"object","properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/tunnel_connection"}}}}]},"tunnel_deleted_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"properties":{"deleted":{"type":"boolean","example":true},"deleted_gre_tunnel":{"type":"object"}}}}}]},"tunnel_health_check":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Determines whether to run healthchecks for a tunnel.","default":true,"example":true},"target":{"type":"string","description":"The address used to run healthchecks for a tunnel. This field defaults to `customer_gre_endpoint address`.","example":"203.0.113.1"},"type":{"type":"string","description":"The type of healthcheck to run, reply or request. The default value is `reply`.","enum":["reply","request"],"default":"reply","example":"request"}}},"tunnel_id":{"type":"string","description":"UUID of the tunnel.","example":"f70ff985-a4ef-4643-bbbc-4a0ed4fc8415","readOnly":true,"maxLength":36},"tunnel_modified_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"properties":{"modified":{"type":"boolean","example":true},"modified_gre_tunnel":{"type":"object"}}}}}]},"tunnel_name":{"type":"string","description":"A user-friendly name for the tunnel.","example":"blog"},"tunnel_response_collection":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"type":"object","properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/argo-tunnel"}}}}]},"tunnel_response_single":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"type":"object","properties":{"result":{"type":"object"}}}]},"tunnel_response_token":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"type":"object","properties":{"result":{"type":"string"}}}]},"tunnel_secret":{"type":"string","description":"Sets the password required to run a locally-managed tunnel. Must be at least 32 bytes and encoded as a base64 string.","example":"AQIDBAUGBwgBAgMEBQYHCAECAwQFBgcIAQIDBAUGBwg="},"tunnel_single_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"properties":{"gre_tunnel":{"type":"object"}}}}}]},"tunnel_type":{"type":"string","description":"The type of tunnel.","enum":["cfd_tunnel"],"example":"cfd_tunnel"},"tunnel_update_request":{"allOf":[{"$ref":"#/components/schemas/tunnel_add_single_request"}]},"tunnels_collection_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"properties":{"gre_tunnels":{"type":"array","items":{"$ref":"#/components/schemas/gre-tunnel"}}}}}}]},"tus_resumable":{"type":"string","description":"Specifies the TUS protocol version. This value must be included in every upload request.\nNotes: The only supported version of TUS protocol is 1.0.0.","enum":["1.0.0"],"example":"1.0.0"},"two_factor_authentication_enabled":{"type":"boolean","description":"Indicates whether two-factor authentication is enabled for the user account. Does not apply to API authentication.","default":false,"readOnly":true},"type":{"type":"string","description":"The billing item type.","example":"charge","readOnly":true,"maxLength":30},"ua-rules":{"allOf":[{"$ref":"#/components/schemas/firewalluablock"}],"type":"object"},"ua-rules_components-schemas-description":{"type":"string","description":"An informative summary of the rule.","example":"Prevent access from abusive clients identified by this User Agent to mitigate a DDoS attack","maxLength":1024},"ua-rules_components-schemas-id":{"type":"string","description":"The unique identifier of the User Agent Blocking rule.","example":"372e67954025e0ba6aaa6d586b9e0b59","readOnly":true,"maxLength":32},"ua-rules_components-schemas-mode":{"description":"The action to apply to a matched request.","enum":["block","challenge","js_challenge","managed_challenge"],"example":"js_challenge","maxLength":12},"uid":{"description":"The unique API identifier for the user."},"uniques":{"type":"object","properties":{"all":{"type":"integer","description":"Total number of unique IP addresses within the time range."}}},"unit_price":{"type":"number","description":"The unit price of the addon.","example":1,"readOnly":true},"universal":{"type":"object","properties":{"enabled":{"$ref":"#/components/schemas/components-schemas-enabled"}}},"unrevoke_devices_request":{"type":"array","description":"A list of device ids to unrevoke.","maxLength":200,"items":{"$ref":"#/components/schemas/uuid"}},"until":{"anyOf":[{"type":"string"},{"type":"integer"}],"description":"The (exclusive) end of the requested time frame. This value can be a negative integer representing the number of minutes in the past relative to time the request is made, or can be an absolute timestamp that conforms to RFC 3339. If omitted, the time of the request is used.","default":0,"example":"2015-01-02T12:23:00Z"},"update-zone-settings-response":{"properties":{"enabled":{"$ref":"#/components/schemas/script-monitor_components-schemas-enabled"},"updated_at":{"$ref":"#/components/schemas/schemas-updated_at"},"use_cloudflare_reporting_endpoint":{"$ref":"#/components/schemas/use_cloudflare_reporting_endpoint"},"use_connection_url_path":{"$ref":"#/components/schemas/use_connection_url_path"}}},"update_catch_all_rule_properties":{"type":"object","required":["actions","matchers"],"properties":{"actions":{"$ref":"#/components/schemas/catchall-actions"},"enabled":{"$ref":"#/components/schemas/rules_components-schemas-enabled"},"matchers":{"$ref":"#/components/schemas/catchall-matchers"},"name":{"$ref":"#/components/schemas/rules_components-schemas-name"}}},"update_custom_profile":{"type":"object","title":"Update custom profile","properties":{"description":{"type":"string","description":"The description of the profile.","example":"A standard CVV card number"},"entries":{"type":"array","description":"The entries for this profile. Array elements with IDs are modifying the existing entry with that ID. Elements without ID will create new entries. Any entry not in the list will be deleted.","items":{"$ref":"#/components/schemas/custom_entry"}},"name":{"type":"string","description":"The name of the profile.","example":"Generic CVV Card Number"}}},"update_input_request":{"properties":{"defaultCreator":{"$ref":"#/components/schemas/live_input_default_creator"},"meta":{"$ref":"#/components/schemas/live_input_metadata"},"recording":{"$ref":"#/components/schemas/live_input_recording_settings"}}},"update_output_request":{"required":["enabled"],"properties":{"enabled":{"$ref":"#/components/schemas/output_enabled"}}},"update_predefined_profile":{"type":"object","title":"Update predefined profile","properties":{"entries":{"type":"array","description":"The entries for this profile.","items":{"properties":{"enabled":{"type":"boolean","description":"Wheter the entry is enabled or not.","example":true},"id":{"$ref":"#/components/schemas/entry_id"}}}}}},"update_rule_properties":{"type":"object","required":["actions","matchers"],"properties":{"actions":{"$ref":"#/components/schemas/actions"},"enabled":{"$ref":"#/components/schemas/rules_components-schemas-enabled"},"matchers":{"$ref":"#/components/schemas/matchers"},"name":{"$ref":"#/components/schemas/rules_components-schemas-name"},"priority":{"$ref":"#/components/schemas/components-schemas-priority"}}},"update_rules":{"type":"array","items":{"$ref":"#/components/schemas/create_rule"}},"update_ruleset":{"type":"object","description":"A ruleset object.","required":["rules"],"properties":{"description":{"$ref":"#/components/schemas/rulesets_components-schemas-description"},"rules":{"$ref":"#/components/schemas/create_update_rules"}}},"updated":{"type":"string","format":"date-time","description":"When the device was updated.","example":"2017-06-14T00:00:00Z"},"updated_at":{"type":"string","format":"date-time","description":"The time when the certificate was updated.","example":"2100-01-01T05:20:00Z","readOnly":true},"upgrade_info":{"type":"object","description":"Defined when the Railgun version is out of date from the latest release from Cloudflare.","properties":{"download_link":{"type":"string","description":"An HTTP link to download the latest Railgun binary.","example":"https://www.cloudflare.com/downloads/railgun"},"latest_version":{"type":"string","description":"Latest version of the Railgun receiver available to install.","example":"1.0.0"}}},"upload_length":{"type":"integer","description":"Indicates the size of the entire upload in bytes. The value must be a non-negative integer.","minimum":0},"uploaded":{"type":"string","format":"date-time","description":"The date and time the media item was uploaded.","example":"2014-01-02T02:20:00Z","readOnly":true},"uploaded_on":{"type":"string","format":"date-time","description":"When the certificate was uploaded to Cloudflare.","example":"2014-01-01T05:20:00Z","readOnly":true},"uptycs_config_request":{"type":"object","required":["client_key","customer_id","client_secret"],"properties":{"client_key":{"type":"string","description":"The Uptycs client secret.","example":"example client key"},"client_secret":{"type":"string","description":"The Uptycs client secret.","example":"example client secret"},"customer_id":{"type":"string","description":"The Uptycs customer ID.","example":"example customer id"}}},"url":{"type":"string","format":"uri","description":"The URL associated with the custom page.","default":"","example":"http://www.example.com"},"url_normalization_components-schemas-type":{"type":"string","description":"The type of URL normalization performed by Cloudflare.","example":"cloudflare"},"url_param":{"type":"object","properties":{"url":{"$ref":"#/components/schemas/components-schemas-url"}}},"url_target":{"type":"object","description":"URL target.","properties":{"constraint":{"allOf":[{"$ref":"#/components/schemas/string_constraint"},{"properties":{"value":{"type":"string","description":"The URL pattern to match against the current request. The pattern may contain up to four asterisks ('*') as placeholders.","example":"*example.com/images/*","pattern":"^(https?://)?(([-a-zA-Z0-9*]*\\.)+[-a-zA-Z0-9]{2,20})(:(8080|8443|443|80))?(/[\\S]+)?$"}}}],"type":"object","description":"The constraint of a target."},"target":{"description":"A target based on the URL of the request.","enum":["url"],"example":"url"}}},"urls":{"type":"array","description":"The URLs to include in the current WAF override. You can use wildcards. Each entered URL will be escaped before use, which means you can only use simple wildcard patterns.","items":{"type":"string","example":"shop.example.com/*"}},"usage-model-response":{"allOf":[{"$ref":"#/components/schemas/api-response-common"},{"properties":{"result":{"type":"object","properties":{"usage_model":{"readOnly":true}}}}}]},"use_cloudflare_reporting_endpoint":{"type":"boolean","description":"When true, CSP reports will be sent to https://csp-reporting.cloudflare.com/cdn-cgi/script_monitor/report","example":true},"use_connection_url_path":{"type":"boolean","description":"When true, the paths associated with connections URLs will also be analyzed.","example":true},"user":{"type":"object","properties":{"email":{"$ref":"#/components/schemas/email"},"id":{"$ref":"#/components/schemas/uuid"},"name":{"type":"string","description":"The enrolled device user's name.","example":"John Appleseed"}}},"user_invite":{"allOf":[{"$ref":"#/components/schemas/base"},{"properties":{"status":{"description":"Current status of the invitation.","enum":["pending","accepted","rejected","expired"],"example":"accepted"}}}]},"user_subscription_response_collection":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"type":"object","properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/subscription"}}}}]},"user_subscription_response_single":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"type":"object","properties":{"result":{"type":"object"}}}]},"users":{"type":"object","properties":{"access_seat":{"$ref":"#/components/schemas/schemas-access_seat"},"active_device_count":{"$ref":"#/components/schemas/active_device_count"},"created_at":{"$ref":"#/components/schemas/timestamp"},"email":{"$ref":"#/components/schemas/components-schemas-email"},"gateway_seat":{"$ref":"#/components/schemas/schemas-gateway_seat"},"id":{"$ref":"#/components/schemas/users_components-schemas-id"},"last_successful_login":{"$ref":"#/components/schemas/last_successful_login"},"name":{"$ref":"#/components/schemas/users_components-schemas-name"},"seat_uid":{"$ref":"#/components/schemas/seat_uid"},"uid":{"$ref":"#/components/schemas/uid"},"updated_at":{"$ref":"#/components/schemas/timestamp"}}},"users_components-schemas-id":{"description":"The ID of the user.","example":"f3b12456-80dd-4e89-9f5f-ba3dfff12365"},"users_components-schemas-identifier":{"example":"699d98642c564d2e855e9661899b7252"},"users_components-schemas-name":{"type":"string","description":"The name of the user.","example":"Jane Doe"},"users_components-schemas-response_collection":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result_info":{"type":"object","properties":{"count":{"example":1},"page":{"example":1},"per_page":{"example":100},"total_count":{"example":1}}}}},{"properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/users"}}}}]},"uuid":{"type":"string","description":"UUID","example":"f174e90a-fafe-4643-bbbc-4a0ed4fc8415","readOnly":true,"maxLength":36},"validate_ownership_response":{"allOf":[{"$ref":"#/components/schemas/api-response-common"},{"properties":{"result":{"type":"object","nullable":true,"properties":{"valid":{"type":"boolean","example":true}}}}}]},"validate_pattern":{"type":"object","title":"Pattern","description":"A request to validate a pattern","required":["regex"],"properties":{"regex":{"type":"string","description":"The regex pattern.","example":"^4[0-9]{6,}$"}}},"validate_response":{"allOf":[{"$ref":"#/components/schemas/api-response-common"},{"properties":{"result":{"type":"object","nullable":true,"properties":{"message":{"type":"string","example":""},"valid":{"type":"boolean","example":true}}}}}]},"validation_method":{"type":"string","description":"Validation Method selected for the order.","enum":["txt","http","email"],"example":"txt"},"validation_method_components-schemas-status":{"type":"string","description":"Result status.","example":"pending_validation"},"validation_method_definition":{"type":"string","description":"Desired validation method.","enum":["http","cname","txt","email"],"example":"txt"},"validation_record":{"type":"object","description":"Certificate's required validation record.","properties":{"emails":{"type":"array","description":"The set of email addresses that the certificate authority (CA) will use to complete domain validation.","example":["administrator@example.com","webmaster@example.com"],"items":{}},"http_body":{"type":"string","description":"The content that the certificate authority (CA) will expect to find at the http_url during the domain validation.","example":"ca3-574923932a82475cb8592200f1a2a23d"},"http_url":{"type":"string","description":"The url that will be checked during domain validation.","example":"http://app.example.com/.well-known/pki-validation/ca3-da12a1c25e7b48cf80408c6c1763b8a2.txt"},"txt_name":{"type":"string","description":"The hostname that the certificate authority (CA) will check for a TXT record during domain validation .","example":"_acme-challenge.app.example.com"},"txt_value":{"type":"string","description":"The TXT record that the certificate authority (CA) will check during domain validation.","example":"810b7d5f01154524b961ba0cd578acc2"}}},"validity_days":{"type":"integer","description":"Validity Days selected for the order.","enum":[14,30,90,365]},"value":{"type":"string","description":"The token value.","example":"8M7wS6hCpXVc-DoRnPPY_UCWPgy8aea4Wy6kCe5T","readOnly":true,"minLength":40,"maxLength":80},"vanity_name_servers":{"type":"array","description":"An array of domains used for custom name servers. This is only\navailable for Business and Enterprise plans.","example":["ns1.example.com","ns2.example.com"],"items":{"type":"string","format":"hostname","maxLength":253}},"variant_generation_request":{"type":"object","required":["id","options"],"properties":{"id":{"$ref":"#/components/schemas/variants_components-schemas-identifier"},"neverRequireSignedURLs":{"$ref":"#/components/schemas/neverRequireSignedURLs"},"options":{"$ref":"#/components/schemas/options"}}},"variant_list_response":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"$ref":"#/components/schemas/variants_response"}}}]},"variant_patch_request":{"type":"object","required":["options"],"properties":{"neverRequireSignedURLs":{"$ref":"#/components/schemas/neverRequireSignedURLs"},"options":{"$ref":"#/components/schemas/options"}}},"variant_public_request":{"type":"object","properties":{"hero":{"type":"object"}}},"variant_response":{"type":"object","properties":{"variant":{"type":"object"}}},"variant_simple_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/variant_response"}}}]},"variants":{"allOf":[{"$ref":"#/components/schemas/components-schemas-base"},{"properties":{"id":{"description":"ID of the zone setting.","enum":["variants"],"example":"variants"}}}],"title":"Variants Caching","description":"Variant support enables caching variants of images with certain file extensions in addition to the original. This only applies when the origin server sends the 'Vary: Accept' response header. If the origin server sends 'Vary: Accept' but does not serve the variant requested, the response will not be cached. This will be indicated with BYPASS cache status in the response headers."},"variants_components-schemas-identifier":{"example":"hero","maxLength":99,"pattern":"^[a-zA-Z0-9]$"},"variants_response":{"type":"object","properties":{"variants":{"$ref":"#/components/schemas/variant_public_request"}}},"variants_response_value":{"properties":{"result":{"allOf":[{"$ref":"#/components/schemas/variants"},{"required":["value"],"properties":{"value":{"$ref":"#/components/schemas/variants_value"}}}]}}},"variants_value":{"type":"object","description":"Value of the zone setting.","properties":{"avif":{"type":"array","description":"List of strings with the MIME types of all the variants that should be served for avif.","example":["image/webp","image/jpeg"],"uniqueItems":true,"items":{}},"bmp":{"type":"array","description":"List of strings with the MIME types of all the variants that should be served for bmp.","example":["image/webp","image/jpeg"],"uniqueItems":true,"items":{}},"gif":{"type":"array","description":"List of strings with the MIME types of all the variants that should be served for gif.","example":["image/webp","image/jpeg"],"uniqueItems":true,"items":{}},"jp2":{"type":"array","description":"List of strings with the MIME types of all the variants that should be served for jp2.","example":["image/webp","image/avif"],"uniqueItems":true,"items":{}},"jpeg":{"type":"array","description":"List of strings with the MIME types of all the variants that should be served for jpeg.","example":["image/webp","image/avif"],"uniqueItems":true,"items":{}},"jpg":{"type":"array","description":"List of strings with the MIME types of all the variants that should be served for jpg.","example":["image/webp","image/avif"],"uniqueItems":true,"items":{}},"jpg2":{"type":"array","description":"List of strings with the MIME types of all the variants that should be served for jpg2.","example":["image/webp","image/avif"],"uniqueItems":true,"items":{}},"png":{"type":"array","description":"List of strings with the MIME types of all the variants that should be served for png.","example":["image/webp","image/avif"],"uniqueItems":true,"items":{}},"tif":{"type":"array","description":"List of strings with the MIME types of all the variants that should be served for tif.","example":["image/webp","image/avif"],"uniqueItems":true,"items":{}},"tiff":{"type":"array","description":"List of strings with the MIME types of all the variants that should be served for tiff.","example":["image/webp","image/avif"],"uniqueItems":true,"items":{}},"webp":{"type":"array","description":"List of strings with the MIME types of all the variants that should be served for webp.","example":["image/jpeg","image/avif"],"uniqueItems":true,"items":{}}}},"verification":{"type":"object","required":["certificate_status"],"properties":{"brand_check":{"$ref":"#/components/schemas/brand_check"},"cert_pack_uuid":{"$ref":"#/components/schemas/cert_pack_uuid"},"certificate_status":{"$ref":"#/components/schemas/certificate_status"},"signature":{"$ref":"#/components/schemas/schemas-signature"},"validation_method":{"$ref":"#/components/schemas/schemas-validation_method"},"verification_info":{"$ref":"#/components/schemas/verification_info"},"verification_status":{"$ref":"#/components/schemas/verification_status"},"verification_type":{"$ref":"#/components/schemas/verification_type"}}},"verification_errors":{"type":"array","description":"These are errors that were encountered while trying to activate a hostname.","example":["None of the A or AAAA records are owned by this account and the pre-generated ownership verification token was not found."],"items":{}},"verification_info":{"type":"object","description":"Certificate's required verification information.","enum":["record_name","record_value","http_url","http_body","cname","cname_target","txt_name","txt_value"],"properties":{"record_name":{"type":"string","format":"hostname","description":"Name of CNAME record.","example":"b3b90cfedd89a3e487d3e383c56c4267.example.com"},"record_target":{"type":"string","format":"hostname","description":"Target of CNAME record.","example":"6979be7e4cfc9e5c603e31df7efac9cc60fee82d.comodoca.com"}}},"verification_status":{"type":"boolean","description":"Status of the required verification information, omitted if verification status is unknown.","example":true},"verification_type":{"type":"string","description":"Method of verification.","enum":["cname","meta tag"],"example":"cname"},"verified":{"type":"string","format":"date-time","description":"The date and time the destination address has been verified. Null means not verified yet.","example":"2014-01-02T02:20:00Z","readOnly":true},"version":{"type":"string","description":"The version of the ruleset.","example":"1","pattern":"^[0-9]+$"},"video_copy_request":{"required":["url"],"properties":{"allowedOrigins":{"$ref":"#/components/schemas/allowedOrigins"},"creator":{"$ref":"#/components/schemas/creator"},"requireSignedURLs":{"$ref":"#/components/schemas/requireSignedURLs"},"thumbnailTimestampPct":{"$ref":"#/components/schemas/thumbnailTimestampPct"},"url":{"type":"string","format":"uri","description":"A video's URL. The server must be publicly routable and support `HTTP HEAD` requests and `HTTP GET` range requests. The server should respond to `HTTP HEAD` requests with a `content-range` header that includes the size of the file.","example":"https://example.com/myvideo.mp4"},"watermark":{"$ref":"#/components/schemas/watermark_at_upload"}}},"video_identifier":{"type":"string","description":"A unique identifier for the MP4 file.","example":"ea95132c15732412d22c1476fa83f27a","readOnly":true,"maxLength":32},"video_response_collection":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/videos"}}}},{"properties":{"range":{"type":"integer","description":"The total number of remaining videos based on cursor position.","example":1000,"readOnly":true},"total":{"type":"integer","description":"The total number of videos that match the provided filters.","example":35586,"readOnly":true}}}]},"video_response_single":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"type":"object"}}}]},"videoClipStandard":{"type":"object","required":["clippedFromVideoUID","startTimeSeconds","endTimeSeconds"],"properties":{"allowedOrigins":{"$ref":"#/components/schemas/allowedOrigins"},"clippedFromVideoUID":{"$ref":"#/components/schemas/clipped_from_video_uid"},"creator":{"$ref":"#/components/schemas/creator"},"endTimeSeconds":{"$ref":"#/components/schemas/end_time_seconds"},"maxDurationSeconds":{"$ref":"#/components/schemas/schemas-maxDurationSeconds"},"requireSignedURLs":{"$ref":"#/components/schemas/requireSignedURLs"},"startTimeSeconds":{"$ref":"#/components/schemas/start_time_seconds"},"thumbnailTimestampPct":{"$ref":"#/components/schemas/thumbnailTimestampPct"},"watermark":{"$ref":"#/components/schemas/watermarkAtUpload"}}},"videos":{"type":"object","properties":{"allowedOrigins":{"$ref":"#/components/schemas/allowedOrigins"},"created":{"$ref":"#/components/schemas/schemas-created"},"creator":{"$ref":"#/components/schemas/creator"},"duration":{"$ref":"#/components/schemas/schemas-duration"},"input":{"$ref":"#/components/schemas/input"},"liveInput":{"$ref":"#/components/schemas/liveInput"},"maxDurationSeconds":{"$ref":"#/components/schemas/maxDurationSeconds"},"meta":{"$ref":"#/components/schemas/media_metadata"},"modified":{"$ref":"#/components/schemas/schemas-modified"},"nft":{"$ref":"#/components/schemas/nft"},"playback":{"$ref":"#/components/schemas/playback"},"preview":{"$ref":"#/components/schemas/preview"},"readyToStream":{"$ref":"#/components/schemas/readyToStream"},"requireSignedURLs":{"$ref":"#/components/schemas/requireSignedURLs"},"size":{"$ref":"#/components/schemas/size"},"status":{"$ref":"#/components/schemas/media_status"},"thumbnail":{"$ref":"#/components/schemas/thumbnail_url"},"thumbnailTimestampPct":{"$ref":"#/components/schemas/thumbnailTimestampPct"},"uid":{"$ref":"#/components/schemas/videos_components-schemas-identifier"},"uploadExpiry":{"$ref":"#/components/schemas/oneTimeUploadExpiry"},"uploaded":{"$ref":"#/components/schemas/uploaded"},"watermark":{"$ref":"#/components/schemas/watermarks"}}},"videos_components-schemas-identifier":{"type":"string","description":"A Cloudflare-generated unique identifier for a media item.","example":"ea95132c15732412d22c1476fa83f27a","readOnly":true,"maxLength":32},"virtual-dns":{"type":"object","required":["id","name","origin_ips","virtual_dns_ips","minimum_cache_ttl","maximum_cache_ttl","deprecate_any_requests","ecs_fallback","modified_on"],"properties":{"deprecate_any_requests":{"$ref":"#/components/schemas/deprecate_any_requests"},"ecs_fallback":{"$ref":"#/components/schemas/ecs_fallback"},"id":{"$ref":"#/components/schemas/common_components-schemas-identifier"},"maximum_cache_ttl":{"$ref":"#/components/schemas/maximum_cache_ttl"},"minimum_cache_ttl":{"$ref":"#/components/schemas/minimum_cache_ttl"},"modified_on":{"$ref":"#/components/schemas/schemas-modified_on"},"name":{"$ref":"#/components/schemas/virtual-dns_components-schemas-name"},"negative_cache_ttl":{"$ref":"#/components/schemas/schemas-negative_cache_ttl"},"origin_ips":{"$ref":"#/components/schemas/origin_ips"},"ratelimit":{"$ref":"#/components/schemas/schemas-ratelimit"},"virtual_dns_ips":{"$ref":"#/components/schemas/virtual_dns_ips"}}},"virtual-dns_components-schemas-name":{"type":"string","description":"DNS Firewall Cluster Name.","example":"My Awesome DNS Firewall cluster","maxLength":160},"virtual-network":{"type":"object","required":["id","name","is_default_network","comment","created_at"],"properties":{"comment":{"$ref":"#/components/schemas/schemas-comment"},"created_at":{"description":"Timestamp of when the virtual network was created."},"deleted_at":{"description":"Timestamp of when the virtual network was deleted. If `null`, the virtual network has not been deleted."},"id":{"$ref":"#/components/schemas/vnet_id"},"is_default_network":{"$ref":"#/components/schemas/is_default_network"},"name":{"$ref":"#/components/schemas/vnet_name"}}},"virtual_dns_ips":{"type":"array","example":["203.0.113.1","203.0.113.254","2001:DB8:AB::CF","2001:DB8:CD::CF"],"items":{"anyOf":[{"type":"string","format":"ipv4","description":"Origin DNS Server IPv4 Address.","example":"203.0.113.1"},{"type":"string","format":"ipv6","description":"Origin DNS Server IPv6 Address.","example":"2001:DB8:ab::CF"}]}},"virtual_dns_response_collection":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/virtual-dns"}}}}]},"virtual_dns_single_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/virtual-dns"}}}]},"virtual_network_id":{"description":"UUID of the Tunnel Virtual Network this route belongs to. If no virtual networks are configured, the route is assigned to the default virtual network of the account."},"vnc_props":{"allOf":[{"$ref":"#/components/schemas/self_hosted_props"},{"properties":{"type":{"type":"string","description":"The application type.","example":"vnc"}}}]},"vnet_id":{"type":"string","description":"UUID of the virtual network.","example":"f70ff985-a4ef-4643-bbbc-4a0ed4fc8415","readOnly":true,"maxLength":36},"vnet_name":{"type":"string","description":"A user-friendly name for the virtual network.","example":"us-east-1-vpc"},"vnet_response_collection":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"type":"object","properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/virtual-network"}}}}]},"vnet_response_single":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"type":"object","properties":{"result":{"type":"object"}}}]},"waf":{"allOf":[{"$ref":"#/components/schemas/schemas-base"},{"properties":{"id":{"description":"ID of the zone setting.","enum":["waf"],"example":"waf"},"value":{"$ref":"#/components/schemas/waf_value"}}}],"title":"Web Application Firewall","description":"The WAF examines HTTP requests to your website. It inspects both GET and POST requests and applies rules to help filter out illegitimate traffic from legitimate website visitors. The Cloudflare WAF inspects website addresses or URLs to detect anything out of the ordinary. If the Cloudflare WAF determines suspicious user behavior, then the WAF will 'challenge' the web visitor with a page that asks them to submit a CAPTCHA successfully to continue their action. If the challenge is failed, the action will be stopped. What this means is that Cloudflare's WAF will block any traffic identified as illegitimate before it reaches your origin web server. (https://support.cloudflare.com/hc/en-us/articles/200172016)."},"waf_action":{"description":"The WAF rule action to apply.","enum":["challenge","block","simulate","disable","default"]},"waf_rewrite_action":{"description":"The WAF rule action to apply.","enum":["challenge","block","simulate","disable","default"]},"waf_value":{"type":"string","description":"Value of the zone setting.","enum":["on","off"],"default":"off"},"wait_time":{"type":"integer","description":"Set the time (in seconds) to wait for a response to a probe.","default":1,"minimum":1,"maximum":5},"waiting_room_id":{"example":"699d98642c564d2e855e9661899b7252"},"waiting_room_id_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/waiting_room_id"}}}}}]},"waitingroom":{"type":"object","properties":{"cookie_attributes":{"$ref":"#/components/schemas/cookie_attributes"},"created_on":{"$ref":"#/components/schemas/timestamp"},"custom_page_html":{"$ref":"#/components/schemas/custom_page_html"},"default_template_language":{"$ref":"#/components/schemas/default_template_language"},"description":{"$ref":"#/components/schemas/waitingroom_components-schemas-description"},"disable_session_renewal":{"$ref":"#/components/schemas/disable_session_renewal"},"host":{"$ref":"#/components/schemas/components-schemas-host"},"id":{"$ref":"#/components/schemas/waiting_room_id"},"json_response_enabled":{"$ref":"#/components/schemas/json_response_enabled"},"modified_on":{"$ref":"#/components/schemas/timestamp"},"name":{"$ref":"#/components/schemas/waitingroom_components-schemas-name"},"new_users_per_minute":{"$ref":"#/components/schemas/new_users_per_minute"},"next_event_prequeue_start_time":{"$ref":"#/components/schemas/next_event_prequeue_start_time"},"next_event_start_time":{"$ref":"#/components/schemas/next_event_start_time"},"path":{"$ref":"#/components/schemas/schemas-path"},"queue_all":{"$ref":"#/components/schemas/queue_all"},"queueing_method":{"$ref":"#/components/schemas/queueing_method"},"session_duration":{"$ref":"#/components/schemas/schemas-session_duration"},"suspended":{"$ref":"#/components/schemas/schemas-suspended"},"total_active_users":{"$ref":"#/components/schemas/total_active_users"}}},"waitingroom_components-schemas-description":{"type":"string","description":"A note that you can use to add more details about the waiting room.","default":"","example":"Production - DO NOT MODIFY"},"waitingroom_components-schemas-name":{"type":"string","description":"A unique name to identify the waiting room. Only alphanumeric characters, hyphens and underscores are allowed.","example":"production_webinar"},"waitingroom_components-schemas-response_collection":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/waitingroom"}}}}]},"waitingroom_components-schemas-single_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/waitingroom"}}}]},"waitingroom_components-schemas-status":{"type":"string","enum":["event_prequeueing","not_queueing","queueing"],"example":"queueing"},"warp_props":{"allOf":[{"$ref":"#/components/schemas/feature_app_props"},{"properties":{"domain":{"example":"authdomain.cloudflareaccess.com/warp","readOnly":true},"name":{"default":"Warp Login App","example":"Warp Login App","readOnly":true},"type":{"type":"string","description":"The application type.","example":"warp"}}}]},"wasm_module_binding":{"type":"object","required":["name","type"],"properties":{"name":{"$ref":"#/components/schemas/binding_name"},"type":{"type":"string","description":"The class of resource that the binding provides.","enum":["wasm_module"],"example":"wasm_module"}}},"watermark_at_upload":{"type":"object","properties":{"uid":{"type":"string","description":"The unique identifier for the watermark profile.","example":"ea95132c15732412d22c1476fa83f27a","maxLength":32}}},"watermark_basic_upload":{"type":"object","required":["file"],"properties":{"file":{"type":"string","description":"The image file to upload.","example":"@/Users/rchen/Downloads/watermark.png"},"name":{"$ref":"#/components/schemas/watermarks_components-schemas-name"},"opacity":{"$ref":"#/components/schemas/opacity"},"padding":{"$ref":"#/components/schemas/padding"},"position":{"$ref":"#/components/schemas/position"},"scale":{"$ref":"#/components/schemas/scale"}}},"watermark_response_collection":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/watermarks"}}}}]},"watermark_response_single":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"type":"object"}}}]},"watermarkAtUpload":{"type":"object","properties":{"uid":{"type":"string","description":"The unique identifier for the watermark profile.","example":"ea95132c15732412d22c1476fa83f27a","maxLength":32}}},"watermarks":{"type":"object","properties":{"created":{"$ref":"#/components/schemas/components-schemas-created"},"downloadedFrom":{"$ref":"#/components/schemas/downloadedFrom"},"height":{"$ref":"#/components/schemas/height"},"name":{"$ref":"#/components/schemas/watermarks_components-schemas-name"},"opacity":{"$ref":"#/components/schemas/opacity"},"padding":{"$ref":"#/components/schemas/padding"},"position":{"$ref":"#/components/schemas/position"},"scale":{"$ref":"#/components/schemas/scale"},"size":{"$ref":"#/components/schemas/schemas-size"},"uid":{"$ref":"#/components/schemas/watermarks_components-schemas-identifier"},"width":{"$ref":"#/components/schemas/width"}}},"watermarks_components-schemas-identifier":{"type":"string","description":"The unique identifier for a watermark profile.","example":"ea95132c15732412d22c1476fa83f27a","readOnly":true,"maxLength":32},"watermarks_components-schemas-name":{"type":"string","description":"A short description of the watermark profile.","default":"","example":"Marketing Videos","readOnly":true},"web3-hostname":{"type":"object","properties":{"created_on":{"$ref":"#/components/schemas/timestamp"},"description":{"$ref":"#/components/schemas/web3-hostname_components-schemas-description"},"dnslink":{"$ref":"#/components/schemas/dnslink"},"id":{"$ref":"#/components/schemas/common_components-schemas-identifier"},"modified_on":{"$ref":"#/components/schemas/timestamp"},"name":{"$ref":"#/components/schemas/web3-hostname_components-schemas-name"},"status":{"$ref":"#/components/schemas/web3-hostname_components-schemas-status"},"target":{"$ref":"#/components/schemas/components-schemas-target"}}},"web3-hostname_components-schemas-description":{"type":"string","description":"An optional description of the hostname.","example":"This is my IPFS gateway.","maxLength":500},"web3-hostname_components-schemas-name":{"type":"string","description":"The hostname that will point to the target gateway via CNAME.","example":"gateway.example.com","readOnly":true,"maxLength":255},"web3-hostname_components-schemas-single_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/web3-hostname"}}}]},"web3-hostname_components-schemas-status":{"type":"string","description":"Status of the hostname's activation.","enum":["active","pending","deleting","error"],"example":"active","readOnly":true},"webhook_components-schemas-account_identifier":{"type":"string","description":"Account identifier tag.","example":"023e105f4ecef8ad9ca31a8372d0c353","readOnly":true,"maxLength":32},"webhook_request":{"required":["notificationUrl"],"properties":{"notificationUrl":{"$ref":"#/components/schemas/notificationUrl"}}},"webhook_response_single":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"type":"object"}}}]},"webhooks":{"type":"object","properties":{"created_at":{"$ref":"#/components/schemas/webhooks_components-schemas-created_at"},"id":{"$ref":"#/components/schemas/uuid"},"last_failure":{"$ref":"#/components/schemas/last_failure"},"last_success":{"$ref":"#/components/schemas/last_success"},"name":{"$ref":"#/components/schemas/webhooks_components-schemas-name"},"secret":{"$ref":"#/components/schemas/schemas-secret"},"type":{"$ref":"#/components/schemas/webhooks_components-schemas-type"},"url":{"$ref":"#/components/schemas/webhooks_components-schemas-url"}}},"webhooks_components-schemas-created_at":{"type":"string","format":"date-time","description":"Timestamp of when the webhook destination was created.","example":"2020-10-26T18:25:04.532316Z","readOnly":true},"webhooks_components-schemas-id_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/uuid"}}}}}]},"webhooks_components-schemas-name":{"type":"string","description":"The name of the webhook destination. This will be included in the request body when you receive a webhook notification.","example":"Slack Webhook"},"webhooks_components-schemas-response_collection":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/webhooks"}}}}]},"webhooks_components-schemas-single_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/webhooks"}}}]},"webhooks_components-schemas-type":{"type":"string","description":"Type of webhook endpoint.","enum":["slack","generic","gchat"],"example":"slack"},"webhooks_components-schemas-url":{"type":"string","description":"The POST endpoint to call when dispatching a notification.","example":"https://hooks.slack.com/services/Ds3fdBFbV/456464Gdd"},"webp":{"allOf":[{"$ref":"#/components/schemas/schemas-base"},{"properties":{"id":{"description":"ID of the zone setting.","enum":["webp"],"example":"webp"},"value":{"$ref":"#/components/schemas/webp_value"}}}],"title":"Polish WebP Conversion","description":"When the client requesting the image supports the WebP image codec, and WebP offers a performance advantage over the original image format, Cloudflare will serve a WebP version of the original image."},"webp_value":{"type":"string","description":"Value of the zone setting.","enum":["off","on"],"default":"off"},"websockets":{"allOf":[{"$ref":"#/components/schemas/schemas-base"},{"properties":{"id":{"description":"ID of the zone setting.","enum":["websockets"],"example":"websockets"},"value":{"$ref":"#/components/schemas/websockets_value"}}}],"title":"WebSockets","description":"WebSockets are open connections sustained between the client and the origin server. Inside a WebSockets connection, the client and the origin can pass data back and forth without having to reestablish sessions. This makes exchanging data within a WebSockets connection fast. WebSockets are often used for real-time applications such as live chat and gaming. For more information refer to [Can I use Cloudflare with Websockets](https://support.cloudflare.com/hc/en-us/articles/200169466-Can-I-use-Cloudflare-with-WebSockets-)."},"websockets_value":{"type":"string","description":"Value of the zone setting.","enum":["off","on"],"default":"off"},"weight":{"type":"number","description":"The weight of this origin relative to other origins in the pool. Based on the configured weight the total traffic is distributed among origins within the pool.","default":1,"example":0.6,"minimum":0,"maximum":1,"multipleOf":0.01},"whois":{"properties":{"created_date":{"type":"string","format":"date","example":"2009-02-17"},"domain":{"$ref":"#/components/schemas/schemas-domain_name"},"nameservers":{"type":"array","example":["ns3.cloudflare.com","ns4.cloudflare.com","ns5.cloudflare.com","ns6.cloudflare.com","ns7.cloudflare.com"],"items":{"type":"string"}},"registrant":{"type":"string","example":"DATA REDACTED"},"registrant_country":{"type":"string","example":"United States"},"registrant_email":{"type":"string","example":"https://domaincontact.cloudflareregistrar.com/cloudflare.com"},"registrant_org":{"type":"string","example":"DATA REDACTED"},"registrar":{"type":"string","example":"Cloudflare, Inc."},"updated_date":{"type":"string","format":"date","example":"2017-05-24"}}},"whois_components-schemas-single_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/whois"}}}]},"width":{"type":"integer","description":"The width of the image in pixels.","readOnly":true},"workspace_one_config_request":{"type":"object","required":["api_url","auth_url","client_id","client_secret"],"properties":{"api_url":{"type":"string","description":"The Workspace One API URL provided in the Workspace One Admin Dashboard.","example":"https://as123.awmdm.com/API"},"auth_url":{"type":"string","description":"The Workspace One Authorization URL depending on your region.","example":"https://na.uemauth.vmwservices.com/connect/token"},"client_id":{"type":"string","description":"The Workspace One client ID provided in the Workspace One Admin Dashboard.","example":"example client id"},"client_secret":{"type":"string","description":"The Workspace One client secret provided in the Workspace One Admin Dashboard.","example":"example client secret"}}},"workspace_one_config_response":{"type":"object","description":"The Workspace One Config Response.","required":["api_url","auth_url","client_id"],"properties":{"api_url":{"type":"string","description":"The Workspace One API URL provided in the Workspace One Admin Dashboard.","example":"https://as123.awmdm.com/API"},"auth_url":{"type":"string","description":"The Workspace One Authorization URL depending on your region.","example":"https://na.uemauth.vmwservices.com/connect/token"},"client_id":{"type":"string","description":"The Workspace One client ID provided in the Workspace One Admin Dashboard.","example":"example client id"}}},"zipcode":{"type":"string","description":"The zipcode or postal code where the user lives.","example":"12345","nullable":true,"maxLength":20},"zone":{"type":"object","description":"A simple zone object. May have null properties if not a zone subscription.","properties":{"id":{"$ref":"#/components/schemas/common_components-schemas-identifier"},"name":{"$ref":"#/components/schemas/properties-name"}}},"zone-authenticated-origin-pull":{"allOf":[{"$ref":"#/components/schemas/certificateObject"}],"type":"object","properties":{"certificate":{"$ref":"#/components/schemas/zone-authenticated-origin-pull_components-schemas-certificate"},"enabled":{"$ref":"#/components/schemas/zone-authenticated-origin-pull_components-schemas-enabled"},"id":{"$ref":"#/components/schemas/zone-authenticated-origin-pull_components-schemas-identifier"},"private_key":{"$ref":"#/components/schemas/private_key"}}},"zone-authenticated-origin-pull_components-schemas-certificate":{"type":"string","description":"The zone's leaf certificate.","example":"-----BEGIN CERTIFICATE-----\nMIIDtTCCAp2gAwIBAgIJAMHAwfXZ5/PWMA0GCSqGSIb3DQEBCwUAMEUxCzAJBgNV\nBAYTAkFVMRMwEQYDVQQIEwpTb21lLVN0YXRlMSEwHwYDVQQKExhJbnRlcm5ldCBX\naWRnaXRzIFB0eSBMdGQwHhcNMTYwODI0MTY0MzAxWhcNMTYxMTIyMTY0MzAxWjBF\nMQswCQYDVQQGEwJBVTETMBEGA1UECBMKU29tZS1TdGF0ZTEhMB8GA1UEChMYSW50\nZXJuZXQgV2lkZ2l0cyBQdHkgTHRkMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIB\nCgKCAQEAwQHoetcl9+5ikGzV6cMzWtWPJHqXT3wpbEkRU9Yz7lgvddmGdtcGbg/1\nCGZu0jJGkMoppoUo4c3dts3iwqRYmBikUP77wwY2QGmDZw2FvkJCJlKnabIRuGvB\nKwzESIXgKk2016aTP6/dAjEHyo6SeoK8lkIySUvK0fyOVlsiEsCmOpidtnKX/a+5\n0GjB79CJH4ER2lLVZnhePFR/zUOyPxZQQ4naHf7yu/b5jhO0f8fwt+pyFxIXjbEI\ndZliWRkRMtzrHOJIhrmJ2A1J7iOrirbbwillwjjNVUWPf3IJ3M12S9pEewooaeO2\nizNTERcG9HzAacbVRn2Y2SWIyT/18QIDAQABo4GnMIGkMB0GA1UdDgQWBBT/LbE4\n9rWf288N6sJA5BRb6FJIGDB1BgNVHSMEbjBsgBT/LbE49rWf288N6sJA5BRb6FJI\nGKFJpEcwRTELMAkGA1UEBhMCQVUxEzARBgNVBAgTClNvbWUtU3RhdGUxITAfBgNV\nBAoTGEludGVybmV0IFdpZGdpdHMgUHR5IEx0ZIIJAMHAwfXZ5/PWMAwGA1UdEwQF\nMAMBAf8wDQYJKoZIhvcNAQELBQADggEBAHHFwl0tH0quUYZYO0dZYt4R7SJ0pCm2\n2satiyzHl4OnXcHDpekAo7/a09c6Lz6AU83cKy/+x3/djYHXWba7HpEu0dR3ugQP\nMlr4zrhd9xKZ0KZKiYmtJH+ak4OM4L3FbT0owUZPyjLSlhMtJVcoRp5CJsjAMBUG\nSvD8RX+T01wzox/Qb+lnnNnOlaWpqu8eoOenybxKp1a9ULzIVvN/LAcc+14vioFq\n2swRWtmocBAs8QR9n4uvbpiYvS8eYueDCWMM4fvFfBhaDZ3N9IbtySh3SpFdQDhw\nYbjM2rxXiyLGxB4Bol7QTv4zHif7Zt89FReT/NBy4rzaskDJY5L6xmY=\n-----END CERTIFICATE-----\n"},"zone-authenticated-origin-pull_components-schemas-enabled":{"type":"boolean","description":"Indicates whether zone-level authenticated origin pulls is enabled.","example":true},"zone-authenticated-origin-pull_components-schemas-expires_on":{"type":"string","format":"date-time","description":"When the certificate from the authority expires.","example":"2100-01-01T05:20:00Z","readOnly":true},"zone-authenticated-origin-pull_components-schemas-identifier":{"type":"string","description":"Certificate identifier tag.","example":"2458ce5a-0c35-4c7f-82c7-8e9487d3ff60","readOnly":true,"maxLength":36},"zone-authenticated-origin-pull_components-schemas-status":{"description":"Status of the certificate activation.","enum":["initializing","pending_deployment","pending_deletion","active","deleted","deployment_timed_out","deletion_timed_out"],"example":"active"},"zone_cache_settings_response_single":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"type":"object"}}}]},"zone_components-schemas-zone":{"allOf":[{"$ref":"#/components/schemas/components-schemas-zone"}],"type":"object"},"zone_identifier":{"description":"Identifier of the zone.","example":"593c9c94de529bbbfaac7c53ced0447d"},"zone_metadata":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether zone uses account-level custom nameservers.","example":true}}},"zone_name":{"type":"string","description":"Name of the zone.","example":"example.com"},"zone_settings_response_collection":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"anyOf":[{"type":"array","items":{}},{"type":"object"}],"items":{"$ref":"#/components/schemas/setting"}}}}]},"zone_settings_response_single":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"type":"object"}}}]},"zone_subscription_response_single":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"type":"object","properties":{"result":{"type":"object"}}}]},"zonelockdown":{"required":["id","created_on","modified_on","paused","description","urls","configurations"],"properties":{"configurations":{"$ref":"#/components/schemas/configurations"},"created_on":{"$ref":"#/components/schemas/schemas-created_on"},"description":{"$ref":"#/components/schemas/lockdowns_components-schemas-description"},"id":{"$ref":"#/components/schemas/lockdowns_components-schemas-id"},"modified_on":{"$ref":"#/components/schemas/lockdowns_components-schemas-modified_on"},"paused":{"$ref":"#/components/schemas/components-schemas-paused"},"urls":{"$ref":"#/components/schemas/schemas-urls"}}},"zonelockdown_response_collection":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"type":"object","required":["result"],"properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/zonelockdown"}}}}]},"zonelockdown_response_single":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"type":"object","required":["result"],"properties":{"result":{"$ref":"#/components/schemas/zonelockdown"}}}]},"zones_connected":{"type":"number","description":"The number of zones using this Railgun.","example":2,"readOnly":true}},"securitySchemes":{"api_email":{"type":"apiKey","name":"X-Auth-Email","in":"header"},"api_key":{"type":"apiKey","name":"X-Auth-Key","in":"header"},"api_token":{"type":"http","scheme":"bearer"},"user_service_key":{"type":"apiKey","name":"X-Auth-User-Service-Key","in":"header"}}},"info":{"title":"Cloudflare API","description":"Interact with Cloudflare's products and services via the Cloudflare API.\nFor more information on how to create and troubleshoot API tokens, refer to\nour [API fundamentals](https://developers.cloudflare.com/fundamentals/api/).\n\nTotally new to Cloudflare? [Start here](https://developers.cloudflare.com/fundamentals/get-started/).","license":{"name":"BSD-3-Clause","url":"https://opensource.org/licenses/BSD-3-Clause"},"version":"4.0.0"},"paths":{"/accounts":{"get":{"tags":["Accounts"],"summary":"List Accounts","description":"List all accounts you have ownership or verified access to.","operationId":"accounts-list-accounts","responses":{"4xx":{"description":"List Accounts response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"List Accounts response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_collection"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{account_id}/gateway/categories":{"get":{"tags":["Zero Trust Gateway Categories"],"summary":"List Categories","description":"List all Categories.","operationId":"zero-trust-gateway-categories-list-categories","parameters":[{"name":"account_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"List Categories response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/categories_components-schemas-response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"List Categories response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/categories_components-schemas-response_collection"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{account_id}/rulesets":{"get":{"tags":["Account Rulesets"],"summary":"List account rulesets","description":"Fetches all rulesets at the account level.","operationId":"account-rulesets-list-account-rulesets","parameters":[{"name":"account_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"List account rulesets response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/rulesets_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"List account rulesets response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/rulesets_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"post":{"tags":["Account Rulesets"],"summary":"Create an account ruleset","description":"Creates a ruleset at the account level.","operationId":"account-rulesets-create-an-account-ruleset","parameters":[{"name":"account_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/create_ruleset"}}}},"responses":{"4xx":{"description":"Create an account ruleset response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ruleset_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Create an account ruleset response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ruleset_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{account_id}/rulesets/{ruleset_id}":{"delete":{"tags":["Account Rulesets"],"summary":"Delete an account ruleset","description":"Deletes all versions of an existing account ruleset.","operationId":"account-rulesets-delete-an-account-ruleset","parameters":[{"name":"ruleset_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/rulesets_components-schemas-id"}},{"name":"account_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{"4xx":{"description":"Delete an account ruleset response failure","content":{"application/json":{}}},"200":{"description":"Delete an account ruleset response","content":{"application/json":{}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"get":{"tags":["Account Rulesets"],"summary":"Get an account ruleset","description":"Fetches the latest version of an account ruleset.","operationId":"account-rulesets-get-an-account-ruleset","parameters":[{"name":"ruleset_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/rulesets_components-schemas-id"}},{"name":"account_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Get an account ruleset response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ruleset_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Get an account ruleset response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ruleset_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"put":{"tags":["Account Rulesets"],"summary":"Update an account ruleset","description":"Updates an account ruleset, creating a new version.","operationId":"account-rulesets-update-an-account-ruleset","parameters":[{"name":"ruleset_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/rulesets_components-schemas-id"}},{"name":"account_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/update_ruleset"}}}},"responses":{"4xx":{"description":"Update an account ruleset response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ruleset_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Update an account ruleset response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ruleset_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{account_id}/rulesets/{ruleset_id}/rules":{"post":{"tags":["Account Rulesets"],"summary":"Create an account ruleset rule","description":"Adds a new rule to an account ruleset. The rule will be added to the end of the existing list of rules in the ruleset.","operationId":"account-rulesets-create-an-account-ruleset-rule","parameters":[{"name":"ruleset_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/rulesets_components-schemas-id"}},{"name":"account_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/create_update_rule"}}}},"responses":{"4xx":{"description":"Create an account ruleset rule response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ruleset_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Create an account ruleset rule response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ruleset_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{account_id}/rulesets/{ruleset_id}/rules/{rule_id}":{"delete":{"tags":["Account Rulesets"],"summary":"Delete an account ruleset rule","description":"Deletes an existing rule from an account ruleset.","operationId":"account-rulesets-delete-an-account-ruleset-rule","parameters":[{"name":"rule_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/rules_components-schemas-id"}},{"name":"ruleset_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/rulesets_components-schemas-id"}},{"name":"account_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{"4xx":{"description":"Delete an account ruleset rule response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ruleset_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Delete an account ruleset rule response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ruleset_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"patch":{"tags":["Account Rulesets"],"summary":"Update an account ruleset rule","description":"Updates an existing rule in an account ruleset.","operationId":"account-rulesets-update-an-account-ruleset-rule","parameters":[{"name":"rule_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/rules_components-schemas-id"}},{"name":"ruleset_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/rulesets_components-schemas-id"}},{"name":"account_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/create_update_rule"}}}},"responses":{"4xx":{"description":"Update an account ruleset rule response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ruleset_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Update an account ruleset rule response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ruleset_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{account_id}/rulesets/{ruleset_id}/versions":{"get":{"tags":["Account Rulesets"],"summary":"List an account ruleset's versions","description":"Fetches the versions of an account ruleset.","operationId":"account-rulesets-list-an-account-ruleset'-s-versions","parameters":[{"name":"ruleset_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/rulesets_components-schemas-id"}},{"name":"account_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"List an account ruleset's versions response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/rulesets_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"List an account ruleset's versions response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/rulesets_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{account_id}/rulesets/{ruleset_id}/versions/{ruleset_version}":{"delete":{"tags":["Account Rulesets"],"summary":"Delete an account ruleset version","description":"Deletes an existing version of an account ruleset.","operationId":"account-rulesets-delete-an-account-ruleset-version","parameters":[{"name":"ruleset_version","in":"path","required":true,"schema":{"$ref":"#/components/schemas/version"}},{"name":"ruleset_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/rulesets_components-schemas-id"}},{"name":"account_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{"4xx":{"description":"Delete an account ruleset version response failure","content":{"application/json":{}}},"200":{"description":"Delete an account ruleset version response","content":{"application/json":{}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"get":{"tags":["Account Rulesets"],"summary":"Get an account ruleset version","description":"Fetches a specific version of an account ruleset.","operationId":"account-rulesets-get-an-account-ruleset-version","parameters":[{"name":"ruleset_version","in":"path","required":true,"schema":{"$ref":"#/components/schemas/version"}},{"name":"ruleset_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/rulesets_components-schemas-id"}},{"name":"account_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Get an account ruleset version response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ruleset_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Get an account ruleset version response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ruleset_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{account_id}/rulesets/{ruleset_id}/versions/{ruleset_version}/by_tag/{rule_tag}":{"get":{"tags":["Account Rulesets"],"summary":"List an account ruleset version's rules by tag","description":"Fetches the rules of a managed account ruleset version for a given tag.","operationId":"account-rulesets-list-an-account-ruleset-version'-s-rules-by-tag","parameters":[{"name":"rule_tag","in":"path","required":true,"schema":{"$ref":"#/components/schemas/category"}},{"name":"ruleset_version","in":"path","required":true,"schema":{"$ref":"#/components/schemas/version"}},{"name":"ruleset_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/rulesets_components-schemas-id"}},{"name":"account_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"List an account ruleset version's rules by tag response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ruleset_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"List an account ruleset version's rules by tag response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ruleset_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{account_id}/rulesets/phases/{ruleset_phase}/entrypoint":{"get":{"tags":["Account Rulesets"],"summary":"Get an account entry point ruleset","description":"Fetches the latest version of the account entry point ruleset for a given phase.","operationId":"account-rulesets-get-an-account-entry-point-ruleset","parameters":[{"name":"ruleset_phase","in":"path","required":true,"schema":{"$ref":"#/components/schemas/phase"}},{"name":"account_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Get an account entry point ruleset response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ruleset_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Get an account entry point ruleset response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ruleset_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"put":{"tags":["Account Rulesets"],"summary":"Update an account entry point ruleset","description":"Updates an account entry point ruleset, creating a new version.","operationId":"account-rulesets-update-an-account-entry-point-ruleset","parameters":[{"name":"ruleset_phase","in":"path","required":true,"schema":{"$ref":"#/components/schemas/phase"}},{"name":"account_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/update_ruleset"}}}},"responses":{"4xx":{"description":"Update an account entry point ruleset response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ruleset_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Update an account entry point ruleset response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ruleset_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{account_id}/rulesets/phases/{ruleset_phase}/entrypoint/versions":{"get":{"tags":["Account Rulesets"],"summary":"List an account entry point ruleset's versions","description":"Fetches the versions of an account entry point ruleset.","operationId":"account-rulesets-list-an-account-entry-point-ruleset'-s-versions","parameters":[{"name":"ruleset_phase","in":"path","required":true,"schema":{"$ref":"#/components/schemas/phase"}},{"name":"account_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"List an account entry point ruleset's versions response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/rulesets_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"List an account entry point ruleset's versions response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/rulesets_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{account_id}/rulesets/phases/{ruleset_phase}/entrypoint/versions/{ruleset_version}":{"get":{"tags":["Account Rulesets"],"summary":"Get an account entry point ruleset version","description":"Fetches a specific version of an account entry point ruleset.","operationId":"account-rulesets-get-an-account-entry-point-ruleset-version","parameters":[{"name":"ruleset_version","in":"path","required":true,"schema":{"$ref":"#/components/schemas/version"}},{"name":"ruleset_phase","in":"path","required":true,"schema":{"$ref":"#/components/schemas/phase"}},{"name":"account_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Get an account entry point ruleset version response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ruleset_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Get an account entry point ruleset version response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ruleset_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{account_identifier}/addressing/address_maps":{"get":{"tags":["IP Address Management Address Maps"],"summary":"List Address Maps","description":"List all address maps owned by the account.","operationId":"ip-address-management-address-maps-list-address-maps","parameters":[{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"List Address Maps response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/address-maps_components-schemas-response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"List Address Maps response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/address-maps_components-schemas-response_collection"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"post":{"tags":["IP Address Management Address Maps"],"summary":"Create Address Map","description":"Create a new address map under the account.","operationId":"ip-address-management-address-maps-create-address-map","parameters":[{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"description":{"$ref":"#/components/schemas/address-maps_components-schemas-description"}}}}}},"responses":{"4xx":{"description":"Create Address Map response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/full_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Create Address Map response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/full_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{account_identifier}/addressing/address_maps/{address_map_identifier}":{"delete":{"tags":["IP Address Management Address Maps"],"summary":"Delete Address Map","description":"Delete a particular address map owned by the account.","operationId":"ip-address-management-address-maps-delete-address-map","parameters":[{"name":"address_map_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}},{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{"4xx":{"description":"Delete Address Map response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Delete Address Map response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-response-collection"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"get":{"tags":["IP Address Management Address Maps"],"summary":"Address Map Details","description":"Show a particular address map owned by the account.","operationId":"ip-address-management-address-maps-address-map-details","parameters":[{"name":"address_map_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}},{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Address Map Details response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/full_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Address Map Details response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/full_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"patch":{"tags":["IP Address Management Address Maps"],"summary":"Update Address Map","description":"Modify the description or default SNI for an address map owned by the account.","operationId":"ip-address-management-address-maps-update-address-map","parameters":[{"name":"address_map_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}},{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"default_sni":{"$ref":"#/components/schemas/default_sni"},"description":{"$ref":"#/components/schemas/address-maps_components-schemas-description"}}}}}},"responses":{"4xx":{"description":"Update Address Map response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/address-maps_components-schemas-single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Update Address Map response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/address-maps_components-schemas-single_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{account_identifier}/addressing/address_maps/{address_map_identifier}/ips/{ip_address}":{"delete":{"tags":["IP Address Management Address Maps"],"summary":"Remove an IP from an Address Map","description":"Remove an IP from a particular address map.","operationId":"ip-address-management-address-maps-remove-an-ip-from-an-address-map","parameters":[{"name":"ip_address","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ip_address"}},{"name":"address_map_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}},{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{"4xx":{"description":"Remove an IP from an Address Map response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Remove an IP from an Address Map response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-response-collection"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"put":{"tags":["IP Address Management Address Maps"],"summary":"Add an IP to an Address Map","description":"Add an IP from a prefix owned by the account to a particular address map.","operationId":"ip-address-management-address-maps-add-an-ip-to-an-address-map","parameters":[{"name":"ip_address","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ip_address"}},{"name":"address_map_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}},{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{"4xx":{"description":"Add an IP to an Address Map response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Add an IP to an Address Map response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-response-collection"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{account_identifier}/addressing/address_maps/{address_map_identifier}/zones/{zone_identifier}":{"delete":{"tags":["IP Address Management Address Maps"],"summary":"Remove a zone membership from an Address Map","description":"Remove a zone as a member of a particular address map.","operationId":"ip-address-management-address-maps-remove-a-zone-membership-from-an-address-map","parameters":[{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}},{"name":"address_map_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}},{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{"4xx":{"description":"Remove a zone membership from an Address Map response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Remove a zone membership from an Address Map response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-response-collection"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"put":{"tags":["IP Address Management Address Maps"],"summary":"Add a zone membership to an Address Map","description":"Add a zone as a member of a particular address map.","operationId":"ip-address-management-address-maps-add-a-zone-membership-to-an-address-map","parameters":[{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}},{"name":"address_map_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}},{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{"4xx":{"description":"Add a zone membership to an Address Map response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Add a zone membership to an Address Map response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-response-collection"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{account_identifier}/addressing/loa_documents":{"post":{"tags":["IP Address Management Prefixes"],"summary":"Upload LOA Document","description":"Submit LOA document (pdf format) under the account.","operationId":"ip-address-management-prefixes-upload-loa-document","parameters":[{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"type":"object","required":["loa_document"],"properties":{"loa_document":{"type":"string","description":"LOA document to upload.","example":"@document.pdf"}}}}}},"responses":{"4xx":{"description":"Upload LOA Document response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/loa_upload_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Upload LOA Document response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/loa_upload_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{account_identifier}/addressing/loa_documents/{loa_document_identifier}/download":{"get":{"tags":["IP Address Management Prefixes"],"summary":"Download LOA Document","description":"Download specified LOA document under the account.","operationId":"ip-address-management-prefixes-download-loa-document","parameters":[{"name":"loa_document_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/loa_document_identifier"}},{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Download LOA Document response failure","content":{"application/json":{"schema":{"allOf":[{},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Download LOA Document response","content":{"application/json":{"schema":{}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{account_identifier}/addressing/prefixes":{"get":{"tags":["IP Address Management Prefixes"],"summary":"List Prefixes","description":"List all prefixes owned by the account.","operationId":"ip-address-management-prefixes-list-prefixes","parameters":[{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"List Prefixes response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ipam-prefixes_components-schemas-response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"List Prefixes response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ipam-prefixes_components-schemas-response_collection"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"post":{"tags":["IP Address Management Prefixes"],"summary":"Add Prefix","description":"Add a prefix under the account.","operationId":"ip-address-management-prefixes-add-prefix","parameters":[{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["cidr","loa_document_id"],"properties":{"asn":{"$ref":"#/components/schemas/asn"},"cidr":{"$ref":"#/components/schemas/cidr"},"loa_document_id":{"$ref":"#/components/schemas/loa_document_identifier"}}}}}},"responses":{"4xx":{"description":"Add Prefix response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ipam-prefixes_components-schemas-single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Add Prefix response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ipam-prefixes_components-schemas-single_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{account_identifier}/addressing/prefixes/{prefix_identifier}":{"delete":{"tags":["IP Address Management Prefixes"],"summary":"Delete Prefix","description":"Delete an unapproved prefix owned by the account.","operationId":"ip-address-management-prefixes-delete-prefix","parameters":[{"name":"prefix_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}},{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{"4xx":{"description":"Delete Prefix response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Delete Prefix response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-response-collection"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"get":{"tags":["IP Address Management Prefixes"],"summary":"Prefix Details","description":"List a particular prefix owned by the account.","operationId":"ip-address-management-prefixes-prefix-details","parameters":[{"name":"prefix_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}},{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Prefix Details response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ipam-prefixes_components-schemas-single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Prefix Details response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ipam-prefixes_components-schemas-single_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"patch":{"tags":["IP Address Management Prefixes"],"summary":"Update Prefix Description","description":"Modify the description for a prefix owned by the account.","operationId":"ip-address-management-prefixes-update-prefix-description","parameters":[{"name":"prefix_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}},{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["description"],"properties":{"description":{"$ref":"#/components/schemas/ipam-prefixes_components-schemas-description"}}}}}},"responses":{"4xx":{"description":"Update Prefix Description response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ipam-prefixes_components-schemas-single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Update Prefix Description response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ipam-prefixes_components-schemas-single_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{account_identifier}/addressing/prefixes/{prefix_identifier}/bgp/status":{"get":{"tags":["IP Address Management Dynamic Advertisement"],"summary":"Get Advertisement Status","description":"List the current advertisement state for a prefix.","operationId":"ip-address-management-dynamic-advertisement-get-advertisement-status","parameters":[{"name":"prefix_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}},{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Get Advertisement Status response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/advertised_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Get Advertisement Status response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/advertised_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"patch":{"tags":["IP Address Management Dynamic Advertisement"],"summary":"Update Prefix Dynamic Advertisement Status","description":"Advertise or withdraw BGP route for a prefix.","operationId":"ip-address-management-dynamic-advertisement-update-prefix-dynamic-advertisement-status","parameters":[{"name":"prefix_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}},{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["advertised"],"properties":{"advertised":{"$ref":"#/components/schemas/schemas-advertised"}}}}}},"responses":{"4xx":{"description":"Update Prefix Dynamic Advertisement Status response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/advertised_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Update Prefix Dynamic Advertisement Status response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/advertised_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{account_identifier}/addressing/prefixes/{prefix_identifier}/delegations":{"get":{"tags":["IP Address Management Prefix Delegation"],"summary":"List Prefix Delegations","description":"List all delegations for a given account IP prefix.","operationId":"ip-address-management-prefix-delegation-list-prefix-delegations","parameters":[{"name":"prefix_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}},{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"List Prefix Delegations response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ipam-delegations_components-schemas-response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"List Prefix Delegations response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ipam-delegations_components-schemas-response_collection"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"post":{"tags":["IP Address Management Prefix Delegation"],"summary":"Create Prefix Delegation","description":"Create a new account delegation for a given IP prefix.","operationId":"ip-address-management-prefix-delegation-create-prefix-delegation","parameters":[{"name":"prefix_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}},{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["cidr","delegated_account_id"],"properties":{"cidr":{"$ref":"#/components/schemas/cidr"},"delegated_account_id":{"$ref":"#/components/schemas/delegated_account_identifier"}}}}}},"responses":{"4xx":{"description":"Create Prefix Delegation response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ipam-delegations_components-schemas-single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Create Prefix Delegation response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ipam-delegations_components-schemas-single_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{account_identifier}/addressing/prefixes/{prefix_identifier}/delegations/{delegation_identifier}":{"delete":{"tags":["IP Address Management Prefix Delegation"],"summary":"Delete Prefix Delegation","description":"Delete an account delegation for a given IP prefix.","operationId":"ip-address-management-prefix-delegation-delete-prefix-delegation","parameters":[{"name":"delegation_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/delegation_identifier"}},{"name":"prefix_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}},{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{"4xx":{"description":"Delete Prefix Delegation response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ipam-delegations_components-schemas-id_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Delete Prefix Delegation response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ipam-delegations_components-schemas-id_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{account_identifier}/audit_logs":{"get":{"tags":["Audit Logs"],"summary":"Get account audit logs","description":"Gets a list of audit logs for an account. The list can be filtered by who made the change, which zone was the change made on, and the timeframe of the change.","operationId":"audit-logs-get-account-audit-logs","parameters":[{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Get account audit logs response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/audit_logs_response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Get account audit logs response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/audit_logs_response_collection"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{account_identifier}/billing/profile":{"get":{"tags":["Account Billing Profile"],"summary":"Billing Profile Details","description":"Gets the current billing profile for the account.","operationId":"account-billing-profile-billing-profile-details","parameters":[{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/account_identifier"}}],"responses":{"4xx":{"description":"Billing Profile Details response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/billing_response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Billing Profile Details response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/billing_response_single"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{account_identifier}/brand-protection/submit":{"post":{"tags":["Phishing URL Scanner"],"summary":"Submit suspicious URL for scanning","operationId":"phishing-url-scanner-submit-suspicious-url-for-scanning","parameters":[{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/url_param"}],"type":"object"}}}},"responses":{"4xx":{"description":"Submit suspicious URL for scanning response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/phishing-url-submit_components-schemas-single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Submit suspicious URL for scanning response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/phishing-url-submit_components-schemas-single_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{account_identifier}/brand-protection/url-info":{"get":{"tags":["Phishing URL Information"],"summary":"Get results for a URL scan","operationId":"phishing-url-information-get-results-for-a-url-scan","parameters":[{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Get results for a URL scan response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/phishing-url-info_components-schemas-single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Get results for a URL scan response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/phishing-url-info_components-schemas-single_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{account_identifier}/cfd_tunnel":{"get":{"tags":["Cloudflare Tunnel"],"summary":"List Cloudflare Tunnels","description":"Lists and filters Cloudflare Tunnels in an account.","operationId":"cloudflare-tunnel-list-cloudflare-tunnels","parameters":[{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/cf_account_id"}}],"responses":{"4xx":{"description":"List Cloudflare Tunnels response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/schemas-tunnel_response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"List Cloudflare Tunnels response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/schemas-tunnel_response_collection"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"post":{"tags":["Cloudflare Tunnel"],"summary":"Create a Cloudflare Tunnel","description":"Creates a new Cloudflare Tunnel in an account.","operationId":"cloudflare-tunnel-create-a-cloudflare-tunnel","parameters":[{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/cf_account_id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["name","tunnel_secret"],"properties":{"config_src":{"$ref":"#/components/schemas/config_src"},"name":{"$ref":"#/components/schemas/tunnel_name"},"tunnel_secret":{"$ref":"#/components/schemas/tunnel_secret"}}}}}},"responses":{"4xx":{"description":"Create a Cloudflare Tunnel response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/schemas-tunnel_response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Create a Cloudflare Tunnel response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/schemas-tunnel_response_single"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{account_identifier}/cfd_tunnel/{tunnel_id}":{"delete":{"tags":["Cloudflare Tunnel"],"summary":"Delete a Cloudflare Tunnel","description":"Deletes a Cloudflare Tunnel from an account.","operationId":"cloudflare-tunnel-delete-a-cloudflare-tunnel","parameters":[{"name":"tunnel_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/tunnel_id"}},{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/cf_account_id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object"}}}},"responses":{"4xx":{"description":"Delete a Cloudflare Tunnel response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/schemas-tunnel_response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Delete a Cloudflare Tunnel response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/schemas-tunnel_response_single"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"get":{"tags":["Cloudflare Tunnel"],"summary":"Get a Cloudflare Tunnel","description":"Fetches a single Cloudflare Tunnel.","operationId":"cloudflare-tunnel-get-a-cloudflare-tunnel","parameters":[{"name":"tunnel_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/tunnel_id"}},{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/cf_account_id"}}],"responses":{"4xx":{"description":"Get a Cloudflare Tunnel response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/schemas-tunnel_response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Get a Cloudflare Tunnel response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/schemas-tunnel_response_single"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"patch":{"tags":["Cloudflare Tunnel"],"summary":"Update a Cloudflare Tunnel","description":"Updates an existing Cloudflare Tunnel.","operationId":"cloudflare-tunnel-update-a-cloudflare-tunnel","parameters":[{"name":"tunnel_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/tunnel_id"}},{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/cf_account_id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"$ref":"#/components/schemas/tunnel_name"},"tunnel_secret":{"$ref":"#/components/schemas/tunnel_secret"}}}}}},"responses":{"4xx":{"description":"Update a Cloudflare Tunnel response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/schemas-tunnel_response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Update a Cloudflare Tunnel response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/schemas-tunnel_response_single"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{account_identifier}/cfd_tunnel/{tunnel_id}/configurations":{"get":{"tags":["Cloudflare Tunnel configuration"],"summary":"Get configuration","description":"Gets the configuration for a remotely-managed tunnel","operationId":"cloudflare-tunnel-configuration-get-configuration","parameters":[{"name":"tunnel_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/tunnel_id"}},{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Get configuration response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/config_response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Get configuration response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/config_response_single"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"put":{"tags":["Cloudflare Tunnel configuration"],"summary":"Put configuration","description":"Adds or updates the configuration for a remotely-managed tunnel.","operationId":"cloudflare-tunnel-configuration-put-configuration","parameters":[{"name":"tunnel_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/tunnel_id"}},{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"config":{"$ref":"#/components/schemas/components-schemas-config"}}}}}},"responses":{"4xx":{"description":"Put configuration response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/config_response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Put configuration response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/config_response_single"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{account_identifier}/cfd_tunnel/{tunnel_id}/connections":{"delete":{"tags":["Cloudflare Tunnel"],"summary":"Clean up Cloudflare Tunnel connections","description":"Removes connections that are in a disconnected or pending reconnect state. We recommend running this command after shutting down a tunnel.","operationId":"cloudflare-tunnel-clean-up-cloudflare-tunnel-connections","parameters":[{"name":"tunnel_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/tunnel_id"}},{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/cf_account_id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object"}}}},"responses":{"4xx":{"description":"Clean up Cloudflare Tunnel connections response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/cloudflare-tunnel_components-schemas-empty_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Clean up Cloudflare Tunnel connections response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudflare-tunnel_components-schemas-empty_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"get":{"tags":["Cloudflare Tunnel"],"summary":"List Cloudflare Tunnel connections","description":"Fetches connection details for a Cloudflare Tunnel.","operationId":"cloudflare-tunnel-list-cloudflare-tunnel-connections","parameters":[{"name":"tunnel_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/tunnel_id"}},{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/cf_account_id"}}],"responses":{"4xx":{"description":"List Cloudflare Tunnel connections response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/tunnel_connections_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"List Cloudflare Tunnel connections response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/tunnel_connections_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{account_identifier}/cfd_tunnel/{tunnel_id}/token":{"get":{"tags":["Cloudflare Tunnel"],"summary":"Get a Cloudflare Tunnel token","description":"Gets the token used to associate cloudflared with a specific tunnel.","operationId":"cloudflare-tunnel-get-a-cloudflare-tunnel-token","parameters":[{"name":"tunnel_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/tunnel_id"}},{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/cf_account_id"}}],"responses":{"4xx":{"description":"Get a Cloudflare Tunnel token response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/tunnel_response_token"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Get a Cloudflare Tunnel token response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/tunnel_response_token"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{account_identifier}/custom_pages":{"get":{"tags":["Custom pages for an account"],"summary":"List custom pages","description":"Fetches all the custom pages at the account level.","operationId":"custom-pages-for-an-account-list-custom-pages","parameters":[{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"List custom pages response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/custom_pages_response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"List custom pages response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/custom_pages_response_collection"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{account_identifier}/custom_pages/{identifier}":{"get":{"tags":["Custom pages for an account"],"summary":"Get a custom page","description":"Fetches the details of a custom page.","operationId":"custom-pages-for-an-account-get-a-custom-page","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/custom-pages_components-schemas-identifier-2"}},{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Get a custom page response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/custom_pages_response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Get a custom page response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/custom_pages_response_single"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"put":{"tags":["Custom pages for an account"],"summary":"Update a custom page","description":"Updates the configuration of an existing custom page.","operationId":"custom-pages-for-an-account-update-a-custom-page","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/custom-pages_components-schemas-identifier-2"}},{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["url","state"],"properties":{"state":{"$ref":"#/components/schemas/components-schemas-state"},"url":{"$ref":"#/components/schemas/url"}}}}}},"responses":{"4xx":{"description":"Update a custom page response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/custom_pages_response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Update a custom page response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/custom_pages_response_single"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{account_identifier}/diagnostics/traceroute":{"post":{"tags":["Diagnostics"],"summary":"Traceroute","description":"Run traceroutes from Cloudflare colos.","operationId":"diagnostics-traceroute","parameters":[{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["targets"],"properties":{"colos":{"$ref":"#/components/schemas/colos"},"options":{"$ref":"#/components/schemas/schemas-options"},"targets":{"$ref":"#/components/schemas/schemas-targets"}}}}}},"responses":{"4xx":{"description":"Traceroute response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/traceroute_response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Traceroute response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/traceroute_response_collection"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{account_identifier}/dlp/patterns/validate":{"post":{"tags":["DLP Pattern Validation"],"summary":"Validate pattern","description":"Validates whether this pattern is a valid regular expression. Rejects it if the regular expression is too complex or can match an unbounded-length string. Your regex will be rejected if it uses the Kleene Star -- be sure to bound the maximum number of characters that can be matched.","operationId":"dlp-pattern-validation-validate-pattern","parameters":[{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/validate_pattern"}}}},"responses":{"4xx":{"description":"Validate pattern response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/schemas-validate_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Validate pattern response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/schemas-validate_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{account_identifier}/dlp/profiles":{"get":{"tags":["DLP Profiles"],"summary":"List all profiles","description":"Lists all DLP profiles in an account.","operationId":"dlp-profiles-list-all-profiles","parameters":[{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"List all profiles response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/profiles_components-schemas-response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"List all profiles response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/profiles_components-schemas-response_collection"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{account_identifier}/dlp/profiles/{profile_id}":{"get":{"tags":["DLP Profiles"],"summary":"Get DLP Profile","description":"Fetches a DLP profile by ID. Supports both predefined and custom profiles","operationId":"dlp-profiles-get-dlp-profile","parameters":[{"name":"profile_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/profile_id"}},{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Get DLP Profile response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/either_profile_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Get DLP Profile response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/either_profile_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{account_identifier}/dlp/profiles/custom":{"post":{"tags":["DLP Profiles"],"summary":"Create custom profiles","description":"Creates a set of DLP custom profiles.","operationId":"dlp-profiles-create-custom-profiles","parameters":[{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/create_custom_profiles"}}}},"responses":{"4xx":{"description":"Create custom profiles response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/create_custom_profile_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Create custom profiles response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/create_custom_profile_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{account_identifier}/dlp/profiles/custom/{profile_id}":{"delete":{"tags":["DLP Profiles"],"summary":"Delete custom profile","description":"Deletes a DLP custom profile.","operationId":"dlp-profiles-delete-custom-profile","parameters":[{"name":"profile_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/profile_id"}},{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{"4xx":{"description":"Delete custom profile response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Delete custom profile response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-response-single"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"get":{"tags":["DLP Profiles"],"summary":"Get custom profile","description":"Fetches a custom DLP profile.","operationId":"dlp-profiles-get-custom-profile","parameters":[{"name":"profile_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/profile_id"}},{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Get custom profile response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/custom_profile_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Get custom profile response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/custom_profile_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"put":{"tags":["DLP Profiles"],"summary":"Update custom profile","description":"Updates a DLP custom profile.","operationId":"dlp-profiles-update-custom-profile","parameters":[{"name":"profile_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/profile_id"}},{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/update_custom_profile"}}}},"responses":{"4xx":{"description":"Update custom profile response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/custom_profile"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Update custom profile response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/custom_profile"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{account_identifier}/dlp/profiles/predefined/{profile_id}":{"get":{"tags":["DLP Profiles"],"summary":"Get predefined profile","description":"Fetches a predefined DLP profile.","operationId":"dlp-profiles-get-predefined-profile","parameters":[{"name":"profile_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/profile_id"}},{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Get predefined profile response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/predefined_profile_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Get predefined profile response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/predefined_profile_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"put":{"tags":["DLP Profiles"],"summary":"Update predefined profile","description":"Updates a DLP predefined profile. Only supports enabling/disabling entries.","operationId":"dlp-profiles-update-predefined-profile","parameters":[{"name":"profile_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/profile_id"}},{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/update_predefined_profile"}}}},"responses":{"4xx":{"description":"Update predefined profile response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/predefined_profile"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Update predefined profile response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/predefined_profile"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{account_identifier}/dns_firewall":{"get":{"tags":["DNS Firewall"],"summary":"List DNS Firewall Clusters","description":"List configured DNS Firewall clusters for an account.","operationId":"dns-firewall-list-dns-firewall-clusters","parameters":[{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"List DNS Firewall Clusters response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/dns_firewall_response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"List DNS Firewall Clusters response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/dns_firewall_response_collection"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"post":{"tags":["DNS Firewall"],"summary":"Create DNS Firewall Cluster","description":"Create a configured DNS Firewall Cluster.","operationId":"dns-firewall-create-dns-firewall-cluster","parameters":[{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["name","origin_ips"],"properties":{"deprecate_any_requests":{"$ref":"#/components/schemas/deprecate_any_requests"},"ecs_fallback":{"$ref":"#/components/schemas/ecs_fallback"},"maximum_cache_ttl":{"$ref":"#/components/schemas/maximum_cache_ttl"},"minimum_cache_ttl":{"$ref":"#/components/schemas/minimum_cache_ttl"},"name":{"$ref":"#/components/schemas/dns-firewall_components-schemas-name"},"negative_cache_ttl":{"$ref":"#/components/schemas/negative_cache_ttl"},"origin_ips":{"$ref":"#/components/schemas/origin_ips"},"ratelimit":{"$ref":"#/components/schemas/ratelimit"}}}}}},"responses":{"4xx":{"description":"Create DNS Firewall Cluster response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/dns_firewall_single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Create DNS Firewall Cluster response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/dns_firewall_single_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{account_identifier}/dns_firewall/{identifier}":{"delete":{"tags":["DNS Firewall"],"summary":"Delete DNS Firewall Cluster","description":"Delete a configured DNS Firewall Cluster.","operationId":"dns-firewall-delete-dns-firewall-cluster","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}},{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{"4xx":{"description":"Delete DNS Firewall Cluster response failure","content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"properties":{"id":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}}}}]},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Delete DNS Firewall Cluster response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"properties":{"id":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}}}}]}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"get":{"tags":["DNS Firewall"],"summary":"DNS Firewall Cluster Details","description":"Show a single configured DNS Firewall cluster for an account.","operationId":"dns-firewall-dns-firewall-cluster-details","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}},{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"DNS Firewall Cluster Details response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/dns_firewall_single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"DNS Firewall Cluster Details response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/dns_firewall_single_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"patch":{"tags":["DNS Firewall"],"summary":"Update DNS Firewall Cluster","description":"Modify a DNS Firewall Cluster configuration.","operationId":"dns-firewall-update-dns-firewall-cluster","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}},{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/schemas-dns-firewall"}}}},"responses":{"4xx":{"description":"Update DNS Firewall Cluster response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/dns_firewall_single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Update DNS Firewall Cluster response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/dns_firewall_single_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{account_identifier}/dns_firewall/{identifier}/dns_analytics/report":{"get":{"tags":["DNS Firewall Analytics"],"summary":"Table","description":"Retrieves a list of summarised aggregate metrics over a given time period.","operationId":"dns-firewall-analytics-table","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}},{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Table response failure","content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"type":"object","properties":{"result":{"$ref":"#/components/schemas/result"}}}]},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Table response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"type":"object","properties":{"result":{"$ref":"#/components/schemas/result"}}}]}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{account_identifier}/dns_firewall/{identifier}/dns_analytics/report/bytime":{"get":{"tags":["DNS Firewall Analytics"],"summary":"By Time","description":"Retrieves a list of aggregate metrics grouped by time interval.","operationId":"dns-firewall-analytics-by-time","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}},{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"By Time response failure","content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"type":"object","properties":{"result":{"$ref":"#/components/schemas/result"}}}]},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"By Time response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"type":"object","properties":{"result":{"$ref":"#/components/schemas/result"}}}]}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{account_identifier}/email/routing/addresses":{"get":{"tags":["Email Routing destination addresses"],"summary":"List destination addresses","description":"Lists existing destination addresses.","operationId":"email-routing-destination-addresses-list-destination-addresses","parameters":[{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"List destination addresses response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/destination_addresses_response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"List destination addresses response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/destination_addresses_response_collection"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"post":{"tags":["Email Routing destination addresses"],"summary":"Create a destination address","description":"Create a destination address to forward your emails to. Destination addresses need to be verified before they can be used.","operationId":"email-routing-destination-addresses-create-a-destination-address","parameters":[{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/create_destination_address_properties"}}}},"responses":{"4xx":{"description":"Create a destination address response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/destination_address_response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Create a destination address response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/destination_address_response_single"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{account_identifier}/email/routing/addresses/{destination_address_identifier}":{"delete":{"tags":["Email Routing destination addresses"],"summary":"Delete destination address","description":"Deletes a specific destination address.","operationId":"email-routing-destination-addresses-delete-destination-address","parameters":[{"name":"destination_address_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/destination_address_identifier"}},{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{"4xx":{"description":"Delete destination address response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/destination_address_response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Delete destination address response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/destination_address_response_single"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"get":{"tags":["Email Routing destination addresses"],"summary":"Get a destination address","description":"Gets information for a specific destination email already created.","operationId":"email-routing-destination-addresses-get-a-destination-address","parameters":[{"name":"destination_address_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/destination_address_identifier"}},{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Get a destination address response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/destination_address_response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Get a destination address response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/destination_address_response_single"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{account_identifier}/firewall/access_rules/rules":{"get":{"tags":["IP Access rules for an account"],"summary":"List IP Access rules","description":"Fetches IP Access rules of an account. These rules apply to all the zones in the account. You can filter the results using several optional parameters.","operationId":"ip-access-rules-for-an-account-list-ip-access-rules","parameters":[{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/account_identifier"}}],"responses":{"4xx":{"description":"List IP Access rules response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"List IP Access rules response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_collection"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"post":{"tags":["IP Access rules for an account"],"summary":"Create an IP Access rule","description":"Creates a new IP Access rule for an account. The rule will apply to all zones in the account.\n\nNote: To create an IP Access rule that applies to a single zone, refer to the [IP Access rules for a zone](#ip-access-rules-for-a-zone) endpoints.","operationId":"ip-access-rules-for-an-account-create-an-ip-access-rule","parameters":[{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/account_identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["mode","configuration"],"properties":{"configuration":{"$ref":"#/components/schemas/schemas-configuration"},"mode":{"$ref":"#/components/schemas/schemas-mode"},"notes":{"$ref":"#/components/schemas/notes"}}}}}},"responses":{"4xx":{"description":"Create an IP Access rule response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Create an IP Access rule response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_single"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{account_identifier}/firewall/access_rules/rules/{identifier}":{"delete":{"tags":["IP Access rules for an account"],"summary":"Delete an IP Access rule","description":"Deletes an existing IP Access rule defined at the account level.\n\nNote: This operation will affect all zones in the account.","operationId":"ip-access-rules-for-an-account-delete-an-ip-access-rule","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/schemas-identifier"}},{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/account_identifier"}}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{"4xx":{"description":"Delete an IP Access rule response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-response-single-id"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Delete an IP Access rule response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-response-single-id"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"get":{"tags":["IP Access rules for an account"],"summary":"Get an IP Access rule","description":"Fetches the details of an IP Access rule defined at the account level.","operationId":"ip-access-rules-for-an-account-get-an-ip-access-rule","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/schemas-identifier"}},{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/account_identifier"}}],"responses":{"4xx":{"description":"Get an IP Access rule response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Get an IP Access rule response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_single"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"patch":{"tags":["IP Access rules for an account"],"summary":"Update an IP Access rule","description":"Updates an IP Access rule defined at the account level.\n\nNote: This operation will affect all zones in the account.","operationId":"ip-access-rules-for-an-account-update-an-ip-access-rule","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/schemas-identifier"}},{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/account_identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/schemas-rule"}}}},"responses":{"4xx":{"description":"Update an IP Access rule response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Update an IP Access rule response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_single"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{account_identifier}/images/v1":{"get":{"tags":["Cloudflare Images"],"summary":"List images","description":"List up to 100 images with one request. Use the optional parameters below to get a specific range of images.","operationId":"cloudflare-images-list-images","parameters":[{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/images_components-schemas-account_identifier"}}],"responses":{"4xx":{"description":"List images response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/image_response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"List images response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/image_response_collection"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"post":{"tags":["Cloudflare Images"],"summary":"Upload an image via URL","description":"Upload an image via URL with up to 10 Megabytes using a single HTTP POST (multipart/form-data) request.","operationId":"cloudflare-images-upload-an-image-via-url","parameters":[{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/images_components-schemas-account_identifier"}}],"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/image_basic_upload_via_url"}}}},"responses":{"4xx":{"description":"Upload an image via URL response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/image_response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Upload an image via URL response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/image_response_single"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{account_identifier}/images/v1/{identifier}":{"delete":{"tags":["Cloudflare Images"],"summary":"Delete image","description":"Delete an image on Cloudflare Images. On success, all copies of the image are deleted and purged from cache.","operationId":"cloudflare-images-delete-image","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/images_components-schemas-identifier"}},{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/images_components-schemas-account_identifier"}}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{"4xx":{"description":"Delete image response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/schemas-deleted_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Delete image response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/schemas-deleted_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"get":{"tags":["Cloudflare Images"],"summary":"Image details","description":"Fetch details for a single image.","operationId":"cloudflare-images-image-details","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/images_components-schemas-identifier"}},{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/images_components-schemas-account_identifier"}}],"responses":{"4xx":{"description":"Image details response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/image_response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Image details response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/image_response_single"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"patch":{"tags":["Cloudflare Images"],"summary":"Update image","description":"Update image access control. On access control change, all copies of the image are purged from cache.","operationId":"cloudflare-images-update-image","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/images_components-schemas-identifier"}},{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/images_components-schemas-account_identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/image_patch_request"}}}},"responses":{"4xx":{"description":"Update image response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/image_response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Update image response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/image_response_single"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{account_identifier}/images/v1/{identifier}/blob":{"get":{"tags":["Cloudflare Images"],"summary":"Base image","description":"Fetch base image. For most images this will be the originally uploaded file. For larger images it can be a near-lossless version of the original.","operationId":"cloudflare-images-base-image","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/images_components-schemas-identifier"}},{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/images_components-schemas-account_identifier"}}],"responses":{"4xx":{"description":"Base image response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/image_response_blob"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Base image response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/image_response_blob"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{account_identifier}/images/v1/direct_upload":{"post":{"tags":["Cloudflare Images"],"summary":"Create authenticated direct upload URL","description":"Direct uploads allow users to upload images without API keys. A common use case are web apps, client-side applications, or mobile devices where users upload content directly to Cloudflare Images.","operationId":"cloudflare-images-create-authenticated-direct-upload-url","parameters":[{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/images_components-schemas-account_identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/schemas-direct_upload_request"}}}},"responses":{"4xx":{"description":"Create authenticated direct upload URL response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/schemas-direct_upload_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Create authenticated direct upload URL response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/schemas-direct_upload_response"}}}}},"deprecated":true,"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{account_identifier}/images/v1/keys":{"get":{"tags":["Cloudflare Images Keys"],"summary":"List Signing Keys","description":"Lists your signing keys. These can be found on your Cloudflare Images dashboard.","operationId":"cloudflare-images-keys-list-signing-keys","parameters":[{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"List Signing Keys response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/schemas-key_response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"List Signing Keys response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/schemas-key_response_collection"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{account_identifier}/images/v1/stats":{"get":{"tags":["Cloudflare Images"],"summary":"Images usage statistics","description":"Fetch usage statistics details for Cloudflare Images.","operationId":"cloudflare-images-images-usage-statistics","parameters":[{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/images_components-schemas-account_identifier"}}],"responses":{"4xx":{"description":"Images usage statistics response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/images_stats"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Images usage statistics response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/images_stats"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{account_identifier}/images/v1/variants":{"get":{"tags":["Cloudflare Images Variants"],"summary":"List variants","description":"Lists existing variants.","operationId":"cloudflare-images-variants-list-variants","parameters":[{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"List variants response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/variant_list_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"List variants response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/variant_list_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"post":{"tags":["Cloudflare Images Variants"],"summary":"Create a variant","description":"Specify variants that allow you to resize images for different use cases.","operationId":"cloudflare-images-variants-create-a-variant","parameters":[{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/variant_generation_request"}}}},"responses":{"4xx":{"description":"Create a variant response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/variant_simple_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Create a variant response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/variant_simple_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{account_identifier}/images/v1/variants/{identifier}":{"delete":{"tags":["Cloudflare Images Variants"],"summary":"Delete a variant","description":"Deleting a variant purges the cache for all images associated with the variant.","operationId":"cloudflare-images-variants-delete-a-variant","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/variants_components-schemas-identifier"}},{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{"4xx":{"description":"Delete a variant response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/schemas-deleted_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Delete a variant response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/schemas-deleted_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"get":{"tags":["Cloudflare Images Variants"],"summary":"Variant details","description":"Fetch details for a single variant.","operationId":"cloudflare-images-variants-variant-details","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/variants_components-schemas-identifier"}},{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Variant details response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/variant_simple_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Variant details response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/variant_simple_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"patch":{"tags":["Cloudflare Images Variants"],"summary":"Update a variant","description":"Updating a variant purges the cache for all images associated with the variant.","operationId":"cloudflare-images-variants-update-a-variant","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/variants_components-schemas-identifier"}},{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/variant_patch_request"}}}},"responses":{"4xx":{"description":"Update a variant response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/variant_simple_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Update a variant response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/variant_simple_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{account_identifier}/images/v2/direct_upload":{"post":{"tags":["Cloudflare Images"],"summary":"Create authenticated direct upload URL V2","description":"Direct uploads allow users to upload images without API keys. A common use case are web apps, client-side applications, or mobile devices where users upload content directly to Cloudflare Images. This method creates a draft record for a future image. It returns an upload URL and an image identifier. To verify if the image itself has been uploaded, send an image details request (accounts/:account_identifier/images/v1/:identifier), and check that the `draft: true` property is not present.","operationId":"cloudflare-images-create-authenticated-direct-upload-url-v-2","parameters":[{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/images_components-schemas-account_identifier"}}],"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/direct_upload_request_v2"}}}},"responses":{"4xx":{"description":"Create authenticated direct upload URL V2 response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/direct_upload_response_v2"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Create authenticated direct upload URL V2 response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/direct_upload_response_v2"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{account_identifier}/intel/asn/{asn}":{"get":{"tags":["ASN Intelligence"],"summary":"Get ASN Overview","operationId":"asn-intelligence-get-asn-overview","parameters":[{"name":"asn","in":"path","required":true,"schema":{"$ref":"#/components/schemas/asn_components-schemas-asn"}},{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Get ASN Overview response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/asn_components-schemas-response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Get ASN Overview response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/asn_components-schemas-response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{account_identifier}/intel/asn/{asn}/subnets":{"get":{"tags":["ASN Intelligence"],"summary":"Get ASN Subnets","operationId":"asn-intelligence-get-asn-subnets","parameters":[{"name":"asn","in":"path","required":true,"schema":{"$ref":"#/components/schemas/asn_components-schemas-asn"}},{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Get ASN Subnets response failure","content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"asn":{"$ref":"#/components/schemas/components-schemas-asn"},"count":{"$ref":"#/components/schemas/schemas-count"},"ip_count_total":{"type":"integer"},"page":{"$ref":"#/components/schemas/page"},"per_page":{"$ref":"#/components/schemas/per_page"},"subnets":{"type":"array","example":["192.0.2.0/24","2001:DB8::/32"],"items":{"type":"string"}}}},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Get ASN Subnets response","content":{"application/json":{"schema":{"type":"object","properties":{"asn":{"$ref":"#/components/schemas/components-schemas-asn"},"count":{"$ref":"#/components/schemas/schemas-count"},"ip_count_total":{"type":"integer"},"page":{"$ref":"#/components/schemas/page"},"per_page":{"$ref":"#/components/schemas/per_page"},"subnets":{"type":"array","example":["192.0.2.0/24","2001:DB8::/32"],"items":{"type":"string"}}}}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{account_identifier}/intel/dns":{"get":{"tags":["Passive DNS by IP"],"summary":"Get Passive DNS by IP","operationId":"passive-dns-by-ip-get-passive-dns-by-ip","parameters":[{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Get Passive DNS by IP response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/passive-dns-by-ip_components-schemas-single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Get Passive DNS by IP response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/passive-dns-by-ip_components-schemas-single_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{account_identifier}/intel/domain":{"get":{"tags":["Domain Intelligence"],"summary":"Get Domain Details","operationId":"domain-intelligence-get-domain-details","parameters":[{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Get Domain Details response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/domain_components-schemas-single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Get Domain Details response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/domain_components-schemas-single_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{account_identifier}/intel/domain-history":{"get":{"tags":["Domain History"],"summary":"Get Domain History","operationId":"domain-history-get-domain-history","parameters":[{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Get Domain History response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Get Domain History response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{account_identifier}/intel/domain/bulk":{"get":{"tags":["Domain Intelligence"],"summary":"Get Multiple Domain Details","operationId":"domain-intelligence-get-multiple-domain-details","parameters":[{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Get Multiple Domain Details response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/schemas-collection_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Get Multiple Domain Details response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/schemas-collection_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{account_identifier}/intel/ip":{"get":{"tags":["IP Intelligence"],"summary":"Get IP Overview","operationId":"ip-intelligence-get-ip-overview","parameters":[{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Get IP Overview response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/schemas-response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Get IP Overview response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/schemas-response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{account_identifier}/intel/ip-list":{"get":{"tags":["IP List"],"summary":"Get IP Lists","operationId":"ip-list-get-ip-lists","parameters":[{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Get IP Lists response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/components-schemas-response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Get IP Lists response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/components-schemas-response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{account_identifier}/intel/miscategorization":{"post":{"tags":["Miscategorization"],"summary":"Create Miscategorization","operationId":"miscategorization-create-miscategorization","parameters":[{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/miscategorization"}}}},"responses":{"4xx":{"description":"Create Miscategorization response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Create Miscategorization response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-response-single"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{account_identifier}/intel/whois":{"get":{"tags":["WHOIS Record"],"summary":"Get WHOIS Record","operationId":"whois-record-get-whois-record","parameters":[{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Get WHOIS Record response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/whois_components-schemas-single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Get WHOIS Record response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/whois_components-schemas-single_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{account_identifier}/load_balancers/monitors":{"get":{"tags":["Account Load Balancer Monitors"],"summary":"List Monitors","description":"List configured monitors for an account.","operationId":"account-load-balancer-monitors-list-monitors","parameters":[{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"List Monitors response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/monitor_components-schemas-response_collection-2"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"List Monitors response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/monitor_components-schemas-response_collection-2"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"post":{"tags":["Account Load Balancer Monitors"],"summary":"Create Monitor","description":"Create a configured monitor.","operationId":"account-load-balancer-monitors-create-monitor","parameters":[{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["expected_codes"],"properties":{"allow_insecure":{"$ref":"#/components/schemas/allow_insecure"},"consecutive_down":{"$ref":"#/components/schemas/consecutive_down"},"consecutive_up":{"$ref":"#/components/schemas/consecutive_up"},"description":{"$ref":"#/components/schemas/monitor_components-schemas-description"},"expected_body":{"$ref":"#/components/schemas/expected_body"},"expected_codes":{"$ref":"#/components/schemas/schemas-expected_codes"},"follow_redirects":{"$ref":"#/components/schemas/follow_redirects"},"header":{"$ref":"#/components/schemas/header"},"interval":{"$ref":"#/components/schemas/interval"},"method":{"$ref":"#/components/schemas/schemas-method"},"path":{"$ref":"#/components/schemas/path"},"port":{"$ref":"#/components/schemas/monitor_components-schemas-port"},"probe_zone":{"$ref":"#/components/schemas/probe_zone"},"retries":{"$ref":"#/components/schemas/retries"},"timeout":{"$ref":"#/components/schemas/schemas-timeout"},"type":{"$ref":"#/components/schemas/monitor_components-schemas-type"}}}}}},"responses":{"4xx":{"description":"Create Monitor response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/monitor_components-schemas-single_response-2"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Create Monitor response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/monitor_components-schemas-single_response-2"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{account_identifier}/load_balancers/monitors/{identifier}":{"delete":{"tags":["Account Load Balancer Monitors"],"summary":"Delete Monitor","description":"Delete a configured monitor.","operationId":"account-load-balancer-monitors-delete-monitor","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/monitor_components-schemas-identifier"}},{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{"4xx":{"description":"Delete Monitor response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/monitor_components-schemas-id_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Delete Monitor response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/monitor_components-schemas-id_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"get":{"tags":["Account Load Balancer Monitors"],"summary":"Monitor Details","description":"List a single configured monitor for an account.","operationId":"account-load-balancer-monitors-monitor-details","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/monitor_components-schemas-identifier"}},{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Monitor Details response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/monitor_components-schemas-single_response-2"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Monitor Details response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/monitor_components-schemas-single_response-2"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"patch":{"tags":["Account Load Balancer Monitors"],"summary":"Patch Monitor","description":"Apply changes to an existing monitor, overwriting the supplied properties.","operationId":"account-load-balancer-monitors-patch-monitor","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/monitor_components-schemas-identifier"}},{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"allow_insecure":{"$ref":"#/components/schemas/allow_insecure"},"consecutive_down":{"$ref":"#/components/schemas/consecutive_down"},"consecutive_up":{"$ref":"#/components/schemas/consecutive_up"},"description":{"$ref":"#/components/schemas/monitor_components-schemas-description"},"expected_body":{"$ref":"#/components/schemas/expected_body"},"expected_codes":{"$ref":"#/components/schemas/schemas-expected_codes"},"follow_redirects":{"$ref":"#/components/schemas/follow_redirects"},"header":{"$ref":"#/components/schemas/header"},"interval":{"$ref":"#/components/schemas/interval"},"method":{"$ref":"#/components/schemas/schemas-method"},"path":{"$ref":"#/components/schemas/path"},"port":{"$ref":"#/components/schemas/monitor_components-schemas-port"},"probe_zone":{"$ref":"#/components/schemas/probe_zone"},"retries":{"$ref":"#/components/schemas/retries"},"timeout":{"$ref":"#/components/schemas/schemas-timeout"},"type":{"$ref":"#/components/schemas/monitor_components-schemas-type"}}}}}},"responses":{"4xx":{"description":"Patch Monitor response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/monitor_components-schemas-single_response-2"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Patch Monitor response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/monitor_components-schemas-single_response-2"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"put":{"tags":["Account Load Balancer Monitors"],"summary":"Update Monitor","description":"Modify a configured monitor.","operationId":"account-load-balancer-monitors-update-monitor","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/monitor_components-schemas-identifier"}},{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["expected_codes"],"properties":{"allow_insecure":{"$ref":"#/components/schemas/allow_insecure"},"consecutive_down":{"$ref":"#/components/schemas/consecutive_down"},"consecutive_up":{"$ref":"#/components/schemas/consecutive_up"},"description":{"$ref":"#/components/schemas/monitor_components-schemas-description"},"expected_body":{"$ref":"#/components/schemas/expected_body"},"expected_codes":{"$ref":"#/components/schemas/schemas-expected_codes"},"follow_redirects":{"$ref":"#/components/schemas/follow_redirects"},"header":{"$ref":"#/components/schemas/header"},"interval":{"$ref":"#/components/schemas/interval"},"method":{"$ref":"#/components/schemas/schemas-method"},"path":{"$ref":"#/components/schemas/path"},"port":{"$ref":"#/components/schemas/monitor_components-schemas-port"},"probe_zone":{"$ref":"#/components/schemas/probe_zone"},"retries":{"$ref":"#/components/schemas/retries"},"timeout":{"$ref":"#/components/schemas/schemas-timeout"},"type":{"$ref":"#/components/schemas/monitor_components-schemas-type"}}}}}},"responses":{"4xx":{"description":"Update Monitor response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/monitor_components-schemas-single_response-2"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Update Monitor response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/monitor_components-schemas-single_response-2"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{account_identifier}/load_balancers/monitors/{identifier}/preview":{"post":{"tags":["Account Load Balancer Monitors"],"summary":"Preview Monitor","description":"Preview pools using the specified monitor with provided monitor details. The returned preview_id can be used in the preview endpoint to retrieve the results.","operationId":"account-load-balancer-monitors-preview-monitor","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/monitor_components-schemas-identifier"}},{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["expected_codes"],"properties":{"allow_insecure":{"$ref":"#/components/schemas/allow_insecure"},"expected_body":{"$ref":"#/components/schemas/expected_body"},"expected_codes":{"$ref":"#/components/schemas/schemas-expected_codes"},"follow_redirects":{"$ref":"#/components/schemas/follow_redirects"},"header":{"$ref":"#/components/schemas/header"},"method":{"$ref":"#/components/schemas/schemas-method"},"path":{"$ref":"#/components/schemas/path"},"port":{"$ref":"#/components/schemas/monitor_components-schemas-port"},"probe_zone":{"$ref":"#/components/schemas/probe_zone"},"retries":{"$ref":"#/components/schemas/retries"},"timeout":{"$ref":"#/components/schemas/schemas-timeout"},"type":{"$ref":"#/components/schemas/monitor_components-schemas-type"}}}}}},"responses":{"4xx":{"description":"Preview Monitor response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/preview_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Preview Monitor response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/preview_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{account_identifier}/load_balancers/monitors/{identifier}/references":{"get":{"tags":["Account Load Balancer Monitors"],"summary":"List Monitor References","description":"Get the list of resources that reference the provided monitor.","operationId":"account-load-balancer-monitors-list-monitor-references","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/monitor_components-schemas-identifier"}},{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"List Monitor References response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/references_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"List Monitor References response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/references_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{account_identifier}/load_balancers/pools":{"get":{"tags":["Account Load Balancer Pools"],"summary":"List Pools","description":"List configured pools.","operationId":"account-load-balancer-pools-list-pools","parameters":[{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"List Pools response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/pool_components-schemas-response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"List Pools response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/pool_components-schemas-response_collection"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"patch":{"tags":["Account Load Balancer Pools"],"summary":"Patch Pools","description":"Apply changes to a number of existing pools, overwriting the supplied properties. Pools are ordered by ascending `name`. Returns the list of affected pools. Supports the standard pagination query parameters, either `limit`/`offset` or `per_page`/`page`.","operationId":"account-load-balancer-pools-patch-pools","parameters":[{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"notification_email":{"$ref":"#/components/schemas/patch_pools_notification_email"}}}}}},"responses":{"4xx":{"description":"Patch Pools response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/pool_components-schemas-response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Patch Pools response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/pool_components-schemas-response_collection"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"post":{"tags":["Account Load Balancer Pools"],"summary":"Create Pool","description":"Create a new pool.","operationId":"account-load-balancer-pools-create-pool","parameters":[{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["origins","name"],"properties":{"description":{"$ref":"#/components/schemas/pool_components-schemas-description"},"enabled":{"$ref":"#/components/schemas/pool_components-schemas-enabled"},"latitude":{"$ref":"#/components/schemas/latitude"},"load_shedding":{"$ref":"#/components/schemas/load_shedding"},"longitude":{"$ref":"#/components/schemas/longitude"},"minimum_origins":{"$ref":"#/components/schemas/minimum_origins"},"monitor":{"$ref":"#/components/schemas/schemas-monitor"},"name":{"$ref":"#/components/schemas/pool_components-schemas-name"},"notification_email":{"$ref":"#/components/schemas/notification_email"},"notification_filter":{"$ref":"#/components/schemas/notification_filter"},"origin_steering":{"$ref":"#/components/schemas/origin_steering"},"origins":{"$ref":"#/components/schemas/origins"}}}}}},"responses":{"4xx":{"description":"Create Pool response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/pool_components-schemas-single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Create Pool response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/pool_components-schemas-single_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{account_identifier}/load_balancers/pools/{identifier}":{"delete":{"tags":["Account Load Balancer Pools"],"summary":"Delete Pool","description":"Delete a configured pool.","operationId":"account-load-balancer-pools-delete-pool","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/pool_components-schemas-identifier"}},{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{"4xx":{"description":"Delete Pool response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/pool_components-schemas-id_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Delete Pool response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/pool_components-schemas-id_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"get":{"tags":["Account Load Balancer Pools"],"summary":"Pool Details","description":"Fetch a single configured pool.","operationId":"account-load-balancer-pools-pool-details","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/pool_components-schemas-identifier"}},{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Pool Details response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/pool_components-schemas-single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Pool Details response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/pool_components-schemas-single_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"patch":{"tags":["Account Load Balancer Pools"],"summary":"Patch Pool","description":"Apply changes to an existing pool, overwriting the supplied properties.","operationId":"account-load-balancer-pools-patch-pool","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/pool_components-schemas-identifier"}},{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"check_regions":{"$ref":"#/components/schemas/check_regions"},"description":{"$ref":"#/components/schemas/pool_components-schemas-description"},"disabled_at":{"$ref":"#/components/schemas/schemas-disabled_at"},"enabled":{"$ref":"#/components/schemas/pool_components-schemas-enabled"},"latitude":{"$ref":"#/components/schemas/latitude"},"load_shedding":{"$ref":"#/components/schemas/load_shedding"},"longitude":{"$ref":"#/components/schemas/longitude"},"minimum_origins":{"$ref":"#/components/schemas/minimum_origins"},"monitor":{"$ref":"#/components/schemas/schemas-monitor"},"name":{"$ref":"#/components/schemas/pool_components-schemas-name"},"notification_email":{"$ref":"#/components/schemas/notification_email"},"notification_filter":{"$ref":"#/components/schemas/notification_filter"},"origin_steering":{"$ref":"#/components/schemas/origin_steering"},"origins":{"$ref":"#/components/schemas/origins"}}}}}},"responses":{"4xx":{"description":"Patch Pool response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/pool_components-schemas-single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Patch Pool response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/pool_components-schemas-single_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"put":{"tags":["Account Load Balancer Pools"],"summary":"Update Pool","description":"Modify a configured pool.","operationId":"account-load-balancer-pools-update-pool","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/pool_components-schemas-identifier"}},{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["origins","name"],"properties":{"check_regions":{"$ref":"#/components/schemas/check_regions"},"description":{"$ref":"#/components/schemas/pool_components-schemas-description"},"disabled_at":{"$ref":"#/components/schemas/schemas-disabled_at"},"enabled":{"$ref":"#/components/schemas/pool_components-schemas-enabled"},"latitude":{"$ref":"#/components/schemas/latitude"},"load_shedding":{"$ref":"#/components/schemas/load_shedding"},"longitude":{"$ref":"#/components/schemas/longitude"},"minimum_origins":{"$ref":"#/components/schemas/minimum_origins"},"monitor":{"$ref":"#/components/schemas/schemas-monitor"},"name":{"$ref":"#/components/schemas/pool_components-schemas-name"},"notification_email":{"$ref":"#/components/schemas/notification_email"},"notification_filter":{"$ref":"#/components/schemas/notification_filter"},"origin_steering":{"$ref":"#/components/schemas/origin_steering"},"origins":{"$ref":"#/components/schemas/origins"}}}}}},"responses":{"4xx":{"description":"Update Pool response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/pool_components-schemas-single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Update Pool response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/pool_components-schemas-single_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{account_identifier}/load_balancers/pools/{identifier}/health":{"get":{"tags":["Account Load Balancer Pools"],"summary":"Pool Health Details","description":"Fetch the latest pool health status for a single pool.","operationId":"account-load-balancer-pools-pool-health-details","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/pool_components-schemas-identifier"}},{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Pool Health Details response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/health_details"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Pool Health Details response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/health_details"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{account_identifier}/load_balancers/pools/{identifier}/preview":{"post":{"tags":["Account Load Balancer Pools"],"summary":"Preview Pool","description":"Preview pool health using provided monitor details. The returned preview_id can be used in the preview endpoint to retrieve the results.","operationId":"account-load-balancer-pools-preview-pool","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/pool_components-schemas-identifier"}},{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["expected_codes"],"properties":{"allow_insecure":{"$ref":"#/components/schemas/allow_insecure"},"expected_body":{"$ref":"#/components/schemas/expected_body"},"expected_codes":{"$ref":"#/components/schemas/schemas-expected_codes"},"follow_redirects":{"$ref":"#/components/schemas/follow_redirects"},"header":{"$ref":"#/components/schemas/header"},"method":{"$ref":"#/components/schemas/schemas-method"},"path":{"$ref":"#/components/schemas/path"},"port":{"$ref":"#/components/schemas/monitor_components-schemas-port"},"probe_zone":{"$ref":"#/components/schemas/probe_zone"},"retries":{"$ref":"#/components/schemas/retries"},"timeout":{"$ref":"#/components/schemas/schemas-timeout"},"type":{"$ref":"#/components/schemas/monitor_components-schemas-type"}}}}}},"responses":{"4xx":{"description":"Preview Pool response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/preview_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Preview Pool response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/preview_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{account_identifier}/load_balancers/pools/{identifier}/references":{"get":{"tags":["Account Load Balancer Pools"],"summary":"List Pool References","description":"Get the list of resources that reference the provided pool.","operationId":"account-load-balancer-pools-list-pool-references","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/pool_components-schemas-identifier"}},{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"List Pool References response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/schemas-references_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"List Pool References response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/schemas-references_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{account_identifier}/load_balancers/preview/{preview_id}":{"get":{"tags":["Account Load Balancer Monitors"],"summary":"Preview Result","description":"Get the result of a previous preview operation using the provided preview_id.","operationId":"account-load-balancer-monitors-preview-result","parameters":[{"name":"preview_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/schemas-preview_id"}},{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Preview Result response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/preview_result_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Preview Result response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/preview_result_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{account_identifier}/load_balancers/regions":{"get":{"tags":["Load Balancer Regions"],"summary":"List Regions","description":"List all region mappings.","operationId":"load-balancer-regions-list-regions","parameters":[{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"List Regions response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/region_components-schemas-response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"List Regions response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/region_components-schemas-response_collection"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{account_identifier}/load_balancers/regions/{region_code}":{"get":{"tags":["Load Balancer Regions"],"summary":"Get Region","description":"Get a single region mapping.","operationId":"load-balancer-regions-get-region","parameters":[{"name":"region_code","in":"path","required":true,"schema":{"$ref":"#/components/schemas/region_code"}},{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Get Region response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/region_components-schemas-single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Get Region response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/region_components-schemas-single_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{account_identifier}/load_balancers/search":{"get":{"tags":["Account Load Balancer Search"],"summary":"Search Resources","description":"Search for Load Balancing resources.","operationId":"account-load-balancer-search-search-resources","parameters":[{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Search Resources response failure","content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"$ref":"#/components/schemas/search_result"}]},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Search Resources response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"$ref":"#/components/schemas/search_result"}]}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{account_identifier}/magic/cf_interconnects":{"get":{"tags":["Magic Interconnects"],"summary":"List interconnects","description":"Lists interconnects associated with an account.","operationId":"magic-interconnects-list-interconnects","parameters":[{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"List interconnects response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/components-schemas-tunnels_collection_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"List interconnects response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/components-schemas-tunnels_collection_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"put":{"tags":["Magic Interconnects"],"summary":"Update multiple interconnects","description":"Updates multiple interconnects associated with an account. Use `?validate_only=true` as an optional query parameter to only run validation without persisting changes.","operationId":"magic-interconnects-update-multiple-interconnects","parameters":[{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["id"]}}}},"responses":{"4xx":{"description":"Update multiple interconnects response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/components-schemas-modified_tunnels_collection_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Update multiple interconnects response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/components-schemas-modified_tunnels_collection_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{account_identifier}/magic/cf_interconnects/{tunnel_identifier}":{"get":{"tags":["Magic Interconnects"],"summary":"List interconnect Details","description":"Lists details for a specific interconnect.","operationId":"magic-interconnects-list-interconnect-details","parameters":[{"name":"tunnel_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}},{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"List interconnect Details response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/components-schemas-tunnel_single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"List interconnect Details response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/components-schemas-tunnel_single_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"put":{"tags":["Magic Interconnects"],"summary":"Update interconnect","description":"Updates a specific interconnect associated with an account. Use `?validate_only=true` as an optional query parameter to only run validation without persisting changes.","operationId":"magic-interconnects-update-interconnect","parameters":[{"name":"tunnel_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}},{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/components-schemas-tunnel_update_request"}}}},"responses":{"4xx":{"description":"Update interconnect response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/components-schemas-tunnel_modified_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Update interconnect response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/components-schemas-tunnel_modified_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{account_identifier}/magic/gre_tunnels":{"get":{"tags":["Magic GRE tunnels"],"summary":"List GRE tunnels","description":"Lists GRE tunnels associated with an account.","operationId":"magic-gre-tunnels-list-gre-tunnels","parameters":[{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"List GRE tunnels response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/tunnels_collection_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"List GRE tunnels response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/tunnels_collection_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"post":{"tags":["Magic GRE tunnels"],"summary":"Create GRE tunnels","description":"Creates new GRE tunnels. Use `?validate_only=true` as an optional query parameter to only run validation without persisting changes.","operationId":"magic-gre-tunnels-create-gre-tunnels","parameters":[{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["name","customer_gre_endpoint","cloudflare_gre_endpoint","interface_address"]}}}},"responses":{"4xx":{"description":"Create GRE tunnels response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/tunnels_collection_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Create GRE tunnels response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/tunnels_collection_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"put":{"tags":["Magic GRE tunnels"],"summary":"Update multiple GRE tunnels","description":"Updates multiple GRE tunnels. Use `?validate_only=true` as an optional query parameter to only run validation without persisting changes.","operationId":"magic-gre-tunnels-update-multiple-gre-tunnels","parameters":[{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["id"]}}}},"responses":{"4xx":{"description":"Update multiple GRE tunnels response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/modified_tunnels_collection_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Update multiple GRE tunnels response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/modified_tunnels_collection_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{account_identifier}/magic/gre_tunnels/{tunnel_identifier}":{"delete":{"tags":["Magic GRE tunnels"],"summary":"Delete GRE Tunnel","description":"Disables and removes a specific static GRE tunnel. Use `?validate_only=true` as an optional query parameter to only run validation without persisting changes.","operationId":"magic-gre-tunnels-delete-gre-tunnel","parameters":[{"name":"tunnel_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}},{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{"4xx":{"description":"Delete GRE Tunnel response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/tunnel_deleted_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Delete GRE Tunnel response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/tunnel_deleted_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"get":{"tags":["Magic GRE tunnels"],"summary":"List GRE Tunnel Details","description":"Lists informtion for a specific GRE tunnel.","operationId":"magic-gre-tunnels-list-gre-tunnel-details","parameters":[{"name":"tunnel_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}},{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"List GRE Tunnel Details response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/tunnel_single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"List GRE Tunnel Details response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/tunnel_single_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"put":{"tags":["Magic GRE tunnels"],"summary":"Update GRE Tunnel","description":"Updates a specific GRE tunnel. Use `?validate_only=true` as an optional query parameter to only run validation without persisting changes.","operationId":"magic-gre-tunnels-update-gre-tunnel","parameters":[{"name":"tunnel_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}},{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/tunnel_update_request"}}}},"responses":{"4xx":{"description":"Update GRE Tunnel response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/tunnel_modified_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Update GRE Tunnel response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/tunnel_modified_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{account_identifier}/magic/ipsec_tunnels":{"get":{"tags":["Magic IPsec tunnels"],"summary":"List IPsec tunnels","description":"Lists IPsec tunnels associated with an account.","operationId":"magic-i-psec-tunnels-list-i-psec-tunnels","parameters":[{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"List IPsec tunnels response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/schemas-tunnels_collection_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"List IPsec tunnels response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/schemas-tunnels_collection_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"post":{"tags":["Magic IPsec tunnels"],"summary":"Create IPsec tunnels","description":"Creates new IPsec tunnels associated with an account. Use `?validate_only=true` as an optional query parameter to only run validation without persisting changes.","operationId":"magic-i-psec-tunnels-create-i-psec-tunnels","parameters":[{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["name","customer_ipsec_endpoint","cloudflare_ipsec_endpoint","interface_address"]}}}},"responses":{"4xx":{"description":"Create IPsec tunnels response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/schemas-tunnels_collection_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Create IPsec tunnels response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/schemas-tunnels_collection_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"put":{"tags":["Magic IPsec tunnels"],"summary":"Update multiple IPsec tunnels","description":"Update multiple IPsec tunnels associated with an account. Use `?validate_only=true` as an optional query parameter to only run validation without persisting changes.","operationId":"magic-i-psec-tunnels-update-multiple-i-psec-tunnels","parameters":[{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["id"]}}}},"responses":{"4xx":{"description":"Update multiple IPsec tunnels response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/schemas-modified_tunnels_collection_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Update multiple IPsec tunnels response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/schemas-modified_tunnels_collection_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{account_identifier}/magic/ipsec_tunnels/{tunnel_identifier}":{"delete":{"tags":["Magic IPsec tunnels"],"summary":"Delete IPsec Tunnel","description":"Disables and removes a specific static IPsec Tunnel associated with an account. Use `?validate_only=true` as an optional query parameter to only run validation without persisting changes.","operationId":"magic-i-psec-tunnels-delete-i-psec-tunnel","parameters":[{"name":"tunnel_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}},{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{"4xx":{"description":"Delete IPsec Tunnel response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/schemas-tunnel_deleted_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Delete IPsec Tunnel response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/schemas-tunnel_deleted_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"get":{"tags":["Magic IPsec tunnels"],"summary":"List IPsec tunnel details","description":"Lists details for a specific IPsec tunnel.","operationId":"magic-i-psec-tunnels-list-i-psec-tunnel-details","parameters":[{"name":"tunnel_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}},{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"List IPsec tunnel details response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/schemas-tunnel_single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"List IPsec tunnel details response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/schemas-tunnel_single_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"put":{"tags":["Magic IPsec tunnels"],"summary":"Update IPsec Tunnel","description":"Updates a specific IPsec tunnel associated with an account. Use `?validate_only=true` as an optional query parameter to only run validation without persisting changes.","operationId":"magic-i-psec-tunnels-update-i-psec-tunnel","parameters":[{"name":"tunnel_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}},{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/schemas-tunnel_update_request"}}}},"responses":{"4xx":{"description":"Update IPsec Tunnel response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/schemas-tunnel_modified_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Update IPsec Tunnel response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/schemas-tunnel_modified_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{account_identifier}/magic/ipsec_tunnels/{tunnel_identifier}/psk_generate":{"post":{"tags":["Magic IPsec tunnels"],"summary":"Generate Pre Shared Key (PSK) for IPsec tunnels","description":"Generates a Pre Shared Key for a specific IPsec tunnel used in the IKE session. Use `?validate_only=true` as an optional query parameter to only run validation without persisting changes. After a PSK is generated, the PSK is immediately persisted to Cloudflare's edge and cannot be retrieved later. Note the PSK in a safe place.","operationId":"magic-i-psec-tunnels-generate-pre-shared-key-(-psk)-for-i-psec-tunnels","parameters":[{"name":"tunnel_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}},{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{"4xx":{"description":"Generate Pre Shared Key (PSK) for IPsec tunnels response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/psk_generation_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Generate Pre Shared Key (PSK) for IPsec tunnels response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/psk_generation_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{account_identifier}/magic/routes":{"get":{"tags":["Magic Static Routes"],"summary":"List Routes","description":"List all Magic static routes.","operationId":"magic-static-routes-list-routes","parameters":[{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"List Routes response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/routes_collection_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"List Routes response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/routes_collection_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"post":{"tags":["Magic Static Routes"],"summary":"Create Routes","description":"Creates a new Magic static route. Use `?validate_only=true` as an optional query parameter to run validation only without persisting changes.","operationId":"magic-static-routes-create-routes","parameters":[{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["prefix","nexthop","priority"]}}}},"responses":{"4xx":{"description":"Create Routes response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/routes_collection_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Create Routes response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/routes_collection_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"put":{"tags":["Magic Static Routes"],"summary":"Update Many Routes","description":"Update multiple Magic static routes. Use `?validate_only=true` as an optional query parameter to run validation only without persisting changes. Only fields for a route that need to be changed need be provided.","operationId":"magic-static-routes-update-many-routes","parameters":[{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/route_update_many_request"}}}},"responses":{"4xx":{"description":"Update Many Routes response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/multiple_route_modified_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Update Many Routes response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/multiple_route_modified_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{account_identifier}/magic/routes/{route_identifier}":{"delete":{"tags":["Magic Static Routes"],"summary":"Delete Route","description":"Disable and remove a specific Magic static route.","operationId":"magic-static-routes-delete-route","parameters":[{"name":"route_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}},{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{"4xx":{"description":"Delete Route response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/route_deleted_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Delete Route response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/route_deleted_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"get":{"tags":["Magic Static Routes"],"summary":"Route Details","description":"Get a specific Magic static route.","operationId":"magic-static-routes-route-details","parameters":[{"name":"route_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}},{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Route Details response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/route_single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Route Details response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/route_single_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"put":{"tags":["Magic Static Routes"],"summary":"Update Route","description":"Update a specific Magic static route. Use `?validate_only=true` as an optional query parameter to run validation only without persisting changes.","operationId":"magic-static-routes-update-route","parameters":[{"name":"route_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}},{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/route_update_request"}}}},"responses":{"4xx":{"description":"Update Route response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/route_modified_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Update Route response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/route_modified_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{account_identifier}/members":{"get":{"tags":["Account Members"],"summary":"List Members","description":"List all members of an account.","operationId":"account-members-list-members","parameters":[{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/account_identifier"}}],"responses":{"4xx":{"description":"List Members response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"List Members response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_collection"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"post":{"tags":["Account Members"],"summary":"Add Member","description":"Add a user to the list of members for this account.","operationId":"account-members-add-member","parameters":[{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/account_identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/create"}}}},"responses":{"4xx":{"description":"Add Member response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Add Member response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_single"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{account_identifier}/members/{identifier}":{"delete":{"tags":["Account Members"],"summary":"Remove Member","description":"Remove a member from an account.","operationId":"account-members-remove-member","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/schemas-identifier"}},{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/account_identifier"}}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{"4xx":{"description":"Remove Member response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-response-single-id"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Remove Member response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-response-single-id"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"get":{"tags":["Account Members"],"summary":"Member Details","description":"Get information about a specific member of an account.","operationId":"account-members-member-details","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/schemas-identifier"}},{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/account_identifier"}}],"responses":{"4xx":{"description":"Member Details response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Member Details response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_single"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"put":{"tags":["Account Members"],"summary":"Update Member","description":"Modify an account member.","operationId":"account-members-update-member","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/schemas-identifier"}},{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/account_identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/schemas-member"}}}},"responses":{"4xx":{"description":"Update Member response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Update Member response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_single"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{account_identifier}/mnm/config":{"delete":{"tags":["Magic Network Monitoring Configuration"],"summary":"Delete account configuration","description":"Delete an existing network monitoring configuration.","operationId":"magic-network-monitoring-configuration-delete-account-configuration","parameters":[{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/config_components-schemas-account_identifier"}}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{"4xx":{"description":"Delete account configuration response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/mnm_config"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Delete account configuration response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/mnm_config"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"get":{"tags":["Magic Network Monitoring Configuration"],"summary":"List account configuration","description":"Lists default sampling and router IPs for account.","operationId":"magic-network-monitoring-configuration-list-account-configuration","parameters":[{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/config_components-schemas-account_identifier"}}],"responses":{"4xx":{"description":"List account configuration response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/mnm_config"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"List account configuration response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/mnm_config"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"patch":{"tags":["Magic Network Monitoring Configuration"],"summary":"Update account configuration fields","description":"Update fields in an existing network monitoring configuration.","operationId":"magic-network-monitoring-configuration-update-account-configuration-fields","parameters":[{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/config_components-schemas-account_identifier"}}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{"4xx":{"description":"Update account configuration fields response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/mnm_config"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Update account configuration fields response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/mnm_config"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"post":{"tags":["Magic Network Monitoring Configuration"],"summary":"Create account configuration","description":"Create a new network monitoring configuration.","operationId":"magic-network-monitoring-configuration-create-account-configuration","parameters":[{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/config_components-schemas-account_identifier"}}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{"4xx":{"description":"Create account configuration response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/mnm_config"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Create account configuration response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/mnm_config"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"put":{"tags":["Magic Network Monitoring Configuration"],"summary":"Update an entire account configuration","description":"Update an existing network monitoring configuration, requires the entire configuration to be updated at once.","operationId":"magic-network-monitoring-configuration-update-an-entire-account-configuration","parameters":[{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/config_components-schemas-account_identifier"}}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{"4xx":{"description":"Update an entire account configuration response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/mnm_config"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Update an entire account configuration response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/mnm_config"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{account_identifier}/mnm/config/full":{"get":{"tags":["Magic Network Monitoring Configuration"],"summary":"List rules and account configuration","description":"Lists default sampling, router IPs, and rules for account.","operationId":"magic-network-monitoring-configuration-list-rules-and-account-configuration","parameters":[{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/config_components-schemas-account_identifier"}}],"responses":{"4xx":{"description":"List rules and account configuration response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/mnm_config"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"List rules and account configuration response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/mnm_config"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{account_identifier}/mnm/rules":{"get":{"tags":["Magic Network Monitoring Rules"],"summary":"List rules","description":"Lists network monitoring rules for account.","operationId":"magic-network-monitoring-rules-list-rules","parameters":[{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/rules_components-schemas-account_identifier"}}],"responses":{"4xx":{"description":"List rules response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/mnm_rules"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"List rules response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/mnm_rules"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"post":{"tags":["Magic Network Monitoring Rules"],"summary":"Create rules","description":"Create network monitoring rules for account.","operationId":"magic-network-monitoring-rules-create-rules","parameters":[{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/rules_components-schemas-account_identifier"}}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{"4xx":{"description":"Create rules response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/mnm_rules"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Create rules response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/mnm_rules"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"put":{"tags":["Magic Network Monitoring Rules"],"summary":"Update rules","description":"Update network monitoring rules for account.","operationId":"magic-network-monitoring-rules-update-rules","parameters":[{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/rules_components-schemas-account_identifier"}}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{"4xx":{"description":"Update rules response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/mnm_rules"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Update rules response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/mnm_rules"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{account_identifier}/mnm/rules/{rule_identifier}":{"delete":{"tags":["Magic Network Monitoring Rules"],"summary":"Delete rule","description":"Delete a network monitoring rule for account.","operationId":"magic-network-monitoring-rules-delete-rule","parameters":[{"name":"rule_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/schemas-rule_identifier"}},{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/rules_components-schemas-account_identifier"}}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{"4xx":{"description":"Delete rule response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/mnm_rule"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Delete rule response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/mnm_rule"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"get":{"tags":["Magic Network Monitoring Rules"],"summary":"Get rule","description":"List a single network monitoring rule for account.","operationId":"magic-network-monitoring-rules-get-rule","parameters":[{"name":"rule_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/schemas-rule_identifier"}},{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/rules_components-schemas-account_identifier"}}],"responses":{"4xx":{"description":"Get rule response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/mnm_rule"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Get rule response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/mnm_rule"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"patch":{"tags":["Magic Network Monitoring Rules"],"summary":"Update rule","description":"Update a network monitoring rule for account.","operationId":"magic-network-monitoring-rules-update-rule","parameters":[{"name":"rule_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/schemas-rule_identifier"}},{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/rules_components-schemas-account_identifier"}}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{"4xx":{"description":"Update rule response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/mnm_rule"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Update rule response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/mnm_rule"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{account_identifier}/mnm/rules/{rule_identifier}/advertisement":{"patch":{"tags":["Magic Network Monitoring Rules"],"summary":"Update advertisement for rule","description":"Update advertisement for rule.","operationId":"magic-network-monitoring-rules-update-advertisement-for-rule","parameters":[{"name":"rule_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/schemas-rule_identifier"}},{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/rules_components-schemas-account_identifier"}}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{"4xx":{"description":"Update advertisement for rule response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/mnm_rule_automatic_advertisement"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Update advertisement for rule response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/mnm_rule_automatic_advertisement"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{account_identifier}/pages/projects":{"get":{"tags":["Pages Project"],"summary":"Get projects","description":"Fetch a list of all user projects.","operationId":"pages-project-get-projects","parameters":[{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/identifier"}}],"responses":{"4xx":{"description":"Get projects response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/projects-response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Get projects response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/projects-response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"post":{"tags":["Pages Project"],"summary":"Create project","description":"Make a new project.","operationId":"pages-project-create-project","parameters":[{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/projects"}}}},"responses":{"4xx":{"description":"Create project response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/new-project-response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Create project response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/new-project-response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{account_identifier}/pages/projects/{project_name}":{"delete":{"tags":["Pages Project"],"summary":"Delete project","description":"Destroy a project by name.","operationId":"pages-project-delete-project","parameters":[{"name":"project_name","in":"path","required":true,"schema":{"$ref":"#/components/schemas/project_name"}},{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/identifier"}}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{"4xx":{"description":"Delete project response failure","content":{"application/json":{"schema":{"allOf":[{"example":{"errors":[],"messages":[],"result":null,"success":true}},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Delete project response","content":{"application/json":{"schema":{"example":{"errors":[],"messages":[],"result":null,"success":true}}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"get":{"tags":["Pages Project"],"summary":"Get project","description":"Fetch a project by name.","operationId":"pages-project-get-project","parameters":[{"name":"project_name","in":"path","required":true,"schema":{"$ref":"#/components/schemas/project_name"}},{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/identifier"}}],"responses":{"4xx":{"description":"Get project response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/project-response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Get project response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/project-response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"patch":{"tags":["Pages Project"],"summary":"Update project","description":"Set new attributes for an existing project. Modify environment variables. To delete an environment variable, set the key to null.","operationId":"pages-project-update-project","parameters":[{"name":"project_name","in":"path","required":true,"schema":{"$ref":"#/components/schemas/project_name"}},{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/project-patch"}}}},"responses":{"4xx":{"description":"Update project response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/new-project-response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Update project response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/new-project-response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{account_identifier}/pages/projects/{project_name}/deployments":{"get":{"tags":["Pages Deployment"],"summary":"Get deployments","description":"Fetch a list of deployments from a project.","operationId":"pages-deployment-get-deployments","parameters":[{"name":"project_name","in":"path","required":true,"schema":{"$ref":"#/components/schemas/project_name"}},{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/identifier"}}],"responses":{"4xx":{"description":"Get deployments response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/deployment-list-response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Get deployments response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/deployment-list-response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"post":{"tags":["Pages Deployment"],"summary":"Create deployment","description":"Start a new deployment from production. The repo/account must have been authorized through the Pages UI dash before.","operationId":"pages-deployment-create-deployment","parameters":[{"name":"project_name","in":"path","required":true,"schema":{"$ref":"#/components/schemas/project_name"}},{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/identifier"}}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{"4xx":{"description":"Create deployment response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/deployment-new-deployment"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Create deployment response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/deployment-new-deployment"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{account_identifier}/pages/projects/{project_name}/deployments/{deployment_identifier}":{"delete":{"tags":["Pages Deployment"],"summary":"Delete deployment","description":"Destroy a deployment.","operationId":"pages-deployment-delete-deployment","parameters":[{"name":"deployment_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/identifier"}},{"name":"project_name","in":"path","required":true,"schema":{"$ref":"#/components/schemas/project_name"}},{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/identifier"}}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{"4xx":{"description":"Delete deployment response failure","content":{"application/json":{"schema":{"allOf":[{"example":{"errors":[],"messages":[],"result":null,"success":true}},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Delete deployment response","content":{"application/json":{"schema":{"example":{"errors":[],"messages":[],"result":null,"success":true}}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"get":{"tags":["Pages Deployment"],"summary":"Get deployment info","description":"Fetch a deployment.","operationId":"pages-deployment-get-deployment-info","parameters":[{"name":"deployment_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/identifier"}},{"name":"project_name","in":"path","required":true,"schema":{"$ref":"#/components/schemas/project_name"}},{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/identifier"}}],"responses":{"4xx":{"description":"Get deployment info response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/deployment-response-details"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Get deployment info response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/deployment-response-details"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{account_identifier}/pages/projects/{project_name}/deployments/{deployment_identifier}/history/logs":{"get":{"tags":["Pages Deployment"],"summary":"Get deployment logs","description":"Fetch deploy logs.","operationId":"pages-deployment-get-deployment-logs","parameters":[{"name":"deployment_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/identifier"}},{"name":"project_name","in":"path","required":true,"schema":{"$ref":"#/components/schemas/project_name"}},{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/identifier"}}],"responses":{"4xx":{"description":"Get deployment logs response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/deployment-response-logs"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Get deployment logs response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/deployment-response-logs"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{account_identifier}/pages/projects/{project_name}/deployments/{deployment_identifier}/retry":{"post":{"tags":["Pages Deployment"],"summary":"Retry deployment","description":"Retry a previous deployment.","operationId":"pages-deployment-retry-deployment","parameters":[{"name":"deployment_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/identifier"}},{"name":"project_name","in":"path","required":true,"schema":{"$ref":"#/components/schemas/project_name"}},{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/identifier"}}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{"4xx":{"description":"Retry deployment response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/deployment-new-deployment"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Retry deployment response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/deployment-new-deployment"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{account_identifier}/pages/projects/{project_name}/deployments/{deployment_identifier}/rollback":{"post":{"tags":["Pages Deployment"],"summary":"Rollback deployment","description":"Rollback the production deployment to a previous deploy. You can only rollback to succesful builds on production.","operationId":"pages-deployment-rollback-deployment","parameters":[{"name":"deployment_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/identifier"}},{"name":"project_name","in":"path","required":true,"schema":{"$ref":"#/components/schemas/project_name"}},{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/identifier"}}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{"4xx":{"description":"Rollback deployment response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/deployment-response-details"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Rollback deployment response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/deployment-response-details"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{account_identifier}/pages/projects/{project_name}/domains":{"get":{"tags":["Pages Domains"],"summary":"Get domains","description":"Fetch a list of all domains.","operationId":"pages-domains-get-domains","parameters":[{"name":"project_name","in":"path","required":true,"schema":{"$ref":"#/components/schemas/project_name"}},{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/identifier"}}],"responses":{"4xx":{"description":"Get domains response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/domain-response-collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Get domains response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/domain-response-collection"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"post":{"tags":["Pages Domains"],"summary":"Add domain","description":"Add a new domain for the Pages project.","operationId":"pages-domains-add-domain","parameters":[{"name":"project_name","in":"path","required":true,"schema":{"$ref":"#/components/schemas/project_name"}},{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/domains-post"}}}},"responses":{"4xx":{"description":"Add domain response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/domain-response-single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Add domain response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/domain-response-single"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{account_identifier}/pages/projects/{project_name}/domains/{domain_name}":{"delete":{"tags":["Pages Domains"],"summary":"Delete domain","description":"Delete a domain.","operationId":"pages-domains-delete-domain","parameters":[{"name":"domain_name","in":"path","required":true,"schema":{"$ref":"#/components/schemas/domain_name"}},{"name":"project_name","in":"path","required":true,"schema":{"$ref":"#/components/schemas/project_name"}},{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/identifier"}}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{"4xx":{"description":"Delete domain response failure","content":{"application/json":{"schema":{"allOf":[{"example":{"errors":[],"messages":[],"result":null,"success":true}},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Delete domain response","content":{"application/json":{"schema":{"example":{"errors":[],"messages":[],"result":null,"success":true}}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"get":{"tags":["Pages Domains"],"summary":"Get domain","description":"Fetch a single domain.","operationId":"pages-domains-get-domain","parameters":[{"name":"domain_name","in":"path","required":true,"schema":{"$ref":"#/components/schemas/domain_name"}},{"name":"project_name","in":"path","required":true,"schema":{"$ref":"#/components/schemas/project_name"}},{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/identifier"}}],"responses":{"4xx":{"description":"Get domain response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/domain-response-single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Get domain response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/domain-response-single"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"patch":{"tags":["Pages Domains"],"summary":"Patch domain","description":"Retry the validation status of a single domain.","operationId":"pages-domains-patch-domain","parameters":[{"name":"domain_name","in":"path","required":true,"schema":{"$ref":"#/components/schemas/domain_name"}},{"name":"project_name","in":"path","required":true,"schema":{"$ref":"#/components/schemas/project_name"}},{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/identifier"}}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{"4xx":{"description":"Patch domain response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/domain-response-single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Patch domain response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/domain-response-single"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{account_identifier}/pcaps":{"get":{"tags":["Magic PCAP collection"],"summary":"List packet capture requests","description":"Lists all packet capture requests for an account.","operationId":"magic-pcap-collection-list-packet-capture-requests","parameters":[{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"List packet capture requests response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/pcaps_collection_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"List packet capture requests response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/pcaps_collection_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"post":{"tags":["Magic PCAP collection"],"summary":"Create PCAP request","description":"Create new PCAP request for account.","operationId":"magic-pcap-collection-create-pcap-request","parameters":[{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/pcaps_request_pcap"}}}},"responses":{"4xx":{"description":"Create PCAP request response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/pcaps_single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Create PCAP request response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/pcaps_single_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{account_identifier}/pcaps/{identifier}":{"get":{"tags":["Magic PCAP collection"],"summary":"Get PCAP request","description":"Get information for a PCAP request by id.","operationId":"magic-pcap-collection-get-pcap-request","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}},{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Get PCAP request response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/pcaps_single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Get PCAP request response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/pcaps_single_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{account_identifier}/pcaps/{identifier}/download":{"get":{"tags":["Magic PCAP collection"],"summary":"Download Simple PCAP","description":"Download PCAP information into a file. Response is a binary PCAP file.","operationId":"magic-pcap-collection-download-simple-pcap","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}},{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Download Simple PCAP response failure","content":{"application/json":{}}},"200":{"description":"Download Simple PCAP response","content":{"application/json":{}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{account_identifier}/pcaps/ownership":{"get":{"tags":["Magic PCAP collection"],"summary":"List PCAPs Bucket Ownership","description":"List all buckets configured for use with PCAPs API.","operationId":"magic-pcap-collection-list-pca-ps-bucket-ownership","parameters":[{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"List PCAPs Bucket Ownership response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/pcaps_ownership_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"List PCAPs Bucket Ownership response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/pcaps_ownership_collection"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"post":{"tags":["Magic PCAP collection"],"summary":"Add buckets for full packet captures","description":"Adds an AWS or GCP bucket to use with full packet captures.","operationId":"magic-pcap-collection-add-buckets-for-full-packet-captures","parameters":[{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/pcaps_ownership_request"}}}},"responses":{"4xx":{"description":"Add buckets for full packet captures response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/pcaps_ownership_single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Add buckets for full packet captures response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/pcaps_ownership_single_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{account_identifier}/pcaps/ownership/{identifier}":{"delete":{"tags":["Magic PCAP collection"],"summary":"Delete buckets for full packet captures","description":"Deletes buckets added to the packet captures API.","operationId":"magic-pcap-collection-delete-buckets-for-full-packet-captures","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}},{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{"4xx":{"description":"Delete buckets for full packet captures response failure","content":{"application/json":{}}},"200":{"description":"Delete buckets for full packet captures response","content":{"application/json":{}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{account_identifier}/pcaps/ownership/validate":{"post":{"tags":["Magic PCAP collection"],"summary":"Validate buckets for full packet captures","description":"Validates buckets added to the packet captures API.","operationId":"magic-pcap-collection-validate-buckets-for-full-packet-captures","parameters":[{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/pcaps_ownership_validate_request"}}}},"responses":{"4xx":{"description":"Validate buckets for full packet captures response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/pcaps_ownership_single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Validate buckets for full packet captures response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/pcaps_ownership_single_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{account_identifier}/r2/buckets":{"get":{"tags":["R2 Bucket"],"summary":"List Buckets","description":"Lists all R2 buckets on your account","operationId":"r-2-bucket-list-buckets","parameters":[{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"List Buckets response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/r2-single-bucket-operation-response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"List Buckets response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/r2-single-bucket-operation-response"}}}}},"security":[{"api_token":[]}]},"post":{"tags":["R2 Bucket"],"summary":"Create Bucket","description":"Creates a new R2 bucket.","operationId":"r-2-bucket-create-bucket","parameters":[{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"example":"{'name': 'example-bucket'}"}}}},"responses":{"4xx":{"description":"Create Bucket response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/r2-single-bucket-operation-response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Create Bucket response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/r2-single-bucket-operation-response"}}}}},"security":[{"api_token":[]}]}},"/accounts/{account_identifier}/r2/buckets/{bucket_name}":{"delete":{"tags":["R2 Bucket"],"summary":"Delete Bucket","description":"Deletes an existing R2 bucket.","operationId":"r-2-bucket-delete-bucket","parameters":[{"name":"bucket_name","in":"path","required":true,"schema":{"$ref":"#/components/schemas/bucket_name"}},{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{"4xx":{"description":"Delete Bucket response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/r2-single-bucket-operation-response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Delete Bucket response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/r2-single-bucket-operation-response"}}}}},"security":[{"api_token":[]}]}},"/accounts/{account_identifier}/railguns":{"get":{"tags":["Account Railguns"],"summary":"List Railguns","description":"List, search, sort and filter your Railguns.","operationId":"account-railguns-list-railguns","parameters":[{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"List Railguns response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/railgun_response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"List Railguns response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/railgun_response_collection"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"post":{"tags":["Account Railguns"],"summary":"Create Railgun","operationId":"account-railguns-create-railgun","parameters":[{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["name"],"properties":{"name":{"$ref":"#/components/schemas/railgun_components-schemas-name"}}}}}},"responses":{"4xx":{"description":"Create Railgun response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/railgun_response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Create Railgun response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/railgun_response_single"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{account_identifier}/railguns/{identifier}":{"delete":{"tags":["Account Railguns"],"summary":"Delete a Railgun","description":"Disable and delete a Railgun. This will immediately disable the Railgun for any connected zones.","operationId":"account-railguns-delete-a-railgun","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/railgun_components-schemas-identifier"}},{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{"4xx":{"description":"Delete a Railgun response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/railgun_response_single_id"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Delete a Railgun response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/railgun_response_single_id"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"get":{"tags":["Account Railguns"],"summary":"Railgun details","operationId":"account-railguns-railgun-details","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/railgun_components-schemas-identifier"}},{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Railgun details response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/railgun_response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Railgun details response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/railgun_response_single"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"put":{"tags":["Account Railguns"],"summary":"Update Railgun","description":"Update a Railgun.","operationId":"account-railguns-update-railgun","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/railgun_components-schemas-identifier"}},{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/schemas-railgun"}}}},"responses":{"4xx":{"description":"Update Railgun response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/railgun_response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Update Railgun response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/railgun_response_single"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{account_identifier}/railguns/{railgun_identifier}/connections":{"get":{"tags":["Railgun Connections"],"summary":"List Connections","description":"List connections associated with the Railgun.","operationId":"railgun-connections-list-connections","parameters":[{"name":"railgun_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/railgun_components-schemas-identifier"}},{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"List Connections response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/connection_collection_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"List Connections response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/connection_collection_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"post":{"tags":["Railgun Connections"],"summary":"Create connection","description":"Associates a zone to the Railgun.","operationId":"railgun-connections-create-connection","parameters":[{"name":"railgun_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/railgun_components-schemas-identifier"}},{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/connection_single_request"}}}},"responses":{"4xx":{"description":"Create connection response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/connection_single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Create connection response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/connection_single_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{account_identifier}/railguns/{railgun_identifier}/connections/{identifier}":{"delete":{"tags":["Railgun Connections"],"summary":"Delete connection","description":"Disable and remove the connection to a zone.","operationId":"railgun-connections-delete-connection","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/connection_components-schemas-identifier"}},{"name":"railgun_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/railgun_components-schemas-identifier"}},{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{"4xx":{"description":"Delete connection response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/connection_single_id_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Delete connection response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/connection_single_id_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"get":{"tags":["Railgun Connections"],"summary":"Connection details","description":"Get a connection by ID.","operationId":"railgun-connections-connection-details","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/connection_components-schemas-identifier"}},{"name":"railgun_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/railgun_components-schemas-identifier"}},{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Connection details response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/connection_single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Connection details response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/connection_single_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"put":{"tags":["Railgun Connections"],"summary":"Update connection","description":"Enable or disable a connection.","operationId":"railgun-connections-update-connection","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/connection_components-schemas-identifier"}},{"name":"railgun_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/railgun_components-schemas-identifier"}},{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/schemas-connection"}}}},"responses":{"4xx":{"description":"Update connection response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/connection_single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Update connection response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/connection_single_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{account_identifier}/registrar/domains":{"post":{"tags":["Registrar Domains"],"summary":"List domains","description":"List domains handled by Registrar.","operationId":"registrar-domains-list-domains","parameters":[{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["id"],"properties":{"id":{"$ref":"#/components/schemas/domain_names"}}}}}},"responses":{"4xx":{"description":"List domains response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/domain_response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"List domains response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/domain_response_collection"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{account_identifier}/registrar/domains/{domain_name}":{"get":{"tags":["Registrar Domains"],"summary":"Get domain","description":"Show individual domain.","operationId":"registrar-domains-get-domain","parameters":[{"name":"domain_name","in":"path","required":true,"schema":{"$ref":"#/components/schemas/Cloudflare Client API_domain_name"}},{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Get domain response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/domain_response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Get domain response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/domain_response_single"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"put":{"tags":["Registrar Domains"],"summary":"Update domain","description":"Update individual domain.","operationId":"registrar-domains-update-domain","parameters":[{"name":"domain_name","in":"path","required":true,"schema":{"$ref":"#/components/schemas/Cloudflare Client API_domain_name"}},{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/domain_update_properties"}]}}}},"responses":{"4xx":{"description":"Update domain response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/domain_response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Update domain response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/domain_response_single"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{account_identifier}/roles":{"get":{"tags":["Account Roles"],"summary":"List Roles","description":"Get all available roles for an account.","operationId":"account-roles-list-roles","parameters":[{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/account_identifier"}}],"responses":{"4xx":{"description":"List Roles response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"List Roles response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_collection"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{account_identifier}/roles/{identifier}":{"get":{"tags":["Account Roles"],"summary":"Role Details","description":"Get information about a specific role for an account.","operationId":"account-roles-role-details","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/schemas-identifier"}},{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/account_identifier"}}],"responses":{"4xx":{"description":"Role Details response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Role Details response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_single"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{account_identifier}/rules/lists":{"get":{"tags":["Lists"],"summary":"Get lists","description":"Fetches all lists in the account.","operationId":"lists-get-lists","parameters":[{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Get lists response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/lists-response-collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Get lists response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/lists-response-collection"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"post":{"tags":["Lists"],"summary":"Create a list","description":"Creates a new list of the specified type.","operationId":"lists-create-a-list","parameters":[{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["name","kind"],"properties":{"description":{"$ref":"#/components/schemas/lists_components-schemas-description"},"kind":{"$ref":"#/components/schemas/kind"},"name":{"$ref":"#/components/schemas/lists_components-schemas-name"}}}}}},"responses":{"4xx":{"description":"Create a list response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/list-response-collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Create a list response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/list-response-collection"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{account_identifier}/rules/lists/{list_id}":{"delete":{"tags":["Lists"],"summary":"Delete a list","description":"Deletes a specific list and all its items.","operationId":"lists-delete-a-list","parameters":[{"name":"list_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/list_id"}},{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{"4xx":{"description":"Delete a list response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/list-delete-response-collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Delete a list response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/list-delete-response-collection"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"get":{"tags":["Lists"],"summary":"Get a list","description":"Fetches the details of a list.","operationId":"lists-get-a-list","parameters":[{"name":"list_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/list_id"}},{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Get a list response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/list-response-collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Get a list response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/list-response-collection"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"put":{"tags":["Lists"],"summary":"Update a list","description":"Updates the description of a list.","operationId":"lists-update-a-list","parameters":[{"name":"list_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/list_id"}},{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"description":{"$ref":"#/components/schemas/lists_components-schemas-description"}}}}}},"responses":{"4xx":{"description":"Update a list response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/list-response-collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Update a list response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/list-response-collection"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{account_identifier}/rules/lists/{list_id}/items":{"delete":{"tags":["Lists"],"summary":"Delete list items","description":"Removes one or more items from a list.\n\nThis operation is asynchronous. To get current the operation status, invoke the [Get bulk operation status](#lists-get-bulk-operation-status) endpoint with the returned `operation_id`.","operationId":"lists-delete-list-items","parameters":[{"name":"list_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/list_id"}},{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","minItems":1,"items":{"properties":{"id":{"$ref":"#/components/schemas/item_id"}}}}}}}}},"responses":{"4xx":{"description":"Delete list items response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/lists-async-response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Delete list items response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/lists-async-response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"get":{"tags":["Lists"],"summary":"Get list items","description":"Fetches all the items in the list.","operationId":"lists-get-list-items","parameters":[{"name":"list_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/list_id"}},{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Get list items response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/items-list-response-collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Get list items response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/items-list-response-collection"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"post":{"tags":["Lists"],"summary":"Create list items","description":"Appends new items to the list.\n\nThis operation is asynchronous. To get current the operation status, invoke the [Get bulk operation status](#lists-get-bulk-operation-status) endpoint with the returned `operation_id`.","operationId":"lists-create-list-items","parameters":[{"name":"list_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/list_id"}},{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/items-update-request-collection"}}}},"responses":{"4xx":{"description":"Create list items response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/lists-async-response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Create list items response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/lists-async-response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"put":{"tags":["Lists"],"summary":"Update all list items","description":"Removes all existing items from the list and adds the provided items to the list.\n\nThis operation is asynchronous. To get current the operation status, invoke the [Get bulk operation status](#lists-get-bulk-operation-status) endpoint with the returned `operation_id`.","operationId":"lists-update-all-list-items","parameters":[{"name":"list_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/list_id"}},{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/items-update-request-collection"}}}},"responses":{"4xx":{"description":"Update all list items response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/lists-async-response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Update all list items response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/lists-async-response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{account_identifier}/rules/lists/{list_id}/items/{item_id}":{"get":{"tags":["Lists"],"summary":"Get a list item","description":"Fetches a list item in the list.","operationId":"lists-get-a-list-item","parameters":[{"name":"item_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/item_id"}},{"name":"list_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/list_id"}},{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Get a list item response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/item-response-collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Get a list item response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/item-response-collection"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{account_identifier}/rules/lists/bulk_operations/{operation_id}":{"get":{"tags":["Lists"],"summary":"Get bulk operation status","description":"Gets the current status of an asynchronous operation on a list.\n\nThe `status` property can have one of the following values: `pending`, `running`, `completed`, or `failed`. If the status is `failed`, the `error` property will contain a message describing the error.","operationId":"lists-get-bulk-operation-status","parameters":[{"name":"operation_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/schemas-operation_id"}},{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Get bulk operation status response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/bulk-operation-response-collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Get bulk operation status response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bulk-operation-response-collection"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{account_identifier}/secondary_dns/acls":{"get":{"tags":["Secondary DNS (ACL)"],"summary":"List ACLs","description":"List ACLs.","operationId":"secondary-dns-(-acl)-list-ac-ls","parameters":[{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/schemas-account_identifier"}}],"responses":{"4xx":{"description":"List ACLs response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/acl_components-schemas-response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"List ACLs response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/acl_components-schemas-response_collection"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"post":{"tags":["Secondary DNS (ACL)"],"summary":"Create ACL","description":"Create ACL.","operationId":"secondary-dns-(-acl)-create-acl","parameters":[{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/schemas-account_identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["name","ip_range"]}}}},"responses":{"4xx":{"description":"Create ACL response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/acl_components-schemas-single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Create ACL response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/acl_components-schemas-single_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{account_identifier}/secondary_dns/acls/{identifier}":{"delete":{"tags":["Secondary DNS (ACL)"],"summary":"Delete ACL","description":"Delete ACL.","operationId":"secondary-dns-(-acl)-delete-acl","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/acl_components-schemas-identifier"}},{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/schemas-account_identifier"}}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{"4xx":{"description":"Delete ACL response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/acl_components-schemas-id_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Delete ACL response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/acl_components-schemas-id_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"get":{"tags":["Secondary DNS (ACL)"],"summary":"ACL Details","description":"Get ACL.","operationId":"secondary-dns-(-acl)-acl-details","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/acl_components-schemas-identifier"}},{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/schemas-account_identifier"}}],"responses":{"4xx":{"description":"ACL Details response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/acl_components-schemas-single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"ACL Details response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/acl_components-schemas-single_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"put":{"tags":["Secondary DNS (ACL)"],"summary":"Update ACL","description":"Modify ACL.","operationId":"secondary-dns-(-acl)-update-acl","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/acl_components-schemas-identifier"}},{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/schemas-account_identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/acl"}}}},"responses":{"4xx":{"description":"Update ACL response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/acl_components-schemas-single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Update ACL response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/acl_components-schemas-single_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{account_identifier}/secondary_dns/peers":{"get":{"tags":["Secondary DNS (Peer)"],"summary":"List Peers","description":"List Peers.","operationId":"secondary-dns-(-peer)-list-peers","parameters":[{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/schemas-account_identifier"}}],"responses":{"4xx":{"description":"List Peers response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/peer_components-schemas-response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"List Peers response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/peer_components-schemas-response_collection"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"post":{"tags":["Secondary DNS (Peer)"],"summary":"Create Peer","description":"Create Peer.","operationId":"secondary-dns-(-peer)-create-peer","parameters":[{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/schemas-account_identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["name"]}}}},"responses":{"4xx":{"description":"Create Peer response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/peer_components-schemas-single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Create Peer response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/peer_components-schemas-single_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{account_identifier}/secondary_dns/peers/{identifier}":{"delete":{"tags":["Secondary DNS (Peer)"],"summary":"Delete Peer","description":"Delete Peer.","operationId":"secondary-dns-(-peer)-delete-peer","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/peer_components-schemas-identifier"}},{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/schemas-account_identifier"}}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{"4xx":{"description":"Delete Peer response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/peer_components-schemas-id_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Delete Peer response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/peer_components-schemas-id_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"get":{"tags":["Secondary DNS (Peer)"],"summary":"Peer Details","description":"Get Peer.","operationId":"secondary-dns-(-peer)-peer-details","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/peer_components-schemas-identifier"}},{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/schemas-account_identifier"}}],"responses":{"4xx":{"description":"Peer Details response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/peer_components-schemas-single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Peer Details response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/peer_components-schemas-single_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"put":{"tags":["Secondary DNS (Peer)"],"summary":"Update Peer","description":"Modify Peer.","operationId":"secondary-dns-(-peer)-update-peer","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/peer_components-schemas-identifier"}},{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/schemas-account_identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/peer"}}}},"responses":{"4xx":{"description":"Update Peer response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/peer_components-schemas-single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Update Peer response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/peer_components-schemas-single_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{account_identifier}/secondary_dns/tsigs":{"get":{"tags":["Secondary DNS (TSIG)"],"summary":"List TSIGs","description":"List TSIGs.","operationId":"secondary-dns-(-tsig)-list-tsi-gs","parameters":[{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/schemas-account_identifier"}}],"responses":{"4xx":{"description":"List TSIGs response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/tsig_components-schemas-response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"List TSIGs response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/tsig_components-schemas-response_collection"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"post":{"tags":["Secondary DNS (TSIG)"],"summary":"Create TSIG","description":"Create TSIG.","operationId":"secondary-dns-(-tsig)-create-tsig","parameters":[{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/schemas-account_identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["name","algo"]}}}},"responses":{"4xx":{"description":"Create TSIG response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/components-schemas-single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Create TSIG response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/components-schemas-single_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{account_identifier}/secondary_dns/tsigs/{identifier}":{"delete":{"tags":["Secondary DNS (TSIG)"],"summary":"Delete TSIG","description":"Delete TSIG.","operationId":"secondary-dns-(-tsig)-delete-tsig","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/tsig_components-schemas-identifier"}},{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/schemas-account_identifier"}}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{"4xx":{"description":"Delete TSIG response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/components-schemas-id_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Delete TSIG response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/components-schemas-id_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"get":{"tags":["Secondary DNS (TSIG)"],"summary":"TSIG Details","description":"Get TSIG.","operationId":"secondary-dns-(-tsig)-tsig-details","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/tsig_components-schemas-identifier"}},{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/schemas-account_identifier"}}],"responses":{"4xx":{"description":"TSIG Details response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/components-schemas-single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"TSIG Details response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/components-schemas-single_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"put":{"tags":["Secondary DNS (TSIG)"],"summary":"Update TSIG","description":"Modify TSIG.","operationId":"secondary-dns-(-tsig)-update-tsig","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/tsig_components-schemas-identifier"}},{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/schemas-account_identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/tsig"}}}},"responses":{"4xx":{"description":"Update TSIG response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/components-schemas-single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Update TSIG response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/components-schemas-single_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{account_identifier}/storage/analytics":{"get":{"tags":["Workers KV Request Analytics"],"summary":"Query Request Analytics","description":"Retrieves Workers KV request metrics for the given account.","operationId":"workers-kv-request-analytics-query-request-analytics","parameters":[{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Query Request Analytics response failure","content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"type":"object","properties":{"result":{"$ref":"#/components/schemas/components-schemas-result"}}}]},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Query Request Analytics response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"type":"object","properties":{"result":{"$ref":"#/components/schemas/components-schemas-result"}}}]}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{account_identifier}/storage/analytics/stored":{"get":{"tags":["Workers KV Stored Data Analytics"],"summary":"Query Stored Data Analytics","description":"Retrieves Workers KV stored data metrics for the given account.","operationId":"workers-kv-stored-data-analytics-query-stored-data-analytics","parameters":[{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Query Stored Data Analytics response failure","content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"type":"object","properties":{"result":{"$ref":"#/components/schemas/stored_components-schemas-result"}}}]},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Query Stored Data Analytics response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"type":"object","properties":{"result":{"$ref":"#/components/schemas/stored_components-schemas-result"}}}]}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{account_identifier}/storage/kv/namespaces":{"get":{"tags":["Workers KV Namespace"],"summary":"List Namespaces","description":"Returns the namespaces owned by an account.","operationId":"workers-kv-namespace-list-namespaces","parameters":[{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"List Namespaces response failure","content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"type":"object","properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/namespace"}}}}]},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"List Namespaces response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"type":"object","properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/namespace"}}}}]}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"post":{"tags":["Workers KV Namespace"],"summary":"Create a Namespace","description":"Creates a namespace under the given title. A 400 is returned if the account already owns a namespace with this title. A namespace must be explicitly deleted to be replaced.","operationId":"workers-kv-namespace-create-a-namespace","parameters":[{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/create_rename_namespace_body"}}}},"responses":{"4xx":{"description":"Create a Namespace response failure","content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"type":"object","properties":{"result":{"$ref":"#/components/schemas/namespace"}}}]},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Create a Namespace response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"type":"object","properties":{"result":{"$ref":"#/components/schemas/namespace"}}}]}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{account_identifier}/storage/kv/namespaces/{namespace_identifier}":{"delete":{"tags":["Workers KV Namespace"],"summary":"Remove a Namespace","description":"Deletes the namespace corresponding to the given ID.","operationId":"workers-kv-namespace-remove-a-namespace","parameters":[{"name":"namespace_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/namespace_identifier"}},{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{"4xx":{"description":"Remove a Namespace response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Remove a Namespace response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-response-single"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"put":{"tags":["Workers KV Namespace"],"summary":"Rename a Namespace","description":"Modifies a namespace's title.","operationId":"workers-kv-namespace-rename-a-namespace","parameters":[{"name":"namespace_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/namespace_identifier"}},{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/create_rename_namespace_body"}}}},"responses":{"4xx":{"description":"Rename a Namespace response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Rename a Namespace response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-response-single"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{account_identifier}/storage/kv/namespaces/{namespace_identifier}/bulk":{"delete":{"tags":["Workers KV Namespace"],"summary":"Delete multiple key-value pairs","description":"Remove multiple KV pairs from the Namespace. Body should be an array of up to 10,000 keys to be removed.","operationId":"workers-kv-namespace-delete-multiple-key-value-pairs","parameters":[{"name":"namespace_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/namespace_identifier"}},{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/bulk_delete"}}}},"responses":{"4xx":{"description":"Delete multiple key-value pairs response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Delete multiple key-value pairs response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-response-single"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"put":{"tags":["Workers KV Namespace"],"summary":"Write multiple key-value pairs","description":"Write multiple keys and values at once. Body should be an array of up to 10,000 key-value pairs to be stored, along with optional expiration information. Existing values and expirations will be overwritten. If neither expiration nor expiration_ttl is specified, the key-value pair will never expire. If both are set, `expiration_ttl` is used and `expiration` is ignored. The entire request size must be 100 megabytes or less.","operationId":"workers-kv-namespace-write-multiple-key-value-pairs","parameters":[{"name":"namespace_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/namespace_identifier"}},{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/bulk_write"}}}},"responses":{"4xx":{"description":"Write multiple key-value pairs response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Write multiple key-value pairs response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-response-single"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{account_identifier}/storage/kv/namespaces/{namespace_identifier}/keys":{"get":{"tags":["Workers KV Namespace"],"summary":"List a Namespace's Keys","description":"Lists a namespace's keys.","operationId":"workers-kv-namespace-list-a-namespace'-s-keys","parameters":[{"name":"namespace_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/namespace_identifier"}},{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"List a Namespace's Keys response failure","content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/api-response-common"},{"properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/key"}},"result_info":{"properties":{"count":{"type":"number","description":"Total results returned based on your list parameters.","example":1},"cursor":{"$ref":"#/components/schemas/cursor"}}}}}]},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"List a Namespace's Keys response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-response-common"},{"properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/key"}},"result_info":{"properties":{"count":{"type":"number","description":"Total results returned based on your list parameters.","example":1},"cursor":{"$ref":"#/components/schemas/cursor"}}}}}]}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{account_identifier}/storage/kv/namespaces/{namespace_identifier}/metadata/{key_name}":{"get":{"tags":["Workers KV Namespace"],"summary":"Read the metadata for a key","description":"Returns the metadata associated with the given key in the given namespace. Use URL-encoding to use special characters (e.g. :, !, %) in the key name.","operationId":"workers-kv-namespace-read-the-metadata-for-a-key","parameters":[{"name":"key_name","in":"path","required":true,"schema":{"$ref":"#/components/schemas/key_name"}},{"name":"namespace_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/namespace_identifier"}},{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Read the metadata for a key response failure","content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/list_metadata"}}}]},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Read the metadata for a key response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/list_metadata"}}}]}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{account_identifier}/storage/kv/namespaces/{namespace_identifier}/values/{key_name}":{"delete":{"tags":["Workers KV Namespace"],"summary":"Delete key-value pair","description":"Remove a KV pair from the Namespace. Use URL-encoding to use special characters (e.g. :, !, %) in the key name.","operationId":"workers-kv-namespace-delete-key-value-pair","parameters":[{"name":"key_name","in":"path","required":true,"schema":{"$ref":"#/components/schemas/key_name"}},{"name":"namespace_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/namespace_identifier"}},{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{"4xx":{"description":"Delete key-value pair response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Delete key-value pair response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-response-single"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"get":{"tags":["Workers KV Namespace"],"summary":"Read key-value pair","description":"Returns the value associated with the given key in the given namespace. Use URL-encoding to use special characters (e.g. :, !, %) in the key name. If the KV-pair is set to expire at some point, the expiration time as measured in seconds since the UNIX epoch will be returned in the \"Expiration\" response header.","operationId":"workers-kv-namespace-read-key-value-pair","parameters":[{"name":"key_name","in":"path","required":true,"schema":{"$ref":"#/components/schemas/key_name"}},{"name":"namespace_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/namespace_identifier"}},{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Read key-value pair response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/kv_components-schemas-value"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Read key-value pair response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/kv_components-schemas-value"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"put":{"tags":["Workers KV Namespace"],"summary":"Write key-value pair with metadata","description":"Write a value identified by a key. Use URL-encoding to use special characters (e.g. :, !, %) in the key name. Body should be the value to be stored along with json metadata to be associated with the key/value pair. Existing values, expirations and metadata will be overwritten. If neither `expiration` nor `expiration_ttl` is specified, the key-value pair will never expire. If both are set, `expiration_ttl` is used and `expiration` is ignored.","operationId":"workers-kv-namespace-write-key-value-pair-with-metadata","parameters":[{"name":"key_name","in":"path","required":true,"schema":{"$ref":"#/components/schemas/key_name"}},{"name":"namespace_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/namespace_identifier"}},{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"type":"object","required":["value","metadata"],"properties":{"metadata":{"$ref":"#/components/schemas/components-schemas-metadata"},"value":{"$ref":"#/components/schemas/kv_components-schemas-value"}}}}}},"responses":{"4xx":{"description":"Write key-value pair with metadata response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Write key-value pair with metadata response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-response-single"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{account_identifier}/stream":{"get":{"tags":["Stream Videos"],"summary":"List videos","description":"Lists up to 1000 videos from a single request. For a specific range, refer to the optional parameters.","operationId":"stream-videos-list-videos","parameters":[{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/components-schemas-account_identifier"}}],"responses":{"4xx":{"description":"List videos response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/video_response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"List videos response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/video_response_collection"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"post":{"tags":["Stream Videos"],"summary":"Initiate video uploads using TUS","description":"Initiates a video upload using the TUS protocol. On success, the server responds with a status code 201 (created) and includes a `location` header to indicate where the content should be uploaded. Refer to https://tus.io for protocol details.","operationId":"stream-videos-initiate-video-uploads-using-tus","parameters":[{"name":"Tus-Resumable","in":"header","required":true,"schema":{"$ref":"#/components/schemas/tus_resumable"}},{"name":"Upload-Creator","in":"header","required":true,"schema":{"$ref":"#/components/schemas/creator"}},{"name":"Upload-Length","in":"header","required":true,"schema":{"$ref":"#/components/schemas/upload_length"}},{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/components-schemas-account_identifier"}}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{"4xx":{"description":"Initiate video uploads using TUS response failure","content":{"application/json":{}}},"200":{"description":"Initiate video uploads using TUS response","content":{"application/json":{}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{account_identifier}/stream/{identifier}":{"delete":{"tags":["Stream Videos"],"summary":"Delete video","description":"Deletes a video and its copies from Cloudflare Stream.","operationId":"stream-videos-delete-video","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/videos_components-schemas-identifier"}},{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/components-schemas-account_identifier"}}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{"4xx":{"description":"Delete video response failure","content":{"application/json":{}}},"200":{"description":"Delete video response","content":{"application/json":{}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"get":{"tags":["Stream Videos"],"summary":"Retrieve video details","description":"Fetches details for a single video.","operationId":"stream-videos-retrieve-video-details","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/videos_components-schemas-identifier"}},{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/components-schemas-account_identifier"}}],"responses":{"4xx":{"description":"Retrieve video details response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/video_response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Retrieve video details response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/video_response_single"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"post":{"tags":["Stream Videos"],"summary":"Associate videos to NFTs","description":"Asssociates videos with a token ID and contract address to transfer admin rights on a video. If a change in ownership of the ERC-721 token happens on the Ethereum blockchain, the new token owner can claim control of the video.","operationId":"stream-videos-associate-videos-to-nf-ts","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/videos_components-schemas-identifier"}},{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/components-schemas-account_identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/nft"}}}},"responses":{"4xx":{"description":"Associate videos to NFTs response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/video_response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Associate videos to NFTs response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/video_response_collection"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{account_identifier}/stream/{identifier}/embed":{"get":{"tags":["Stream Videos"],"summary":"Retreieve embed Code HTML","description":"Fetches an HTML code snippet to embed a video in a web page delivered through Cloudflare. On success, returns an HTML fragment for use on web pages to display a video. On failure, returns a JSON response body.","operationId":"stream-videos-retreieve-embed-code-html","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/videos_components-schemas-identifier"}},{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/components-schemas-account_identifier"}}],"responses":{"4xx":{"description":"Retreieve embed Code HTML response failure","content":{"application/json":{"schema":{"allOf":[{"example":"<stream id=\"ea95132c15732412d22c1476fa83f27a\"></stream><script data-cfasync=\"false\" defer type=\"text/javascript\" src=\"https://embed.cloudflarestream.com/embed/we4g.fla9.latest.js\"></script>"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Retreieve embed Code HTML response","content":{"application/json":{"schema":{"example":"<stream id=\"ea95132c15732412d22c1476fa83f27a\"></stream><script data-cfasync=\"false\" defer type=\"text/javascript\" src=\"https://embed.cloudflarestream.com/embed/we4g.fla9.latest.js\"></script>"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{account_identifier}/stream/{identifier}/token":{"post":{"tags":["Stream Videos"],"summary":"Create signed URL tokens for videso","description":"Creates a signed URL token for a video. If a body is not provided in the request, a token is created with default values.","operationId":"stream-videos-create-signed-url-tokens-for-videso","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/videos_components-schemas-identifier"}},{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/components-schemas-account_identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/signed_token_request"}}}},"responses":{"4xx":{"description":"Create signed URL tokens for videso response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/signed_token_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Create signed URL tokens for videso response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/signed_token_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{account_identifier}/stream/{video_identifier}/captions":{"get":{"tags":["Stream Subtitles/Captions"],"summary":"List captions or subtitles","description":"Lists the available captions or subtitles for a specific video.","operationId":"stream-subtitles/-captions-list-captions-or-subtitles","parameters":[{"name":"video_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/schemas-video_identifier"}},{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"List captions or subtitles response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/language_response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"List captions or subtitles response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/language_response_collection"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{account_identifier}/stream/{video_identifier}/captions/{language}":{"delete":{"tags":["Stream Subtitles/Captions"],"summary":"Delete captions or subtitles","description":"Removes the captions or subtitles from a video.","operationId":"stream-subtitles/-captions-delete-captions-or-subtitles","parameters":[{"name":"language","in":"path","required":true,"schema":{"$ref":"#/components/schemas/language"}},{"name":"video_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/schemas-video_identifier"}},{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{"4xx":{"description":"Delete captions or subtitles response failure","content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"type":"string","example":""}}}]},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Delete captions or subtitles response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"type":"string","example":""}}}]}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"put":{"tags":["Stream Subtitles/Captions"],"summary":"Upload captions or subtitles","description":"Uploads the caption or subtitle file to the endpoint for a specific BCP47 language. One caption or subtitle file per language is allowed.","operationId":"stream-subtitles/-captions-upload-captions-or-subtitles","parameters":[{"name":"language","in":"path","required":true,"schema":{"$ref":"#/components/schemas/language"}},{"name":"video_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/schemas-video_identifier"}},{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/caption_basic_upload"}}}},"responses":{"4xx":{"description":"Upload captions or subtitles response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/language_response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Upload captions or subtitles response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/language_response_single"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{account_identifier}/stream/{video_identifier}/downloads":{"get":{"tags":["Stream MP4 Downloads"],"summary":"List downloads","description":"Lists the downloads created for a video.","operationId":"stream-m-p-4-downloads-list-downloads","parameters":[{"name":"video_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/video_identifier"}},{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"List downloads response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/downloads_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"List downloads response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/downloads_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"post":{"tags":["Stream MP4 Downloads"],"summary":"Create downloads","description":"Creates a download for a video when a video is ready to view.","operationId":"stream-m-p-4-downloads-create-downloads","parameters":[{"name":"video_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/video_identifier"}},{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{"4xx":{"description":"Create downloads response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/downloads_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Create downloads response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/downloads_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{account_identifier}/stream/clip":{"post":{"tags":["Stream Video Clipping"],"summary":"Clip videos given a start and end time","description":"Clips a video based on the specified start and end times provided in seconds.","operationId":"stream-video-clipping-clip-videos-given-a-start-and-end-time","parameters":[{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/components-schemas-account_identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/videoClipStandard"}}}},"responses":{"4xx":{"description":"Clip videos given a start and end time response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/clipResponseSingle"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Clip videos given a start and end time response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/clipResponseSingle"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{account_identifier}/stream/copy":{"post":{"tags":["Stream Videos"],"summary":"Upload videos from a URL","description":"Uploads a video to Stream from a provided URL.","operationId":"stream-videos-upload-videos-from-a-url","parameters":[{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/components-schemas-account_identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/video_copy_request"}}}},"responses":{"4xx":{"description":"Upload videos from a URL response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/video_response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Upload videos from a URL response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/video_response_single"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{account_identifier}/stream/direct_upload":{"post":{"tags":["Stream Videos"],"summary":"Upload videos via direct upload URLs","description":"Creates a direct upload that allows video uploads without an API key.","operationId":"stream-videos-upload-videos-via-direct-upload-ur-ls","parameters":[{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/components-schemas-account_identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/direct_upload_request"}}}},"responses":{"4xx":{"description":"Upload videos via direct upload URLs response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/direct_upload_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Upload videos via direct upload URLs response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/direct_upload_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{account_identifier}/stream/keys":{"get":{"tags":["Stream Signing Keys"],"summary":"List signing keys","description":"Lists the video ID and creation date and time when a signing key was created.","operationId":"stream-signing-keys-list-signing-keys","parameters":[{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"List signing keys response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/key_response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"List signing keys response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/key_response_collection"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"post":{"tags":["Stream Signing Keys"],"summary":"Create signing keys","description":"Creates an RSA private key in PEM and JWK formats. Key files are only displayed once after creation. Keys are created, used, and deleted independently of videos, and every key can sign any video.","operationId":"stream-signing-keys-create-signing-keys","parameters":[{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{"4xx":{"description":"Create signing keys response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/key_generation_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Create signing keys response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/key_generation_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{account_identifier}/stream/keys/{identifier}":{"delete":{"tags":["Stream Signing Keys"],"summary":"Delete signing keys","description":"Deletes signing keys and revokes all signed URLs generated with the key.","operationId":"stream-signing-keys-delete-signing-keys","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/keys_components-schemas-identifier"}},{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{"4xx":{"description":"Delete signing keys response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/deleted_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Delete signing keys response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/deleted_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{account_identifier}/stream/live_inputs":{"get":{"tags":["Stream Live Inputs"],"summary":"List live inputs","description":"Lists the live inputs created for an account. To get the credentials needed to stream to a specific live input, request a single live input.","operationId":"stream-live-inputs-list-live-inputs","parameters":[{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"List live inputs response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/live_input_response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"List live inputs response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/live_input_response_collection"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"post":{"tags":["Stream Live Inputs"],"summary":"Create a live input","description":"Creates a live input, and returns credentials that you or your users can use to stream live video to Cloudflare Stream.","operationId":"stream-live-inputs-create-a-live-input","parameters":[{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/create_input_request"}}}},"responses":{"4xx":{"description":"Create a live input response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/live_input_response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Create a live input response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/live_input_response_single"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{account_identifier}/stream/live_inputs/{live_input_identifier}":{"delete":{"tags":["Stream Live Inputs"],"summary":"Delete a live input","description":"Prevents a live input from being streamed to and makes the live input inaccessible to any future API calls.","operationId":"stream-live-inputs-delete-a-live-input","parameters":[{"name":"live_input_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/live_input_identifier"}},{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{"4xx":{"description":"Delete a live input response failure","content":{"application/json":{}}},"200":{"description":"Delete a live input response","content":{"application/json":{}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"get":{"tags":["Stream Live Inputs"],"summary":"Retrieve a live input","description":"Retrieves details of an existing live input.","operationId":"stream-live-inputs-retrieve-a-live-input","parameters":[{"name":"live_input_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/live_input_identifier"}},{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Retrieve a live input response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/live_input_response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Retrieve a live input response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/live_input_response_single"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"put":{"tags":["Stream Live Inputs"],"summary":"Update a live input","description":"Updates a specified live input.","operationId":"stream-live-inputs-update-a-live-input","parameters":[{"name":"live_input_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/live_input_identifier"}},{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/update_input_request"}}}},"responses":{"4xx":{"description":"Update a live input response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/live_input_response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Update a live input response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/live_input_response_single"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{account_identifier}/stream/live_inputs/{live_input_identifier}/outputs":{"get":{"tags":["Stream Live Inputs"],"summary":"List all outputs associated with a specified live input","description":"Retrieves all outputs associated with a specified live input.","operationId":"stream-live-inputs-list-all-outputs-associated-with-a-specified-live-input","parameters":[{"name":"live_input_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/live_input_identifier"}},{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"List all outputs associated with a specified live input response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/output_response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"List all outputs associated with a specified live input response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/output_response_collection"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"post":{"tags":["Stream Live Inputs"],"summary":"Create a new output, connected to a live input","description":"Creates a new output that can be used to simulcast or restream live video to other RTMP or SRT destinations. Outputs are always linked to a specific live input — one live input can have many outputs.","operationId":"stream-live-inputs-create-a-new-output,-connected-to-a-live-input","parameters":[{"name":"live_input_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/live_input_identifier"}},{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/create_output_request"}}}},"responses":{"4xx":{"description":"Create a new output, connected to a live input response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/output_response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Create a new output, connected to a live input response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/output_response_single"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{account_identifier}/stream/live_inputs/{live_input_identifier}/outputs/{output_identifier}":{"delete":{"tags":["Stream Live Inputs"],"summary":"Delete an output","description":"Deletes an output and removes it from the associated live input.","operationId":"stream-live-inputs-delete-an-output","parameters":[{"name":"output_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/output_identifier"}},{"name":"live_input_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/live_input_identifier"}},{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{"4xx":{"description":"Delete an output response failure","content":{"application/json":{}}},"200":{"description":"Delete an output response","content":{"application/json":{}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"put":{"tags":["Stream Live Inputs"],"summary":"Update an output","description":"Updates the state of an output.","operationId":"stream-live-inputs-update-an-output","parameters":[{"name":"output_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/output_identifier"}},{"name":"live_input_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/live_input_identifier"}},{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/update_output_request"}}}},"responses":{"4xx":{"description":"Update an output response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/output_response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Update an output response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/output_response_single"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{account_identifier}/stream/watermarks":{"get":{"tags":["Stream Watermark Profile"],"summary":"List watermark profiles","description":"Lists all watermark profiles for an account.","operationId":"stream-watermark-profile-list-watermark-profiles","parameters":[{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/components-schemas-account_identifier"}}],"responses":{"4xx":{"description":"List watermark profiles response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/watermark_response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"List watermark profiles response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/watermark_response_collection"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"post":{"tags":["Stream Watermark Profile"],"summary":"Create watermark profiles via basic upload","description":"Creates watermark profiles using a single `HTTP POST multipart/form-data` request.","operationId":"stream-watermark-profile-create-watermark-profiles-via-basic-upload","parameters":[{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/components-schemas-account_identifier"}}],"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/watermark_basic_upload"}}}},"responses":{"4xx":{"description":"Create watermark profiles via basic upload response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/watermark_response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Create watermark profiles via basic upload response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/watermark_response_single"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{account_identifier}/stream/watermarks/{identifier}":{"delete":{"tags":["Stream Watermark Profile"],"summary":"Delete watermark profiles","description":"Deletes a watermark profile.","operationId":"stream-watermark-profile-delete-watermark-profiles","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/watermarks_components-schemas-identifier"}},{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/components-schemas-account_identifier"}}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{"4xx":{"description":"Delete watermark profiles response failure","content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"type":"string","example":""}}}]},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Delete watermark profiles response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"type":"string","example":""}}}]}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"get":{"tags":["Stream Watermark Profile"],"summary":"Watermark profile details","description":"Retrieves details for a single watermark profile.","operationId":"stream-watermark-profile-watermark-profile-details","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/watermarks_components-schemas-identifier"}},{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/components-schemas-account_identifier"}}],"responses":{"4xx":{"description":"Watermark profile details response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/watermark_response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Watermark profile details response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/watermark_response_single"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{account_identifier}/stream/webhook":{"delete":{"tags":["Stream Webhook"],"summary":"Delete webhooks","description":"Deletes a webhook.","operationId":"stream-webhook-delete-webhooks","parameters":[{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/webhook_components-schemas-account_identifier"}}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{"4xx":{"description":"Delete webhooks response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/deleted_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Delete webhooks response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/deleted_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"get":{"tags":["Stream Webhook"],"summary":"View webhooks","description":"Retrieves a list of webhooks.","operationId":"stream-webhook-view-webhooks","parameters":[{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/webhook_components-schemas-account_identifier"}}],"responses":{"4xx":{"description":"View webhooks response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/webhook_response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"View webhooks response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/webhook_response_single"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"put":{"tags":["Stream Webhook"],"summary":"Create webhooks","description":"Creates a webhook notification.","operationId":"stream-webhook-create-webhooks","parameters":[{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/webhook_components-schemas-account_identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/webhook_request"}}}},"responses":{"4xx":{"description":"Create webhooks response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/webhook_response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Create webhooks response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/webhook_response_single"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{account_identifier}/subscriptions":{"get":{"tags":["Account Subscriptions"],"summary":"List Subscriptions","description":"Lists all of an account's subscriptions.","operationId":"account-subscriptions-list-subscriptions","parameters":[{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"List Subscriptions response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/account_subscription_response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"List Subscriptions response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/account_subscription_response_collection"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"post":{"tags":["Account Subscriptions"],"summary":"Create Subscription","description":"Creates an account subscription.","operationId":"account-subscriptions-create-subscription","parameters":[{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/subscription-v2"}}}},"responses":{"4xx":{"description":"Create Subscription response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/account_subscription_response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Create Subscription response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/account_subscription_response_single"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{account_identifier}/subscriptions/{subscription_identifier}":{"delete":{"tags":["Account Subscriptions"],"summary":"Delete Subscription","description":"Deletes an account's subscription.","operationId":"account-subscriptions-delete-subscription","parameters":[{"name":"subscription_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/subscription-v2_components-schemas-identifier"}},{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{"4xx":{"description":"Delete Subscription response failure","content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"type":"object","properties":{"subscription_id":{"$ref":"#/components/schemas/subscription-v2_components-schemas-identifier"}}}}}]},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Delete Subscription response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"type":"object","properties":{"subscription_id":{"$ref":"#/components/schemas/subscription-v2_components-schemas-identifier"}}}}}]}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"put":{"tags":["Account Subscriptions"],"summary":"Update Subscription","description":"Updates an account subscription.","operationId":"account-subscriptions-update-subscription","parameters":[{"name":"subscription_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/subscription-v2_components-schemas-identifier"}},{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/subscription-v2"}}}},"responses":{"4xx":{"description":"Update Subscription response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/account_subscription_response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Update Subscription response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/account_subscription_response_single"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{account_identifier}/teamnet/routes":{"get":{"tags":["Tunnel route"],"summary":"List tunnel routes","description":"Lists and filters private network routes in an account.","operationId":"tunnel-route-list-tunnel-routes","parameters":[{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/cf_account_id"}}],"responses":{"4xx":{"description":"List tunnel routes response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/route_response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"List tunnel routes response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/route_response_collection"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{account_identifier}/teamnet/routes/ip/{ip}":{"get":{"tags":["Tunnel route"],"summary":"Get tunnel route by IP","description":"Fetches routes that contain the given IP address.","operationId":"tunnel-route-get-tunnel-route-by-ip","parameters":[{"name":"ip","in":"path","required":true,"schema":{"$ref":"#/components/schemas/teamnet_components-schemas-ip"}},{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/cf_account_id"}}],"responses":{"4xx":{"description":"Get tunnel route by IP response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/route_response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Get tunnel route by IP response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/route_response_single"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{account_identifier}/teamnet/routes/network/{ip_network_encoded}":{"delete":{"tags":["Tunnel route"],"summary":"Delete a tunnel route","description":"Deletes a private network route from an account. The CIDR in `ip_network_encoded` must be written in URL-encoded format.","operationId":"tunnel-route-delete-a-tunnel-route","parameters":[{"name":"ip_network_encoded","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ip_network_encoded"}},{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/cf_account_id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"virtual_network_id":{"$ref":"#/components/schemas/virtual_network_id"}}}}}},"responses":{"4xx":{"description":"Delete a tunnel route response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/route_response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Delete a tunnel route response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/route_response_single"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"patch":{"tags":["Tunnel route"],"summary":"Update a tunnel route","description":"Updates an existing private network route in an account. The CIDR in `ip_network_encoded` must be written in URL-encoded format.","operationId":"tunnel-route-update-a-tunnel-route","parameters":[{"name":"ip_network_encoded","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ip_network_encoded"}},{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/cf_account_id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"comment":{"$ref":"#/components/schemas/comment"},"network":{"description":"The new IPv4 or IPv6 range of this route, in CIDR notation."},"tunnel_id":{"description":"UUID of the tunnel this route should belong to."},"virtual_network_id":{"$ref":"#/components/schemas/virtual_network_id"}}}}}},"responses":{"4xx":{"description":"Update a tunnel route response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/route_response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Update a tunnel route response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/route_response_single"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"post":{"tags":["Tunnel route"],"summary":"Create a tunnel route","description":"Routes a private network through a Cloudflare Tunnel. The CIDR in `ip_network_encoded` must be written in URL-encoded format.","operationId":"tunnel-route-create-a-tunnel-route","parameters":[{"name":"ip_network_encoded","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ip_network_encoded"}},{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/cf_account_id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["tunnel_id"],"properties":{"comment":{"$ref":"#/components/schemas/comment"},"tunnel_id":{"$ref":"#/components/schemas/tunnel_id"},"virtual_network_id":{"$ref":"#/components/schemas/virtual_network_id"}}}}}},"responses":{"4xx":{"description":"Create a tunnel route response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/route_response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Create a tunnel route response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/route_response_single"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{account_identifier}/teamnet/virtual_networks":{"get":{"tags":["Tunnel Virtual Network"],"summary":"List virtual networks","description":"Lists and filters virtual networks in an account.","operationId":"tunnel-virtual-network-list-virtual-networks","parameters":[{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/cf_account_id"}}],"responses":{"4xx":{"description":"List virtual networks response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/vnet_response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"List virtual networks response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/vnet_response_collection"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"post":{"tags":["Tunnel Virtual Network"],"summary":"Create a virtual network","description":"Adds a new virtual network to an account.","operationId":"tunnel-virtual-network-create-a-virtual-network","parameters":[{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/cf_account_id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["name"],"properties":{"comment":{"$ref":"#/components/schemas/schemas-comment"},"is_default":{"$ref":"#/components/schemas/is_default_network"},"name":{"$ref":"#/components/schemas/vnet_name"}}}}}},"responses":{"4xx":{"description":"Create a virtual network response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/vnet_response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Create a virtual network response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/vnet_response_single"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{account_identifier}/teamnet/virtual_networks/{vnet_id}":{"delete":{"tags":["Tunnel Virtual Network"],"summary":"Delete a virtual network","description":"Deletes an existing virtual network.","operationId":"tunnel-virtual-network-delete-a-virtual-network","parameters":[{"name":"vnet_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/vnet_id"}},{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/cf_account_id"}}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{"4xx":{"description":"Delete a virtual network response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/vnet_response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Delete a virtual network response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/vnet_response_single"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"patch":{"tags":["Tunnel Virtual Network"],"summary":"Update a virtual network","description":"Updates an existing virtual network.","operationId":"tunnel-virtual-network-update-a-virtual-network","parameters":[{"name":"vnet_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/vnet_id"}},{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/cf_account_id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"comment":{"$ref":"#/components/schemas/schemas-comment"},"is_default_network":{"$ref":"#/components/schemas/is_default_network"},"name":{"$ref":"#/components/schemas/vnet_name"}}}}}},"responses":{"4xx":{"description":"Update a virtual network response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/vnet_response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Update a virtual network response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/vnet_response_single"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{account_identifier}/tunnels":{"get":{"tags":["Argo Tunnel"],"summary":"List Argo Tunnels","description":"Lists and filters Argo Tunnels in an account.","operationId":"argo-tunnel-list-argo-tunnels","parameters":[{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/cf_account_id"}}],"responses":{"4xx":{"description":"List Argo Tunnels response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/tunnel_response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"List Argo Tunnels response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/tunnel_response_collection"}}}}},"deprecated":true,"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"post":{"tags":["Argo Tunnel"],"summary":"Create an Argo Tunnel","description":"Creates a new Argo Tunnel in an account.","operationId":"argo-tunnel-create-an-argo-tunnel","parameters":[{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/cf_account_id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["name","tunnel_secret"],"properties":{"name":{"$ref":"#/components/schemas/tunnel_name"},"tunnel_secret":{"description":"Sets the password required to run the tunnel. Must be at least 32 bytes and encoded as a base64 string."}}}}}},"responses":{"4xx":{"description":"Create an Argo Tunnel response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/tunnel_response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Create an Argo Tunnel response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/tunnel_response_single"}}}}},"deprecated":true,"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{account_identifier}/tunnels/{tunnel_id}":{"delete":{"tags":["Argo Tunnel"],"summary":"Delete an Argo Tunnel","description":"Deletes an Argo Tunnel from an account.","operationId":"argo-tunnel-delete-an-argo-tunnel","parameters":[{"name":"tunnel_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/tunnel_id"}},{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/cf_account_id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object"}}}},"responses":{"4xx":{"description":"Delete an Argo Tunnel response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/tunnel_response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Delete an Argo Tunnel response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/tunnel_response_single"}}}}},"deprecated":true,"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"get":{"tags":["Argo Tunnel"],"summary":"Get an Argo Tunnel","description":"Fetches a single Argo Tunnel.","operationId":"argo-tunnel-get-an-argo-tunnel","parameters":[{"name":"tunnel_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/tunnel_id"}},{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/cf_account_id"}}],"responses":{"4xx":{"description":"Get an Argo Tunnel response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/tunnel_response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Get an Argo Tunnel response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/tunnel_response_single"}}}}},"deprecated":true,"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{account_identifier}/tunnels/{tunnel_id}/connections":{"delete":{"tags":["Argo Tunnel"],"summary":"Clean up Argo Tunnel connections","description":"Removes connections that are in a disconnected or pending reconnect state. We recommend running this command after shutting down a tunnel.","operationId":"argo-tunnel-clean-up-argo-tunnel-connections","parameters":[{"name":"tunnel_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/tunnel_id"}},{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/cf_account_id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object"}}}},"responses":{"4xx":{"description":"Clean up Argo Tunnel connections response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/argo-tunnel_components-schemas-empty_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Clean up Argo Tunnel connections response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/argo-tunnel_components-schemas-empty_response"}}}}},"deprecated":true,"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{account_identifier}/virtual_dns":{"get":{"tags":["DNS Firewall (Legacy)"],"summary":"List DNS Firewall Clusters","description":"List configured DNS Firewall clusters for an account.","operationId":"dns-firewall-(-legacy)-list-dns-firewall-clusters","parameters":[{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"List DNS Firewall Clusters response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/virtual_dns_response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"List DNS Firewall Clusters response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/virtual_dns_response_collection"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"post":{"tags":["DNS Firewall (Legacy)"],"summary":"Create DNS Firewall Cluster","description":"Create a configured DNS Firewall Cluster.","operationId":"dns-firewall-(-legacy)-create-dns-firewall-cluster","parameters":[{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["name","origin_ips","virtual_dns_ips"],"properties":{"deprecate_any_requests":{"$ref":"#/components/schemas/deprecate_any_requests"},"ecs_fallback":{"$ref":"#/components/schemas/ecs_fallback"},"maximum_cache_ttl":{"$ref":"#/components/schemas/maximum_cache_ttl"},"minimum_cache_ttl":{"$ref":"#/components/schemas/minimum_cache_ttl"},"name":{"$ref":"#/components/schemas/virtual-dns_components-schemas-name"},"negative_cache_ttl":{"$ref":"#/components/schemas/schemas-negative_cache_ttl"},"origin_ips":{"$ref":"#/components/schemas/origin_ips"},"ratelimit":{"$ref":"#/components/schemas/schemas-ratelimit"}}}}}},"responses":{"4xx":{"description":"Create DNS Firewall Cluster response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/virtual_dns_single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Create DNS Firewall Cluster response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/virtual_dns_single_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{account_identifier}/virtual_dns/{identifier}":{"delete":{"tags":["DNS Firewall (Legacy)"],"summary":"Delete DNS Firewall Cluster","description":"Delete a configured DNS Firewall Cluster.","operationId":"dns-firewall-(-legacy)-delete-dns-firewall-cluster","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}},{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{"4xx":{"description":"Delete DNS Firewall Cluster response failure","content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"properties":{"id":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}}}}]},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Delete DNS Firewall Cluster response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"properties":{"id":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}}}}]}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"get":{"tags":["DNS Firewall (Legacy)"],"summary":"DNS Firewall Cluster Details","description":"Show a single configured DNS Firewall cluster for an account.","operationId":"dns-firewall-(-legacy)-dns-firewall-cluster-details","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}},{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"DNS Firewall Cluster Details response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/virtual_dns_single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"DNS Firewall Cluster Details response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/virtual_dns_single_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"put":{"tags":["DNS Firewall (Legacy)"],"summary":"Update DNS Firewall Cluster","description":"Modify a DNS Firewall Cluster configuration.","operationId":"dns-firewall-(-legacy)-update-dns-firewall-cluster","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}},{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/schemas-virtual-dns"}}}},"responses":{"4xx":{"description":"Update DNS Firewall Cluster response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/virtual_dns_single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Update DNS Firewall Cluster response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/virtual_dns_single_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{account_identifier}/virtual_dns/{identifier}/dns_analytics/report":{"get":{"tags":["DNS Firewall Analytics (Legacy)"],"summary":"Table","description":"Retrieves a list of summarised aggregate metrics over a given time period.","operationId":"dns-firewall-analytics-(-legacy)-table","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}},{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Table response failure","content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"type":"object","properties":{"result":{"$ref":"#/components/schemas/result"}}}]},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Table response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"type":"object","properties":{"result":{"$ref":"#/components/schemas/result"}}}]}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{account_identifier}/virtual_dns/{identifier}/dns_analytics/report/bytime":{"get":{"tags":["DNS Firewall Analytics (Legacy)"],"summary":"By Time","description":"Retrieves a list of aggregate metrics grouped by time interval.","operationId":"dns-firewall-analytics-(-legacy)-by-time","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}},{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"By Time response failure","content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"type":"object","properties":{"result":{"$ref":"#/components/schemas/result"}}}]},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"By Time response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"type":"object","properties":{"result":{"$ref":"#/components/schemas/result"}}}]}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{account_identifier}/workers/account-settings":{"get":{"tags":["Worker Account Settings"],"summary":"Fetch Worker Account Settings","description":"Fetches Worker Account Settings for an account.","operationId":"worker-account-settings-fetch-worker-account-settings","parameters":[{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Fetch Worker Account Settings response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/account-settings-response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Fetch Worker Account Settings response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/account-settings-response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"put":{"tags":["Worker Account Settings"],"summary":"Create Worker Account Settings","description":"Creates Worker Account Settings for an account.","operationId":"worker-account-settings-create-worker-account-settings","parameters":[{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"example":"{'default_usage_model': 'unbound'}"}}}},"responses":{"4xx":{"description":"Create Worker Account Settings response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/account-settings-response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Create Worker Account Settings response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/account-settings-response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{account_identifier}/workers/deployments/by-script/{script_identifier}":{"get":{"tags":["Worker Deployments"],"summary":"List Deployments","operationId":"worker-deployments-list-deployments","parameters":[{"name":"script_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/script_identifier"}},{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"List Deployments response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/deployments-list-response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"List Deployments response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/deployments-list-response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{account_identifier}/workers/deployments/by-script/{script_identifier}/detail/{deployment_identifier}":{"get":{"tags":["Worker Deployments"],"summary":"Get Deployment Detail","operationId":"worker-deployments-get-deployment-detail","parameters":[{"name":"deployment_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/deployment_identifier"}},{"name":"script_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/script_identifier"}},{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Get Deployment Detail response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/deployments-single-response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Get Deployment Detail response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/deployments-single-response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{account_identifier}/workers/domains":{"get":{"tags":["Worker Domain"],"summary":"List Domains","description":"Lists all Worker Domains.","operationId":"worker-domain-list-domains","parameters":[{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/domains_components-schemas-account_identifier"}}],"responses":{"4xx":{"description":"List Domains response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Cloudflare Client API_domain-response-collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"List Domains response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Cloudflare Client API_domain-response-collection"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"put":{"tags":["Worker Domain"],"summary":"Attach to Domain","description":"Attaches a worker to a zone and hostname.","operationId":"worker-domain-attach-to-domain","parameters":[{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/domains_components-schemas-account_identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["zone_id","hostname","service","environment"],"properties":{"environment":{"$ref":"#/components/schemas/environment"},"hostname":{"$ref":"#/components/schemas/components-schemas-hostname"},"service":{"$ref":"#/components/schemas/service"},"zone_id":{"$ref":"#/components/schemas/zone_identifier"}}}}}},"responses":{"4xx":{"description":"Attach to Domain response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Cloudflare Client API_domain-response-single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Attach to Domain response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Cloudflare Client API_domain-response-single"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{account_identifier}/workers/domains/{domain_identifier}":{"delete":{"tags":["Worker Domain"],"summary":"Detach from Domain","description":"Detaches a worker from a zone and hostname.","operationId":"worker-domain-detach-from-domain","parameters":[{"name":"domain_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/domain_identifier"}},{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/domains_components-schemas-account_identifier"}}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{"4xx":{"description":"Detach from Domain response failure","content":{"application/json":{}}},"200":{"description":"Detach from Domain response","content":{"application/json":{}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"get":{"tags":["Worker Domain"],"summary":"Get a Domain","description":"Gets a Worker Domain.","operationId":"worker-domain-get-a-domain","parameters":[{"name":"domain_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/domain_identifier"}},{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/domains_components-schemas-account_identifier"}}],"responses":{"4xx":{"description":"Get a Domain response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Cloudflare Client API_domain-response-single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Get a Domain response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Cloudflare Client API_domain-response-single"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{account_identifier}/workers/durable_objects/namespaces":{"get":{"tags":["Durable Objects Namespace"],"summary":"List Namespaces","description":"Returns the namespaces owned by an account.","operationId":"durable-objects-namespace-list-namespaces","parameters":[{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"List Namespaces response failure","content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"type":"object","properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/schemas-namespace"}}}}]},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"List Namespaces response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"type":"object","properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/schemas-namespace"}}}}]}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{account_identifier}/workers/durable_objects/namespaces/{id}/objects":{"get":{"tags":["Durable Objects Namespace"],"summary":"List Objects","description":"Returns the Durable Objects in a given namespace.","operationId":"durable-objects-namespace-list-objects","parameters":[{"name":"id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/namespaces_components-schemas-id"}},{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"List Objects response failure","content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"type":"object","properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/object"}},"result_info":{"properties":{"count":{"type":"number","description":"Total results returned based on your list parameters.","example":1},"cursor":{"$ref":"#/components/schemas/schemas-cursor"}}}}}]},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"List Objects response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"type":"object","properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/object"}},"result_info":{"properties":{"count":{"type":"number","description":"Total results returned based on your list parameters.","example":1},"cursor":{"$ref":"#/components/schemas/schemas-cursor"}}}}}]}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{account_identifier}/workers/queues":{"get":{"tags":["Queue"],"summary":"List Queues","description":"Returns the queues owned by an account.","operationId":"queue-list-queues","parameters":[{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"List Queues response failure","content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"errors":{"nullable":true}}},{"properties":{"messages":{"nullable":true}}},{"properties":{"result_info":{"type":"object","properties":{"count":{"example":1},"page":{"example":1},"per_page":{"example":100},"total_count":{"example":1},"total_pages":{"example":1}}}}},{"type":"object","required":["queue_id","queue_name","created_on","modified_on","producers_total_count","producers","consumers_total_count","consumers"],"properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/queue"}}}}]},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"List Queues response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"errors":{"nullable":true}}},{"properties":{"messages":{"nullable":true}}},{"properties":{"result_info":{"type":"object","properties":{"count":{"example":1},"page":{"example":1},"per_page":{"example":100},"total_count":{"example":1},"total_pages":{"example":1}}}}},{"type":"object","required":["queue_id","queue_name","created_on","modified_on","producers_total_count","producers","consumers_total_count","consumers"],"properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/queue"}}}}]}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"post":{"tags":["Queue"],"summary":"Create Queue","description":"Creates a new queue.","operationId":"queue-create-queue","parameters":[{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"example":{"queue_name":"example-queue"}}}}},"responses":{"4xx":{"description":"Create Queue response failure","content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"type":"object","required":["queue_id","queue_name","created_on","modified_on"],"properties":{"result":{"allOf":[{"$ref":"#/components/schemas/queue_created"}],"type":"object"}}}]},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Create Queue response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"type":"object","required":["queue_id","queue_name","created_on","modified_on"],"properties":{"result":{"allOf":[{"$ref":"#/components/schemas/queue_created"}],"type":"object"}}}]}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{account_identifier}/workers/queues/{name}":{"delete":{"tags":["Queue"],"summary":"Delete Queue","description":"Deletes a queue.","operationId":"queue-delete-queue","parameters":[{"name":"name","in":"path","required":true,"schema":{"$ref":"#/components/schemas/queues_components-schemas-name"}},{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{"4xx":{"description":"Delete Queue response failure","content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"nullable":true,"properties":{"result":{"nullable":true}}}]},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Delete Queue response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"nullable":true,"properties":{"result":{"nullable":true}}}]}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"get":{"tags":["Queue"],"summary":"Queue Details","description":"Get information about a specific queue.","operationId":"queue-queue-details","parameters":[{"name":"name","in":"path","required":true,"schema":{"$ref":"#/components/schemas/queues_components-schemas-name"}},{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Queue Details response failure","content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"type":"object","required":["queue_id","queue_name","created_on","modified_on"],"properties":{"result":{"allOf":[{"$ref":"#/components/schemas/queue"}],"type":"object"}}}]},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Queue Details response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"type":"object","required":["queue_id","queue_name","created_on","modified_on"],"properties":{"result":{"allOf":[{"$ref":"#/components/schemas/queue"}],"type":"object"}}}]}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"put":{"tags":["Queue"],"summary":"Update Queue","description":"Updates a queue.","operationId":"queue-update-queue","parameters":[{"name":"name","in":"path","required":true,"schema":{"$ref":"#/components/schemas/queues_components-schemas-name"}},{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"example":{"queue_name":"renamed-example-queue"}}}}},"responses":{"4xx":{"description":"Update Queue response failure","content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"type":"object","required":["queue_id","queue_name","created_on","modified_on"],"properties":{"result":{"allOf":[{"$ref":"#/components/schemas/queue_updated"}],"type":"object"}}}]},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Update Queue response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"type":"object","required":["queue_id","queue_name","created_on","modified_on"],"properties":{"result":{"allOf":[{"$ref":"#/components/schemas/queue_updated"}],"type":"object"}}}]}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{account_identifier}/workers/queues/{name}/consumers":{"get":{"tags":["Queue"],"summary":"List Queue Consumers","description":"Returns the consumers for a queue.","operationId":"queue-list-queue-consumers","parameters":[{"name":"name","in":"path","required":true,"schema":{"$ref":"#/components/schemas/queues_components-schemas-name"}},{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"List Queue Consumers response failure","content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"errors":{"nullable":true}}},{"properties":{"messages":{"nullable":true}}},{"properties":{"result_info":{"type":"object","properties":{"count":{"example":1},"page":{"example":1},"per_page":{"example":100},"total_count":{"example":1},"total_pages":{"example":1}}}}},{"type":"object","required":["queue_name","created_on","settings"],"properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/consumer"}}}}]},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"List Queue Consumers response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"errors":{"nullable":true}}},{"properties":{"messages":{"nullable":true}}},{"properties":{"result_info":{"type":"object","properties":{"count":{"example":1},"page":{"example":1},"per_page":{"example":100},"total_count":{"example":1},"total_pages":{"example":1}}}}},{"type":"object","required":["queue_name","created_on","settings"],"properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/consumer"}}}}]}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"post":{"tags":["Queue"],"summary":"Create Queue Consumer","description":"Creates a new consumer for a queue.","operationId":"queue-create-queue-consumer","parameters":[{"name":"name","in":"path","required":true,"schema":{"$ref":"#/components/schemas/queues_components-schemas-name"}},{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"example":{"dead_letter_queue":"example-dlq","environment":"production","script_name":"example-consumer","settings":{"batch_size":10,"max_retries":3,"max_wait_time_ms":5000}}}}}},"responses":{"4xx":{"description":"Create Queue Consumer response failure","content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"type":"object","required":["queue_name","script_name","settings","dead_letter_queue","created_on"],"properties":{"result":{"allOf":[{"$ref":"#/components/schemas/consumer_created"}],"type":"object"}}}]},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Create Queue Consumer response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"type":"object","required":["queue_name","script_name","settings","dead_letter_queue","created_on"],"properties":{"result":{"allOf":[{"$ref":"#/components/schemas/consumer_created"}],"type":"object"}}}]}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{account_identifier}/workers/queues/{name}/consumers/{consumer_name}":{"delete":{"tags":["Queue"],"summary":"Delete Queue Consumer","description":"Deletes the consumer for a queue.","operationId":"queue-delete-queue-consumer","parameters":[{"name":"consumer_name","in":"path","required":true,"schema":{"$ref":"#/components/schemas/consumer_name"}},{"name":"name","in":"path","required":true,"schema":{"$ref":"#/components/schemas/queues_components-schemas-name"}},{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{"4xx":{"description":"Delete Queue Consumer response failure","content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"nullable":true,"properties":{"result":{"nullable":true}}}]},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Delete Queue Consumer response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"nullable":true,"properties":{"result":{"nullable":true}}}]}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"put":{"tags":["Queue"],"summary":"Update Queue Consumer","description":"Updates the consumer for a queue, or creates one if it does not exist.","operationId":"queue-update-queue-consumer","parameters":[{"name":"consumer_name","in":"path","required":true,"schema":{"$ref":"#/components/schemas/consumer_name"}},{"name":"name","in":"path","required":true,"schema":{"$ref":"#/components/schemas/queues_components-schemas-name"}},{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"example":{"dead_letter_queue":"updated-example-dlq","environment":"production","script_name":"example-consumer","settings":{"batch_size":100}}}}}},"responses":{"4xx":{"description":"Update Queue Consumer response failure","content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"type":"object","required":["queue_name","script_name","settings","dead_letter_queue","created_on"],"properties":{"result":{"allOf":[{"$ref":"#/components/schemas/consumer_updated"}],"type":"object"}}}]},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Update Queue Consumer response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"type":"object","required":["queue_name","script_name","settings","dead_letter_queue","created_on"],"properties":{"result":{"allOf":[{"$ref":"#/components/schemas/consumer_updated"}],"type":"object"}}}]}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{account_identifier}/workers/scripts":{"get":{"tags":["Worker Script"],"summary":"List Workers","description":"Fetch a list of uploaded workers.","operationId":"worker-script-list-workers","parameters":[{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"List Workers response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/script-response-collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"List Workers response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/script-response-collection"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{account_identifier}/workers/scripts/{script_name}":{"delete":{"tags":["Worker Script"],"summary":"Delete Worker","description":"Delete your worker. This call has no response body on a successful delete.\n\n**Query paramaters**:\n\n1. `force`: boolean; If set to true, delete will not be stopped by associated service binding, durable object, or other binding. Any of these associated bindings/durable objects will be deleted along with the script.","operationId":"worker-script-delete-worker","parameters":[{"name":"script_name","in":"path","required":true,"schema":{"$ref":"#/components/schemas/script_name"}},{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{"4xx":{"description":"Delete Worker response failure","content":{"application/json":{}}},"200":{"description":"Delete Worker response","content":{"application/json":{}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"get":{"tags":["Worker Script"],"summary":"Download Worker","description":"Fetch raw script content for your worker. Note this is the original script content, not JSON encoded.","operationId":"worker-script-download-worker","parameters":[{"name":"script_name","in":"path","required":true,"schema":{"$ref":"#/components/schemas/script_name"}},{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Download Worker response failure","content":{"undefined":{"schema":{"example":"addEventListener('fetch', event => { event.respondWith(fetch(event.request)) })"}}}},"200":{"description":"Download Worker response","content":{"undefined":{"schema":{"example":"addEventListener('fetch', event => { event.respondWith(fetch(event.request)) })"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"put":{"tags":["Worker Script"],"summary":"Upload Worker Module","description":"Upload a worker module.","operationId":"worker-script-upload-worker-module","parameters":[{"name":"script_name","in":"path","required":true,"schema":{"$ref":"#/components/schemas/script_name"}},{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"properties":{"\"second-file.js\"":{"type":"string","description":"Worker script.","example":"@second-file.js;type=application/javascript+module"},"\"worker.js\"":{"type":"string","description":"Worker script.","example":"@worker.js;type=application/javascript+module"},"metadata":{"type":"string","description":"Metadata for script such as bindings. Main module needs to be specified with `main_module`.","example":"{\"main_module\": \"worker.js\", \"some_binding\": \"stuff\"}"}}}}}},"responses":{"4xx":{"description":"Upload Worker Module response failure","content":{"application/json":{"schema":{"allOf":[{"example":{"errors":[],"messages":[],"result":{"created_on":"2022-05-05T05:15:11.602148Z","etag":"777f24a43bef5f69174aa69ceaf1dea67968d510a31d1vw3e49d34a0187c06d1","handlers":["fetch"],"id":"this-is_my_script-01","modified_on":"2022-05-20T19:02:56.446492Z","usage_model":"bundled"},"success":true}},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Upload Worker Module response","content":{"application/json":{"schema":{"example":{"errors":[],"messages":[],"result":{"created_on":"2022-05-05T05:15:11.602148Z","etag":"777f24a43bef5f69174aa69ceaf1dea67968d510a31d1vw3e49d34a0187c06d1","handlers":["fetch"],"id":"this-is_my_script-01","modified_on":"2022-05-20T19:02:56.446492Z","usage_model":"bundled"},"success":true}}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{account_identifier}/workers/scripts/{script_name}/schedules":{"get":{"tags":["Worker Cron Trigger"],"summary":"Get Cron Triggers","description":"Fetches Cron Triggers for a Worker.","operationId":"worker-cron-trigger-get-cron-triggers","parameters":[{"name":"script_name","in":"path","required":true,"schema":{"$ref":"#/components/schemas/script_name"}},{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Get Cron Triggers response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/cron-trigger-response-collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Get Cron Triggers response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/cron-trigger-response-collection"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"put":{"tags":["Worker Cron Trigger"],"summary":"Update Cron Triggers","description":"Updates Cron Triggers for a Worker.","operationId":"worker-cron-trigger-update-cron-triggers","parameters":[{"name":"script_name","in":"path","required":true,"schema":{"$ref":"#/components/schemas/script_name"}},{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"example":"[{'cron': '*/30 * * * *'}]"}}}},"responses":{"4xx":{"description":"Update Cron Triggers response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/cron-trigger-response-collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Update Cron Triggers response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/cron-trigger-response-collection"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{account_identifier}/workers/scripts/{script_name}/tails":{"get":{"tags":["Worker Tail Logs"],"summary":"List Tails","description":"Get list of tails currently deployed on a worker.","operationId":"worker-tail-logs-list-tails","parameters":[{"name":"script_name","in":"path","required":true,"schema":{"$ref":"#/components/schemas/script_name"}},{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"List Tails response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/tail-response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"List Tails response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/tail-response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"post":{"tags":["Worker Tail Logs"],"summary":"Start Tail","description":"Starts a tail that receives logs and exception from a Worker.","operationId":"worker-tail-logs-start-tail","parameters":[{"name":"script_name","in":"path","required":true,"schema":{"$ref":"#/components/schemas/script_name"}},{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{"4xx":{"description":"Start Tail response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/tail-response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Start Tail response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/tail-response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{account_identifier}/workers/scripts/{script_name}/tails/{id}":{"delete":{"tags":["Worker Tail Logs"],"summary":"Delete Tail","description":"Deletes a tail from a Worker.","operationId":"worker-tail-logs-delete-tail","parameters":[{"name":"id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/components-schemas-id"}},{"name":"script_name","in":"path","required":true,"schema":{"$ref":"#/components/schemas/script_name"}},{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{"4xx":{"description":"Delete Tail response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-response-common"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Delete Tail response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-response-common"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{account_identifier}/workers/scripts/{script_name}/usage-model":{"get":{"tags":["Worker Script"],"summary":"Fetch Usage Model","description":"Fetches the Usage Model for a given Worker.","operationId":"worker-script-fetch-usage-model","parameters":[{"name":"script_name","in":"path","required":true,"schema":{"$ref":"#/components/schemas/script_name"}},{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Fetch Usage Model response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/usage-model-response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Fetch Usage Model response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/usage-model-response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"put":{"tags":["Worker Script"],"summary":"Update Usage Model","description":"Updates the Usage Model for a given Worker. Requires a Workers Paid subscription.","operationId":"worker-script-update-usage-model","parameters":[{"name":"script_name","in":"path","required":true,"schema":{"$ref":"#/components/schemas/script_name"}},{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"example":"{'usage_model': 'unbound'}"}}}},"responses":{"4xx":{"description":"Update Usage Model response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/usage-model-response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Update Usage Model response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/usage-model-response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{account_identifier}/workers/subdomain":{"get":{"tags":["Worker Subdomain"],"summary":"Get Subdomain","description":"Returns a Workers subdomain for an account.","operationId":"worker-subdomain-get-subdomain","parameters":[{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Get Subdomain response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/subdomain-response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Get Subdomain response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/subdomain-response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"put":{"tags":["Worker Subdomain"],"summary":"Create Subdomain","description":"Creates a Workers subdomain for an account.","operationId":"worker-subdomain-create-subdomain","parameters":[{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"example":"{'subdomain': 'example-subdomain'}"}}}},"responses":{"4xx":{"description":"Create Subdomain response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/subdomain-response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Create Subdomain response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/subdomain-response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{account_identifier1}/addressing/address_maps/{address_map_identifier}/accounts/{account_identifier}":{"delete":{"tags":["IP Address Management Address Maps"],"summary":"Remove an account membership from an Address Map","description":"Remove an account as a member of a particular address map.","operationId":"ip-address-management-address-maps-remove-an-account-membership-from-an-address-map","parameters":[{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}},{"name":"address_map_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}},{"name":"account_identifier1","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{"4xx":{"description":"Remove an account membership from an Address Map response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Remove an account membership from an Address Map response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-response-collection"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"put":{"tags":["IP Address Management Address Maps"],"summary":"Add an account membership to an Address Map","description":"Add an account as a member of a particular address map.","operationId":"ip-address-management-address-maps-add-an-account-membership-to-an-address-map","parameters":[{"name":"account_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}},{"name":"address_map_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}},{"name":"account_identifier1","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{"4xx":{"description":"Add an account membership to an Address Map response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Add an account membership to an Address Map response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-response-collection"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{identifier}":{"get":{"tags":["Accounts"],"summary":"Account Details","description":"Get information about a specific account that you are a member of.","operationId":"accounts-account-details","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/schemas-identifier"}}],"responses":{"4xx":{"description":"Account Details response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Account Details response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_single"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"put":{"tags":["Accounts"],"summary":"Update Account","description":"Update an existing account.","operationId":"accounts-update-account","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/components-schemas-account"}}}},"responses":{"4xx":{"description":"Update Account response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Update Account response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_single"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{identifier}/access/apps":{"get":{"tags":["Access applications"],"summary":"List Access applications","description":"Lists all Access applications in an account.","operationId":"access-applications-list-access-applications","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/apps_components-schemas-identifier"}}],"responses":{"4xx":{"description":"List Access applications response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/apps_components-schemas-response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"List Access applications response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/apps_components-schemas-response_collection"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"post":{"tags":["Access applications"],"summary":"Add a Bookmark application","description":"Adds a custom link to the App Launcher. Bookmark applications are not protected by Access.","operationId":"access-applications-add-a-bookmark-application","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/apps_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["name","type","domain"]}}}},"responses":{"4xx":{"description":"Add a Bookmark application response failure","content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/apps_components-schemas-single_response"},{"properties":{"result":{"allOf":[{"$ref":"#/components/schemas/basic_app_response_props"},{"$ref":"#/components/schemas/bookmark_props"}]}}}]},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Add a Bookmark application response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/apps_components-schemas-single_response"},{"properties":{"result":{"allOf":[{"$ref":"#/components/schemas/basic_app_response_props"},{"$ref":"#/components/schemas/bookmark_props"}]}}}]}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{identifier}/access/apps/{app_id}":{"delete":{"tags":["Access applications"],"summary":"Delete an Access application","description":"Deletes an application from Access.","operationId":"access-applications-delete-an-access-application","parameters":[{"name":"app_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/schemas-app_id"}},{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/apps_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{"4xx":{"description":"Delete an Access application response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/apps_components-schemas-id_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Delete an Access application response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/apps_components-schemas-id_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"get":{"tags":["Access applications"],"summary":"Get an Access application","description":"Fetches information about an Access application.","operationId":"access-applications-get-an-access-application","parameters":[{"name":"app_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/schemas-app_id"}},{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/apps_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Get an Access application response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/apps_components-schemas-single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Get an Access application response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/apps_components-schemas-single_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"put":{"tags":["Access applications"],"summary":"Update a Bookmark application","description":"Updates a Bookmark application.","operationId":"access-applications-update-a-bookmark-application","parameters":[{"name":"app_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/schemas-app_id"}},{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/apps_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["name","type","domain"]}}}},"responses":{"4xx":{"description":"Update a Bookmark application response failure","content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/apps_components-schemas-single_response"},{"properties":{"result":{"allOf":[{"$ref":"#/components/schemas/basic_app_response_props"},{"$ref":"#/components/schemas/bookmark_props"}]}}}]},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Update a Bookmark application response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/apps_components-schemas-single_response"},{"properties":{"result":{"allOf":[{"$ref":"#/components/schemas/basic_app_response_props"},{"$ref":"#/components/schemas/bookmark_props"}]}}}]}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{identifier}/access/apps/{app_id}/revoke_tokens":{"post":{"tags":["Access applications"],"summary":"Revoke service tokens","description":"Revokes all service tokens used by an application.","operationId":"access-applications-revoke-service-tokens","parameters":[{"name":"app_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/schemas-app_id"}},{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/apps_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{"4xx":{"description":"Revoke service tokens response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/components-schemas-empty_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Revoke service tokens response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/components-schemas-empty_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{identifier}/access/apps/{app_id}/user_policy_checks":{"get":{"tags":["Access applications"],"summary":"Test Access policies","description":"Tests if a specific user has permission to access an application.","operationId":"access-applications-test-access-policies","parameters":[{"name":"app_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/schemas-app_id"}},{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/apps_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Test Access policies response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/policy_check_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Test Access policies response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/policy_check_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{identifier}/access/apps/{uuid}/ca":{"delete":{"tags":["Access short-lived certificate CAs"],"summary":"Delete a short-lived certificate CA","description":"Deletes a short-lived certificate CA.","operationId":"access-short-lived-certificate-c-as-delete-a-short-lived-certificate-ca","parameters":[{"name":"uuid","in":"path","required":true,"schema":{"$ref":"#/components/schemas/uuid"}},{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{"4xx":{"description":"Delete a short-lived certificate CA response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ca_components-schemas-id_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Delete a short-lived certificate CA response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ca_components-schemas-id_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"get":{"tags":["Access short-lived certificate CAs"],"summary":"Get a short-lived certificate CA","description":"Fetches a short-lived certificate CA and its public key.","operationId":"access-short-lived-certificate-c-as-get-a-short-lived-certificate-ca","parameters":[{"name":"uuid","in":"path","required":true,"schema":{"$ref":"#/components/schemas/uuid"}},{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Get a short-lived certificate CA response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ca_components-schemas-single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Get a short-lived certificate CA response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ca_components-schemas-single_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"post":{"tags":["Access short-lived certificate CAs"],"summary":"Create a short-lived certificate CA","description":"Generates a new short-lived certificate CA and public key.","operationId":"access-short-lived-certificate-c-as-create-a-short-lived-certificate-ca","parameters":[{"name":"uuid","in":"path","required":true,"schema":{"$ref":"#/components/schemas/uuid"}},{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{"4xx":{"description":"Create a short-lived certificate CA response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ca_components-schemas-single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Create a short-lived certificate CA response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ca_components-schemas-single_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{identifier}/access/apps/{uuid}/policies":{"get":{"tags":["Access policies"],"summary":"List Access policies","description":"Lists Access policies configured for an application.","operationId":"access-policies-list-access-policies","parameters":[{"name":"uuid","in":"path","required":true,"schema":{"$ref":"#/components/schemas/components-schemas-uuid"}},{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/policies_components-schemas-identifier"}}],"responses":{"4xx":{"description":"List Access policies response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/policies_components-schemas-response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"List Access policies response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/policies_components-schemas-response_collection"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"post":{"tags":["Access policies"],"summary":"Create an Access policy","description":"Create a new Access policy for an application.","operationId":"access-policies-create-an-access-policy","parameters":[{"name":"uuid","in":"path","required":true,"schema":{"$ref":"#/components/schemas/components-schemas-uuid"}},{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/policies_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["name","decision","include"],"properties":{"approval_groups":{"$ref":"#/components/schemas/approval_groups"},"approval_required":{"$ref":"#/components/schemas/approval_required"},"decision":{"$ref":"#/components/schemas/decision"},"exclude":{"$ref":"#/components/schemas/schemas-exclude"},"include":{"$ref":"#/components/schemas/include"},"name":{"$ref":"#/components/schemas/policies_components-schemas-name"},"precedence":{"$ref":"#/components/schemas/precedence"},"purpose_justification_prompt":{"$ref":"#/components/schemas/purpose_justification_prompt"},"purpose_justification_required":{"$ref":"#/components/schemas/purpose_justification_required"},"require":{"$ref":"#/components/schemas/schemas-require"}}}}}},"responses":{"4xx":{"description":"Create an Access policy response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/policies_components-schemas-single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Create an Access policy response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/policies_components-schemas-single_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{identifier}/access/apps/{uuid1}/policies/{uuid}":{"delete":{"tags":["Access policies"],"summary":"Delete an Access policy","description":"Delete an Access policy.","operationId":"access-policies-delete-an-access-policy","parameters":[{"name":"uuid","in":"path","required":true,"schema":{"$ref":"#/components/schemas/components-schemas-uuid"}},{"name":"uuid1","in":"path","required":true,"schema":{"$ref":"#/components/schemas/components-schemas-uuid"}},{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/policies_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{"4xx":{"description":"Delete an Access policy response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/policies_components-schemas-id_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Delete an Access policy response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/policies_components-schemas-id_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"get":{"tags":["Access policies"],"summary":"Get an Access policy","description":"Fetches a single Access policy.","operationId":"access-policies-get-an-access-policy","parameters":[{"name":"uuid","in":"path","required":true,"schema":{"$ref":"#/components/schemas/components-schemas-uuid"}},{"name":"uuid1","in":"path","required":true,"schema":{"$ref":"#/components/schemas/components-schemas-uuid"}},{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/policies_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Get an Access policy response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/policies_components-schemas-single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Get an Access policy response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/policies_components-schemas-single_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"put":{"tags":["Access policies"],"summary":"Update an Access policy","description":"Update a configured Access policy.","operationId":"access-policies-update-an-access-policy","parameters":[{"name":"uuid","in":"path","required":true,"schema":{"$ref":"#/components/schemas/components-schemas-uuid"}},{"name":"uuid1","in":"path","required":true,"schema":{"$ref":"#/components/schemas/components-schemas-uuid"}},{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/policies_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["name","decision","include"],"properties":{"approval_groups":{"$ref":"#/components/schemas/approval_groups"},"approval_required":{"$ref":"#/components/schemas/approval_required"},"decision":{"$ref":"#/components/schemas/decision"},"exclude":{"$ref":"#/components/schemas/schemas-exclude"},"include":{"$ref":"#/components/schemas/include"},"name":{"$ref":"#/components/schemas/policies_components-schemas-name"},"precedence":{"$ref":"#/components/schemas/precedence"},"purpose_justification_prompt":{"$ref":"#/components/schemas/purpose_justification_prompt"},"purpose_justification_required":{"$ref":"#/components/schemas/purpose_justification_required"},"require":{"$ref":"#/components/schemas/schemas-require"}}}}}},"responses":{"4xx":{"description":"Update an Access policy response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/policies_components-schemas-single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Update an Access policy response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/policies_components-schemas-single_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{identifier}/access/apps/ca":{"get":{"tags":["Access short-lived certificate CAs"],"summary":"List short-lived certificate CAs","description":"Lists short-lived certificate CAs and their public keys.","operationId":"access-short-lived-certificate-c-as-list-short-lived-certificate-c-as","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"List short-lived certificate CAs response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ca_components-schemas-response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"List short-lived certificate CAs response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ca_components-schemas-response_collection"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{identifier}/access/bookmarks":{"get":{"tags":["Access Bookmark applications (Deprecated)"],"summary":"List Bookmark applications","description":"Lists Bookmark applications.","operationId":"access-bookmark-applications-(-deprecated)-list-bookmark-applications","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/bookmarks_components-schemas-identifier"}}],"responses":{"4xx":{"description":"List Bookmark applications response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/bookmarks_components-schemas-response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"List Bookmark applications response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bookmarks_components-schemas-response_collection"}}}}},"deprecated":true,"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{identifier}/access/bookmarks/{uuid}":{"delete":{"tags":["Access Bookmark applications (Deprecated)"],"summary":"Delete a Bookmark application","description":"Deletes a Bookmark application.","operationId":"access-bookmark-applications-(-deprecated)-delete-a-bookmark-application","parameters":[{"name":"uuid","in":"path","required":true,"schema":{"$ref":"#/components/schemas/uuid"}},{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/bookmarks_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{"4xx":{"description":"Delete a Bookmark application response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/bookmarks_components-schemas-id_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Delete a Bookmark application response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bookmarks_components-schemas-id_response"}}}}},"deprecated":true,"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"get":{"tags":["Access Bookmark applications (Deprecated)"],"summary":"Get a Bookmark application","description":"Fetches a single Bookmark application.","operationId":"access-bookmark-applications-(-deprecated)-get-a-bookmark-application","parameters":[{"name":"uuid","in":"path","required":true,"schema":{"$ref":"#/components/schemas/uuid"}},{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/bookmarks_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Get a Bookmark application response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/bookmarks_components-schemas-single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Get a Bookmark application response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bookmarks_components-schemas-single_response"}}}}},"deprecated":true,"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"post":{"tags":["Access Bookmark applications (Deprecated)"],"summary":"Create a Bookmark application","description":"Create a new Bookmark application.","operationId":"access-bookmark-applications-(-deprecated)-create-a-bookmark-application","parameters":[{"name":"uuid","in":"path","required":true,"schema":{"$ref":"#/components/schemas/uuid"}},{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/bookmarks_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{"4xx":{"description":"Create a Bookmark application response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/bookmarks_components-schemas-single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Create a Bookmark application response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bookmarks_components-schemas-single_response"}}}}},"deprecated":true,"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"put":{"tags":["Access Bookmark applications (Deprecated)"],"summary":"Update a Bookmark application","description":"Updates a configured Bookmark application.","operationId":"access-bookmark-applications-(-deprecated)-update-a-bookmark-application","parameters":[{"name":"uuid","in":"path","required":true,"schema":{"$ref":"#/components/schemas/uuid"}},{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/bookmarks_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{"4xx":{"description":"Update a Bookmark application response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/bookmarks_components-schemas-single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Update a Bookmark application response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bookmarks_components-schemas-single_response"}}}}},"deprecated":true,"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{identifier}/access/certificates":{"get":{"tags":["Access mTLS authentication"],"summary":"List mTLS certificates","description":"Lists all mTLS certificates.","operationId":"access-m-tls-authentication-list-m-tls-certificates","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"List mTLS certificates response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/certificates_components-schemas-response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"List mTLS certificates response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/certificates_components-schemas-response_collection"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"post":{"tags":["Access mTLS authentication"],"summary":"Add an mTLS certificate","description":"Adds a new mTLS root certificate to Access.","operationId":"access-m-tls-authentication-add-an-m-tls-certificate","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["name","certificate"],"properties":{"associated_hostnames":{"$ref":"#/components/schemas/associated_hostnames"},"certificate":{"type":"string","description":"The certificate content.","example":"-----BEGIN CERTIFICATE-----\nMIIGAjCCA+qgAwIBAgIJAI7kymlF7CWT...N4RI7KKB7nikiuUf8vhULKy5IX10\nDrUtmu/B\n-----END CERTIFICATE-----"},"name":{"$ref":"#/components/schemas/certificates_components-schemas-name"}}}}}},"responses":{"4xx":{"description":"Add an mTLS certificate response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/certificates_components-schemas-single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Add an mTLS certificate response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/certificates_components-schemas-single_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{identifier}/access/certificates/{uuid}":{"delete":{"tags":["Access mTLS authentication"],"summary":"Delete an mTLS certificate","description":"Deletes an mTLS certificate.","operationId":"access-m-tls-authentication-delete-an-m-tls-certificate","parameters":[{"name":"uuid","in":"path","required":true,"schema":{"$ref":"#/components/schemas/uuid"}},{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{"4xx":{"description":"Delete an mTLS certificate response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/certificates_components-schemas-id_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Delete an mTLS certificate response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/certificates_components-schemas-id_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"get":{"tags":["Access mTLS authentication"],"summary":"Get an mTLS certificate","description":"Fetches a single mTLS certificate.","operationId":"access-m-tls-authentication-get-an-m-tls-certificate","parameters":[{"name":"uuid","in":"path","required":true,"schema":{"$ref":"#/components/schemas/uuid"}},{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Get an mTLS certificate response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/certificates_components-schemas-single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Get an mTLS certificate response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/certificates_components-schemas-single_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"put":{"tags":["Access mTLS authentication"],"summary":"Update an mTLS certificate","description":"Updates a configured mTLS certificate.","operationId":"access-m-tls-authentication-update-an-m-tls-certificate","parameters":[{"name":"uuid","in":"path","required":true,"schema":{"$ref":"#/components/schemas/uuid"}},{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["name","associated_hostnames"],"properties":{"associated_hostnames":{"$ref":"#/components/schemas/associated_hostnames"},"name":{"$ref":"#/components/schemas/certificates_components-schemas-name"}}}}}},"responses":{"4xx":{"description":"Update an mTLS certificate response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/certificates_components-schemas-single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Update an mTLS certificate response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/certificates_components-schemas-single_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{identifier}/access/groups":{"get":{"tags":["Access groups"],"summary":"List Access groups","description":"Lists all Access groups.","operationId":"access-groups-list-access-groups","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"List Access groups response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/groups_components-schemas-response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"List Access groups response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/groups_components-schemas-response_collection"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"post":{"tags":["Access groups"],"summary":"Create an Access group","description":"Creates a new Access group.","operationId":"access-groups-create-an-access-group","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["name","include"],"properties":{"exclude":{"$ref":"#/components/schemas/exclude"},"include":{"$ref":"#/components/schemas/include"},"name":{"$ref":"#/components/schemas/groups_components-schemas-name"},"require":{"$ref":"#/components/schemas/require"}}}}}},"responses":{"4xx":{"description":"Create an Access group response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/groups_components-schemas-single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Create an Access group response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/groups_components-schemas-single_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{identifier}/access/groups/{uuid}":{"delete":{"tags":["Access groups"],"summary":"Delete an Access group","description":"Deletes an Access group.","operationId":"access-groups-delete-an-access-group","parameters":[{"name":"uuid","in":"path","required":true,"schema":{"$ref":"#/components/schemas/schemas-uuid"}},{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{"4xx":{"description":"Delete an Access group response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/groups_components-schemas-id_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Delete an Access group response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/groups_components-schemas-id_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"get":{"tags":["Access groups"],"summary":"Get an Access group","description":"Fetches a single Access group.","operationId":"access-groups-get-an-access-group","parameters":[{"name":"uuid","in":"path","required":true,"schema":{"$ref":"#/components/schemas/schemas-uuid"}},{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Get an Access group response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/groups_components-schemas-single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Get an Access group response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/groups_components-schemas-single_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"put":{"tags":["Access groups"],"summary":"Update an Access group","description":"Updates a configured Access group.","operationId":"access-groups-update-an-access-group","parameters":[{"name":"uuid","in":"path","required":true,"schema":{"$ref":"#/components/schemas/schemas-uuid"}},{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["name","include"],"properties":{"exclude":{"$ref":"#/components/schemas/exclude"},"include":{"$ref":"#/components/schemas/include"},"name":{"$ref":"#/components/schemas/groups_components-schemas-name"},"require":{"$ref":"#/components/schemas/require"}}}}}},"responses":{"4xx":{"description":"Update an Access group response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/groups_components-schemas-single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Update an Access group response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/groups_components-schemas-single_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{identifier}/access/identity_providers":{"get":{"tags":["Access identity providers"],"summary":"List Access identity providers","description":"Lists all configured identity providers.","operationId":"access-identity-providers-list-access-identity-providers","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/identity-providers_components-schemas-identifier"}}],"responses":{"4xx":{"description":"List Access identity providers response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/identity-providers_components-schemas-response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"List Access identity providers response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/identity-providers_components-schemas-response_collection"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"post":{"tags":["Access identity providers"],"summary":"Add an Access identity provider","description":"Adds a new identity provider to Access.","operationId":"access-identity-providers-add-an-access-identity-provider","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/identity-providers_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["name","type","config"],"properties":{"config":{"$ref":"#/components/schemas/schemas-config"},"name":{"$ref":"#/components/schemas/identity-providers_components-schemas-name"},"type":{"$ref":"#/components/schemas/identity-providers_components-schemas-type"}}}}}},"responses":{"4xx":{"description":"Add an Access identity provider response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/identity-providers_components-schemas-single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Add an Access identity provider response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/identity-providers_components-schemas-single_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{identifier}/access/identity_providers/{uuid}":{"delete":{"tags":["Access identity providers"],"summary":"Delete an Access identity provider","description":"Deletes an identity provider from Access.","operationId":"access-identity-providers-delete-an-access-identity-provider","parameters":[{"name":"uuid","in":"path","required":true,"schema":{"$ref":"#/components/schemas/uuid"}},{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/identity-providers_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{"4xx":{"description":"Delete an Access identity provider response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/identity-providers_components-schemas-single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Delete an Access identity provider response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/identity-providers_components-schemas-single_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"get":{"tags":["Access identity providers"],"summary":"Get an Access identity provider","description":"Fetches a configured identity provider.","operationId":"access-identity-providers-get-an-access-identity-provider","parameters":[{"name":"uuid","in":"path","required":true,"schema":{"$ref":"#/components/schemas/uuid"}},{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/identity-providers_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Get an Access identity provider response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/identity-providers_components-schemas-single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Get an Access identity provider response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/identity-providers_components-schemas-single_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"put":{"tags":["Access identity providers"],"summary":"Update an Access identity provider","description":"Updates a configured identity provider.","operationId":"access-identity-providers-update-an-access-identity-provider","parameters":[{"name":"uuid","in":"path","required":true,"schema":{"$ref":"#/components/schemas/uuid"}},{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/identity-providers_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["name","type","config"],"properties":{"config":{"$ref":"#/components/schemas/schemas-config"},"name":{"$ref":"#/components/schemas/identity-providers_components-schemas-name"},"type":{"$ref":"#/components/schemas/identity-providers_components-schemas-type"}}}}}},"responses":{"4xx":{"description":"Update an Access identity provider response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/identity-providers_components-schemas-single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Update an Access identity provider response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/identity-providers_components-schemas-single_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{identifier}/access/keys":{"get":{"tags":["Access key configuration"],"summary":"Get the Access key configuration","description":"Gets the Access key rotation settings for an account.","operationId":"access-key-configuration-get-the-access-key-configuration","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/keys_components-schemas-identifier-2"}}],"responses":{"4xx":{"description":"Get the Access key configuration response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/keys_components-schemas-single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Get the Access key configuration response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/keys_components-schemas-single_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"put":{"tags":["Access key configuration"],"summary":"Update the Access key configuration","description":"Updates the Access key rotation settings for an account.","operationId":"access-key-configuration-update-the-access-key-configuration","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/keys_components-schemas-identifier-2"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["key_rotation_interval_days"],"properties":{"key_rotation_interval_days":{"$ref":"#/components/schemas/key_rotation_interval_days"}}}}}},"responses":{"4xx":{"description":"Update the Access key configuration response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/keys_components-schemas-single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Update the Access key configuration response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/keys_components-schemas-single_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{identifier}/access/keys/rotate":{"post":{"tags":["Access key configuration"],"summary":"Rotate Access keys","description":"Perfoms a key rotation for an account.","operationId":"access-key-configuration-rotate-access-keys","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/keys_components-schemas-identifier-2"}}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{"4xx":{"description":"Rotate Access keys response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/keys_components-schemas-single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Rotate Access keys response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/keys_components-schemas-single_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{identifier}/access/logs/access_requests":{"get":{"tags":["Access authentication logs"],"summary":"Get Access authentication logs","description":"Gets a list of Access authentication audit logs for an account.","operationId":"access-authentication-logs-get-access-authentication-logs","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/access-requests_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Get Access authentication logs response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/access-requests_components-schemas-response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Get Access authentication logs response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/access-requests_components-schemas-response_collection"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{identifier}/access/organizations":{"get":{"tags":["Zero Trust organization"],"summary":"Get your Zero Trust organization","description":"Returns the configuration for your Zero Trust organization.","operationId":"zero-trust-organization-get-your-zero-trust-organization","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/organizations_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Get your Zero Trust organization response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/organizations_components-schemas-single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Get your Zero Trust organization response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/organizations_components-schemas-single_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"post":{"tags":["Zero Trust organization"],"summary":"Create your Zero Trust organization","description":"Sets up a Zero Trust organization for your account.","operationId":"zero-trust-organization-create-your-zero-trust-organization","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/organizations_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["name","auth_domain"],"properties":{"auth_domain":{"$ref":"#/components/schemas/auth_domain"},"is_ui_read_only":{"$ref":"#/components/schemas/is_ui_read_only"},"login_design":{"$ref":"#/components/schemas/login_design"},"name":{"$ref":"#/components/schemas/organizations_components-schemas-name"}}}}}},"responses":{"4xx":{"description":"Create your Zero Trust organization response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/organizations_components-schemas-single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Create your Zero Trust organization response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/organizations_components-schemas-single_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"put":{"tags":["Zero Trust organization"],"summary":"Update your Zero Trust organization","description":"Updates the configuration for your Zero Trust organization.","operationId":"zero-trust-organization-update-your-zero-trust-organization","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/organizations_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"auth_domain":{"$ref":"#/components/schemas/auth_domain"},"is_ui_read_only":{"$ref":"#/components/schemas/is_ui_read_only"},"login_design":{"$ref":"#/components/schemas/login_design"},"name":{"$ref":"#/components/schemas/organizations_components-schemas-name"}}}}}},"responses":{"4xx":{"description":"Update your Zero Trust organization response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/organizations_components-schemas-single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Update your Zero Trust organization response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/organizations_components-schemas-single_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{identifier}/access/organizations/revoke_user":{"post":{"tags":["Zero Trust organization"],"summary":"Revoke all Access tokens for a user","description":"Revokes a user's access across all applications.","operationId":"zero-trust-organization-revoke-all-access-tokens-for-a-user","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/organizations_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["email"],"properties":{"email":{"type":"string","description":"The email of the user to revoke.","example":"test@example.com"}}}}}},"responses":{"4xx":{"description":"Revoke all Access tokens for a user response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/schemas-empty_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Revoke all Access tokens for a user response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/schemas-empty_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{identifier}/access/seats":{"patch":{"tags":["Zero Trust seats"],"summary":"Update a user seat","description":"Removes a user from a Zero Trust seat when both `access_seat` and `gateway_seat` are set to false.","operationId":"zero-trust-seats-update-a-user-seat","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/seats_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/seats_definition"}}}},"responses":{"4xx":{"description":"Update a user seat response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/seats_components-schemas-response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Update a user seat response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/seats_components-schemas-response_collection"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{identifier}/access/service_tokens":{"get":{"tags":["Access service tokens"],"summary":"List service tokens","description":"Lists all service tokens.","operationId":"access-service-tokens-list-service-tokens","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"List service tokens response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/service-tokens_components-schemas-response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"List service tokens response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/service-tokens_components-schemas-response_collection"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"post":{"tags":["Access service tokens"],"summary":"Create a service token","description":"Generates a new service token. **Note:** This is the only time you can get the Client Secret. If you lose the Client Secret, you will have to rotate the Client Secret or create a new service token.","operationId":"access-service-tokens-create-a-service-token","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["name"],"properties":{"name":{"$ref":"#/components/schemas/service-tokens_components-schemas-name"}}}}}},"responses":{"4xx":{"description":"Create a service token response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/create_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Create a service token response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/create_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{identifier}/access/service_tokens/{uuid}":{"delete":{"tags":["Access service tokens"],"summary":"Delete a service token","description":"Deletes a service token.","operationId":"access-service-tokens-delete-a-service-token","parameters":[{"name":"uuid","in":"path","required":true,"schema":{"$ref":"#/components/schemas/uuid"}},{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{"4xx":{"description":"Delete a service token response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/service-tokens_components-schemas-single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Delete a service token response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/service-tokens_components-schemas-single_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"put":{"tags":["Access service tokens"],"summary":"Update a service token","description":"Updates a configured service token.","operationId":"access-service-tokens-update-a-service-token","parameters":[{"name":"uuid","in":"path","required":true,"schema":{"$ref":"#/components/schemas/uuid"}},{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"name":{"$ref":"#/components/schemas/service-tokens_components-schemas-name"}}}}}},"responses":{"4xx":{"description":"Update a service token response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/service-tokens_components-schemas-single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Update a service token response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/service-tokens_components-schemas-single_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{identifier}/access/service_tokens/{uuid}/refresh":{"post":{"tags":["Access service tokens"],"summary":"Refresh a service token","description":"Refreshes the expiration of a service token.","operationId":"access-service-tokens-refresh-a-service-token","parameters":[{"name":"uuid","in":"path","required":true,"schema":{"$ref":"#/components/schemas/uuid"}},{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{"4xx":{"description":"Refresh a service token response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/service-tokens_components-schemas-single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Refresh a service token response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/service-tokens_components-schemas-single_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{identifier}/access/service_tokens/{uuid}/rotate":{"post":{"tags":["Access service tokens"],"summary":"Rotate a service token","description":"Generates a new Client Secret for a service token and revokes the old one.","operationId":"access-service-tokens-rotate-a-service-token","parameters":[{"name":"uuid","in":"path","required":true,"schema":{"$ref":"#/components/schemas/uuid"}},{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{"4xx":{"description":"Rotate a service token response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/create_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Rotate a service token response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/create_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{identifier}/access/users":{"get":{"tags":["Zero Trust users"],"summary":"Get users","description":"Gets a list of users for an account.","operationId":"zero-trust-users-get-users","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/users_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Get users response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/users_components-schemas-response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Get users response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/users_components-schemas-response_collection"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{identifier}/access/users/{id}/failed_logins":{"get":{"tags":["Zero Trust users"],"summary":"Get failed logins","description":"Get all failed login attempts for a single user.","operationId":"zero-trust-users-get-failed-logins","parameters":[{"name":"id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/users_components-schemas-id"}},{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/users_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Get failed logins response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/failed_login_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Get failed logins response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/failed_login_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{identifier}/alerting/v3/available_alerts":{"get":{"tags":["Notification Alert Types"],"summary":"Get Alert Types","description":"Gets a list of all alert types for which an account is eligible.","operationId":"notification-alert-types-get-alert-types","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Get Alert Types response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/alert-types_components-schemas-response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Get Alert Types response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/alert-types_components-schemas-response_collection"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{identifier}/alerting/v3/destinations/eligible":{"get":{"tags":["Notification Mechanism Eligibility"],"summary":"Get delivery mechanism eligibility","description":"Get a list of all delivery mechanism types for which an account is eligible.","operationId":"notification-mechanism-eligibility-get-delivery-mechanism-eligibility","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Get delivery mechanism eligibility response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/eligibility_components-schemas-response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Get delivery mechanism eligibility response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/eligibility_components-schemas-response_collection"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{identifier}/alerting/v3/destinations/pagerduty":{"get":{"tags":["Notification destinations with PagerDuty"],"summary":"List PagerDuty services","description":"Get a list of all configured PagerDuty services.","operationId":"notification-destinations-with-pager-duty-list-pager-duty-services","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"List PagerDuty services response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/pagerduty_components-schemas-response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"List PagerDuty services response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/pagerduty_components-schemas-response_collection"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{identifier}/alerting/v3/destinations/webhooks":{"get":{"tags":["Notification webhooks"],"summary":"List webhooks","description":"Gets a list of all configured webhook destinations.","operationId":"notification-webhooks-list-webhooks","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"List webhooks response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/webhooks_components-schemas-response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"List webhooks response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/webhooks_components-schemas-response_collection"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"post":{"tags":["Notification webhooks"],"summary":"Create a webhook","description":"Creates a new webhook destination.","operationId":"notification-webhooks-create-a-webhook","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["name","url"],"properties":{"name":{"$ref":"#/components/schemas/webhooks_components-schemas-name"},"secret":{"$ref":"#/components/schemas/schemas-secret"},"url":{"$ref":"#/components/schemas/webhooks_components-schemas-url"}}}}}},"responses":{"4xx":{"description":"Create a webhook response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/webhooks_components-schemas-id_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Create a webhook response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/webhooks_components-schemas-id_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{identifier}/alerting/v3/destinations/webhooks/{uuid}":{"delete":{"tags":["Notification webhooks"],"summary":"Delete a webhook","description":"Delete a configured webhook destination.","operationId":"notification-webhooks-delete-a-webhook","parameters":[{"name":"uuid","in":"path","required":true,"schema":{"$ref":"#/components/schemas/uuid"}},{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{"4xx":{"description":"Delete a webhook response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Delete a webhook response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-response-collection"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"get":{"tags":["Notification webhooks"],"summary":"Get a webhook","description":"Get details for a single webhooks destination.","operationId":"notification-webhooks-get-a-webhook","parameters":[{"name":"uuid","in":"path","required":true,"schema":{"$ref":"#/components/schemas/uuid"}},{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Get a webhook response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/webhooks_components-schemas-single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Get a webhook response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/webhooks_components-schemas-single_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"put":{"tags":["Notification webhooks"],"summary":"Update a webhook","description":"Update a webhook destination.","operationId":"notification-webhooks-update-a-webhook","parameters":[{"name":"uuid","in":"path","required":true,"schema":{"$ref":"#/components/schemas/uuid"}},{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["name","url"],"properties":{"name":{"$ref":"#/components/schemas/webhooks_components-schemas-name"},"secret":{"$ref":"#/components/schemas/schemas-secret"},"url":{"$ref":"#/components/schemas/webhooks_components-schemas-url"}}}}}},"responses":{"4xx":{"description":"Update a webhook response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/webhooks_components-schemas-id_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Update a webhook response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/webhooks_components-schemas-id_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{identifier}/alerting/v3/history":{"get":{"tags":["Notification History"],"summary":"List History","description":"Gets a list of history records for notifications sent to an account. The records are displayed for last `x` number of days based on the zone plan (free = 30, pro = 30, biz = 30, ent = 90).","operationId":"notification-history-list-history","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"List History response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/history_components-schemas-response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"List History response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/history_components-schemas-response_collection"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{identifier}/alerting/v3/policies":{"get":{"tags":["Notification policies"],"summary":"List Notification policies","description":"Get a list of all Notification policies.","operationId":"notification-policies-list-notification-policies","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"List Notification policies response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/policies_components-schemas-response_collection-2"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"List Notification policies response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/policies_components-schemas-response_collection-2"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"post":{"tags":["Notification policies"],"summary":"Create a Notification policy","description":"Creates a new Notification policy.","operationId":"notification-policies-create-a-notification-policy","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["name","alert_type","enabled","mechanisms"],"properties":{"alert_type":{"$ref":"#/components/schemas/alert_type"},"description":{"$ref":"#/components/schemas/policies_components-schemas-description"},"enabled":{"$ref":"#/components/schemas/policies_components-schemas-enabled"},"filters":{"$ref":"#/components/schemas/components-schemas-filters"},"mechanisms":{"$ref":"#/components/schemas/mechanisms"},"name":{"$ref":"#/components/schemas/policies_components-schemas-name-2"}}}}}},"responses":{"4xx":{"description":"Create a Notification policy response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/policies_components-schemas-id_response-2"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Create a Notification policy response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/policies_components-schemas-id_response-2"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{identifier}/alerting/v3/policies/{uuid}":{"delete":{"tags":["Notification policies"],"summary":"Delete a Notification policy","description":"Delete a Notification policy.","operationId":"notification-policies-delete-a-notification-policy","parameters":[{"name":"uuid","in":"path","required":true,"schema":{"$ref":"#/components/schemas/uuid"}},{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{"4xx":{"description":"Delete a Notification policy response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Delete a Notification policy response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-response-collection"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"get":{"tags":["Notification policies"],"summary":"Get a Notification policy","description":"Get details for a single policy.","operationId":"notification-policies-get-a-notification-policy","parameters":[{"name":"uuid","in":"path","required":true,"schema":{"$ref":"#/components/schemas/uuid"}},{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Get a Notification policy response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/policies_components-schemas-single_response-2"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Get a Notification policy response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/policies_components-schemas-single_response-2"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"put":{"tags":["Notification policies"],"summary":"Update a Notification policy","description":"Update a Notification policy.","operationId":"notification-policies-update-a-notification-policy","parameters":[{"name":"uuid","in":"path","required":true,"schema":{"$ref":"#/components/schemas/uuid"}},{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"alert_type":{"$ref":"#/components/schemas/alert_type"},"description":{"$ref":"#/components/schemas/policies_components-schemas-description"},"enabled":{"$ref":"#/components/schemas/policies_components-schemas-enabled"},"filters":{"$ref":"#/components/schemas/components-schemas-filters"},"mechanisms":{"$ref":"#/components/schemas/mechanisms"},"name":{"$ref":"#/components/schemas/policies_components-schemas-name-2"}}}}}},"responses":{"4xx":{"description":"Update a Notification policy response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/policies_components-schemas-id_response-2"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Update a Notification policy response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/policies_components-schemas-id_response-2"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{identifier}/custom_ns":{"get":{"tags":["Account-Level Custom Nameservers"],"summary":"List Account Custom Nameservers","description":"List an account's custom nameservers.","operationId":"account-level-custom-nameservers-list-account-custom-nameservers","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/custom-ns_components-schemas-identifier"}}],"responses":{"4xx":{"description":"List Account Custom Nameservers response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/acns_response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"List Account Custom Nameservers response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/acns_response_collection"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"post":{"tags":["Account-Level Custom Nameservers"],"summary":"Add Account Custom Nameserver","operationId":"account-level-custom-nameservers-add-account-custom-nameserver","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/custom-ns_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomNSInput"}}}},"responses":{"4xx":{"description":"Add Account Custom Nameserver response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/acns_response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Add Account Custom Nameserver response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/acns_response_single"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{identifier}/custom_ns/{ns_name}":{"delete":{"tags":["Account-Level Custom Nameservers"],"summary":"Delete Account Custom Nameserver","operationId":"account-level-custom-nameservers-delete-account-custom-nameserver","parameters":[{"name":"ns_name","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ns_name"}},{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/custom-ns_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{"4xx":{"description":"Delete Account Custom Nameserver response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/empty_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Delete Account Custom Nameserver response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/empty_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{identifier}/custom_ns/availability":{"get":{"tags":["Account-Level Custom Nameservers"],"summary":"Get Eligible Zones for Account Custom Nameservers","operationId":"account-level-custom-nameservers-get-eligible-zones-for-account-custom-nameservers","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/custom-ns_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Get Eligible Zones for Account Custom Nameservers response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/availability_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Get Eligible Zones for Account Custom Nameservers response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/availability_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{identifier}/custom_ns/verify":{"post":{"tags":["Account-Level Custom Nameservers"],"summary":"Verify Account Custom Nameserver Glue Records","operationId":"account-level-custom-nameservers-verify-account-custom-nameserver-glue-records","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/custom-ns_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{"4xx":{"description":"Verify Account Custom Nameserver Glue Records response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/acns_response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Verify Account Custom Nameserver Glue Records response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/acns_response_collection"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{identifier}/devices":{"get":{"tags":["Devices"],"summary":"List Devices","description":"List Enrolled Devices.","operationId":"devices-list-devices","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/devices_components-schemas-identifier"}}],"responses":{"4xx":{"description":"List Devices response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/devices_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"List Devices response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/devices_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{identifier}/devices/{uuid}":{"get":{"tags":["Devices"],"summary":"Device Details","description":"Fetch a single Device.","operationId":"devices-device-details","parameters":[{"name":"uuid","in":"path","required":true,"schema":{"$ref":"#/components/schemas/uuid"}},{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/devices_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Device Details response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/device_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Device Details response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/device_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{identifier}/devices/{uuid}/override_codes":{"get":{"tags":["Devices"],"summary":"List Admin Override code for device","description":"Fetch one-time use admin override code for a device. This relies on the Admin Override setting being enabled in your device configuration.","operationId":"devices-list-admin-override-code-for-device","parameters":[{"name":"uuid","in":"path","required":true,"schema":{"$ref":"#/components/schemas/uuid"}},{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/devices_components-schemas-identifier"}}],"responses":{"4xx":{"description":"List Admin Override code for device response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/override_codes_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"List Admin Override code for device response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/override_codes_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{identifier}/devices/policies":{"get":{"tags":["Devices"],"summary":"List Device Settings Policies","description":"Lists the device settings policies for an account.","operationId":"devices-list-device-settings-policies","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/devices_components-schemas-identifier"}}],"responses":{"4xx":{"description":"List Device Settings Policies response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/device_settings_response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"List Device Settings Policies response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/device_settings_response_collection"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{identifier}/devices/policy":{"get":{"tags":["Devices"],"summary":"Get Default Device Settings Policy","description":"Get the default device settings policy for an account.","operationId":"devices-get-default-device-settings-policy","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/devices_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Get Default Device Settings Policy response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/default_device_settings_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Get Default Device Settings Policy response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/default_device_settings_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"patch":{"tags":["Devices"],"summary":"Update Default Device Settings Policy","description":"Update the default device settings policy for an account.","operationId":"devices-update-default-device-settings-policy","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/devices_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"allow_mode_switch":{"$ref":"#/components/schemas/allow_mode_switch"},"allow_updates":{"$ref":"#/components/schemas/allow_updates"},"allowed_to_leave":{"$ref":"#/components/schemas/allowed_to_leave"},"auto_connect":{"$ref":"#/components/schemas/auto_connect"},"captive_portal":{"$ref":"#/components/schemas/captive_portal"},"disable_auto_fallback":{"$ref":"#/components/schemas/disable_auto_fallback"},"service_mode_v2":{"$ref":"#/components/schemas/service_mode_v2"},"support_url":{"$ref":"#/components/schemas/support_url"},"switch_locked":{"$ref":"#/components/schemas/switch_locked"}}}}}},"responses":{"4xx":{"description":"Update Default Device Settings Policy response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/default_device_settings_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Update Default Device Settings Policy response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/default_device_settings_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"post":{"tags":["Devices"],"summary":"Create Device Settings Policy","description":"Create a device settings policy to be applied to certain devices matching the criteria.","operationId":"devices-create-device-settings-policy","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/devices_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["name","precedence","match"],"properties":{"allow_mode_switch":{"$ref":"#/components/schemas/allow_mode_switch"},"allow_updates":{"$ref":"#/components/schemas/allow_updates"},"allowed_to_leave":{"$ref":"#/components/schemas/allowed_to_leave"},"auto_connect":{"$ref":"#/components/schemas/auto_connect"},"captive_portal":{"$ref":"#/components/schemas/captive_portal"},"disable_auto_fallback":{"$ref":"#/components/schemas/disable_auto_fallback"},"enabled":{"type":"boolean","description":"Whether the policy will be applied to matching devices.","example":true},"match":{"$ref":"#/components/schemas/components-schemas-match"},"name":{"type":"string","description":"The name of the device settings policy.","example":"Allow Developers","maxLength":100},"precedence":{"$ref":"#/components/schemas/components-schemas-precedence"},"service_mode_v2":{"$ref":"#/components/schemas/service_mode_v2"},"support_url":{"$ref":"#/components/schemas/support_url"},"switch_locked":{"$ref":"#/components/schemas/switch_locked"}}}}}},"responses":{"4xx":{"description":"Create Device Settings Policy response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/device_settings_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Create Device Settings Policy response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/device_settings_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{identifier}/devices/policy/{uuid}":{"delete":{"tags":["Devices"],"summary":"Delete Device Settings Policy","description":"Delete a device settings policy. Returns the remaining policies for the account.","operationId":"devices-delete-device-settings-policy","parameters":[{"name":"uuid","in":"path","required":true,"schema":{"$ref":"#/components/schemas/uuid"}},{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/devices_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{"4xx":{"description":"Delete Device Settings Policy response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/device_settings_response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Delete Device Settings Policy response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/device_settings_response_collection"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"get":{"tags":["Devices"],"summary":"Get Device Settings Policy by ID","description":"Get the device settings policy by ID.","operationId":"devices-get-device-settings-policy-by-id","parameters":[{"name":"uuid","in":"path","required":true,"schema":{"$ref":"#/components/schemas/uuid"}},{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/devices_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Get Device Settings Policy by ID response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/device_settings_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Get Device Settings Policy by ID response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/device_settings_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"patch":{"tags":["Devices"],"summary":"Update Device Settings Policy","description":"Update a device settings policy.","operationId":"devices-update-device-settings-policy","parameters":[{"name":"uuid","in":"path","required":true,"schema":{"$ref":"#/components/schemas/uuid"}},{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/devices_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"allow_mode_switch":{"$ref":"#/components/schemas/allow_mode_switch"},"allow_updates":{"$ref":"#/components/schemas/allow_updates"},"allowed_to_leave":{"$ref":"#/components/schemas/allowed_to_leave"},"auto_connect":{"$ref":"#/components/schemas/auto_connect"},"captive_portal":{"$ref":"#/components/schemas/captive_portal"},"disable_auto_fallback":{"$ref":"#/components/schemas/disable_auto_fallback"},"enabled":{"type":"boolean","description":"Whether the policy will be applied to matching devices.","example":true},"match":{"$ref":"#/components/schemas/components-schemas-match"},"name":{"type":"string","description":"The name of the device settings policy.","example":"Allow Developers","maxLength":100},"precedence":{"$ref":"#/components/schemas/components-schemas-precedence"},"service_mode_v2":{"$ref":"#/components/schemas/service_mode_v2"},"support_url":{"$ref":"#/components/schemas/support_url"},"switch_locked":{"$ref":"#/components/schemas/switch_locked"}}}}}},"responses":{"4xx":{"description":"Update Device Settings Policy response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/device_settings_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Update Device Settings Policy response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/device_settings_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{identifier}/devices/policy/{uuid}/exclude":{"get":{"tags":["Devices"],"summary":"Get Split Tunnel Exclude List for a Device Settings Policy","description":"Get the list of routes excluded from the WARP client's tunnel for one specific device settings policy.","operationId":"devices-get-split-tunnel-exclude-list-for-a-device-settings-policy","parameters":[{"name":"uuid","in":"path","required":true,"schema":{"$ref":"#/components/schemas/uuid"}},{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/devices_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Get Split Tunnel Exclude List for a Device Settings Policy response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/split_tunnel_response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Get Split Tunnel Exclude List for a Device Settings Policy response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/split_tunnel_response_collection"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"put":{"tags":["Devices"],"summary":"Set Split Tunnel Exclude List for a Device Settings Policy","description":"Set the list of routes excluded from the WARP client's tunnel for one specific device settings policy.","operationId":"devices-set-split-tunnel-exclude-list-for-a-device-settings-policy","parameters":[{"name":"uuid","in":"path","required":true,"schema":{"$ref":"#/components/schemas/uuid"}},{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/devices_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/split_tunnel"}}}}},"responses":{"4xx":{"description":"Set Split Tunnel Exclude List for a Device Settings Policy response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/split_tunnel_response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Set Split Tunnel Exclude List for a Device Settings Policy response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/split_tunnel_response_collection"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{identifier}/devices/policy/{uuid}/fallback_domains":{"get":{"tags":["Devices"],"summary":"Get Local Domain Fallback List for a Device Settings Policy","description":"Get the list of domains to bypass Gateway for DNS resolution and instead use the specified server.","operationId":"devices-get-local-domain-fallback-list-for-a-device-settings-policy","parameters":[{"name":"uuid","in":"path","required":true,"schema":{"$ref":"#/components/schemas/uuid"}},{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/devices_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Get Local Domain Fallback List for a Device Settings Policy response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/fallback_domain_response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Get Local Domain Fallback List for a Device Settings Policy response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/fallback_domain_response_collection"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"put":{"tags":["Devices"],"summary":"Set Local Domain Fallback List for a Device Settings Policy","description":"Set the list of domains to bypass Gateway for DNS resolution and instead use the specified server.","operationId":"devices-set-local-domain-fallback-list-for-a-device-settings-policy","parameters":[{"name":"uuid","in":"path","required":true,"schema":{"$ref":"#/components/schemas/uuid"}},{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/devices_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/fallback_domain"}}}}},"responses":{"4xx":{"description":"Set Local Domain Fallback List for a Device Settings Policy response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/fallback_domain_response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Set Local Domain Fallback List for a Device Settings Policy response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/fallback_domain_response_collection"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{identifier}/devices/policy/{uuid}/include":{"get":{"tags":["Devices"],"summary":"Get Split Tunnel Include List for a Device Settings Policy","description":"Get the list of routes included in the WARP client's tunnel for one specific device settings policy.","operationId":"devices-get-split-tunnel-include-list-for-a-device-settings-policy","parameters":[{"name":"uuid","in":"path","required":true,"schema":{"$ref":"#/components/schemas/uuid"}},{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/devices_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Get Split Tunnel Include List for a Device Settings Policy response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/split_tunnel_include_response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Get Split Tunnel Include List for a Device Settings Policy response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/split_tunnel_include_response_collection"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"put":{"tags":["Devices"],"summary":"Set Split Tunnel Include List for a Device Settings Policy","description":"Set the list of routes included in the WARP client's tunnel for one specific device settings policy.","operationId":"devices-set-split-tunnel-include-list-for-a-device-settings-policy","parameters":[{"name":"uuid","in":"path","required":true,"schema":{"$ref":"#/components/schemas/uuid"}},{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/devices_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/split_tunnel_include"}}}}},"responses":{"4xx":{"description":"Set Split Tunnel Include List for a Device Settings Policy response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/split_tunnel_include_response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Set Split Tunnel Include List for a Device Settings Policy response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/split_tunnel_include_response_collection"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{identifier}/devices/policy/exclude":{"get":{"tags":["Devices"],"summary":"Get Split Tunnel Exclude List","description":"Get the list of routes excluded from the WARP client's tunnel.","operationId":"devices-get-split-tunnel-exclude-list","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/devices_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Get Split Tunnel Exclude List response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/split_tunnel_response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Get Split Tunnel Exclude List response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/split_tunnel_response_collection"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"put":{"tags":["Devices"],"summary":"Set Split Tunnel Exclude List","description":"Set the list of routes excluded from the WARP client's tunnel.","operationId":"devices-set-split-tunnel-exclude-list","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/devices_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/split_tunnel"}}}}},"responses":{"4xx":{"description":"Set Split Tunnel Exclude List response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/split_tunnel_response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Set Split Tunnel Exclude List response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/split_tunnel_response_collection"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{identifier}/devices/policy/fallback_domains":{"get":{"tags":["Devices"],"summary":"Get Local Domain Fallback List","description":"Get the list of domains to bypass Gateway for DNS resolution and instead use the specified server.","operationId":"devices-get-local-domain-fallback-list","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/devices_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Get Local Domain Fallback List response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/fallback_domain_response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Get Local Domain Fallback List response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/fallback_domain_response_collection"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"put":{"tags":["Devices"],"summary":"Set Local Domain Fallback List","description":"Set the list of domains to bypass Gateway for DNS resolution and instead use the specified server.","operationId":"devices-set-local-domain-fallback-list","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/devices_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/fallback_domain"}}}}},"responses":{"4xx":{"description":"Set Local Domain Fallback List response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/fallback_domain_response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Set Local Domain Fallback List response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/fallback_domain_response_collection"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{identifier}/devices/policy/include":{"get":{"tags":["Devices"],"summary":"Get Split Tunnel Include List","description":"Get the list of routes included in the WARP client's tunnel.","operationId":"devices-get-split-tunnel-include-list","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/devices_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Get Split Tunnel Include List response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/split_tunnel_include_response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Get Split Tunnel Include List response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/split_tunnel_include_response_collection"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"put":{"tags":["Devices"],"summary":"Set Split Tunnel Include List","description":"Set the list of routes included in the WARP client's tunnel.","operationId":"devices-set-split-tunnel-include-list","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/devices_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/split_tunnel_include"}}}}},"responses":{"4xx":{"description":"Set Split Tunnel Include List response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/split_tunnel_include_response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Set Split Tunnel Include List response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/split_tunnel_include_response_collection"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{identifier}/devices/posture":{"get":{"tags":["Device Posture Rules"],"summary":"List Device Posture Rules","description":"List Device Posture Rules for an account.","operationId":"device-posture-rules-list-device-posture-rules","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/device-posture-rules_components-schemas-identifier"}}],"responses":{"4xx":{"description":"List Device Posture Rules response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/device-posture-rules_components-schemas-response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"List Device Posture Rules response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/device-posture-rules_components-schemas-response_collection"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"post":{"tags":["Device Posture Rules"],"summary":"Create Device Posture Rule","description":"Create a new Device Posture Rule.","operationId":"device-posture-rules-create-device-posture-rule","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/device-posture-rules_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["name","type"],"properties":{"description":{"$ref":"#/components/schemas/device-posture-rules_components-schemas-description"},"expiration":{"$ref":"#/components/schemas/schemas-expiration"},"input":{"$ref":"#/components/schemas/schemas-input"},"match":{"$ref":"#/components/schemas/schemas-match"},"name":{"$ref":"#/components/schemas/device-posture-rules_components-schemas-name"},"schedule":{"$ref":"#/components/schemas/schedule"},"type":{"$ref":"#/components/schemas/device-posture-rules_components-schemas-type"}}}}}},"responses":{"4xx":{"description":"Create Device Posture Rule response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/device-posture-rules_components-schemas-single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Create Device Posture Rule response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/device-posture-rules_components-schemas-single_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{identifier}/devices/posture/{uuid}":{"delete":{"tags":["Device Posture Rules"],"summary":"Delete Device Posture Rule","description":"Delete a Device Posture Rule.","operationId":"device-posture-rules-delete-device-posture-rule","parameters":[{"name":"uuid","in":"path","required":true,"schema":{"$ref":"#/components/schemas/device-posture-rules_components-schemas-uuid"}},{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/device-posture-rules_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{"4xx":{"description":"Delete Device Posture Rule response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/device-posture-rules_components-schemas-id_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Delete Device Posture Rule response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/device-posture-rules_components-schemas-id_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"get":{"tags":["Device Posture Rules"],"summary":"Device Posture Rules Details","description":"Fetch a single Device Posture Rule.","operationId":"device-posture-rules-device-posture-rules-details","parameters":[{"name":"uuid","in":"path","required":true,"schema":{"$ref":"#/components/schemas/device-posture-rules_components-schemas-uuid"}},{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/device-posture-rules_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Device Posture Rules Details response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/device-posture-rules_components-schemas-single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Device Posture Rules Details response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/device-posture-rules_components-schemas-single_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"put":{"tags":["Device Posture Rules"],"summary":"Update Device Posture Rule","description":"Update a Device Posture Rule.","operationId":"device-posture-rules-update-device-posture-rule","parameters":[{"name":"uuid","in":"path","required":true,"schema":{"$ref":"#/components/schemas/device-posture-rules_components-schemas-uuid"}},{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/device-posture-rules_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["name","type"],"properties":{"description":{"$ref":"#/components/schemas/device-posture-rules_components-schemas-description"},"expiration":{"$ref":"#/components/schemas/schemas-expiration"},"input":{"$ref":"#/components/schemas/schemas-input"},"match":{"$ref":"#/components/schemas/schemas-match"},"name":{"$ref":"#/components/schemas/device-posture-rules_components-schemas-name"},"schedule":{"$ref":"#/components/schemas/schedule"},"type":{"$ref":"#/components/schemas/device-posture-rules_components-schemas-type"}}}}}},"responses":{"4xx":{"description":"Update Device Posture Rule response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/device-posture-rules_components-schemas-single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Update Device Posture Rule response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/device-posture-rules_components-schemas-single_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{identifier}/devices/posture/integration":{"get":{"tags":["Device Posture Integrations"],"summary":"List Device Posture Integrations","description":"List Device Posture Integrations for an account.","operationId":"device-posture-integrations-list-device-posture-integrations","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/device-posture-integrations_components-schemas-identifier"}}],"responses":{"4xx":{"description":"List Device Posture Integrations response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/device-posture-integrations_components-schemas-response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"List Device Posture Integrations response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/device-posture-integrations_components-schemas-response_collection"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"post":{"tags":["Device Posture Integrations"],"summary":"Create Device Posture Integration","description":"Create a new Device Posture Integration.","operationId":"device-posture-integrations-create-device-posture-integration","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/device-posture-integrations_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["name","type","interval","config"],"properties":{"config":{"$ref":"#/components/schemas/config_request"},"interval":{"$ref":"#/components/schemas/schemas-interval"},"name":{"$ref":"#/components/schemas/device-posture-integrations_components-schemas-name"},"type":{"$ref":"#/components/schemas/device-posture-integrations_components-schemas-type"}}}}}},"responses":{"4xx":{"description":"Create Device Posture Integration response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/device-posture-integrations_components-schemas-single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Create Device Posture Integration response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/device-posture-integrations_components-schemas-single_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{identifier}/devices/posture/integration/{uuid}":{"delete":{"tags":["Device Posture Integrations"],"summary":"Delete Device Posture Integration","description":"Delete a Device Posture Integration.","operationId":"device-posture-integrations-delete-device-posture-integration","parameters":[{"name":"uuid","in":"path","required":true,"schema":{"$ref":"#/components/schemas/device-posture-integrations_components-schemas-uuid"}},{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/device-posture-integrations_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{"4xx":{"description":"Delete Device Posture Integration response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/device-posture-integrations_components-schemas-id_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Delete Device Posture Integration response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/device-posture-integrations_components-schemas-id_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"get":{"tags":["Device Posture Integrations"],"summary":"Device Posture Integration Details","description":"Fetch a single Device Posture Integration.","operationId":"device-posture-integrations-device-posture-integration-details","parameters":[{"name":"uuid","in":"path","required":true,"schema":{"$ref":"#/components/schemas/device-posture-integrations_components-schemas-uuid"}},{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/device-posture-integrations_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Device Posture Integration Details response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/device-posture-integrations_components-schemas-single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Device Posture Integration Details response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/device-posture-integrations_components-schemas-single_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"patch":{"tags":["Device Posture Integrations"],"summary":"Update Device Posture Integration","description":"Update a Device Posture Integration.","operationId":"device-posture-integrations-update-device-posture-integration","parameters":[{"name":"uuid","in":"path","required":true,"schema":{"$ref":"#/components/schemas/device-posture-integrations_components-schemas-uuid"}},{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/device-posture-integrations_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"config":{"$ref":"#/components/schemas/config_request"},"interval":{"$ref":"#/components/schemas/schemas-interval"},"name":{"$ref":"#/components/schemas/device-posture-integrations_components-schemas-name"},"type":{"$ref":"#/components/schemas/device-posture-integrations_components-schemas-type"}}}}}},"responses":{"4xx":{"description":"Update Device Posture Integration response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/device-posture-integrations_components-schemas-single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Update Device Posture Integration response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/device-posture-integrations_components-schemas-single_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{identifier}/devices/revoke":{"post":{"tags":["Devices"],"summary":"Revoke Devices","description":"Revoke a list of devices.","operationId":"devices-revoke-devices","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/devices_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/revoke_devices_request"}}}},"responses":{"4xx":{"description":"Revoke Devices response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Revoke Devices response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-response-single"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{identifier}/devices/settings":{"get":{"tags":["Zero Trust accounts"],"summary":"Get device settings for Zero Trust account","description":"Describes the current device settings Zero Trust account.","operationId":"zero-trust-accounts-get-device-settings-for-zero-trust-account","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/accounts_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Get device settings for Zero Trust account response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/gateway-account-device-settings-response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Get device settings for Zero Trust account response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/gateway-account-device-settings-response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"put":{"tags":["Zero Trust accounts"],"summary":"Update device settings for the Zero Trust account","description":"Updates the current device settings for Zero Trust account.","operationId":"zero-trust-accounts-update-device-settings-for-the-zero-trust-account","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/accounts_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/gateway-account-device-settings"}}}},"responses":{"4xx":{"description":"Update device settings for the Zero Trust account response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/gateway-account-device-settings-response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Update device settings for the Zero Trust account response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/gateway-account-device-settings-response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{identifier}/devices/unrevoke":{"post":{"tags":["Devices"],"summary":"Unrevoke Devices","description":"Unrevoke a list of devices.","operationId":"devices-unrevoke-devices","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/devices_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/unrevoke_devices_request"}}}},"responses":{"4xx":{"description":"Unrevoke Devices response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Unrevoke Devices response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-response-single"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{identifier}/gateway":{"get":{"tags":["Zero Trust accounts"],"summary":"Get Zero Trust account information","description":"Get Zero Trust account information.","operationId":"zero-trust-accounts-get-zero-trust-account-information","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/accounts_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Get Zero Trust account information response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/gateway_account"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Get Zero Trust account information response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/gateway_account"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"post":{"tags":["Zero Trust accounts"],"summary":"Create Zero Trust account","description":"Create Zero Trust account with existing cloudflare account.","operationId":"zero-trust-accounts-create-zero-trust-account","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/accounts_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["account_id"],"properties":{"account_id":{"$ref":"#/components/schemas/cf_account_id"}}}}}},"responses":{"4xx":{"description":"Create Zero Trust account response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/gateway_account"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Create Zero Trust account response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/gateway_account"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{identifier}/gateway/app_types":{"get":{"tags":["Zero Trust Gateway Application and Application Type mappings"],"summary":"List Application and Application Type mappings","description":"List all Application and Application Type mappings.","operationId":"zero-trust-gateway-application-and-application-type-mappings-list-application-and-application-type-mappings","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"List Application and Application Type mappings response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/app-types_components-schemas-response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"List Application and Application Type mappings response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/app-types_components-schemas-response_collection"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{identifier}/gateway/configuration":{"get":{"tags":["Zero Trust accounts"],"summary":"Get Zero Trust account configuration","description":"Describes current Zero Trust account configuration.","operationId":"zero-trust-accounts-get-zero-trust-account-configuration","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/accounts_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Get Zero Trust account configuration response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/gateway_account_config"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Get Zero Trust account configuration response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/gateway_account_config"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"put":{"tags":["Zero Trust accounts"],"summary":"Update Zero Trust account configuration","description":"Updates the current Zero Trust account configuration.","operationId":"zero-trust-accounts-update-zero-trust-account-configuration","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/accounts_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/gateway-account-settings"}}}},"responses":{"4xx":{"description":"Update Zero Trust account configuration response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/gateway_account_config"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Update Zero Trust account configuration response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/gateway_account_config"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{identifier}/gateway/lists":{"get":{"tags":["Zero Trust Lists"],"summary":"List Zero Trust Lists","description":"List Zero Trust Lists for an account.","operationId":"zero-trust-lists-list-zero-trust-lists","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/lists_components-schemas-identifier"}}],"responses":{"4xx":{"description":"List Zero Trust Lists response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/lists_components-schemas-response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"List Zero Trust Lists response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/lists_components-schemas-response_collection"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"post":{"tags":["Zero Trust Lists"],"summary":"Create Zero Trust List","description":"Create a new Zero Trust List.","operationId":"zero-trust-lists-create-zero-trust-list","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/lists_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["name","type"],"properties":{"description":{"$ref":"#/components/schemas/lists_components-schemas-description-2"},"items":{"$ref":"#/components/schemas/schemas-items"},"name":{"$ref":"#/components/schemas/lists_components-schemas-name-2"},"type":{"$ref":"#/components/schemas/lists_components-schemas-type"}}}}}},"responses":{"4xx":{"description":"Create Zero Trust List response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/single_response_with_list_items"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Create Zero Trust List response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/single_response_with_list_items"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{identifier}/gateway/lists/{uuid}":{"delete":{"tags":["Zero Trust Lists"],"summary":"Delete Zero Trust List","description":"Delete a Zero Trust List.","operationId":"zero-trust-lists-delete-zero-trust-list","parameters":[{"name":"uuid","in":"path","required":true,"schema":{"$ref":"#/components/schemas/lists_components-schemas-uuid"}},{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/lists_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{"4xx":{"description":"Delete Zero Trust List response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/lists_components-schemas-empty_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Delete Zero Trust List response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/lists_components-schemas-empty_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"get":{"tags":["Zero Trust Lists"],"summary":"Zero Trust List Details","description":"Fetch a single Zero Trust List.","operationId":"zero-trust-lists-zero-trust-list-details","parameters":[{"name":"uuid","in":"path","required":true,"schema":{"$ref":"#/components/schemas/lists_components-schemas-uuid"}},{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/lists_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Zero Trust List Details response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/lists_components-schemas-single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Zero Trust List Details response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/lists_components-schemas-single_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"patch":{"tags":["Zero Trust Lists"],"summary":"Patch Zero Trust List","description":"Append or remove an item from a configured Zero Trust List.","operationId":"zero-trust-lists-patch-zero-trust-list","parameters":[{"name":"uuid","in":"path","required":true,"schema":{"$ref":"#/components/schemas/lists_components-schemas-uuid"}},{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/lists_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"append":{"$ref":"#/components/schemas/schemas-items"},"remove":{"type":"array","description":"A list of the item values you want to remove.","items":{"$ref":"#/components/schemas/lists_components-schemas-value"}}}}}}},"responses":{"4xx":{"description":"Patch Zero Trust List response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/lists_components-schemas-single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Patch Zero Trust List response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/lists_components-schemas-single_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"put":{"tags":["Zero Trust Lists"],"summary":"Update Zero Trust List","description":"Update a configured Zero Trust List.","operationId":"zero-trust-lists-update-zero-trust-list","parameters":[{"name":"uuid","in":"path","required":true,"schema":{"$ref":"#/components/schemas/lists_components-schemas-uuid"}},{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/lists_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["name"],"properties":{"description":{"$ref":"#/components/schemas/lists_components-schemas-description-2"},"name":{"$ref":"#/components/schemas/lists_components-schemas-name-2"}}}}}},"responses":{"4xx":{"description":"Update Zero Trust List response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/lists_components-schemas-single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Update Zero Trust List response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/lists_components-schemas-single_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{identifier}/gateway/lists/{uuid}/items":{"get":{"tags":["Zero Trust Lists"],"summary":"Zero Trust List Items","description":"Fetch all items of a single Zero Trust List.","operationId":"zero-trust-lists-zero-trust-list-items","parameters":[{"name":"uuid","in":"path","required":true,"schema":{"$ref":"#/components/schemas/lists_components-schemas-uuid"}},{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/lists_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Zero Trust List Items response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/list_item_response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Zero Trust List Items response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/list_item_response_collection"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{identifier}/gateway/locations":{"get":{"tags":["Zero Trust Gateway Locations"],"summary":"List Zero Trust Gateway Locations","description":"List Zero Trust Gateway Locations for an account.","operationId":"zero-trust-gateway-locations-list-zero-trust-gateway-locations","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/locations_components-schemas-identifier"}}],"responses":{"4xx":{"description":"List Zero Trust Gateway Locations response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/locations_components-schemas-response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"List Zero Trust Gateway Locations response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/locations_components-schemas-response_collection"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"post":{"tags":["Zero Trust Gateway Locations"],"summary":"Create Zero Trust Gateway Location","description":"Create a new Zero Trust Gateway Location.","operationId":"zero-trust-gateway-locations-create-zero-trust-gateway-location","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/locations_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["name"],"properties":{"client_default":{"$ref":"#/components/schemas/client-default"},"ecs_support":{"$ref":"#/components/schemas/ecs-support"},"name":{"$ref":"#/components/schemas/locations_components-schemas-name"},"networks":{"$ref":"#/components/schemas/network"}}}}}},"responses":{"4xx":{"description":"Create Zero Trust Gateway Location response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/locations_components-schemas-single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Create Zero Trust Gateway Location response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/locations_components-schemas-single_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{identifier}/gateway/locations/{uuid}":{"delete":{"tags":["Zero Trust Gateway Locations"],"summary":"Delete Zero Trust Gateway Location","description":"Delete a Zero Trust Gateway Location.","operationId":"zero-trust-gateway-locations-delete-zero-trust-gateway-location","parameters":[{"name":"uuid","in":"path","required":true,"schema":{"$ref":"#/components/schemas/locations_components-schemas-uuid"}},{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/locations_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{"4xx":{"description":"Delete Zero Trust Gateway Location response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/locations_components-schemas-empty_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Delete Zero Trust Gateway Location response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/locations_components-schemas-empty_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"get":{"tags":["Zero Trust Gateway Locations"],"summary":"Zero Trust Gateway Location Details","description":"Fetch a single Zero Trust Gateway Location.","operationId":"zero-trust-gateway-locations-zero-trust-gateway-location-details","parameters":[{"name":"uuid","in":"path","required":true,"schema":{"$ref":"#/components/schemas/locations_components-schemas-uuid"}},{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/locations_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Zero Trust Gateway Location Details response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/locations_components-schemas-single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Zero Trust Gateway Location Details response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/locations_components-schemas-single_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"put":{"tags":["Zero Trust Gateway Locations"],"summary":"Update Zero Trust Gateway Location","description":"Update a configured Zero Trust Gateway Location.","operationId":"zero-trust-gateway-locations-update-zero-trust-gateway-location","parameters":[{"name":"uuid","in":"path","required":true,"schema":{"$ref":"#/components/schemas/locations_components-schemas-uuid"}},{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/locations_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["name"],"properties":{"client_default":{"$ref":"#/components/schemas/client-default"},"ecs_support":{"$ref":"#/components/schemas/ecs-support"},"name":{"$ref":"#/components/schemas/locations_components-schemas-name"},"networks":{"$ref":"#/components/schemas/network"}}}}}},"responses":{"4xx":{"description":"Update Zero Trust Gateway Location response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/locations_components-schemas-single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Update Zero Trust Gateway Location response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/locations_components-schemas-single_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{identifier}/gateway/logging":{"get":{"tags":["Zero Trust accounts"],"summary":"Get logging settings for the Zero Trust account","description":"Describes the current logging settings for Zero Trust account.","operationId":"zero-trust-accounts-get-logging-settings-for-the-zero-trust-account","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/accounts_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Get logging settings for the Zero Trust account response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/gateway-account-logging-settings-response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Get logging settings for the Zero Trust account response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/gateway-account-logging-settings-response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"put":{"tags":["Zero Trust accounts"],"summary":"Update logging settings for the Zero Trust account","description":"Updates the current logging settings for the Zero Trust accounty.","operationId":"zero-trust-accounts-update-logging-settings-for-the-zero-trust-account","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/accounts_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/gateway-account-logging-settings"}}}},"responses":{"4xx":{"description":"Update logging settings for the Zero Trust account response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/gateway-account-logging-settings-response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Update logging settings for the Zero Trust account response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/gateway-account-logging-settings-response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{identifier}/gateway/proxy_endpoints":{"get":{"tags":["Zero Trust Gateway Proxy Endpoints"],"summary":"List Proxy Endpoints","description":"Fetch a single Zero Trust Gateway Proxy Endpoint.","operationId":"zero-trust-gateway-proxy-endpoints-list-proxy-endpoints","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/proxy-endpoints_components-schemas-identifier"}}],"responses":{"4xx":{"description":"List Proxy Endpoints response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/proxy-endpoints_components-schemas-response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"List Proxy Endpoints response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/proxy-endpoints_components-schemas-response_collection"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"post":{"tags":["Zero Trust Gateway Proxy Endpoints"],"summary":"Create Proxy Endpoint","description":"Create a new Zero Trust Gateway Proxy Endpoint.","operationId":"zero-trust-gateway-proxy-endpoints-create-proxy-endpoint","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/proxy-endpoints_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["name","ips"],"properties":{"ips":{"$ref":"#/components/schemas/components-schemas-ips"},"name":{"$ref":"#/components/schemas/proxy-endpoints_components-schemas-name"},"subdomain":{"$ref":"#/components/schemas/schemas-subdomain"}}}}}},"responses":{"4xx":{"description":"Create Proxy Endpoint response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/proxy-endpoints_components-schemas-single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Create Proxy Endpoint response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/proxy-endpoints_components-schemas-single_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{identifier}/gateway/proxy_endpoints/{uuid}":{"delete":{"tags":["Zero Trust Gateway Proxy Endpoints"],"summary":"Delete Proxy Endpoint","description":"Delete a Zero Trust Gateway Proxy Endpoint.","operationId":"zero-trust-gateway-proxy-endpoints-delete-proxy-endpoint","parameters":[{"name":"uuid","in":"path","required":true,"schema":{"$ref":"#/components/schemas/proxy-endpoints_components-schemas-uuid"}},{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/proxy-endpoints_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{"4xx":{"description":"Delete Proxy Endpoint response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/proxy-endpoints_components-schemas-empty_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Delete Proxy Endpoint response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/proxy-endpoints_components-schemas-empty_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"get":{"tags":["Zero Trust Gateway Proxy Endpoints"],"summary":"Proxy Endpoint Details","description":"List Zero Trust Gateway Proxy Endpoints for an account.","operationId":"zero-trust-gateway-proxy-endpoints-proxy-endpoint-details","parameters":[{"name":"uuid","in":"path","required":true,"schema":{"$ref":"#/components/schemas/proxy-endpoints_components-schemas-uuid"}},{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/proxy-endpoints_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Proxy Endpoint Details response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/proxy-endpoints_components-schemas-single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Proxy Endpoint Details response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/proxy-endpoints_components-schemas-single_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"patch":{"tags":["Zero Trust Gateway Proxy Endpoints"],"summary":"Update Proxy Endpoint","description":"Update a new Zero Trust Gateway Proxy Endpoint.","operationId":"zero-trust-gateway-proxy-endpoints-update-proxy-endpoint","parameters":[{"name":"uuid","in":"path","required":true,"schema":{"$ref":"#/components/schemas/proxy-endpoints_components-schemas-uuid"}},{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/proxy-endpoints_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"ips":{"$ref":"#/components/schemas/components-schemas-ips"},"name":{"$ref":"#/components/schemas/proxy-endpoints_components-schemas-name"},"subdomain":{"$ref":"#/components/schemas/schemas-subdomain"}}}}}},"responses":{"4xx":{"description":"Update Proxy Endpoint response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/proxy-endpoints_components-schemas-single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Update Proxy Endpoint response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/proxy-endpoints_components-schemas-single_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{identifier}/gateway/rules":{"get":{"tags":["Zero Trust Gateway Rules"],"summary":"List Zero Trust Gateway Rules","description":"List Zero Trust Gateway Rules for an account.","operationId":"zero-trust-gateway-rules-list-zero-trust-gateway-rules","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/rules_components-schemas-identifier"}}],"responses":{"4xx":{"description":"List Zero Trust Gateway Rules response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/rules_components-schemas-response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"List Zero Trust Gateway Rules response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/rules_components-schemas-response_collection"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"post":{"tags":["Zero Trust Gateway Rules"],"summary":"Create Zero Trust Gateway Rule","description":"Create a new Zero Trust Gateway Rule.","operationId":"zero-trust-gateway-rules-create-zero-trust-gateway-rule","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/rules_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["name","action"],"properties":{"action":{"$ref":"#/components/schemas/rules_components-schemas-action-2"},"description":{"$ref":"#/components/schemas/rules_components-schemas-description-2"},"device_posture":{"$ref":"#/components/schemas/device_posture"},"enabled":{"$ref":"#/components/schemas/rules_components-schemas-enabled-3"},"filters":{"$ref":"#/components/schemas/schemas-filters"},"identity":{"$ref":"#/components/schemas/identity"},"name":{"$ref":"#/components/schemas/rules_components-schemas-name-2"},"precedence":{"$ref":"#/components/schemas/schemas-precedence"},"rule_settings":{"$ref":"#/components/schemas/rule-settings"},"traffic":{"$ref":"#/components/schemas/traffic"}}}}}},"responses":{"4xx":{"description":"Create Zero Trust Gateway Rule response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/rules_components-schemas-single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Create Zero Trust Gateway Rule response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/rules_components-schemas-single_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/accounts/{identifier}/gateway/rules/{uuid}":{"delete":{"tags":["Zero Trust Gateway Rules"],"summary":"Delete Zero Trust Gateway Rule","description":"Delete a Zero Trust Gateway Rule.","operationId":"zero-trust-gateway-rules-delete-zero-trust-gateway-rule","parameters":[{"name":"uuid","in":"path","required":true,"schema":{"$ref":"#/components/schemas/rules_components-schemas-uuid"}},{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/rules_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{"4xx":{"description":"Delete Zero Trust Gateway Rule response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/rules_components-schemas-empty_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Delete Zero Trust Gateway Rule response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/rules_components-schemas-empty_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"get":{"tags":["Zero Trust Gateway Rules"],"summary":"Zero Trust Gateway Rule Details","description":"Fetch a single Zero Trust Gateway Rule.","operationId":"zero-trust-gateway-rules-zero-trust-gateway-rule-details","parameters":[{"name":"uuid","in":"path","required":true,"schema":{"$ref":"#/components/schemas/rules_components-schemas-uuid"}},{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/rules_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Zero Trust Gateway Rule Details response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/rules_components-schemas-single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Zero Trust Gateway Rule Details response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/rules_components-schemas-single_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"put":{"tags":["Zero Trust Gateway Rules"],"summary":"Update Zero Trust Gateway Rule","description":"Update a configured Zero Trust Gateway Rule.","operationId":"zero-trust-gateway-rules-update-zero-trust-gateway-rule","parameters":[{"name":"uuid","in":"path","required":true,"schema":{"$ref":"#/components/schemas/rules_components-schemas-uuid"}},{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/rules_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["name","action"],"properties":{"action":{"$ref":"#/components/schemas/rules_components-schemas-action-2"},"description":{"$ref":"#/components/schemas/rules_components-schemas-description-2"},"device_posture":{"$ref":"#/components/schemas/device_posture"},"enabled":{"$ref":"#/components/schemas/rules_components-schemas-enabled-3"},"filters":{"$ref":"#/components/schemas/schemas-filters"},"identity":{"$ref":"#/components/schemas/identity"},"name":{"$ref":"#/components/schemas/rules_components-schemas-name-2"},"precedence":{"$ref":"#/components/schemas/schemas-precedence"},"rule_settings":{"$ref":"#/components/schemas/rule-settings"},"traffic":{"$ref":"#/components/schemas/traffic"}}}}}},"responses":{"4xx":{"description":"Update Zero Trust Gateway Rule response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/rules_components-schemas-single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Update Zero Trust Gateway Rule response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/rules_components-schemas-single_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/certificates":{"get":{"tags":["Origin CA"],"summary":"List Certificates","description":"List all existing Origin CA certificates for a given zone. Use your Origin CA Key as your User Service Key when calling this endpoint ([see above](#requests)).","operationId":"origin-ca-list-certificates","responses":{"4xx":{"description":"List Certificates response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/schemas-certificate_response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"List Certificates response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/schemas-certificate_response_collection"}}}}},"security":[{"user_service_key":[]},{"api_token":[]}]},"post":{"tags":["Origin CA"],"summary":"Create Certificate","description":"Create an Origin CA certificate. Use your Origin CA Key as your User Service Key when calling this endpoint ([see above](#requests)).","operationId":"origin-ca-create-certificate","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"csr":{"$ref":"#/components/schemas/csr"},"hostnames":{"$ref":"#/components/schemas/hostnames"},"request_type":{"$ref":"#/components/schemas/request_type"},"requested_validity":{"$ref":"#/components/schemas/requested_validity"}}}}}},"responses":{"4xx":{"description":"Create Certificate response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/schemas-certificate_response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Create Certificate response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/schemas-certificate_response_single"}}}}},"security":[{"user_service_key":[]},{"api_token":[]}]}},"/certificates/{identifier}":{"delete":{"tags":["Origin CA"],"summary":"Revoke Certificate","description":"Revoke an existing Origin CA certificate by its serial number. Use your Origin CA Key as your User Service Key when calling this endpoint ([see above](#requests)).","operationId":"origin-ca-revoke-certificate","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/certificates_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{"4xx":{"description":"Revoke Certificate response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/certificate_response_single_id"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Revoke Certificate response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/certificate_response_single_id"}}}}},"security":[{"user_service_key":[]},{"api_token":[]}]},"get":{"tags":["Origin CA"],"summary":"Get Certificate","description":"Get an existing Origin CA certificate by its serial number. Use your Origin CA Key as your User Service Key when calling this endpoint ([see above](#requests)).","operationId":"origin-ca-get-certificate","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/certificates_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Get Certificate response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/schemas-certificate_response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Get Certificate response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/schemas-certificate_response_single"}}}}},"security":[{"user_service_key":[]},{"api_token":[]}]}},"/ips":{"get":{"tags":["Cloudflare IPs"],"summary":"Cloudflare IP Details","description":"Get Cloudflare IPs.","operationId":"cloudflare-i-ps-cloudflare-ip-details","responses":{"4xx":{"description":"Cloudflare IP Details response failure","content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/ips"}}}]},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Cloudflare IP Details response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/ips"}}}]}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/memberships":{"get":{"tags":["User's Account Memberships"],"summary":"List Memberships","description":"List memberships of accounts the user can access.","operationId":"user'-s-account-memberships-list-memberships","responses":{"4xx":{"description":"List Memberships response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/collection_membership_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"List Memberships response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/collection_membership_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/memberships/{identifier}":{"delete":{"tags":["User's Account Memberships"],"summary":"Delete Membership","description":"Remove the associated member from an account.","operationId":"user'-s-account-memberships-delete-membership","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/membership_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{"4xx":{"description":"Delete Membership response failure","content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"type":"object","properties":{"result":{"properties":{"id":{"$ref":"#/components/schemas/membership_components-schemas-identifier"}}}}}]},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Delete Membership response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"type":"object","properties":{"result":{"properties":{"id":{"$ref":"#/components/schemas/membership_components-schemas-identifier"}}}}}]}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"get":{"tags":["User's Account Memberships"],"summary":"Membership Details","description":"Get a specific membership.","operationId":"user'-s-account-memberships-membership-details","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/membership_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Membership Details response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/single_membership_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Membership Details response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/single_membership_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"put":{"tags":["User's Account Memberships"],"summary":"Update Membership","description":"Accept or reject this account invitation.","operationId":"user'-s-account-memberships-update-membership","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/membership_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["status"],"properties":{"status":{"description":"Whether to accept or reject this account invitation.","enum":["accepted","rejected"],"example":"accepted"}}}}}},"responses":{"4xx":{"description":"Update Membership response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/single_membership_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Update Membership response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/single_membership_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/organizations/{identifier}":{"get":{"tags":["Organizations (Deprecated)"],"summary":"Organization Details","description":"Get information about a specific organization that you are a member of.","operationId":"organizations-(-deprecated)-organization-details","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Organization Details response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/single_organization_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Organization Details response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/single_organization_response"}}}}},"deprecated":true,"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"patch":{"tags":["Organizations (Deprecated)"],"summary":"Edit Organization","description":"Update an existing Organization.","operationId":"organizations-(-deprecated)-edit-organization","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"$ref":"#/components/schemas/schemas-name"}}}}}},"responses":{"4xx":{"description":"Edit Organization response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/single_organization_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Edit Organization response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/single_organization_response"}}}}},"deprecated":true,"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/organizations/{organization_identifier}/audit_logs":{"get":{"tags":["Audit Logs"],"summary":"Get organization audit logs","description":"Gets a list of audit logs for an organization. The list can be filtered by who made the change, which zone was the change made on, and the timeframe of the change.","operationId":"audit-logs-get-organization-audit-logs","parameters":[{"name":"organization_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Get organization audit logs response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/audit_logs_response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Get organization audit logs response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/audit_logs_response_collection"}}}}},"deprecated":true,"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/organizations/{organization_identifier}/invites":{"get":{"tags":["Organization Invites"],"summary":"List Invitations","description":"List all invitations associated with an organization.","operationId":"organization-invites-list-invitations","parameters":[{"name":"organization_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"List Invitations response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/collection_invite_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"List Invitations response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/collection_invite_response"}}}}},"deprecated":true,"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"post":{"tags":["Organization Invites"],"summary":"Create Invitation","description":"Invite a User to become a Member of an Organization.","operationId":"organization-invites-create-invitation","parameters":[{"name":"organization_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["invited_member_email","roles"],"properties":{"auto_accept":{"type":"boolean","description":"When present and set to true, allows for the invited user to be automatically accepted to the organization. No invitation is sent.","default":false,"example":true},"invited_member_email":{"$ref":"#/components/schemas/invited_member_email"},"roles":{"type":"array","description":"Array of Roles associated with the invited user.","example":[{"id":"5a7805061c76ada191ed06f989cc3dac"},{"id":"9a7806061c88ada191ed06f989cc3dac"}],"items":{"type":"object","required":["id"],"properties":{"description":{"$ref":"#/components/schemas/description"},"id":{"$ref":"#/components/schemas/role_components-schemas-identifier"},"name":{"$ref":"#/components/schemas/components-schemas-name"},"permissions":{"$ref":"#/components/schemas/schemas-permissions"}}}}}}}}},"responses":{"4xx":{"description":"Create Invitation response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/single_invite_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Create Invitation response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/single_invite_response"}}}}},"deprecated":true,"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/organizations/{organization_identifier}/invites/{identifier}":{"delete":{"tags":["Organization Invites"],"summary":"Cancel Invitation","description":"Cancel an existing invitation.","operationId":"organization-invites-cancel-invitation","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/invite_components-schemas-identifier"}},{"name":"organization_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{"4xx":{"description":"Cancel Invitation response failure","content":{"application/json":{"schema":{"allOf":[{"properties":{"id":{"$ref":"#/components/schemas/invite_components-schemas-identifier"}}},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Cancel Invitation response","content":{"application/json":{"schema":{"properties":{"id":{"$ref":"#/components/schemas/invite_components-schemas-identifier"}}}}}}},"deprecated":true,"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"get":{"tags":["Organization Invites"],"summary":"Invitation Details","description":"Get the details of an invitation.","operationId":"organization-invites-invitation-details","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/invite_components-schemas-identifier"}},{"name":"organization_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Invitation Details response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/single_invite_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Invitation Details response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/single_invite_response"}}}}},"deprecated":true,"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"patch":{"tags":["Organization Invites"],"summary":"Edit Invitation Roles","description":"Change the Roles of a Pending Invite.","operationId":"organization-invites-edit-invitation-roles","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/invite_components-schemas-identifier"}},{"name":"organization_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"roles":{"type":"array","description":"Array of Roles associated with the invited user.","items":{"$ref":"#/components/schemas/role_components-schemas-identifier"}}}}}}},"responses":{"4xx":{"description":"Edit Invitation Roles response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/single_invite_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Edit Invitation Roles response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/single_invite_response"}}}}},"deprecated":true,"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/organizations/{organization_identifier}/members":{"get":{"tags":["Organization Members"],"summary":"List Members","description":"List all members of a organization.","operationId":"organization-members-list-members","parameters":[{"name":"organization_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/organization_components-schemas-identifier"}}],"responses":{"4xx":{"description":"List Members response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/collection_member_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"List Members response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/collection_member_response"}}}}},"deprecated":true,"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/organizations/{organization_identifier}/members/{identifier}":{"delete":{"tags":["Organization Members"],"summary":"Remove Member","description":"Remove a member from an organization.","operationId":"organization-members-remove-member","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}},{"name":"organization_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/organization_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{"4xx":{"description":"Remove Member response failure","content":{"application/json":{"schema":{"allOf":[{"properties":{"id":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Remove Member response","content":{"application/json":{"schema":{"properties":{"id":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}}}}}},"deprecated":true,"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"get":{"tags":["Organization Members"],"summary":"Member Details","description":"Get information about a specific member of an organization.","operationId":"organization-members-member-details","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}},{"name":"organization_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/organization_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Member Details response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/single_member_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Member Details response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/single_member_response"}}}}},"deprecated":true,"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"patch":{"tags":["Organization Members"],"summary":"Edit Member Roles","description":"Change the Roles of an Organization's Member.","operationId":"organization-members-edit-member-roles","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}},{"name":"organization_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/organization_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"roles":{"type":"array","description":"Array of Roles associated with this Member.","items":{"$ref":"#/components/schemas/role_components-schemas-identifier"}}}}}}},"responses":{"4xx":{"description":"Edit Member Roles response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/single_member_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Edit Member Roles response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/single_member_response"}}}}},"deprecated":true,"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/organizations/{organization_identifier}/railguns":{"get":{"tags":["Organization Railgun"],"summary":"List Railguns","description":"List, search, sort and filter your Railguns.","operationId":"organization-railgun-list-railguns","parameters":[{"name":"organization_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"List Railguns response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/railgun_response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"List Railguns response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/railgun_response_collection"}}}}},"deprecated":true,"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"post":{"tags":["Organization Railgun"],"summary":"Create Railgun","operationId":"organization-railgun-create-railgun","parameters":[{"name":"organization_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["name"],"properties":{"name":{"$ref":"#/components/schemas/railgun_components-schemas-name"}}}}}},"responses":{"4xx":{"description":"Create Railgun response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/railgun_response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Create Railgun response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/railgun_response_single"}}}}},"deprecated":true,"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/organizations/{organization_identifier}/railguns/{identifier}":{"delete":{"tags":["Organization Railgun"],"summary":"Delete Railgun","description":"Disable and delete a Railgun. This will immediately disable the Railgun for any connected zones.","operationId":"organization-railgun-delete-railgun","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/railgun_components-schemas-identifier"}},{"name":"organization_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{"4xx":{"description":"Delete Railgun response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/railgun_response_single_id"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Delete Railgun response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/railgun_response_single_id"}}}}},"deprecated":true,"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"get":{"tags":["Organization Railgun"],"summary":"Railgun details","operationId":"organization-railgun-railgun-details","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/railgun_components-schemas-identifier"}},{"name":"organization_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Railgun details response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/railgun_response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Railgun details response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/railgun_response_single"}}}}},"deprecated":true,"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"patch":{"tags":["Organization Railgun"],"summary":"Enable or disable a Railgun","description":"Enable or disable a Railgun for all zones connected to it.","operationId":"organization-railgun-enable-or-disable-a-railgun","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/railgun_components-schemas-identifier"}},{"name":"organization_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["enabled"],"properties":{"enabled":{"$ref":"#/components/schemas/railgun_components-schemas-enabled"}}}}}},"responses":{"4xx":{"description":"Enable or disable a Railgun response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/railgun_response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Enable or disable a Railgun response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/railgun_response_single"}}}}},"deprecated":true,"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/organizations/{organization_identifier}/railguns/{identifier}/zones":{"get":{"tags":["Organization Railgun"],"summary":"Get Railgun zones","description":"Lists the zones that are currently using this Railgun.","operationId":"organization-railgun-get-railgun-zones","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/railgun_components-schemas-identifier"}},{"name":"organization_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Get Railgun zones response failure","content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/components-schemas-zone"}}}}]},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Get Railgun zones response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/components-schemas-zone"}}}}]}}}}},"deprecated":true,"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/organizations/{organization_identifier}/roles":{"get":{"tags":["Organization Roles"],"summary":"List Roles","description":"Get all available roles for an organization.","operationId":"organization-roles-list-roles","parameters":[{"name":"organization_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/organization_components-schemas-identifier"}}],"responses":{"4xx":{"description":"List Roles response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/collection_role_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"List Roles response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/collection_role_response"}}}}},"deprecated":true,"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/organizations/{organization_identifier}/roles/{identifier}":{"get":{"tags":["Organization Roles"],"summary":"Role Details","description":"Get information about a specific role for an organization.","operationId":"organization-roles-role-details","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/role_components-schemas-identifier"}},{"name":"organization_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/organization_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Role Details response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/single_role_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Role Details response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/single_role_response"}}}}},"deprecated":true,"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/radar/annotations/outages":{"get":{"tags":["Radar Annotations"],"summary":"Get outages annotations","operationId":"radar_get_AnnotationsOutages","parameters":[{"name":"limit","in":"query","description":"Limit the number of objects in the response.","schema":{"type":"integer","description":"Limit the number of objects in the response.","default":5,"example":5}},{"name":"offset","in":"query","description":"Number of objects to skip before grabbing results.","schema":{"type":"integer","description":"Number of objects to skip before grabbing results.","default":0,"example":0}},{"name":"dateRange","in":"query","description":"Shorthand date ranges for the last X days - use when you don't need specific start and end dates.","schema":{"type":"string","description":"Shorthand date ranges for the last X days - use when you don't need specific start and end dates.","enum":["1d","7d","14d","28d","1dControl","7dControl","14dControl","28dControl"],"example":"7d"}},{"name":"dateStart","in":"query","description":"Start of the date range (inclusive).","schema":{"type":"string","format":"date-time","example":"2022-09-15T00:00:00Z"}},{"name":"dateEnd","in":"query","description":"End of the date range (inclusive).","schema":{"type":"string","format":"date-time","example":"2022-09-15T00:00:00Z"}},{"name":"format","in":"query","description":"Format results are returned in.","schema":{"type":"string","description":"Format results are returned in.","enum":["json","csv"],"example":"json"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"object","properties":{"annotations":{"type":"array","items":{"type":"object","properties":{"asns":{"type":"array","items":{"type":"integer","example":189}},"dataSource":{"type":"string","example":"ALL"},"description":{"type":"string","example":"example"},"endDate":{"type":"string","example":"2022-09-08T10:00:28Z"},"eventType":{"type":"string","example":"OUTAGE"},"linkedUrl":{"type":"string","example":"http://example.com"},"locations":{"type":"array","items":{"type":"string","example":"MX"}},"outage":{"type":"object","properties":{"outageCause":{"type":"string","example":"CABLE_CUT"},"outageType":{"type":"string","example":"NATIONWIDE"}}},"scope":{"type":"string","example":"Colima, Michoacán, México"},"startDate":{"type":"string","example":"2022-09-06T10:00:28Z"}}}}}},"success":{"type":"boolean","example":true}}}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/radar/annotations/outages/locations":{"get":{"tags":["Radar Annotations"],"summary":"Get top outages annotations","operationId":"radar_get_AnnotationsOutagesTop","parameters":[{"name":"limit","in":"query","description":"Limit the number of objects in the response.","schema":{"type":"integer","description":"Limit the number of objects in the response.","default":5,"example":5}},{"name":"dateRange","in":"query","description":"Shorthand date ranges for the last X days - use when you don't need specific start and end dates.","schema":{"type":"string","description":"Shorthand date ranges for the last X days - use when you don't need specific start and end dates.","enum":["1d","7d","14d","28d","1dControl","7dControl","14dControl","28dControl"],"example":"7d"}},{"name":"dateStart","in":"query","description":"Start of the date range (inclusive).","schema":{"type":"string","format":"date-time","example":"2022-09-15T00:00:00Z"}},{"name":"dateEnd","in":"query","description":"End of the date range (inclusive).","schema":{"type":"string","format":"date-time","example":"2022-09-15T00:00:00Z"}},{"name":"format","in":"query","description":"Format results are returned in.","schema":{"type":"string","description":"Format results are returned in.","enum":["json","csv"],"example":"json"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"object","properties":{"annotations":{"type":"array","items":{"type":"object","properties":{"clientCountryAlpha2":{"type":"string","example":"PT"},"clientCountryName":{"type":"string","example":"Portugal"},"value":{"type":"string","example":"5"}}}}}},"success":{"type":"boolean","example":true}}}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/radar/attacks/layer3/summary":{"get":{"tags":["Radar Attacks"],"summary":"Get a summary of layer 3 attacks","description":"Percentage distribution of network protocols in layer 3/4 attacks.","operationId":"radar_get_AttacksLayer3Summary","parameters":[{"name":"name","in":"query","description":"Array of names that will be used to name the series in responses.","schema":{"type":"array","items":{"type":"string","description":"Array of names that will be used to name the series in responses.","example":"main_series"}}},{"name":"dateRange","in":"query","description":"For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","schema":{"type":"array","items":{"type":"string","description":"For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","enum":["1d","7d","14d","28d","1dControl","7dControl","14dControl","28dControl"]}}},{"name":"dateStart","in":"query","description":"Array of datetimes to filter the start of a series.","schema":{"type":"array","items":{"type":"string","format":"date-time","example":"2022-09-15T00:00:00Z"}}},{"name":"dateEnd","in":"query","description":"Array of datetimes to filter the end of a series.","schema":{"type":"array","items":{"type":"string","format":"date-time","example":"2022-09-15T00:00:00Z"}}},{"name":"asn","in":"query","description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `[-174, 3356]` excludes results from AS174, but includes results from AS3356.","schema":{"type":"array","items":{"type":"string","description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `[-174, 3356]` excludes results from AS174, but includes results from AS3356.","example":"15169"}}},{"name":"location","in":"query","description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `[-US, PT]` excludes results from the US, but includes results from PT.","schema":{"type":"array","items":{"type":"string","description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `[-US, PT]` excludes results from the US, but includes results from PT.","example":"US,CA"}}},{"name":"format","in":"query","description":"Format results are returned in.","schema":{"type":"string","description":"Format results are returned in.","enum":["json","csv"],"example":"json"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"object","properties":{"meta":{"type":"object","properties":{"confidenceInfo":{"type":"object","properties":{"annotations":{"type":"array","items":{"type":"object","properties":{"dataSource":{"type":"string","example":"ALL"},"description":{"type":"string","example":"Cable cut in Tonga"},"endTime":{"type":"string","format":"date-time","example":"2022-09-15T00:00:00Z"},"eventType":{"type":"string","example":"OUTAGE"},"startTime":{"type":"string","format":"date-time","example":"2022-09-15T00:00:00Z"}}}},"level":{"type":"integer"}}},"dateRange":{"type":"object","properties":{"endTime":{"type":"string","format":"date-time","description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z"},"startTime":{"type":"string","format":"date-time","description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z"}}}}},"summary_0":{"type":"object","properties":{"gre":{"type":"string","example":"0.9"},"icmp":{"type":"string","example":"0.1"},"tcp":{"type":"string","example":"60"},"udp":{"type":"string","example":"39"}}}}},"success":{"type":"boolean","example":true}}}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/radar/attacks/layer3/timeseries":{"get":{"tags":["Radar Attacks"],"summary":"Get layer 3 attacks time series","description":"Get layer 3/4 attacks change over time. Values are normalized using min-max by default, with the minimum set to 0. When asking for multiple time series, you can also get the percentual relative change of the 1st/main series, with respect to the 2nd/control series - for example, to get the relative change of this week from the previous week, the 1st series would have a date range of 7d, the 2nd, a date range of 7dControl, and the normalization would be set to PERCENTAGE_CHANGE.","operationId":"radar_get_AttacksLayer3Timeseries","parameters":[{"name":"aggInterval","in":"query","description":"Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals).","schema":{"type":"string","description":"Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals).","enum":["15m","1h","1d"],"example":"1h"}},{"name":"name","in":"query","description":"Array of names that will be used to name the series in responses.","schema":{"type":"array","items":{"type":"string","description":"Array of names that will be used to name the series in responses.","example":"main_series"}}},{"name":"dateRange","in":"query","description":"For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","schema":{"type":"array","items":{"type":"string","description":"For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","enum":["1d","7d","14d","28d","1dControl","7dControl","14dControl","28dControl"]}}},{"name":"dateStart","in":"query","description":"Array of datetimes to filter the start of a series.","schema":{"type":"array","items":{"type":"string","format":"date-time","example":"2022-09-15T00:00:00Z"}}},{"name":"dateEnd","in":"query","description":"Array of datetimes to filter the end of a series.","schema":{"type":"array","items":{"type":"string","format":"date-time","example":"2022-09-15T00:00:00Z"}}},{"name":"attack","in":"query","description":"Array of L3/4 attack types.","schema":{"type":"array","items":{"type":"string","description":"Array of L3/4 attack types.","enum":["udp","tcp","icmp","gre"]}}},{"name":"asn","in":"query","description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `[-174, 3356]` excludes results from AS174, but includes results from AS3356.","schema":{"type":"array","items":{"type":"string","description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `[-174, 3356]` excludes results from AS174, but includes results from AS3356.","example":"15169"}}},{"name":"location","in":"query","description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `[-US, PT]` excludes results from the US, but includes results from PT.","schema":{"type":"array","items":{"type":"string","description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `[-US, PT]` excludes results from the US, but includes results from PT.","example":"US,CA"}}},{"name":"normalization","in":"query","description":"Normalization method applied.","schema":{"type":"string","description":"Normalization method applied.","enum":["PERCENTAGE_CHANGE","MIN0_MAX"],"example":"MIN0_MAX"}},{"name":"format","in":"query","description":"Format results are returned in.","schema":{"type":"string","description":"Format results are returned in.","enum":["json","csv"],"example":"json"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"object","properties":{"meta":{"type":"object","properties":{"aggInterval":{"type":"string","example":"1h"},"confidenceInfo":{"type":"object","properties":{"endTime":{"type":"string","format":"date-time","description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z"},"startTime":{"type":"string","format":"date-time","description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z"}}},"dateRange":{"type":"object","properties":{"endTime":{"type":"string","format":"date-time","description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z"},"startTime":{"type":"string","format":"date-time","description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z"}}},"lastUpdated":{"type":"string","format":"date-time","example":"2022-09-15T00:00:00Z"}}},"series":{"type":"object","properties":{"timestamps":{"type":"array","items":{"type":"string","format":"date-time","example":"2022-09-15T00:00:00Z"}},"values":{"type":"array","items":{"type":"string","example":0.56}}}}}},"success":{"type":"boolean","example":true}}}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/radar/attacks/layer3/timeseries_groups":{"get":{"tags":["Radar Attacks"],"summary":"Get layer 3 attacks by network protocol, over time","description":"Get percentage of what type of network protocols are used in layer 3/4 attacks, over time.","operationId":"radar_get_AttacksLayer3TimeseriesGroups","parameters":[{"name":"aggInterval","in":"query","description":"Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals).","schema":{"type":"string","description":"Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals).","enum":["15m","1h","1d"],"example":"1h"}},{"name":"name","in":"query","description":"Array of names that will be used to name the series in responses.","schema":{"type":"array","items":{"type":"string","description":"Array of names that will be used to name the series in responses.","example":"main_series"}}},{"name":"dateRange","in":"query","description":"For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","schema":{"type":"array","items":{"type":"string","description":"For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","enum":["1d","7d","14d","28d","1dControl","7dControl","14dControl","28dControl"]}}},{"name":"dateStart","in":"query","description":"Array of datetimes to filter the start of a series.","schema":{"type":"array","items":{"type":"string","format":"date-time","example":"2022-09-15T00:00:00Z"}}},{"name":"dateEnd","in":"query","description":"Array of datetimes to filter the end of a series.","schema":{"type":"array","items":{"type":"string","format":"date-time","example":"2022-09-15T00:00:00Z"}}},{"name":"asn","in":"query","description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `[-174, 3356]` excludes results from AS174, but includes results from AS3356.","schema":{"type":"array","items":{"type":"string","description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `[-174, 3356]` excludes results from AS174, but includes results from AS3356.","example":"15169"}}},{"name":"location","in":"query","description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `[-US, PT]` excludes results from the US, but includes results from PT.","schema":{"type":"array","items":{"type":"string","description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `[-US, PT]` excludes results from the US, but includes results from PT.","example":"US,CA"}}},{"name":"format","in":"query","description":"Format results are returned in.","schema":{"type":"string","description":"Format results are returned in.","enum":["json","csv"],"example":"json"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"object","properties":{"meta":{"type":"object","properties":{"aggInterval":{"type":"string","example":"1h"},"confidenceInfo":{"type":"object","properties":{"annotations":{"type":"array","items":{"type":"object","properties":{"dataSource":{"type":"string","example":"ALL"},"description":{"type":"string","example":"Cable cut in Tonga"},"endTime":{"type":"string","format":"date-time","example":"2022-09-15T00:00:00Z"},"eventType":{"type":"string","example":"OUTAGE"},"startTime":{"type":"string","format":"date-time","example":"2022-09-15T00:00:00Z"}}}},"level":{"type":"integer"}}},"dateRange":{"type":"object","properties":{"endTime":{"type":"string","format":"date-time","description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z"},"startTime":{"type":"string","format":"date-time","description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z"}}},"lastUpdated":{"type":"string","format":"date-time","example":"2022-09-15T00:00:00Z"}}},"serie_0":{"type":"object","properties":{"gre":{"type":"array","items":{"type":"string","example":"0.9"}},"icmp":{"type":"array","items":{"type":"string","example":"0.1"}},"tcp":{"type":"array","items":{"type":"string","example":"70"}},"timeseries":{"type":"array","items":{"type":"string"}},"udp":{"type":"array","items":{"type":"string","example":"29"}}}}}},"success":{"type":"boolean","example":true}}}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/radar/attacks/layer7/summary":{"get":{"tags":["Radar Attacks"],"summary":"Get a summary of layer 7 attacks","description":"Percentage distribution of mitigation techniques in layer 7 attacks.","operationId":"radar_get_AttacksLayer7Summary","parameters":[{"name":"name","in":"query","description":"Array of names that will be used to name the series in responses.","schema":{"type":"array","items":{"type":"string","description":"Array of names that will be used to name the series in responses.","example":"main_series"}}},{"name":"dateRange","in":"query","description":"For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","schema":{"type":"array","items":{"type":"string","description":"For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","enum":["1d","7d","14d","28d","1dControl","7dControl","14dControl","28dControl"]}}},{"name":"dateStart","in":"query","description":"Array of datetimes to filter the start of a series.","schema":{"type":"array","items":{"type":"string","format":"date-time","example":"2022-09-15T00:00:00Z"}}},{"name":"dateEnd","in":"query","description":"Array of datetimes to filter the end of a series.","schema":{"type":"array","items":{"type":"string","format":"date-time","example":"2022-09-15T00:00:00Z"}}},{"name":"asn","in":"query","description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `[-174, 3356]` excludes results from AS174, but includes results from AS3356.","schema":{"type":"array","items":{"type":"string","description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `[-174, 3356]` excludes results from AS174, but includes results from AS3356.","example":"15169"}}},{"name":"location","in":"query","description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `[-US, PT]` excludes results from the US, but includes results from PT.","schema":{"type":"array","items":{"type":"string","description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `[-US, PT]` excludes results from the US, but includes results from PT.","example":"US,CA"}}},{"name":"format","in":"query","description":"Format results are returned in.","schema":{"type":"string","description":"Format results are returned in.","enum":["json","csv"],"example":"json"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"object","properties":{"meta":{"type":"object","properties":{"confidenceInfo":{"type":"object","properties":{"annotations":{"type":"array","items":{"type":"object","properties":{"dataSource":{"type":"string","example":"ALL"},"description":{"type":"string","example":"Cable cut in Tonga"},"endTime":{"type":"string","format":"date-time","example":"2022-09-15T00:00:00Z"},"eventType":{"type":"string","example":"OUTAGE"},"startTime":{"type":"string","format":"date-time","example":"2022-09-15T00:00:00Z"}}}},"level":{"type":"integer"}}},"dateRange":{"type":"object","properties":{"endTime":{"type":"string","format":"date-time","description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z"},"startTime":{"type":"string","format":"date-time","description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z"}}}}},"summary_0":{"type":"object","properties":{"gre":{"type":"string","example":"0.1"},"icmp":{"type":"string","example":"0.9"},"tcp":{"type":"string","example":"65"},"udp":{"type":"string","example":"34"}}}}},"success":{"type":"boolean","example":true}}}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/radar/attacks/layer7/timeseries":{"get":{"tags":["Radar Attacks"],"summary":"Get attacks layer 7 time series","description":"Get layer 7 attacks change over time. Values are normalized using min-max by default, with the minimum set to 0. When asking for multiple time series, you can also get the percentage relative change of the first/main series, with respect to the second/control series - for example, to get the relative change of this week from the previous week, the first series would have a date range of `7d`, the second, a date range of `7dControl`, and the normalization would be set to `PERCENTAGE_CHANGE`.","operationId":"radar_get_AttacksLayer7Timeseries","parameters":[{"name":"aggInterval","in":"query","description":"Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals).","schema":{"type":"string","description":"Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals).","enum":["15m","1h","1d"],"example":"1h"}},{"name":"name","in":"query","description":"Array of names that will be used to name the series in responses.","schema":{"type":"array","items":{"type":"string","description":"Array of names that will be used to name the series in responses.","example":"main_series"}}},{"name":"dateRange","in":"query","description":"For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","schema":{"type":"array","items":{"type":"string","description":"For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","enum":["1d","7d","14d","28d","1dControl","7dControl","14dControl","28dControl"]}}},{"name":"dateStart","in":"query","description":"Array of datetimes to filter the start of a series.","schema":{"type":"array","items":{"type":"string","format":"date-time","example":"2022-09-15T00:00:00Z"}}},{"name":"dateEnd","in":"query","description":"Array of datetimes to filter the end of a series.","schema":{"type":"array","items":{"type":"string","format":"date-time","example":"2022-09-15T00:00:00Z"}}},{"name":"attack","in":"query","description":"Array of L7 attack types.","schema":{"type":"array","items":{"type":"string","description":"Array of L7 attack types.","enum":["ddos","waf","bot_management","access_rules","ip_reputation","api_shield","data_loss_prevention"]}}},{"name":"asn","in":"query","description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `[-174, 3356]` excludes results from AS174, but includes results from AS3356.","schema":{"type":"array","items":{"type":"string","description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `[-174, 3356]` excludes results from AS174, but includes results from AS3356.","example":"15169"}}},{"name":"location","in":"query","description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `[-US, PT]` excludes results from the US, but includes results from PT.","schema":{"type":"array","items":{"type":"string","description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `[-US, PT]` excludes results from the US, but includes results from PT.","example":"US,CA"}}},{"name":"normalization","in":"query","description":"Normalization method applied.","schema":{"type":"string","description":"Normalization method applied.","enum":["PERCENTAGE_CHANGE","MIN0_MAX"],"example":"MIN0_MAX"}},{"name":"format","in":"query","description":"Format results are returned in.","schema":{"type":"string","description":"Format results are returned in.","enum":["json","csv"],"example":"json"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"object","properties":{"meta":{"type":"object","properties":{"aggInterval":{"type":"string","example":"1h"},"confidenceInfo":{"type":"object","properties":{"annotations":{"type":"array","items":{"type":"object","properties":{"dataSource":{"type":"string","example":"ALL"},"description":{"type":"string","example":"Cable cut in Tonga"},"endTime":{"type":"string","format":"date-time","example":"2022-09-15T00:00:00Z"},"eventType":{"type":"string","example":"OUTAGE"},"startTime":{"type":"string","format":"date-time","example":"2022-09-15T00:00:00Z"}}}},"level":{"type":"integer"}}},"dateRange":{"type":"object","properties":{"endTime":{"type":"string","format":"date-time","description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z"},"startTime":{"type":"string","format":"date-time","description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z"}}},"lastUpdated":{"type":"string","format":"date-time","example":"2022-09-15T00:00:00Z"}}},"series":{"type":"object","properties":{"timestamps":{"type":"array","items":{"type":"string","format":"date-time","example":"2022-09-15T00:00:00Z"}},"values":{"type":"array","items":{"type":"string","example":0.56}}}}}},"success":{"type":"boolean","example":true}}}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/radar/attacks/layer7/timeseries_groups":{"get":{"tags":["Radar Attacks"],"summary":"Get layer 7 attacks by mitigation technique, over time","description":"Get percentage of what type of mitigation techniques are used to block layer 7 attacks, over time.","operationId":"radar_get_AttacksLayer7TimeseriesGroups","parameters":[{"name":"aggInterval","in":"query","description":"Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals).","schema":{"type":"string","description":"Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals).","enum":["15m","1h","1d"],"example":"1h"}},{"name":"name","in":"query","description":"Array of names that will be used to name the series in responses.","schema":{"type":"array","items":{"type":"string","description":"Array of names that will be used to name the series in responses.","example":"main_series"}}},{"name":"dateRange","in":"query","description":"For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","schema":{"type":"array","items":{"type":"string","description":"For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","enum":["1d","7d","14d","28d","1dControl","7dControl","14dControl","28dControl"]}}},{"name":"dateStart","in":"query","description":"Array of datetimes to filter the start of a series.","schema":{"type":"array","items":{"type":"string","format":"date-time","example":"2022-09-15T00:00:00Z"}}},{"name":"dateEnd","in":"query","description":"Array of datetimes to filter the end of a series.","schema":{"type":"array","items":{"type":"string","format":"date-time","example":"2022-09-15T00:00:00Z"}}},{"name":"asn","in":"query","description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `[-174, 3356]` excludes results from AS174, but includes results from AS3356.","schema":{"type":"array","items":{"type":"string","description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `[-174, 3356]` excludes results from AS174, but includes results from AS3356.","example":"15169"}}},{"name":"location","in":"query","description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `[-US, PT]` excludes results from the US, but includes results from PT.","schema":{"type":"array","items":{"type":"string","description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `[-US, PT]` excludes results from the US, but includes results from PT.","example":"US,CA"}}},{"name":"format","in":"query","description":"Format results are returned in.","schema":{"type":"string","description":"Format results are returned in.","enum":["json","csv"],"example":"json"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"object","properties":{"meta":{"type":"object","properties":{"aggInterval":{"type":"string","example":"1h"},"confidenceInfo":{"type":"object","properties":{"annotations":{"type":"array","items":{"type":"object","properties":{"dataSource":{"type":"string","example":"ALL"},"description":{"type":"string","example":"Cable cut in Tonga"},"endTime":{"type":"string","format":"date-time","example":"2022-09-15T00:00:00Z"},"eventType":{"type":"string","example":"OUTAGE"},"startTime":{"type":"string","format":"date-time","example":"2022-09-15T00:00:00Z"}}}},"level":{"type":"integer"}}},"dateRange":{"type":"object","properties":{"endTime":{"type":"string","format":"date-time","description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z"},"startTime":{"type":"string","format":"date-time","description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z"}}},"lastUpdated":{"type":"string","format":"date-time","example":"2022-09-15T00:00:00Z"}}},"serie_0":{"type":"object","properties":{"gre":{"type":"array","items":{"type":"string","example":"5"}},"icmp":{"type":"array","items":{"type":"string","example":"5"}},"tcp":{"type":"array","items":{"type":"string","example":"60"}},"timeseries":{"type":"array","items":{"type":"string","format":"date-time","example":"2022-09-15T00:00:00Z"}},"udp":{"type":"array","items":{"type":"string","example":"30"}}}}}},"success":{"type":"boolean","example":true}}}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/radar/attacks/layer7/top/ases/origin":{"get":{"tags":["Radar Attacks"],"summary":"Get layer 7 top origin ASes","description":"Get the top origin ASes by layer 7 attacks. Values are a percentage out of the total layer 7 attacks. The origin location is determined by the client IP.","operationId":"radar_get_AttacksLayer7TopOriginASes","parameters":[{"name":"limit","in":"query","description":"Limit the number of objects in the response.","schema":{"type":"integer","description":"Limit the number of objects in the response.","default":5,"example":5}},{"name":"name","in":"query","description":"Array of names that will be used to name the series in responses.","schema":{"type":"array","items":{"type":"string","description":"Array of names that will be used to name the series in responses.","example":"main_series"}}},{"name":"dateRange","in":"query","description":"For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","schema":{"type":"array","items":{"type":"string","description":"For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","enum":["1d","7d","14d","28d","1dControl","7dControl","14dControl","28dControl"]}}},{"name":"dateStart","in":"query","description":"Array of datetimes to filter the start of a series.","schema":{"type":"array","items":{"type":"string","format":"date-time","example":"2022-09-15T00:00:00Z"}}},{"name":"dateEnd","in":"query","description":"Array of datetimes to filter the end of a series.","schema":{"type":"array","items":{"type":"string","format":"date-time","example":"2022-09-15T00:00:00Z"}}},{"name":"location","in":"query","description":"Array of locations (alpha-2 country codes).","schema":{"type":"array","items":{"type":"string","description":"Array of locations (alpha-2 country codes).","example":"US"}}},{"name":"format","in":"query","description":"Format results are returned in.","schema":{"type":"string","description":"Format results are returned in.","enum":["json","csv"],"example":"json"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"object","properties":{"top_0":{"type":"array","items":{"type":"object","properties":{"originAsn":{"type":"number","example":16509},"originAsnName":{"type":"string","example":"AMAZON-02"},"rank":{"type":"string","example":"1"},"value":{"type":"string","example":"0.73996"}}}}}},"success":{"type":"boolean","example":true}}}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/radar/attacks/layer7/top/attacks":{"get":{"tags":["Radar Attacks"],"summary":"Get layer 7 top attack pairs (origin and target locations)","description":"Get the top attacks from origin to target location. Values are a percentage out of the total layer 7 attacks (with billing country). The attack magnitude can be defined by the number of mitigated requests or by the number of zones affected. You can optionally limit the number of attacks per origin/target location (useful if all the top attacks are from or to the same location).","operationId":"radar_get_AttacksLayer7TopAttacks","parameters":[{"name":"limit","in":"query","description":"Limit the number of objects in the response.","schema":{"type":"integer","description":"Limit the number of objects in the response.","default":5,"example":5}},{"name":"name","in":"query","description":"Array of names that will be used to name the series in responses.","schema":{"type":"array","items":{"type":"string","description":"Array of names that will be used to name the series in responses.","example":"main_series"}}},{"name":"dateRange","in":"query","description":"For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","schema":{"type":"array","items":{"type":"string","description":"For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","enum":["1d","7d","14d","28d","1dControl","7dControl","14dControl","28dControl"]}}},{"name":"dateStart","in":"query","description":"Array of datetimes to filter the start of a series.","schema":{"type":"array","items":{"type":"string","format":"date-time","example":"2022-09-15T00:00:00Z"}}},{"name":"dateEnd","in":"query","description":"Array of datetimes to filter the end of a series.","schema":{"type":"array","items":{"type":"string","format":"date-time","example":"2022-09-15T00:00:00Z"}}},{"name":"location","in":"query","description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `[-US, PT]` excludes results from the US, but includes results from PT.","schema":{"type":"array","items":{"type":"string","description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `[-US, PT]` excludes results from the US, but includes results from PT.","example":"US,CA"}}},{"name":"magnitude","in":"query","description":"Attack magnitude can be defined by total requests mitigated or by total zones attacked.","schema":{"type":"string","description":"Attack magnitude can be defined by total requests mitigated or by total zones attacked.","enum":["AFFECTED_ZONES","MITIGATED_REQUESTS"],"example":"mitigated_requests"}},{"name":"limitDirection","in":"query","description":"Array of attack origin/target location attack limits. Together with `limitPerLocation`, limits how many objects will be fetched per origin/target location.","schema":{"type":"array","items":{"type":"string","description":"Array of attack origin/target location attack limits. Together with `limitPerLocation`, limits how many objects will be fetched per origin/target location.","enum":["ORIGIN","TARGET"],"example":"origin"}}},{"name":"limitPerLocation","in":"query","description":"Limit the number of attacks per origin/target (see `limitDirection` parameter) location.","schema":{"type":"array","items":{"type":"integer","description":"Limit the number of attacks per origin/target (see `limitDirection` parameter) location.","default":10,"example":10}}},{"name":"format","in":"query","description":"Format results are returned in.","schema":{"type":"string","description":"Format results are returned in.","enum":["json","csv"],"example":"json"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"object","properties":{"top_0":{"type":"array","items":{"type":"object","properties":{"originCountryAlpha2":{"type":"string","example":"US"},"originCountryName":{"type":"string","example":"United States"},"rank":{"type":"string","example":"1"},"targetCountryAlpha2":{"type":"string","example":"PT"},"targetCountryName":{"type":"string","example":"Portugal"},"value":{"type":"string","example":"0.73996"}}}}}},"success":{"type":"boolean","example":true}}}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/radar/attacks/layer7/top/locations/origin":{"get":{"tags":["Radar Attacks"],"summary":"Get layer 7 top origin locations","description":"Get the top origin locations of and by layer 7 attacks. Values are a percentage out of the total layer 7 attacks. The origin location is determined by the client IP.","operationId":"radar_get_AttacksLayer7TopOriginLocations","parameters":[{"name":"limit","in":"query","description":"Limit the number of objects in the response.","schema":{"type":"integer","description":"Limit the number of objects in the response.","default":5,"example":5}},{"name":"name","in":"query","description":"Array of names that will be used to name the series in responses.","schema":{"type":"array","items":{"type":"string","description":"Array of names that will be used to name the series in responses.","example":"main_series"}}},{"name":"dateRange","in":"query","description":"For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","schema":{"type":"array","items":{"type":"string","description":"For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","enum":["1d","7d","14d","28d","1dControl","7dControl","14dControl","28dControl"]}}},{"name":"dateStart","in":"query","description":"Array of datetimes to filter the start of a series.","schema":{"type":"array","items":{"type":"string","format":"date-time","example":"2022-09-15T00:00:00Z"}}},{"name":"dateEnd","in":"query","description":"Array of datetimes to filter the end of a series.","schema":{"type":"array","items":{"type":"string","format":"date-time","example":"2022-09-15T00:00:00Z"}}},{"name":"asn","in":"query","description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `[-174, 3356]` excludes results from AS174, but includes results from AS3356.","schema":{"type":"array","items":{"type":"string","description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `[-174, 3356]` excludes results from AS174, but includes results from AS3356.","example":"15169"}}},{"name":"format","in":"query","description":"Format results are returned in.","schema":{"type":"string","description":"Format results are returned in.","enum":["json","csv"],"example":"json"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"object","properties":{"top_0":{"type":"array","items":{"type":"object","properties":{"originCountryAlpha2":{"type":"string","example":"US"},"originCountryName":{"type":"string","example":"United States"},"rank":{"type":"string","example":"1"},"value":{"type":"string","example":"0.73996"}}}}}},"success":{"type":"boolean","example":true}}}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/radar/attacks/layer7/top/locations/target":{"get":{"tags":["Radar Attacks"],"summary":"Get layer 7 top target locations","description":"Get the top target locations of and by layer 7 attacks. Values are a percentage out of the total layer 7 attacks. The target location is determined by the attacked zone's billing country, when available.","operationId":"radar_get_AttacksLayer7TopTargetLocations","parameters":[{"name":"limit","in":"query","description":"Limit the number of objects in the response.","schema":{"type":"integer","description":"Limit the number of objects in the response.","default":5,"example":5}},{"name":"name","in":"query","description":"Array of names that will be used to name the series in responses.","schema":{"type":"array","items":{"type":"string","description":"Array of names that will be used to name the series in responses.","example":"main_series"}}},{"name":"dateRange","in":"query","description":"For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","schema":{"type":"array","items":{"type":"string","description":"For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","enum":["1d","7d","14d","28d","1dControl","7dControl","14dControl","28dControl"]}}},{"name":"dateStart","in":"query","description":"Array of datetimes to filter the start of a series.","schema":{"type":"array","items":{"type":"string","format":"date-time","example":"2022-09-15T00:00:00Z"}}},{"name":"dateEnd","in":"query","description":"Array of datetimes to filter the end of a series.","schema":{"type":"array","items":{"type":"string","format":"date-time","example":"2022-09-15T00:00:00Z"}}},{"name":"format","in":"query","description":"Format results are returned in.","schema":{"type":"string","description":"Format results are returned in.","enum":["json","csv"],"example":"json"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"top_0":{"type":"array","items":{"type":"object","properties":{"rank":{"type":"string","example":"1"},"targetCountryAlpha2":{"type":"string","example":"US"},"targetCountryName":{"type":"string","example":"United States"},"value":{"type":"string","example":"0.73996"}}}}}}}}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/radar/bgp/leaks/events":{"get":{"tags":["Radar BGP"],"summary":"Get BGP route leak events","description":"Get the BGP route leak events.","operationId":"radar_get_BGPRouteLeakEvents","parameters":[{"name":"page","in":"query","description":"Current page number, starting from 1","schema":{"type":"integer","description":"Current page number, starting from 1","default":1}},{"name":"per_page","in":"query","description":"Number of entries per page","schema":{"type":"integer","description":"Number of entries per page","default":50}},{"name":"leakAsn","in":"query","description":"The leaking AS of a route leak event","schema":{"type":"integer","description":"The leaking AS of a route leak event"}},{"name":"involvedAsn","in":"query","description":"ASN that is causing or affected by a route leak event","schema":{"type":"integer","description":"ASN that is causing or affected by a route leak event"}},{"name":"dateRange","in":"query","description":"For example, use `7d` to get route leak events happened within this week.","schema":{"type":"string","description":"For example, use `7d` to get route leak events happened within this week.","enum":["1d","7d","14d","28d"],"default":"1d"}},{"name":"format","in":"query","description":"Format results are returned in.","schema":{"type":"string","description":"Format results are returned in.","enum":["json","csv"],"example":"json"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"object","properties":{"data":{"type":"object","properties":{"asn_info":{"type":"array","items":{"type":"object","properties":{"asn":{"type":"integer"},"org_name":{"type":"string"}}}},"events":{"type":"array","items":{"type":"object","properties":{"detected_ts":{"type":"string"},"finished":{"type":"boolean"},"id":{"type":"integer"},"leak_asn":{"type":"integer"},"leak_count":{"type":"integer"},"leak_seg":{"type":"array","items":{"type":"integer"}},"leak_type":{"type":"integer"},"max_ts":{"type":"string"},"min_ts":{"type":"string"},"origin_count":{"type":"integer"},"peer_count":{"type":"integer"},"prefix_count":{"type":"integer"}}}}}}}},"result_info":{"type":"object","properties":{"count":{"type":"integer"},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_count":{"type":"integer"}}},"success":{"type":"boolean","example":true}}}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/radar/bgp/timeseries":{"get":{"tags":["Radar BGP"],"summary":"Get BGP time series","description":"Gets BGP updates change over time. Raw values are returned. When requesting updates of an autonomous system (AS), only BGP updates of type announcement are returned.","operationId":"radar_get_BgpTimeseries","parameters":[{"name":"aggInterval","in":"query","description":"Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals).","schema":{"type":"string","description":"Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals).","enum":["15m","1h","1d"],"example":"1h"}},{"name":"name","in":"query","description":"Array of names that will be used to name the series in responses.","schema":{"type":"array","items":{"type":"string","description":"Array of names that will be used to name the series in responses.","example":"main_series"}}},{"name":"dateRange","in":"query","description":"For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","schema":{"type":"array","items":{"type":"string","description":"For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","enum":["1d","7d","14d","28d","1dControl","7dControl","14dControl","28dControl"]}}},{"name":"dateStart","in":"query","description":"Array of datetimes to filter the start of a series.","schema":{"type":"array","items":{"type":"string","format":"date-time","example":"2022-09-15T00:00:00Z"}}},{"name":"dateEnd","in":"query","description":"Array of datetimes to filter the end of a series.","schema":{"type":"array","items":{"type":"string","format":"date-time","example":"2022-09-15T00:00:00Z"}}},{"name":"prefix","in":"query","description":"Network prefix, IPv4 or IPv6.","schema":{"type":"string","description":"Network prefix, IPv4 or IPv6.","example":"1.1.1.0/24"}},{"name":"updateType","in":"query","description":"Array of BGP update types.","schema":{"type":"array","items":{"type":"string","description":"Array of BGP update types.","enum":["ANNOUNCEMENT","WITHDRAWAL"],"example":"ANNOUNCEMENT"}}},{"name":"asn","in":"query","description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `[-174, 3356]` excludes results from AS174, but includes results from AS3356.","schema":{"type":"array","items":{"type":"string","description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `[-174, 3356]` excludes results from AS174, but includes results from AS3356.","example":"15169"}}},{"name":"format","in":"query","description":"Format results are returned in.","schema":{"type":"string","description":"Format results are returned in.","enum":["json","csv"],"example":"json"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"object","properties":{"meta":{"type":"object","properties":{"aggInterval":{"type":"string","example":"1h"},"confidenceInfo":{"type":"object","properties":{"annotations":{"type":"array","items":{"type":"object","properties":{"dataSource":{"type":"string","example":"ALL"},"description":{"type":"string","example":"Cable cut in Tonga"},"endTime":{"type":"string","format":"date-time","example":"2022-09-15T00:00:00Z"},"eventType":{"type":"string","example":"OUTAGE"},"startTime":{"type":"string","format":"date-time","example":"2022-09-15T00:00:00Z"}}}},"level":{"type":"integer"}}},"dateRange":{"type":"object","properties":{"endTime":{"type":"string","format":"date-time","description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z"},"startTime":{"type":"string","format":"date-time","description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z"}}},"lastUpdated":{"type":"string","format":"date-time","example":"2022-09-15T00:00:00Z"}}},"series":{"type":"object","properties":{"timestamps":{"type":"array","items":{"type":"string","format":"date-time","example":"2022-09-15T00:00:00Z"}},"values":{"type":"array","items":{"type":"string","example":0.56}}}}}},"success":{"type":"boolean","example":true}}}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/radar/bgp/top/ases":{"get":{"tags":["Radar BGP"],"summary":"Get top autonomous systems","description":"Get the top autonomous systems (AS) by BGP updates (announcements only). Values are a percentage out of the total updates.","operationId":"radar_get_BGPTopASes","parameters":[{"name":"limit","in":"query","description":"Limit the number of objects in the response.","schema":{"type":"integer","description":"Limit the number of objects in the response.","default":5,"example":5}},{"name":"name","in":"query","description":"Array of names that will be used to name the series in responses.","schema":{"type":"array","items":{"type":"string","description":"Array of names that will be used to name the series in responses.","example":"main_series"}}},{"name":"dateRange","in":"query","description":"For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","schema":{"type":"array","items":{"type":"string","description":"For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","enum":["1d","7d","14d","28d","1dControl","7dControl","14dControl","28dControl"]}}},{"name":"dateStart","in":"query","description":"Array of datetimes to filter the start of a series.","schema":{"type":"array","items":{"type":"string","format":"date-time","example":"2022-09-15T00:00:00Z"}}},{"name":"dateEnd","in":"query","description":"Array of datetimes to filter the end of a series.","schema":{"type":"array","items":{"type":"string","format":"date-time","example":"2022-09-15T00:00:00Z"}}},{"name":"asn","in":"query","description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `[-174, 3356]` excludes results from AS174, but includes results from AS3356.","schema":{"type":"array","items":{"type":"string","description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `[-174, 3356]` excludes results from AS174, but includes results from AS3356.","example":"15169"}}},{"name":"prefix","in":"query","description":"Array of BGP network prefixes.","schema":{"type":"array","items":{"type":"string","description":"Array of BGP network prefixes.","example":"1.1.1.0/24"}}},{"name":"updateType","in":"query","description":"Array of BGP update types.","schema":{"type":"array","items":{"type":"string","description":"Array of BGP update types.","enum":["ANNOUNCEMENT","WITHDRAWAL"],"example":"ANNOUNCEMENT"}}},{"name":"format","in":"query","description":"Format results are returned in.","schema":{"type":"string","description":"Format results are returned in.","enum":["json","csv"],"example":"json"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"object","properties":{"meta":{"type":"object","properties":{"dateRange":{"type":"object","properties":{"endTime":{"type":"string","format":"date-time","description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z"},"startTime":{"type":"string","format":"date-time","description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z"}}}}},"top_0":{"type":"array","items":{"type":"object","properties":{"ASName":{"type":"string","example":"Apple-Engineering"},"asn":{"type":"string","example":"714"},"value":{"type":"string","description":"Percentage of updates by this AS out of the total updates by all autonomous systems.","example":"0.73996"}}}}}},"success":{"type":"boolean","example":true}}}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/radar/bgp/top/prefixes":{"get":{"tags":["Radar BGP"],"summary":"Get top prefixes","description":"Get the top network prefixes by BGP updates. Values are a percentage out of the total BGP updates.","operationId":"radar_get_BGPTopPrefixes","parameters":[{"name":"limit","in":"query","description":"Limit the number of objects in the response.","schema":{"type":"integer","description":"Limit the number of objects in the response.","default":5,"example":5}},{"name":"name","in":"query","description":"Array of names that will be used to name the series in responses.","schema":{"type":"array","items":{"type":"string","description":"Array of names that will be used to name the series in responses.","example":"main_series"}}},{"name":"dateRange","in":"query","description":"For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","schema":{"type":"array","items":{"type":"string","description":"For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","enum":["1d","7d","14d","28d","1dControl","7dControl","14dControl","28dControl"]}}},{"name":"dateStart","in":"query","description":"Array of datetimes to filter the start of a series.","schema":{"type":"array","items":{"type":"string","format":"date-time","example":"2022-09-15T00:00:00Z"}}},{"name":"dateEnd","in":"query","description":"Array of datetimes to filter the end of a series.","schema":{"type":"array","items":{"type":"string","format":"date-time","example":"2022-09-15T00:00:00Z"}}},{"name":"asn","in":"query","description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `[-174, 3356]` excludes results from AS174, but includes results from AS3356.","schema":{"type":"array","items":{"type":"string","description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `[-174, 3356]` excludes results from AS174, but includes results from AS3356.","example":"15169"}}},{"name":"updateType","in":"query","description":"Array of BGP update types.","schema":{"type":"array","items":{"type":"string","description":"Array of BGP update types.","enum":["ANNOUNCEMENT","WITHDRAWAL"],"example":"ANNOUNCEMENT"}}},{"name":"format","in":"query","description":"Format results are returned in.","schema":{"type":"string","description":"Format results are returned in.","enum":["json","csv"],"example":"json"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"object","properties":{"meta":{"type":"object","properties":{"dateRange":{"type":"object","properties":{"endTime":{"type":"string","format":"date-time","description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z"},"startTime":{"type":"string","format":"date-time","description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z"}}}}},"top_0":{"type":"array","items":{"type":"object","properties":{"prefix":{"type":"string","example":"2804:77cc:8000::/33"},"value":{"type":"string","example":"0.73996"}}}}}},"success":{"type":"boolean","example":true}}}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/radar/datasets":{"get":{"tags":["Radar Datasets"],"summary":"Get Datasets","description":"Get a list of datasets.","operationId":"radar_get_DatasetList","parameters":[{"name":"limit","in":"query","description":"Limit the number of objects in the response.","schema":{"type":"integer","description":"Limit the number of objects in the response.","default":5,"example":5}},{"name":"offset","in":"query","description":"Number of objects to skip before grabbing results.","schema":{"type":"integer","description":"Number of objects to skip before grabbing results.","default":0,"example":0}},{"name":"datasetType","in":"query","description":"Dataset type.","schema":{"type":"string","description":"Dataset type.","enum":["RANKING_BUCKET","REPORT"],"default":"RANKING_BUCKET","example":"RANKING_BUCKET"}},{"name":"format","in":"query","description":"Format results are returned in.","schema":{"type":"string","description":"Format results are returned in.","enum":["json","csv"],"example":"json"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"object","properties":{"datasets":{"type":"array","items":{"type":"object","properties":{"description":{"type":"string","example":"This dataset contains a list of the op 20000 domains globally"},"id":{"type":"integer","example":3},"meta":{"type":"object"},"tags":{"type":"array","items":{"type":"string","example":"global"}},"title":{"type":"string","example":"Top bucket 20000 domains"},"type":{"type":"string","example":"RANKING_BUCKET"}}}}}},"success":{"type":"boolean","example":true}}}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/radar/datasets/{alias}":{"get":{"tags":["Radar Datasets"],"summary":"Get Dataset csv Stream","description":"Get the content of a dataset.","operationId":"radar_get_DatasetStream","parameters":[{"name":"alias","in":"path","description":"Dataset alias or id","required":true,"schema":{"type":"string","description":"Dataset alias or id","example":"year-in-review"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/radar/datasets/download":{"post":{"tags":["Radar Datasets"],"summary":"Get Dataset download url","description":"Get a url to download a single dataset.","operationId":"radar_post_DatasetDownload","parameters":[{"name":"format","in":"query","description":"Format results are returned in.","schema":{"type":"string","description":"Format results are returned in.","enum":["json","csv"],"example":"json"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"datasetId":{"type":"integer","example":3}}}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","properties":{"dataset":{"type":"object","properties":{"url":{"type":"string","example":"https://example.com/download"}}}}}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/radar/dns/top/ases":{"get":{"tags":["Radar DNS"],"summary":"Get top autonomous systems by DNS queries.","description":"Get top autonomous systems by DNS queries made to Cloudflare's public DNS resolver.","operationId":"radar_get_DnsTopAses","parameters":[{"name":"limit","in":"query","description":"Limit the number of objects in the response.","schema":{"type":"integer","description":"Limit the number of objects in the response.","default":5,"example":5}},{"name":"name","in":"query","description":"Array of names that will be used to name the series in responses.","schema":{"type":"array","items":{"type":"string","description":"Array of names that will be used to name the series in responses.","example":"main_series"}}},{"name":"domain","in":"query","description":"Array of domain names.","required":true,"schema":{"type":"array","items":{"type":"string","description":"Array of domain names.","example":"google.com"}}},{"name":"dateRange","in":"query","description":"For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","schema":{"type":"array","items":{"type":"string","description":"For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","enum":["1d","7d","14d","28d","1dControl","7dControl","14dControl","28dControl"]}}},{"name":"dateStart","in":"query","description":"Array of datetimes to filter the start of a series.","schema":{"type":"array","items":{"type":"string","format":"date-time","example":"2022-09-15T00:00:00Z"}}},{"name":"dateEnd","in":"query","description":"Array of datetimes to filter the end of a series.","schema":{"type":"array","items":{"type":"string","format":"date-time","example":"2022-09-15T00:00:00Z"}}},{"name":"asn","in":"query","description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `[-174, 3356]` excludes results from AS174, but includes results from AS3356.","schema":{"type":"array","items":{"type":"string","description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `[-174, 3356]` excludes results from AS174, but includes results from AS3356.","example":"15169"}}},{"name":"location","in":"query","description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `[-US, PT]` excludes results from the US, but includes results from PT.","schema":{"type":"array","items":{"type":"string","description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `[-US, PT]` excludes results from the US, but includes results from PT.","example":"US,CA"}}},{"name":"format","in":"query","description":"Format results are returned in.","schema":{"type":"string","description":"Format results are returned in.","enum":["json","csv"],"example":"json"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"object","properties":{"meta":{"type":"object","properties":{"confidenceInfo":{"type":"object","properties":{"annotations":{"type":"array","items":{"type":"object","properties":{"dataSource":{"type":"string"},"description":{"type":"string"},"endTime":{"type":"string","format":"date-time","example":"2022-09-15T00:00:00Z"},"eventType":{"type":"string"},"startTime":{"type":"string","format":"date-time","example":"2022-09-15T00:00:00Z"}}}},"level":{"type":"integer"}}},"dateRange":{"type":"object","properties":{"endTime":{"type":"string","format":"date-time","example":"2022-09-15T00:00:00Z"},"startTime":{"type":"string","format":"date-time","example":"2022-09-15T00:00:00Z"}}}}},"top_0":{"type":"array","items":{"type":"object","properties":{"clientASN":{"type":"string","example":"174"},"clientASName":{"type":"string","example":"Cogent-174"},"value":{"type":"string","example":"65"}}}}}},"success":{"type":"boolean","example":true}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Not Found"}}}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/radar/dns/top/locations":{"get":{"tags":["Radar DNS"],"summary":"Get top locations by DNS queries","description":"Get top locations by DNS queries made to Cloudflare's public DNS resolver.","operationId":"radar_get_DnsTopLocations","parameters":[{"name":"limit","in":"query","description":"Limit the number of objects in the response.","schema":{"type":"integer","description":"Limit the number of objects in the response.","default":5,"example":5}},{"name":"name","in":"query","description":"Array of names that will be used to name the series in responses.","schema":{"type":"array","items":{"type":"string","description":"Array of names that will be used to name the series in responses.","example":"main_series"}}},{"name":"domain","in":"query","description":"Array of domain names.","required":true,"schema":{"type":"array","items":{"type":"string","description":"Array of domain names.","example":"google.com"}}},{"name":"dateRange","in":"query","description":"For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","schema":{"type":"array","items":{"type":"string","description":"For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","enum":["1d","7d","14d","28d","1dControl","7dControl","14dControl","28dControl"]}}},{"name":"dateStart","in":"query","description":"Array of datetimes to filter the start of a series.","schema":{"type":"array","items":{"type":"string","format":"date-time","example":"2022-09-15T00:00:00Z"}}},{"name":"dateEnd","in":"query","description":"Array of datetimes to filter the end of a series.","schema":{"type":"array","items":{"type":"string","format":"date-time","example":"2022-09-15T00:00:00Z"}}},{"name":"asn","in":"query","description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `[-174, 3356]` excludes results from AS174, but includes results from AS3356.","schema":{"type":"array","items":{"type":"string","description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `[-174, 3356]` excludes results from AS174, but includes results from AS3356.","example":"15169"}}},{"name":"location","in":"query","description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `[-US, PT]` excludes results from the US, but includes results from PT.","schema":{"type":"array","items":{"type":"string","description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `[-US, PT]` excludes results from the US, but includes results from PT.","example":"US,CA"}}},{"name":"format","in":"query","description":"Format results are returned in.","schema":{"type":"string","description":"Format results are returned in.","enum":["json","csv"],"example":"json"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"object","properties":{"meta":{"type":"object","properties":{"confidenceInfo":{"type":"object","properties":{"annotations":{"type":"array","items":{"type":"object","properties":{"dataSource":{"type":"string"},"description":{"type":"string"},"endTime":{"type":"string","format":"date-time","example":"2022-09-15T00:00:00Z"},"eventType":{"type":"string"},"startTime":{"type":"string","format":"date-time","example":"2022-09-15T00:00:00Z"}}}},"level":{"type":"integer"}}},"dateRange":{"type":"object","properties":{"endTime":{"type":"string","format":"date-time","example":"2022-09-15T00:00:00Z"},"startTime":{"type":"string","format":"date-time","example":"2022-09-15T00:00:00Z"}}}}},"top_0":{"type":"array","items":{"type":"object","properties":{"clientCountryAlpha2":{"type":"string","example":"PT"},"clientCountryName":{"type":"string","example":"Portugal"},"value":{"type":"string","example":"65"}}}}}},"success":{"type":"boolean","example":true}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Not Found"}}}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/radar/entities/asns":{"get":{"tags":["Radar Entities"],"summary":"Get autonomous systems","description":"Gets a list of autonomous systems (AS).","operationId":"radar_get_ASNsList","parameters":[{"name":"limit","in":"query","description":"Limit the number of objects in the response.","schema":{"type":"integer","description":"Limit the number of objects in the response.","default":5,"example":5}},{"name":"offset","in":"query","description":"Number of objects to skip before grabbing results.","schema":{"type":"integer","description":"Number of objects to skip before grabbing results.","default":0,"example":0}},{"name":"asn","in":"query","description":"Comma separated list of ASNs.","schema":{"type":"string","description":"Comma separated list of ASNs.","example":1747922}},{"name":"format","in":"query","description":"Format results are returned in.","schema":{"type":"string","description":"Format results are returned in.","enum":["json","csv"],"example":"json"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","properties":{"ases":{"type":"array","items":{"type":"object","properties":{"aka":{"type":"string"},"asn":{"type":"integer","example":714},"name":{"type":"string","example":"Apple Inc."},"nameLong":{"type":"string"},"website":{"type":"string","example":"https://www.apple.com/support/systemstatus/"}}}}}}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/radar/entities/asns/{asn}":{"get":{"tags":["Radar Entities"],"summary":"Get autonomous system (AS) by ID","description":"Get the requested autonomous system information. A confidence level below `5` indicates a low level of confidence in the traffic data - normally this happens because Cloudflare has a small amount of traffic from/to this AS).","operationId":"radar_get_ASNId","parameters":[{"name":"asn","in":"path","description":"Autonomous System Number (ASN).","required":true,"schema":{"type":"integer","description":"Autonomous System Number (ASN).","example":3}},{"name":"format","in":"query","description":"Format results are returned in.","schema":{"type":"string","description":"Format results are returned in.","enum":["json","csv"],"example":"json"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"object","properties":{"asn":{"type":"object","properties":{"aka":{"type":"string"},"asn":{"type":"integer","example":714},"confidenceLevel":{"type":"integer","example":5},"country":{"type":"string"},"name":{"type":"string","example":"Apple Inc."},"nameLong":{"type":"string"},"related":{"type":"array","items":{"type":"object","properties":{"aka":{"type":"string","example":""},"asn":{"type":"integer","example":174},"name":{"type":"string","example":"Cogent-174"}}}},"website":{"type":"string","example":"https://www.apple.com/support/systemstatus/"}}}}},"success":{"type":"boolean","example":true}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Not Found"}}}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/radar/entities/asns/ip":{"get":{"tags":["Radar Entities"],"summary":"Get autonomous system information by IP address","operationId":"radar_get_ASNIp","parameters":[{"name":"ip","in":"query","description":"IP address.","required":true,"schema":{"type":"string","description":"IP address.","example":"1.1.1.1"}},{"name":"format","in":"query","description":"Format results are returned in.","schema":{"type":"string","description":"Format results are returned in.","enum":["json","csv"],"example":"json"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"object","properties":{"asn":{"type":"object","properties":{"aka":{"type":"string"},"asn":{"type":"integer","example":714},"country":{"type":"string"},"name":{"type":"string","example":"Apple Inc."},"nameLong":{"type":"string"},"related":{"type":"array","items":{"type":"object","properties":{"aka":{"type":"string"},"asn":{"type":"integer"},"name":{"type":"string"}}}},"website":{"type":"string","example":"https://www.apple.com/support/systemstatus/"}}}}},"success":{"type":"boolean","example":true}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Not Found"}}}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/radar/entities/locations":{"get":{"tags":["Radar Entities"],"summary":"Get locations","description":"Get a list of locations.","operationId":"radar_get_LocationsList","parameters":[{"name":"limit","in":"query","description":"Limit the number of objects in the response.","schema":{"type":"integer","description":"Limit the number of objects in the response.","default":5,"example":5}},{"name":"offset","in":"query","description":"Number of objects to skip before grabbing results.","schema":{"type":"integer","description":"Number of objects to skip before grabbing results.","default":0,"example":0}},{"name":"location","in":"query","description":"Comma separated list of locations.","schema":{"type":"string","description":"Comma separated list of locations.","example":"US,CA"}},{"name":"format","in":"query","description":"Format results are returned in.","schema":{"type":"string","description":"Format results are returned in.","enum":["json","csv"],"example":"json"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"object","properties":{"locations":{"type":"array","items":{"type":"object","properties":{"alpha2":{"type":"string","example":"AF"},"latitude":{"type":"string","example":33.939116},"longitude":{"type":"string","example":67.709953},"name":{"type":"string","example":"Afghanistan"}}}}}},"success":{"type":"boolean","example":true}}}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/radar/entities/locations/{location}":{"get":{"tags":["Radar Entities"],"summary":"Get location","description":"Get the requested location information. A confidence level below `5` indicates a low level of confidence in the traffic data - normally this happens because Cloudflare has a small amount of traffic from/to this location).","operationId":"radar_get_LocationsOne","parameters":[{"name":"location","in":"path","description":"Alpha-2 country code.","required":true,"schema":{"type":"string","description":"Alpha-2 country code.","example":"US"}},{"name":"format","in":"query","description":"Format results are returned in.","schema":{"type":"string","description":"Format results are returned in.","enum":["json","csv"],"example":"json"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"object","properties":{"location":{"type":"object","properties":{"alpha2":{"type":"string","example":"AF"},"confidenceLvel":{"type":"integer","example":5},"latitude":{"type":"string","example":33.939116},"longitude":{"type":"string","example":67.709953},"name":{"type":"string","example":"Afghanistan"},"region":{"type":"string","example":"Middle East"},"subregion":{"type":"string","example":"Southern Asia"}}}}},"success":{"type":"boolean","example":true}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Not Found"}}}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/radar/http/summary/bot_class":{"get":{"tags":["Radar Http"],"summary":"Get a summary of bot classes","description":"Percentage distribution of traffic classified as automated or human.","operationId":"radar_get_SummaryBotClass","parameters":[{"name":"name","in":"query","description":"Array of names that will be used to name the series in responses.","schema":{"type":"array","items":{"type":"string","description":"Array of names that will be used to name the series in responses.","example":"main_series"}}},{"name":"dateRange","in":"query","description":"For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","schema":{"type":"array","items":{"type":"string","description":"For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","enum":["1d","7d","14d","28d","1dControl","7dControl","14dControl","28dControl"]}}},{"name":"dateStart","in":"query","description":"Array of datetimes to filter the start of a series.","schema":{"type":"array","items":{"type":"string","format":"date-time","example":"2022-09-15T00:00:00Z"}}},{"name":"dateEnd","in":"query","description":"Array of datetimes to filter the end of a series.","schema":{"type":"array","items":{"type":"string","format":"date-time","example":"2022-09-15T00:00:00Z"}}},{"name":"asn","in":"query","description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `[-174, 3356]` excludes results from AS174, but includes results from AS3356.","schema":{"type":"array","items":{"type":"string","description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `[-174, 3356]` excludes results from AS174, but includes results from AS3356.","example":"15169"}}},{"name":"location","in":"query","description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `[-US, PT]` excludes results from the US, but includes results from PT.","schema":{"type":"array","items":{"type":"string","description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `[-US, PT]` excludes results from the US, but includes results from PT.","example":"US,CA"}}},{"name":"format","in":"query","description":"Format results are returned in.","schema":{"type":"string","description":"Format results are returned in.","enum":["json","csv"],"example":"json"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"object","properties":{"meta":{"type":"object"},"summary_0":{"type":"object","properties":{"bot":{"type":"string","example":"35"},"human":{"type":"string","example":"65"}}}}},"success":{"type":"boolean","example":true}}}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/radar/http/summary/device_type":{"get":{"tags":["Radar Http"],"summary":"Get a summary of device types","description":"Percentage distribution of traffic per device type.","operationId":"radar_get_SummaryDeviceType","parameters":[{"name":"name","in":"query","description":"Array of names that will be used to name the series in responses.","schema":{"type":"array","items":{"type":"string","description":"Array of names that will be used to name the series in responses.","example":"main_series"}}},{"name":"dateRange","in":"query","description":"For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","schema":{"type":"array","items":{"type":"string","description":"For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","enum":["1d","7d","14d","28d","1dControl","7dControl","14dControl","28dControl"]}}},{"name":"dateStart","in":"query","description":"Array of datetimes to filter the start of a series.","schema":{"type":"array","items":{"type":"string","format":"date-time","example":"2022-09-15T00:00:00Z"}}},{"name":"dateEnd","in":"query","description":"Array of datetimes to filter the end of a series.","schema":{"type":"array","items":{"type":"string","format":"date-time","example":"2022-09-15T00:00:00Z"}}},{"name":"asn","in":"query","description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `[-174, 3356]` excludes results from AS174, but includes results from AS3356.","schema":{"type":"array","items":{"type":"string","description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `[-174, 3356]` excludes results from AS174, but includes results from AS3356.","example":"15169"}}},{"name":"location","in":"query","description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `[-US, PT]` excludes results from the US, but includes results from PT.","schema":{"type":"array","items":{"type":"string","description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `[-US, PT]` excludes results from the US, but includes results from PT.","example":"US,CA"}}},{"name":"botClass","in":"query","description":"Filter for bot class. Refer to [Bot Groupings](https://developers.cloudflare.com/bots/concepts/bot-score#bot-groupings)","schema":{"type":"array","items":{"type":"string","description":"Filter for bot class. Refer to [Bot Groupings](https://developers.cloudflare.com/bots/concepts/bot-score#bot-groupings)","enum":["LIKELY_AUTOMATED","LIKELY_HUMAN"],"example":"LIKELY_AUTOMATED"}}},{"name":"format","in":"query","description":"Format results are returned in.","schema":{"type":"string","description":"Format results are returned in.","enum":["json","csv"],"example":"json"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"object","properties":{"meta":{"type":"object"},"summary_0":{"type":"object","properties":{"desktop":{"type":"string","example":"65"},"mobile":{"type":"string","example":"30"},"other":{"type":"string","example":"5"}}}}},"success":{"type":"boolean","example":true}}}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/radar/http/summary/http_protocol":{"get":{"tags":["Radar Http"],"summary":"Get a summary of HTTP protocols","description":"Percentage distribution of traffic per HTTP protocol.","operationId":"radar_get_SummaryHttpProtocol","parameters":[{"name":"name","in":"query","description":"Array of names that will be used to name the series in responses.","schema":{"type":"array","items":{"type":"string","description":"Array of names that will be used to name the series in responses.","example":"main_series"}}},{"name":"dateRange","in":"query","description":"For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","schema":{"type":"array","items":{"type":"string","description":"For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","enum":["1d","7d","14d","28d","1dControl","7dControl","14dControl","28dControl"]}}},{"name":"dateStart","in":"query","description":"Array of datetimes to filter the start of a series.","schema":{"type":"array","items":{"type":"string","format":"date-time","example":"2022-09-15T00:00:00Z"}}},{"name":"dateEnd","in":"query","description":"Array of datetimes to filter the end of a series.","schema":{"type":"array","items":{"type":"string","format":"date-time","example":"2022-09-15T00:00:00Z"}}},{"name":"asn","in":"query","description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `[-174, 3356]` excludes results from AS174, but includes results from AS3356.","schema":{"type":"array","items":{"type":"string","description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `[-174, 3356]` excludes results from AS174, but includes results from AS3356.","example":"15169"}}},{"name":"location","in":"query","description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `[-US, PT]` excludes results from the US, but includes results from PT.","schema":{"type":"array","items":{"type":"string","description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `[-US, PT]` excludes results from the US, but includes results from PT.","example":"US,CA"}}},{"name":"botClass","in":"query","description":"Filter for bot class. Refer to [Bot Groupings](https://developers.cloudflare.com/bots/concepts/bot-score#bot-groupings)","schema":{"type":"array","items":{"type":"string","description":"Filter for bot class. Refer to [Bot Groupings](https://developers.cloudflare.com/bots/concepts/bot-score#bot-groupings)","enum":["LIKELY_AUTOMATED","LIKELY_HUMAN"],"example":"LIKELY_AUTOMATED"}}},{"name":"format","in":"query","description":"Format results are returned in.","schema":{"type":"string","description":"Format results are returned in.","enum":["json","csv"],"example":"json"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"object","properties":{"meta":{"type":"object"},"summary_0":{"type":"object","properties":{"http":{"type":"string","example":"99"},"https":{"type":"string","example":"1"}}}}},"success":{"type":"boolean","example":true}}}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/radar/http/summary/http_version":{"get":{"tags":["Radar Http"],"summary":"Get a summary of HTTP versions","description":"Percentage distribution of traffic per HTTP protocol version.","operationId":"radar_get_SummaryHttpVersion","parameters":[{"name":"name","in":"query","description":"Array of names that will be used to name the series in responses.","schema":{"type":"array","items":{"type":"string","description":"Array of names that will be used to name the series in responses.","example":"main_series"}}},{"name":"dateRange","in":"query","description":"For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","schema":{"type":"array","items":{"type":"string","description":"For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","enum":["1d","7d","14d","28d","1dControl","7dControl","14dControl","28dControl"]}}},{"name":"dateStart","in":"query","description":"Array of datetimes to filter the start of a series.","schema":{"type":"array","items":{"type":"string","format":"date-time","example":"2022-09-15T00:00:00Z"}}},{"name":"dateEnd","in":"query","description":"Array of datetimes to filter the end of a series.","schema":{"type":"array","items":{"type":"string","format":"date-time","example":"2022-09-15T00:00:00Z"}}},{"name":"asn","in":"query","description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `[-174, 3356]` excludes results from AS174, but includes results from AS3356.","schema":{"type":"array","items":{"type":"string","description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `[-174, 3356]` excludes results from AS174, but includes results from AS3356.","example":"15169"}}},{"name":"location","in":"query","description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `[-US, PT]` excludes results from the US, but includes results from PT.","schema":{"type":"array","items":{"type":"string","description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `[-US, PT]` excludes results from the US, but includes results from PT.","example":"US,CA"}}},{"name":"botClass","in":"query","description":"Filter for bot class. Refer to [Bot Groupings](https://developers.cloudflare.com/bots/concepts/bot-score#bot-groupings)","schema":{"type":"array","items":{"type":"string","description":"Filter for bot class. Refer to [Bot Groupings](https://developers.cloudflare.com/bots/concepts/bot-score#bot-groupings)","enum":["LIKELY_AUTOMATED","LIKELY_HUMAN"],"example":"LIKELY_AUTOMATED"}}},{"name":"format","in":"query","description":"Format results are returned in.","schema":{"type":"string","description":"Format results are returned in.","enum":["json","csv"],"example":"json"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"object","properties":{"meta":{"type":"object"},"summary_0":{"type":"object","properties":{"HTTP/1.x":{"type":"string","example":"1"},"HTTP/2":{"type":"string","example":"39"},"HTTP/3":{"type":"string","example":"60"}}}}},"success":{"type":"boolean","example":true}}}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/radar/http/summary/ip_version":{"get":{"tags":["Radar Http"],"summary":"Get a summary of IP versions","description":"Percentage distribution of traffic per IP protocol version.","operationId":"radar_get_SummaryIpVersion","parameters":[{"name":"name","in":"query","description":"Array of names that will be used to name the series in responses.","schema":{"type":"array","items":{"type":"string","description":"Array of names that will be used to name the series in responses.","example":"main_series"}}},{"name":"dateRange","in":"query","description":"For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","schema":{"type":"array","items":{"type":"string","description":"For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","enum":["1d","7d","14d","28d","1dControl","7dControl","14dControl","28dControl"]}}},{"name":"dateStart","in":"query","description":"Array of datetimes to filter the start of a series.","schema":{"type":"array","items":{"type":"string","format":"date-time","example":"2022-09-15T00:00:00Z"}}},{"name":"dateEnd","in":"query","description":"Array of datetimes to filter the end of a series.","schema":{"type":"array","items":{"type":"string","format":"date-time","example":"2022-09-15T00:00:00Z"}}},{"name":"asn","in":"query","description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `[-174, 3356]` excludes results from AS174, but includes results from AS3356.","schema":{"type":"array","items":{"type":"string","description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `[-174, 3356]` excludes results from AS174, but includes results from AS3356.","example":"15169"}}},{"name":"location","in":"query","description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `[-US, PT]` excludes results from the US, but includes results from PT.","schema":{"type":"array","items":{"type":"string","description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `[-US, PT]` excludes results from the US, but includes results from PT.","example":"US,CA"}}},{"name":"botClass","in":"query","description":"Filter for bot class. Refer to [Bot Groupings](https://developers.cloudflare.com/bots/concepts/bot-score#bot-groupings)","schema":{"type":"array","items":{"type":"string","description":"Filter for bot class. Refer to [Bot Groupings](https://developers.cloudflare.com/bots/concepts/bot-score#bot-groupings)","enum":["LIKELY_AUTOMATED","LIKELY_HUMAN"],"example":"LIKELY_AUTOMATED"}}},{"name":"format","in":"query","description":"Format results are returned in.","schema":{"type":"string","description":"Format results are returned in.","enum":["json","csv"],"example":"json"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"object","properties":{"meta":{"type":"object"},"summary_0":{"type":"object","properties":{"IPv4":{"type":"string","example":"65"},"IPv6":{"type":"string","example":"35"}}}}},"success":{"type":"boolean","example":true}}}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/radar/http/summary/tls_version":{"get":{"tags":["Radar Http"],"summary":"Get a summary of TLS versions","description":"Percentage distribution of traffic per TLS protocol version.","operationId":"radar_get_SummaryTLSVersion","parameters":[{"name":"name","in":"query","description":"Array of names that will be used to name the series in responses.","schema":{"type":"array","items":{"type":"string","description":"Array of names that will be used to name the series in responses.","example":"main_series"}}},{"name":"dateRange","in":"query","description":"For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","schema":{"type":"array","items":{"type":"string","description":"For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","enum":["1d","7d","14d","28d","1dControl","7dControl","14dControl","28dControl"]}}},{"name":"dateStart","in":"query","description":"Array of datetimes to filter the start of a series.","schema":{"type":"array","items":{"type":"string","format":"date-time","example":"2022-09-15T00:00:00Z"}}},{"name":"dateEnd","in":"query","description":"Array of datetimes to filter the end of a series.","schema":{"type":"array","items":{"type":"string","format":"date-time","example":"2022-09-15T00:00:00Z"}}},{"name":"asn","in":"query","description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `[-174, 3356]` excludes results from AS174, but includes results from AS3356.","schema":{"type":"array","items":{"type":"string","description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `[-174, 3356]` excludes results from AS174, but includes results from AS3356.","example":"15169"}}},{"name":"location","in":"query","description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `[-US, PT]` excludes results from the US, but includes results from PT.","schema":{"type":"array","items":{"type":"string","description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `[-US, PT]` excludes results from the US, but includes results from PT.","example":"US,CA"}}},{"name":"botClass","in":"query","description":"Filter for bot class. Refer to [Bot Groupings](https://developers.cloudflare.com/bots/concepts/bot-score#bot-groupings)","schema":{"type":"array","items":{"type":"string","description":"Filter for bot class. Refer to [Bot Groupings](https://developers.cloudflare.com/bots/concepts/bot-score#bot-groupings)","enum":["LIKELY_AUTOMATED","LIKELY_HUMAN"],"example":"LIKELY_AUTOMATED"}}},{"name":"format","in":"query","description":"Format results are returned in.","schema":{"type":"string","description":"Format results are returned in.","enum":["json","csv"],"example":"json"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"object","properties":{"meta":{"type":"object"},"summary_0":{"type":"object","properties":{"TLS 1.0":{"type":"string","example":"0.5"},"TLS 1.1":{"type":"string","example":"0.5"},"TLS 1.2":{"type":"string","example":"60"},"TLS 1.3":{"type":"string","example":"10"},"TLS QUIC":{"type":"string","example":"29"}}}}},"success":{"type":"boolean","example":true}}}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/radar/http/timeseries/bot_class":{"get":{"tags":["Radar Http"],"summary":"Get time series of bot classes","description":"Percentage distribution of traffic classified as automated or human over time.","operationId":"radar_get_TimeseriesBotClass","parameters":[{"name":"aggInterval","in":"query","description":"Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals).","schema":{"type":"string","description":"Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals).","enum":["15m","1h","1d"],"example":"1h"}},{"name":"name","in":"query","description":"Array of names that will be used to name the series in responses.","schema":{"type":"array","items":{"type":"string","description":"Array of names that will be used to name the series in responses.","example":"main_series"}}},{"name":"dateRange","in":"query","description":"For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","schema":{"type":"array","items":{"type":"string","description":"For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","enum":["1d","7d","14d","28d","1dControl","7dControl","14dControl","28dControl"]}}},{"name":"dateStart","in":"query","description":"Array of datetimes to filter the start of a series.","schema":{"type":"array","items":{"type":"string","format":"date-time","example":"2022-09-15T00:00:00Z"}}},{"name":"dateEnd","in":"query","description":"Array of datetimes to filter the end of a series.","schema":{"type":"array","items":{"type":"string","format":"date-time","example":"2022-09-15T00:00:00Z"}}},{"name":"asn","in":"query","description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `[-174, 3356]` excludes results from AS174, but includes results from AS3356.","schema":{"type":"array","items":{"type":"string","description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `[-174, 3356]` excludes results from AS174, but includes results from AS3356.","example":"15169"}}},{"name":"location","in":"query","description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `[-US, PT]` excludes results from the US, but includes results from PT.","schema":{"type":"array","items":{"type":"string","description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `[-US, PT]` excludes results from the US, but includes results from PT.","example":"US,CA"}}},{"name":"format","in":"query","description":"Format results are returned in.","schema":{"type":"string","description":"Format results are returned in.","enum":["json","csv"],"example":"json"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"object","properties":{"meta":{"type":"object"},"serie_0":{"type":"object","properties":{"bot":{"type":"array","items":{"type":"string"}},"human":{"type":"array","items":{"type":"string"}},"timestamps":{"type":"array","items":{"type":"string"}}}}}},"success":{"type":"boolean","example":true}}}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/radar/http/timeseries/browser":{"get":{"tags":["Radar Http"],"summary":"Get time series of user agents","description":"Percentage distribution of traffic of the top user agents in the selected time range, over time.","operationId":"radar_get_TimeseriesBrowsers","parameters":[{"name":"aggInterval","in":"query","description":"Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals).","schema":{"type":"string","description":"Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals).","enum":["15m","1h","1d"],"example":"1h"}},{"name":"name","in":"query","description":"Array of names that will be used to name the series in responses.","schema":{"type":"array","items":{"type":"string","description":"Array of names that will be used to name the series in responses.","example":"main_series"}}},{"name":"dateRange","in":"query","description":"For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","schema":{"type":"array","items":{"type":"string","description":"For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","enum":["1d","7d","14d","28d","1dControl","7dControl","14dControl","28dControl"]}}},{"name":"dateStart","in":"query","description":"Array of datetimes to filter the start of a series.","schema":{"type":"array","items":{"type":"string","format":"date-time","example":"2022-09-15T00:00:00Z"}}},{"name":"dateEnd","in":"query","description":"Array of datetimes to filter the end of a series.","schema":{"type":"array","items":{"type":"string","format":"date-time","example":"2022-09-15T00:00:00Z"}}},{"name":"asn","in":"query","description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `[-174, 3356]` excludes results from AS174, but includes results from AS3356.","schema":{"type":"array","items":{"type":"string","description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `[-174, 3356]` excludes results from AS174, but includes results from AS3356.","example":"15169"}}},{"name":"location","in":"query","description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `[-US, PT]` excludes results from the US, but includes results from PT.","schema":{"type":"array","items":{"type":"string","description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `[-US, PT]` excludes results from the US, but includes results from PT.","example":"US,CA"}}},{"name":"botClass","in":"query","description":"Filter for bot class. Refer to [Bot Groupings](https://developers.cloudflare.com/bots/concepts/bot-score#bot-groupings)","schema":{"type":"array","items":{"type":"string","description":"Filter for bot class. Refer to [Bot Groupings](https://developers.cloudflare.com/bots/concepts/bot-score#bot-groupings)","enum":["LIKELY_AUTOMATED","LIKELY_HUMAN"],"example":"LIKELY_AUTOMATED"}}},{"name":"limitPerGroup","in":"query","description":"Limit the number of objects (eg browsers) to the top items over the time range.","schema":{"type":"integer","description":"Limit the number of objects (eg browsers) to the top items over the time range.","default":10,"example":2}},{"name":"format","in":"query","description":"Format results are returned in.","schema":{"type":"string","description":"Format results are returned in.","enum":["json","csv"],"example":"json"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"object","properties":{"meta":{"type":"object"},"serie_0":{"type":"object","properties":{"<browser name>":{"type":"array","items":{"type":"string"}},"timestamps":{"type":"array","items":{"type":"string"}}}}}},"success":{"type":"boolean","example":true}}}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/radar/http/timeseries/browser_family":{"get":{"tags":["Radar Http"],"summary":"Get time series of user agents aggregated in families","description":"Percentage distribution of traffic of the top user agents aggregated in families in the selected time range, over time.","operationId":"radar_get_TimeseriesBrowserFamilies","parameters":[{"name":"aggInterval","in":"query","description":"Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals).","schema":{"type":"string","description":"Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals).","enum":["15m","1h","1d"],"example":"1h"}},{"name":"name","in":"query","description":"Array of names that will be used to name the series in responses.","schema":{"type":"array","items":{"type":"string","description":"Array of names that will be used to name the series in responses.","example":"main_series"}}},{"name":"dateRange","in":"query","description":"For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","schema":{"type":"array","items":{"type":"string","description":"For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","enum":["1d","7d","14d","28d","1dControl","7dControl","14dControl","28dControl"]}}},{"name":"dateStart","in":"query","description":"Array of datetimes to filter the start of a series.","schema":{"type":"array","items":{"type":"string","format":"date-time","example":"2022-09-15T00:00:00Z"}}},{"name":"dateEnd","in":"query","description":"Array of datetimes to filter the end of a series.","schema":{"type":"array","items":{"type":"string","format":"date-time","example":"2022-09-15T00:00:00Z"}}},{"name":"asn","in":"query","description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `[-174, 3356]` excludes results from AS174, but includes results from AS3356.","schema":{"type":"array","items":{"type":"string","description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `[-174, 3356]` excludes results from AS174, but includes results from AS3356.","example":"15169"}}},{"name":"location","in":"query","description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `[-US, PT]` excludes results from the US, but includes results from PT.","schema":{"type":"array","items":{"type":"string","description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `[-US, PT]` excludes results from the US, but includes results from PT.","example":"US,CA"}}},{"name":"botClass","in":"query","description":"Filter for bot class. Refer to [Bot Groupings](https://developers.cloudflare.com/bots/concepts/bot-score#bot-groupings)","schema":{"type":"array","items":{"type":"string","description":"Filter for bot class. Refer to [Bot Groupings](https://developers.cloudflare.com/bots/concepts/bot-score#bot-groupings)","enum":["LIKELY_AUTOMATED","LIKELY_HUMAN"],"example":"LIKELY_AUTOMATED"}}},{"name":"format","in":"query","description":"Format results are returned in.","schema":{"type":"string","description":"Format results are returned in.","enum":["json","csv"],"example":"json"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"object","properties":{"meta":{"type":"object"},"serie_0":{"type":"object","properties":{"<browser name>":{"type":"array","items":{"type":"string"}},"timestamps":{"type":"array","items":{"type":"string"}}}}}},"success":{"type":"boolean","example":true}}}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/radar/http/timeseries/device_type":{"get":{"tags":["Radar Http"],"summary":"Get time series of device types","description":"Percentage distribution of traffic per device type over time.","operationId":"radar_get_TimeseriesDeviceType","parameters":[{"name":"aggInterval","in":"query","description":"Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals).","schema":{"type":"string","description":"Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals).","enum":["15m","1h","1d"],"example":"1h"}},{"name":"name","in":"query","description":"Array of names that will be used to name the series in responses.","schema":{"type":"array","items":{"type":"string","description":"Array of names that will be used to name the series in responses.","example":"main_series"}}},{"name":"dateRange","in":"query","description":"For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","schema":{"type":"array","items":{"type":"string","description":"For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","enum":["1d","7d","14d","28d","1dControl","7dControl","14dControl","28dControl"]}}},{"name":"dateStart","in":"query","description":"Array of datetimes to filter the start of a series.","schema":{"type":"array","items":{"type":"string","format":"date-time","example":"2022-09-15T00:00:00Z"}}},{"name":"dateEnd","in":"query","description":"Array of datetimes to filter the end of a series.","schema":{"type":"array","items":{"type":"string","format":"date-time","example":"2022-09-15T00:00:00Z"}}},{"name":"asn","in":"query","description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `[-174, 3356]` excludes results from AS174, but includes results from AS3356.","schema":{"type":"array","items":{"type":"string","description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `[-174, 3356]` excludes results from AS174, but includes results from AS3356.","example":"15169"}}},{"name":"location","in":"query","description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `[-US, PT]` excludes results from the US, but includes results from PT.","schema":{"type":"array","items":{"type":"string","description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `[-US, PT]` excludes results from the US, but includes results from PT.","example":"US,CA"}}},{"name":"botClass","in":"query","description":"Filter for bot class. Refer to [Bot Groupings](https://developers.cloudflare.com/bots/concepts/bot-score#bot-groupings)","schema":{"type":"array","items":{"type":"string","description":"Filter for bot class. Refer to [Bot Groupings](https://developers.cloudflare.com/bots/concepts/bot-score#bot-groupings)","enum":["LIKELY_AUTOMATED","LIKELY_HUMAN"],"example":"LIKELY_AUTOMATED"}}},{"name":"format","in":"query","description":"Format results are returned in.","schema":{"type":"string","description":"Format results are returned in.","enum":["json","csv"],"example":"json"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"object","properties":{"meta":{"type":"object"},"serie_0":{"type":"object","properties":{"desktop":{"type":"array","items":{"type":"string"}},"mobile":{"type":"array","items":{"type":"string"}},"other":{"type":"array","items":{"type":"string"}},"timestamps":{"type":"array","items":{"type":"string"}}}}}},"success":{"type":"boolean","example":true}}}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/radar/http/timeseries/http_protocol":{"get":{"tags":["Radar Http"],"summary":"Get time series of HTTP protocols","description":"Percentage distribution of traffic per HTTP protocol over time.","operationId":"radar_get_TimeseriesHttpProtocol","parameters":[{"name":"aggInterval","in":"query","description":"Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals).","schema":{"type":"string","description":"Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals).","enum":["15m","1h","1d"],"example":"1h"}},{"name":"name","in":"query","description":"Array of names that will be used to name the series in responses.","schema":{"type":"array","items":{"type":"string","description":"Array of names that will be used to name the series in responses.","example":"main_series"}}},{"name":"dateRange","in":"query","description":"For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","schema":{"type":"array","items":{"type":"string","description":"For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","enum":["1d","7d","14d","28d","1dControl","7dControl","14dControl","28dControl"]}}},{"name":"dateStart","in":"query","description":"Array of datetimes to filter the start of a series.","schema":{"type":"array","items":{"type":"string","format":"date-time","example":"2022-09-15T00:00:00Z"}}},{"name":"dateEnd","in":"query","description":"Array of datetimes to filter the end of a series.","schema":{"type":"array","items":{"type":"string","format":"date-time","example":"2022-09-15T00:00:00Z"}}},{"name":"asn","in":"query","description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `[-174, 3356]` excludes results from AS174, but includes results from AS3356.","schema":{"type":"array","items":{"type":"string","description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `[-174, 3356]` excludes results from AS174, but includes results from AS3356.","example":"15169"}}},{"name":"location","in":"query","description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `[-US, PT]` excludes results from the US, but includes results from PT.","schema":{"type":"array","items":{"type":"string","description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `[-US, PT]` excludes results from the US, but includes results from PT.","example":"US,CA"}}},{"name":"botClass","in":"query","description":"Filter for bot class. Refer to [Bot Groupings](https://developers.cloudflare.com/bots/concepts/bot-score#bot-groupings)","schema":{"type":"array","items":{"type":"string","description":"Filter for bot class. Refer to [Bot Groupings](https://developers.cloudflare.com/bots/concepts/bot-score#bot-groupings)","enum":["LIKELY_AUTOMATED","LIKELY_HUMAN"],"example":"LIKELY_AUTOMATED"}}},{"name":"format","in":"query","description":"Format results are returned in.","schema":{"type":"string","description":"Format results are returned in.","enum":["json","csv"],"example":"json"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"object","properties":{"meta":{"type":"object"},"serie_0":{"type":"object","properties":{"http":{"type":"array","items":{"type":"string"}},"https":{"type":"array","items":{"type":"string"}},"timestamps":{"type":"array","items":{"type":"string"}}}}}},"success":{"type":"boolean","example":true}}}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/radar/http/timeseries/http_version":{"get":{"tags":["Radar Http"],"summary":"Get time series of HTTP versions","description":"Percentage distribution of traffic per HTTP protocol version over time.","operationId":"radar_get_TimeseriesHttpVersion","parameters":[{"name":"aggInterval","in":"query","description":"Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals).","schema":{"type":"string","description":"Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals).","enum":["15m","1h","1d"],"example":"1h"}},{"name":"name","in":"query","description":"Array of names that will be used to name the series in responses.","schema":{"type":"array","items":{"type":"string","description":"Array of names that will be used to name the series in responses.","example":"main_series"}}},{"name":"dateRange","in":"query","description":"For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","schema":{"type":"array","items":{"type":"string","description":"For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","enum":["1d","7d","14d","28d","1dControl","7dControl","14dControl","28dControl"]}}},{"name":"dateStart","in":"query","description":"Array of datetimes to filter the start of a series.","schema":{"type":"array","items":{"type":"string","format":"date-time","example":"2022-09-15T00:00:00Z"}}},{"name":"dateEnd","in":"query","description":"Array of datetimes to filter the end of a series.","schema":{"type":"array","items":{"type":"string","format":"date-time","example":"2022-09-15T00:00:00Z"}}},{"name":"asn","in":"query","description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `[-174, 3356]` excludes results from AS174, but includes results from AS3356.","schema":{"type":"array","items":{"type":"string","description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `[-174, 3356]` excludes results from AS174, but includes results from AS3356.","example":"15169"}}},{"name":"location","in":"query","description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `[-US, PT]` excludes results from the US, but includes results from PT.","schema":{"type":"array","items":{"type":"string","description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `[-US, PT]` excludes results from the US, but includes results from PT.","example":"US,CA"}}},{"name":"botClass","in":"query","description":"Filter for bot class. Refer to [Bot Groupings](https://developers.cloudflare.com/bots/concepts/bot-score#bot-groupings)","schema":{"type":"array","items":{"type":"string","description":"Filter for bot class. Refer to [Bot Groupings](https://developers.cloudflare.com/bots/concepts/bot-score#bot-groupings)","enum":["LIKELY_AUTOMATED","LIKELY_HUMAN"],"example":"LIKELY_AUTOMATED"}}},{"name":"format","in":"query","description":"Format results are returned in.","schema":{"type":"string","description":"Format results are returned in.","enum":["json","csv"],"example":"json"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"object","properties":{"meta":{"type":"object"},"serie_0":{"type":"object","properties":{"HTTP/1.x":{"type":"array","items":{"type":"string"}},"HTTP/2":{"type":"array","items":{"type":"string"}},"HTTP/3":{"type":"array","items":{"type":"string"}},"timestamps":{"type":"array","items":{"type":"string"}}}}}},"success":{"type":"boolean","example":true}}}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/radar/http/timeseries/ip_version":{"get":{"tags":["Radar Http"],"summary":"Get time series of IP versions","description":"Percentage distribution of traffic per IP protocol version over time.","operationId":"radar_get_TimeseriesIpVersion","parameters":[{"name":"aggInterval","in":"query","description":"Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals).","schema":{"type":"string","description":"Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals).","enum":["15m","1h","1d"],"example":"1h"}},{"name":"name","in":"query","description":"Array of names that will be used to name the series in responses.","schema":{"type":"array","items":{"type":"string","description":"Array of names that will be used to name the series in responses.","example":"main_series"}}},{"name":"dateRange","in":"query","description":"For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","schema":{"type":"array","items":{"type":"string","description":"For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","enum":["1d","7d","14d","28d","1dControl","7dControl","14dControl","28dControl"]}}},{"name":"dateStart","in":"query","description":"Array of datetimes to filter the start of a series.","schema":{"type":"array","items":{"type":"string","format":"date-time","example":"2022-09-15T00:00:00Z"}}},{"name":"dateEnd","in":"query","description":"Array of datetimes to filter the end of a series.","schema":{"type":"array","items":{"type":"string","format":"date-time","example":"2022-09-15T00:00:00Z"}}},{"name":"asn","in":"query","description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `[-174, 3356]` excludes results from AS174, but includes results from AS3356.","schema":{"type":"array","items":{"type":"string","description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `[-174, 3356]` excludes results from AS174, but includes results from AS3356.","example":"15169"}}},{"name":"location","in":"query","description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `[-US, PT]` excludes results from the US, but includes results from PT.","schema":{"type":"array","items":{"type":"string","description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `[-US, PT]` excludes results from the US, but includes results from PT.","example":"US,CA"}}},{"name":"botClass","in":"query","description":"Filter for bot class. Refer to [Bot Groupings](https://developers.cloudflare.com/bots/concepts/bot-score#bot-groupings)","schema":{"type":"array","items":{"type":"string","description":"Filter for bot class. Refer to [Bot Groupings](https://developers.cloudflare.com/bots/concepts/bot-score#bot-groupings)","enum":["LIKELY_AUTOMATED","LIKELY_HUMAN"],"example":"LIKELY_AUTOMATED"}}},{"name":"format","in":"query","description":"Format results are returned in.","schema":{"type":"string","description":"Format results are returned in.","enum":["json","csv"],"example":"json"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"object","properties":{"meta":{"type":"object"},"serie_0":{"type":"object","properties":{"IPv4":{"type":"array","items":{"type":"string"}},"IPv6":{"type":"array","items":{"type":"string"}},"timestamps":{"type":"array","items":{"type":"string"}}}}}},"success":{"type":"boolean","example":true}}}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/radar/http/timeseries/tls_version":{"get":{"tags":["Radar Http"],"summary":"Get time series of TLS versions","description":"Percentage distribution of traffic per TLS protocol version over time.","operationId":"radar_get_TimeseriesTLSVersion","parameters":[{"name":"aggInterval","in":"query","description":"Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals).","schema":{"type":"string","description":"Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals).","enum":["15m","1h","1d"],"example":"1h"}},{"name":"name","in":"query","description":"Array of names that will be used to name the series in responses.","schema":{"type":"array","items":{"type":"string","description":"Array of names that will be used to name the series in responses.","example":"main_series"}}},{"name":"dateRange","in":"query","description":"For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","schema":{"type":"array","items":{"type":"string","description":"For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","enum":["1d","7d","14d","28d","1dControl","7dControl","14dControl","28dControl"]}}},{"name":"dateStart","in":"query","description":"Array of datetimes to filter the start of a series.","schema":{"type":"array","items":{"type":"string","format":"date-time","example":"2022-09-15T00:00:00Z"}}},{"name":"dateEnd","in":"query","description":"Array of datetimes to filter the end of a series.","schema":{"type":"array","items":{"type":"string","format":"date-time","example":"2022-09-15T00:00:00Z"}}},{"name":"asn","in":"query","description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `[-174, 3356]` excludes results from AS174, but includes results from AS3356.","schema":{"type":"array","items":{"type":"string","description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `[-174, 3356]` excludes results from AS174, but includes results from AS3356.","example":"15169"}}},{"name":"location","in":"query","description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `[-US, PT]` excludes results from the US, but includes results from PT.","schema":{"type":"array","items":{"type":"string","description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `[-US, PT]` excludes results from the US, but includes results from PT.","example":"US,CA"}}},{"name":"botClass","in":"query","description":"Filter for bot class. Refer to [Bot Groupings](https://developers.cloudflare.com/bots/concepts/bot-score#bot-groupings)","schema":{"type":"array","items":{"type":"string","description":"Filter for bot class. Refer to [Bot Groupings](https://developers.cloudflare.com/bots/concepts/bot-score#bot-groupings)","enum":["LIKELY_AUTOMATED","LIKELY_HUMAN"],"example":"LIKELY_AUTOMATED"}}},{"name":"format","in":"query","description":"Format results are returned in.","schema":{"type":"string","description":"Format results are returned in.","enum":["json","csv"],"example":"json"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"object","properties":{"meta":{"type":"object"},"serie_0":{"type":"object","properties":{"TLS 1.0":{"type":"array","items":{"type":"string"}},"TLS 1.1":{"type":"array","items":{"type":"string"}},"TLS 1.2":{"type":"array","items":{"type":"string"}},"TLS 1.3":{"type":"array","items":{"type":"string"}},"TLS QUIC":{"type":"array","items":{"type":"string"}},"timestamps":{"type":"array","items":{"type":"string"}}}}}},"success":{"type":"boolean","example":true}}}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/radar/http/top/ases":{"get":{"tags":["Radar Http"],"summary":"Get top autonomous systems by HTTP requests","description":"Get the top autonomous systems (AS) by HTTP traffic. Values are a percentage out of the total traffic.","operationId":"radar_get_HttpTopASes","parameters":[{"name":"limit","in":"query","description":"Limit the number of objects in the response.","schema":{"type":"integer","description":"Limit the number of objects in the response.","default":5,"example":5}},{"name":"name","in":"query","description":"Array of names that will be used to name the series in responses.","schema":{"type":"array","items":{"type":"string","description":"Array of names that will be used to name the series in responses.","example":"main_series"}}},{"name":"dateRange","in":"query","description":"For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","schema":{"type":"array","items":{"type":"string","description":"For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","enum":["1d","7d","14d","28d","1dControl","7dControl","14dControl","28dControl"]}}},{"name":"dateStart","in":"query","description":"Array of datetimes to filter the start of a series.","schema":{"type":"array","items":{"type":"string","format":"date-time","example":"2022-09-15T00:00:00Z"}}},{"name":"dateEnd","in":"query","description":"Array of datetimes to filter the end of a series.","schema":{"type":"array","items":{"type":"string","format":"date-time","example":"2022-09-15T00:00:00Z"}}},{"name":"asn","in":"query","description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `[-174, 3356]` excludes results from AS174, but includes results from AS3356.","schema":{"type":"array","items":{"type":"string","description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `[-174, 3356]` excludes results from AS174, but includes results from AS3356.","example":"15169"}}},{"name":"location","in":"query","description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `[-US, PT]` excludes results from the US, but includes results from PT.","schema":{"type":"array","items":{"type":"string","description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `[-US, PT]` excludes results from the US, but includes results from PT.","example":"US,CA"}}},{"name":"botClass","in":"query","description":"Filter for bot class. Refer to [Bot Groupings](https://developers.cloudflare.com/bots/concepts/bot-score#bot-groupings)","schema":{"type":"array","items":{"type":"string","description":"Filter for bot class. Refer to [Bot Groupings](https://developers.cloudflare.com/bots/concepts/bot-score#bot-groupings)","enum":["LIKELY_AUTOMATED","LIKELY_HUMAN"],"example":"LIKELY_AUTOMATED"}}},{"name":"format","in":"query","description":"Format results are returned in.","schema":{"type":"string","description":"Format results are returned in.","enum":["json","csv"],"example":"json"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"object","properties":{"meta":{"type":"object","properties":{"confidenceInfo":{"type":"object","properties":{"annotations":{"type":"array","items":{"type":"object","properties":{"dataSource":{"type":"string"},"description":{"type":"string"},"endTime":{"type":"string","format":"date-time","example":"2022-09-15T00:00:00Z"},"eventType":{"type":"string"},"startTime":{"type":"string","format":"date-time","example":"2022-09-15T00:00:00Z"}}}},"level":{"type":"integer"}}},"dateRange":{"type":"object","properties":{"endTime":{"type":"string","format":"date-time","example":"2022-09-15T00:00:00Z"},"startTime":{"type":"string","format":"date-time","example":"2022-09-15T00:00:00Z"}}}}},"top_0":{"type":"array","items":{"type":"object","properties":{"clientASN":{"type":"string","example":"3243"},"clientASName":{"type":"string","example":"MEO"},"value":{"type":"string","example":"3"}}}}}},"success":{"type":"boolean","example":true}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Not Found"}}}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/radar/http/top/ases/bot_class/{bot_class}":{"get":{"tags":["Radar Http"],"summary":"Get top autonomous systems by bot class","description":"Get the top autonomous systems (AS), by HTTP traffic, of the requested bot class. These two categories use Cloudflare's bot score - refer to [Bot Scores](https://developers.cloudflare.com/bots/concepts/bot-score) for more information. Values are a percentage out of the total traffic.","operationId":"radar_get_HttpTopASesByBotClass","parameters":[{"name":"bot_class","in":"path","description":"Bot class.","required":true,"schema":{"type":"string","description":"Bot class.","enum":["LIKELY_AUTOMATED","LIKELY_HUMAN"]}},{"name":"limit","in":"query","description":"Limit the number of objects in the response.","schema":{"type":"integer","description":"Limit the number of objects in the response.","default":5,"example":5}},{"name":"name","in":"query","description":"Array of names that will be used to name the series in responses.","schema":{"type":"array","items":{"type":"string","description":"Array of names that will be used to name the series in responses.","example":"main_series"}}},{"name":"dateRange","in":"query","description":"For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","schema":{"type":"array","items":{"type":"string","description":"For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","enum":["1d","7d","14d","28d","1dControl","7dControl","14dControl","28dControl"]}}},{"name":"dateStart","in":"query","description":"Array of datetimes to filter the start of a series.","schema":{"type":"array","items":{"type":"string","format":"date-time","example":"2022-09-15T00:00:00Z"}}},{"name":"dateEnd","in":"query","description":"Array of datetimes to filter the end of a series.","schema":{"type":"array","items":{"type":"string","format":"date-time","example":"2022-09-15T00:00:00Z"}}},{"name":"asn","in":"query","description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `[-174, 3356]` excludes results from AS174, but includes results from AS3356.","schema":{"type":"array","items":{"type":"string","description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `[-174, 3356]` excludes results from AS174, but includes results from AS3356.","example":"15169"}}},{"name":"location","in":"query","description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `[-US, PT]` excludes results from the US, but includes results from PT.","schema":{"type":"array","items":{"type":"string","description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `[-US, PT]` excludes results from the US, but includes results from PT.","example":"US,CA"}}},{"name":"format","in":"query","description":"Format results are returned in.","schema":{"type":"string","description":"Format results are returned in.","enum":["json","csv"],"example":"json"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"object","properties":{"meta":{"type":"object","properties":{"confidenceInfo":{"type":"object","properties":{"annotations":{"type":"array","items":{"type":"object","properties":{"dataSource":{"type":"string"},"description":{"type":"string"},"endTime":{"type":"string","format":"date-time","example":"2022-09-15T00:00:00Z"},"eventType":{"type":"string"},"startTime":{"type":"string","format":"date-time","example":"2022-09-15T00:00:00Z"}}}},"level":{"type":"integer"}}},"dateRange":{"type":"object","properties":{"endTime":{"type":"string","format":"date-time","example":"2022-09-15T00:00:00Z"},"startTime":{"type":"string","format":"date-time","example":"2022-09-15T00:00:00Z"}}}}},"top_0":{"type":"array","items":{"type":"object","properties":{"clientASN":{"type":"string","example":"3243"},"clientASName":{"type":"string","example":"MEO"},"value":{"type":"string","example":"3"}}}}}},"success":{"type":"boolean","example":true}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Not Found"}}}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/radar/http/top/ases/device_type/{device_type}":{"get":{"tags":["Radar Http"],"summary":"Get top autonomous systems by device type","description":"Get the top autonomous systems (AS), by HTTP traffic, of the requested device type. Values are a percentage out of the total traffic.","operationId":"radar_get_HttpTopASesByDeviceType","parameters":[{"name":"device_type","in":"path","description":"Device type.","required":true,"schema":{"type":"string","description":"Device type.","enum":["DESKTOP","MOBILE","OTHER"]}},{"name":"limit","in":"query","description":"Limit the number of objects in the response.","schema":{"type":"integer","description":"Limit the number of objects in the response.","default":5,"example":5}},{"name":"name","in":"query","description":"Array of names that will be used to name the series in responses.","schema":{"type":"array","items":{"type":"string","description":"Array of names that will be used to name the series in responses.","example":"main_series"}}},{"name":"dateRange","in":"query","description":"For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","schema":{"type":"array","items":{"type":"string","description":"For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","enum":["1d","7d","14d","28d","1dControl","7dControl","14dControl","28dControl"]}}},{"name":"dateStart","in":"query","description":"Array of datetimes to filter the start of a series.","schema":{"type":"array","items":{"type":"string","format":"date-time","example":"2022-09-15T00:00:00Z"}}},{"name":"dateEnd","in":"query","description":"Array of datetimes to filter the end of a series.","schema":{"type":"array","items":{"type":"string","format":"date-time","example":"2022-09-15T00:00:00Z"}}},{"name":"asn","in":"query","description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `[-174, 3356]` excludes results from AS174, but includes results from AS3356.","schema":{"type":"array","items":{"type":"string","description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `[-174, 3356]` excludes results from AS174, but includes results from AS3356.","example":"15169"}}},{"name":"location","in":"query","description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `[-US, PT]` excludes results from the US, but includes results from PT.","schema":{"type":"array","items":{"type":"string","description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `[-US, PT]` excludes results from the US, but includes results from PT.","example":"US,CA"}}},{"name":"botClass","in":"query","description":"Filter for bot class. Refer to [Bot Groupings](https://developers.cloudflare.com/bots/concepts/bot-score#bot-groupings)","schema":{"type":"array","items":{"type":"string","description":"Filter for bot class. Refer to [Bot Groupings](https://developers.cloudflare.com/bots/concepts/bot-score#bot-groupings)","enum":["LIKELY_AUTOMATED","LIKELY_HUMAN"],"example":"LIKELY_AUTOMATED"}}},{"name":"format","in":"query","description":"Format results are returned in.","schema":{"type":"string","description":"Format results are returned in.","enum":["json","csv"],"example":"json"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"object","properties":{"meta":{"type":"object","properties":{"confidenceInfo":{"type":"object","properties":{"annotations":{"type":"array","items":{"type":"object","properties":{"dataSource":{"type":"string"},"description":{"type":"string"},"endTime":{"type":"string","format":"date-time","example":"2022-09-15T00:00:00Z"},"eventType":{"type":"string"},"startTime":{"type":"string","format":"date-time","example":"2022-09-15T00:00:00Z"}}}},"level":{"type":"integer"}}},"dateRange":{"type":"object","properties":{"endTime":{"type":"string","format":"date-time","example":"2022-09-15T00:00:00Z"},"startTime":{"type":"string","format":"date-time","example":"2022-09-15T00:00:00Z"}}}}},"top_0":{"type":"array","items":{"type":"object","properties":{"clientASN":{"type":"string","example":"3243"},"clientASName":{"type":"string","example":"MEO"},"value":{"type":"string","example":"3"}}}}}},"success":{"type":"boolean","example":true}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Not Found"}}}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/radar/http/top/ases/http_protocol/{http_protocol}":{"get":{"tags":["Radar Http"],"summary":"Get top autonomous systems by HTTP protocol","description":"Get the top autonomous systems (AS), by HTTP traffic, of the requested HTTP protocol. Values are a percentage out of the total traffic.","operationId":"radar_get_HttpTopASesByHTTPProtocol","parameters":[{"name":"http_protocol","in":"path","description":"HTTP Protocol.","required":true,"schema":{"type":"string","description":"HTTP Protocol.","enum":["HTTP","HTTPS"]}},{"name":"limit","in":"query","description":"Limit the number of objects in the response.","schema":{"type":"integer","description":"Limit the number of objects in the response.","default":5,"example":5}},{"name":"name","in":"query","description":"Array of names that will be used to name the series in responses.","schema":{"type":"array","items":{"type":"string","description":"Array of names that will be used to name the series in responses.","example":"main_series"}}},{"name":"dateRange","in":"query","description":"For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","schema":{"type":"array","items":{"type":"string","description":"For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","enum":["1d","7d","14d","28d","1dControl","7dControl","14dControl","28dControl"]}}},{"name":"dateStart","in":"query","description":"Array of datetimes to filter the start of a series.","schema":{"type":"array","items":{"type":"string","format":"date-time","example":"2022-09-15T00:00:00Z"}}},{"name":"dateEnd","in":"query","description":"Array of datetimes to filter the end of a series.","schema":{"type":"array","items":{"type":"string","format":"date-time","example":"2022-09-15T00:00:00Z"}}},{"name":"asn","in":"query","description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `[-174, 3356]` excludes results from AS174, but includes results from AS3356.","schema":{"type":"array","items":{"type":"string","description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `[-174, 3356]` excludes results from AS174, but includes results from AS3356.","example":"15169"}}},{"name":"location","in":"query","description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `[-US, PT]` excludes results from the US, but includes results from PT.","schema":{"type":"array","items":{"type":"string","description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `[-US, PT]` excludes results from the US, but includes results from PT.","example":"US,CA"}}},{"name":"botClass","in":"query","description":"Filter for bot class. Refer to [Bot Groupings](https://developers.cloudflare.com/bots/concepts/bot-score#bot-groupings)","schema":{"type":"array","items":{"type":"string","description":"Filter for bot class. Refer to [Bot Groupings](https://developers.cloudflare.com/bots/concepts/bot-score#bot-groupings)","enum":["LIKELY_AUTOMATED","LIKELY_HUMAN"],"example":"LIKELY_AUTOMATED"}}},{"name":"format","in":"query","description":"Format results are returned in.","schema":{"type":"string","description":"Format results are returned in.","enum":["json","csv"],"example":"json"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"object","properties":{"meta":{"type":"object","properties":{"confidenceInfo":{"type":"object","properties":{"annotations":{"type":"array","items":{"type":"object","properties":{"dataSource":{"type":"string"},"description":{"type":"string"},"endTime":{"type":"string","format":"date-time","example":"2022-09-15T00:00:00Z"},"eventType":{"type":"string"},"startTime":{"type":"string","format":"date-time","example":"2022-09-15T00:00:00Z"}}}},"level":{"type":"integer"}}},"dateRange":{"type":"object","properties":{"endTime":{"type":"string","format":"date-time","example":"2022-09-15T00:00:00Z"},"startTime":{"type":"string","format":"date-time","example":"2022-09-15T00:00:00Z"}}}}},"top_0":{"type":"array","items":{"type":"object","properties":{"clientASN":{"type":"string","example":"3243"},"clientASName":{"type":"string","example":"MEO"},"value":{"type":"string","example":"3"}}}}}},"success":{"type":"boolean","example":true}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Not Found"}}}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/radar/http/top/ases/http_version/{http_version}":{"get":{"tags":["Radar Http"],"summary":"Get top autonomous systems by HTTP version","description":"Get the top autonomous systems (AS), by HTTP traffic, of the requested HTTP protocol version. Values are a percentage out of the total traffic.","operationId":"radar_get_HttpTopASesByHTTPVersion","parameters":[{"name":"http_version","in":"path","description":"HTTP version.","required":true,"schema":{"type":"string","description":"HTTP version.","enum":["HTTPv1","HTTPv2","HTTPv3"]}},{"name":"limit","in":"query","description":"Limit the number of objects in the response.","schema":{"type":"integer","description":"Limit the number of objects in the response.","default":5,"example":5}},{"name":"name","in":"query","description":"Array of names that will be used to name the series in responses.","schema":{"type":"array","items":{"type":"string","description":"Array of names that will be used to name the series in responses.","example":"main_series"}}},{"name":"dateRange","in":"query","description":"For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","schema":{"type":"array","items":{"type":"string","description":"For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","enum":["1d","7d","14d","28d","1dControl","7dControl","14dControl","28dControl"]}}},{"name":"dateStart","in":"query","description":"Array of datetimes to filter the start of a series.","schema":{"type":"array","items":{"type":"string","format":"date-time","example":"2022-09-15T00:00:00Z"}}},{"name":"dateEnd","in":"query","description":"Array of datetimes to filter the end of a series.","schema":{"type":"array","items":{"type":"string","format":"date-time","example":"2022-09-15T00:00:00Z"}}},{"name":"asn","in":"query","description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `[-174, 3356]` excludes results from AS174, but includes results from AS3356.","schema":{"type":"array","items":{"type":"string","description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `[-174, 3356]` excludes results from AS174, but includes results from AS3356.","example":"15169"}}},{"name":"location","in":"query","description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `[-US, PT]` excludes results from the US, but includes results from PT.","schema":{"type":"array","items":{"type":"string","description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `[-US, PT]` excludes results from the US, but includes results from PT.","example":"US,CA"}}},{"name":"botClass","in":"query","description":"Filter for bot class. Refer to [Bot Groupings](https://developers.cloudflare.com/bots/concepts/bot-score#bot-groupings)","schema":{"type":"array","items":{"type":"string","description":"Filter for bot class. Refer to [Bot Groupings](https://developers.cloudflare.com/bots/concepts/bot-score#bot-groupings)","enum":["LIKELY_AUTOMATED","LIKELY_HUMAN"],"example":"LIKELY_AUTOMATED"}}},{"name":"format","in":"query","description":"Format results are returned in.","schema":{"type":"string","description":"Format results are returned in.","enum":["json","csv"],"example":"json"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"object","properties":{"meta":{"type":"object","properties":{"confidenceInfo":{"type":"object","properties":{"annotations":{"type":"array","items":{"type":"object","properties":{"dataSource":{"type":"string"},"description":{"type":"string"},"endTime":{"type":"string","format":"date-time","example":"2022-09-15T00:00:00Z"},"eventType":{"type":"string"},"startTime":{"type":"string","format":"date-time","example":"2022-09-15T00:00:00Z"}}}},"level":{"type":"integer"}}},"dateRange":{"type":"object","properties":{"endTime":{"type":"string","format":"date-time","example":"2022-09-15T00:00:00Z"},"startTime":{"type":"string","format":"date-time","example":"2022-09-15T00:00:00Z"}}}}},"top_0":{"type":"array","items":{"type":"object","properties":{"clientASN":{"type":"string","example":"3243"},"clientASName":{"type":"string","example":"MEO"},"value":{"type":"string","example":"3"}}}}}},"success":{"type":"boolean","example":true}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Not Found"}}}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/radar/http/top/ases/ip_version/{ip_version}":{"get":{"tags":["Radar Http"],"summary":"Get top autonomous systems by IP version","description":"Get the top autonomous systems, by HTTP traffic, of the requested IP protocol version. Values are a percentage out of the total traffic.","operationId":"radar_get_HttpTopASesByIpVersion","parameters":[{"name":"ip_version","in":"path","description":"IP version.","required":true,"schema":{"type":"string","description":"IP version.","enum":["IPv4","IPv6"]}},{"name":"limit","in":"query","description":"Limit the number of objects in the response.","schema":{"type":"integer","description":"Limit the number of objects in the response.","default":5,"example":5}},{"name":"name","in":"query","description":"Array of names that will be used to name the series in responses.","schema":{"type":"array","items":{"type":"string","description":"Array of names that will be used to name the series in responses.","example":"main_series"}}},{"name":"dateRange","in":"query","description":"For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","schema":{"type":"array","items":{"type":"string","description":"For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","enum":["1d","7d","14d","28d","1dControl","7dControl","14dControl","28dControl"]}}},{"name":"dateStart","in":"query","description":"Array of datetimes to filter the start of a series.","schema":{"type":"array","items":{"type":"string","format":"date-time","example":"2022-09-15T00:00:00Z"}}},{"name":"dateEnd","in":"query","description":"Array of datetimes to filter the end of a series.","schema":{"type":"array","items":{"type":"string","format":"date-time","example":"2022-09-15T00:00:00Z"}}},{"name":"asn","in":"query","description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `[-174, 3356]` excludes results from AS174, but includes results from AS3356.","schema":{"type":"array","items":{"type":"string","description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `[-174, 3356]` excludes results from AS174, but includes results from AS3356.","example":"15169"}}},{"name":"location","in":"query","description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `[-US, PT]` excludes results from the US, but includes results from PT.","schema":{"type":"array","items":{"type":"string","description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `[-US, PT]` excludes results from the US, but includes results from PT.","example":"US,CA"}}},{"name":"botClass","in":"query","description":"Filter for bot class. Refer to [Bot Groupings](https://developers.cloudflare.com/bots/concepts/bot-score#bot-groupings)","schema":{"type":"array","items":{"type":"string","description":"Filter for bot class. Refer to [Bot Groupings](https://developers.cloudflare.com/bots/concepts/bot-score#bot-groupings)","enum":["LIKELY_AUTOMATED","LIKELY_HUMAN"],"example":"LIKELY_AUTOMATED"}}},{"name":"format","in":"query","description":"Format results are returned in.","schema":{"type":"string","description":"Format results are returned in.","enum":["json","csv"],"example":"json"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"object","properties":{"meta":{"type":"object","properties":{"confidenceInfo":{"type":"object","properties":{"annotations":{"type":"array","items":{"type":"object","properties":{"dataSource":{"type":"string"},"description":{"type":"string"},"endTime":{"type":"string","format":"date-time","example":"2022-09-15T00:00:00Z"},"eventType":{"type":"string"},"startTime":{"type":"string","format":"date-time","example":"2022-09-15T00:00:00Z"}}}},"level":{"type":"integer"}}},"dateRange":{"type":"object","properties":{"endTime":{"type":"string","format":"date-time","example":"2022-09-15T00:00:00Z"},"startTime":{"type":"string","format":"date-time","example":"2022-09-15T00:00:00Z"}}}}},"top_0":{"type":"array","items":{"type":"object","properties":{"clientASN":{"type":"string","example":"3243"},"clientASName":{"type":"string","example":"MEO"},"value":{"type":"string","example":"3"}}}}}},"success":{"type":"boolean","example":true}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Not Found"}}}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/radar/http/top/ases/tls_version/{tls_version}":{"get":{"tags":["Radar Http"],"summary":"Get top autonomous systems by TLS version","description":"Get the top autonomous systems (AS), by HTTP traffic, of the requested TLS protocol version. Values are a percentage out of the total traffic.","operationId":"radar_get_HttpTopASesByTLSVersion","parameters":[{"name":"tls_version","in":"path","description":"TLS version.","required":true,"schema":{"type":"string","description":"TLS version.","enum":["TLSv1_0","TLSv1_1","TLSv1_2","TLSv1_3","TLSvQUIC"]}},{"name":"limit","in":"query","description":"Limit the number of objects in the response.","schema":{"type":"integer","description":"Limit the number of objects in the response.","default":5,"example":5}},{"name":"name","in":"query","description":"Array of names that will be used to name the series in responses.","schema":{"type":"array","items":{"type":"string","description":"Array of names that will be used to name the series in responses.","example":"main_series"}}},{"name":"dateRange","in":"query","description":"For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","schema":{"type":"array","items":{"type":"string","description":"For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","enum":["1d","7d","14d","28d","1dControl","7dControl","14dControl","28dControl"]}}},{"name":"dateStart","in":"query","description":"Array of datetimes to filter the start of a series.","schema":{"type":"array","items":{"type":"string","format":"date-time","example":"2022-09-15T00:00:00Z"}}},{"name":"dateEnd","in":"query","description":"Array of datetimes to filter the end of a series.","schema":{"type":"array","items":{"type":"string","format":"date-time","example":"2022-09-15T00:00:00Z"}}},{"name":"asn","in":"query","description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `[-174, 3356]` excludes results from AS174, but includes results from AS3356.","schema":{"type":"array","items":{"type":"string","description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `[-174, 3356]` excludes results from AS174, but includes results from AS3356.","example":"15169"}}},{"name":"location","in":"query","description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `[-US, PT]` excludes results from the US, but includes results from PT.","schema":{"type":"array","items":{"type":"string","description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `[-US, PT]` excludes results from the US, but includes results from PT.","example":"US,CA"}}},{"name":"botClass","in":"query","description":"Filter for bot class. Refer to [Bot Groupings](https://developers.cloudflare.com/bots/concepts/bot-score#bot-groupings)","schema":{"type":"array","items":{"type":"string","description":"Filter for bot class. Refer to [Bot Groupings](https://developers.cloudflare.com/bots/concepts/bot-score#bot-groupings)","enum":["LIKELY_AUTOMATED","LIKELY_HUMAN"],"example":"LIKELY_AUTOMATED"}}},{"name":"format","in":"query","description":"Format results are returned in.","schema":{"type":"string","description":"Format results are returned in.","enum":["json","csv"],"example":"json"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"object","properties":{"meta":{"type":"object","properties":{"confidenceInfo":{"type":"object","properties":{"annotations":{"type":"array","items":{"type":"object","properties":{"dataSource":{"type":"string"},"description":{"type":"string"},"endTime":{"type":"string","format":"date-time","example":"2022-09-15T00:00:00Z"},"eventType":{"type":"string"},"startTime":{"type":"string","format":"date-time","example":"2022-09-15T00:00:00Z"}}}},"level":{"type":"integer"}}},"dateRange":{"type":"object","properties":{"endTime":{"type":"string","format":"date-time","example":"2022-09-15T00:00:00Z"},"startTime":{"type":"string","format":"date-time","example":"2022-09-15T00:00:00Z"}}}}},"top_0":{"type":"array","items":{"type":"object","properties":{"clientASN":{"type":"string","example":"3243"},"clientASName":{"type":"string","example":"MEO"},"value":{"type":"string","example":"3"}}}}}},"success":{"type":"boolean","example":true}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Not Found"}}}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/radar/http/top/browser_families":{"get":{"tags":["Radar Http"],"summary":"Get top user agents aggregated in families by HTTP requests","description":"Get the top user agents aggregated in families by HTTP traffic. Values are a percentage out of the total traffic.","operationId":"radar_get_HttpTopBrowserFamilies","parameters":[{"name":"limit","in":"query","description":"Limit the number of objects in the response.","schema":{"type":"integer","description":"Limit the number of objects in the response.","default":5,"example":5}},{"name":"name","in":"query","description":"Array of names that will be used to name the series in responses.","schema":{"type":"array","items":{"type":"string","description":"Array of names that will be used to name the series in responses.","example":"main_series"}}},{"name":"dateRange","in":"query","description":"For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","schema":{"type":"array","items":{"type":"string","description":"For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","enum":["1d","7d","14d","28d","1dControl","7dControl","14dControl","28dControl"]}}},{"name":"dateStart","in":"query","description":"Array of datetimes to filter the start of a series.","schema":{"type":"array","items":{"type":"string","format":"date-time","example":"2022-09-15T00:00:00Z"}}},{"name":"dateEnd","in":"query","description":"Array of datetimes to filter the end of a series.","schema":{"type":"array","items":{"type":"string","format":"date-time","example":"2022-09-15T00:00:00Z"}}},{"name":"asn","in":"query","description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `[-174, 3356]` excludes results from AS174, but includes results from AS3356.","schema":{"type":"array","items":{"type":"string","description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `[-174, 3356]` excludes results from AS174, but includes results from AS3356.","example":"15169"}}},{"name":"location","in":"query","description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `[-US, PT]` excludes results from the US, but includes results from PT.","schema":{"type":"array","items":{"type":"string","description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `[-US, PT]` excludes results from the US, but includes results from PT.","example":"US,CA"}}},{"name":"botClass","in":"query","description":"Filter for bot class. Refer to [Bot Groupings](https://developers.cloudflare.com/bots/concepts/bot-score#bot-groupings)","schema":{"type":"array","items":{"type":"string","description":"Filter for bot class. Refer to [Bot Groupings](https://developers.cloudflare.com/bots/concepts/bot-score#bot-groupings)","enum":["LIKELY_AUTOMATED","LIKELY_HUMAN"],"example":"LIKELY_AUTOMATED"}}},{"name":"format","in":"query","description":"Format results are returned in.","schema":{"type":"string","description":"Format results are returned in.","enum":["json","csv"],"example":"json"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"object","properties":{"meta":{"type":"object","properties":{"confidenceInfo":{"type":"object","properties":{"annotations":{"type":"array","items":{"type":"object","properties":{"dataSource":{"type":"string"},"description":{"type":"string"},"endTime":{"type":"string","format":"date-time","example":"2022-09-15T00:00:00Z"},"eventType":{"type":"string"},"startTime":{"type":"string","format":"date-time","example":"2022-09-15T00:00:00Z"}}}},"level":{"type":"integer"}}},"dateRange":{"type":"object","properties":{"endTime":{"type":"string","format":"date-time","example":"2022-09-15T00:00:00Z"},"startTime":{"type":"string","format":"date-time","example":"2022-09-15T00:00:00Z"}}}}},"top_0":{"type":"array","items":{"type":"object","properties":{"<browser name>":{"type":"string"},"value":{"type":"string"}}}}}},"success":{"type":"boolean","example":true}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Not Found"}}}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/radar/http/top/browsers":{"get":{"tags":["Radar Http"],"summary":"Get top user agents by HTTP requests","description":"Get the top user agents by HTTP traffic. Values are a percentage out of the total traffic.","operationId":"radar_get_HttpTopBrowsers","parameters":[{"name":"limit","in":"query","description":"Limit the number of objects in the response.","schema":{"type":"integer","description":"Limit the number of objects in the response.","default":5,"example":5}},{"name":"name","in":"query","description":"Array of names that will be used to name the series in responses.","schema":{"type":"array","items":{"type":"string","description":"Array of names that will be used to name the series in responses.","example":"main_series"}}},{"name":"dateRange","in":"query","description":"For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","schema":{"type":"array","items":{"type":"string","description":"For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","enum":["1d","7d","14d","28d","1dControl","7dControl","14dControl","28dControl"]}}},{"name":"dateStart","in":"query","description":"Array of datetimes to filter the start of a series.","schema":{"type":"array","items":{"type":"string","format":"date-time","example":"2022-09-15T00:00:00Z"}}},{"name":"dateEnd","in":"query","description":"Array of datetimes to filter the end of a series.","schema":{"type":"array","items":{"type":"string","format":"date-time","example":"2022-09-15T00:00:00Z"}}},{"name":"asn","in":"query","description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `[-174, 3356]` excludes results from AS174, but includes results from AS3356.","schema":{"type":"array","items":{"type":"string","description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `[-174, 3356]` excludes results from AS174, but includes results from AS3356.","example":"15169"}}},{"name":"location","in":"query","description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `[-US, PT]` excludes results from the US, but includes results from PT.","schema":{"type":"array","items":{"type":"string","description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `[-US, PT]` excludes results from the US, but includes results from PT.","example":"US,CA"}}},{"name":"botClass","in":"query","description":"Filter for bot class. Refer to [Bot Groupings](https://developers.cloudflare.com/bots/concepts/bot-score#bot-groupings)","schema":{"type":"array","items":{"type":"string","description":"Filter for bot class. Refer to [Bot Groupings](https://developers.cloudflare.com/bots/concepts/bot-score#bot-groupings)","enum":["LIKELY_AUTOMATED","LIKELY_HUMAN"],"example":"LIKELY_AUTOMATED"}}},{"name":"format","in":"query","description":"Format results are returned in.","schema":{"type":"string","description":"Format results are returned in.","enum":["json","csv"],"example":"json"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"object","properties":{"meta":{"type":"object","properties":{"confidenceInfo":{"type":"object","properties":{"annotations":{"type":"array","items":{"type":"object","properties":{"dataSource":{"type":"string"},"description":{"type":"string"},"endTime":{"type":"string","format":"date-time","example":"2022-09-15T00:00:00Z"},"eventType":{"type":"string"},"startTime":{"type":"string","format":"date-time","example":"2022-09-15T00:00:00Z"}}}},"level":{"type":"integer"}}},"dateRange":{"type":"object","properties":{"endTime":{"type":"string","format":"date-time","example":"2022-09-15T00:00:00Z"},"startTime":{"type":"string","format":"date-time","example":"2022-09-15T00:00:00Z"}}}}},"top_0":{"type":"array","items":{"type":"object","properties":{"<browser name>":{"type":"string"},"value":{"type":"string"}}}}}},"success":{"type":"boolean","example":true}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Not Found"}}}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/radar/http/top/locations":{"get":{"tags":["Radar Http"],"summary":"Get top locations by HTTP requests","description":"Get the top locations by HTTP traffic. Values are a percentage out of the total traffic.","operationId":"radar_get_HttpTopLocations","parameters":[{"name":"limit","in":"query","description":"Limit the number of objects in the response.","schema":{"type":"integer","description":"Limit the number of objects in the response.","default":5,"example":5}},{"name":"name","in":"query","description":"Array of names that will be used to name the series in responses.","schema":{"type":"array","items":{"type":"string","description":"Array of names that will be used to name the series in responses.","example":"main_series"}}},{"name":"dateRange","in":"query","description":"For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","schema":{"type":"array","items":{"type":"string","description":"For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","enum":["1d","7d","14d","28d","1dControl","7dControl","14dControl","28dControl"]}}},{"name":"dateStart","in":"query","description":"Array of datetimes to filter the start of a series.","schema":{"type":"array","items":{"type":"string","format":"date-time","example":"2022-09-15T00:00:00Z"}}},{"name":"dateEnd","in":"query","description":"Array of datetimes to filter the end of a series.","schema":{"type":"array","items":{"type":"string","format":"date-time","example":"2022-09-15T00:00:00Z"}}},{"name":"asn","in":"query","description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `[-174, 3356]` excludes results from AS174, but includes results from AS3356.","schema":{"type":"array","items":{"type":"string","description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `[-174, 3356]` excludes results from AS174, but includes results from AS3356.","example":"15169"}}},{"name":"location","in":"query","description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `[-US, PT]` excludes results from the US, but includes results from PT.","schema":{"type":"array","items":{"type":"string","description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `[-US, PT]` excludes results from the US, but includes results from PT.","example":"US,CA"}}},{"name":"botClass","in":"query","description":"Filter for bot class. Refer to [Bot Groupings](https://developers.cloudflare.com/bots/concepts/bot-score#bot-groupings)","schema":{"type":"array","items":{"type":"string","description":"Filter for bot class. Refer to [Bot Groupings](https://developers.cloudflare.com/bots/concepts/bot-score#bot-groupings)","enum":["LIKELY_AUTOMATED","LIKELY_HUMAN"],"example":"LIKELY_AUTOMATED"}}},{"name":"format","in":"query","description":"Format results are returned in.","schema":{"type":"string","description":"Format results are returned in.","enum":["json","csv"],"example":"json"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"object","properties":{"meta":{"type":"object","properties":{"confidenceInfo":{"type":"object","properties":{"annotations":{"type":"array","items":{"type":"object","properties":{"dataSource":{"type":"string"},"description":{"type":"string"},"endTime":{"type":"string","format":"date-time","example":"2022-09-15T00:00:00Z"},"eventType":{"type":"string"},"startTime":{"type":"string","format":"date-time","example":"2022-09-15T00:00:00Z"}}}},"level":{"type":"integer"}}},"dateRange":{"type":"object","properties":{"endTime":{"type":"string","format":"date-time","example":"2022-09-15T00:00:00Z"},"startTime":{"type":"string","format":"date-time","example":"2022-09-15T00:00:00Z"}}}}},"top_0":{"type":"array","items":{"type":"object","properties":{"clientCountryAlpha2":{"type":"string","example":"US"},"clientCountryName":{"type":"string","example":"United States"},"value":{"type":"string","example":"65"}}}}}},"success":{"type":"boolean","example":true}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Not Found"}}}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/radar/http/top/locations/bot_class/{bot_class}":{"get":{"tags":["Radar Http"],"summary":"Get top locations by bot class","description":"Get the top locations, by HTTP traffic, of the requested bot class. These two categories use Cloudflare's bot score - refer to [Bot scores])https://developers.cloudflare.com/bots/concepts/bot-score). Values are a percentage out of the total traffic.","operationId":"radar_get_HttpTopLocationsByBotClass","parameters":[{"name":"bot_class","in":"path","description":"Bot class.","required":true,"schema":{"type":"string","description":"Bot class.","enum":["LIKELY_AUTOMATED","LIKELY_HUMAN"]}},{"name":"limit","in":"query","description":"Limit the number of objects in the response.","schema":{"type":"integer","description":"Limit the number of objects in the response.","default":5,"example":5}},{"name":"name","in":"query","description":"Array of names that will be used to name the series in responses.","schema":{"type":"array","items":{"type":"string","description":"Array of names that will be used to name the series in responses.","example":"main_series"}}},{"name":"dateRange","in":"query","description":"For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","schema":{"type":"array","items":{"type":"string","description":"For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","enum":["1d","7d","14d","28d","1dControl","7dControl","14dControl","28dControl"]}}},{"name":"dateStart","in":"query","description":"Array of datetimes to filter the start of a series.","schema":{"type":"array","items":{"type":"string","format":"date-time","example":"2022-09-15T00:00:00Z"}}},{"name":"dateEnd","in":"query","description":"Array of datetimes to filter the end of a series.","schema":{"type":"array","items":{"type":"string","format":"date-time","example":"2022-09-15T00:00:00Z"}}},{"name":"asn","in":"query","description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `[-174, 3356]` excludes results from AS174, but includes results from AS3356.","schema":{"type":"array","items":{"type":"string","description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `[-174, 3356]` excludes results from AS174, but includes results from AS3356.","example":"15169"}}},{"name":"location","in":"query","description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `[-US, PT]` excludes results from the US, but includes results from PT.","schema":{"type":"array","items":{"type":"string","description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `[-US, PT]` excludes results from the US, but includes results from PT.","example":"US,CA"}}},{"name":"format","in":"query","description":"Format results are returned in.","schema":{"type":"string","description":"Format results are returned in.","enum":["json","csv"],"example":"json"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"object","properties":{"meta":{"type":"object","properties":{"confidenceInfo":{"type":"object","properties":{"annotations":{"type":"array","items":{"type":"object","properties":{"dataSource":{"type":"string"},"description":{"type":"string"},"endTime":{"type":"string","format":"date-time","example":"2022-09-15T00:00:00Z"},"eventType":{"type":"string"},"startTime":{"type":"string","format":"date-time","example":"2022-09-15T00:00:00Z"}}}},"level":{"type":"integer"}}},"dateRange":{"type":"object","properties":{"endTime":{"type":"string","format":"date-time","example":"2022-09-15T00:00:00Z"},"startTime":{"type":"string","format":"date-time","example":"2022-09-15T00:00:00Z"}}}}},"top_0":{"type":"array","items":{"type":"object","properties":{"clientCountryAlpha2":{"type":"string","example":"US"},"clientCountryName":{"type":"string","example":"United States"},"value":{"type":"string","example":"65"}}}}}},"success":{"type":"boolean","example":true}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Not Found"}}}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/radar/http/top/locations/device_type/{device_type}":{"get":{"tags":["Radar Http"],"summary":"Get top locations by device type","description":"Get the top locations, by HTTP traffic, of the requested device type. Values are a percentage out of the total traffic.","operationId":"radar_get_HttpTopLocationsByDeviceType","parameters":[{"name":"device_type","in":"path","description":"Device type.","required":true,"schema":{"type":"string","description":"Device type.","enum":["DESKTOP","MOBILE","OTHER"]}},{"name":"limit","in":"query","description":"Limit the number of objects in the response.","schema":{"type":"integer","description":"Limit the number of objects in the response.","default":5,"example":5}},{"name":"name","in":"query","description":"Array of names that will be used to name the series in responses.","schema":{"type":"array","items":{"type":"string","description":"Array of names that will be used to name the series in responses.","example":"main_series"}}},{"name":"dateRange","in":"query","description":"For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","schema":{"type":"array","items":{"type":"string","description":"For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","enum":["1d","7d","14d","28d","1dControl","7dControl","14dControl","28dControl"]}}},{"name":"dateStart","in":"query","description":"Array of datetimes to filter the start of a series.","schema":{"type":"array","items":{"type":"string","format":"date-time","example":"2022-09-15T00:00:00Z"}}},{"name":"dateEnd","in":"query","description":"Array of datetimes to filter the end of a series.","schema":{"type":"array","items":{"type":"string","format":"date-time","example":"2022-09-15T00:00:00Z"}}},{"name":"asn","in":"query","description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `[-174, 3356]` excludes results from AS174, but includes results from AS3356.","schema":{"type":"array","items":{"type":"string","description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `[-174, 3356]` excludes results from AS174, but includes results from AS3356.","example":"15169"}}},{"name":"location","in":"query","description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `[-US, PT]` excludes results from the US, but includes results from PT.","schema":{"type":"array","items":{"type":"string","description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `[-US, PT]` excludes results from the US, but includes results from PT.","example":"US,CA"}}},{"name":"botClass","in":"query","description":"Filter for bot class. Refer to [Bot Groupings](https://developers.cloudflare.com/bots/concepts/bot-score#bot-groupings)","schema":{"type":"array","items":{"type":"string","description":"Filter for bot class. Refer to [Bot Groupings](https://developers.cloudflare.com/bots/concepts/bot-score#bot-groupings)","enum":["LIKELY_AUTOMATED","LIKELY_HUMAN"],"example":"LIKELY_AUTOMATED"}}},{"name":"format","in":"query","description":"Format results are returned in.","schema":{"type":"string","description":"Format results are returned in.","enum":["json","csv"],"example":"json"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"object","properties":{"meta":{"type":"object","properties":{"confidenceInfo":{"type":"object","properties":{"annotations":{"type":"array","items":{"type":"object","properties":{"dataSource":{"type":"string"},"description":{"type":"string"},"endTime":{"type":"string","format":"date-time","example":"2022-09-15T00:00:00Z"},"eventType":{"type":"string"},"startTime":{"type":"string","format":"date-time","example":"2022-09-15T00:00:00Z"}}}},"level":{"type":"integer"}}},"dateRange":{"type":"object","properties":{"endTime":{"type":"string","format":"date-time","example":"2022-09-15T00:00:00Z"},"startTime":{"type":"string","format":"date-time","example":"2022-09-15T00:00:00Z"}}}}},"top_0":{"type":"array","items":{"type":"object","properties":{"clientCountryAlpha2":{"type":"string","example":"US"},"clientCountryName":{"type":"string","example":"United States"},"value":{"type":"string","example":"65"}}}}}},"success":{"type":"boolean","example":true}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Not Found"}}}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/radar/http/top/locations/http_protocol/{http_protocol}":{"get":{"tags":["Radar Http"],"summary":"Get top locations by HTTP protocol","description":"Get the top locations, by HTTP traffic, of the requested HTTP protocol. Values are a percentage out of the total traffic.","operationId":"radar_get_HttpTopLocationsByHTTPProtocol","parameters":[{"name":"http_protocol","in":"path","description":"HTTP Protocol.","required":true,"schema":{"type":"string","description":"HTTP Protocol.","enum":["HTTP","HTTPS"]}},{"name":"limit","in":"query","description":"Limit the number of objects in the response.","schema":{"type":"integer","description":"Limit the number of objects in the response.","default":5,"example":5}},{"name":"name","in":"query","description":"Array of names that will be used to name the series in responses.","schema":{"type":"array","items":{"type":"string","description":"Array of names that will be used to name the series in responses.","example":"main_series"}}},{"name":"dateRange","in":"query","description":"For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","schema":{"type":"array","items":{"type":"string","description":"For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","enum":["1d","7d","14d","28d","1dControl","7dControl","14dControl","28dControl"]}}},{"name":"dateStart","in":"query","description":"Array of datetimes to filter the start of a series.","schema":{"type":"array","items":{"type":"string","format":"date-time","example":"2022-09-15T00:00:00Z"}}},{"name":"dateEnd","in":"query","description":"Array of datetimes to filter the end of a series.","schema":{"type":"array","items":{"type":"string","format":"date-time","example":"2022-09-15T00:00:00Z"}}},{"name":"asn","in":"query","description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `[-174, 3356]` excludes results from AS174, but includes results from AS3356.","schema":{"type":"array","items":{"type":"string","description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `[-174, 3356]` excludes results from AS174, but includes results from AS3356.","example":"15169"}}},{"name":"location","in":"query","description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `[-US, PT]` excludes results from the US, but includes results from PT.","schema":{"type":"array","items":{"type":"string","description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `[-US, PT]` excludes results from the US, but includes results from PT.","example":"US,CA"}}},{"name":"botClass","in":"query","description":"Filter for bot class. Refer to [Bot Groupings](https://developers.cloudflare.com/bots/concepts/bot-score#bot-groupings)","schema":{"type":"array","items":{"type":"string","description":"Filter for bot class. Refer to [Bot Groupings](https://developers.cloudflare.com/bots/concepts/bot-score#bot-groupings)","enum":["LIKELY_AUTOMATED","LIKELY_HUMAN"],"example":"LIKELY_AUTOMATED"}}},{"name":"format","in":"query","description":"Format results are returned in.","schema":{"type":"string","description":"Format results are returned in.","enum":["json","csv"],"example":"json"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"object","properties":{"meta":{"type":"object","properties":{"confidenceInfo":{"type":"object","properties":{"annotations":{"type":"array","items":{"type":"object","properties":{"dataSource":{"type":"string"},"description":{"type":"string"},"endTime":{"type":"string","format":"date-time","example":"2022-09-15T00:00:00Z"},"eventType":{"type":"string"},"startTime":{"type":"string","format":"date-time","example":"2022-09-15T00:00:00Z"}}}},"level":{"type":"integer"}}},"dateRange":{"type":"object","properties":{"endTime":{"type":"string","format":"date-time","example":"2022-09-15T00:00:00Z"},"startTime":{"type":"string","format":"date-time","example":"2022-09-15T00:00:00Z"}}}}},"top_0":{"type":"array","items":{"type":"object","properties":{"clientCountryAlpha2":{"type":"string","example":"US"},"clientCountryName":{"type":"string","example":"United States"},"value":{"type":"string","example":"65"}}}}}},"success":{"type":"boolean","example":true}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Not Found"}}}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/radar/http/top/locations/http_version/{http_version}":{"get":{"tags":["Radar Http"],"summary":"Get top locations by HTTP version","description":"Get the top locations, by HTTP traffic, of the requested HTTP protocol. Values are a percentage out of the total traffic.","operationId":"radar_get_HttpTopLocationsByHTTPVersion","parameters":[{"name":"http_version","in":"path","description":"HTTP version.","required":true,"schema":{"type":"string","description":"HTTP version.","enum":["HTTPv1","HTTPv2","HTTPv3"]}},{"name":"limit","in":"query","description":"Limit the number of objects in the response.","schema":{"type":"integer","description":"Limit the number of objects in the response.","default":5,"example":5}},{"name":"name","in":"query","description":"Array of names that will be used to name the series in responses.","schema":{"type":"array","items":{"type":"string","description":"Array of names that will be used to name the series in responses.","example":"main_series"}}},{"name":"dateRange","in":"query","description":"For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","schema":{"type":"array","items":{"type":"string","description":"For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","enum":["1d","7d","14d","28d","1dControl","7dControl","14dControl","28dControl"]}}},{"name":"dateStart","in":"query","description":"Array of datetimes to filter the start of a series.","schema":{"type":"array","items":{"type":"string","format":"date-time","example":"2022-09-15T00:00:00Z"}}},{"name":"dateEnd","in":"query","description":"Array of datetimes to filter the end of a series.","schema":{"type":"array","items":{"type":"string","format":"date-time","example":"2022-09-15T00:00:00Z"}}},{"name":"asn","in":"query","description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `[-174, 3356]` excludes results from AS174, but includes results from AS3356.","schema":{"type":"array","items":{"type":"string","description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `[-174, 3356]` excludes results from AS174, but includes results from AS3356.","example":"15169"}}},{"name":"location","in":"query","description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `[-US, PT]` excludes results from the US, but includes results from PT.","schema":{"type":"array","items":{"type":"string","description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `[-US, PT]` excludes results from the US, but includes results from PT.","example":"US,CA"}}},{"name":"botClass","in":"query","description":"Filter for bot class. Refer to [Bot Groupings](https://developers.cloudflare.com/bots/concepts/bot-score#bot-groupings)","schema":{"type":"array","items":{"type":"string","description":"Filter for bot class. Refer to [Bot Groupings](https://developers.cloudflare.com/bots/concepts/bot-score#bot-groupings)","enum":["LIKELY_AUTOMATED","LIKELY_HUMAN"],"example":"LIKELY_AUTOMATED"}}},{"name":"format","in":"query","description":"Format results are returned in.","schema":{"type":"string","description":"Format results are returned in.","enum":["json","csv"],"example":"json"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"object","properties":{"meta":{"type":"object","properties":{"confidenceInfo":{"type":"object","properties":{"annotations":{"type":"array","items":{"type":"object","properties":{"dataSource":{"type":"string"},"description":{"type":"string"},"endTime":{"type":"string","format":"date-time","example":"2022-09-15T00:00:00Z"},"eventType":{"type":"string"},"startTime":{"type":"string","format":"date-time","example":"2022-09-15T00:00:00Z"}}}},"level":{"type":"integer"}}},"dateRange":{"type":"object","properties":{"endTime":{"type":"string","format":"date-time","example":"2022-09-15T00:00:00Z"},"startTime":{"type":"string","format":"date-time","example":"2022-09-15T00:00:00Z"}}}}},"top_0":{"type":"array","items":{"type":"object","properties":{"clientCountryAlpha2":{"type":"string","example":"US"},"clientCountryName":{"type":"string","example":"United States"},"value":{"type":"string","example":"65"}}}}}},"success":{"type":"boolean","example":true}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Not Found"}}}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/radar/http/top/locations/ip_version/{ip_version}":{"get":{"tags":["Radar Http"],"summary":"Get top locations by IP version","description":"Get the top locations, by HTTP traffic, of the requested IP protocol version. Values are a percentage out of the total traffic.","operationId":"radar_get_HttpTopLocationsByIpVersion","parameters":[{"name":"ip_version","in":"path","description":"IP version.","required":true,"schema":{"type":"string","description":"IP version.","enum":["IPv4","IPv6"]}},{"name":"limit","in":"query","description":"Limit the number of objects in the response.","schema":{"type":"integer","description":"Limit the number of objects in the response.","default":5,"example":5}},{"name":"name","in":"query","description":"Array of names that will be used to name the series in responses.","schema":{"type":"array","items":{"type":"string","description":"Array of names that will be used to name the series in responses.","example":"main_series"}}},{"name":"dateRange","in":"query","description":"For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","schema":{"type":"array","items":{"type":"string","description":"For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","enum":["1d","7d","14d","28d","1dControl","7dControl","14dControl","28dControl"]}}},{"name":"dateStart","in":"query","description":"Array of datetimes to filter the start of a series.","schema":{"type":"array","items":{"type":"string","format":"date-time","example":"2022-09-15T00:00:00Z"}}},{"name":"dateEnd","in":"query","description":"Array of datetimes to filter the end of a series.","schema":{"type":"array","items":{"type":"string","format":"date-time","example":"2022-09-15T00:00:00Z"}}},{"name":"asn","in":"query","description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `[-174, 3356]` excludes results from AS174, but includes results from AS3356.","schema":{"type":"array","items":{"type":"string","description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `[-174, 3356]` excludes results from AS174, but includes results from AS3356.","example":"15169"}}},{"name":"location","in":"query","description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `[-US, PT]` excludes results from the US, but includes results from PT.","schema":{"type":"array","items":{"type":"string","description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `[-US, PT]` excludes results from the US, but includes results from PT.","example":"US,CA"}}},{"name":"botClass","in":"query","description":"Filter for bot class. Refer to [Bot Groupings](https://developers.cloudflare.com/bots/concepts/bot-score#bot-groupings)","schema":{"type":"array","items":{"type":"string","description":"Filter for bot class. Refer to [Bot Groupings](https://developers.cloudflare.com/bots/concepts/bot-score#bot-groupings)","enum":["LIKELY_AUTOMATED","LIKELY_HUMAN"],"example":"LIKELY_AUTOMATED"}}},{"name":"format","in":"query","description":"Format results are returned in.","schema":{"type":"string","description":"Format results are returned in.","enum":["json","csv"],"example":"json"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"object","properties":{"meta":{"type":"object","properties":{"confidenceInfo":{"type":"object","properties":{"annotations":{"type":"array","items":{"type":"object","properties":{"dataSource":{"type":"string"},"description":{"type":"string"},"endTime":{"type":"string","format":"date-time","example":"2022-09-15T00:00:00Z"},"eventType":{"type":"string"},"startTime":{"type":"string","format":"date-time","example":"2022-09-15T00:00:00Z"}}}},"level":{"type":"integer"}}},"dateRange":{"type":"object","properties":{"endTime":{"type":"string","format":"date-time","example":"2022-09-15T00:00:00Z"},"startTime":{"type":"string","format":"date-time","example":"2022-09-15T00:00:00Z"}}}}},"top_0":{"type":"array","items":{"type":"object","properties":{"clientCountryAlpha2":{"type":"string","example":"US"},"clientCountryName":{"type":"string","example":"United States"},"value":{"type":"string","example":"65"}}}}}},"success":{"type":"boolean","example":true}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Not Found"}}}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/radar/http/top/locations/tls_version/{tls_version}":{"get":{"tags":["Radar Http"],"summary":"Get top locations by TLS version","description":"Get the top locations, by HTTP traffic, of the requested TLS protocol version. Values are a percentage out of the total traffic.","operationId":"radar_get_HttpTopLocationsByTLSVersion","parameters":[{"name":"tls_version","in":"path","description":"TLS version.","required":true,"schema":{"type":"string","description":"TLS version.","enum":["TLSv1_0","TLSv1_1","TLSv1_2","TLSv1_3","TLSvQUIC"]}},{"name":"limit","in":"query","description":"Limit the number of objects in the response.","schema":{"type":"integer","description":"Limit the number of objects in the response.","default":5,"example":5}},{"name":"name","in":"query","description":"Array of names that will be used to name the series in responses.","schema":{"type":"array","items":{"type":"string","description":"Array of names that will be used to name the series in responses.","example":"main_series"}}},{"name":"dateRange","in":"query","description":"For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","schema":{"type":"array","items":{"type":"string","description":"For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","enum":["1d","7d","14d","28d","1dControl","7dControl","14dControl","28dControl"]}}},{"name":"dateStart","in":"query","description":"Array of datetimes to filter the start of a series.","schema":{"type":"array","items":{"type":"string","format":"date-time","example":"2022-09-15T00:00:00Z"}}},{"name":"dateEnd","in":"query","description":"Array of datetimes to filter the end of a series.","schema":{"type":"array","items":{"type":"string","format":"date-time","example":"2022-09-15T00:00:00Z"}}},{"name":"asn","in":"query","description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `[-174, 3356]` excludes results from AS174, but includes results from AS3356.","schema":{"type":"array","items":{"type":"string","description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `[-174, 3356]` excludes results from AS174, but includes results from AS3356.","example":"15169"}}},{"name":"location","in":"query","description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `[-US, PT]` excludes results from the US, but includes results from PT.","schema":{"type":"array","items":{"type":"string","description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `[-US, PT]` excludes results from the US, but includes results from PT.","example":"US,CA"}}},{"name":"botClass","in":"query","description":"Filter for bot class. Refer to [Bot Groupings](https://developers.cloudflare.com/bots/concepts/bot-score#bot-groupings)","schema":{"type":"array","items":{"type":"string","description":"Filter for bot class. Refer to [Bot Groupings](https://developers.cloudflare.com/bots/concepts/bot-score#bot-groupings)","enum":["LIKELY_AUTOMATED","LIKELY_HUMAN"],"example":"LIKELY_AUTOMATED"}}},{"name":"format","in":"query","description":"Format results are returned in.","schema":{"type":"string","description":"Format results are returned in.","enum":["json","csv"],"example":"json"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"object","properties":{"meta":{"type":"object","properties":{"confidenceInfo":{"type":"object","properties":{"annotations":{"type":"array","items":{"type":"object","properties":{"dataSource":{"type":"string"},"description":{"type":"string"},"endTime":{"type":"string","format":"date-time","example":"2022-09-15T00:00:00Z"},"eventType":{"type":"string"},"startTime":{"type":"string","format":"date-time","example":"2022-09-15T00:00:00Z"}}}},"level":{"type":"integer"}}},"dateRange":{"type":"object","properties":{"endTime":{"type":"string","format":"date-time","example":"2022-09-15T00:00:00Z"},"startTime":{"type":"string","format":"date-time","example":"2022-09-15T00:00:00Z"}}}}},"top_0":{"type":"array","items":{"type":"object","properties":{"clientCountryAlpha2":{"type":"string","example":"US"},"clientCountryName":{"type":"string","example":"United States"},"value":{"type":"string","example":"65"}}}}}},"success":{"type":"boolean","example":true}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Not Found"}}}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/radar/netflows/timeseries":{"get":{"tags":["Radar Netflows"],"summary":"Get NetFlow time series","description":"Get network traffic change over time. Values are normalized using min-max by default, with the minimum set to 0. When asking for multiple time series, you can also get the percentage relative change of the first/main series, with respect to the second/control series - for example, to get the relative change of this week from the previous week, the first series would have a date range of `7d`, the second, a date range of `7dControl`, and the normalization would be set to `PERCENTAGE_CHANGE`.","operationId":"radar_get_Timeseries","parameters":[{"name":"aggInterval","in":"query","description":"Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals).","schema":{"type":"string","description":"Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals).","enum":["15m","1h","1d"],"example":"1h"}},{"name":"name","in":"query","description":"Array of names that will be used to name the series in responses.","schema":{"type":"array","items":{"type":"string","description":"Array of names that will be used to name the series in responses.","example":"main_series"}}},{"name":"dateRange","in":"query","description":"For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","schema":{"type":"array","items":{"type":"string","description":"For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","enum":["1d","7d","14d","28d","1dControl","7dControl","14dControl","28dControl"]}}},{"name":"dateStart","in":"query","description":"Array of datetimes to filter the start of a series.","schema":{"type":"array","items":{"type":"string","format":"date-time","example":"2022-09-15T00:00:00Z"}}},{"name":"dateEnd","in":"query","description":"Array of datetimes to filter the end of a series.","schema":{"type":"array","items":{"type":"string","format":"date-time","example":"2022-09-15T00:00:00Z"}}},{"name":"product","in":"query","description":"Array of network traffic product types.","schema":{"type":"array","items":{"type":"string","description":"Array of network traffic product types.","enum":["http","all"],"example":"all"}}},{"name":"asn","in":"query","description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `[-174, 3356]` excludes results from AS174, but includes results from AS3356.","schema":{"type":"array","items":{"type":"string","description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `[-174, 3356]` excludes results from AS174, but includes results from AS3356.","example":"15169"}}},{"name":"location","in":"query","description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `[-US, PT]` excludes results from the US, but includes results from PT.","schema":{"type":"array","items":{"type":"string","description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `[-US, PT]` excludes results from the US, but includes results from PT.","example":"US,CA"}}},{"name":"normalization","in":"query","description":"Normalization method applied.","schema":{"type":"string","description":"Normalization method applied.","enum":["PERCENTAGE_CHANGE","MIN0_MAX"],"example":"MIN0_MAX"}},{"name":"format","in":"query","description":"Format results are returned in.","schema":{"type":"string","description":"Format results are returned in.","enum":["json","csv"],"example":"json"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"object","properties":{"meta":{"type":"object","properties":{"aggInterval":{"type":"string","example":"1h"},"confidenceInfo":{"type":"object","properties":{"annotations":{"type":"array","items":{"type":"object","properties":{"dataSource":{"type":"string","example":"ALL"},"description":{"type":"string","example":"Cable cut in Tonga"},"endTime":{"type":"string","format":"date-time","example":"2022-09-15T00:00:00Z"},"eventType":{"type":"string","example":"OUTAGE"},"startTime":{"type":"string","format":"date-time","example":"2022-09-15T00:00:00Z"}}}},"level":{"type":"integer"}}},"dateRange":{"type":"object","properties":{"endTime":{"type":"string","format":"date-time","description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z"},"startTime":{"type":"string","format":"date-time","description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z"}}},"lastUpdated":{"type":"string","format":"date-time","example":"2022-09-15T00:00:00Z"}}},"series":{"type":"object","properties":{"timestamps":{"type":"array","items":{"type":"string","format":"date-time","example":"2022-09-15T00:00:00Z"}},"values":{"type":"array","items":{"type":"string","example":0.56}}}}}},"success":{"type":"boolean","example":true}}}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/radar/netflows/top/ases":{"get":{"tags":["Radar Netflows"],"summary":"Get top autonomous systems","description":"Get the top autonomous systems (AS) by network traffic. Values are a percentage out of the total network traffic.","operationId":"radar_get_NetflowsTopASes","parameters":[{"name":"limit","in":"query","description":"Limit the number of objects in the response.","schema":{"type":"integer","description":"Limit the number of objects in the response.","default":5,"example":5}},{"name":"name","in":"query","description":"Array of names that will be used to name the series in responses.","schema":{"type":"array","items":{"type":"string","description":"Array of names that will be used to name the series in responses.","example":"main_series"}}},{"name":"dateRange","in":"query","description":"For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","schema":{"type":"array","items":{"type":"string","description":"For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","enum":["1d","7d","14d","28d","1dControl","7dControl","14dControl","28dControl"]}}},{"name":"dateStart","in":"query","description":"Array of datetimes to filter the start of a series.","schema":{"type":"array","items":{"type":"string","format":"date-time","example":"2022-09-15T00:00:00Z"}}},{"name":"dateEnd","in":"query","description":"Array of datetimes to filter the end of a series.","schema":{"type":"array","items":{"type":"string","format":"date-time","example":"2022-09-15T00:00:00Z"}}},{"name":"asn","in":"query","description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `[-174, 3356]` excludes results from AS174, but includes results from AS3356.","schema":{"type":"array","items":{"type":"string","description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `[-174, 3356]` excludes results from AS174, but includes results from AS3356.","example":"15169"}}},{"name":"location","in":"query","description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `[-US, PT]` excludes results from the US, but includes results from PT.","schema":{"type":"array","items":{"type":"string","description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `[-US, PT]` excludes results from the US, but includes results from PT.","example":"US,CA"}}},{"name":"format","in":"query","description":"Format results are returned in.","schema":{"type":"string","description":"Format results are returned in.","enum":["json","csv"],"example":"json"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"object","properties":{"top_0":{"type":"array","items":{"type":"object","properties":{"clientASN":{"type":"number","example":16509},"clientASName":{"type":"string","example":"AMAZON-02"},"value":{"type":"string","example":"0.73996"}}}}}},"success":{"type":"boolean","example":true}}}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/radar/netflows/top/locations":{"get":{"tags":["Radar Netflows"],"summary":"Get top locations","description":"Get the top locations by network traffic. Values are a percentage out of the total network traffic.","operationId":"radar_get_NetflowsTopLocations","parameters":[{"name":"limit","in":"query","description":"Limit the number of objects in the response.","schema":{"type":"integer","description":"Limit the number of objects in the response.","default":5,"example":5}},{"name":"name","in":"query","description":"Array of names that will be used to name the series in responses.","schema":{"type":"array","items":{"type":"string","description":"Array of names that will be used to name the series in responses.","example":"main_series"}}},{"name":"dateRange","in":"query","description":"For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","schema":{"type":"array","items":{"type":"string","description":"For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","enum":["1d","7d","14d","28d","1dControl","7dControl","14dControl","28dControl"]}}},{"name":"dateStart","in":"query","description":"Array of datetimes to filter the start of a series.","schema":{"type":"array","items":{"type":"string","format":"date-time","example":"2022-09-15T00:00:00Z"}}},{"name":"dateEnd","in":"query","description":"Array of datetimes to filter the end of a series.","schema":{"type":"array","items":{"type":"string","format":"date-time","example":"2022-09-15T00:00:00Z"}}},{"name":"asn","in":"query","description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `[-174, 3356]` excludes results from AS174, but includes results from AS3356.","schema":{"type":"array","items":{"type":"string","description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `[-174, 3356]` excludes results from AS174, but includes results from AS3356.","example":"15169"}}},{"name":"location","in":"query","description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `[-US, PT]` excludes results from the US, but includes results from PT.","schema":{"type":"array","items":{"type":"string","description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `[-US, PT]` excludes results from the US, but includes results from PT.","example":"US,CA"}}},{"name":"format","in":"query","description":"Format results are returned in.","schema":{"type":"string","description":"Format results are returned in.","enum":["json","csv"],"example":"json"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"object","properties":{"top_0":{"type":"array","items":{"type":"object","properties":{"clientCountryAlpha2":{"type":"string","example":"US"},"clientCountryName":{"type":"string","example":"United States"},"value":{"type":"string","example":"0.73996"}}}}}},"success":{"type":"boolean","example":true}}}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/radar/ranking/timeseries":{"get":{"tags":["Radar Ranking"],"summary":"Get Domains Rank time series","description":"Gets Domains Rank updates change over time. Raw values are returned.","operationId":"radar_get_RankingTimeseries","parameters":[{"name":"limit","in":"query","description":"Limit the number of objects in the response.","schema":{"type":"integer","description":"Limit the number of objects in the response.","default":5,"example":5}},{"name":"name","in":"query","description":"Array of names that will be used to name the series in responses.","schema":{"type":"array","items":{"type":"string","description":"Array of names that will be used to name the series in responses.","example":"main_series"}}},{"name":"location","in":"query","description":"Array of locations (alpha-2 country codes).","schema":{"type":"array","items":{"type":"string","description":"Array of locations (alpha-2 country codes).","example":"US"}}},{"name":"domains","in":"query","description":"Array of comma separated list of domains names.","schema":{"type":"array","items":{"type":"string","description":"Array of comma separated list of domains names.","example":"google.com,facebook.com"}}},{"name":"dateRange","in":"query","description":"For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","schema":{"type":"array","items":{"type":"string","description":"For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","enum":["1d","7d","14d","28d","1dControl","7dControl","14dControl","28dControl"]}}},{"name":"dateStart","in":"query","description":"Array of datetimes to filter the start of a series.","schema":{"type":"array","items":{"type":"string","format":"date-time","example":"2022-09-15T00:00:00Z"}}},{"name":"dateEnd","in":"query","description":"Array of datetimes to filter the end of a series.","schema":{"type":"array","items":{"type":"string","format":"date-time","example":"2022-09-15T00:00:00Z"}}},{"name":"format","in":"query","description":"Format results are returned in.","schema":{"type":"string","description":"Format results are returned in.","enum":["json","csv"],"example":"json"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"object","properties":{"meta":{"type":"object","properties":{"dateRange":{"type":"object","properties":{"endTime":{"type":"string","format":"date-time","description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z"},"startTime":{"type":"string","format":"date-time","description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z"}}}}},"serie_0":{"type":"object","properties":{"<domain name>":{"type":"array","items":{"type":"integer","example":2}},"timestamps":{"type":"array","items":{"type":"string","example":"2022-09-02"}}}}}},"success":{"type":"boolean","example":true}}}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/radar/ranking/top":{"get":{"tags":["Radar Ranking"],"summary":"Get Domains Rank top","description":"Gets Top Domains Rank globally or by country.","operationId":"radar_get_RankingTop","parameters":[{"name":"limit","in":"query","description":"Limit the number of objects in the response.","schema":{"type":"integer","description":"Limit the number of objects in the response.","default":5,"example":5}},{"name":"name","in":"query","description":"Array of names that will be used to name the series in responses.","schema":{"type":"array","items":{"type":"string","description":"Array of names that will be used to name the series in responses.","example":"main_series"}}},{"name":"location","in":"query","description":"Array of locations (alpha-2 country codes).","schema":{"type":"array","items":{"type":"string","description":"Array of locations (alpha-2 country codes).","example":"US"}}},{"name":"date","in":"query","description":"Array of dates to filter the ranking.","schema":{"type":"array","items":{"type":"string","format":"date","description":"Array of dates to filter the ranking.","example":"2022-09-19"}}},{"name":"format","in":"query","description":"Format results are returned in.","schema":{"type":"string","description":"Format results are returned in.","enum":["json","csv"],"example":"json"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"object","properties":{"meta":{"type":"object","properties":{"top_0":{"type":"object","properties":{"date":{"type":"string","example":"2022-09-19"}}}}},"top_0":{"type":"array","items":{"type":"object","properties":{"domain":{"type":"string","example":"google.com"},"rank":{"type":"integer","example":1}}}}}},"success":{"type":"boolean","example":true}}}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/radar/search/global":{"get":{"tags":["Radar Search"],"summary":"Search for locations, autonomous systems (AS) and reports","description":"Lets you search for locations, autonomous systems (AS) and reports.","operationId":"radar_get_SearchGlobal","parameters":[{"name":"limit","in":"query","description":"Limit the number of objects in the response.","schema":{"type":"integer","description":"Limit the number of objects in the response.","default":5,"example":5}},{"name":"query","in":"query","description":"Search for locations, AS and reports","required":true,"schema":{"type":"string","description":"Search for locations, AS and reports","example":"United"}},{"name":"format","in":"query","description":"Format results are returned in.","schema":{"type":"string","description":"Format results are returned in.","enum":["json","csv"],"example":"json"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","example":"13335"},"name":{"type":"string","example":"Cloudflare"},"type":{"type":"string","example":"asn"}}}},"success":{"type":"boolean","example":true}}}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/radar/specialevents":{"get":{"tags":["Radar Special Events"],"summary":"List Special Events","description":"Get a list of Special Events.","operationId":"radar_get_SpecialEventsList","parameters":[{"name":"limit","in":"query","description":"Limit the number of objects in the response.","schema":{"type":"integer","description":"Limit the number of objects in the response.","default":5,"example":5}},{"name":"offset","in":"query","description":"Number of objects to skip before grabbing results.","schema":{"type":"integer","description":"Number of objects to skip before grabbing results.","default":0,"example":0}},{"name":"format","in":"query","description":"Format results are returned in.","schema":{"type":"string","description":"Format results are returned in.","enum":["json","csv"],"example":"json"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"object","properties":{"specialEvents":{"type":"array","items":{"type":"object","properties":{"alias":{"type":"string","example":"euro2020"},"categories":{"type":"array","items":{"type":"object","properties":{"categoryAlias":{"type":"string","example":"streaming"},"location":{"type":"string","example":"GLOBAL"}}}},"description":{"type":"string","example":"The 2020 UEFA European Football Championship"},"id":{"type":"integer","example":1},"title":{"type":"string","example":"Euro2020"}}}}}},"success":{"type":"boolean","example":true}}}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/radar/specialevents/{eventAlias}":{"get":{"tags":["Radar Special Events"],"summary":"Get a Single Special Events","description":"Get a single Special Event.","operationId":"radar_get_SpecialEventsGet","parameters":[{"name":"eventAlias","in":"path","description":"Special Event alias","required":true,"schema":{"type":"string","description":"Special Event alias","example":"eurovision-2022"}},{"name":"format","in":"query","description":"Format results are returned in.","schema":{"type":"string","description":"Format results are returned in.","enum":["json","csv"],"example":"json"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"object","properties":{"specialEvent":{"type":"object","properties":{"alias":{"type":"string","example":"euro2020"},"categories":{"type":"array","items":{"type":"object","properties":{"categoryAlias":{"type":"string","example":"streaming"},"location":{"type":"string","example":"GLOBAL"}}}},"description":{"type":"string","example":"The 2020 UEFA European Football Championship"},"id":{"type":"integer","example":1},"title":{"type":"string","example":"Euro2020"}}}}},"success":{"type":"boolean","example":true}}}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/radar/specialevents/{eventAlias}/{categoryAlias}":{"get":{"tags":["Radar Special Events"],"summary":"Get Special Events time series","operationId":"radar_get_TimeseriesSpecialEvents","parameters":[{"name":"aggInterval","in":"query","description":"Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals).","schema":{"type":"string","description":"Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals).","enum":["15m","1h","1d"],"example":"1h"}},{"name":"name","in":"query","description":"Name that will be used to name the series in response.","schema":{"type":"string","description":"Name that will be used to name the series in response.","example":"main_series"}},{"name":"dateStart","in":"query","description":"Start of the date range (inclusive).","schema":{"type":"string","format":"date-time","example":"2022-09-15T00:00:00Z"}},{"name":"dateEnd","in":"query","description":"End of the date range (inclusive).","schema":{"type":"string","format":"date-time","example":"2022-09-15T00:00:00Z"}},{"name":"location","in":"query","description":"Location Alpha2 code.","schema":{"type":"string","description":"Location Alpha2 code.","example":"US"}},{"name":"eventAlias","in":"path","description":"Special Event alias","required":true,"schema":{"type":"string","description":"Special Event alias","example":"eurovision-2022"}},{"name":"categoryAlias","in":"path","description":"Special Event Category alias","required":true,"schema":{"type":"string","description":"Special Event Category alias","example":"videos"}},{"name":"format","in":"query","description":"Format results are returned in.","schema":{"type":"string","description":"Format results are returned in.","enum":["json","csv"],"example":"json"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"object","properties":{"serie_0":{"type":"object","properties":{"timestamps":{"type":"array","items":{"type":"string","format":"date-time","example":"2022-09-15T00:00:00Z"}},"values":{"type":"array","items":{"type":"string","example":0.56}}}}}},"success":{"type":"boolean","example":true}}}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/radar/verified_bots/top/bots":{"get":{"tags":["Radar Verified Bots"],"summary":"Get top verified bots by HTTP requests","description":"Get top verified bots by HTTP requests, with owner and category.","operationId":"radar_get_HttpTopVerifiedBots","parameters":[{"name":"limit","in":"query","description":"Limit the number of objects in the response.","schema":{"type":"integer","description":"Limit the number of objects in the response.","default":5,"example":5}},{"name":"name","in":"query","description":"Array of names that will be used to name the series in responses.","schema":{"type":"array","items":{"type":"string","description":"Array of names that will be used to name the series in responses.","example":"main_series"}}},{"name":"dateRange","in":"query","description":"For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","schema":{"type":"array","items":{"type":"string","description":"For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","enum":["1d","7d","14d","28d","1dControl","7dControl","14dControl","28dControl"]}}},{"name":"dateStart","in":"query","description":"Array of datetimes to filter the start of a series.","schema":{"type":"array","items":{"type":"string","format":"date-time","example":"2022-09-15T00:00:00Z"}}},{"name":"dateEnd","in":"query","description":"Array of datetimes to filter the end of a series.","schema":{"type":"array","items":{"type":"string","format":"date-time","example":"2022-09-15T00:00:00Z"}}},{"name":"asn","in":"query","description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `[-174, 3356]` excludes results from AS174, but includes results from AS3356.","schema":{"type":"array","items":{"type":"string","description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `[-174, 3356]` excludes results from AS174, but includes results from AS3356.","example":"15169"}}},{"name":"location","in":"query","description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `[-US, PT]` excludes results from the US, but includes results from PT.","schema":{"type":"array","items":{"type":"string","description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `[-US, PT]` excludes results from the US, but includes results from PT.","example":"US,CA"}}},{"name":"format","in":"query","description":"Format results are returned in.","schema":{"type":"string","description":"Format results are returned in.","enum":["json","csv"],"example":"json"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"object","properties":{"meta":{"type":"object","properties":{"confidenceInfo":{"type":"object","properties":{"annotations":{"type":"array","items":{"type":"object","properties":{"dataSource":{"type":"string"},"description":{"type":"string"},"endTime":{"type":"string","format":"date-time","example":"2022-09-15T00:00:00Z"},"eventType":{"type":"string"},"startTime":{"type":"string","format":"date-time","example":"2022-09-15T00:00:00Z"}}}},"level":{"type":"integer"}}},"dateRange":{"type":"object","properties":{"endTime":{"type":"string","format":"date-time","example":"2022-09-15T00:00:00Z"},"startTime":{"type":"string","format":"date-time","example":"2022-09-15T00:00:00Z"}}}}},"top_0":{"type":"array","items":{"type":"object","properties":{"botCategory":{"type":"string","example":"Search Engine Crawler"},"botName":{"type":"string","example":"GoogleBot"},"botOwner":{"type":"string","example":"Google"},"value":{"type":"string","example":"29.034407"}}}}}},"success":{"type":"boolean","example":true}}}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/radar/verified_bots/top/categories":{"get":{"tags":["Radar Verified Bots"],"summary":"Get top verified bot categories by HTTP requests","description":"Get top verified bot categories by HTTP requests, along with their corresponding percentage, over the total verified bot HTTP requests.","operationId":"radar_get_HttpTopVerifiedBotCategories","parameters":[{"name":"limit","in":"query","description":"Limit the number of objects in the response.","schema":{"type":"integer","description":"Limit the number of objects in the response.","default":5,"example":5}},{"name":"name","in":"query","description":"Array of names that will be used to name the series in responses.","schema":{"type":"array","items":{"type":"string","description":"Array of names that will be used to name the series in responses.","example":"main_series"}}},{"name":"dateRange","in":"query","description":"For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","schema":{"type":"array","items":{"type":"string","description":"For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","enum":["1d","7d","14d","28d","1dControl","7dControl","14dControl","28dControl"]}}},{"name":"dateStart","in":"query","description":"Array of datetimes to filter the start of a series.","schema":{"type":"array","items":{"type":"string","format":"date-time","example":"2022-09-15T00:00:00Z"}}},{"name":"dateEnd","in":"query","description":"Array of datetimes to filter the end of a series.","schema":{"type":"array","items":{"type":"string","format":"date-time","example":"2022-09-15T00:00:00Z"}}},{"name":"asn","in":"query","description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `[-174, 3356]` excludes results from AS174, but includes results from AS3356.","schema":{"type":"array","items":{"type":"string","description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `[-174, 3356]` excludes results from AS174, but includes results from AS3356.","example":"15169"}}},{"name":"location","in":"query","description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `[-US, PT]` excludes results from the US, but includes results from PT.","schema":{"type":"array","items":{"type":"string","description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `[-US, PT]` excludes results from the US, but includes results from PT.","example":"US,CA"}}},{"name":"format","in":"query","description":"Format results are returned in.","schema":{"type":"string","description":"Format results are returned in.","enum":["json","csv"],"example":"json"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"object","properties":{"meta":{"type":"object","properties":{"confidenceInfo":{"type":"object","properties":{"annotations":{"type":"array","items":{"type":"object","properties":{"dataSource":{"type":"string"},"description":{"type":"string"},"endTime":{"type":"string","format":"date-time","example":"2022-09-15T00:00:00Z"},"eventType":{"type":"string"},"startTime":{"type":"string","format":"date-time","example":"2022-09-15T00:00:00Z"}}}},"level":{"type":"integer"}}},"dateRange":{"type":"object","properties":{"endTime":{"type":"string","format":"date-time","example":"2022-09-15T00:00:00Z"},"startTime":{"type":"string","format":"date-time","example":"2022-09-15T00:00:00Z"}}}}},"top_0":{"type":"array","items":{"type":"object","properties":{"botCategory":{"type":"string","example":"Search"},"value":{"type":"string","example":"65"}}}}}},"success":{"type":"boolean","example":true}}}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/railguns":{"get":{"tags":["Railgun"],"summary":"List Railguns","description":"List, search, sort and filter your Railguns.","operationId":"railgun-list-railguns","responses":{"4xx":{"description":"List Railguns response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/railgun_response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"List Railguns response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/railgun_response_collection"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"post":{"tags":["Railgun"],"summary":"Create Railgun","operationId":"railgun-create-railgun","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["name"],"properties":{"name":{"$ref":"#/components/schemas/railgun_components-schemas-name"}}}}}},"responses":{"4xx":{"description":"Create Railgun response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/railgun_response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Create Railgun response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/railgun_response_single"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/railguns/{identifier}":{"delete":{"tags":["Railgun"],"summary":"Delete a Railgun","description":"Disable and delete a Railgun. This will immediately disable that Railgun for any connected zones.","operationId":"railgun-delete-a-railgun","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/railgun_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{"4xx":{"description":"Delete a Railgun response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/railgun_response_single_id"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Delete a Railgun response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/railgun_response_single_id"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"get":{"tags":["Railgun"],"summary":"Railgun details","operationId":"railgun-railgun-details","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/railgun_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Railgun details response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/railgun_response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Railgun details response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/railgun_response_single"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"patch":{"tags":["Railgun"],"summary":"Enable or disable a Railgun","description":"Enable or disable a Railgun for all zones connected to it.","operationId":"railgun-enable-or-disable-a-railgun","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/railgun_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["enabled"],"properties":{"enabled":{"$ref":"#/components/schemas/railgun_components-schemas-enabled"}}}}}},"responses":{"4xx":{"description":"Enable or disable a Railgun response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/railgun_response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Enable or disable a Railgun response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/railgun_response_single"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/railguns/{identifier}/zones":{"get":{"tags":["Railgun"],"summary":"List Railgun zones","description":"List the zones that are currently using this Railgun.","operationId":"railgun-list-railgun-zones","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/railgun_components-schemas-identifier"}}],"responses":{"4xx":{"description":"List Railgun zones response failure","content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/components-schemas-zone"}}}}]},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"List Railgun zones response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/components-schemas-zone"}}}}]}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/user":{"get":{"tags":["User"],"summary":"User Details","operationId":"user-user-details","responses":{"4xx":{"description":"User Details response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/single_user_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"User Details response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/single_user_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"patch":{"tags":["User"],"summary":"Edit User","description":"Edit part of your user details.","operationId":"user-edit-user","requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"country":{"$ref":"#/components/schemas/country"},"first_name":{"$ref":"#/components/schemas/first_name"},"last_name":{"$ref":"#/components/schemas/last_name"},"telephone":{"$ref":"#/components/schemas/telephone"},"zipcode":{"$ref":"#/components/schemas/zipcode"}}}}}},"responses":{"4xx":{"description":"Edit User response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/single_user_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Edit User response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/single_user_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/user/audit_logs":{"get":{"tags":["Audit Logs"],"summary":"Get user audit logs","description":"Gets a list of audit logs for a user account. The list can be filtered by who made the change, which zone was the change made on, and the timeframe of the change.","operationId":"audit-logs-get-user-audit-logs","responses":{"4xx":{"description":"Get user audit logs response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/audit_logs_response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Get user audit logs response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/audit_logs_response_collection"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/user/billing/history":{"get":{"tags":["User Billing History"],"summary":"Billing History Details","description":"Accesses your billing history object.","operationId":"user-billing-history-billing-history-details","responses":{"4xx":{"description":"Billing History Details response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/billing_history_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Billing History Details response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/billing_history_collection"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/user/billing/profile":{"get":{"tags":["User Billing Profile"],"summary":"Billing Profile Details","description":"Accesses your billing profile object.","operationId":"user-billing-profile-billing-profile-details","responses":{"4xx":{"description":"Billing Profile Details response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/billing_response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Billing Profile Details response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/billing_response_single"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/user/firewall/access_rules/rules":{"get":{"tags":["IP Access rules for a user"],"summary":"List IP Access rules","description":"Fetches IP Access rules of the user. You can filter the results using several optional parameters.","operationId":"ip-access-rules-for-a-user-list-ip-access-rules","responses":{"4xx":{"description":"List IP Access rules response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/rule_collection_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"List IP Access rules response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/rule_collection_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"post":{"tags":["IP Access rules for a user"],"summary":"Create an IP Access rule","description":"Creates a new IP Access rule for all zones owned by the current user.\n\nNote: To create an IP Access rule that applies to a specific zone, refer to the [IP Access rules for a zone](#ip-access-rules-for-a-zone) endpoints.","operationId":"ip-access-rules-for-a-user-create-an-ip-access-rule","requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["mode","configuration"],"properties":{"configuration":{"$ref":"#/components/schemas/schemas-configuration"},"mode":{"$ref":"#/components/schemas/schemas-mode"},"notes":{"$ref":"#/components/schemas/notes"}}}}}},"responses":{"4xx":{"description":"Create an IP Access rule response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/rule_single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Create an IP Access rule response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/rule_single_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/user/firewall/access_rules/rules/{identifier}":{"delete":{"tags":["IP Access rules for a user"],"summary":"Delete an IP Access rule","description":"Deletes an IP Access rule at the user level.\n\nNote: Deleting a user-level rule will affect all zones owned by the user.","operationId":"ip-access-rules-for-a-user-delete-an-ip-access-rule","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/rule_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{"4xx":{"description":"Delete an IP Access rule response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/rule_single_id_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Delete an IP Access rule response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/rule_single_id_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"patch":{"tags":["IP Access rules for a user"],"summary":"Update an IP Access rule","description":"Updates an IP Access rule defined at the user level. You can only update the rule action (`mode` parameter) and notes.","operationId":"ip-access-rules-for-a-user-update-an-ip-access-rule","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/rule_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"mode":{"$ref":"#/components/schemas/schemas-mode"},"notes":{"$ref":"#/components/schemas/notes"}}}}}},"responses":{"4xx":{"description":"Update an IP Access rule response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/rule_single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Update an IP Access rule response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/rule_single_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/user/invites":{"get":{"tags":["User's Invites"],"summary":"List Invitations","description":"Lists all invitations associated with my user.","operationId":"user'-s-invites-list-invitations","responses":{"4xx":{"description":"List Invitations response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/schemas-collection_invite_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"List Invitations response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/schemas-collection_invite_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/user/invites/{identifier}":{"get":{"tags":["User's Invites"],"summary":"Invitation Details","description":"Gets the details of an invitation.","operationId":"user'-s-invites-invitation-details","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/invite_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Invitation Details response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/single_invite_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Invitation Details response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/single_invite_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"patch":{"tags":["User's Invites"],"summary":"Respond to Invitation","description":"Responds to an invitation.","operationId":"user'-s-invites-respond-to-invitation","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/invite_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["status"],"properties":{"status":{"description":"Status of your response to the invitation (rejected or accepted).","enum":["accepted","rejected"],"example":"accepted"}}}}}},"responses":{"4xx":{"description":"Respond to Invitation response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/single_invite_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Respond to Invitation response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/single_invite_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/user/load_balancers/monitors":{"get":{"tags":["Load Balancer Monitors"],"summary":"List Monitors","description":"List configured monitors for a user.","operationId":"load-balancer-monitors-list-monitors","responses":{"4xx":{"description":"List Monitors response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/monitor_components-schemas-response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"List Monitors response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/monitor_components-schemas-response_collection"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"post":{"tags":["Load Balancer Monitors"],"summary":"Create Monitor","description":"Create a configured monitor.","operationId":"load-balancer-monitors-create-monitor","requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["expected_codes"],"properties":{"allow_insecure":{"$ref":"#/components/schemas/allow_insecure"},"description":{"$ref":"#/components/schemas/monitor_components-schemas-description"},"expected_body":{"$ref":"#/components/schemas/expected_body"},"expected_codes":{"$ref":"#/components/schemas/expected_codes"},"follow_redirects":{"$ref":"#/components/schemas/follow_redirects"},"header":{"$ref":"#/components/schemas/header"},"interval":{"$ref":"#/components/schemas/interval"},"method":{"$ref":"#/components/schemas/schemas-method"},"path":{"$ref":"#/components/schemas/path"},"port":{"$ref":"#/components/schemas/components-schemas-port"},"probe_zone":{"$ref":"#/components/schemas/probe_zone"},"retries":{"$ref":"#/components/schemas/retries"},"timeout":{"$ref":"#/components/schemas/schemas-timeout"},"type":{"$ref":"#/components/schemas/monitor_components-schemas-type"}}}}}},"responses":{"4xx":{"description":"Create Monitor response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/monitor_components-schemas-single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Create Monitor response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/monitor_components-schemas-single_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/user/load_balancers/monitors/{identifier}":{"delete":{"tags":["Load Balancer Monitors"],"summary":"Delete Monitor","description":"Delete a configured monitor.","operationId":"load-balancer-monitors-delete-monitor","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/monitor_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{"4xx":{"description":"Delete Monitor response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/monitor_components-schemas-id_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Delete Monitor response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/monitor_components-schemas-id_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"get":{"tags":["Load Balancer Monitors"],"summary":"Monitor Details","description":"List a single configured monitor for a user.","operationId":"load-balancer-monitors-monitor-details","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/monitor_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Monitor Details response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/monitor_components-schemas-single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Monitor Details response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/monitor_components-schemas-single_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"patch":{"tags":["Load Balancer Monitors"],"summary":"Patch Monitor","description":"Apply changes to an existing monitor, overwriting the supplied properties.","operationId":"load-balancer-monitors-patch-monitor","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/monitor_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"allow_insecure":{"$ref":"#/components/schemas/allow_insecure"},"description":{"$ref":"#/components/schemas/monitor_components-schemas-description"},"expected_body":{"$ref":"#/components/schemas/expected_body"},"expected_codes":{"$ref":"#/components/schemas/expected_codes"},"follow_redirects":{"$ref":"#/components/schemas/follow_redirects"},"header":{"$ref":"#/components/schemas/header"},"interval":{"$ref":"#/components/schemas/interval"},"method":{"$ref":"#/components/schemas/schemas-method"},"path":{"$ref":"#/components/schemas/path"},"port":{"$ref":"#/components/schemas/components-schemas-port"},"probe_zone":{"$ref":"#/components/schemas/probe_zone"},"retries":{"$ref":"#/components/schemas/retries"},"timeout":{"$ref":"#/components/schemas/schemas-timeout"},"type":{"$ref":"#/components/schemas/monitor_components-schemas-type"}}}}}},"responses":{"4xx":{"description":"Patch Monitor response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/monitor_components-schemas-single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Patch Monitor response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/monitor_components-schemas-single_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"put":{"tags":["Load Balancer Monitors"],"summary":"Update Monitor","description":"Modify a configured monitor.","operationId":"load-balancer-monitors-update-monitor","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/monitor_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["expected_codes"],"properties":{"allow_insecure":{"$ref":"#/components/schemas/allow_insecure"},"description":{"$ref":"#/components/schemas/monitor_components-schemas-description"},"expected_body":{"$ref":"#/components/schemas/expected_body"},"expected_codes":{"$ref":"#/components/schemas/expected_codes"},"follow_redirects":{"$ref":"#/components/schemas/follow_redirects"},"header":{"$ref":"#/components/schemas/header"},"interval":{"$ref":"#/components/schemas/interval"},"method":{"$ref":"#/components/schemas/schemas-method"},"path":{"$ref":"#/components/schemas/path"},"port":{"$ref":"#/components/schemas/components-schemas-port"},"probe_zone":{"$ref":"#/components/schemas/probe_zone"},"retries":{"$ref":"#/components/schemas/retries"},"timeout":{"$ref":"#/components/schemas/schemas-timeout"},"type":{"$ref":"#/components/schemas/monitor_components-schemas-type"}}}}}},"responses":{"4xx":{"description":"Update Monitor response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/monitor_components-schemas-single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Update Monitor response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/monitor_components-schemas-single_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/user/load_balancers/monitors/{identifier}/preview":{"post":{"tags":["Load Balancer Monitors"],"summary":"Preview Monitor","description":"Preview pools using the specified monitor with provided monitor details. The returned preview_id can be used in the preview endpoint to retrieve the results.","operationId":"load-balancer-monitors-preview-monitor","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/monitor_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["expected_codes"],"properties":{"allow_insecure":{"$ref":"#/components/schemas/allow_insecure"},"expected_body":{"$ref":"#/components/schemas/expected_body"},"expected_codes":{"$ref":"#/components/schemas/expected_codes"},"follow_redirects":{"$ref":"#/components/schemas/follow_redirects"},"header":{"$ref":"#/components/schemas/header"},"method":{"$ref":"#/components/schemas/schemas-method"},"path":{"$ref":"#/components/schemas/path"},"port":{"$ref":"#/components/schemas/components-schemas-port"},"retries":{"$ref":"#/components/schemas/retries"},"timeout":{"$ref":"#/components/schemas/schemas-timeout"},"type":{"$ref":"#/components/schemas/monitor_components-schemas-type"}}}}}},"responses":{"4xx":{"description":"Preview Monitor response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/preview_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Preview Monitor response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/preview_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/user/load_balancers/monitors/{identifier}/references":{"get":{"tags":["Load Balancer Monitors"],"summary":"List Monitor References","description":"Get the list of resources that reference the provided monitor.","operationId":"load-balancer-monitors-list-monitor-references","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/monitor_components-schemas-identifier"}}],"responses":{"4xx":{"description":"List Monitor References response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/references_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"List Monitor References response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/references_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/user/load_balancers/pools":{"get":{"tags":["Load Balancer Pools"],"summary":"List Pools","description":"List configured pools.","operationId":"load-balancer-pools-list-pools","responses":{"4xx":{"description":"List Pools response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/pool_components-schemas-response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"List Pools response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/pool_components-schemas-response_collection"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"patch":{"tags":["Load Balancer Pools"],"summary":"Patch Pools","description":"Apply changes to a number of existing pools, overwriting the supplied properties. Pools are ordered by ascending `name`. Returns the list of affected pools. Supports the standard pagination query parameters, either `limit`/`offset` or `per_page`/`page`.","operationId":"load-balancer-pools-patch-pools","requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"notification_email":{"$ref":"#/components/schemas/patch_pools_notification_email"}}}}}},"responses":{"4xx":{"description":"Patch Pools response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/pool_components-schemas-response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Patch Pools response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/pool_components-schemas-response_collection"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"post":{"tags":["Load Balancer Pools"],"summary":"Create Pool","description":"Create a new pool.","operationId":"load-balancer-pools-create-pool","requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["origins","name"],"properties":{"check_regions":{"$ref":"#/components/schemas/check_regions"},"description":{"$ref":"#/components/schemas/pool_components-schemas-description"},"enabled":{"$ref":"#/components/schemas/pool_components-schemas-enabled"},"latitude":{"$ref":"#/components/schemas/latitude"},"load_shedding":{"$ref":"#/components/schemas/load_shedding"},"longitude":{"$ref":"#/components/schemas/longitude"},"minimum_origins":{"$ref":"#/components/schemas/minimum_origins"},"monitor":{"$ref":"#/components/schemas/schemas-monitor"},"name":{"$ref":"#/components/schemas/pool_components-schemas-name"},"notification_email":{"$ref":"#/components/schemas/notification_email"},"notification_filter":{"$ref":"#/components/schemas/notification_filter"},"origin_steering":{"$ref":"#/components/schemas/origin_steering"},"origins":{"$ref":"#/components/schemas/origins"}}}}}},"responses":{"4xx":{"description":"Create Pool response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/pool_components-schemas-single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Create Pool response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/pool_components-schemas-single_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/user/load_balancers/pools/{identifier}":{"delete":{"tags":["Load Balancer Pools"],"summary":"Delete Pool","description":"Delete a configured pool.","operationId":"load-balancer-pools-delete-pool","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/pool_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{"4xx":{"description":"Delete Pool response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/pool_components-schemas-id_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Delete Pool response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/pool_components-schemas-id_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"get":{"tags":["Load Balancer Pools"],"summary":"Pool Details","description":"Fetch a single configured pool.","operationId":"load-balancer-pools-pool-details","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/pool_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Pool Details response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/pool_components-schemas-single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Pool Details response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/pool_components-schemas-single_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"patch":{"tags":["Load Balancer Pools"],"summary":"Patch Pool","description":"Apply changes to an existing pool, overwriting the supplied properties.","operationId":"load-balancer-pools-patch-pool","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/pool_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"check_regions":{"$ref":"#/components/schemas/check_regions"},"description":{"$ref":"#/components/schemas/pool_components-schemas-description"},"disabled_at":{"$ref":"#/components/schemas/schemas-disabled_at"},"enabled":{"$ref":"#/components/schemas/pool_components-schemas-enabled"},"latitude":{"$ref":"#/components/schemas/latitude"},"load_shedding":{"$ref":"#/components/schemas/load_shedding"},"longitude":{"$ref":"#/components/schemas/longitude"},"minimum_origins":{"$ref":"#/components/schemas/minimum_origins"},"monitor":{"$ref":"#/components/schemas/schemas-monitor"},"name":{"$ref":"#/components/schemas/pool_components-schemas-name"},"notification_email":{"$ref":"#/components/schemas/notification_email"},"notification_filter":{"$ref":"#/components/schemas/notification_filter"},"origin_steering":{"$ref":"#/components/schemas/origin_steering"},"origins":{"$ref":"#/components/schemas/origins"}}}}}},"responses":{"4xx":{"description":"Patch Pool response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/pool_components-schemas-single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Patch Pool response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/pool_components-schemas-single_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"put":{"tags":["Load Balancer Pools"],"summary":"Update Pool","description":"Modify a configured pool.","operationId":"load-balancer-pools-update-pool","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/pool_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["origins","name"],"properties":{"check_regions":{"$ref":"#/components/schemas/check_regions"},"description":{"$ref":"#/components/schemas/pool_components-schemas-description"},"disabled_at":{"$ref":"#/components/schemas/schemas-disabled_at"},"enabled":{"$ref":"#/components/schemas/pool_components-schemas-enabled"},"latitude":{"$ref":"#/components/schemas/latitude"},"load_shedding":{"$ref":"#/components/schemas/load_shedding"},"longitude":{"$ref":"#/components/schemas/longitude"},"minimum_origins":{"$ref":"#/components/schemas/minimum_origins"},"monitor":{"$ref":"#/components/schemas/schemas-monitor"},"name":{"$ref":"#/components/schemas/pool_components-schemas-name"},"notification_email":{"$ref":"#/components/schemas/notification_email"},"notification_filter":{"$ref":"#/components/schemas/notification_filter"},"origin_steering":{"$ref":"#/components/schemas/origin_steering"},"origins":{"$ref":"#/components/schemas/origins"}}}}}},"responses":{"4xx":{"description":"Update Pool response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/pool_components-schemas-single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Update Pool response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/pool_components-schemas-single_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/user/load_balancers/pools/{identifier}/health":{"get":{"tags":["Load Balancer Pools"],"summary":"Pool Health Details","description":"Fetch the latest pool health status for a single pool.","operationId":"load-balancer-pools-pool-health-details","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/pool_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Pool Health Details response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/health_details"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Pool Health Details response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/health_details"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/user/load_balancers/pools/{identifier}/preview":{"post":{"tags":["Load Balancer Pools"],"summary":"Preview Pool","description":"Preview pool health using provided monitor details. The returned preview_id can be used in the preview endpoint to retrieve the results.","operationId":"load-balancer-pools-preview-pool","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/pool_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["expected_codes"],"properties":{"allow_insecure":{"$ref":"#/components/schemas/allow_insecure"},"expected_body":{"$ref":"#/components/schemas/expected_body"},"expected_codes":{"$ref":"#/components/schemas/expected_codes"},"follow_redirects":{"$ref":"#/components/schemas/follow_redirects"},"header":{"$ref":"#/components/schemas/header"},"method":{"$ref":"#/components/schemas/schemas-method"},"path":{"$ref":"#/components/schemas/path"},"port":{"$ref":"#/components/schemas/components-schemas-port"},"retries":{"$ref":"#/components/schemas/retries"},"timeout":{"$ref":"#/components/schemas/schemas-timeout"},"type":{"$ref":"#/components/schemas/monitor_components-schemas-type"}}}}}},"responses":{"4xx":{"description":"Preview Pool response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/preview_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Preview Pool response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/preview_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/user/load_balancers/pools/{identifier}/references":{"get":{"tags":["Load Balancer Pools"],"summary":"List Pool References","description":"Get the list of resources that reference the provided pool.","operationId":"load-balancer-pools-list-pool-references","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/pool_components-schemas-identifier"}}],"responses":{"4xx":{"description":"List Pool References response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/schemas-references_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"List Pool References response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/schemas-references_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/user/load_balancers/preview/{preview_id}":{"get":{"tags":["Load Balancer Monitors"],"summary":"Preview Result","description":"Get the result of a previous preview operation using the provided preview_id.","operationId":"load-balancer-monitors-preview-result","parameters":[{"name":"preview_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/preview_id"}}],"responses":{"4xx":{"description":"Preview Result response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/preview_result_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Preview Result response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/preview_result_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/user/load_balancing_analytics/events":{"get":{"tags":["Load Balancer Healthcheck Events"],"summary":"List Healthcheck Events","description":"List origin health changes.","operationId":"load-balancer-healthcheck-events-list-healthcheck-events","responses":{"4xx":{"description":"List Healthcheck Events response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/analytics_components-schemas-response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"List Healthcheck Events response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/analytics_components-schemas-response_collection"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/user/organizations":{"get":{"tags":["User's Organizations"],"summary":"List Organizations","description":"Lists organizations the user is associated with.","operationId":"user'-s-organizations-list-organizations","responses":{"4xx":{"description":"List Organizations response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/collection_organization_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"List Organizations response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/collection_organization_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/user/organizations/{identifier}":{"delete":{"tags":["User's Organizations"],"summary":"Leave Organization","description":"Removes association to an organization.","operationId":"user'-s-organizations-leave-organization","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{"4xx":{"description":"Leave Organization response failure","content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"id":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Leave Organization response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"get":{"tags":["User's Organizations"],"summary":"Organization Details","description":"Gets a specific organization the user is associated with.","operationId":"user'-s-organizations-organization-details","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Organization Details response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/single_organization_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Organization Details response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/single_organization_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/user/subscriptions":{"get":{"tags":["User Subscription"],"summary":"Get User Subscriptions","description":"Lists all of a user's subscriptions.","operationId":"user-subscription-get-user-subscriptions","responses":{"4xx":{"description":"Get User Subscriptions response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/user_subscription_response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Get User Subscriptions response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/user_subscription_response_collection"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/user/subscriptions/{identifier}":{"delete":{"tags":["User Subscription"],"summary":"Delete User Subscription","description":"Deletes a user's subscription.","operationId":"user-subscription-delete-user-subscription","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/subscription-v2_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{"4xx":{"description":"Delete User Subscription response failure","content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"subscription_id":{"$ref":"#/components/schemas/subscription-v2_components-schemas-identifier"}}},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Delete User Subscription response","content":{"application/json":{"schema":{"type":"object","properties":{"subscription_id":{"$ref":"#/components/schemas/subscription-v2_components-schemas-identifier"}}}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"put":{"tags":["User Subscription"],"summary":"Update User Subscription","description":"Updates a user's subscriptions.","operationId":"user-subscription-update-user-subscription","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/subscription-v2_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/subscription-v2"}}}},"responses":{"4xx":{"description":"Update User Subscription response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/user_subscription_response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Update User Subscription response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/user_subscription_response_single"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/user/tokens":{"get":{"tags":["User API Tokens"],"summary":"List Tokens","description":"List all access tokens you created.","operationId":"user-api-tokens-list-tokens","responses":{"4xx":{"description":"List Tokens response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"List Tokens response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_collection"}}}}},"security":[{"api_token":[]}]},"post":{"tags":["User API Tokens"],"summary":"Create Token","description":"Create a new access token.","operationId":"user-api-tokens-create-token","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/create_payload"}}}},"responses":{"4xx":{"description":"Create Token response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/response_create"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Create Token response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_create"}}}}},"security":[{"api_token":[]}]}},"/user/tokens/{identifier}":{"delete":{"tags":["User API Tokens"],"summary":"Delete Token","description":"Destroy a token.","operationId":"user-api-tokens-delete-token","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{"4xx":{"description":"Delete Token response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-response-single-id"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Delete Token response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-response-single-id"}}}}},"security":[{"api_token":[]}]},"get":{"tags":["User API Tokens"],"summary":"Token Details","description":"Get information about a specific token.","operationId":"user-api-tokens-token-details","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/schemas-identifier"}}],"responses":{"4xx":{"description":"Token Details response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Token Details response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_single"}}}}},"security":[{"api_token":[]}]},"put":{"tags":["User API Tokens"],"summary":"Update Token","description":"Update an existing token.","operationId":"user-api-tokens-update-token","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/schemas-token"}}}},"responses":{"4xx":{"description":"Update Token response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Update Token response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_single"}}}}},"security":[{"api_token":[]}]}},"/user/tokens/{identifier}/value":{"put":{"tags":["User API Tokens"],"summary":"Roll Token","description":"Roll the token secret.","operationId":"user-api-tokens-roll-token","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object"}}}},"responses":{"4xx":{"description":"Roll Token response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/response_single_value"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Roll Token response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_single_value"}}}}},"security":[{"api_token":[]}]}},"/user/tokens/permission_groups":{"get":{"tags":["Permission Groups"],"summary":"List Permission Groups","description":"Find all available permission groups.","operationId":"permission-groups-list-permission-groups","responses":{"4xx":{"description":"List Permission Groups response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/schemas-response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"List Permission Groups response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/schemas-response_collection"}}}}},"security":[{"api_token":[]}]}},"/user/tokens/verify":{"get":{"tags":["User API Tokens"],"summary":"Verify Token","description":"Test whether a token works.","operationId":"user-api-tokens-verify-token","responses":{"4xx":{"description":"Verify Token response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/response_single_segment"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Verify Token response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_single_segment"}}}}},"security":[{"api_token":[]}]}},"/zones":{"get":{"tags":["Zone"],"summary":"List Zones","description":"Lists, searches, sorts, and filters your zones.","operationId":"zone-list-zones","responses":{"4xx":{"description":"List Zones response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/components-schemas-response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"List Zones response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/components-schemas-response_collection"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"post":{"tags":["Zone"],"summary":"Create Zone","operationId":"zone-create-zone","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/schemas-create"}}}},"responses":{"4xx":{"description":"Create Zone response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/components-schemas-response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Create Zone response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/components-schemas-response_single"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/zones/{identifier}":{"delete":{"tags":["Zone"],"summary":"Delete Zone","description":"Deletes an existing zone.","operationId":"zone-delete-zone","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{"4xx":{"description":"Delete Zone response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-response-single-id"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Delete Zone response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-response-single-id"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"get":{"tags":["Zone"],"summary":"Zone Details","operationId":"zone-zone-details","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/schemas-identifier"}}],"responses":{"4xx":{"description":"Zone Details response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/components-schemas-response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Zone Details response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/components-schemas-response_single"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"patch":{"tags":["Zone"],"summary":"Edit Zone","description":"Editz a zone. Only one zone property can be changed at a time.","operationId":"zone-edit-zone","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/schemas-patch"}}}},"responses":{"4xx":{"description":"Edit Zone response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/components-schemas-response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Edit Zone response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/components-schemas-response_single"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/zones/{identifier}/access/apps":{"get":{"tags":["Zone-Level Access applications"],"summary":"List Access Applications","description":"List all Access Applications in a zone.","operationId":"zone-level-access-applications-list-access-applications","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/apps_components-schemas-identifier"}}],"responses":{"4xx":{"description":"List Access Applications response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/apps_components-schemas-response_collection-2"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"List Access Applications response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/apps_components-schemas-response_collection-2"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"post":{"tags":["Zone-Level Access applications"],"summary":"Add a Bookmark application","description":"Adds a custom link to the App Launcher. Bookmark applications are not protected by Access.","operationId":"zone-level-access-applications-add-a-bookmark-application","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/apps_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["name","type","domain"]}}}},"responses":{"4xx":{"description":"Add a Bookmark application response failure","content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/apps_components-schemas-single_response-2"},{"properties":{"result":{"allOf":[{"$ref":"#/components/schemas/basic_app_response_props"},{"$ref":"#/components/schemas/schemas-bookmark_props"}]}}}]},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Add a Bookmark application response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/apps_components-schemas-single_response-2"},{"properties":{"result":{"allOf":[{"$ref":"#/components/schemas/basic_app_response_props"},{"$ref":"#/components/schemas/schemas-bookmark_props"}]}}}]}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/zones/{identifier}/access/apps/{app_id}":{"delete":{"tags":["Zone-Level Access applications"],"summary":"Delete an Access application","description":"Deletes an application from Access.","operationId":"zone-level-access-applications-delete-an-access-application","parameters":[{"name":"app_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/schemas-app_id"}},{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/apps_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{"4xx":{"description":"Delete an Access application response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/apps_components-schemas-id_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Delete an Access application response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/apps_components-schemas-id_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"get":{"tags":["Zone-Level Access applications"],"summary":"Get an Access application","description":"Fetches information about an Access application.","operationId":"zone-level-access-applications-get-an-access-application","parameters":[{"name":"app_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/schemas-app_id"}},{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/apps_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Get an Access application response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/apps_components-schemas-single_response-2"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Get an Access application response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/apps_components-schemas-single_response-2"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"put":{"tags":["Zone-Level Access applications"],"summary":"Update a Bookmark application","description":"Updates a Bookmark application.","operationId":"zone-level-access-applications-update-a-bookmark-application","parameters":[{"name":"app_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/schemas-app_id"}},{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/apps_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["name","type","domain"]}}}},"responses":{"4xx":{"description":"Update a Bookmark application response failure","content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/apps_components-schemas-single_response-2"},{"properties":{"result":{"allOf":[{"$ref":"#/components/schemas/basic_app_response_props"},{"$ref":"#/components/schemas/schemas-bookmark_props"}]}}}]},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Update a Bookmark application response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/apps_components-schemas-single_response-2"},{"properties":{"result":{"allOf":[{"$ref":"#/components/schemas/basic_app_response_props"},{"$ref":"#/components/schemas/schemas-bookmark_props"}]}}}]}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/zones/{identifier}/access/apps/{app_id}/revoke_tokens":{"post":{"tags":["Zone-Level Access applications"],"summary":"Revoke service tokens","description":"Revokes all service tokens used by an application.","operationId":"zone-level-access-applications-revoke-service-tokens","parameters":[{"name":"app_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/schemas-app_id"}},{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/apps_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{"4xx":{"description":"Revoke service tokens response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/components-schemas-empty_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Revoke service tokens response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/components-schemas-empty_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/zones/{identifier}/access/apps/{app_id}/user_policy_checks":{"get":{"tags":["Zone-Level Access applications"],"summary":"Test Access policies","description":"Tests if a specific user has permission to access an application.","operationId":"zone-level-access-applications-test-access-policies","parameters":[{"name":"app_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/schemas-app_id"}},{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/apps_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Test Access policies response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/policy_check_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Test Access policies response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/policy_check_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/zones/{identifier}/access/apps/{uuid}/ca":{"delete":{"tags":["Zone-Level Access short-lived certificate CAs"],"summary":"Delete a short-lived certificate CA","description":"Deletes a short-lived certificate CA.","operationId":"zone-level-access-short-lived-certificate-c-as-delete-a-short-lived-certificate-ca","parameters":[{"name":"uuid","in":"path","required":true,"schema":{"$ref":"#/components/schemas/uuid"}},{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{"4xx":{"description":"Delete a short-lived certificate CA response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ca_components-schemas-id_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Delete a short-lived certificate CA response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ca_components-schemas-id_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"get":{"tags":["Zone-Level Access short-lived certificate CAs"],"summary":"Get a short-lived certificate CA","description":"Fetches a short-lived certificate CA and its public key.","operationId":"zone-level-access-short-lived-certificate-c-as-get-a-short-lived-certificate-ca","parameters":[{"name":"uuid","in":"path","required":true,"schema":{"$ref":"#/components/schemas/uuid"}},{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Get a short-lived certificate CA response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ca_components-schemas-single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Get a short-lived certificate CA response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ca_components-schemas-single_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"post":{"tags":["Zone-Level Access short-lived certificate CAs"],"summary":"Create a short-lived certificate CA","description":"Generates a new short-lived certificate CA and public key.","operationId":"zone-level-access-short-lived-certificate-c-as-create-a-short-lived-certificate-ca","parameters":[{"name":"uuid","in":"path","required":true,"schema":{"$ref":"#/components/schemas/uuid"}},{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{"4xx":{"description":"Create a short-lived certificate CA response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ca_components-schemas-single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Create a short-lived certificate CA response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ca_components-schemas-single_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/zones/{identifier}/access/apps/{uuid}/policies":{"get":{"tags":["Zone-Level Access policies"],"summary":"List Access policies","description":"Lists Access policies configured for an application.","operationId":"zone-level-access-policies-list-access-policies","parameters":[{"name":"uuid","in":"path","required":true,"schema":{"$ref":"#/components/schemas/components-schemas-uuid"}},{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/policies_components-schemas-identifier"}}],"responses":{"4xx":{"description":"List Access policies response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/policies_components-schemas-response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"List Access policies response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/policies_components-schemas-response_collection"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"post":{"tags":["Zone-Level Access policies"],"summary":"Create an Access policy","description":"Create a new Access policy for an application.","operationId":"zone-level-access-policies-create-an-access-policy","parameters":[{"name":"uuid","in":"path","required":true,"schema":{"$ref":"#/components/schemas/components-schemas-uuid"}},{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/policies_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["name","decision","include"],"properties":{"approval_groups":{"$ref":"#/components/schemas/approval_groups"},"approval_required":{"$ref":"#/components/schemas/approval_required"},"decision":{"$ref":"#/components/schemas/decision"},"exclude":{"$ref":"#/components/schemas/schemas-exclude"},"include":{"$ref":"#/components/schemas/include"},"name":{"$ref":"#/components/schemas/policies_components-schemas-name"},"precedence":{"$ref":"#/components/schemas/precedence"},"purpose_justification_prompt":{"$ref":"#/components/schemas/purpose_justification_prompt"},"purpose_justification_required":{"$ref":"#/components/schemas/purpose_justification_required"},"require":{"$ref":"#/components/schemas/schemas-require"}}}}}},"responses":{"4xx":{"description":"Create an Access policy response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/policies_components-schemas-single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Create an Access policy response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/policies_components-schemas-single_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/zones/{identifier}/access/apps/{uuid1}/policies/{uuid}":{"delete":{"tags":["Zone-Level Access policies"],"summary":"Delete an Access policy","description":"Delete an Access policy.","operationId":"zone-level-access-policies-delete-an-access-policy","parameters":[{"name":"uuid","in":"path","required":true,"schema":{"$ref":"#/components/schemas/components-schemas-uuid"}},{"name":"uuid1","in":"path","required":true,"schema":{"$ref":"#/components/schemas/components-schemas-uuid"}},{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/policies_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{"4xx":{"description":"Delete an Access policy response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/policies_components-schemas-id_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Delete an Access policy response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/policies_components-schemas-id_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"get":{"tags":["Zone-Level Access policies"],"summary":"Get an Access policy","description":"Fetches a single Access policy.","operationId":"zone-level-access-policies-get-an-access-policy","parameters":[{"name":"uuid","in":"path","required":true,"schema":{"$ref":"#/components/schemas/components-schemas-uuid"}},{"name":"uuid1","in":"path","required":true,"schema":{"$ref":"#/components/schemas/components-schemas-uuid"}},{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/policies_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Get an Access policy response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/policies_components-schemas-single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Get an Access policy response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/policies_components-schemas-single_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"put":{"tags":["Zone-Level Access policies"],"summary":"Update an Access policy","description":"Update a configured Access policy.","operationId":"zone-level-access-policies-update-an-access-policy","parameters":[{"name":"uuid","in":"path","required":true,"schema":{"$ref":"#/components/schemas/components-schemas-uuid"}},{"name":"uuid1","in":"path","required":true,"schema":{"$ref":"#/components/schemas/components-schemas-uuid"}},{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/policies_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["name","decision","include"],"properties":{"approval_groups":{"$ref":"#/components/schemas/approval_groups"},"approval_required":{"$ref":"#/components/schemas/approval_required"},"decision":{"$ref":"#/components/schemas/decision"},"exclude":{"$ref":"#/components/schemas/schemas-exclude"},"include":{"$ref":"#/components/schemas/include"},"name":{"$ref":"#/components/schemas/policies_components-schemas-name"},"precedence":{"$ref":"#/components/schemas/precedence"},"purpose_justification_prompt":{"$ref":"#/components/schemas/purpose_justification_prompt"},"purpose_justification_required":{"$ref":"#/components/schemas/purpose_justification_required"},"require":{"$ref":"#/components/schemas/schemas-require"}}}}}},"responses":{"4xx":{"description":"Update an Access policy response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/policies_components-schemas-single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Update an Access policy response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/policies_components-schemas-single_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/zones/{identifier}/access/apps/ca":{"get":{"tags":["Zone-Level Access short-lived certificate CAs"],"summary":"List short-lived certificate CAs","description":"Lists short-lived certificate CAs and their public keys.","operationId":"zone-level-access-short-lived-certificate-c-as-list-short-lived-certificate-c-as","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"List short-lived certificate CAs response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ca_components-schemas-response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"List short-lived certificate CAs response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ca_components-schemas-response_collection"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/zones/{identifier}/access/certificates":{"get":{"tags":["Zone-Level Access mTLS authentication"],"summary":"List mTLS certificates","description":"Lists all mTLS certificates.","operationId":"zone-level-access-m-tls-authentication-list-m-tls-certificates","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"List mTLS certificates response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/certificates_components-schemas-response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"List mTLS certificates response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/certificates_components-schemas-response_collection"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"post":{"tags":["Zone-Level Access mTLS authentication"],"summary":"Add an mTLS certificate","description":"Adds a new mTLS root certificate to Access.","operationId":"zone-level-access-m-tls-authentication-add-an-m-tls-certificate","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["name","certificate"],"properties":{"associated_hostnames":{"$ref":"#/components/schemas/associated_hostnames"},"certificate":{"type":"string","description":"The certificate content.","example":"-----BEGIN CERTIFICATE-----\nMIIGAjCCA+qgAwIBAgIJAI7kymlF7CWT...N4RI7KKB7nikiuUf8vhULKy5IX10\nDrUtmu/B\n-----END CERTIFICATE-----"},"name":{"$ref":"#/components/schemas/certificates_components-schemas-name"}}}}}},"responses":{"4xx":{"description":"Add an mTLS certificate response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/certificates_components-schemas-single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Add an mTLS certificate response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/certificates_components-schemas-single_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/zones/{identifier}/access/certificates/{uuid}":{"delete":{"tags":["Zone-Level Access mTLS authentication"],"summary":"Delete an mTLS certificate","description":"Deletes an mTLS certificate.","operationId":"zone-level-access-m-tls-authentication-delete-an-m-tls-certificate","parameters":[{"name":"uuid","in":"path","required":true,"schema":{"$ref":"#/components/schemas/uuid"}},{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{"4xx":{"description":"Delete an mTLS certificate response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/certificates_components-schemas-id_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Delete an mTLS certificate response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/certificates_components-schemas-id_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"get":{"tags":["Zone-Level Access mTLS authentication"],"summary":"Get an mTLS certificate","description":"Fetches a single mTLS certificate.","operationId":"zone-level-access-m-tls-authentication-get-an-m-tls-certificate","parameters":[{"name":"uuid","in":"path","required":true,"schema":{"$ref":"#/components/schemas/uuid"}},{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Get an mTLS certificate response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/certificates_components-schemas-single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Get an mTLS certificate response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/certificates_components-schemas-single_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"put":{"tags":["Zone-Level Access mTLS authentication"],"summary":"Update an mTLS certificate","description":"Updates a configured mTLS certificate.","operationId":"zone-level-access-m-tls-authentication-update-an-m-tls-certificate","parameters":[{"name":"uuid","in":"path","required":true,"schema":{"$ref":"#/components/schemas/uuid"}},{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["name","associated_hostnames"],"properties":{"associated_hostnames":{"$ref":"#/components/schemas/associated_hostnames"},"name":{"$ref":"#/components/schemas/certificates_components-schemas-name"}}}}}},"responses":{"4xx":{"description":"Update an mTLS certificate response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/certificates_components-schemas-single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Update an mTLS certificate response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/certificates_components-schemas-single_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/zones/{identifier}/access/groups":{"get":{"tags":["Zone-Level Access groups"],"summary":"List Access groups","description":"Lists all Access groups.","operationId":"zone-level-access-groups-list-access-groups","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"List Access groups response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/groups_components-schemas-response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"List Access groups response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/groups_components-schemas-response_collection"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"post":{"tags":["Zone-Level Access groups"],"summary":"Create an Access group","description":"Creates a new Access group.","operationId":"zone-level-access-groups-create-an-access-group","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["name","include"],"properties":{"exclude":{"$ref":"#/components/schemas/exclude"},"include":{"$ref":"#/components/schemas/include"},"name":{"$ref":"#/components/schemas/groups_components-schemas-name"},"require":{"$ref":"#/components/schemas/require"}}}}}},"responses":{"4xx":{"description":"Create an Access group response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/groups_components-schemas-single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Create an Access group response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/groups_components-schemas-single_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/zones/{identifier}/access/groups/{uuid}":{"delete":{"tags":["Zone-Level Access groups"],"summary":"Delete an Access group","description":"Deletes an Access group.","operationId":"zone-level-access-groups-delete-an-access-group","parameters":[{"name":"uuid","in":"path","required":true,"schema":{"$ref":"#/components/schemas/schemas-uuid"}},{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{"4xx":{"description":"Delete an Access group response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/groups_components-schemas-id_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Delete an Access group response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/groups_components-schemas-id_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"get":{"tags":["Zone-Level Access groups"],"summary":"Get an Access group","description":"Fetches a single Access group.","operationId":"zone-level-access-groups-get-an-access-group","parameters":[{"name":"uuid","in":"path","required":true,"schema":{"$ref":"#/components/schemas/schemas-uuid"}},{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Get an Access group response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/groups_components-schemas-single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Get an Access group response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/groups_components-schemas-single_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"put":{"tags":["Zone-Level Access groups"],"summary":"Update an Access group","description":"Updates a configured Access group.","operationId":"zone-level-access-groups-update-an-access-group","parameters":[{"name":"uuid","in":"path","required":true,"schema":{"$ref":"#/components/schemas/schemas-uuid"}},{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["name","include"],"properties":{"exclude":{"$ref":"#/components/schemas/exclude"},"include":{"$ref":"#/components/schemas/include"},"name":{"$ref":"#/components/schemas/groups_components-schemas-name"},"require":{"$ref":"#/components/schemas/require"}}}}}},"responses":{"4xx":{"description":"Update an Access group response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/groups_components-schemas-single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Update an Access group response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/groups_components-schemas-single_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/zones/{identifier}/access/identity_providers":{"get":{"tags":["Zone-Level Access identity providers"],"summary":"List Access identity providers","description":"Lists all configured identity providers.","operationId":"zone-level-access-identity-providers-list-access-identity-providers","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/identity-providers_components-schemas-identifier"}}],"responses":{"4xx":{"description":"List Access identity providers response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/identity-providers_components-schemas-response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"List Access identity providers response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/identity-providers_components-schemas-response_collection"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"post":{"tags":["Zone-Level Access identity providers"],"summary":"Add an Access identity provider","description":"Adds a new identity provider to Access.","operationId":"zone-level-access-identity-providers-add-an-access-identity-provider","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/identity-providers_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["name","type","config"],"properties":{"config":{"$ref":"#/components/schemas/schemas-config"},"name":{"$ref":"#/components/schemas/identity-providers_components-schemas-name"},"type":{"$ref":"#/components/schemas/identity-providers_components-schemas-type"}}}}}},"responses":{"4xx":{"description":"Add an Access identity provider response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/identity-providers_components-schemas-single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Add an Access identity provider response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/identity-providers_components-schemas-single_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/zones/{identifier}/access/identity_providers/{uuid}":{"delete":{"tags":["Zone-Level Access identity providers"],"summary":"Delete an Access identity provider","description":"Deletes an identity provider from Access.","operationId":"zone-level-access-identity-providers-delete-an-access-identity-provider","parameters":[{"name":"uuid","in":"path","required":true,"schema":{"$ref":"#/components/schemas/uuid"}},{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/identity-providers_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{"4xx":{"description":"Delete an Access identity provider response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/identity-providers_components-schemas-single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Delete an Access identity provider response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/identity-providers_components-schemas-single_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"get":{"tags":["Zone-Level Access identity providers"],"summary":"Get an Access identity provider","description":"Fetches a configured identity provider.","operationId":"zone-level-access-identity-providers-get-an-access-identity-provider","parameters":[{"name":"uuid","in":"path","required":true,"schema":{"$ref":"#/components/schemas/uuid"}},{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/identity-providers_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Get an Access identity provider response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/identity-providers_components-schemas-single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Get an Access identity provider response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/identity-providers_components-schemas-single_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"put":{"tags":["Zone-Level Access identity providers"],"summary":"Update an Access identity provider","description":"Updates a configured identity provider.","operationId":"zone-level-access-identity-providers-update-an-access-identity-provider","parameters":[{"name":"uuid","in":"path","required":true,"schema":{"$ref":"#/components/schemas/uuid"}},{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/identity-providers_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["name","type","config"],"properties":{"config":{"$ref":"#/components/schemas/schemas-config"},"name":{"$ref":"#/components/schemas/identity-providers_components-schemas-name"},"type":{"$ref":"#/components/schemas/identity-providers_components-schemas-type"}}}}}},"responses":{"4xx":{"description":"Update an Access identity provider response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/identity-providers_components-schemas-single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Update an Access identity provider response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/identity-providers_components-schemas-single_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/zones/{identifier}/access/organizations":{"get":{"tags":["Zone-Level Zero Trust organization"],"summary":"Get your Zero Trust organization","description":"Returns the configuration for your Zero Trust organization.","operationId":"zone-level-zero-trust-organization-get-your-zero-trust-organization","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/organizations_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Get your Zero Trust organization response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/organizations_components-schemas-single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Get your Zero Trust organization response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/organizations_components-schemas-single_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"post":{"tags":["Zone-Level Zero Trust organization"],"summary":"Create your Zero Trust organization","description":"Sets up a Zero Trust organization for your account.","operationId":"zone-level-zero-trust-organization-create-your-zero-trust-organization","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/organizations_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["name","auth_domain"],"properties":{"auth_domain":{"$ref":"#/components/schemas/auth_domain"},"is_ui_read_only":{"$ref":"#/components/schemas/is_ui_read_only"},"login_design":{"$ref":"#/components/schemas/login_design"},"name":{"$ref":"#/components/schemas/organizations_components-schemas-name"}}}}}},"responses":{"4xx":{"description":"Create your Zero Trust organization response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/organizations_components-schemas-single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Create your Zero Trust organization response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/organizations_components-schemas-single_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"put":{"tags":["Zone-Level Zero Trust organization"],"summary":"Update your Zero Trust organization","description":"Updates the configuration for your Zero Trust organization.","operationId":"zone-level-zero-trust-organization-update-your-zero-trust-organization","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/organizations_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"auth_domain":{"$ref":"#/components/schemas/auth_domain"},"is_ui_read_only":{"$ref":"#/components/schemas/is_ui_read_only"},"login_design":{"$ref":"#/components/schemas/login_design"},"name":{"$ref":"#/components/schemas/organizations_components-schemas-name"}}}}}},"responses":{"4xx":{"description":"Update your Zero Trust organization response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/organizations_components-schemas-single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Update your Zero Trust organization response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/organizations_components-schemas-single_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/zones/{identifier}/access/organizations/revoke_user":{"post":{"tags":["Zone-Level Zero Trust organization"],"summary":"Revoke all Access tokens for a user","description":"Revokes a user's access across all applications.","operationId":"zone-level-zero-trust-organization-revoke-all-access-tokens-for-a-user","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/organizations_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["email"],"properties":{"email":{"type":"string","description":"The email of the user to revoke.","example":"test@example.com"}}}}}},"responses":{"4xx":{"description":"Revoke all Access tokens for a user response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/schemas-empty_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Revoke all Access tokens for a user response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/schemas-empty_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/zones/{identifier}/access/service_tokens":{"get":{"tags":["Zone-Level Access service tokens"],"summary":"List service tokens","description":"Lists all service tokens.","operationId":"zone-level-access-service-tokens-list-service-tokens","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"List service tokens response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/service-tokens_components-schemas-response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"List service tokens response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/service-tokens_components-schemas-response_collection"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"post":{"tags":["Zone-Level Access service tokens"],"summary":"Create a service token","description":"Generates a new service token. **Note:** This is the only time you can get the Client Secret. If you lose the Client Secret, you will have to create a new service token.","operationId":"zone-level-access-service-tokens-create-a-service-token","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["name"],"properties":{"name":{"$ref":"#/components/schemas/service-tokens_components-schemas-name"}}}}}},"responses":{"4xx":{"description":"Create a service token response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/create_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Create a service token response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/create_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/zones/{identifier}/access/service_tokens/{uuid}":{"delete":{"tags":["Zone-Level Access service tokens"],"summary":"Delete a service token","description":"Deletes a service token.","operationId":"zone-level-access-service-tokens-delete-a-service-token","parameters":[{"name":"uuid","in":"path","required":true,"schema":{"$ref":"#/components/schemas/uuid"}},{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{"4xx":{"description":"Delete a service token response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/service-tokens_components-schemas-single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Delete a service token response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/service-tokens_components-schemas-single_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"put":{"tags":["Zone-Level Access service tokens"],"summary":"Update a service token","description":"Updates a configured service token.","operationId":"zone-level-access-service-tokens-update-a-service-token","parameters":[{"name":"uuid","in":"path","required":true,"schema":{"$ref":"#/components/schemas/uuid"}},{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"name":{"$ref":"#/components/schemas/service-tokens_components-schemas-name"}}}}}},"responses":{"4xx":{"description":"Update a service token response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/service-tokens_components-schemas-single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Update a service token response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/service-tokens_components-schemas-single_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/zones/{identifier}/activation_check":{"put":{"tags":["Zone"],"summary":"Zone Activation Check","description":"Initiates another zone activation check.","operationId":"zone-zone-activation-check","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{"4xx":{"description":"Zone Activation Check response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-response-single-id"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Zone Activation Check response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-response-single-id"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/zones/{identifier}/dns_analytics/report":{"get":{"tags":["DNS Analytics"],"summary":"Table","description":"Retrieves a list of summarised aggregate metrics over a given time period.","operationId":"dns-analytics-table","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Table response failure","content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"type":"object","properties":{"result":{"$ref":"#/components/schemas/result"}}}]},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Table response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"type":"object","properties":{"result":{"$ref":"#/components/schemas/result"}}}]}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/zones/{identifier}/dns_analytics/report/bytime":{"get":{"tags":["DNS Analytics"],"summary":"By Time","description":"Retrieves a list of aggregate metrics grouped by time interval.","operationId":"dns-analytics-by-time","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"By Time response failure","content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"type":"object","properties":{"result":{"$ref":"#/components/schemas/result"}}}]},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"By Time response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"type":"object","properties":{"result":{"$ref":"#/components/schemas/result"}}}]}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/zones/{identifier}/load_balancers":{"get":{"tags":["Load Balancers"],"summary":"List Load Balancers","description":"List configured load balancers.","operationId":"load-balancers-list-load-balancers","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/load-balancer_components-schemas-identifier"}}],"responses":{"4xx":{"description":"List Load Balancers response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/load-balancer_components-schemas-response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"List Load Balancers response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/load-balancer_components-schemas-response_collection"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"post":{"tags":["Load Balancers"],"summary":"Create Load Balancer","description":"Create a new load balancer.","operationId":"load-balancers-create-load-balancer","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/load-balancer_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["name","default_pools","fallback_pool"],"properties":{"adaptive_routing":{"$ref":"#/components/schemas/adaptive_routing"},"country_pools":{"$ref":"#/components/schemas/country_pools"},"default_pools":{"$ref":"#/components/schemas/default_pools"},"description":{"$ref":"#/components/schemas/load-balancer_components-schemas-description"},"fallback_pool":{"$ref":"#/components/schemas/fallback_pool"},"location_strategy":{"$ref":"#/components/schemas/location_strategy"},"name":{"$ref":"#/components/schemas/load-balancer_components-schemas-name"},"pop_pools":{"$ref":"#/components/schemas/pop_pools"},"proxied":{"$ref":"#/components/schemas/schemas-proxied"},"random_steering":{"$ref":"#/components/schemas/random_steering"},"region_pools":{"$ref":"#/components/schemas/region_pools"},"rules":{"$ref":"#/components/schemas/load-balancer_components-schemas-rules"},"session_affinity":{"$ref":"#/components/schemas/session_affinity"},"session_affinity_attributes":{"$ref":"#/components/schemas/session_affinity_attributes"},"session_affinity_ttl":{"$ref":"#/components/schemas/session_affinity_ttl"},"steering_policy":{"$ref":"#/components/schemas/steering_policy"},"ttl":{"$ref":"#/components/schemas/schemas-ttl"}}}}}},"responses":{"4xx":{"description":"Create Load Balancer response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/load-balancer_components-schemas-single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Create Load Balancer response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/load-balancer_components-schemas-single_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/zones/{identifier}/purge_cache":{"post":{"tags":["Zone"],"summary":"Purge Files by Cache-Tags, Host, or Prefix","description":"Granularly removes one or more files from Cloudflare's cache either by specifying the host, the associated Cache-Tag, or a Prefix.\n\n**NB:** Cache-Tag, host, and prefix purging each have a rate limit of 30,000 purge API calls in every 24 hour period. You may purge up to 30 tags, hosts, or prefixes in one API call. This rate limit can be raised for customers who need to purge at higher volume.","operationId":"zone-purge-files-by-cache-tags,-host,-or-prefix","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/purge_by_cache_tags_or_hosts_or_prefixes"}}}},"responses":{"4xx":{"description":"Purge Files by Cache-Tags, Host, or Prefix response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-response-single-id"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Purge Files by Cache-Tags, Host, or Prefix response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-response-single-id"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/zones/{identifier}/secondary_dns/force_axfr":{"post":{"tags":["Secondary DNS (Secondary Zone)"],"summary":"Force AXFR","description":"Sends AXFR zone transfer request to primary nameserver(s).","operationId":"secondary-dns-(-secondary-zone)-force-axfr","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/dns-secondary-secondary-zone_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{"4xx":{"description":"Force AXFR response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/force_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Force AXFR response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/force_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/zones/{identifier}/secondary_dns/incoming":{"delete":{"tags":["Secondary DNS (Secondary Zone)"],"summary":"Delete Secondary Zone Configuration","description":"Delete secondary zone configuration for incoming zone transfers.","operationId":"secondary-dns-(-secondary-zone)-delete-secondary-zone-configuration","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/dns-secondary-secondary-zone_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{"4xx":{"description":"Delete Secondary Zone Configuration response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/id_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Delete Secondary Zone Configuration response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/id_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"get":{"tags":["Secondary DNS (Secondary Zone)"],"summary":"Secondary Zone Configuration Details","description":"Get secondary zone configuration for incoming zone transfers.","operationId":"secondary-dns-(-secondary-zone)-secondary-zone-configuration-details","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/dns-secondary-secondary-zone_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Secondary Zone Configuration Details response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/single_response_incoming"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Secondary Zone Configuration Details response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/single_response_incoming"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"post":{"tags":["Secondary DNS (Secondary Zone)"],"summary":"Create Secondary Zone Configuration","description":"Create secondary zone configuration for incoming zone transfers.","operationId":"secondary-dns-(-secondary-zone)-create-secondary-zone-configuration","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/dns-secondary-secondary-zone_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dns-secondary-secondary-zone"}}}},"responses":{"4xx":{"description":"Create Secondary Zone Configuration response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/single_response_incoming"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Create Secondary Zone Configuration response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/single_response_incoming"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"put":{"tags":["Secondary DNS (Secondary Zone)"],"summary":"Update Secondary Zone Configuration","description":"Update secondary zone configuration for incoming zone transfers.","operationId":"secondary-dns-(-secondary-zone)-update-secondary-zone-configuration","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/dns-secondary-secondary-zone_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dns-secondary-secondary-zone"}}}},"responses":{"4xx":{"description":"Update Secondary Zone Configuration response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/single_response_incoming"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Update Secondary Zone Configuration response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/single_response_incoming"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/zones/{identifier}/secondary_dns/outgoing":{"delete":{"tags":["Secondary DNS (Primary Zone)"],"summary":"Delete Primary Zone Configuration","description":"Delete primary zone configuration for outgoing zone transfers.","operationId":"secondary-dns-(-primary-zone)-delete-primary-zone-configuration","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/dns-secondary-primary-zone_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{"4xx":{"description":"Delete Primary Zone Configuration response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/schemas-id_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Delete Primary Zone Configuration response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/schemas-id_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"get":{"tags":["Secondary DNS (Primary Zone)"],"summary":"Primary Zone Configuration Details","description":"Get primary zone configuration for outgoing zone transfers.","operationId":"secondary-dns-(-primary-zone)-primary-zone-configuration-details","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/dns-secondary-primary-zone_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Primary Zone Configuration Details response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/single_response_outgoing"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Primary Zone Configuration Details response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/single_response_outgoing"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"post":{"tags":["Secondary DNS (Primary Zone)"],"summary":"Create Primary Zone Configuration","description":"Create primary zone configuration for outgoing zone transfers.","operationId":"secondary-dns-(-primary-zone)-create-primary-zone-configuration","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/dns-secondary-primary-zone_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/single_request_outgoing"}}}},"responses":{"4xx":{"description":"Create Primary Zone Configuration response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/single_response_outgoing"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Create Primary Zone Configuration response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/single_response_outgoing"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"put":{"tags":["Secondary DNS (Primary Zone)"],"summary":"Update Primary Zone Configuration","description":"Update primary zone configuration for outgoing zone transfers.","operationId":"secondary-dns-(-primary-zone)-update-primary-zone-configuration","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/dns-secondary-primary-zone_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/single_request_outgoing"}}}},"responses":{"4xx":{"description":"Update Primary Zone Configuration response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/single_response_outgoing"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Update Primary Zone Configuration response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/single_response_outgoing"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/zones/{identifier}/secondary_dns/outgoing/disable":{"post":{"tags":["Secondary DNS (Primary Zone)"],"summary":"Disable Outgoing Zone Transfers","description":"Disable outgoing zone transfers for primary zone and clears IXFR backlog of primary zone.","operationId":"secondary-dns-(-primary-zone)-disable-outgoing-zone-transfers","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/dns-secondary-primary-zone_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{"4xx":{"description":"Disable Outgoing Zone Transfers response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/disable_transfer_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Disable Outgoing Zone Transfers response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/disable_transfer_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/zones/{identifier}/secondary_dns/outgoing/enable":{"post":{"tags":["Secondary DNS (Primary Zone)"],"summary":"Enable Outgoing Zone Transfers","description":"Enable outgoing zone transfers for primary zone.","operationId":"secondary-dns-(-primary-zone)-enable-outgoing-zone-transfers","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/dns-secondary-primary-zone_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{"4xx":{"description":"Enable Outgoing Zone Transfers response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/enable_transfer_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Enable Outgoing Zone Transfers response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/enable_transfer_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/zones/{identifier}/secondary_dns/outgoing/force_notify":{"post":{"tags":["Secondary DNS (Primary Zone)"],"summary":"Force DNS NOTIFY","description":"Notifies the secondary nameserver(s) and clears IXFR backlog of primary zone.","operationId":"secondary-dns-(-primary-zone)-force-dns-notify","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/dns-secondary-primary-zone_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{"4xx":{"description":"Force DNS NOTIFY response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/schemas-force_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Force DNS NOTIFY response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/schemas-force_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/zones/{identifier}/secondary_dns/outgoing/status":{"get":{"tags":["Secondary DNS (Primary Zone)"],"summary":"Get Outgoing Zone Transfer Status","description":"Get primary zone transfer status.","operationId":"secondary-dns-(-primary-zone)-get-outgoing-zone-transfer-status","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/dns-secondary-primary-zone_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Get Outgoing Zone Transfer Status response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/enable_transfer_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Get Outgoing Zone Transfer Status response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/enable_transfer_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/zones/{identifier}/ssl/analyze":{"post":{"tags":["Analyze Certificate"],"summary":"Analyze Certificate","description":"Returns the set of hostnames, the signature algorithm, and the expiration date of the certificate.","operationId":"analyze-certificate-analyze-certificate","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"bundle_method":{"$ref":"#/components/schemas/bundle_method"},"certificate":{"$ref":"#/components/schemas/certificate"}}}}}},"responses":{"4xx":{"description":"Analyze Certificate response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/certificate_analyze_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Analyze Certificate response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/certificate_analyze_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/zones/{identifier}/subscription":{"get":{"tags":["Zone Subscription"],"summary":"Zone Subscription Details","description":"Lists zone subscription details.","operationId":"zone-subscription-zone-subscription-details","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/subscription-v2_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Zone Subscription Details response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zone_subscription_response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Zone Subscription Details response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/zone_subscription_response_single"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"post":{"tags":["Zone Subscription"],"summary":"Create Zone Subscription","description":"Create a zone subscription, either plan or add-ons.","operationId":"zone-subscription-create-zone-subscription","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/subscription-v2_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/subscription-v2"}}}},"responses":{"4xx":{"description":"Create Zone Subscription response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zone_subscription_response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Create Zone Subscription response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/zone_subscription_response_single"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"put":{"tags":["Zone Subscription"],"summary":"Update Zone Subscription","description":"Updates zone subscriptions, either plan or add-ons.","operationId":"zone-subscription-update-zone-subscription","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/subscription-v2_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/subscription-v2"}}}},"responses":{"4xx":{"description":"Update Zone Subscription response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zone_subscription_response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Update Zone Subscription response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/zone_subscription_response_single"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/zones/{identifier1}/load_balancers/{identifier}":{"delete":{"tags":["Load Balancers"],"summary":"Delete Load Balancer","description":"Delete a configured load balancer.","operationId":"load-balancers-delete-load-balancer","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/load-balancer_components-schemas-identifier"}},{"name":"identifier1","in":"path","required":true,"schema":{"$ref":"#/components/schemas/load-balancer_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{"4xx":{"description":"Delete Load Balancer response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/load-balancer_components-schemas-id_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Delete Load Balancer response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/load-balancer_components-schemas-id_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"get":{"tags":["Load Balancers"],"summary":"Load Balancer Details","description":"Fetch a single configured load balancer.","operationId":"load-balancers-load-balancer-details","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/load-balancer_components-schemas-identifier"}},{"name":"identifier1","in":"path","required":true,"schema":{"$ref":"#/components/schemas/load-balancer_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Load Balancer Details response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/load-balancer_components-schemas-single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Load Balancer Details response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/load-balancer_components-schemas-single_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"patch":{"tags":["Load Balancers"],"summary":"Patch Load Balancer","description":"Apply changes to an existing load balancer, overwriting the supplied properties.","operationId":"load-balancers-patch-load-balancer","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/load-balancer_components-schemas-identifier"}},{"name":"identifier1","in":"path","required":true,"schema":{"$ref":"#/components/schemas/load-balancer_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"adaptive_routing":{"$ref":"#/components/schemas/adaptive_routing"},"country_pools":{"$ref":"#/components/schemas/country_pools"},"default_pools":{"$ref":"#/components/schemas/default_pools"},"description":{"$ref":"#/components/schemas/load-balancer_components-schemas-description"},"enabled":{"$ref":"#/components/schemas/load-balancer_components-schemas-enabled"},"fallback_pool":{"$ref":"#/components/schemas/fallback_pool"},"location_strategy":{"$ref":"#/components/schemas/location_strategy"},"name":{"$ref":"#/components/schemas/load-balancer_components-schemas-name"},"pop_pools":{"$ref":"#/components/schemas/pop_pools"},"proxied":{"$ref":"#/components/schemas/schemas-proxied"},"random_steering":{"$ref":"#/components/schemas/random_steering"},"region_pools":{"$ref":"#/components/schemas/region_pools"},"rules":{"$ref":"#/components/schemas/load-balancer_components-schemas-rules"},"session_affinity":{"$ref":"#/components/schemas/session_affinity"},"session_affinity_attributes":{"$ref":"#/components/schemas/session_affinity_attributes"},"session_affinity_ttl":{"$ref":"#/components/schemas/session_affinity_ttl"},"steering_policy":{"$ref":"#/components/schemas/steering_policy"},"ttl":{"$ref":"#/components/schemas/schemas-ttl"}}}}}},"responses":{"4xx":{"description":"Patch Load Balancer response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/load-balancer_components-schemas-single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Patch Load Balancer response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/load-balancer_components-schemas-single_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"put":{"tags":["Load Balancers"],"summary":"Update Load Balancer","description":"Update a configured load balancer.","operationId":"load-balancers-update-load-balancer","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/load-balancer_components-schemas-identifier"}},{"name":"identifier1","in":"path","required":true,"schema":{"$ref":"#/components/schemas/load-balancer_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["name","default_pools","fallback_pool"],"properties":{"adaptive_routing":{"$ref":"#/components/schemas/adaptive_routing"},"country_pools":{"$ref":"#/components/schemas/country_pools"},"default_pools":{"$ref":"#/components/schemas/default_pools"},"description":{"$ref":"#/components/schemas/load-balancer_components-schemas-description"},"enabled":{"$ref":"#/components/schemas/load-balancer_components-schemas-enabled"},"fallback_pool":{"$ref":"#/components/schemas/fallback_pool"},"location_strategy":{"$ref":"#/components/schemas/location_strategy"},"name":{"$ref":"#/components/schemas/load-balancer_components-schemas-name"},"pop_pools":{"$ref":"#/components/schemas/pop_pools"},"proxied":{"$ref":"#/components/schemas/schemas-proxied"},"random_steering":{"$ref":"#/components/schemas/random_steering"},"region_pools":{"$ref":"#/components/schemas/region_pools"},"rules":{"$ref":"#/components/schemas/load-balancer_components-schemas-rules"},"session_affinity":{"$ref":"#/components/schemas/session_affinity"},"session_affinity_attributes":{"$ref":"#/components/schemas/session_affinity_attributes"},"session_affinity_ttl":{"$ref":"#/components/schemas/session_affinity_ttl"},"steering_policy":{"$ref":"#/components/schemas/steering_policy"},"ttl":{"$ref":"#/components/schemas/schemas-ttl"}}}}}},"responses":{"4xx":{"description":"Update Load Balancer response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/load-balancer_components-schemas-single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Update Load Balancer response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/load-balancer_components-schemas-single_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/zones/{zone_id}/activation_check":{"put":{"tags":["Client"],"summary":"Rerun the Activation Check","description":"Triggeres a new activation check for a PENDING Zone. This can be\ntriggered every 5 min for paygo/ent customers, every hour for FREE\nZones.","operationId":"put-zones-zone_id-activation_check","parameters":[{"name":"zone_id","in":"path","description":"Zone ID","required":true,"schema":{"$ref":"#/components/schemas/identifier"}}],"responses":{"4xx":{"description":"Client Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Successful Response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"type":"object","properties":{"result":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/identifier"}}}}}]}}}}}}},"/zones/{zone_id}/api_gateway/configuration":{"get":{"tags":["API Shield Settings"],"summary":"Retrieve information about specific configuration properties","operationId":"api-shield-settings-retrieve-information-about-specific-configuration-properties","parameters":[{"name":"zone_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Retrieve information about specific configuration properties response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Retrieve information about specific configuration properties response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/single_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"put":{"tags":["API Shield Settings"],"summary":"Set configuration properties","operationId":"api-shield-settings-set-configuration-properties","parameters":[{"name":"zone_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/configuration"}}}},"responses":{"4xx":{"description":"Set configuration properties response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/default_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Set configuration properties response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/default_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/zones/{zone_id}/api_gateway/discovery":{"get":{"tags":["API Shield Endpoint Management"],"summary":"Retrieve API Discovery results for a zone","description":"Retrieve the most up to date view of API Discovery on a zone.","operationId":"api-shield-endpoint-management-retrieve-api-discovery-results-for-a-zone","parameters":[{"name":"zone_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Retrieve API Discovery results for a zone response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/schema_response_discovery"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Retrieve API Discovery results for a zone response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/schema_response_discovery"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/zones/{zone_id}/api_gateway/operations":{"get":{"tags":["API Shield Endpoint Management"],"summary":"Retrieve information about all operations on a zone","operationId":"api-shield-endpoint-management-retrieve-information-about-all-operations-on-a-zone","parameters":[{"name":"zone_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Retrieve information about all operations on a zone response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/collection_response_paginated"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Retrieve information about all operations on a zone response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/collection_response_paginated"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"post":{"tags":["API Shield Endpoint Management"],"summary":"Add operations to a zone","description":"Add one or more operations to a zone. Endpoints can contain path variables. Host, method, endpoint will be normalized to a canoncial form when creating an operation and must be unique on the zone. Inserting an operation that matches an existing one will return the record of the already existing operation and update its last_updated date.","operationId":"api-shield-endpoint-management-add-operations-to-a-zone","parameters":[{"name":"zone_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"endpoint":{"$ref":"#/components/schemas/endpoint"},"host":{"$ref":"#/components/schemas/host"},"method":{"$ref":"#/components/schemas/method"}}},"required":["host","method","endpoint"]}}}},"responses":{"4xx":{"description":"Add operations to a zone response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/collection_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Add operations to a zone response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/collection_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/zones/{zone_id}/api_gateway/operations/{operation_id}":{"delete":{"tags":["API Shield Endpoint Management"],"summary":"Delete an operation","operationId":"api-shield-endpoint-management-delete-an-operation","parameters":[{"name":"operation_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/operation_id"}},{"name":"zone_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{"4xx":{"description":"Delete an operation response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/default_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Delete an operation response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/default_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"get":{"tags":["API Shield Endpoint Management"],"summary":"Retrieve information about an operation","operationId":"api-shield-endpoint-management-retrieve-information-about-an-operation","parameters":[{"name":"operation_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/operation_id"}},{"name":"zone_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Retrieve information about an operation response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/schemas-single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Retrieve information about an operation response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/schemas-single_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/zones/{zone_id}/api_gateway/schemas":{"get":{"tags":["API Shield Endpoint Management"],"summary":"Retrieve operations and features as OpenAPI schemas","operationId":"api-shield-endpoint-management-retrieve-operations-and-features-as-open-api-schemas","parameters":[{"name":"zone_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Retrieve operations and features as OpenAPI schemas response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/schema_response_with_thresholds"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Retrieve operations and features as OpenAPI schemas response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/schema_response_with_thresholds"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/zones/{zone_id}/firewall/access_rules/rules":{"get":{"tags":["IP Access rules for a zone"],"summary":"List IP Access rules","description":"Fetches IP Access rules of a zone. You can filter the results using several optional parameters.","operationId":"ip-access-rules-for-a-zone-list-ip-access-rules","parameters":[{"name":"zone_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"List IP Access rules response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/rule_collection_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"List IP Access rules response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/rule_collection_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"post":{"tags":["IP Access rules for a zone"],"summary":"Create an IP Access rule","description":"Creates a new IP Access rule for a zone.\n\nNote: To create an IP Access rule that applies to multiple zones, refer to [IP Access rules for a user](#ip-access-rules-for-a-user) or [IP Access rules for an account](#ip-access-rules-for-an-account) as appropriate.","operationId":"ip-access-rules-for-a-zone-create-an-ip-access-rule","parameters":[{"name":"zone_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["mode","configuration","notes"],"properties":{"configuration":{"$ref":"#/components/schemas/schemas-configuration"},"mode":{"$ref":"#/components/schemas/schemas-mode"},"notes":{"$ref":"#/components/schemas/notes"}}}}}},"responses":{"4xx":{"description":"Create an IP Access rule response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/rule_single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Create an IP Access rule response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/rule_single_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/zones/{zone_id}/firewall/access_rules/rules/{identifier}":{"delete":{"tags":["IP Access rules for a zone"],"summary":"Delete an IP Access rule","description":"Deletes an IP Access rule defined at the zone level.\n\nOptionally, you can use the `cascade` property to specify that you wish to delete similar rules in other zones managed by the same zone owner.","operationId":"ip-access-rules-for-a-zone-delete-an-ip-access-rule","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/rule_components-schemas-identifier"}},{"name":"zone_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"cascade":{"type":"string","description":"The level to attempt to delete similar rules defined for other zones with the same owner. The default value is `none`, which will only delete the current rule. Using `basic` will delete rules that match the same action (mode) and configuration, while using `aggressive` will delete rules that match the same configuration.","enum":["none","basic","aggressive"],"default":"none"}}}}}},"responses":{"4xx":{"description":"Delete an IP Access rule response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/rule_single_id_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Delete an IP Access rule response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/rule_single_id_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"patch":{"tags":["IP Access rules for a zone"],"summary":"Update an IP Access rule","description":"Updates an IP Access rule defined at the zone level. You can only update the rule action (`mode` parameter) and notes.","operationId":"ip-access-rules-for-a-zone-update-an-ip-access-rule","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/rule_components-schemas-identifier"}},{"name":"zone_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"mode":{"$ref":"#/components/schemas/schemas-mode"},"notes":{"$ref":"#/components/schemas/notes"}}}}}},"responses":{"4xx":{"description":"Update an IP Access rule response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/rule_single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Update an IP Access rule response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/rule_single_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/zones/{zone_id}/firewall/waf/packages/{package_id}/rules":{"get":{"tags":["WAF rules"],"summary":"List WAF rules","description":"Fetches WAF rules in a WAF package.","operationId":"waf-rules-list-waf-rules","parameters":[{"name":"package_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/package_components-schemas-identifier"}},{"name":"zone_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"List WAF rules response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/rule_response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"List WAF rules response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/rule_response_collection"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/zones/{zone_id}/firewall/waf/packages/{package_id}/rules/{identifier}":{"get":{"tags":["WAF rules"],"summary":"Get a WAF rule","description":"Fetches the details of a WAF rule in a WAF package.","operationId":"waf-rules-get-a-waf-rule","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/rule_components-schemas-identifier-2"}},{"name":"package_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/package_components-schemas-identifier"}},{"name":"zone_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Get a WAF rule response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/rule_response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Get a WAF rule response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/rule_response_single"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"patch":{"tags":["WAF rules"],"summary":"Update a WAF rule","description":"Updates a WAF rule. You can only update the mode/action of the rule.","operationId":"waf-rules-update-a-waf-rule","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/rule_components-schemas-identifier-2"}},{"name":"package_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/package_components-schemas-identifier"}},{"name":"zone_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"mode":{"description":"The mode/action of the rule when triggered. You must use a value from the `allowed_modes` array of the current rule.","enum":["default","disable","simulate","block","challenge","on","off"],"example":"on"}}}}}},"responses":{"4xx":{"description":"Update a WAF rule response failure","content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/rule_response_single"},{"properties":{"result":{"oneOf":[{"$ref":"#/components/schemas/anomaly_rule"},{"$ref":"#/components/schemas/traditional_deny_rule"},{"$ref":"#/components/schemas/traditional_allow_rule"}]}}}]},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Update a WAF rule response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/rule_response_single"},{"properties":{"result":{"oneOf":[{"$ref":"#/components/schemas/anomaly_rule"},{"$ref":"#/components/schemas/traditional_deny_rule"},{"$ref":"#/components/schemas/traditional_allow_rule"}]}}}]}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/zones/{zone_id}/managed_headers":{"get":{"tags":["Managed Transforms"],"summary":"List Managed Transforms","description":"Fetches a list of all Managed Transforms.","operationId":"managed-transforms-list-managed-transforms","parameters":[{"name":"zone_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"List Managed Transforms response failure","content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"managed_request_headers":{"$ref":"#/components/schemas/request_list"},"managed_response_headers":{"$ref":"#/components/schemas/request_list"}}},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"List Managed Transforms response","content":{"application/json":{"schema":{"type":"object","properties":{"managed_request_headers":{"$ref":"#/components/schemas/request_list"},"managed_response_headers":{"$ref":"#/components/schemas/request_list"}}}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"patch":{"tags":["Managed Transforms"],"summary":"Update status of Managed Transforms","description":"Updates the status of one or more Managed Transforms.","operationId":"managed-transforms-update-status-of-managed-transforms","parameters":[{"name":"zone_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["managed_request_headers","managed_response_headers"],"properties":{"managed_request_headers":{"$ref":"#/components/schemas/request_list"},"managed_response_headers":{"$ref":"#/components/schemas/request_list"}}}}}},"responses":{"4xx":{"description":"Update status of Managed Transforms response failure","content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"managed_request_headers":{"$ref":"#/components/schemas/response_list"},"managed_response_headers":{"$ref":"#/components/schemas/response_list"}}},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Update status of Managed Transforms response","content":{"application/json":{"schema":{"type":"object","properties":{"managed_request_headers":{"$ref":"#/components/schemas/response_list"},"managed_response_headers":{"$ref":"#/components/schemas/response_list"}}}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/zones/{zone_id}/page_shield":{"get":{"tags":["Page Shield"],"summary":"Get Page Shield settings","description":"Fetches the Page Shield settings.","operationId":"page-shield-get-page-shield-settings","parameters":[{"name":"zone_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Get Page Shield settings response failure","content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single"},{"properties":{"result":{"$ref":"#/components/schemas/get-zone-settings-response"}}}]},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Get Page Shield settings response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single"},{"properties":{"result":{"$ref":"#/components/schemas/get-zone-settings-response"}}}]}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"put":{"tags":["Page Shield"],"summary":"Update Page Shield settings","description":"Updates Page Shield settings.","operationId":"page-shield-update-page-shield-settings","parameters":[{"name":"zone_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"enabled":{"$ref":"#/components/schemas/script-monitor_components-schemas-enabled"},"use_cloudflare_reporting_endpoint":{"$ref":"#/components/schemas/use_cloudflare_reporting_endpoint"},"use_connection_url_path":{"$ref":"#/components/schemas/use_connection_url_path"}}}}}},"responses":{"4xx":{"description":"Update Page Shield settings response failure","content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single"},{"properties":{"result":{"$ref":"#/components/schemas/update-zone-settings-response"}}}]},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Update Page Shield settings response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single"},{"properties":{"result":{"$ref":"#/components/schemas/update-zone-settings-response"}}}]}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/zones/{zone_id}/page_shield/connections":{"get":{"tags":["Page Shield"],"summary":"List Page Shield connections","description":"Lists all connections detected by Page Shield.","operationId":"page-shield-list-page-shield-connections","parameters":[{"name":"zone_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"List Page Shield connections response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/list-zone-connections-response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"List Page Shield connections response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/list-zone-connections-response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/zones/{zone_id}/page_shield/connections/{id}":{"get":{"tags":["Page Shield"],"summary":"Get a Page Shield connection","description":"Fetches a connection detected by Page Shield by connection ID.","operationId":"page-shield-get-a-page-shield-connection","parameters":[{"name":"id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/script-monitor_components-schemas-id"}},{"name":"zone_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Get a Page Shield connection response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/get-zone-connection-response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Get a Page Shield connection response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/get-zone-connection-response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/zones/{zone_id}/page_shield/scripts":{"get":{"tags":["Page Shield"],"summary":"List Page Shield scripts","description":"Lists all scripts detected by Page Shield.","operationId":"page-shield-list-page-shield-scripts","parameters":[{"name":"zone_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"List Page Shield scripts response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/list-zone-scripts-response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"List Page Shield scripts response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/list-zone-scripts-response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/zones/{zone_id}/page_shield/scripts/{id}":{"get":{"tags":["Page Shield"],"summary":"Get a Page Shield script","description":"Fetches a script detected by Page Shield by script ID.","operationId":"page-shield-get-a-page-shield-script","parameters":[{"name":"id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/script-monitor_components-schemas-id"}},{"name":"zone_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Get a Page Shield script response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/get-zone-script-response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Get a Page Shield script response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/get-zone-script-response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/zones/{zone_id}/rulesets":{"get":{"tags":["Zone Rulesets"],"summary":"List zone rulesets","description":"Fetches all rulesets at the zone level.","operationId":"zone-rulesets-list-zone-rulesets","parameters":[{"name":"zone_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"List zone rulesets response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/rulesets_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"List zone rulesets response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/rulesets_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"post":{"tags":["Zone Rulesets"],"summary":"Create a zone ruleset","description":"Creates a ruleset at the zone level.","operationId":"zone-rulesets-create-a-zone-ruleset","parameters":[{"name":"zone_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/create_ruleset"}}}},"responses":{"4xx":{"description":"Create a zone ruleset response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ruleset_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Create a zone ruleset response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ruleset_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/zones/{zone_id}/rulesets/{ruleset_id}":{"delete":{"tags":["Zone Rulesets"],"summary":"Delete a zone ruleset","description":"Deletes all versions of an existing zone ruleset.","operationId":"zone-rulesets-delete-a-zone-ruleset","parameters":[{"name":"ruleset_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/rulesets_components-schemas-id"}},{"name":"zone_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{"4xx":{"description":"Delete a zone ruleset response failure","content":{"application/json":{}}},"200":{"description":"Delete a zone ruleset response","content":{"application/json":{}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"get":{"tags":["Zone Rulesets"],"summary":"Get a zone ruleset","description":"Fetches the latest version of a zone ruleset.","operationId":"zone-rulesets-get-a-zone-ruleset","parameters":[{"name":"ruleset_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/rulesets_components-schemas-id"}},{"name":"zone_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Get a zone ruleset response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ruleset_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Get a zone ruleset response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ruleset_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"put":{"tags":["Zone Rulesets"],"summary":"Update a zone ruleset","description":"Updates a zone ruleset, creating a new version.","operationId":"zone-rulesets-update-a-zone-ruleset","parameters":[{"name":"ruleset_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/rulesets_components-schemas-id"}},{"name":"zone_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/update_ruleset"}}}},"responses":{"4xx":{"description":"Update a zone ruleset response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ruleset_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Update a zone ruleset response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ruleset_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/zones/{zone_id}/rulesets/{ruleset_id}/rules":{"post":{"tags":["Zone Rulesets"],"summary":"Create a zone ruleset rule","description":"Adds a new rule to a zone ruleset. The rule will be added to the end of the existing list of rules in the ruleset.","operationId":"zone-rulesets-create-a-zone-ruleset-rule","parameters":[{"name":"ruleset_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/rulesets_components-schemas-id"}},{"name":"zone_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/create_update_rule"}}}},"responses":{"4xx":{"description":"Create a zone ruleset rule response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ruleset_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Create a zone ruleset rule response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ruleset_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/zones/{zone_id}/rulesets/{ruleset_id}/rules/{rule_id}":{"delete":{"tags":["Zone Rulesets"],"summary":"Delete a zone ruleset rule","description":"Deletes an existing rule from a zone ruleset.","operationId":"zone-rulesets-delete-a-zone-ruleset-rule","parameters":[{"name":"rule_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/rules_components-schemas-id"}},{"name":"ruleset_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/rulesets_components-schemas-id"}},{"name":"zone_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{"4xx":{"description":"Delete a zone ruleset rule response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ruleset_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Delete a zone ruleset rule response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ruleset_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"patch":{"tags":["Zone Rulesets"],"summary":"Update a zone ruleset rule","description":"Updates an existing rule in a zone ruleset.","operationId":"zone-rulesets-update-a-zone-ruleset-rule","parameters":[{"name":"rule_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/rules_components-schemas-id"}},{"name":"ruleset_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/rulesets_components-schemas-id"}},{"name":"zone_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/create_update_rule"}}}},"responses":{"4xx":{"description":"Update a zone ruleset rule response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ruleset_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Update a zone ruleset rule response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ruleset_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/zones/{zone_id}/rulesets/{ruleset_id}/versions":{"get":{"tags":["Zone Rulesets"],"summary":"List a zone ruleset's versions","description":"Fetches the versions of a zone ruleset.","operationId":"zone-rulesets-list-a-zone-ruleset'-s-versions","parameters":[{"name":"ruleset_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/rulesets_components-schemas-id"}},{"name":"zone_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"List a zone ruleset's versions response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/rulesets_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"List a zone ruleset's versions response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/rulesets_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/zones/{zone_id}/rulesets/{ruleset_id}/versions/{ruleset_version}":{"delete":{"tags":["Zone Rulesets"],"summary":"Delete a zone ruleset version","description":"Deletes an existing version of a zone ruleset.","operationId":"zone-rulesets-delete-a-zone-ruleset-version","parameters":[{"name":"ruleset_version","in":"path","required":true,"schema":{"$ref":"#/components/schemas/version"}},{"name":"ruleset_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/rulesets_components-schemas-id"}},{"name":"zone_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{"4xx":{"description":"Delete a zone ruleset version response failure","content":{"application/json":{}}},"200":{"description":"Delete a zone ruleset version response","content":{"application/json":{}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"get":{"tags":["Zone Rulesets"],"summary":"Get a zone ruleset version","description":"Fetches a specific version of a zone ruleset.","operationId":"zone-rulesets-get-a-zone-ruleset-version","parameters":[{"name":"ruleset_version","in":"path","required":true,"schema":{"$ref":"#/components/schemas/version"}},{"name":"ruleset_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/rulesets_components-schemas-id"}},{"name":"zone_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Get a zone ruleset version response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ruleset_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Get a zone ruleset version response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ruleset_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/zones/{zone_id}/rulesets/phases/{phase}/entrypoint":{"get":{"tags":["Transform Rules"],"summary":"List Transform Rules","description":"Fetches all Transform Rules in a zone.","operationId":"transform-rules-list-transform-rules","parameters":[{"name":"phase","in":"path","required":true,"schema":{"$ref":"#/components/schemas/schemas-phase"}},{"name":"zone_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"List Transform Rules response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/schemas-ruleset"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"List Transform Rules response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/schemas-ruleset"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"put":{"tags":["Transform Rules"],"summary":"Update Transform Rules","description":"Updates the Transform Rules of a zone.","operationId":"transform-rules-update-transform-rules","parameters":[{"name":"phase","in":"path","required":true,"schema":{"$ref":"#/components/schemas/schemas-phase"}},{"name":"zone_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/update_ruleset"}}}},"responses":{"4xx":{"description":"Update Transform Rules response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Update Transform Rules response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-response-single"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/zones/{zone_id}/rulesets/phases/{ruleset_phase}/entrypoint":{"get":{"tags":["Zone Rulesets"],"summary":"Get a zone entry point ruleset","description":"Fetches the latest version of the zone entry point ruleset for a given phase.","operationId":"zone-rulesets-get-a-zone-entry-point-ruleset","parameters":[{"name":"ruleset_phase","in":"path","required":true,"schema":{"$ref":"#/components/schemas/phase"}},{"name":"zone_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Get a zone entry point ruleset response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ruleset_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Get a zone entry point ruleset response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ruleset_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"put":{"tags":["Zone Rulesets"],"summary":"Update a zone entry point ruleset","description":"Updates a zone entry point ruleset, creating a new version.","operationId":"zone-rulesets-update-a-zone-entry-point-ruleset","parameters":[{"name":"ruleset_phase","in":"path","required":true,"schema":{"$ref":"#/components/schemas/phase"}},{"name":"zone_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/update_ruleset"}}}},"responses":{"4xx":{"description":"Update a zone entry point ruleset response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ruleset_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Update a zone entry point ruleset response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ruleset_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/zones/{zone_id}/rulesets/phases/{ruleset_phase}/entrypoint/versions":{"get":{"tags":["Zone Rulesets"],"summary":"List a zone entry point ruleset's versions","description":"Fetches the versions of a zone entry point ruleset.","operationId":"zone-rulesets-list-a-zone-entry-point-ruleset'-s-versions","parameters":[{"name":"ruleset_phase","in":"path","required":true,"schema":{"$ref":"#/components/schemas/phase"}},{"name":"zone_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"List a zone entry point ruleset's versions response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/rulesets_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"List a zone entry point ruleset's versions response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/rulesets_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/zones/{zone_id}/rulesets/phases/{ruleset_phase}/entrypoint/versions/{ruleset_version}":{"get":{"tags":["Zone Rulesets"],"summary":"Get a zone entry point ruleset version","description":"Fetches a specific version of a zone entry point ruleset.","operationId":"zone-rulesets-get-a-zone-entry-point-ruleset-version","parameters":[{"name":"ruleset_version","in":"path","required":true,"schema":{"$ref":"#/components/schemas/version"}},{"name":"ruleset_phase","in":"path","required":true,"schema":{"$ref":"#/components/schemas/phase"}},{"name":"zone_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Get a zone entry point ruleset version response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ruleset_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Get a zone entry point ruleset version response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ruleset_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/zones/{zone_id}/rulesets/phases/http_custom_errors/entrypoint":{"get":{"tags":["Custom Error Responses"],"summary":"Get Custom Error Responses","description":"Fetches all Custom Error Responses in a zone.","operationId":"custom-error-responses-get-custom-error-responses","parameters":[{"name":"zone_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Get Custom Error Responses response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/components-schemas-ruleset"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Get Custom Error Responses response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/components-schemas-ruleset"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"put":{"tags":["Custom Error Responses"],"summary":"Update Custom Error Responses","description":"Updates the Custom Error Responses of a zone.","operationId":"custom-error-responses-update-custom-error-responses","parameters":[{"name":"zone_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/update_ruleset"}}}},"responses":{"4xx":{"description":"Update Custom Error Responses response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Update Custom Error Responses response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-response-single"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/zones/{zone_id}/url_normalization":{"get":{"tags":["URL Normalization"],"summary":"Get URL normalization settings","description":"Fetches the current URL normalization settings.","operationId":"url-normalization-get-url-normalization-settings","parameters":[{"name":"zone_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Get URL normalization settings response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/schemas-response_model"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Get URL normalization settings response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/schemas-response_model"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"put":{"tags":["URL Normalization"],"summary":"Update URL normalization settings","description":"Updates the URL normalization settings.","operationId":"url-normalization-update-url-normalization-settings","parameters":[{"name":"zone_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/schemas-request_model"}}}},"responses":{"4xx":{"description":"Update URL normalization settings response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/schemas-response_model"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Update URL normalization settings response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/schemas-response_model"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/zones/{zone_id}/workers/filters":{"get":{"tags":["Worker Filters (Deprecated)"],"summary":"List Filters","operationId":"worker-filters-(-deprecated)-list-filters","parameters":[{"name":"zone_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"List Filters response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/filter-response-collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"List Filters response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/filter-response-collection"}}}}},"deprecated":true,"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"post":{"tags":["Worker Filters (Deprecated)"],"summary":"Create Filter","operationId":"worker-filters-(-deprecated)-create-filter","parameters":[{"name":"zone_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/filter-no-id"}}}},"responses":{"4xx":{"description":"Create Filter response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-response-single-id"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Create Filter response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-response-single-id"}}}}},"deprecated":true,"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/zones/{zone_id}/workers/filters/{filter_id}":{"delete":{"tags":["Worker Filters (Deprecated)"],"summary":"Delete Filter","operationId":"worker-filters-(-deprecated)-delete-filter","parameters":[{"name":"filter_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}},{"name":"zone_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{"4xx":{"description":"Delete Filter response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-response-single-id"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Delete Filter response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-response-single-id"}}}}},"deprecated":true,"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"put":{"tags":["Worker Filters (Deprecated)"],"summary":"Update Filter","operationId":"worker-filters-(-deprecated)-update-filter","parameters":[{"name":"filter_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}},{"name":"zone_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/filter-no-id"}}}},"responses":{"4xx":{"description":"Update Filter response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/filter-response-single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Update Filter response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/filter-response-single"}}}}},"deprecated":true,"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/zones/{zone_id}/workers/routes":{"get":{"tags":["Worker Routes"],"summary":"List Routes","operationId":"worker-routes-list-routes","parameters":[{"name":"zone_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"List Routes response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/route-response-collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"List Routes response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/route-response-collection"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"post":{"tags":["Worker Routes"],"summary":"Create Route","operationId":"worker-routes-create-route","parameters":[{"name":"zone_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/route-no-id"}}}},"responses":{"4xx":{"description":"Create Route response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-response-single-id"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Create Route response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-response-single-id"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/zones/{zone_id}/workers/routes/{route_id}":{"delete":{"tags":["Worker Routes"],"summary":"Delete Route","operationId":"worker-routes-delete-route","parameters":[{"name":"route_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}},{"name":"zone_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{"4xx":{"description":"Delete Route response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-response-single-id"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Delete Route response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-response-single-id"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"get":{"tags":["Worker Routes"],"summary":"Get Route","operationId":"worker-routes-get-route","parameters":[{"name":"route_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}},{"name":"zone_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Get Route response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/route-response-single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Get Route response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/route-response-single"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"put":{"tags":["Worker Routes"],"summary":"Update Route","operationId":"worker-routes-update-route","parameters":[{"name":"route_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}},{"name":"zone_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/route-no-id"}}}},"responses":{"4xx":{"description":"Update Route response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/route-response-single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Update Route response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/route-response-single"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/zones/{zone_identifier}/acm/total_tls":{"get":{"tags":["Total TLS"],"summary":"Total TLS Settings Details","description":"Get Total TLS Settings for a Zone.","operationId":"total-tls-total-tls-settings-details","parameters":[{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Total TLS Settings Details response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/total_tls_settings_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Total TLS Settings Details response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/total_tls_settings_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"post":{"tags":["Total TLS"],"summary":"Enable or Disable Total TLS","description":"Set Total TLS Settings or disable the feature for a Zone.","operationId":"total-tls-enable-or-disable-total-tls","parameters":[{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["enabled"],"properties":{"certificate_authority":{"$ref":"#/components/schemas/schemas-certificate_authority"},"enabled":{"$ref":"#/components/schemas/total-tls_components-schemas-enabled"}}}}}},"responses":{"4xx":{"description":"Enable or Disable Total TLS response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/total_tls_settings_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Enable or Disable Total TLS response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/total_tls_settings_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/zones/{zone_identifier}/analytics/colos":{"get":{"tags":["Zone Analytics (Deprecated)"],"summary":"Get analytics by Co-locations","description":"This view provides a breakdown of analytics data by datacenter. Note: This is available to Enterprise customers only.","operationId":"zone-analytics-(-deprecated)-get-analytics-by-co-locations","parameters":[{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Get analytics by Co-locations response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/colo_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Get analytics by Co-locations response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/colo_response"}}}}},"deprecated":true,"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/zones/{zone_identifier}/analytics/dashboard":{"get":{"tags":["Zone Analytics (Deprecated)"],"summary":"Get dashboard","description":"The dashboard view provides both totals and timeseries data for the given zone and time period across the entire Cloudflare network.","operationId":"zone-analytics-(-deprecated)-get-dashboard","parameters":[{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Get dashboard response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/dashboard_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Get dashboard response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/dashboard_response"}}}}},"deprecated":true,"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/zones/{zone_identifier}/analytics/latency":{"get":{"tags":["Argo Analytics for Zone"],"summary":"Argo Analytics for a zone","operationId":"argo-analytics-for-zone-argo-analytics-for-a-zone","parameters":[{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Argo Analytics for a zone response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/schemas-response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Argo Analytics for a zone response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/schemas-response_single"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/zones/{zone_identifier}/analytics/latency/colos":{"get":{"tags":["Argo Analytics for Geolocation"],"summary":"Argo Analytics for a zone at different PoPs","operationId":"argo-analytics-for-geolocation-argo-analytics-for-a-zone-at-different-po-ps","parameters":[{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Argo Analytics for a zone at different PoPs response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/schemas-response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Argo Analytics for a zone at different PoPs response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/schemas-response_single"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/zones/{zone_identifier}/argo/smart_routing":{"get":{"tags":["Argo Smart Routing"],"summary":"Get Argo Smart Routing setting","operationId":"argo-smart-routing-get-argo-smart-routing-setting","parameters":[{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Get Argo Smart Routing setting response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/schemas-response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Get Argo Smart Routing setting response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/schemas-response_single"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"patch":{"tags":["Argo Smart Routing"],"summary":"Patch Argo Smart Routing setting","description":"Updates enablement of Argo Smart Routing.","operationId":"argo-smart-routing-patch-argo-smart-routing-setting","parameters":[{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/patch"}}}},"responses":{"4xx":{"description":"Patch Argo Smart Routing setting response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/schemas-response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Patch Argo Smart Routing setting response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/schemas-response_single"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/zones/{zone_identifier}/available_plans":{"get":{"tags":["Zone Rate Plan"],"summary":"List Available Plans","description":"Lists available plans the zone can subscribe to.","operationId":"zone-rate-plan-list-available-plans","parameters":[{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"List Available Plans response failure","content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/available-rate-plan"}}}}]},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"List Available Plans response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/available-rate-plan"}}}}]}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/zones/{zone_identifier}/available_plans/{plan_identifier}":{"get":{"tags":["Zone Rate Plan"],"summary":"Available Plan Details","description":"Details of the available plan that the zone can subscribe to.","operationId":"zone-rate-plan-available-plan-details","parameters":[{"name":"plan_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}},{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Available Plan Details response failure","content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/available-rate-plan"}}}]},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Available Plan Details response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/available-rate-plan"}}}]}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/zones/{zone_identifier}/available_rate_plans":{"get":{"tags":["Zone Rate Plan"],"summary":"List Available Rate Plans","description":"Lists all rate plans the zone can subscribe to.","operationId":"zone-rate-plan-list-available-rate-plans","parameters":[{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"List Available Rate Plans response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/plan_response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"List Available Rate Plans response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/plan_response_collection"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/zones/{zone_identifier}/cache/cache_reserve":{"get":{"tags":["Zone Cache Settings"],"summary":"Get Cache Reserve setting","description":"Increase cache lifetimes by automatically storing all cacheable files into Cloudflare's persistent object storage buckets. Requires Cache Reserve subscription. Note: using Tiered Cache with Cache Reserve is highly recommended to reduce Reserve operations costs. See the [developer docs](https://developers.cloudflare.com/cache/about/cache-reserve) for more information.","operationId":"zone-cache-settings-get-cache-reserve-setting","parameters":[{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Get Cache Reserve setting response failure","content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/zone_cache_settings_response_single"},{"$ref":"#/components/schemas/cache_reserve_response_value"}]},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Get Cache Reserve setting response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zone_cache_settings_response_single"},{"$ref":"#/components/schemas/cache_reserve_response_value"}]}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"patch":{"tags":["Zone Cache Settings"],"summary":"Change Cache Reserve setting","description":"Increase cache lifetimes by automatically storing all cacheable files into Cloudflare's persistent object storage buckets. Requires Cache Reserve subscription. Note: using Tiered Cache with Cache Reserve is highly recommended to reduce Reserve operations costs. See the [developer docs](https://developers.cloudflare.com/cache/about/cache-reserve) for more information.","operationId":"zone-cache-settings-change-cache-reserve-setting","parameters":[{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["value"],"properties":{"value":{"$ref":"#/components/schemas/cache_reserve_value"}}}}}},"responses":{"4xx":{"description":"Change Cache Reserve setting response failure","content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/zone_cache_settings_response_single"},{"$ref":"#/components/schemas/cache_reserve_response_value"}]},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Change Cache Reserve setting response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zone_cache_settings_response_single"},{"$ref":"#/components/schemas/cache_reserve_response_value"}]}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/zones/{zone_identifier}/cache/variants":{"delete":{"tags":["Zone Cache Settings"],"summary":"Delete variants setting","description":"Variant support enables caching variants of images with certain file extensions in addition to the original. This only applies when the origin server sends the 'Vary: Accept' response header. If the origin server sends 'Vary: Accept' but does not serve the variant requested, the response will not be cached. This will be indicated with BYPASS cache status in the response headers.","operationId":"zone-cache-settings-delete-variants-setting","parameters":[{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{"4xx":{"description":"Delete variants setting response failure","content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/zone_cache_settings_response_single"},{"properties":{"result":{"$ref":"#/components/schemas/variants"}}}]},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Delete variants setting response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zone_cache_settings_response_single"},{"properties":{"result":{"$ref":"#/components/schemas/variants"}}}]}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"get":{"tags":["Zone Cache Settings"],"summary":"Get variants setting","description":"Variant support enables caching variants of images with certain file extensions in addition to the original. This only applies when the origin server sends the 'Vary: Accept' response header. If the origin server sends 'Vary: Accept' but does not serve the variant requested, the response will not be cached. This will be indicated with BYPASS cache status in the response headers.","operationId":"zone-cache-settings-get-variants-setting","parameters":[{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Get variants setting response failure","content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/zone_cache_settings_response_single"},{"$ref":"#/components/schemas/variants_response_value"}]},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Get variants setting response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zone_cache_settings_response_single"},{"$ref":"#/components/schemas/variants_response_value"}]}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"patch":{"tags":["Zone Cache Settings"],"summary":"Change variants setting","description":"Variant support enables caching variants of images with certain file extensions in addition to the original. This only applies when the origin server sends the 'Vary: Accept' response header. If the origin server sends 'Vary: Accept' but does not serve the variant requested, the response will not be cached. This will be indicated with BYPASS cache status in the response headers.","operationId":"zone-cache-settings-change-variants-setting","parameters":[{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["value"],"properties":{"value":{"$ref":"#/components/schemas/variants_value"}}}}}},"responses":{"4xx":{"description":"Change variants setting response failure","content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/zone_cache_settings_response_single"},{"$ref":"#/components/schemas/variants_response_value"}]},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Change variants setting response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zone_cache_settings_response_single"},{"$ref":"#/components/schemas/variants_response_value"}]}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/zones/{zone_identifier}/custom_certificates":{"get":{"tags":["Custom SSL for a Zone"],"summary":"List SSL Configurations","description":"List, search, and filter all of your custom SSL certificates. The higher priority will break ties across overlapping 'legacy_custom' certificates, but 'legacy_custom' certificates will always supercede 'sni_custom' certificates.","operationId":"custom-ssl-for-a-zone-list-ssl-configurations","parameters":[{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"List SSL Configurations response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/certificate_response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"List SSL Configurations response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/certificate_response_collection"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"post":{"tags":["Custom SSL for a Zone"],"summary":"Create SSL Configuration","description":"Upload a new SSL certificate for a zone.","operationId":"custom-ssl-for-a-zone-create-ssl-configuration","parameters":[{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["certificate","private_key"],"properties":{"bundle_method":{"$ref":"#/components/schemas/bundle_method"},"certificate":{"$ref":"#/components/schemas/certificate"},"geo_restrictions":{"$ref":"#/components/schemas/geo_restrictions"},"policy":{"$ref":"#/components/schemas/policy"},"private_key":{"$ref":"#/components/schemas/private_key"},"type":{"$ref":"#/components/schemas/custom-certificate_components-schemas-type"}}}}}},"responses":{"4xx":{"description":"Create SSL Configuration response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/certificate_response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Create SSL Configuration response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/certificate_response_single"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/zones/{zone_identifier}/custom_certificates/{identifier}":{"delete":{"tags":["Custom SSL for a Zone"],"summary":"Delete SSL Configuration","description":"Remove a SSL certificate from a zone.","operationId":"custom-ssl-for-a-zone-delete-ssl-configuration","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/custom-certificate_components-schemas-identifier"}},{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{"4xx":{"description":"Delete SSL Configuration response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/certificate_response_id_only"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Delete SSL Configuration response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/certificate_response_id_only"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"get":{"tags":["Custom SSL for a Zone"],"summary":"SSL Configuration Details","operationId":"custom-ssl-for-a-zone-ssl-configuration-details","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/custom-certificate_components-schemas-identifier"}},{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"SSL Configuration Details response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/certificate_response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"SSL Configuration Details response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/certificate_response_single"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"patch":{"tags":["Custom SSL for a Zone"],"summary":"Edit SSL Configuration","description":"Upload a new private key and/or PEM/CRT for the SSL certificate. Note: PATCHing a configuration for sni_custom certificates will result in a new resource id being returned, and the previous one being deleted.","operationId":"custom-ssl-for-a-zone-edit-ssl-configuration","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/custom-certificate_components-schemas-identifier"}},{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"bundle_method":{"$ref":"#/components/schemas/bundle_method"},"certificate":{"$ref":"#/components/schemas/certificate"},"geo_restrictions":{"$ref":"#/components/schemas/geo_restrictions"},"policy":{"$ref":"#/components/schemas/policy"},"private_key":{"$ref":"#/components/schemas/private_key"}}}}}},"responses":{"4xx":{"description":"Edit SSL Configuration response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/certificate_response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Edit SSL Configuration response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/certificate_response_single"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/zones/{zone_identifier}/custom_certificates/prioritize":{"put":{"tags":["Custom SSL for a Zone"],"summary":"Re-prioritize SSL Certificates","description":"If a zone has multiple SSL certificates, you can set the order in which they should be used during a request. The higher priority will break ties across overlapping 'legacy_custom' certificates.","operationId":"custom-ssl-for-a-zone-re-prioritize-ssl-certificates","parameters":[{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["certificates"],"properties":{"certificates":{"type":"array","description":"Array of ordered certificates.","example":[{"id":"5a7805061c76ada191ed06f989cc3dac","priority":2},{"id":"9a7806061c88ada191ed06f989cc3dac","priority":1}],"items":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/custom-certificate_components-schemas-identifier"},"priority":{"$ref":"#/components/schemas/schemas-priority"}}}}}}}}},"responses":{"4xx":{"description":"Re-prioritize SSL Certificates response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/certificate_response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Re-prioritize SSL Certificates response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/certificate_response_collection"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/zones/{zone_identifier}/custom_hostnames":{"get":{"tags":["Custom Hostname for a Zone"],"summary":"List Custom Hostnames","description":"List, search, sort, and filter all of your custom hostnames.","operationId":"custom-hostname-for-a-zone-list-custom-hostnames","parameters":[{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"List Custom Hostnames response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/custom_hostname_response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"List Custom Hostnames response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/custom_hostname_response_collection"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"post":{"tags":["Custom Hostname for a Zone"],"summary":"Create Custom Hostname","description":"Add a new custom hostname and request that an SSL certificate be issued for it. One of three validation methods—http, txt, email—should be used, with 'http' recommended if the CNAME is already in place (or will be soon). Specifying 'email' will send an email to the WHOIS contacts on file for the base domain plus hostmaster, postmaster, webmaster, admin, administrator. If http is used and the domain is not already pointing to the Managed CNAME host, the PATCH method must be used once it is (to complete validation).","operationId":"custom-hostname-for-a-zone-create-custom-hostname","parameters":[{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["hostname","ssl"],"properties":{"hostname":{"$ref":"#/components/schemas/hostname"},"ssl":{"$ref":"#/components/schemas/sslpost"}}}}}},"responses":{"4xx":{"description":"Create Custom Hostname response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/custom_hostname_response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Create Custom Hostname response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/custom_hostname_response_single"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/zones/{zone_identifier}/custom_hostnames/{identifier}":{"delete":{"tags":["Custom Hostname for a Zone"],"summary":"Delete Custom Hostname (and any issued SSL certificates)","operationId":"custom-hostname-for-a-zone-delete-custom-hostname-(-and-any-issued-ssl-certificates)","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/custom-hostname_components-schemas-identifier"}},{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{"4xx":{"description":"Delete Custom Hostname (and any issued SSL certificates) response failure","content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"id":{"$ref":"#/components/schemas/custom-hostname_components-schemas-identifier"}}},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Delete Custom Hostname (and any issued SSL certificates) response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/custom-hostname_components-schemas-identifier"}}}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"get":{"tags":["Custom Hostname for a Zone"],"summary":"Custom Hostname Details","operationId":"custom-hostname-for-a-zone-custom-hostname-details","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/custom-hostname_components-schemas-identifier"}},{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Custom Hostname Details response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/custom_hostname_response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Custom Hostname Details response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/custom_hostname_response_single"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"patch":{"tags":["Custom Hostname for a Zone"],"summary":"Edit Custom Hostname","description":"Modify SSL configuration for a custom hostname. When sent with SSL config that matches existing config, used to indicate that hostname should pass domain control validation (DCV). Can also be used to change validation type, e.g., from 'http' to 'email'.","operationId":"custom-hostname-for-a-zone-edit-custom-hostname","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/custom-hostname_components-schemas-identifier"}},{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"custom_metadata":{"$ref":"#/components/schemas/custom_metadata"},"custom_origin_server":{"$ref":"#/components/schemas/custom_origin_server"},"custom_origin_sni":{"$ref":"#/components/schemas/custom_origin_sni"},"ssl":{"$ref":"#/components/schemas/sslpost"}}}}}},"responses":{"4xx":{"description":"Edit Custom Hostname response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/custom_hostname_response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Edit Custom Hostname response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/custom_hostname_response_single"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/zones/{zone_identifier}/custom_hostnames/fallback_origin":{"delete":{"tags":["Custom Hostname Fallback Origin for a Zone"],"summary":"Delete Fallback Origin for Custom Hostnames","operationId":"custom-hostname-fallback-origin-for-a-zone-delete-fallback-origin-for-custom-hostnames","parameters":[{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{"4xx":{"description":"Delete Fallback Origin for Custom Hostnames response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/fallback_origin_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Delete Fallback Origin for Custom Hostnames response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/fallback_origin_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"get":{"tags":["Custom Hostname Fallback Origin for a Zone"],"summary":"Get Fallback Origin for Custom Hostnames","operationId":"custom-hostname-fallback-origin-for-a-zone-get-fallback-origin-for-custom-hostnames","parameters":[{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Get Fallback Origin for Custom Hostnames response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/fallback_origin_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Get Fallback Origin for Custom Hostnames response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/fallback_origin_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"put":{"tags":["Custom Hostname Fallback Origin for a Zone"],"summary":"Update Fallback Origin for Custom Hostnames","operationId":"custom-hostname-fallback-origin-for-a-zone-update-fallback-origin-for-custom-hostnames","parameters":[{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["origin"],"properties":{"origin":{"$ref":"#/components/schemas/origin"}}}}}},"responses":{"4xx":{"description":"Update Fallback Origin for Custom Hostnames response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/fallback_origin_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Update Fallback Origin for Custom Hostnames response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/fallback_origin_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/zones/{zone_identifier}/custom_ns":{"get":{"tags":["Account-Level Custom Nameservers Usage for a Zone"],"summary":"Get Account Custom Nameserver Related Zone Metadata","operationId":"account-level-custom-nameservers-usage-for-a-zone-get-account-custom-nameserver-related-zone-metadata","parameters":[{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Get Account Custom Nameserver Related Zone Metadata response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/get_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Get Account Custom Nameserver Related Zone Metadata response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/get_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"put":{"tags":["Account-Level Custom Nameservers Usage for a Zone"],"summary":"Set Account Custom Nameserver Related Zone Metadata","operationId":"account-level-custom-nameservers-usage-for-a-zone-set-account-custom-nameserver-related-zone-metadata","parameters":[{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/zone_metadata"}}}},"responses":{"4xx":{"description":"Set Account Custom Nameserver Related Zone Metadata response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/empty_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Set Account Custom Nameserver Related Zone Metadata response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/empty_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/zones/{zone_identifier}/custom_pages":{"get":{"tags":["Custom pages for a zone"],"summary":"List custom pages","description":"Fetches all the custom pages at the zone level.","operationId":"custom-pages-for-a-zone-list-custom-pages","parameters":[{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"List custom pages response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/custom_pages_response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"List custom pages response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/custom_pages_response_collection"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/zones/{zone_identifier}/custom_pages/{identifier}":{"get":{"tags":["Custom pages for a zone"],"summary":"Get a custom page","description":"Fetches the details of a custom page.","operationId":"custom-pages-for-a-zone-get-a-custom-page","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/custom-pages_components-schemas-identifier"}},{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Get a custom page response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/custom_pages_response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Get a custom page response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/custom_pages_response_single"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"put":{"tags":["Custom pages for a zone"],"summary":"Update a custom page","description":"Updates the configuration of an existing custom page.","operationId":"custom-pages-for-a-zone-update-a-custom-page","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/custom-pages_components-schemas-identifier"}},{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["url","state"],"properties":{"state":{"$ref":"#/components/schemas/schemas-state"},"url":{"$ref":"#/components/schemas/url"}}}}}},"responses":{"4xx":{"description":"Update a custom page response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/custom_pages_response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Update a custom page response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/custom_pages_response_single"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/zones/{zone_identifier}/dns_records":{"get":{"tags":["DNS Records for a Zone"],"summary":"List DNS Records","description":"List, search, sort, and filter a zones' DNS records.","operationId":"dns-records-for-a-zone-list-dns-records","parameters":[{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"List DNS Records response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/dns_response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"List DNS Records response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/dns_response_collection"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"post":{"tags":["DNS Records for a Zone"],"summary":"Create DNS Record","description":"Create a new DNS record for a zone. See the record object definitions for required attributes for each record type.","operationId":"dns-records-for-a-zone-create-dns-record","parameters":[{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["type","name","content","ttl"],"properties":{"content":{"$ref":"#/components/schemas/content"},"name":{"$ref":"#/components/schemas/dns-record_components-schemas-name"},"priority":{"$ref":"#/components/schemas/priority"},"proxied":{"$ref":"#/components/schemas/proxied"},"ttl":{"$ref":"#/components/schemas/ttl"},"type":{"$ref":"#/components/schemas/dns-record_components-schemas-type"}}}}}},"responses":{"4xx":{"description":"Create DNS Record response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/dns_response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Create DNS Record response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/dns_response_single"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/zones/{zone_identifier}/dns_records/{identifier}":{"delete":{"tags":["DNS Records for a Zone"],"summary":"Delete DNS Record","operationId":"dns-records-for-a-zone-delete-dns-record","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/dns-record_components-schemas-identifier"}},{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{"4xx":{"description":"Delete DNS Record response failure","content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"result":{"properties":{"id":{"$ref":"#/components/schemas/dns-record_components-schemas-identifier"}}}}},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Delete DNS Record response","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"properties":{"id":{"$ref":"#/components/schemas/dns-record_components-schemas-identifier"}}}}}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"get":{"tags":["DNS Records for a Zone"],"summary":"DNS Record Details","operationId":"dns-records-for-a-zone-dns-record-details","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/dns-record_components-schemas-identifier"}},{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"DNS Record Details response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/dns_response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"DNS Record Details response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/dns_response_single"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"patch":{"tags":["DNS Records for a Zone"],"summary":"Patch DNS Record","operationId":"dns-records-for-a-zone-patch-dns-record","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/dns-record_components-schemas-identifier"}},{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"content":{"$ref":"#/components/schemas/content"},"name":{"$ref":"#/components/schemas/dns-record_components-schemas-name"},"proxied":{"$ref":"#/components/schemas/proxied"},"ttl":{"$ref":"#/components/schemas/ttl"},"type":{"$ref":"#/components/schemas/dns-record_components-schemas-type"}}}}}},"responses":{"4xx":{"description":"Patch DNS Record response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/dns_response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Patch DNS Record response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/dns_response_single"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"put":{"tags":["DNS Records for a Zone"],"summary":"Update DNS Record","operationId":"dns-records-for-a-zone-update-dns-record","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/dns-record_components-schemas-identifier"}},{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["type","name","content","ttl"],"properties":{"content":{"$ref":"#/components/schemas/content"},"name":{"$ref":"#/components/schemas/dns-record_components-schemas-name"},"proxied":{"$ref":"#/components/schemas/proxied"},"ttl":{"$ref":"#/components/schemas/ttl"},"type":{"$ref":"#/components/schemas/dns-record_components-schemas-type"}}}}}},"responses":{"4xx":{"description":"Update DNS Record response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/dns_response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Update DNS Record response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/dns_response_single"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/zones/{zone_identifier}/dns_records/export":{"get":{"tags":["DNS Records for a Zone"],"summary":"Export DNS Records","description":"You can export your [BIND config](https://en.wikipedia.org/wiki/Zone_file \"Zone file\") through this endpoint.","operationId":"dns-records-for-a-zone-export-dns-records","parameters":[{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Export DNS Records response failure","content":{"application/json":{"schema":{"allOf":[{},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Export DNS Records response","content":{"application/json":{"schema":{}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/zones/{zone_identifier}/dns_records/import":{"post":{"tags":["DNS Records for a Zone"],"summary":"Import DNS Records","description":"You can upload your [BIND config](https://en.wikipedia.org/wiki/Zone_file \"Zone file\") through this endpoint. It assumes that cURL is called from a location with bind_config.txt (valid BIND config) present.","operationId":"dns-records-for-a-zone-import-dns-records","parameters":[{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"type":"object","required":["file"],"properties":{"file":{"type":"string","description":"BIND config to upload.","example":"@bind_config.txt"},"proxied":{"type":"boolean","description":"Whether or not proxiable records should receive the performance and security benefits of Cloudflare.","example":false}}}}}},"responses":{"4xx":{"description":"Import DNS Records response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/dns_response_import_scan"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Import DNS Records response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/dns_response_import_scan"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/zones/{zone_identifier}/dns_records/scan":{"post":{"tags":["DNS Records for a Zone"],"summary":"Scan DNS Records","description":"Scan for common DNS records on your domain and automatically add them to your zone. Useful if you haven't updated your nameservers yet.","operationId":"dns-records-for-a-zone-scan-dns-records","parameters":[{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{"4xx":{"description":"Scan DNS Records response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/dns_response_import_scan"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Scan DNS Records response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/dns_response_import_scan"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/zones/{zone_identifier}/dnssec":{"delete":{"tags":["DNSSEC"],"summary":"Delete DNSSEC records","description":"Delete DNSSEC.","operationId":"dnssec-delete-dnssec-records","parameters":[{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{"4xx":{"description":"Delete DNSSEC records response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/delete_dnssec_response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Delete DNSSEC records response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/delete_dnssec_response_single"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"get":{"tags":["DNSSEC"],"summary":"DNSSEC Details","description":"Details about DNSSEC status and configuration.","operationId":"dnssec-dnssec-details","parameters":[{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"DNSSEC Details response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/dnssec_response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"DNSSEC Details response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/dnssec_response_single"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"patch":{"tags":["DNSSEC"],"summary":"Edit DNSSEC Status","description":"Enable or disable DNSSEC.","operationId":"dnssec-edit-dnssec-status","parameters":[{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["status"],"properties":{"status":{"description":"Status of DNSSEC, based on user-desired state and presence of necessary records.","enum":["active","disabled"],"example":"active"}}}}}},"responses":{"4xx":{"description":"Edit DNSSEC Status response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/dnssec_response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Edit DNSSEC Status response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/dnssec_response_single"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/zones/{zone_identifier}/email/routing":{"get":{"tags":["Email Routing settings"],"summary":"Get Email Routing settings","description":"Get information about the settings for your Email Routing zone.","operationId":"email-routing-settings-get-email-routing-settings","parameters":[{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Get Email Routing settings response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/email-settings_response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Get Email Routing settings response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/email-settings_response_single"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/zones/{zone_identifier}/email/routing/disable":{"post":{"tags":["Email Routing settings"],"summary":"Disable Email Routing","description":"Disable your Email Routing zone. Also removes additional MX records previously required for Email Routing to work.","operationId":"email-routing-settings-disable-email-routing","parameters":[{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{"4xx":{"description":"Disable Email Routing response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/email-settings_response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Disable Email Routing response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/email-settings_response_single"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/zones/{zone_identifier}/email/routing/dns":{"get":{"tags":["Email Routing settings"],"summary":"Email Routing - DNS settings","description":"Show the DNS records needed to configure your Email Routing zone.","operationId":"email-routing-settings-email-routing-dns-settings","parameters":[{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Email Routing - DNS settings response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/dns-settings_response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Email Routing - DNS settings response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/dns-settings_response_collection"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/zones/{zone_identifier}/email/routing/enable":{"post":{"tags":["Email Routing settings"],"summary":"Enable Email Routing","description":"Enable you Email Routing zone. Add and lock the necessary MX and SPF records.","operationId":"email-routing-settings-enable-email-routing","parameters":[{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{"4xx":{"description":"Enable Email Routing response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/email-settings_response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Enable Email Routing response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/email-settings_response_single"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/zones/{zone_identifier}/email/routing/rules":{"get":{"tags":["Email Routing routing rules"],"summary":"List routing rules","description":"Lists existing routing rules.","operationId":"email-routing-routing-rules-list-routing-rules","parameters":[{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"List routing rules response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/rules_response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"List routing rules response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/rules_response_collection"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"post":{"tags":["Email Routing routing rules"],"summary":"Create routing rule","description":"Rules consist of a set of criteria for matching emails (such as an email being sent to a specific custom email address) plus a set of actions to take on the email (like forwarding it to a specific destination address).","operationId":"email-routing-routing-rules-create-routing-rule","parameters":[{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/create_rule_properties"}}}},"responses":{"4xx":{"description":"Create routing rule response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/rule_response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Create routing rule response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/rule_response_single"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/zones/{zone_identifier}/email/routing/rules/{rule_identifier}":{"delete":{"tags":["Email Routing routing rules"],"summary":"Delete routing rule","description":"Delete a specific routing rule.","operationId":"email-routing-routing-rules-delete-routing-rule","parameters":[{"name":"rule_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/rule_identifier"}},{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{"4xx":{"description":"Delete routing rule response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/rule_response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Delete routing rule response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/rule_response_single"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"get":{"tags":["Email Routing routing rules"],"summary":"Get routing rule","description":"Get information for a specific routing rule already created.","operationId":"email-routing-routing-rules-get-routing-rule","parameters":[{"name":"rule_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/rule_identifier"}},{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Get routing rule response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/rule_response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Get routing rule response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/rule_response_single"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"put":{"tags":["Email Routing routing rules"],"summary":"Update routing rule","description":"Update actions and matches, or enable/disable specific routing rules.","operationId":"email-routing-routing-rules-update-routing-rule","parameters":[{"name":"rule_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/rule_identifier"}},{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/update_rule_properties"}}}},"responses":{"4xx":{"description":"Update routing rule response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/rule_response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Update routing rule response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/rule_response_single"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/zones/{zone_identifier}/email/routing/rules/catch_all":{"get":{"tags":["Email Routing routing rules"],"summary":"Get catch-all rule","description":"Get information on the default catch-all routing rule.","operationId":"email-routing-routing-rules-get-catch-all-rule","parameters":[{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Get catch-all rule response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/catch_all_rule_response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Get catch-all rule response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/catch_all_rule_response_single"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"put":{"tags":["Email Routing routing rules"],"summary":"Update catch-all rule","description":"Enable or disable catch-all routing rule, or change action to forward to specific destination address.","operationId":"email-routing-routing-rules-update-catch-all-rule","parameters":[{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/update_catch_all_rule_properties"}}}},"responses":{"4xx":{"description":"Update catch-all rule response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/catch_all_rule_response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Update catch-all rule response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/catch_all_rule_response_single"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/zones/{zone_identifier}/filters":{"delete":{"tags":["Filters"],"summary":"Delete filters","description":"Deletes one or more existing filters.","operationId":"filters-delete-filters","parameters":[{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"$ref":"#/components/schemas/filters_components-schemas-id"}}}}}},"responses":{"4xx":{"description":"Delete filters response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/filter-delete-response-collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Delete filters response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/filter-delete-response-collection"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"get":{"tags":["Filters"],"summary":"List filters","description":"Fetches filters in a zone. You can filter the results using several optional parameters.","operationId":"filters-list-filters","parameters":[{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"List filters response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/schemas-filter-response-collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"List filters response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/schemas-filter-response-collection"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"post":{"tags":["Filters"],"summary":"Create filters","description":"Creates one or more filters.","operationId":"filters-create-filters","parameters":[{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["expression"]}}}},"responses":{"4xx":{"description":"Create filters response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/schemas-filter-response-collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Create filters response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/schemas-filter-response-collection"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"put":{"tags":["Filters"],"summary":"Update filters","description":"Updates one or more existing filters.","operationId":"filters-update-filters","parameters":[{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["id"]}}}},"responses":{"4xx":{"description":"Update filters response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/schemas-filter-response-collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Update filters response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/schemas-filter-response-collection"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/zones/{zone_identifier}/filters/{id}":{"delete":{"tags":["Filters"],"summary":"Delete a filter","description":"Deletes an existing filter.","operationId":"filters-delete-a-filter","parameters":[{"name":"id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/filters_components-schemas-id"}},{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{"4xx":{"description":"Delete a filter response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/filter-delete-response-single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Delete a filter response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/filter-delete-response-single"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"get":{"tags":["Filters"],"summary":"Get a filter","description":"Fetches the details of a filter.","operationId":"filters-get-a-filter","parameters":[{"name":"id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/filters_components-schemas-id"}},{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Get a filter response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/schemas-filter-response-single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Get a filter response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/schemas-filter-response-single"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"put":{"tags":["Filters"],"summary":"Update a filter","description":"Updates an existing filter.","operationId":"filters-update-a-filter","parameters":[{"name":"id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/filters_components-schemas-id"}},{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["id"]}}}},"responses":{"4xx":{"description":"Update a filter response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/schemas-filter-response-single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Update a filter response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/schemas-filter-response-single"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/zones/{zone_identifier}/firewall/lockdowns":{"get":{"tags":["Zone Lockdown"],"summary":"List Zone Lockdown rules","description":"Fetches Zone Lockdown rules. You can filter the results using several optional parameters.","operationId":"zone-lockdown-list-zone-lockdown-rules","parameters":[{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"List Zone Lockdown rules response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zonelockdown_response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"List Zone Lockdown rules response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/zonelockdown_response_collection"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"post":{"tags":["Zone Lockdown"],"summary":"Create a Zone Lockdown rule","description":"Creates a new Zone Lockdown rule.","operationId":"zone-lockdown-create-a-zone-lockdown-rule","parameters":[{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["urls","configurations"]}}}},"responses":{"4xx":{"description":"Create a Zone Lockdown rule response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zonelockdown_response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Create a Zone Lockdown rule response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/zonelockdown_response_single"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/zones/{zone_identifier}/firewall/lockdowns/{id}":{"delete":{"tags":["Zone Lockdown"],"summary":"Delete a Zone Lockdown rule","description":"Deletes an existing Zone Lockdown rule.","operationId":"zone-lockdown-delete-a-zone-lockdown-rule","parameters":[{"name":"id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/lockdowns_components-schemas-id"}},{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{"4xx":{"description":"Delete a Zone Lockdown rule response failure","content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"result":{"properties":{"id":{"$ref":"#/components/schemas/lockdowns_components-schemas-id"}}}}},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Delete a Zone Lockdown rule response","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"properties":{"id":{"$ref":"#/components/schemas/lockdowns_components-schemas-id"}}}}}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"get":{"tags":["Zone Lockdown"],"summary":"Get a Zone Lockdown rule","description":"Fetches the details of a Zone Lockdown rule.","operationId":"zone-lockdown-get-a-zone-lockdown-rule","parameters":[{"name":"id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/lockdowns_components-schemas-id"}},{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Get a Zone Lockdown rule response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zonelockdown_response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Get a Zone Lockdown rule response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/zonelockdown_response_single"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"put":{"tags":["Zone Lockdown"],"summary":"Update a Zone Lockdown rule","description":"Updates an existing Zone Lockdown rule.","operationId":"zone-lockdown-update-a-zone-lockdown-rule","parameters":[{"name":"id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/lockdowns_components-schemas-id"}},{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["urls","configurations"]}}}},"responses":{"4xx":{"description":"Update a Zone Lockdown rule response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zonelockdown_response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Update a Zone Lockdown rule response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/zonelockdown_response_single"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/zones/{zone_identifier}/firewall/rules":{"delete":{"tags":["Firewall rules"],"summary":"Delete firewall rules","description":"Deletes existing firewall rules.","operationId":"firewall-rules-delete-firewall-rules","parameters":[{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"$ref":"#/components/schemas/firewall-rules_components-schemas-id"}}}}}},"responses":{"4xx":{"description":"Delete firewall rules response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/filter-rules-response-collection-delete"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Delete firewall rules response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/filter-rules-response-collection-delete"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"get":{"tags":["Firewall rules"],"summary":"List firewall rules","description":"Fetches firewall rules in a zone. You can filter the results using several optional parameters.","operationId":"firewall-rules-list-firewall-rules","parameters":[{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"List firewall rules response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/filter-rules-response-collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"List firewall rules response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/filter-rules-response-collection"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"patch":{"tags":["Firewall rules"],"summary":"Update priority of firewall rules","description":"Updates the priority of existing firewall rules.","operationId":"firewall-rules-update-priority-of-firewall-rules","parameters":[{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["id"]}}}},"responses":{"4xx":{"description":"Update priority of firewall rules response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/filter-rules-response-collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Update priority of firewall rules response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/filter-rules-response-collection"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"post":{"tags":["Firewall rules"],"summary":"Create firewall rules","description":"Create one or more firewall rules.","operationId":"firewall-rules-create-firewall-rules","parameters":[{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["filter","action"]}}}},"responses":{"4xx":{"description":"Create firewall rules response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/filter-rules-response-collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Create firewall rules response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/filter-rules-response-collection"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"put":{"tags":["Firewall rules"],"summary":"Update firewall rules","description":"Updates one or more existing firewall rules.","operationId":"firewall-rules-update-firewall-rules","parameters":[{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["id"]}}}},"responses":{"4xx":{"description":"Update firewall rules response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/filter-rules-response-collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Update firewall rules response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/filter-rules-response-collection"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/zones/{zone_identifier}/firewall/rules/{id}":{"delete":{"tags":["Firewall rules"],"summary":"Delete a firewall rule","description":"Deletes an existing firewall rule.","operationId":"firewall-rules-delete-a-firewall-rule","parameters":[{"name":"id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/firewall-rules_components-schemas-id"}},{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"delete_filter_if_unused":{"$ref":"#/components/schemas/delete_filter_if_unused"}}}}}},"responses":{"4xx":{"description":"Delete a firewall rule response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/filter-rules-single-response-delete"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Delete a firewall rule response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/filter-rules-single-response-delete"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"get":{"tags":["Firewall rules"],"summary":"Get a firewall rule","description":"Fetches the details of a firewall rule.","operationId":"firewall-rules-get-a-firewall-rule","parameters":[{"name":"id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/firewall-rules_components-schemas-id"}},{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Get a firewall rule response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/filter-rules-single-response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Get a firewall rule response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/filter-rules-single-response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"patch":{"tags":["Firewall rules"],"summary":"Update priority of a firewall rule","description":"Updates the priority of an existing firewall rule.","operationId":"firewall-rules-update-priority-of-a-firewall-rule","parameters":[{"name":"id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/firewall-rules_components-schemas-id"}},{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["id"]}}}},"responses":{"4xx":{"description":"Update priority of a firewall rule response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/filter-rules-response-collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Update priority of a firewall rule response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/filter-rules-response-collection"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"put":{"tags":["Firewall rules"],"summary":"Update a firewall rule","description":"Updates an existing firewall rule.","operationId":"firewall-rules-update-a-firewall-rule","parameters":[{"name":"id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/firewall-rules_components-schemas-id"}},{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["id","filter","action"]}}}},"responses":{"4xx":{"description":"Update a firewall rule response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/filter-rules-single-response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Update a firewall rule response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/filter-rules-single-response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/zones/{zone_identifier}/firewall/ua_rules":{"get":{"tags":["User Agent Blocking rules"],"summary":"List User Agent Blocking rules","description":"Fetches User Agent Blocking rules in a zone. You can filter the results using several optional parameters.","operationId":"user-agent-blocking-rules-list-user-agent-blocking-rules","parameters":[{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"List User Agent Blocking rules response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/firewalluablock_response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"List User Agent Blocking rules response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/firewalluablock_response_collection"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"post":{"tags":["User Agent Blocking rules"],"summary":"Create a User Agent Blocking rule","description":"Creates a new User Agent Blocking rule in a zone.","operationId":"user-agent-blocking-rules-create-a-user-agent-blocking-rule","parameters":[{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["mode","configuration"]}}}},"responses":{"4xx":{"description":"Create a User Agent Blocking rule response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/firewalluablock_response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Create a User Agent Blocking rule response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/firewalluablock_response_single"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/zones/{zone_identifier}/firewall/ua_rules/{id}":{"delete":{"tags":["User Agent Blocking rules"],"summary":"Delete a User Agent Blocking rule","description":"Deletes an existing User Agent Blocking rule.","operationId":"user-agent-blocking-rules-delete-a-user-agent-blocking-rule","parameters":[{"name":"id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ua-rules_components-schemas-id"}},{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{"4xx":{"description":"Delete a User Agent Blocking rule response failure","content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/firewalluablock_response_single"},{"type":"object","properties":{"result":{"properties":{"id":{"$ref":"#/components/schemas/ua-rules_components-schemas-id"}}}}}]},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Delete a User Agent Blocking rule response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/firewalluablock_response_single"},{"type":"object","properties":{"result":{"properties":{"id":{"$ref":"#/components/schemas/ua-rules_components-schemas-id"}}}}}]}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"get":{"tags":["User Agent Blocking rules"],"summary":"Get a User Agent Blocking rule","description":"Fetches the details of a User Agent Blocking rule.","operationId":"user-agent-blocking-rules-get-a-user-agent-blocking-rule","parameters":[{"name":"id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ua-rules_components-schemas-id"}},{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Get a User Agent Blocking rule response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/firewalluablock_response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Get a User Agent Blocking rule response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/firewalluablock_response_single"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"put":{"tags":["User Agent Blocking rules"],"summary":"Update a User Agent Blocking rule","description":"Updates an existing User Agent Blocking rule.","operationId":"user-agent-blocking-rules-update-a-user-agent-blocking-rule","parameters":[{"name":"id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ua-rules_components-schemas-id"}},{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["id","mode","configuration"]}}}},"responses":{"4xx":{"description":"Update a User Agent Blocking rule response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/firewalluablock_response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Update a User Agent Blocking rule response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/firewalluablock_response_single"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/zones/{zone_identifier}/firewall/waf/overrides":{"get":{"tags":["WAF overrides"],"summary":"List WAF overrides","description":"Fetches the URI-based WAF overrides in a zone.","operationId":"waf-overrides-list-waf-overrides","parameters":[{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"List WAF overrides response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/override_response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"List WAF overrides response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/override_response_collection"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"post":{"tags":["WAF overrides"],"summary":"Create a WAF override","description":"Creates a URI-based WAF override for a zone.","operationId":"waf-overrides-create-a-waf-override","parameters":[{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["urls"]}}}},"responses":{"4xx":{"description":"Create a WAF override response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/override_response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Create a WAF override response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/override_response_single"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/zones/{zone_identifier}/firewall/waf/overrides/{id}":{"delete":{"tags":["WAF overrides"],"summary":"Delete a WAF override","description":"Deletes an existing URI-based WAF override.","operationId":"waf-overrides-delete-a-waf-override","parameters":[{"name":"id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/overrides_components-schemas-id"}},{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{"4xx":{"description":"Delete a WAF override response failure","content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"result":{"properties":{"id":{"$ref":"#/components/schemas/overrides_components-schemas-id"}}}}},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Delete a WAF override response","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"properties":{"id":{"$ref":"#/components/schemas/overrides_components-schemas-id"}}}}}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"get":{"tags":["WAF overrides"],"summary":"Get a WAF override","description":"Fetches the details of a URI-based WAF override.","operationId":"waf-overrides-get-a-waf-override","parameters":[{"name":"id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/overrides_components-schemas-id"}},{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Get a WAF override response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/override_response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Get a WAF override response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/override_response_single"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"put":{"tags":["WAF overrides"],"summary":"Update WAF override","description":"Updates an existing URI-based WAF override.","operationId":"waf-overrides-update-waf-override","parameters":[{"name":"id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/overrides_components-schemas-id"}},{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["id","urls","rules","rewrite_action"]}}}},"responses":{"4xx":{"description":"Update WAF override response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/override_response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Update WAF override response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/override_response_single"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/zones/{zone_identifier}/firewall/waf/packages":{"get":{"tags":["WAF packages"],"summary":"List WAF packages","description":"Fetches WAF packages for a zone.","operationId":"waf-packages-list-waf-packages","parameters":[{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"List WAF packages response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/package_response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"List WAF packages response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/package_response_collection"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/zones/{zone_identifier}/firewall/waf/packages/{identifier}":{"get":{"tags":["WAF packages"],"summary":"Get a WAF package","description":"Fetches the details of a WAF package.","operationId":"waf-packages-get-a-waf-package","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/package_components-schemas-identifier"}},{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Get a WAF package response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/package_response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Get a WAF package response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/package_response_single"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"patch":{"tags":["WAF packages"],"summary":"Update a WAF package","description":"Updates a WAF package. You can update the sensitivity and the action of an anomaly detection WAF package.","operationId":"waf-packages-update-a-waf-package","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/package_components-schemas-identifier"}},{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"action_mode":{"$ref":"#/components/schemas/action_mode"},"sensitivity":{"$ref":"#/components/schemas/sensitivity"}}}}}},"responses":{"4xx":{"description":"Update a WAF package response failure","content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/package_response_single"},{"properties":{"result":{"$ref":"#/components/schemas/anomaly_package"}}}]},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Update a WAF package response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/package_response_single"},{"properties":{"result":{"$ref":"#/components/schemas/anomaly_package"}}}]}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/zones/{zone_identifier}/firewall/waf/packages/{package_identifier}/groups":{"get":{"tags":["WAF rule groups"],"summary":"List WAF rule groups","description":"Fetches the WAF rule groups in a WAF package.","operationId":"waf-rule-groups-list-waf-rule-groups","parameters":[{"name":"package_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/package_components-schemas-identifier"}},{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"List WAF rule groups response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/rule_group_response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"List WAF rule groups response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/rule_group_response_collection"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/zones/{zone_identifier}/firewall/waf/packages/{package_identifier}/groups/{identifier}":{"get":{"tags":["WAF rule groups"],"summary":"Get a WAF rule group","description":"Fetches the details of a WAF rule group.","operationId":"waf-rule-groups-get-a-waf-rule-group","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/group_components-schemas-identifier"}},{"name":"package_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/package_components-schemas-identifier"}},{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Get a WAF rule group response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/rule_group_response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Get a WAF rule group response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/rule_group_response_single"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"patch":{"tags":["WAF rule groups"],"summary":"Update a WAF rule group","description":"Updates a WAF rule group. You can update the state (`mode` parameter) of a rule group.","operationId":"waf-rule-groups-update-a-waf-rule-group","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/group_components-schemas-identifier"}},{"name":"package_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/package_components-schemas-identifier"}},{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"mode":{"$ref":"#/components/schemas/components-schemas-mode"}}}}}},"responses":{"4xx":{"description":"Update a WAF rule group response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/rule_group_response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Update a WAF rule group response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/rule_group_response_single"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/zones/{zone_identifier}/healthchecks":{"get":{"tags":["Health Checks"],"summary":"List Health Checks","description":"List configured health checks.","operationId":"health-checks-list-health-checks","parameters":[{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"List Health Checks response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/healthchecks_components-schemas-response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"List Health Checks response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/healthchecks_components-schemas-response_collection"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"post":{"tags":["Health Checks"],"summary":"Create Health Check","description":"Create a new health check.","operationId":"health-checks-create-health-check","parameters":[{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/query_healthcheck"}}}},"responses":{"4xx":{"description":"Create Health Check response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/healthchecks_components-schemas-single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Create Health Check response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/healthchecks_components-schemas-single_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/zones/{zone_identifier}/healthchecks/{identifier}":{"delete":{"tags":["Health Checks"],"summary":"Delete Health Check","description":"Delete a health check.","operationId":"health-checks-delete-health-check","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/healthchecks_components-schemas-identifier"}},{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{"4xx":{"description":"Delete Health Check response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/healthchecks_components-schemas-id_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Delete Health Check response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/healthchecks_components-schemas-id_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"get":{"tags":["Health Checks"],"summary":"Health Check Details","description":"Fetch a single configured health check.","operationId":"health-checks-health-check-details","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/healthchecks_components-schemas-identifier"}},{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Health Check Details response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/healthchecks_components-schemas-single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Health Check Details response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/healthchecks_components-schemas-single_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"patch":{"tags":["Health Checks"],"summary":"Patch Health Check","description":"Patch a configured health check.","operationId":"health-checks-patch-health-check","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/healthchecks_components-schemas-identifier"}},{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/query_healthcheck"}}}},"responses":{"4xx":{"description":"Patch Health Check response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/healthchecks_components-schemas-single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Patch Health Check response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/healthchecks_components-schemas-single_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"put":{"tags":["Health Checks"],"summary":"Update Health Check","description":"Update a configured health check.","operationId":"health-checks-update-health-check","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/healthchecks_components-schemas-identifier"}},{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/query_healthcheck"}}}},"responses":{"4xx":{"description":"Update Health Check response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/healthchecks_components-schemas-single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Update Health Check response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/healthchecks_components-schemas-single_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/zones/{zone_identifier}/healthchecks/preview":{"post":{"tags":["Health Checks"],"summary":"Create Preview Health Check","description":"Create a new preview health check.","operationId":"health-checks-create-preview-health-check","parameters":[{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/query_healthcheck"}}}},"responses":{"4xx":{"description":"Create Preview Health Check response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/healthchecks_components-schemas-single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Create Preview Health Check response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/healthchecks_components-schemas-single_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/zones/{zone_identifier}/healthchecks/preview/{identifier}":{"delete":{"tags":["Health Checks"],"summary":"Delete Preview Health Check","description":"Delete a health check.","operationId":"health-checks-delete-preview-health-check","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/healthchecks_components-schemas-identifier"}},{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{"4xx":{"description":"Delete Preview Health Check response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/healthchecks_components-schemas-id_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Delete Preview Health Check response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/healthchecks_components-schemas-id_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"get":{"tags":["Health Checks"],"summary":"Health Check Preview Details","description":"Fetch a single configured health check preview.","operationId":"health-checks-health-check-preview-details","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/healthchecks_components-schemas-identifier"}},{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Health Check Preview Details response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/healthchecks_components-schemas-single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Health Check Preview Details response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/healthchecks_components-schemas-single_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/zones/{zone_identifier}/keyless_certificates":{"get":{"tags":["Keyless SSL for a Zone"],"summary":"List Keyless SSL Configurations","description":"List all Keyless SSL configurations for a given zone.","operationId":"keyless-ssl-for-a-zone-list-keyless-ssl-configurations","parameters":[{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"List Keyless SSL Configurations response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/keyless_response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"List Keyless SSL Configurations response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/keyless_response_collection"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"post":{"tags":["Keyless SSL for a Zone"],"summary":"Create Keyless SSL Configuration","operationId":"keyless-ssl-for-a-zone-create-keyless-ssl-configuration","parameters":[{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["host","port","certificate"],"properties":{"bundle_method":{"$ref":"#/components/schemas/bundle_method"},"certificate":{"$ref":"#/components/schemas/schemas-certificate"},"host":{"$ref":"#/components/schemas/schemas-host"},"name":{"$ref":"#/components/schemas/keyless-certificate_components-schemas-name"},"port":{"$ref":"#/components/schemas/schemas-port"}}}}}},"responses":{"4xx":{"description":"Create Keyless SSL Configuration response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/keyless_response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Create Keyless SSL Configuration response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/keyless_response_single"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/zones/{zone_identifier}/keyless_certificates/{identifier}":{"delete":{"tags":["Keyless SSL for a Zone"],"summary":"Delete Keyless SSL Configuration","operationId":"keyless-ssl-for-a-zone-delete-keyless-ssl-configuration","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/keyless-certificate_components-schemas-identifier"}},{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{"4xx":{"description":"Delete Keyless SSL Configuration response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/keyless_response_single_id"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Delete Keyless SSL Configuration response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/keyless_response_single_id"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"get":{"tags":["Keyless SSL for a Zone"],"summary":"Get Keyless SSL Configuration","description":"Get details for one Keyless SSL configuration.","operationId":"keyless-ssl-for-a-zone-get-keyless-ssl-configuration","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/keyless-certificate_components-schemas-identifier"}},{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Get Keyless SSL Configuration response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/keyless_response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Get Keyless SSL Configuration response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/keyless_response_single"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"patch":{"tags":["Keyless SSL for a Zone"],"summary":"Edit Keyless SSL Configuration","description":"This will update attributes of a Keyless SSL. Consists of one or more of the following: host,name,port,certificate,enabled.","operationId":"keyless-ssl-for-a-zone-edit-keyless-ssl-configuration","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/keyless-certificate_components-schemas-identifier"}},{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"enabled":{"$ref":"#/components/schemas/schemas-enabled"},"host":{"$ref":"#/components/schemas/schemas-host"},"name":{"$ref":"#/components/schemas/keyless-certificate_components-schemas-name"},"port":{"$ref":"#/components/schemas/schemas-port"}}}}}},"responses":{"4xx":{"description":"Edit Keyless SSL Configuration response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/keyless_response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Edit Keyless SSL Configuration response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/keyless_response_single"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/zones/{zone_identifier}/logpush/datasets/{dataset}/fields":{"get":{"tags":["Logpush Jobs"],"summary":"List fields","description":"Lists all fields available for a dataset. The response result is an object with key-value pairs, where keys are field names, and values are descriptions.","operationId":"logpush-jobs-list-fields","parameters":[{"name":"dataset","in":"path","required":true,"schema":{"$ref":"#/components/schemas/dataset"}},{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"List fields response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/logpush_field_response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"List fields response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/logpush_field_response_collection"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/zones/{zone_identifier}/logpush/datasets/{dataset}/jobs":{"get":{"tags":["Logpush Jobs"],"summary":"List Logpush jobs for a dataset","description":"Lists Logpush jobs for a zone for a dataset.","operationId":"logpush-jobs-list-logpush-jobs-for-a-dataset","parameters":[{"name":"dataset","in":"path","required":true,"schema":{"$ref":"#/components/schemas/dataset"}},{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"List Logpush jobs for a dataset response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/logpush_job_response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"List Logpush jobs for a dataset response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/logpush_job_response_collection"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/zones/{zone_identifier}/logpush/jobs":{"get":{"tags":["Logpush Jobs"],"summary":"List Logpush jobs","description":"Lists Logpush jobs for a zone.","operationId":"logpush-jobs-list-logpush-jobs","parameters":[{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"List Logpush jobs response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/logpush_job_response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"List Logpush jobs response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/logpush_job_response_collection"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"post":{"tags":["Logpush Jobs"],"summary":"Create Logpush job","description":"Creates a new Logpush job for a zone.","operationId":"logpush-jobs-create-logpush-job","parameters":[{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["destination_conf"],"properties":{"dataset":{"$ref":"#/components/schemas/dataset"},"destination_conf":{"$ref":"#/components/schemas/destination_conf"},"enabled":{"$ref":"#/components/schemas/enabled"},"frequency":{"$ref":"#/components/schemas/components-schemas-frequency"},"logpull_options":{"$ref":"#/components/schemas/logpull_options"},"name":{"$ref":"#/components/schemas/logpush_components-schemas-name"},"ownership_challenge":{"$ref":"#/components/schemas/ownership_challenge"}}}}}},"responses":{"4xx":{"description":"Create Logpush job response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/logpush_job_response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Create Logpush job response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/logpush_job_response_single"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/zones/{zone_identifier}/logpush/jobs/{job_identifier}":{"delete":{"tags":["Logpush Jobs"],"summary":"Delete Logpush job","description":"Deletes a Logpush job.","operationId":"logpush-jobs-delete-logpush-job","parameters":[{"name":"job_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/id"}},{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{"4xx":{"description":"Delete Logpush job response failure","content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/api-response-common"},{"properties":{"result":{"type":"object","example":{},"nullable":true}}}]},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Delete Logpush job response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-response-common"},{"properties":{"result":{"type":"object","example":{},"nullable":true}}}]}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"get":{"tags":["Logpush Jobs"],"summary":"Get Logpush job details","description":"Gets the details of a Logpush job.","operationId":"logpush-jobs-get-logpush-job-details","parameters":[{"name":"job_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/id"}},{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Get Logpush job details response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/logpush_job_response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Get Logpush job details response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/logpush_job_response_single"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"put":{"tags":["Logpush Jobs"],"summary":"Update Logpush job","description":"Updates a Logpush job.","operationId":"logpush-jobs-update-logpush-job","parameters":[{"name":"job_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/id"}},{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"destination_conf":{"$ref":"#/components/schemas/destination_conf"},"enabled":{"$ref":"#/components/schemas/enabled"},"frequency":{"$ref":"#/components/schemas/components-schemas-frequency"},"logpull_options":{"$ref":"#/components/schemas/logpull_options"},"ownership_challenge":{"$ref":"#/components/schemas/ownership_challenge"}}}}}},"responses":{"4xx":{"description":"Update Logpush job response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/logpush_job_response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Update Logpush job response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/logpush_job_response_single"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/zones/{zone_identifier}/logpush/ownership":{"post":{"tags":["Logpush Jobs"],"summary":"Get ownership challenge","description":"Gets a new ownership challenge sent to your destination.","operationId":"logpush-jobs-get-ownership-challenge","parameters":[{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["destination_conf"],"properties":{"destination_conf":{"$ref":"#/components/schemas/destination_conf"}}}}}},"responses":{"4xx":{"description":"Get ownership challenge response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/get_ownership_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Get ownership challenge response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/get_ownership_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/zones/{zone_identifier}/logpush/ownership/validate":{"post":{"tags":["Logpush Jobs"],"summary":"Validate ownership challenge","description":"Validates ownership challenge of the destination.","operationId":"logpush-jobs-validate-ownership-challenge","parameters":[{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["destination_conf","ownership_challenge"],"properties":{"destination_conf":{"$ref":"#/components/schemas/destination_conf"},"ownership_challenge":{"$ref":"#/components/schemas/ownership_challenge"}}}}}},"responses":{"4xx":{"description":"Validate ownership challenge response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/validate_ownership_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Validate ownership challenge response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/validate_ownership_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/zones/{zone_identifier}/logpush/validate/destination/exists":{"post":{"tags":["Logpush Jobs"],"summary":"Check destination exists","description":"Checks if there is an existing job with a destination.","operationId":"logpush-jobs-check-destination-exists","parameters":[{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["destination_conf"],"properties":{"destination_conf":{"$ref":"#/components/schemas/destination_conf"}}}}}},"responses":{"4xx":{"description":"Check destination exists response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/destination_exists_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Check destination exists response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/destination_exists_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/zones/{zone_identifier}/logpush/validate/origin":{"post":{"tags":["Logpush Jobs"],"summary":"Validate origin","description":"Validates logpull origin with logpull_options.","operationId":"logpush-jobs-validate-origin","parameters":[{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["logpull_options"],"properties":{"logpull_options":{"$ref":"#/components/schemas/logpull_options"}}}}}},"responses":{"4xx":{"description":"Validate origin response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/validate_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Validate origin response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/validate_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/zones/{zone_identifier}/logs/control/retention/flag":{"get":{"tags":["Logs Received"],"summary":"Get log retention flag","description":"Gets log retention flag for Logpull API.","operationId":"logs-received-get-log-retention-flag","parameters":[{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Get log retention flag response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/flag_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Get log retention flag response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/flag_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"post":{"tags":["Logs Received"],"summary":"Update log retention flag","description":"Updates log retention flag for Logpull API.","operationId":"logs-received-update-log-retention-flag","parameters":[{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["flag"],"properties":{"flag":{"$ref":"#/components/schemas/flag"}}}}}},"responses":{"4xx":{"description":"Update log retention flag response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/flag_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Update log retention flag response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/flag_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/zones/{zone_identifier}/logs/rayids/{ray_identifier}":{"get":{"tags":["Logs Received"],"summary":"Get logs RayIDs","description":"The `/rayids` api route allows lookups by specific rayid. The rayids route will return zero, one, or more records (ray ids are not unique).","operationId":"logs-received-get-logs-ray-i-ds","parameters":[{"name":"ray_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ray_identifier"}},{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Get logs RayIDs response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/logs"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Get logs RayIDs response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/logs"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/zones/{zone_identifier}/logs/received":{"get":{"tags":["Logs Received"],"summary":"Get logs received","description":"The `/received` api route allows customers to retrieve their edge HTTP logs. The basic access pattern is \"give me all the logs for zone Z for minute M\", where the minute M refers to the time records were received at Cloudflare's central data center. `start` is inclusive, and `end` is exclusive. Because of that, to get all data, at minutely cadence, starting at 10AM, the proper values are: `start=2018-05-20T10:00:00Z&end=2018-05-20T10:01:00Z`, then `start=2018-05-20T10:01:00Z&end=2018-05-20T10:02:00Z` and so on; the overlap will be handled properly.","operationId":"logs-received-get-logs-received","parameters":[{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Get logs received response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/logs"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Get logs received response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/logs"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/zones/{zone_identifier}/logs/received/fields":{"get":{"tags":["Logs Received"],"summary":"List fields","description":"Lists all fields available. The response is json object with key-value pairs, where keys are field names, and values are descriptions.","operationId":"logs-received-list-fields","parameters":[{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"List fields response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/fields_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"List fields response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/fields_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/zones/{zone_identifier}/origin_tls_client_auth":{"get":{"tags":["Zone-Level Authenticated Origin Pulls"],"summary":"List Certificates","operationId":"zone-level-authenticated-origin-pulls-list-certificates","parameters":[{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"List Certificates response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/components-schemas-certificate_response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"List Certificates response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/components-schemas-certificate_response_collection"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"post":{"tags":["Zone-Level Authenticated Origin Pulls"],"summary":"Upload Certificate","description":"Upload your own certificate you want Cloudflare to use for edge-to-origin communication to override the shared certificate. Please note that it is important to keep only one certificate active. Also, make sure to enable zone-level authenticated origin pulls by making a PUT call to settings endpoint to see the uploaded certificate in use.","operationId":"zone-level-authenticated-origin-pulls-upload-certificate","parameters":[{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["certificate","private_key"],"properties":{"certificate":{"$ref":"#/components/schemas/zone-authenticated-origin-pull_components-schemas-certificate"},"private_key":{"$ref":"#/components/schemas/private_key"}}}}}},"responses":{"4xx":{"description":"Upload Certificate response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/certificate_response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Upload Certificate response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/certificate_response_single"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/zones/{zone_identifier}/origin_tls_client_auth/{identifier}":{"delete":{"tags":["Zone-Level Authenticated Origin Pulls"],"summary":"Delete Certificate","operationId":"zone-level-authenticated-origin-pulls-delete-certificate","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/zone-authenticated-origin-pull_components-schemas-identifier"}},{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{"4xx":{"description":"Delete Certificate response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/certificate_response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Delete Certificate response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/certificate_response_single"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"get":{"tags":["Zone-Level Authenticated Origin Pulls"],"summary":"Get Certificate Details","operationId":"zone-level-authenticated-origin-pulls-get-certificate-details","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/zone-authenticated-origin-pull_components-schemas-identifier"}},{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Get Certificate Details response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/certificate_response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Get Certificate Details response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/certificate_response_single"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/zones/{zone_identifier}/origin_tls_client_auth/hostnames":{"put":{"tags":["Per-hostname Authenticated Origin Pull"],"summary":"Enable or Disable a Hostname for Client Authentication","description":"Associate a hostname to a certificate and enable, disable or invalidate the association. If disabled, client certificate will not be sent to the hostname even if activated at the zone level. 100 maximum associations on a single certificate are allowed. Note: Use a null value for parameter *enabled* to invalidate the association.","operationId":"per-hostname-authenticated-origin-pull-enable-or-disable-a-hostname-for-client-authentication","parameters":[{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["config"],"properties":{"config":{"$ref":"#/components/schemas/config"}}}}}},"responses":{"4xx":{"description":"Enable or Disable a Hostname for Client Authentication response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/hostname_aop_response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Enable or Disable a Hostname for Client Authentication response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/hostname_aop_response_collection"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/zones/{zone_identifier}/origin_tls_client_auth/hostnames/{hostname}":{"get":{"tags":["Per-hostname Authenticated Origin Pull"],"summary":"Get the Hostname Status for Client Authentication","operationId":"per-hostname-authenticated-origin-pull-get-the-hostname-status-for-client-authentication","parameters":[{"name":"hostname","in":"path","required":true,"schema":{"$ref":"#/components/schemas/schemas-hostname"}},{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Get the Hostname Status for Client Authentication response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/hostname_aop_single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Get the Hostname Status for Client Authentication response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/hostname_aop_single_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/zones/{zone_identifier}/origin_tls_client_auth/hostnames/certificates":{"get":{"tags":["Per-hostname Authenticated Origin Pull"],"summary":"List Certificates","operationId":"per-hostname-authenticated-origin-pull-list-certificates","parameters":[{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"List Certificates response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/hostname-authenticated-origin-pull_components-schemas-certificate_response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"List Certificates response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/hostname-authenticated-origin-pull_components-schemas-certificate_response_collection"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"post":{"tags":["Per-hostname Authenticated Origin Pull"],"summary":"Upload a Hostname Client Certificate","description":"Upload a certificate to be used for client authentication on a hostname. 10 hostname certificates per zone are allowed.","operationId":"per-hostname-authenticated-origin-pull-upload-a-hostname-client-certificate","parameters":[{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["certificate","private_key"],"properties":{"certificate":{"$ref":"#/components/schemas/hostname-authenticated-origin-pull_components-schemas-certificate"},"private_key":{"$ref":"#/components/schemas/schemas-private_key"}}}}}},"responses":{"4xx":{"description":"Upload a Hostname Client Certificate response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/components-schemas-certificate_response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Upload a Hostname Client Certificate response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/components-schemas-certificate_response_single"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/zones/{zone_identifier}/origin_tls_client_auth/hostnames/certificates/{identifier}":{"delete":{"tags":["Per-hostname Authenticated Origin Pull"],"summary":"Delete Hostname Client Certificate","operationId":"per-hostname-authenticated-origin-pull-delete-hostname-client-certificate","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/hostname-authenticated-origin-pull_components-schemas-identifier"}},{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{"4xx":{"description":"Delete Hostname Client Certificate response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/components-schemas-certificate_response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Delete Hostname Client Certificate response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/components-schemas-certificate_response_single"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"get":{"tags":["Per-hostname Authenticated Origin Pull"],"summary":"Get the Hostname Client Certificate","description":"Get the certificate by ID to be used for client authentication on a hostname.","operationId":"per-hostname-authenticated-origin-pull-get-the-hostname-client-certificate","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/hostname-authenticated-origin-pull_components-schemas-identifier"}},{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Get the Hostname Client Certificate response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/components-schemas-certificate_response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Get the Hostname Client Certificate response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/components-schemas-certificate_response_single"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/zones/{zone_identifier}/origin_tls_client_auth/settings":{"get":{"tags":["Zone-Level Authenticated Origin Pulls"],"summary":"Get Enablement Setting for Zone","description":"Get whether zone-level authenticated origin pulls is enabled or not. It is false by default.","operationId":"zone-level-authenticated-origin-pulls-get-enablement-setting-for-zone","parameters":[{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Get Enablement Setting for Zone response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/enabled_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Get Enablement Setting for Zone response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/enabled_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"put":{"tags":["Zone-Level Authenticated Origin Pulls"],"summary":"Set Enablement for Zone","description":"Enable or disable zone-level authenticated origin pulls. 'enabled' should be set true either before/after the certificate is uploaded to see the certificate in use.","operationId":"zone-level-authenticated-origin-pulls-set-enablement-for-zone","parameters":[{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["enabled"],"properties":{"enabled":{"$ref":"#/components/schemas/zone-authenticated-origin-pull_components-schemas-enabled"}}}}}},"responses":{"4xx":{"description":"Set Enablement for Zone response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/enabled_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Set Enablement for Zone response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/enabled_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/zones/{zone_identifier}/pagerules":{"get":{"tags":["Page Rules"],"summary":"List Page Rules","description":"Fetches Page Rules in a zone.","operationId":"page-rules-list-page-rules","parameters":[{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"List Page Rules response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/pagerule_response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"List Page Rules response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/pagerule_response_collection"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"post":{"tags":["Page Rules"],"summary":"Create a Page Rule","description":"Creates a new Page Rule.","operationId":"page-rules-create-a-page-rule","parameters":[{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["targets","actions"],"properties":{"actions":{"$ref":"#/components/schemas/schemas-actions"},"priority":{"$ref":"#/components/schemas/page-rule_components-schemas-priority"},"status":{"$ref":"#/components/schemas/page-rule_components-schemas-status"},"targets":{"$ref":"#/components/schemas/targets"}}}}}},"responses":{"4xx":{"description":"Create a Page Rule response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/pagerule_response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Create a Page Rule response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/pagerule_response_single"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/zones/{zone_identifier}/pagerules/{identifier}":{"delete":{"tags":["Page Rules"],"summary":"Delete a Page Rule","description":"Deletes an existing Page Rule.","operationId":"page-rules-delete-a-page-rule","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}},{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{"4xx":{"description":"Delete a Page Rule response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-response-single-id"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Delete a Page Rule response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-response-single-id"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"get":{"tags":["Page Rules"],"summary":"Get a Page Rule","description":"Fetches the details of a Page Rule.","operationId":"page-rules-get-a-page-rule","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}},{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Get a Page Rule response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/pagerule_response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Get a Page Rule response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/pagerule_response_single"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"patch":{"tags":["Page Rules"],"summary":"Edit a Page Rule","description":"Updates one or more fields of an existing Page Rule.","operationId":"page-rules-edit-a-page-rule","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}},{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"actions":{"$ref":"#/components/schemas/schemas-actions"},"priority":{"$ref":"#/components/schemas/page-rule_components-schemas-priority"},"status":{"$ref":"#/components/schemas/page-rule_components-schemas-status"},"targets":{"$ref":"#/components/schemas/targets"}}}}}},"responses":{"4xx":{"description":"Edit a Page Rule response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/pagerule_response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Edit a Page Rule response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/pagerule_response_single"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"put":{"tags":["Page Rules"],"summary":"Update a Page Rule","description":"Replaces the configuration of an existing Page Rule. The configuration of the updated Page Rule will exactly match the data passed in the API request.","operationId":"page-rules-update-a-page-rule","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}},{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["targets","actions"],"properties":{"actions":{"$ref":"#/components/schemas/schemas-actions"},"priority":{"$ref":"#/components/schemas/page-rule_components-schemas-priority"},"status":{"$ref":"#/components/schemas/page-rule_components-schemas-status"},"targets":{"$ref":"#/components/schemas/targets"}}}}}},"responses":{"4xx":{"description":"Update a Page Rule response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/pagerule_response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Update a Page Rule response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/pagerule_response_single"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/zones/{zone_identifier}/pagerules/settings":{"get":{"tags":["Available Page Rules settings"],"summary":"List available Page Rules settings","description":"Returns a list of settings (and their details) that Page Rules can apply to matching requests.","operationId":"available-page-rules-settings-list-available-page-rules-settings","parameters":[{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"List available Page Rules settings response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/pagerule_settings_response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"List available Page Rules settings response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/pagerule_settings_response_collection"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/zones/{zone_identifier}/railguns":{"get":{"tags":["Railgun Connections for a Zone"],"summary":"List available Railguns","description":"A list of available Railguns the zone can use.","operationId":"railgun-connections-for-a-zone-list-available-railguns","parameters":[{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"List available Railguns response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/schemas-railgun_response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"List available Railguns response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/schemas-railgun_response_collection"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/zones/{zone_identifier}/railguns/{identifier}":{"get":{"tags":["Railgun Connections for a Zone"],"summary":"Railgun details","description":"Lists details about a specific Railgun.","operationId":"railgun-connections-for-a-zone-railgun-details","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/railgun_components-schemas-identifier-2"}},{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Railgun details response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/railgun_response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Railgun details response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/railgun_response_single"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"patch":{"tags":["Railgun Connections for a Zone"],"summary":"Connect or disconnect a Railgun","description":"Connect or disconnect a Railgun.","operationId":"railgun-connections-for-a-zone-connect-or-disconnect-a-railgun","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/railgun_components-schemas-identifier-2"}},{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["connected"],"properties":{"connected":{"$ref":"#/components/schemas/connected"}}}}}},"responses":{"4xx":{"description":"Connect or disconnect a Railgun response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/railgun_response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Connect or disconnect a Railgun response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/railgun_response_single"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/zones/{zone_identifier}/railguns/{identifier}/diagnose":{"get":{"tags":["Railgun Connections for a Zone"],"summary":"Test Railgun connection","description":"Tests the Railgun connection to the zone.","operationId":"railgun-connections-for-a-zone-test-railgun-connection","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/railgun_components-schemas-identifier-2"}},{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Test Railgun connection response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/test_connection_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Test Railgun connection response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/test_connection_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/zones/{zone_identifier}/rate_limits":{"get":{"tags":["Rate limits for a zone"],"summary":"List rate limits","description":"Fetches the rate limits for a zone.","operationId":"rate-limits-for-a-zone-list-rate-limits","parameters":[{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"List rate limits response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ratelimit_response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"List rate limits response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ratelimit_response_collection"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"post":{"tags":["Rate limits for a zone"],"summary":"Create a rate limit","description":"Creates a new rate limit for a zone. Refer to the object definition for a list of required attributes.","operationId":"rate-limits-for-a-zone-create-a-rate-limit","parameters":[{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["match","threshold","period","action"]}}}},"responses":{"4xx":{"description":"Create a rate limit response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ratelimit_response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Create a rate limit response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ratelimit_response_single"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/zones/{zone_identifier}/rate_limits/{id}":{"delete":{"tags":["Rate limits for a zone"],"summary":"Delete a rate limit","description":"Deletes an existing rate limit.","operationId":"rate-limits-for-a-zone-delete-a-rate-limit","parameters":[{"name":"id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/rate-limits_components-schemas-id"}},{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{"4xx":{"description":"Delete a rate limit response failure","content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/ratelimit_response_single"},{"type":"object","properties":{"result":{"properties":{"id":{"$ref":"#/components/schemas/rate-limits_components-schemas-id"}}}}}]},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Delete a rate limit response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ratelimit_response_single"},{"type":"object","properties":{"result":{"properties":{"id":{"$ref":"#/components/schemas/rate-limits_components-schemas-id"}}}}}]}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"get":{"tags":["Rate limits for a zone"],"summary":"Get a rate limit","description":"Fetches the details of a rate limit.","operationId":"rate-limits-for-a-zone-get-a-rate-limit","parameters":[{"name":"id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/rate-limits_components-schemas-id"}},{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Get a rate limit response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ratelimit_response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Get a rate limit response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ratelimit_response_single"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"put":{"tags":["Rate limits for a zone"],"summary":"Update a rate limit","description":"Updates an existing rate limit.","operationId":"rate-limits-for-a-zone-update-a-rate-limit","parameters":[{"name":"id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/rate-limits_components-schemas-id"}},{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["id","match","threshold","period","action"]}}}},"responses":{"4xx":{"description":"Update a rate limit response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ratelimit_response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Update a rate limit response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ratelimit_response_single"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/zones/{zone_identifier}/settings":{"get":{"tags":["Zone Settings"],"summary":"Get all Zone settings","description":"Available settings for your user in relation to a zone.","operationId":"zone-settings-get-all-zone-settings","parameters":[{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Get all Zone settings response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Get all Zone settings response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/zone_settings_response_collection"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"patch":{"tags":["Zone Settings"],"summary":"Edit zone settings info","description":"Edit settings for a zone.","operationId":"zone-settings-edit-zone-settings-info","parameters":[{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["items"],"properties":{"items":{"type":"array","description":"One or more zone setting objects. Must contain an ID and a value.","example":[{"id":"always_online","value":"on"},{"id":"browser_cache_ttl","value":18000},{"id":"ip_geolocation","value":"off"}],"minItems":1,"items":{"$ref":"#/components/schemas/setting"}}}}}}},"responses":{"4xx":{"description":"Edit zone settings info response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Edit zone settings info response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/zone_settings_response_collection"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/zones/{zone_identifier}/settings/0rtt":{"get":{"tags":["Zone Settings"],"summary":"Get 0-RTT session resumption setting","description":"Gets 0-RTT session resumption setting.","operationId":"zone-settings-get-0-rtt-session-resumption-setting","parameters":[{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Get 0-RTT session resumption setting response failure","content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single"},{"properties":{"result":{"$ref":"#/components/schemas/0rtt"}}}]},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Get 0-RTT session resumption setting response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single"},{"properties":{"result":{"$ref":"#/components/schemas/0rtt"}}}]}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"patch":{"tags":["Zone Settings"],"summary":"Change 0-RTT session resumption setting","description":"Changes the 0-RTT session resumption setting.","operationId":"zone-settings-change-0-rtt-session-resumption-setting","parameters":[{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["value"],"properties":{"value":{"$ref":"#/components/schemas/0rtt_value"}}}}}},"responses":{"4xx":{"description":"Change 0-RTT session resumption setting response failure","content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single"},{"properties":{"result":{"$ref":"#/components/schemas/0rtt"}}}]},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Change 0-RTT session resumption setting response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single"},{"properties":{"result":{"$ref":"#/components/schemas/0rtt"}}}]}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/zones/{zone_identifier}/settings/advanced_ddos":{"get":{"tags":["Zone Settings"],"summary":"Get Advanced DDOS setting","description":"Advanced protection from Distributed Denial of Service (DDoS) attacks on your website. This is an uneditable value that is 'on' in the case of Business and Enterprise zones.","operationId":"zone-settings-get-advanced-ddos-setting","parameters":[{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Get Advanced DDOS setting response failure","content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single"},{"properties":{"result":{"$ref":"#/components/schemas/advanced_ddos"}}}]},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Get Advanced DDOS setting response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single"},{"properties":{"result":{"$ref":"#/components/schemas/advanced_ddos"}}}]}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/zones/{zone_identifier}/settings/always_online":{"get":{"tags":["Zone Settings"],"summary":"Get Always Online setting","description":"When enabled, Cloudflare serves limited copies of web pages available from the [Internet Archive's Wayback Machine](https://archive.org/web/) if your server is offline. Refer to [Always Online](https://developers.cloudflare.com/cache/about/always-online) for more information.","operationId":"zone-settings-get-always-online-setting","parameters":[{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Get Always Online setting response failure","content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single"},{"properties":{"result":{"$ref":"#/components/schemas/always_online"}}}]},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Get Always Online setting response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single"},{"properties":{"result":{"$ref":"#/components/schemas/always_online"}}}]}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"patch":{"tags":["Zone Settings"],"summary":"Change Always Online setting","description":"When enabled, Cloudflare serves limited copies of web pages available from the [Internet Archive's Wayback Machine](https://archive.org/web/) if your server is offline. Refer to [Always Online](https://developers.cloudflare.com/cache/about/always-online) for more information.","operationId":"zone-settings-change-always-online-setting","parameters":[{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["value"],"properties":{"value":{"$ref":"#/components/schemas/always_online_value"}}}}}},"responses":{"4xx":{"description":"Change Always Online setting response failure","content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single"},{"properties":{"result":{"$ref":"#/components/schemas/always_online"}}}]},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Change Always Online setting response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single"},{"properties":{"result":{"$ref":"#/components/schemas/always_online"}}}]}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/zones/{zone_identifier}/settings/always_use_https":{"get":{"tags":["Zone Settings"],"summary":"Get Always Use HTTPS setting","description":"Reply to all requests for URLs that use \"http\" with a 301 redirect to the equivalent \"https\" URL. If you only want to redirect for a subset of requests, consider creating an \"Always use HTTPS\" page rule.","operationId":"zone-settings-get-always-use-https-setting","parameters":[{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Get Always Use HTTPS setting response failure","content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single"},{"properties":{"result":{"$ref":"#/components/schemas/always_use_https"}}}]},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Get Always Use HTTPS setting response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single"},{"properties":{"result":{"$ref":"#/components/schemas/always_use_https"}}}]}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"patch":{"tags":["Zone Settings"],"summary":"Change Always Use HTTPS setting","description":"Reply to all requests for URLs that use \"http\" with a 301 redirect to the equivalent \"https\" URL. If you only want to redirect for a subset of requests, consider creating an \"Always use HTTPS\" page rule.","operationId":"zone-settings-change-always-use-https-setting","parameters":[{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["value"],"properties":{"value":{"$ref":"#/components/schemas/always_use_https_value"}}}}}},"responses":{"4xx":{"description":"Change Always Use HTTPS setting response failure","content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single"},{"properties":{"result":{"$ref":"#/components/schemas/always_use_https"}}}]},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Change Always Use HTTPS setting response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single"},{"properties":{"result":{"$ref":"#/components/schemas/always_use_https"}}}]}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/zones/{zone_identifier}/settings/automatic_https_rewrites":{"get":{"tags":["Zone Settings"],"summary":"Get Automatic HTTPS Rewrites setting","description":"Enable the Automatic HTTPS Rewrites feature for this zone.","operationId":"zone-settings-get-automatic-https-rewrites-setting","parameters":[{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Get Automatic HTTPS Rewrites setting response failure","content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single"},{"properties":{"result":{"$ref":"#/components/schemas/automatic_https_rewrites"}}}]},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Get Automatic HTTPS Rewrites setting response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single"},{"properties":{"result":{"$ref":"#/components/schemas/automatic_https_rewrites"}}}]}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"patch":{"tags":["Zone Settings"],"summary":"Change Automatic HTTPS Rewrites setting","description":"Enable the Automatic HTTPS Rewrites feature for this zone.","operationId":"zone-settings-change-automatic-https-rewrites-setting","parameters":[{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["value"],"properties":{"value":{"$ref":"#/components/schemas/automatic_https_rewrites_value"}}}}}},"responses":{"4xx":{"description":"Change Automatic HTTPS Rewrites setting response failure","content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single"},{"properties":{"result":{"$ref":"#/components/schemas/automatic_https_rewrites"}}}]},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Change Automatic HTTPS Rewrites setting response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single"},{"properties":{"result":{"$ref":"#/components/schemas/automatic_https_rewrites"}}}]}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/zones/{zone_identifier}/settings/automatic_platform_optimization":{"get":{"tags":["Zone Settings"],"summary":"Get Automatic Platform Optimization for WordPress settings","description":"[Automatic Platform Optimization for WordPress](https://developers.cloudflare.com/automatic-platform-optimization/) serves your WordPress site from Cloudflare's edge network and caches third-party fonts.","operationId":"zone-settings-get-automatic-platform-optimization-for-word-press-settings","parameters":[{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Get Automatic Platform Optimization for WordPress settings response failure","content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single"},{"properties":{"result":{"$ref":"#/components/schemas/automatic_platform_optimization"}}}]},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Get Automatic Platform Optimization for WordPress settings response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single"},{"properties":{"result":{"$ref":"#/components/schemas/automatic_platform_optimization"}}}]}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"patch":{"tags":["Zone Settings"],"summary":"Change Automatic Platform Optimization for WordPress settings","description":"[Automatic Platform Optimization for WordPress](https://developers.cloudflare.com/automatic-platform-optimization/) serves your WordPress site from Cloudflare's edge network and caches third-party fonts.","operationId":"zone-settings-change-automatic-platform-optimization-for-word-press-settings","parameters":[{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["value"],"properties":{"value":{"$ref":"#/components/schemas/automatic_platform_optimization"}}}}}},"responses":{"4xx":{"description":"Change Automatic Platform Optimization for WordPress settings response failure","content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single"},{"properties":{"result":{"$ref":"#/components/schemas/automatic_platform_optimization"}}}]},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Change Automatic Platform Optimization for WordPress settings response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single"},{"properties":{"result":{"$ref":"#/components/schemas/automatic_platform_optimization"}}}]}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/zones/{zone_identifier}/settings/brotli":{"get":{"tags":["Zone Settings"],"summary":"Get Brotli setting","description":"When the client requesting an asset supports the Brotli compression algorithm, Cloudflare will serve a Brotli compressed version of the asset.","operationId":"zone-settings-get-brotli-setting","parameters":[{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Get Brotli setting response failure","content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single"},{"properties":{"result":{"$ref":"#/components/schemas/brotli"}}}]},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Get Brotli setting response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single"},{"properties":{"result":{"$ref":"#/components/schemas/brotli"}}}]}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"patch":{"tags":["Zone Settings"],"summary":"Change Brotli setting","description":"When the client requesting an asset supports the Brotli compression algorithm, Cloudflare will serve a Brotli compressed version of the asset.","operationId":"zone-settings-change-brotli-setting","parameters":[{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["value"],"properties":{"value":{"$ref":"#/components/schemas/brotli_value"}}}}}},"responses":{"4xx":{"description":"Change Brotli setting response failure","content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single"},{"properties":{"result":{"$ref":"#/components/schemas/brotli"}}}]},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Change Brotli setting response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single"},{"properties":{"result":{"$ref":"#/components/schemas/brotli"}}}]}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/zones/{zone_identifier}/settings/browser_cache_ttl":{"get":{"tags":["Zone Settings"],"summary":"Get Browser Cache TTL setting","description":"Browser Cache TTL (in seconds) specifies how long Cloudflare-cached resources will remain on your visitors' computers. Cloudflare will honor any larger times specified by your server. (https://support.cloudflare.com/hc/en-us/articles/200168276).","operationId":"zone-settings-get-browser-cache-ttl-setting","parameters":[{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Get Browser Cache TTL setting response failure","content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single"},{"properties":{"result":{"$ref":"#/components/schemas/browser_cache_ttl"}}}]},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Get Browser Cache TTL setting response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single"},{"properties":{"result":{"$ref":"#/components/schemas/browser_cache_ttl"}}}]}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"patch":{"tags":["Zone Settings"],"summary":"Change Browser Cache TTL setting","description":"Browser Cache TTL (in seconds) specifies how long Cloudflare-cached resources will remain on your visitors' computers. Cloudflare will honor any larger times specified by your server. (https://support.cloudflare.com/hc/en-us/articles/200168276).","operationId":"zone-settings-change-browser-cache-ttl-setting","parameters":[{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["value"],"properties":{"value":{"$ref":"#/components/schemas/browser_cache_ttl_value"}}}}}},"responses":{"4xx":{"description":"Change Browser Cache TTL setting response failure","content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single"},{"properties":{"result":{"$ref":"#/components/schemas/browser_cache_ttl"}}}]},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Change Browser Cache TTL setting response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single"},{"properties":{"result":{"$ref":"#/components/schemas/browser_cache_ttl"}}}]}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/zones/{zone_identifier}/settings/browser_check":{"get":{"tags":["Zone Settings"],"summary":"Get Browser Check setting","description":"Browser Integrity Check is similar to Bad Behavior and looks for common HTTP headers abused most commonly by spammers and denies access to your page. It will also challenge visitors that do not have a user agent or a non standard user agent (also commonly used by abuse bots, crawlers or visitors). (https://support.cloudflare.com/hc/en-us/articles/200170086).","operationId":"zone-settings-get-browser-check-setting","parameters":[{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Get Browser Check setting response failure","content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single"},{"properties":{"result":{"$ref":"#/components/schemas/browser_check"}}}]},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Get Browser Check setting response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single"},{"properties":{"result":{"$ref":"#/components/schemas/browser_check"}}}]}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"patch":{"tags":["Zone Settings"],"summary":"Change Browser Check setting","description":"Browser Integrity Check is similar to Bad Behavior and looks for common HTTP headers abused most commonly by spammers and denies access to your page. It will also challenge visitors that do not have a user agent or a non standard user agent (also commonly used by abuse bots, crawlers or visitors). (https://support.cloudflare.com/hc/en-us/articles/200170086).","operationId":"zone-settings-change-browser-check-setting","parameters":[{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["value"],"properties":{"value":{"$ref":"#/components/schemas/browser_check_value"}}}}}},"responses":{"4xx":{"description":"Change Browser Check setting response failure","content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single"},{"properties":{"result":{"$ref":"#/components/schemas/browser_check"}}}]},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Change Browser Check setting response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single"},{"properties":{"result":{"$ref":"#/components/schemas/browser_check"}}}]}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/zones/{zone_identifier}/settings/cache_level":{"get":{"tags":["Zone Settings"],"summary":"Get Cache Level setting","description":"Cache Level functions based off the setting level. The basic setting will cache most static resources (i.e., css, images, and JavaScript). The simplified setting will ignore the query string when delivering a cached resource. The aggressive setting will cache all static resources, including ones with a query string. (https://support.cloudflare.com/hc/en-us/articles/200168256).","operationId":"zone-settings-get-cache-level-setting","parameters":[{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Get Cache Level setting response failure","content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single"},{"properties":{"result":{"$ref":"#/components/schemas/cache_level"}}}]},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Get Cache Level setting response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single"},{"properties":{"result":{"$ref":"#/components/schemas/cache_level"}}}]}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"patch":{"tags":["Zone Settings"],"summary":"Change Cache Level setting","description":"Cache Level functions based off the setting level. The basic setting will cache most static resources (i.e., css, images, and JavaScript). The simplified setting will ignore the query string when delivering a cached resource. The aggressive setting will cache all static resources, including ones with a query string. (https://support.cloudflare.com/hc/en-us/articles/200168256).","operationId":"zone-settings-change-cache-level-setting","parameters":[{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["value"],"properties":{"value":{"$ref":"#/components/schemas/cache_level_value"}}}}}},"responses":{"4xx":{"description":"Change Cache Level setting response failure","content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single"},{"properties":{"result":{"$ref":"#/components/schemas/cache_level"}}}]},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Change Cache Level setting response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single"},{"properties":{"result":{"$ref":"#/components/schemas/cache_level"}}}]}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/zones/{zone_identifier}/settings/challenge_ttl":{"get":{"tags":["Zone Settings"],"summary":"Get Challenge TTL setting","description":"Specify how long a visitor is allowed access to your site after successfully completing a challenge (such as a CAPTCHA). After the TTL has expired the visitor will have to complete a new challenge. We recommend a 15 - 45 minute setting and will attempt to honor any setting above 45 minutes. (https://support.cloudflare.com/hc/en-us/articles/200170136).","operationId":"zone-settings-get-challenge-ttl-setting","parameters":[{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Get Challenge TTL setting response failure","content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single"},{"properties":{"result":{"$ref":"#/components/schemas/challenge_ttl"}}}]},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Get Challenge TTL setting response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single"},{"properties":{"result":{"$ref":"#/components/schemas/challenge_ttl"}}}]}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"patch":{"tags":["Zone Settings"],"summary":"Change Challenge TTL setting","description":"Specify how long a visitor is allowed access to your site after successfully completing a challenge (such as a CAPTCHA). After the TTL has expired the visitor will have to complete a new challenge. We recommend a 15 - 45 minute setting and will attempt to honor any setting above 45 minutes. (https://support.cloudflare.com/hc/en-us/articles/200170136).","operationId":"zone-settings-change-challenge-ttl-setting","parameters":[{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["value"],"properties":{"value":{"$ref":"#/components/schemas/challenge_ttl_value"}}}}}},"responses":{"4xx":{"description":"Change Challenge TTL setting response failure","content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single"},{"properties":{"result":{"$ref":"#/components/schemas/challenge_ttl"}}}]},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Change Challenge TTL setting response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single"},{"properties":{"result":{"$ref":"#/components/schemas/challenge_ttl"}}}]}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/zones/{zone_identifier}/settings/ciphers":{"get":{"tags":["Zone Settings"],"summary":"Get ciphers setting","description":"Gets ciphers setting.","operationId":"zone-settings-get-ciphers-setting","parameters":[{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Get ciphers setting response failure","content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single"},{"properties":{"result":{"$ref":"#/components/schemas/ciphers"}}}]},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Get ciphers setting response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single"},{"properties":{"result":{"$ref":"#/components/schemas/ciphers"}}}]}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"patch":{"tags":["Zone Settings"],"summary":"Change ciphers setting","description":"Changes ciphers setting.","operationId":"zone-settings-change-ciphers-setting","parameters":[{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["value"],"properties":{"value":{"$ref":"#/components/schemas/ciphers_value"}}}}}},"responses":{"4xx":{"description":"Change ciphers setting response failure","content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single"},{"properties":{"result":{"$ref":"#/components/schemas/ciphers"}}}]},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Change ciphers setting response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single"},{"properties":{"result":{"$ref":"#/components/schemas/ciphers"}}}]}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/zones/{zone_identifier}/settings/development_mode":{"get":{"tags":["Zone Settings"],"summary":"Get Development Mode setting","description":"Development Mode temporarily allows you to enter development mode for your websites if you need to make changes to your site. This will bypass Cloudflare's accelerated cache and slow down your site, but is useful if you are making changes to cacheable content (like images, css, or JavaScript) and would like to see those changes right away. Once entered, development mode will last for 3 hours and then automatically toggle off.","operationId":"zone-settings-get-development-mode-setting","parameters":[{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Get Development Mode setting response failure","content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single"},{"properties":{"result":{"$ref":"#/components/schemas/development_mode"}}}]},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Get Development Mode setting response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single"},{"properties":{"result":{"$ref":"#/components/schemas/development_mode"}}}]}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"patch":{"tags":["Zone Settings"],"summary":"Change Development Mode setting","description":"Development Mode temporarily allows you to enter development mode for your websites if you need to make changes to your site. This will bypass Cloudflare's accelerated cache and slow down your site, but is useful if you are making changes to cacheable content (like images, css, or JavaScript) and would like to see those changes right away. Once entered, development mode will last for 3 hours and then automatically toggle off.","operationId":"zone-settings-change-development-mode-setting","parameters":[{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["value"],"properties":{"value":{"$ref":"#/components/schemas/development_mode_value"}}}}}},"responses":{"4xx":{"description":"Change Development Mode setting response failure","content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single"},{"properties":{"result":{"$ref":"#/components/schemas/development_mode"}}}]},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Change Development Mode setting response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single"},{"properties":{"result":{"$ref":"#/components/schemas/development_mode"}}}]}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/zones/{zone_identifier}/settings/early_hints":{"get":{"tags":["Zone Settings"],"summary":"Get Early Hints setting","description":"When enabled, Cloudflare will attempt to speed up overall page loads by serving `103` responses with `Link` headers from the final response. Refer to [Early Hints](https://developers.cloudflare.com/cache/about/early-hints) for more information.","operationId":"zone-settings-get-early-hints-setting","parameters":[{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Get Early Hints setting response failure","content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single"},{"properties":{"result":{"$ref":"#/components/schemas/early_hints"}}}]},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Get Early Hints setting response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single"},{"properties":{"result":{"$ref":"#/components/schemas/early_hints"}}}]}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"patch":{"tags":["Zone Settings"],"summary":"Change Early Hints setting","description":"When enabled, Cloudflare will attempt to speed up overall page loads by serving `103` responses with `Link` headers from the final response. Refer to [Early Hints](https://developers.cloudflare.com/cache/about/early-hints) for more information.","operationId":"zone-settings-change-early-hints-setting","parameters":[{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["value"],"properties":{"value":{"$ref":"#/components/schemas/early_hints_value"}}}}}},"responses":{"4xx":{"description":"Change Early Hints setting response failure","content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single"},{"properties":{"result":{"$ref":"#/components/schemas/early_hints"}}}]},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Change Early Hints setting response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single"},{"properties":{"result":{"$ref":"#/components/schemas/early_hints"}}}]}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/zones/{zone_identifier}/settings/email_obfuscation":{"get":{"tags":["Zone Settings"],"summary":"Get Email Obfuscation setting","description":"Encrypt email adresses on your web page from bots, while keeping them visible to humans. (https://support.cloudflare.com/hc/en-us/articles/200170016).","operationId":"zone-settings-get-email-obfuscation-setting","parameters":[{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Get Email Obfuscation setting response failure","content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single"},{"properties":{"result":{"$ref":"#/components/schemas/email_obfuscation"}}}]},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Get Email Obfuscation setting response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single"},{"properties":{"result":{"$ref":"#/components/schemas/email_obfuscation"}}}]}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"patch":{"tags":["Zone Settings"],"summary":"Change Email Obfuscation setting","description":"Encrypt email adresses on your web page from bots, while keeping them visible to humans. (https://support.cloudflare.com/hc/en-us/articles/200170016).","operationId":"zone-settings-change-email-obfuscation-setting","parameters":[{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["value"],"properties":{"value":{"$ref":"#/components/schemas/email_obfuscation_value"}}}}}},"responses":{"4xx":{"description":"Change Email Obfuscation setting response failure","content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single"},{"properties":{"result":{"$ref":"#/components/schemas/email_obfuscation"}}}]},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Change Email Obfuscation setting response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single"},{"properties":{"result":{"$ref":"#/components/schemas/email_obfuscation"}}}]}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/zones/{zone_identifier}/settings/h2_prioritization":{"get":{"tags":["Zone Settings"],"summary":"Get HTTP/2 Edge Prioritization setting","description":"Gets HTTP/2 Edge Prioritization setting.","operationId":"zone-settings-get-http/-2-edge-prioritization-setting","parameters":[{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Get HTTP/2 Edge Prioritization setting response failure","content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single"},{"properties":{"result":{"$ref":"#/components/schemas/h2_prioritization"}}}]},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Get HTTP/2 Edge Prioritization setting response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single"},{"properties":{"result":{"$ref":"#/components/schemas/h2_prioritization"}}}]}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"patch":{"tags":["Zone Settings"],"summary":"Change HTTP/2 Edge Prioritization setting","description":"Changes HTTP/2 Edge Prioritization setting.","operationId":"zone-settings-change-http/-2-edge-prioritization-setting","parameters":[{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["value"],"properties":{"value":{"$ref":"#/components/schemas/h2_prioritization_value"}}}}}},"responses":{"4xx":{"description":"Change HTTP/2 Edge Prioritization setting response failure","content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single"},{"properties":{"result":{"$ref":"#/components/schemas/h2_prioritization"}}}]},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Change HTTP/2 Edge Prioritization setting response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single"},{"properties":{"result":{"$ref":"#/components/schemas/h2_prioritization"}}}]}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/zones/{zone_identifier}/settings/hotlink_protection":{"get":{"tags":["Zone Settings"],"summary":"Get Hotlink Protection setting","description":"When enabled, the Hotlink Protection option ensures that other sites cannot suck up your bandwidth by building pages that use images hosted on your site. Anytime a request for an image on your site hits Cloudflare, we check to ensure that it's not another site requesting them. People will still be able to download and view images from your page, but other sites won't be able to steal them for use on their own pages. (https://support.cloudflare.com/hc/en-us/articles/200170026).","operationId":"zone-settings-get-hotlink-protection-setting","parameters":[{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Get Hotlink Protection setting response failure","content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single"},{"properties":{"result":{"$ref":"#/components/schemas/hotlink_protection"}}}]},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Get Hotlink Protection setting response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single"},{"properties":{"result":{"$ref":"#/components/schemas/hotlink_protection"}}}]}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"patch":{"tags":["Zone Settings"],"summary":"Change Hotlink Protection setting","description":"When enabled, the Hotlink Protection option ensures that other sites cannot suck up your bandwidth by building pages that use images hosted on your site. Anytime a request for an image on your site hits Cloudflare, we check to ensure that it's not another site requesting them. People will still be able to download and view images from your page, but other sites won't be able to steal them for use on their own pages. (https://support.cloudflare.com/hc/en-us/articles/200170026).","operationId":"zone-settings-change-hotlink-protection-setting","parameters":[{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["value"],"properties":{"value":{"$ref":"#/components/schemas/hotlink_protection_value"}}}}}},"responses":{"4xx":{"description":"Change Hotlink Protection setting response failure","content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single"},{"properties":{"result":{"$ref":"#/components/schemas/hotlink_protection"}}}]},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Change Hotlink Protection setting response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single"},{"properties":{"result":{"$ref":"#/components/schemas/hotlink_protection"}}}]}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/zones/{zone_identifier}/settings/http2":{"get":{"tags":["Zone Settings"],"summary":"Get HTTP2 setting","description":"Value of the HTTP2 setting.","operationId":"zone-settings-get-h-t-t-p-2-setting","parameters":[{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Get HTTP2 setting response failure","content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single"},{"properties":{"result":{"$ref":"#/components/schemas/http2"}}}]},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Get HTTP2 setting response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single"},{"properties":{"result":{"$ref":"#/components/schemas/http2"}}}]}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"patch":{"tags":["Zone Settings"],"summary":"Change HTTP2 setting","description":"Value of the HTTP2 setting.","operationId":"zone-settings-change-h-t-t-p-2-setting","parameters":[{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["value"],"properties":{"value":{"$ref":"#/components/schemas/http2_value"}}}}}},"responses":{"4xx":{"description":"Change HTTP2 setting response failure","content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single"},{"properties":{"result":{"$ref":"#/components/schemas/http2"}}}]},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Change HTTP2 setting response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single"},{"properties":{"result":{"$ref":"#/components/schemas/http2"}}}]}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/zones/{zone_identifier}/settings/http3":{"get":{"tags":["Zone Settings"],"summary":"Get HTTP3 setting","description":"Value of the HTTP3 setting.","operationId":"zone-settings-get-h-t-t-p-3-setting","parameters":[{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Get HTTP3 setting response failure","content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single"},{"properties":{"result":{"$ref":"#/components/schemas/http3"}}}]},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Get HTTP3 setting response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single"},{"properties":{"result":{"$ref":"#/components/schemas/http3"}}}]}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"patch":{"tags":["Zone Settings"],"summary":"Change HTTP3 setting","description":"Value of the HTTP3 setting.","operationId":"zone-settings-change-h-t-t-p-3-setting","parameters":[{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["value"],"properties":{"value":{"$ref":"#/components/schemas/http3_value"}}}}}},"responses":{"4xx":{"description":"Change HTTP3 setting response failure","content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single"},{"properties":{"result":{"$ref":"#/components/schemas/http3"}}}]},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Change HTTP3 setting response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single"},{"properties":{"result":{"$ref":"#/components/schemas/http3"}}}]}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/zones/{zone_identifier}/settings/image_resizing":{"get":{"tags":["Zone Settings"],"summary":"Get Image Resizing setting","description":"Image Resizing provides on-demand resizing, conversion and optimisation for images served through Cloudflare's network. Refer to the [Image Resizing documentation](https://developers.cloudflare.com/images/) for more information.","operationId":"zone-settings-get-image-resizing-setting","parameters":[{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Get Image Resizing setting response failure","content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single"},{"properties":{"result":{"$ref":"#/components/schemas/image_resizing"}}}]},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Get Image Resizing setting response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single"},{"properties":{"result":{"$ref":"#/components/schemas/image_resizing"}}}]}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"patch":{"tags":["Zone Settings"],"summary":"Change Image Resizing setting","description":"Image Resizing provides on-demand resizing, conversion and optimisation for images served through Cloudflare's network. Refer to the [Image Resizing documentation](https://developers.cloudflare.com/images/) for more information.","operationId":"zone-settings-change-image-resizing-setting","parameters":[{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["value"],"properties":{"value":{"$ref":"#/components/schemas/image_resizing_value"}}}}}},"responses":{"4xx":{"description":"Change Image Resizing setting response failure","content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single"},{"properties":{"result":{"$ref":"#/components/schemas/image_resizing"}}}]},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Change Image Resizing setting response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single"},{"properties":{"result":{"$ref":"#/components/schemas/image_resizing"}}}]}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/zones/{zone_identifier}/settings/ip_geolocation":{"get":{"tags":["Zone Settings"],"summary":"Get IP Geolocation setting","description":"Enable IP Geolocation to have Cloudflare geolocate visitors to your website and pass the country code to you. (https://support.cloudflare.com/hc/en-us/articles/200168236).","operationId":"zone-settings-get-ip-geolocation-setting","parameters":[{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Get IP Geolocation setting response failure","content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single"},{"properties":{"result":{"$ref":"#/components/schemas/ip_geolocation"}}}]},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Get IP Geolocation setting response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single"},{"properties":{"result":{"$ref":"#/components/schemas/ip_geolocation"}}}]}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"patch":{"tags":["Zone Settings"],"summary":"Change IP Geolocation setting","description":"Enable IP Geolocation to have Cloudflare geolocate visitors to your website and pass the country code to you. (https://support.cloudflare.com/hc/en-us/articles/200168236).","operationId":"zone-settings-change-ip-geolocation-setting","parameters":[{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["value"],"properties":{"value":{"$ref":"#/components/schemas/ip_geolocation_value"}}}}}},"responses":{"4xx":{"description":"Change IP Geolocation setting response failure","content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single"},{"properties":{"result":{"$ref":"#/components/schemas/ip_geolocation"}}}]},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Change IP Geolocation setting response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single"},{"properties":{"result":{"$ref":"#/components/schemas/ip_geolocation"}}}]}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/zones/{zone_identifier}/settings/ipv6":{"get":{"tags":["Zone Settings"],"summary":"Get IPv6 setting","description":"Enable IPv6 on all subdomains that are Cloudflare enabled. (https://support.cloudflare.com/hc/en-us/articles/200168586).","operationId":"zone-settings-get-i-pv6-setting","parameters":[{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Get IPv6 setting response failure","content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single"},{"properties":{"result":{"$ref":"#/components/schemas/ipv6"}}}]},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Get IPv6 setting response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single"},{"properties":{"result":{"$ref":"#/components/schemas/ipv6"}}}]}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"patch":{"tags":["Zone Settings"],"summary":"Change IPv6 setting","description":"Enable IPv6 on all subdomains that are Cloudflare enabled. (https://support.cloudflare.com/hc/en-us/articles/200168586).","operationId":"zone-settings-change-i-pv6-setting","parameters":[{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["value"],"properties":{"value":{"$ref":"#/components/schemas/ipv6_value"}}}}}},"responses":{"4xx":{"description":"Change IPv6 setting response failure","content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single"},{"properties":{"result":{"$ref":"#/components/schemas/ipv6"}}}]},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Change IPv6 setting response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single"},{"properties":{"result":{"$ref":"#/components/schemas/ipv6"}}}]}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/zones/{zone_identifier}/settings/min_tls_version":{"get":{"tags":["Zone Settings"],"summary":"Get Minimum TLS Version setting","description":"Gets Minimum TLS Version setting.","operationId":"zone-settings-get-minimum-tls-version-setting","parameters":[{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Get Minimum TLS Version setting response failure","content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single"},{"properties":{"result":{"$ref":"#/components/schemas/min_tls_version"}}}]},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Get Minimum TLS Version setting response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single"},{"properties":{"result":{"$ref":"#/components/schemas/min_tls_version"}}}]}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"patch":{"tags":["Zone Settings"],"summary":"Change Minimum TLS Version setting","description":"Changes Minimum TLS Version setting.","operationId":"zone-settings-change-minimum-tls-version-setting","parameters":[{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["value"],"properties":{"value":{"$ref":"#/components/schemas/min_tls_version_value"}}}}}},"responses":{"4xx":{"description":"Change Minimum TLS Version setting response failure","content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single"},{"properties":{"result":{"$ref":"#/components/schemas/min_tls_version"}}}]},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Change Minimum TLS Version setting response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single"},{"properties":{"result":{"$ref":"#/components/schemas/min_tls_version"}}}]}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/zones/{zone_identifier}/settings/minify":{"get":{"tags":["Zone Settings"],"summary":"Get Minify setting","description":"Automatically minify certain assets for your website. Refer to [Using Cloudflare Auto Minify](https://support.cloudflare.com/hc/en-us/articles/200168196) for more information.","operationId":"zone-settings-get-minify-setting","parameters":[{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Get Minify setting response failure","content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single"},{"properties":{"result":{"$ref":"#/components/schemas/minify"}}}]},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Get Minify setting response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single"},{"properties":{"result":{"$ref":"#/components/schemas/minify"}}}]}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"patch":{"tags":["Zone Settings"],"summary":"Change Minify setting","description":"Automatically minify certain assets for your website. Refer to [Using Cloudflare Auto Minify](https://support.cloudflare.com/hc/en-us/articles/200168196) for more information.","operationId":"zone-settings-change-minify-setting","parameters":[{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["value"],"properties":{"value":{"$ref":"#/components/schemas/minify_value"}}}}}},"responses":{"4xx":{"description":"Change Minify setting response failure","content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single"},{"properties":{"result":{"$ref":"#/components/schemas/minify"}}}]},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Change Minify setting response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single"},{"properties":{"result":{"$ref":"#/components/schemas/minify"}}}]}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/zones/{zone_identifier}/settings/mirage":{"get":{"tags":["Zone Settings"],"summary":"Get Mirage setting","description":"Automatically optimize image loading for website visitors on mobile devices. Refer to [our blog post](http://blog.cloudflare.com/mirage2-solving-mobile-speed) for more information.","operationId":"zone-settings-get-mirage-setting","parameters":[{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Get Mirage setting response failure","content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single"},{"properties":{"result":{"$ref":"#/components/schemas/mirage"}}}]},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Get Mirage setting response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single"},{"properties":{"result":{"$ref":"#/components/schemas/mirage"}}}]}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"patch":{"tags":["Zone Settings"],"summary":"Change Mirage setting","description":"Automatically optimize image loading for website visitors on mobile devices. Refer to [our blog post](http://blog.cloudflare.com/mirage2-solving-mobile-speed) for more information.","operationId":"zone-settings-change-mirage-setting","parameters":[{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["value"],"properties":{"value":{"$ref":"#/components/schemas/mirage_value"}}}}}},"responses":{"4xx":{"description":"Change Mirage setting response failure","content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single"},{"properties":{"result":{"$ref":"#/components/schemas/mirage"}}}]},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Change Mirage setting response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single"},{"properties":{"result":{"$ref":"#/components/schemas/mirage"}}}]}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/zones/{zone_identifier}/settings/mobile_redirect":{"get":{"tags":["Zone Settings"],"summary":"Get Mobile Redirect setting","description":"Automatically redirect visitors on mobile devices to a mobile-optimized subdomain. Refer to [Understanding Cloudflare Mobile Redirect](https://support.cloudflare.com/hc/articles/200168336) for more information.","operationId":"zone-settings-get-mobile-redirect-setting","parameters":[{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Get Mobile Redirect setting response failure","content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single"},{"properties":{"result":{"$ref":"#/components/schemas/mobile_redirect"}}}]},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Get Mobile Redirect setting response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single"},{"properties":{"result":{"$ref":"#/components/schemas/mobile_redirect"}}}]}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"patch":{"tags":["Zone Settings"],"summary":"Change Mobile Redirect setting","description":"Automatically redirect visitors on mobile devices to a mobile-optimized subdomain. Refer to [Understanding Cloudflare Mobile Redirect](https://support.cloudflare.com/hc/articles/200168336) for more information.","operationId":"zone-settings-change-mobile-redirect-setting","parameters":[{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["value"],"properties":{"value":{"$ref":"#/components/schemas/mobile_redirect_value"}}}}}},"responses":{"4xx":{"description":"Change Mobile Redirect setting response failure","content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single"},{"properties":{"result":{"$ref":"#/components/schemas/mobile_redirect"}}}]},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Change Mobile Redirect setting response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single"},{"properties":{"result":{"$ref":"#/components/schemas/mobile_redirect"}}}]}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/zones/{zone_identifier}/settings/nel":{"get":{"tags":["Zone Settings"],"summary":"Get Network Error Logging setting","description":"Enable Network Error Logging reporting on your zone. (Beta) ","operationId":"zone-settings-get-network-error-logging-setting","parameters":[{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Get Network Error Logging setting response failure","content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single"},{"properties":{"result":{"$ref":"#/components/schemas/nel"}}}]},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Get Network Error Logging setting response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single"},{"properties":{"result":{"$ref":"#/components/schemas/nel"}}}]}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"patch":{"tags":["Zone Settings"],"summary":"Change Network Error Logging setting","description":"Enable Network Error Logging reporting on your zone. (Beta) ","operationId":"zone-settings-change-network-error-logging-setting","parameters":[{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["value"],"properties":{"value":{"$ref":"#/components/schemas/nel_value"}}}}}},"responses":{"4xx":{"description":"Change Network Error Logging setting response failure","content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single"},{"properties":{"result":{"$ref":"#/components/schemas/nel"}}}]},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Change Network Error Logging setting response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single"},{"properties":{"result":{"$ref":"#/components/schemas/nel"}}}]}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/zones/{zone_identifier}/settings/opportunistic_encryption":{"get":{"tags":["Zone Settings"],"summary":"Get Opportunistic Encryption setting","description":"Gets Opportunistic Encryption setting.","operationId":"zone-settings-get-opportunistic-encryption-setting","parameters":[{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Get Opportunistic Encryption setting response failure","content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single"},{"properties":{"result":{"$ref":"#/components/schemas/opportunistic_encryption"}}}]},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Get Opportunistic Encryption setting response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single"},{"properties":{"result":{"$ref":"#/components/schemas/opportunistic_encryption"}}}]}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"patch":{"tags":["Zone Settings"],"summary":"Change Opportunistic Encryption setting","description":"Changes Opportunistic Encryption setting.","operationId":"zone-settings-change-opportunistic-encryption-setting","parameters":[{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["value"],"properties":{"value":{"$ref":"#/components/schemas/opportunistic_encryption_value"}}}}}},"responses":{"4xx":{"description":"Change Opportunistic Encryption setting response failure","content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single"},{"properties":{"result":{"$ref":"#/components/schemas/opportunistic_encryption"}}}]},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Change Opportunistic Encryption setting response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single"},{"properties":{"result":{"$ref":"#/components/schemas/opportunistic_encryption"}}}]}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/zones/{zone_identifier}/settings/opportunistic_onion":{"get":{"tags":["Zone Settings"],"summary":"Get Opportunistic Onion setting","description":"Add an Alt-Svc header to all legitimate requests from Tor, allowing the connection to use our onion services instead of exit nodes.","operationId":"zone-settings-get-opportunistic-onion-setting","parameters":[{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Get Opportunistic Onion setting response failure","content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single"},{"properties":{"result":{"$ref":"#/components/schemas/opportunistic_onion"}}}]},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Get Opportunistic Onion setting response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single"},{"properties":{"result":{"$ref":"#/components/schemas/opportunistic_onion"}}}]}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"patch":{"tags":["Zone Settings"],"summary":"Change Opportunistic Onion setting","description":"Add an Alt-Svc header to all legitimate requests from Tor, allowing the connection to use our onion services instead of exit nodes.","operationId":"zone-settings-change-opportunistic-onion-setting","parameters":[{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["value"],"properties":{"value":{"$ref":"#/components/schemas/opportunistic_onion_value"}}}}}},"responses":{"4xx":{"description":"Change Opportunistic Onion setting response failure","content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single"},{"properties":{"result":{"$ref":"#/components/schemas/opportunistic_onion"}}}]},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Change Opportunistic Onion setting response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single"},{"properties":{"result":{"$ref":"#/components/schemas/opportunistic_onion"}}}]}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/zones/{zone_identifier}/settings/orange_to_orange":{"get":{"tags":["Zone Settings"],"summary":"Get Orange to Orange (O2O)","description":"Orange to Orange (O2O) allows zones on Cloudflare to CNAME to other zones also on Cloudflare.","operationId":"zone-settings-get-orange-to-orange-(-o-2-o)","parameters":[{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Get Orange to Orange (O2O) response failure","content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single"},{"properties":{"result":{"$ref":"#/components/schemas/orange_to_orange"}}}]},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Get Orange to Orange (O2O) response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single"},{"properties":{"result":{"$ref":"#/components/schemas/orange_to_orange"}}}]}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"patch":{"tags":["Zone Settings"],"summary":"Change Orange to Orange (O2O)","description":"Orange to Orange (O2O) allows zones on Cloudflare to CNAME to other zones also on Cloudflare.","operationId":"zone-settings-change-orange-to-orange-(-o-2-o)","parameters":[{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["value"],"properties":{"value":{"$ref":"#/components/schemas/orange_to_orange_value"}}}}}},"responses":{"4xx":{"description":"Change Orange to Orange (O2O) response failure","content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single"},{"properties":{"result":{"$ref":"#/components/schemas/orange_to_orange"}}}]},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Change Orange to Orange (O2O) response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single"},{"properties":{"result":{"$ref":"#/components/schemas/orange_to_orange"}}}]}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/zones/{zone_identifier}/settings/origin_error_page_pass_thru":{"get":{"tags":["Zone Settings"],"summary":"Get Enable Error Pages On setting","description":"Cloudflare will proxy customer error pages on any 502,504 errors on origin server instead of showing a default Cloudflare error page. This does not apply to 522 errors and is limited to Enterprise Zones.","operationId":"zone-settings-get-enable-error-pages-on-setting","parameters":[{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Get Enable Error Pages On setting response failure","content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single"},{"properties":{"result":{"$ref":"#/components/schemas/origin_error_page_pass_thru"}}}]},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Get Enable Error Pages On setting response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single"},{"properties":{"result":{"$ref":"#/components/schemas/origin_error_page_pass_thru"}}}]}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"patch":{"tags":["Zone Settings"],"summary":"Change Enable Error Pages On setting","description":"Cloudflare will proxy customer error pages on any 502,504 errors on origin server instead of showing a default Cloudflare error page. This does not apply to 522 errors and is limited to Enterprise Zones.","operationId":"zone-settings-change-enable-error-pages-on-setting","parameters":[{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["value"],"properties":{"value":{"$ref":"#/components/schemas/origin_error_page_pass_thru_value"}}}}}},"responses":{"4xx":{"description":"Change Enable Error Pages On setting response failure","content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single"},{"properties":{"result":{"$ref":"#/components/schemas/origin_error_page_pass_thru"}}}]},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Change Enable Error Pages On setting response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single"},{"properties":{"result":{"$ref":"#/components/schemas/origin_error_page_pass_thru"}}}]}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/zones/{zone_identifier}/settings/origin_max_http_version":{"get":{"tags":["Zone Settings"],"summary":"Get Origin Max HTTP version setting","description":"Value of the Origin Max HTTP version setting (Note that the default value for Enterprise is \"1\").","operationId":"zone-settings-get-origin-max-http-version-setting","parameters":[{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Get Origin Max HTTP version setting response failure","content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single"},{"$ref":"#/components/schemas/origin_max_http_version_response_value"}]},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Get Origin Max HTTP version setting response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single"},{"$ref":"#/components/schemas/origin_max_http_version_response_value"}]}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"patch":{"tags":["Zone Settings"],"summary":"Change Origin Max HTTP version setting","description":"The highest HTTP version Cloudflare will attempt to use with your origin. This setting allows Cloudflare to make HTTP/2 requests to your origin. (Refer to [Enable HTTP/2 to Origin](https://developers.cloudflare.com/cache/how-to/enable-http2-to-origin/), for more information.).","operationId":"zone-settings-change-origin-max-http-version-setting","parameters":[{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["value"],"properties":{"value":{"$ref":"#/components/schemas/origin_max_http_version_value"}}}}}},"responses":{"4xx":{"description":"Change Origin Max HTTP version setting response failure","content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single"},{"$ref":"#/components/schemas/origin_max_http_version_response_value"}]},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Change Origin Max HTTP version setting response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single"},{"$ref":"#/components/schemas/origin_max_http_version_response_value"}]}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/zones/{zone_identifier}/settings/polish":{"get":{"tags":["Zone Settings"],"summary":"Get Polish setting","description":"Removes metadata and compresses your images for faster page load times. Basic (Lossless): Reduce the size of PNG, JPEG, and GIF files - no impact on visual quality. Basic + JPEG (Lossy): Further reduce the size of JPEG files for faster image loading. Larger JPEGs are converted to progressive images, loading a lower-resolution image first and ending in a higher-resolution version. Not recommended for hi-res photography sites.","operationId":"zone-settings-get-polish-setting","parameters":[{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Get Polish setting response failure","content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single"},{"properties":{"result":{"$ref":"#/components/schemas/polish"}}}]},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Get Polish setting response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single"},{"properties":{"result":{"$ref":"#/components/schemas/polish"}}}]}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"patch":{"tags":["Zone Settings"],"summary":"Change Polish setting","description":"Removes metadata and compresses your images for faster page load times. Basic (Lossless): Reduce the size of PNG, JPEG, and GIF files - no impact on visual quality. Basic + JPEG (Lossy): Further reduce the size of JPEG files for faster image loading. Larger JPEGs are converted to progressive images, loading a lower-resolution image first and ending in a higher-resolution version. Not recommended for hi-res photography sites.","operationId":"zone-settings-change-polish-setting","parameters":[{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["value"],"properties":{"value":{"$ref":"#/components/schemas/polish_value"}}}}}},"responses":{"4xx":{"description":"Change Polish setting response failure","content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single"},{"properties":{"result":{"$ref":"#/components/schemas/polish"}}}]},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Change Polish setting response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single"},{"properties":{"result":{"$ref":"#/components/schemas/polish"}}}]}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/zones/{zone_identifier}/settings/prefetch_preload":{"get":{"tags":["Zone Settings"],"summary":"Get prefetch preload setting","description":"Cloudflare will prefetch any URLs that are included in the response headers. This is limited to Enterprise Zones.","operationId":"zone-settings-get-prefetch-preload-setting","parameters":[{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Get prefetch preload setting response failure","content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single"},{"properties":{"result":{"$ref":"#/components/schemas/prefetch_preload"}}}]},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Get prefetch preload setting response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single"},{"properties":{"result":{"$ref":"#/components/schemas/prefetch_preload"}}}]}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"patch":{"tags":["Zone Settings"],"summary":"Change prefetch preload setting","description":"Cloudflare will prefetch any URLs that are included in the response headers. This is limited to Enterprise Zones.","operationId":"zone-settings-change-prefetch-preload-setting","parameters":[{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["value"],"properties":{"value":{"$ref":"#/components/schemas/prefetch_preload_value"}}}}}},"responses":{"4xx":{"description":"Change prefetch preload setting response failure","content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single"},{"properties":{"result":{"$ref":"#/components/schemas/prefetch_preload"}}}]},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Change prefetch preload setting response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single"},{"properties":{"result":{"$ref":"#/components/schemas/prefetch_preload"}}}]}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/zones/{zone_identifier}/settings/privacy_pass":{"get":{"tags":["Zone Settings"],"summary":"Get Privacy Pass setting","description":"Privacy Pass is a browser extension developed by the Privacy Pass Team to improve the browsing experience for your visitors. Enabling Privacy Pass will reduce the number of CAPTCHAs shown to your visitors. (https://support.cloudflare.com/hc/en-us/articles/115001992652-Privacy-Pass).","operationId":"zone-settings-get-privacy-pass-setting","parameters":[{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Get Privacy Pass setting response failure","content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single"},{"properties":{"result":{"$ref":"#/components/schemas/privacy_pass"}}}]},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Get Privacy Pass setting response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single"},{"properties":{"result":{"$ref":"#/components/schemas/privacy_pass"}}}]}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"patch":{"tags":["Zone Settings"],"summary":"Change Privacy Pass setting","description":"Privacy Pass is a browser extension developed by the Privacy Pass Team to improve the browsing experience for your visitors. Enabling Privacy Pass will reduce the number of CAPTCHAs shown to your visitors. (https://support.cloudflare.com/hc/en-us/articles/115001992652-Privacy-Pass).","operationId":"zone-settings-change-privacy-pass-setting","parameters":[{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["value"],"properties":{"value":{"$ref":"#/components/schemas/privacy_pass_value"}}}}}},"responses":{"4xx":{"description":"Change Privacy Pass setting response failure","content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single"},{"properties":{"result":{"$ref":"#/components/schemas/privacy_pass"}}}]},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Change Privacy Pass setting response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single"},{"properties":{"result":{"$ref":"#/components/schemas/privacy_pass"}}}]}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/zones/{zone_identifier}/settings/proxy_read_timeout":{"get":{"tags":["Zone Settings"],"summary":"Get Proxy Read Timeout setting","description":"Maximum time between two read operations from origin.","operationId":"zone-settings-get-proxy-read-timeout-setting","parameters":[{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Get Proxy Read Timeout setting response failure","content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single"},{"properties":{"result":{"$ref":"#/components/schemas/proxy_read_timeout"}}}]},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Get Proxy Read Timeout setting response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single"},{"properties":{"result":{"$ref":"#/components/schemas/proxy_read_timeout"}}}]}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"patch":{"tags":["Zone Settings"],"summary":"Change Proxy Read Timeout setting","description":"Maximum time between two read operations from origin.","operationId":"zone-settings-change-proxy-read-timeout-setting","parameters":[{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["value"],"properties":{"value":{"$ref":"#/components/schemas/proxy_read_timeout_value"}}}}}},"responses":{"4xx":{"description":"Change Proxy Read Timeout setting response failure","content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single"},{"properties":{"result":{"$ref":"#/components/schemas/proxy_read_timeout"}}}]},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Change Proxy Read Timeout setting response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single"},{"properties":{"result":{"$ref":"#/components/schemas/proxy_read_timeout"}}}]}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/zones/{zone_identifier}/settings/pseudo_ipv4":{"get":{"tags":["Zone Settings"],"summary":"Get Pseudo IPv4 setting","description":"Value of the Pseudo IPv4 setting.","operationId":"zone-settings-get-pseudo-i-pv4-setting","parameters":[{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Get Pseudo IPv4 setting response failure","content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single"},{"properties":{"result":{"$ref":"#/components/schemas/pseudo_ipv4"}}}]},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Get Pseudo IPv4 setting response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single"},{"properties":{"result":{"$ref":"#/components/schemas/pseudo_ipv4"}}}]}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"patch":{"tags":["Zone Settings"],"summary":"Change Pseudo IPv4 setting","description":"Value of the Pseudo IPv4 setting.","operationId":"zone-settings-change-pseudo-i-pv4-setting","parameters":[{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["value"],"properties":{"value":{"$ref":"#/components/schemas/pseudo_ipv4_value"}}}}}},"responses":{"4xx":{"description":"Change Pseudo IPv4 setting response failure","content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single"},{"properties":{"result":{"$ref":"#/components/schemas/pseudo_ipv4"}}}]},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Change Pseudo IPv4 setting response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single"},{"properties":{"result":{"$ref":"#/components/schemas/pseudo_ipv4"}}}]}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/zones/{zone_identifier}/settings/response_buffering":{"get":{"tags":["Zone Settings"],"summary":"Get Response Buffering setting","description":"Enables or disables buffering of responses from the proxied server. Cloudflare may buffer the whole payload to deliver it at once to the client versus allowing it to be delivered in chunks. By default, the proxied server streams directly and is not buffered by Cloudflare. This is limited to Enterprise Zones.","operationId":"zone-settings-get-response-buffering-setting","parameters":[{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Get Response Buffering setting response failure","content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single"},{"properties":{"result":{"$ref":"#/components/schemas/response_buffering"}}}]},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Get Response Buffering setting response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single"},{"properties":{"result":{"$ref":"#/components/schemas/response_buffering"}}}]}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"patch":{"tags":["Zone Settings"],"summary":"Change Response Buffering setting","description":"Enables or disables buffering of responses from the proxied server. Cloudflare may buffer the whole payload to deliver it at once to the client versus allowing it to be delivered in chunks. By default, the proxied server streams directly and is not buffered by Cloudflare. This is limited to Enterprise Zones.","operationId":"zone-settings-change-response-buffering-setting","parameters":[{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["value"],"properties":{"value":{"$ref":"#/components/schemas/response_buffering_value"}}}}}},"responses":{"4xx":{"description":"Change Response Buffering setting response failure","content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single"},{"properties":{"result":{"$ref":"#/components/schemas/response_buffering"}}}]},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Change Response Buffering setting response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single"},{"properties":{"result":{"$ref":"#/components/schemas/response_buffering"}}}]}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/zones/{zone_identifier}/settings/rocket_loader":{"get":{"tags":["Zone Settings"],"summary":"Get Rocket Loader setting","description":"Rocket Loader is a general-purpose asynchronous JavaScript optimisation that prioritises rendering your content while loading your site's Javascript asynchronously. Turning on Rocket Loader will immediately improve a web page's rendering time sometimes measured as Time to First Paint (TTFP), and also the `window.onload` time (assuming there is JavaScript on the page). This can have a positive impact on your Google search ranking. When turned on, Rocket Loader will automatically defer the loading of all Javascript referenced in your HTML, with no configuration required. Refer to [Understanding Rocket Loader](https://support.cloudflare.com/hc/articles/200168056) for more information.","operationId":"zone-settings-get-rocket-loader-setting","parameters":[{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Get Rocket Loader setting response failure","content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single"},{"properties":{"result":{"$ref":"#/components/schemas/rocket_loader"}}}]},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Get Rocket Loader setting response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single"},{"properties":{"result":{"$ref":"#/components/schemas/rocket_loader"}}}]}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"patch":{"tags":["Zone Settings"],"summary":"Change Rocket Loader setting","description":"Rocket Loader is a general-purpose asynchronous JavaScript optimisation that prioritises rendering your content while loading your site's Javascript asynchronously. Turning on Rocket Loader will immediately improve a web page's rendering time sometimes measured as Time to First Paint (TTFP), and also the `window.onload` time (assuming there is JavaScript on the page). This can have a positive impact on your Google search ranking. When turned on, Rocket Loader will automatically defer the loading of all Javascript referenced in your HTML, with no configuration required. Refer to [Understanding Rocket Loader](https://support.cloudflare.com/hc/articles/200168056) for more information.","operationId":"zone-settings-change-rocket-loader-setting","parameters":[{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["value"],"properties":{"value":{"$ref":"#/components/schemas/rocket_loader_value"}}}}}},"responses":{"4xx":{"description":"Change Rocket Loader setting response failure","content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single"},{"properties":{"result":{"$ref":"#/components/schemas/rocket_loader"}}}]},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Change Rocket Loader setting response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single"},{"properties":{"result":{"$ref":"#/components/schemas/rocket_loader"}}}]}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/zones/{zone_identifier}/settings/security_header":{"get":{"tags":["Zone Settings"],"summary":"Get Security Header (HSTS) setting","description":"Cloudflare security header for a zone.","operationId":"zone-settings-get-security-header-(-hsts)-setting","parameters":[{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Get Security Header (HSTS) setting response failure","content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single"},{"properties":{"result":{"$ref":"#/components/schemas/security_header"}}}]},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Get Security Header (HSTS) setting response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single"},{"properties":{"result":{"$ref":"#/components/schemas/security_header"}}}]}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"patch":{"tags":["Zone Settings"],"summary":"Change Security Header (HSTS) setting","description":"Cloudflare security header for a zone.","operationId":"zone-settings-change-security-header-(-hsts)-setting","parameters":[{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["value"],"properties":{"value":{"$ref":"#/components/schemas/security_header_value"}}}}}},"responses":{"4xx":{"description":"Change Security Header (HSTS) setting response failure","content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single"},{"properties":{"result":{"$ref":"#/components/schemas/security_header"}}}]},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Change Security Header (HSTS) setting response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single"},{"properties":{"result":{"$ref":"#/components/schemas/security_header"}}}]}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/zones/{zone_identifier}/settings/security_level":{"get":{"tags":["Zone Settings"],"summary":"Get Security Level setting","description":"Choose the appropriate security profile for your website, which will automatically adjust each of the security settings. If you choose to customize an individual security setting, the profile will become Custom. (https://support.cloudflare.com/hc/en-us/articles/200170056).","operationId":"zone-settings-get-security-level-setting","parameters":[{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Get Security Level setting response failure","content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single"},{"properties":{"result":{"$ref":"#/components/schemas/security_level"}}}]},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Get Security Level setting response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single"},{"properties":{"result":{"$ref":"#/components/schemas/security_level"}}}]}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"patch":{"tags":["Zone Settings"],"summary":"Change Security Level setting","description":"Choose the appropriate security profile for your website, which will automatically adjust each of the security settings. If you choose to customize an individual security setting, the profile will become Custom. (https://support.cloudflare.com/hc/en-us/articles/200170056).","operationId":"zone-settings-change-security-level-setting","parameters":[{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["value"],"properties":{"value":{"$ref":"#/components/schemas/security_level_value"}}}}}},"responses":{"4xx":{"description":"Change Security Level setting response failure","content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single"},{"properties":{"result":{"$ref":"#/components/schemas/security_level"}}}]},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Change Security Level setting response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single"},{"properties":{"result":{"$ref":"#/components/schemas/security_level"}}}]}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/zones/{zone_identifier}/settings/server_side_exclude":{"get":{"tags":["Zone Settings"],"summary":"Get Server Side Exclude setting","description":"If there is sensitive content on your website that you want visible to real visitors, but that you want to hide from suspicious visitors, all you have to do is wrap the content with Cloudflare SSE tags. Wrap any content that you want to be excluded from suspicious visitors in the following SSE tags: <!--sse--><!--/sse-->. For example: <!--sse--> Bad visitors won't see my phone number, 555-555-5555 <!--/sse-->. Note: SSE only will work with HTML. If you have HTML minification enabled, you won't see the SSE tags in your HTML source when it's served through Cloudflare. SSE will still function in this case, as Cloudflare's HTML minification and SSE functionality occur on-the-fly as the resource moves through our network to the visitor's computer. (https://support.cloudflare.com/hc/en-us/articles/200170036).","operationId":"zone-settings-get-server-side-exclude-setting","parameters":[{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Get Server Side Exclude setting response failure","content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single"},{"properties":{"result":{"$ref":"#/components/schemas/server_side_exclude"}}}]},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Get Server Side Exclude setting response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single"},{"properties":{"result":{"$ref":"#/components/schemas/server_side_exclude"}}}]}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"patch":{"tags":["Zone Settings"],"summary":"Change Server Side Exclude setting","description":"If there is sensitive content on your website that you want visible to real visitors, but that you want to hide from suspicious visitors, all you have to do is wrap the content with Cloudflare SSE tags. Wrap any content that you want to be excluded from suspicious visitors in the following SSE tags: <!--sse--><!--/sse-->. For example: <!--sse--> Bad visitors won't see my phone number, 555-555-5555 <!--/sse-->. Note: SSE only will work with HTML. If you have HTML minification enabled, you won't see the SSE tags in your HTML source when it's served through Cloudflare. SSE will still function in this case, as Cloudflare's HTML minification and SSE functionality occur on-the-fly as the resource moves through our network to the visitor's computer. (https://support.cloudflare.com/hc/en-us/articles/200170036).","operationId":"zone-settings-change-server-side-exclude-setting","parameters":[{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["value"],"properties":{"value":{"$ref":"#/components/schemas/server_side_exclude_value"}}}}}},"responses":{"4xx":{"description":"Change Server Side Exclude setting response failure","content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single"},{"properties":{"result":{"$ref":"#/components/schemas/server_side_exclude"}}}]},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Change Server Side Exclude setting response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single"},{"properties":{"result":{"$ref":"#/components/schemas/server_side_exclude"}}}]}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/zones/{zone_identifier}/settings/sort_query_string_for_cache":{"get":{"tags":["Zone Settings"],"summary":"Get Enable Query String Sort setting","description":"Cloudflare will treat files with the same query strings as the same file in cache, regardless of the order of the query strings. This is limited to Enterprise Zones.","operationId":"zone-settings-get-enable-query-string-sort-setting","parameters":[{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Get Enable Query String Sort setting response failure","content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single"},{"properties":{"result":{"$ref":"#/components/schemas/sort_query_string_for_cache"}}}]},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Get Enable Query String Sort setting response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single"},{"properties":{"result":{"$ref":"#/components/schemas/sort_query_string_for_cache"}}}]}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"patch":{"tags":["Zone Settings"],"summary":"Change Enable Query String Sort setting","description":"Cloudflare will treat files with the same query strings as the same file in cache, regardless of the order of the query strings. This is limited to Enterprise Zones.","operationId":"zone-settings-change-enable-query-string-sort-setting","parameters":[{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["value"],"properties":{"value":{"$ref":"#/components/schemas/sort_query_string_for_cache_value"}}}}}},"responses":{"4xx":{"description":"Change Enable Query String Sort setting response failure","content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single"},{"properties":{"result":{"$ref":"#/components/schemas/sort_query_string_for_cache"}}}]},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Change Enable Query String Sort setting response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single"},{"properties":{"result":{"$ref":"#/components/schemas/sort_query_string_for_cache"}}}]}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/zones/{zone_identifier}/settings/ssl":{"get":{"tags":["Zone Settings"],"summary":"Get SSL setting","description":"SSL encrypts your visitor's connection and safeguards credit card numbers and other personal data to and from your website. SSL can take up to 5 minutes to fully activate. Requires Cloudflare active on your root domain or www domain. Off: no SSL between the visitor and Cloudflare, and no SSL between Cloudflare and your web server (all HTTP traffic). Flexible: SSL between the visitor and Cloudflare -- visitor sees HTTPS on your site, but no SSL between Cloudflare and your web server. You don't need to have an SSL cert on your web server, but your vistors will still see the site as being HTTPS enabled. Full: SSL between the visitor and Cloudflare -- visitor sees HTTPS on your site, and SSL between Cloudflare and your web server. You'll need to have your own SSL cert or self-signed cert at the very least. Full (Strict): SSL between the visitor and Cloudflare -- visitor sees HTTPS on your site, and SSL between Cloudflare and your web server. You'll need to have a valid SSL certificate installed on your web server. This certificate must be signed by a certificate authority, have an expiration date in the future, and respond for the request domain name (hostname). (https://support.cloudflare.com/hc/en-us/articles/200170416).","operationId":"zone-settings-get-ssl-setting","parameters":[{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Get SSL setting response failure","content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single"},{"properties":{"result":{"$ref":"#/components/schemas/ssl"}}}]},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Get SSL setting response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single"},{"properties":{"result":{"$ref":"#/components/schemas/ssl"}}}]}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"patch":{"tags":["Zone Settings"],"summary":"Change SSL setting","description":"SSL encrypts your visitor's connection and safeguards credit card numbers and other personal data to and from your website. SSL can take up to 5 minutes to fully activate. Requires Cloudflare active on your root domain or www domain. Off: no SSL between the visitor and Cloudflare, and no SSL between Cloudflare and your web server (all HTTP traffic). Flexible: SSL between the visitor and Cloudflare -- visitor sees HTTPS on your site, but no SSL between Cloudflare and your web server. You don't need to have an SSL cert on your web server, but your vistors will still see the site as being HTTPS enabled. Full: SSL between the visitor and Cloudflare -- visitor sees HTTPS on your site, and SSL between Cloudflare and your web server. You'll need to have your own SSL cert or self-signed cert at the very least. Full (Strict): SSL between the visitor and Cloudflare -- visitor sees HTTPS on your site, and SSL between Cloudflare and your web server. You'll need to have a valid SSL certificate installed on your web server. This certificate must be signed by a certificate authority, have an expiration date in the future, and respond for the request domain name (hostname). (https://support.cloudflare.com/hc/en-us/articles/200170416).","operationId":"zone-settings-change-ssl-setting","parameters":[{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["value"],"properties":{"value":{"$ref":"#/components/schemas/ssl_value"}}}}}},"responses":{"4xx":{"description":"Change SSL setting response failure","content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single"},{"properties":{"result":{"$ref":"#/components/schemas/ssl"}}}]},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Change SSL setting response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single"},{"properties":{"result":{"$ref":"#/components/schemas/ssl"}}}]}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/zones/{zone_identifier}/settings/ssl_recommender":{"get":{"tags":["Zone Settings"],"summary":"Get SSL/TLS Recommender enrollment","description":"Enrollment in the SSL/TLS Recommender service which tries to detect and recommend (by sending periodic emails) the most secure SSL/TLS setting your origin servers support.","operationId":"zone-settings-get-ssl/-tls-recommender-enrollment","parameters":[{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Get SSL/TLS Recommender enrollment response failure","content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single"},{"properties":{"result":{"$ref":"#/components/schemas/ssl_recommender"}}}]},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Get SSL/TLS Recommender enrollment response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single"},{"properties":{"result":{"$ref":"#/components/schemas/ssl_recommender"}}}]}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"patch":{"tags":["Zone Settings"],"summary":"Change SSL/TLS Recommender enrollment","description":"Enrollment in the SSL/TLS Recommender service which tries to detect and recommend (by sending periodic emails) the most secure SSL/TLS setting your origin servers support.","operationId":"zone-settings-change-ssl/-tls-recommender-enrollment","parameters":[{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["enabled"],"properties":{"enabled":{"$ref":"#/components/schemas/ssl_recommender_enabled"}}}}}},"responses":{"4xx":{"description":"Change SSL/TLS Recommender enrollment response failure","content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single"},{"properties":{"result":{"$ref":"#/components/schemas/ssl_recommender"}}}]},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Change SSL/TLS Recommender enrollment response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single"},{"properties":{"result":{"$ref":"#/components/schemas/ssl_recommender"}}}]}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/zones/{zone_identifier}/settings/tls_1_3":{"get":{"tags":["Zone Settings"],"summary":"Get TLS 1.3 setting enabled for a zone","description":"Gets TLS 1.3 setting enabled for a zone.","operationId":"zone-settings-get-tls-1.-3-setting-enabled-for-a-zone","parameters":[{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Get TLS 1.3 setting enabled for a zone response failure","content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single"},{"properties":{"result":{"$ref":"#/components/schemas/tls_1_3"}}}]},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Get TLS 1.3 setting enabled for a zone response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single"},{"properties":{"result":{"$ref":"#/components/schemas/tls_1_3"}}}]}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"patch":{"tags":["Zone Settings"],"summary":"Change TLS 1.3 setting","description":"Changes TLS 1.3 setting.","operationId":"zone-settings-change-tls-1.-3-setting","parameters":[{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["value"],"properties":{"value":{"$ref":"#/components/schemas/tls_1_3_value"}}}}}},"responses":{"4xx":{"description":"Change TLS 1.3 setting response failure","content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single"},{"properties":{"result":{"$ref":"#/components/schemas/tls_1_3"}}}]},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Change TLS 1.3 setting response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single"},{"properties":{"result":{"$ref":"#/components/schemas/tls_1_3"}}}]}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/zones/{zone_identifier}/settings/tls_client_auth":{"get":{"tags":["Zone Settings"],"summary":"Get TLS Client Auth setting","description":"TLS Client Auth requires Cloudflare to connect to your origin server using a client certificate (Enterprise Only).","operationId":"zone-settings-get-tls-client-auth-setting","parameters":[{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Get TLS Client Auth setting response failure","content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single"},{"properties":{"result":{"$ref":"#/components/schemas/tls_client_auth"}}}]},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Get TLS Client Auth setting response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single"},{"properties":{"result":{"$ref":"#/components/schemas/tls_client_auth"}}}]}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"patch":{"tags":["Zone Settings"],"summary":"Change TLS Client Auth setting","description":"TLS Client Auth requires Cloudflare to connect to your origin server using a client certificate (Enterprise Only).","operationId":"zone-settings-change-tls-client-auth-setting","parameters":[{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["value"],"properties":{"value":{"$ref":"#/components/schemas/tls_client_auth_value"}}}}}},"responses":{"4xx":{"description":"Change TLS Client Auth setting response failure","content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single"},{"properties":{"result":{"$ref":"#/components/schemas/tls_client_auth"}}}]},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Change TLS Client Auth setting response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single"},{"properties":{"result":{"$ref":"#/components/schemas/tls_client_auth"}}}]}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/zones/{zone_identifier}/settings/true_client_ip_header":{"get":{"tags":["Zone Settings"],"summary":"Get True Client IP setting","description":"Allows customer to continue to use True Client IP (Akamai feature) in the headers we send to the origin. This is limited to Enterprise Zones.","operationId":"zone-settings-get-true-client-ip-setting","parameters":[{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Get True Client IP setting response failure","content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single"},{"properties":{"result":{"$ref":"#/components/schemas/true_client_ip_header"}}}]},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Get True Client IP setting response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single"},{"properties":{"result":{"$ref":"#/components/schemas/true_client_ip_header"}}}]}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"patch":{"tags":["Zone Settings"],"summary":"Change True Client IP setting","description":"Allows customer to continue to use True Client IP (Akamai feature) in the headers we send to the origin. This is limited to Enterprise Zones.","operationId":"zone-settings-change-true-client-ip-setting","parameters":[{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["value"],"properties":{"value":{"$ref":"#/components/schemas/true_client_ip_header_value"}}}}}},"responses":{"4xx":{"description":"Change True Client IP setting response failure","content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single"},{"properties":{"result":{"$ref":"#/components/schemas/true_client_ip_header"}}}]},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Change True Client IP setting response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single"},{"properties":{"result":{"$ref":"#/components/schemas/true_client_ip_header"}}}]}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/zones/{zone_identifier}/settings/waf":{"get":{"tags":["Zone Settings"],"summary":"Get Web Application Firewall (WAF) setting","description":"The WAF examines HTTP requests to your website. It inspects both GET and POST requests and applies rules to help filter out illegitimate traffic from legitimate website visitors. The Cloudflare WAF inspects website addresses or URLs to detect anything out of the ordinary. If the Cloudflare WAF determines suspicious user behavior, then the WAF will 'challenge' the web visitor with a page that asks them to submit a CAPTCHA successfully to continue their action. If the challenge is failed, the action will be stopped. What this means is that Cloudflare's WAF will block any traffic identified as illegitimate before it reaches your origin web server. (https://support.cloudflare.com/hc/en-us/articles/200172016).","operationId":"zone-settings-get-web-application-firewall-(-waf)-setting","parameters":[{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Get Web Application Firewall (WAF) setting response failure","content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single"},{"properties":{"result":{"$ref":"#/components/schemas/waf"}}}]},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Get Web Application Firewall (WAF) setting response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single"},{"properties":{"result":{"$ref":"#/components/schemas/waf"}}}]}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"patch":{"tags":["Zone Settings"],"summary":"Change Web Application Firewall (WAF) setting","description":"The WAF examines HTTP requests to your website. It inspects both GET and POST requests and applies rules to help filter out illegitimate traffic from legitimate website visitors. The Cloudflare WAF inspects website addresses or URLs to detect anything out of the ordinary. If the Cloudflare WAF determines suspicious user behavior, then the WAF will 'challenge' the web visitor with a page that asks them to submit a CAPTCHA successfully to continue their action. If the challenge is failed, the action will be stopped. What this means is that Cloudflare's WAF will block any traffic identified as illegitimate before it reaches your origin web server. (https://support.cloudflare.com/hc/en-us/articles/200172016).","operationId":"zone-settings-change-web-application-firewall-(-waf)-setting","parameters":[{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["value"],"properties":{"value":{"$ref":"#/components/schemas/waf_value"}}}}}},"responses":{"4xx":{"description":"Change Web Application Firewall (WAF) setting response failure","content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single"},{"properties":{"result":{"$ref":"#/components/schemas/waf"}}}]},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Change Web Application Firewall (WAF) setting response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single"},{"properties":{"result":{"$ref":"#/components/schemas/waf"}}}]}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/zones/{zone_identifier}/settings/webp":{"get":{"tags":["Zone Settings"],"summary":"Get WebP setting","description":"When the client requesting the image supports the WebP image codec, and WebP offers a performance advantage over the original image format, Cloudflare will serve a WebP version of the original image.","operationId":"zone-settings-get-web-p-setting","parameters":[{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Get WebP setting response failure","content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single"},{"properties":{"result":{"$ref":"#/components/schemas/webp"}}}]},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Get WebP setting response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single"},{"properties":{"result":{"$ref":"#/components/schemas/webp"}}}]}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"patch":{"tags":["Zone Settings"],"summary":"Change WebP setting","description":"When the client requesting the image supports the WebP image codec, and WebP offers a performance advantage over the original image format, Cloudflare will serve a WebP version of the original image.","operationId":"zone-settings-change-web-p-setting","parameters":[{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["value"],"properties":{"value":{"$ref":"#/components/schemas/webp_value"}}}}}},"responses":{"4xx":{"description":"Change WebP setting response failure","content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single"},{"properties":{"result":{"$ref":"#/components/schemas/webp"}}}]},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Change WebP setting response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single"},{"properties":{"result":{"$ref":"#/components/schemas/webp"}}}]}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/zones/{zone_identifier}/settings/websockets":{"get":{"tags":["Zone Settings"],"summary":"Get WebSockets setting","description":"Gets Websockets setting. For more information about Websockets, please refer to [Using Cloudflare with WebSockets](https://support.cloudflare.com/hc/en-us/articles/200169466-Using-Cloudflare-with-WebSockets).","operationId":"zone-settings-get-web-sockets-setting","parameters":[{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Get WebSockets setting response failure","content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single"},{"properties":{"result":{"$ref":"#/components/schemas/websockets"}}}]},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Get WebSockets setting response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single"},{"properties":{"result":{"$ref":"#/components/schemas/websockets"}}}]}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"patch":{"tags":["Zone Settings"],"summary":"Change WebSockets setting","description":"Changes Websockets setting. For more information about Websockets, please refer to [Using Cloudflare with WebSockets](https://support.cloudflare.com/hc/en-us/articles/200169466-Using-Cloudflare-with-WebSockets).","operationId":"zone-settings-change-web-sockets-setting","parameters":[{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["value"],"properties":{"value":{"$ref":"#/components/schemas/websockets_value"}}}}}},"responses":{"4xx":{"description":"Change WebSockets setting response failure","content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single"},{"properties":{"result":{"$ref":"#/components/schemas/websockets"}}}]},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Change WebSockets setting response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single"},{"properties":{"result":{"$ref":"#/components/schemas/websockets"}}}]}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/zones/{zone_identifier}/ssl/certificate_packs":{"get":{"tags":["Certificate Packs"],"summary":"List Certificate Packs","description":"For a given zone, list all active certificate packs.","operationId":"certificate-packs-list-certificate-packs","parameters":[{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"List Certificate Packs response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/certificate_pack_response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"List Certificate Packs response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/certificate_pack_response_collection"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"post":{"tags":["Certificate Packs"],"summary":"Order Certificate Pack","description":"For a given zone, order a certificate pack with a list of hostnames.","operationId":"certificate-packs-order-certificate-pack","parameters":[{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"hosts":{"$ref":"#/components/schemas/schemas-hosts"}}}}}},"responses":{"4xx":{"description":"Order Certificate Pack response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/certificate_pack_response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Order Certificate Pack response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/certificate_pack_response_single"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/zones/{zone_identifier}/ssl/certificate_packs/{identifier}":{"delete":{"tags":["Certificate Packs"],"summary":"Delete Advanced Certificate Manager Certificate Pack","description":"For a given zone, delete an advanced certificate pack.","operationId":"certificate-packs-delete-advanced-certificate-manager-certificate-pack","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/certificate-packs_components-schemas-identifier"}},{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{"4xx":{"description":"Delete Advanced Certificate Manager Certificate Pack response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/delete_advanced_certificate_pack_response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Delete Advanced Certificate Manager Certificate Pack response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/delete_advanced_certificate_pack_response_single"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"get":{"tags":["Certificate Packs"],"summary":"Get Certificate Pack","description":"For a given zone, get a certificate pack.","operationId":"certificate-packs-get-certificate-pack","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/certificate-packs_components-schemas-identifier"}},{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Get Certificate Pack response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/certificate_pack_response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Get Certificate Pack response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/certificate_pack_response_single"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"patch":{"tags":["Certificate Packs"],"summary":"Restart Validation for Advanced Certificate Manager Certificate Pack","description":"For a given zone, restart validation for an advanced certificate pack. This is only a validation operation for a Certificate Pack in a validation_timed_out status.","operationId":"certificate-packs-restart-validation-for-advanced-certificate-manager-certificate-pack","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/certificate-packs_components-schemas-identifier"}},{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{"4xx":{"description":"Restart Validation for Advanced Certificate Manager Certificate Pack response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/advanced_certificate_pack_response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Restart Validation for Advanced Certificate Manager Certificate Pack response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/advanced_certificate_pack_response_single"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/zones/{zone_identifier}/ssl/certificate_packs/order":{"post":{"tags":["Certificate Packs"],"summary":"Order Advanced Certificate Manager Certificate Pack","description":"For a given zone, order an advanced certificate pack.","operationId":"certificate-packs-order-advanced-certificate-manager-certificate-pack","parameters":[{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["type","hosts","validation_method","validity_days","certificate_authority"],"properties":{"certificate_authority":{"$ref":"#/components/schemas/certificate_authority"},"cloudflare_branding":{"$ref":"#/components/schemas/cloudflare_branding"},"hosts":{"$ref":"#/components/schemas/schemas-hosts"},"type":{"$ref":"#/components/schemas/advanced_type"},"validation_method":{"$ref":"#/components/schemas/validation_method"},"validity_days":{"$ref":"#/components/schemas/validity_days"}}}}}},"responses":{"4xx":{"description":"Order Advanced Certificate Manager Certificate Pack response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/advanced_certificate_pack_response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Order Advanced Certificate Manager Certificate Pack response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/advanced_certificate_pack_response_single"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/zones/{zone_identifier}/ssl/certificate_packs/quota":{"get":{"tags":["Certificate Packs"],"summary":"Get Certificate Pack Quotas","description":"For a given zone, list certificate pack quotas.","operationId":"certificate-packs-get-certificate-pack-quotas","parameters":[{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Get Certificate Pack Quotas response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/certificate_pack_quota_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Get Certificate Pack Quotas response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/certificate_pack_quota_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/zones/{zone_identifier}/ssl/recommendation":{"get":{"tags":["SSL/TLS Mode Recommendation"],"summary":"SSL/TLS Recommendation","description":"Retrieve the SSL/TLS Recommender's recommendation for a zone.","operationId":"ssl/-tls-mode-recommendation-ssl/-tls-recommendation","parameters":[{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"SSL/TLS Recommendation response failure","content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"properties":{"id":{"$ref":"#/components/schemas/schemas-id"},"modified_on":{"$ref":"#/components/schemas/timestamp"},"value":{"$ref":"#/components/schemas/components-schemas-value"}}}}}]},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"SSL/TLS Recommendation response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"properties":{"id":{"$ref":"#/components/schemas/schemas-id"},"modified_on":{"$ref":"#/components/schemas/timestamp"},"value":{"$ref":"#/components/schemas/components-schemas-value"}}}}}]}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/zones/{zone_identifier}/ssl/universal/settings":{"get":{"tags":["Universal SSL Settings for a Zone"],"summary":"Universal SSL Settings Details","description":"Get Universal SSL Settings for a Zone.","operationId":"universal-ssl-settings-for-a-zone-universal-ssl-settings-details","parameters":[{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Universal SSL Settings Details response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ssl_universal_settings_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Universal SSL Settings Details response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ssl_universal_settings_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"patch":{"tags":["Universal SSL Settings for a Zone"],"summary":"Edit Universal SSL Settings","description":"Patch Universal SSL Settings for a Zone.","operationId":"universal-ssl-settings-for-a-zone-edit-universal-ssl-settings","parameters":[{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/universal"}}}},"responses":{"4xx":{"description":"Edit Universal SSL Settings response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ssl_universal_settings_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Edit Universal SSL Settings response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ssl_universal_settings_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/zones/{zone_identifier}/ssl/verification":{"get":{"tags":["SSL Verification"],"summary":"SSL Verification Details","description":"Get SSL Verification Info for a Zone.","operationId":"ssl-verification-ssl-verification-details","parameters":[{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"SSL Verification Details response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ssl_verification_response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"SSL Verification Details response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ssl_verification_response_collection"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/zones/{zone_identifier}/ssl/verification/{cert_pack_uuid}":{"patch":{"tags":["SSL Verification"],"summary":"Edit SSL Certificate Pack Validation Method","description":"Edit SSL validation method for a certificate pack. A PATCH request will request an immediate validation check on any certificate, and return the updated status. If a validation method is provided, the validation will be immediately attempted using that method.","operationId":"ssl-verification-edit-ssl-certificate-pack-validation-method","parameters":[{"name":"cert_pack_uuid","in":"path","required":true,"schema":{"$ref":"#/components/schemas/cert_pack_uuid"}},{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/components-schemas-validation_method"}}}},"responses":{"4xx":{"description":"Edit SSL Certificate Pack Validation Method response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ssl_validation_method_response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Edit SSL Certificate Pack Validation Method response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ssl_validation_method_response_collection"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/zones/{zone_identifier}/waiting_rooms":{"get":{"tags":["Waiting Room"],"summary":"List waiting rooms","description":"Lists waiting rooms.","operationId":"waiting-room-list-waiting-rooms","parameters":[{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"List waiting rooms response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/waitingroom_components-schemas-response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"List waiting rooms response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/waitingroom_components-schemas-response_collection"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"post":{"tags":["Waiting Room"],"summary":"Create waiting room","description":"Creates a new waiting room.","operationId":"waiting-room-create-waiting-room","parameters":[{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/query_waitingroom"}}}},"responses":{"4xx":{"description":"Create waiting room response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/waitingroom_components-schemas-single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Create waiting room response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/waitingroom_components-schemas-single_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/zones/{zone_identifier}/waiting_rooms/{waiting_room_id}":{"delete":{"tags":["Waiting Room"],"summary":"Delete waiting room","description":"Deletes a waiting room.","operationId":"waiting-room-delete-waiting-room","parameters":[{"name":"waiting_room_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/waiting_room_id"}},{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{"4xx":{"description":"Delete waiting room response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/waiting_room_id_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Delete waiting room response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/waiting_room_id_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"get":{"tags":["Waiting Room"],"summary":"Waiting room details","description":"Fetches a single configured waiting room.","operationId":"waiting-room-waiting-room-details","parameters":[{"name":"waiting_room_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/waiting_room_id"}},{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Waiting room details response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/waitingroom_components-schemas-single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Waiting room details response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/waitingroom_components-schemas-single_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"patch":{"tags":["Waiting Room"],"summary":"Patch waiting room","description":"Patches a configured waiting room.","operationId":"waiting-room-patch-waiting-room","parameters":[{"name":"waiting_room_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/waiting_room_id"}},{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/query_waitingroom"}}}},"responses":{"4xx":{"description":"Patch waiting room response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/waitingroom_components-schemas-single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Patch waiting room response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/waitingroom_components-schemas-single_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"put":{"tags":["Waiting Room"],"summary":"Update waiting room","description":"Updates a configured waiting room.","operationId":"waiting-room-update-waiting-room","parameters":[{"name":"waiting_room_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/waiting_room_id"}},{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/query_waitingroom"}}}},"responses":{"4xx":{"description":"Update waiting room response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/waitingroom_components-schemas-single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Update waiting room response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/waitingroom_components-schemas-single_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/zones/{zone_identifier}/waiting_rooms/{waiting_room_id}/events":{"get":{"tags":["Waiting Room"],"summary":"List events","description":"Lists events for a waiting room.","operationId":"waiting-room-list-events","parameters":[{"name":"waiting_room_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/waiting_room_id"}},{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"List events response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/event_response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"List events response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/event_response_collection"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"post":{"tags":["Waiting Room"],"summary":"Create event","description":"Only available for the Waiting Room Advanced subscription. Creates an event for a waiting room. An event takes place during a specified period of time, temporarily changing the behavior of a waiting room. While the event is active, some of the properties in the event's configuration may either override or inherit from the waiting room's configuration. Note that events cannot overlap with each other, so only one event can be active at a time.","operationId":"waiting-room-create-event","parameters":[{"name":"waiting_room_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/waiting_room_id"}},{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/query_event"}}}},"responses":{"4xx":{"description":"Create event response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/event_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Create event response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/event_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/zones/{zone_identifier}/waiting_rooms/{waiting_room_id}/events/{event_id}":{"delete":{"tags":["Waiting Room"],"summary":"Delete event","description":"Deletes an event for a waiting room.","operationId":"waiting-room-delete-event","parameters":[{"name":"event_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/event_id"}},{"name":"waiting_room_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/waiting_room_id"}},{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{"4xx":{"description":"Delete event response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/event_id_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Delete event response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/event_id_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"get":{"tags":["Waiting Room"],"summary":"Event details","description":"Fetches a single configured event for a waiting room.","operationId":"waiting-room-event-details","parameters":[{"name":"event_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/event_id"}},{"name":"waiting_room_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/waiting_room_id"}},{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Event details response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/event_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Event details response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/event_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"patch":{"tags":["Waiting Room"],"summary":"Patch event","description":"Patches a configured event for a waiting room.","operationId":"waiting-room-patch-event","parameters":[{"name":"event_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/event_id"}},{"name":"waiting_room_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/waiting_room_id"}},{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/query_event"}}}},"responses":{"4xx":{"description":"Patch event response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/event_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Patch event response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/event_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"put":{"tags":["Waiting Room"],"summary":"Update event","description":"Updates a configured event for a waiting room.","operationId":"waiting-room-update-event","parameters":[{"name":"event_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/event_id"}},{"name":"waiting_room_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/waiting_room_id"}},{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/query_event"}}}},"responses":{"4xx":{"description":"Update event response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/event_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Update event response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/event_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/zones/{zone_identifier}/waiting_rooms/{waiting_room_id}/events/{event_id}/details":{"get":{"tags":["Waiting Room"],"summary":"Preview active event details","description":"Previews an event's configuration as if it was active. Inherited fields from the waiting room will be displayed with their current values.","operationId":"waiting-room-preview-active-event-details","parameters":[{"name":"event_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/event_id"}},{"name":"waiting_room_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/waiting_room_id"}},{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Preview active event details response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/event_details_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Preview active event details response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/event_details_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/zones/{zone_identifier}/waiting_rooms/{waiting_room_id}/rules":{"get":{"tags":["Waiting Room"],"summary":"List Waiting Room Rules","description":"Lists rules for a waiting room.","operationId":"waiting-room-list-waiting-room-rules","parameters":[{"name":"waiting_room_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/waiting_room_id"}},{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"List Waiting Room Rules response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/schemas-rules_response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"List Waiting Room Rules response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/schemas-rules_response_collection"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"post":{"tags":["Waiting Room"],"summary":"Create Waiting Room Rule","description":"Only available for the Waiting Room Advanced subscription. Creates a rule for a waiting room.","operationId":"waiting-room-create-waiting-room-rule","parameters":[{"name":"waiting_room_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/waiting_room_id"}},{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/create_rule"}}}},"responses":{"4xx":{"description":"Create Waiting Room Rule response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/schemas-rules_response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Create Waiting Room Rule response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/schemas-rules_response_collection"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"put":{"tags":["Waiting Room"],"summary":"Replace Waiting Room Rules","description":"Only available for the Waiting Room Advanced subscription. Replaces all rules for a waiting room.","operationId":"waiting-room-replace-waiting-room-rules","parameters":[{"name":"waiting_room_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/waiting_room_id"}},{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/update_rules"}}}},"responses":{"4xx":{"description":"Replace Waiting Room Rules response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/schemas-rules_response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Replace Waiting Room Rules response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/schemas-rules_response_collection"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/zones/{zone_identifier}/waiting_rooms/{waiting_room_id}/rules/{rule_id}":{"delete":{"tags":["Waiting Room"],"summary":"Delete Waiting Room Rule","description":"Deletes a rule for a waiting room.","operationId":"waiting-room-delete-waiting-room-rule","parameters":[{"name":"rule_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/rule_id"}},{"name":"waiting_room_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/waiting_room_id"}},{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{"4xx":{"description":"Delete Waiting Room Rule response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/schemas-rules_response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Delete Waiting Room Rule response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/schemas-rules_response_collection"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"patch":{"tags":["Waiting Room"],"summary":"Patch Waiting Room Rule","description":"Patches a rule for a waiting room.","operationId":"waiting-room-patch-waiting-room-rule","parameters":[{"name":"rule_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/rule_id"}},{"name":"waiting_room_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/waiting_room_id"}},{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/patch_rule"}}}},"responses":{"4xx":{"description":"Patch Waiting Room Rule response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/schemas-rules_response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Patch Waiting Room Rule response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/schemas-rules_response_collection"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/zones/{zone_identifier}/waiting_rooms/{waiting_room_id}/status":{"get":{"tags":["Waiting Room"],"summary":"Get waiting room status","description":"Fetches the status of a configured waiting room. Response fields include:\n1. `status`: String indicating the status of the waiting room. The possible status are:\n\t- **not_queueing** indicates that the configured thresholds have not been met and all users are going through to the origin.\n\t- **queueing** indicates that the thresholds have been met and some users are held in the waiting room.\n\t- **event_prequeueing** indicates that an event is active and is currently prequeueing users before it starts.\n2. `event_id`: String of the current event's `id` if an event is active, otherwise an empty string.\n3. `estimated_queued_users`: Integer of the estimated number of users currently waiting in the queue.\n4. `estimated_total_active_users`: Integer of the estimated number of users currently active on the origin.\n5. `max_estimated_time_minutes`: Integer of the maximum estimated time currently presented to the users.","operationId":"waiting-room-get-waiting-room-status","parameters":[{"name":"waiting_room_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/waiting_room_id"}},{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Get waiting room status response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/status_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Get waiting room status response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/status_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/zones/{zone_identifier}/waiting_rooms/preview":{"post":{"tags":["Waiting Room"],"summary":"Create a custom waiting room page preview","description":"Creates a waiting room page preview. Upload a custom waiting room page for preview. You will receive a preview URL in the form `http://waitingrooms.dev/preview/<uuid>`. You can use the following query parameters to change the state of the preview:\n1. `force_queue`: Boolean indicating if all users will be queued in the waiting room and no one will be let into the origin website (also known as queueAll).\n2. `queue_is_full`: Boolean indicating if the waiting room's queue is currently full and not accepting new users at the moment.\n3. `queueing_method`: The queueing method currently used by the waiting room.\n\t- **fifo** indicates a FIFO queue.\n\t- **random** indicates a Random queue.\n\t- **passthrough** indicates a Passthrough queue. Keep in mind that the waiting room page will only be displayed if `force_queue=true` or `event=prequeueing` — for other cases the request will pass through to the origin. For our preview, this will be a fake origin website returning \"Welcome\". \n\t- **reject** indicates a Reject queue.\n4. `event`: Used to preview a waiting room event.\n\t- **none** indicates no event is occurring.\n\t- **prequeueing** indicates that an event is prequeueing (between `prequeue_start_time` and `event_start_time`).\n\t- **started** indicates that an event has started (between `event_start_time` and `event_end_time`).\n5. `shuffle_at_event_start`: Boolean indicating if the event will shuffle users in the prequeue when it starts. This can only be set to **true** if an event is active (`event` is not **none**).\n\nFor example, you can make a request to `http://waitingrooms.dev/preview/<uuid>?force_queue=false&queue_is_full=false&queueing_method=random&event=started&shuffle_at_event_start=true`\n6. `waitTime`: Non-zero, positive integer indicating the estimated wait time in minutes. The default value is 10 minutes.\n\nFor example, you can make a request to `http://waitingrooms.dev/preview/<uuid>?waitTime=50` to configure the estimated wait time as 50 minutes.","operationId":"waiting-room-create-a-custom-waiting-room-page-preview","parameters":[{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/query_preview"}}}},"responses":{"4xx":{"description":"Create a custom waiting room page preview response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/schemas-preview_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Create a custom waiting room page preview response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/schemas-preview_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/zones/{zone_identifier}/web3/hostnames":{"get":{"tags":["Web3 Hostname"],"summary":"List Web3 Hostnames","operationId":"web3-hostname-list-web3-hostnames","parameters":[{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"List Web3 Hostnames response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/components-schemas-collection_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"List Web3 Hostnames response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/components-schemas-collection_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"post":{"tags":["Web3 Hostname"],"summary":"Create Web3 Hostname","operationId":"web3-hostname-create-web3-hostname","parameters":[{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/create_request"}}}},"responses":{"4xx":{"description":"Create Web3 Hostname response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/web3-hostname_components-schemas-single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Create Web3 Hostname response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/web3-hostname_components-schemas-single_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/zones/{zone_identifier}/web3/hostnames/{identifier}":{"delete":{"tags":["Web3 Hostname"],"summary":"Delete Web3 Hostname","operationId":"web3-hostname-delete-web3-hostname","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}},{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{"4xx":{"description":"Delete Web3 Hostname response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-response-single-id"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Delete Web3 Hostname response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-response-single-id"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"get":{"tags":["Web3 Hostname"],"summary":"Web3 Hostname Details","operationId":"web3-hostname-web3-hostname-details","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}},{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Web3 Hostname Details response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/web3-hostname_components-schemas-single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Web3 Hostname Details response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/web3-hostname_components-schemas-single_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"patch":{"tags":["Web3 Hostname"],"summary":"Edit Web3 Hostname","operationId":"web3-hostname-edit-web3-hostname","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}},{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/modify_request"}}}},"responses":{"4xx":{"description":"Edit Web3 Hostname response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/web3-hostname_components-schemas-single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Edit Web3 Hostname response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/web3-hostname_components-schemas-single_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/zones/{zone_identifier}/web3/hostnames/{identifier}/ipfs_universal_path/content_list":{"get":{"tags":["Web3 Hostname"],"summary":"IPFS Universal Path Gateway Content List Details","operationId":"web3-hostname-ipfs-universal-path-gateway-content-list-details","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}},{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"IPFS Universal Path Gateway Content List Details response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/content_list_details_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"IPFS Universal Path Gateway Content List Details response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/content_list_details_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"put":{"tags":["Web3 Hostname"],"summary":"Update IPFS Universal Path Gateway Content List","operationId":"web3-hostname-update-ipfs-universal-path-gateway-content-list","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}},{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/content_list_update_request"}}}},"responses":{"4xx":{"description":"Update IPFS Universal Path Gateway Content List response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/content_list_details_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Update IPFS Universal Path Gateway Content List response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/content_list_details_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/zones/{zone_identifier}/web3/hostnames/{identifier}/ipfs_universal_path/content_list/entries":{"get":{"tags":["Web3 Hostname"],"summary":"List IPFS Universal Path Gateway Content List Entries","operationId":"web3-hostname-list-ipfs-universal-path-gateway-content-list-entries","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}},{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"List IPFS Universal Path Gateway Content List Entries response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/content_list_entry_collection_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"List IPFS Universal Path Gateway Content List Entries response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/content_list_entry_collection_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"post":{"tags":["Web3 Hostname"],"summary":"Create IPFS Universal Path Gateway Content List Entry","operationId":"web3-hostname-create-ipfs-universal-path-gateway-content-list-entry","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}},{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/content_list_entry_create_request"}}}},"responses":{"4xx":{"description":"Create IPFS Universal Path Gateway Content List Entry response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/content_list_entry_single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Create IPFS Universal Path Gateway Content List Entry response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/content_list_entry_single_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/zones/{zone_identifier}/web3/hostnames/{identifier}/ipfs_universal_path/content_list/entries/{content_list_entry_identifier}":{"delete":{"tags":["Web3 Hostname"],"summary":"Delete IPFS Universal Path Gateway Content List Entry","operationId":"web3-hostname-delete-ipfs-universal-path-gateway-content-list-entry","parameters":[{"name":"content_list_entry_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}},{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}},{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{"4xx":{"description":"Delete IPFS Universal Path Gateway Content List Entry response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-response-single-id"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Delete IPFS Universal Path Gateway Content List Entry response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-response-single-id"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"get":{"tags":["Web3 Hostname"],"summary":"IPFS Universal Path Gateway Content List Entry Details","operationId":"web3-hostname-ipfs-universal-path-gateway-content-list-entry-details","parameters":[{"name":"content_list_entry_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}},{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}},{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"IPFS Universal Path Gateway Content List Entry Details response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/content_list_entry_single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"IPFS Universal Path Gateway Content List Entry Details response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/content_list_entry_single_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"put":{"tags":["Web3 Hostname"],"summary":"Edit IPFS Universal Path Gateway Content List Entry","operationId":"web3-hostname-edit-ipfs-universal-path-gateway-content-list-entry","parameters":[{"name":"content_list_entry_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}},{"name":"identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}},{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/content_list_entry_create_request"}}}},"responses":{"4xx":{"description":"Edit IPFS Universal Path Gateway Content List Entry response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/content_list_entry_single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Edit IPFS Universal Path Gateway Content List Entry response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/content_list_entry_single_response"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/zones/{zone_identifier}/workers/script":{"delete":{"tags":["Worker Script (Deprecated)"],"summary":"Delete Worker","description":"Delete your worker. This call has no response body on a successful delete.","operationId":"worker-script-(-deprecated)-delete-worker","parameters":[{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{"4xx":{"description":"Delete Worker response failure","content":{"application/json":{}}},"200":{"description":"Delete Worker response","content":{"application/json":{}}}},"deprecated":true,"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"get":{"tags":["Worker Script (Deprecated)"],"summary":"Download Worker","description":"Fetch raw script content for your worker. Note this is the original script content, not JSON encoded.","operationId":"worker-script-(-deprecated)-download-worker","parameters":[{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Download Worker response failure","content":{"undefined":{"schema":{"example":"addEventListener('fetch', event => { event.respondWith(fetch(event.request)) })"}}}},"200":{"description":"Download Worker response","content":{"undefined":{"schema":{"example":"addEventListener('fetch', event => { event.respondWith(fetch(event.request)) })"}}}}},"deprecated":true,"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"put":{"tags":["Worker Script (Deprecated)"],"summary":"Upload Worker","description":"Upload a worker, or a new version of a worker.","operationId":"worker-script-(-deprecated)-upload-worker","parameters":[{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/javascript":{"schema":{"example":"addEventListener('fetch', event => { event.respondWith(fetch(event.request)) })"}}}},"responses":{"4xx":{"description":"Upload Worker response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/script-response-single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Upload Worker response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/script-response-single"}}}}},"deprecated":true,"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/zones/{zone_identifier}/workers/script/bindings":{"get":{"tags":["Worker Binding (Deprecated)"],"summary":"List Bindings","description":"List the bindings for a Workers script.","operationId":"worker-binding-(-deprecated)-list-bindings","parameters":[{"name":"zone_identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"List Bindings response failure","content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/api-response-common"},{"type":"object","properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/binding"}}}}]},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"List Bindings response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-response-common"},{"type":"object","properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/binding"}}}}]}}}}},"deprecated":true,"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/zones/{zone}/spectrum/analytics/aggregate/current":{"get":{"tags":["Spectrum Aggregate Analytics"],"summary":"Get current aggregated analytics","description":"Retrieves analytics aggregated from the last minute of usage on Spectrum applications underneath a given zone.","operationId":"spectrum-aggregate-analytics-get-current-aggregated-analytics","parameters":[{"name":"zone","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Get current aggregated analytics response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/analytics-aggregate_components-schemas-response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Get current aggregated analytics response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/analytics-aggregate_components-schemas-response_collection"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/zones/{zone}/spectrum/analytics/events/bytime":{"get":{"tags":["Spectrum Analytics (By Time)"],"summary":"Get analytics by time","description":"Retrieves a list of aggregate metrics grouped by time interval.","operationId":"spectrum-analytics-(-by-time)-get-analytics-by-time","parameters":[{"name":"zone","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Get analytics by time response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Get analytics by time response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-response-single"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/zones/{zone}/spectrum/analytics/events/summary":{"get":{"tags":["Spectrum Analytics (Summary)"],"summary":"Get analytics summary","description":"Retrieves a list of summarised aggregate metrics over a given time period.","operationId":"spectrum-analytics-(-summary)-get-analytics-summary","parameters":[{"name":"zone","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Get analytics summary response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Get analytics summary response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-response-single"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/zones/{zone}/spectrum/apps":{"get":{"tags":["Spectrum Applications"],"summary":"List Spectrum applications","description":"Retrieves a list of currently existing Spectrum applications inside a zone.","operationId":"spectrum-applications-list-spectrum-applications","parameters":[{"name":"zone","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"List Spectrum applications response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/app_components-schemas-response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"List Spectrum applications response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/app_components-schemas-response_collection"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"post":{"tags":["Spectrum Applications"],"summary":"Create Spectrum application using a name for the origin","description":"Creates a new Spectrum application from a configuration using a name for the origin.","operationId":"spectrum-applications-create-spectrum-application-using-a-name-for-the-origin","parameters":[{"name":"zone","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["protocol","dns","origin_dns","origin_port"],"properties":{"argo_smart_routing":{"$ref":"#/components/schemas/argo_smart_routing"},"dns":{"$ref":"#/components/schemas/dns"},"edge_ips":{"$ref":"#/components/schemas/edge_ips"},"ip_firewall":{"$ref":"#/components/schemas/ip_firewall"},"origin_dns":{"$ref":"#/components/schemas/origin_dns"},"origin_port":{"$ref":"#/components/schemas/origin_port"},"protocol":{"$ref":"#/components/schemas/protocol"},"proxy_protocol":{"$ref":"#/components/schemas/proxy_protocol"},"tls":{"$ref":"#/components/schemas/tls"},"traffic_type":{"$ref":"#/components/schemas/traffic_type"}}}}}},"responses":{"4xx":{"description":"Create Spectrum application using a name for the origin response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/response_single_origin_dns"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Create Spectrum application using a name for the origin response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_single_origin_dns"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}},"/zones/{zone}/spectrum/apps/{app_id}":{"delete":{"tags":["Spectrum Applications"],"summary":"Delete Spectrum application","description":"Deletes a previously existing application.","operationId":"spectrum-applications-delete-spectrum-application","parameters":[{"name":"app_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/app_id"}},{"name":"zone","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{"4xx":{"description":"Delete Spectrum application response failure","content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"type":"object","properties":{"result":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/app_id"}}}}}]},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Delete Spectrum application response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"type":"object","properties":{"result":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/app_id"}}}}}]}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"get":{"tags":["Spectrum Applications"],"summary":"Get Spectrum application configuration","description":"Gets the application configuration of a specific application inside a zone.","operationId":"spectrum-applications-get-spectrum-application-configuration","parameters":[{"name":"app_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/app_id"}},{"name":"zone","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"4xx":{"description":"Get Spectrum application configuration response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/schemas-response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Get Spectrum application configuration response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/schemas-response_single"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]},"put":{"tags":["Spectrum Applications"],"summary":"Update Spectrum application configuration using a name for the origin","description":"Updates a previously existing application's configuration that uses a name for the origin.","operationId":"spectrum-applications-update-spectrum-application-configuration-using-a-name-for-the-origin","parameters":[{"name":"app_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/app_id"}},{"name":"zone","in":"path","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["protocol","dns","origin_dns","origin_port"],"properties":{"argo_smart_routing":{"$ref":"#/components/schemas/argo_smart_routing"},"dns":{"$ref":"#/components/schemas/dns"},"edge_ips":{"$ref":"#/components/schemas/edge_ips"},"ip_firewall":{"$ref":"#/components/schemas/ip_firewall"},"origin_dns":{"$ref":"#/components/schemas/origin_dns"},"origin_port":{"$ref":"#/components/schemas/origin_port"},"protocol":{"$ref":"#/components/schemas/protocol"},"proxy_protocol":{"$ref":"#/components/schemas/proxy_protocol"},"tls":{"$ref":"#/components/schemas/tls"},"traffic_type":{"$ref":"#/components/schemas/traffic_type"}}}}}},"responses":{"4xx":{"description":"Update Spectrum application configuration using a name for the origin response failure","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/response_single_origin_dns"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}}},"200":{"description":"Update Spectrum application configuration using a name for the origin response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_single_origin_dns"}}}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}]}}},"servers":[{"url":"https://api.cloudflare.com/client/v4","description":"Client API"}]}
/ accounts
/ accounts / {account_id} / gateway / categories
/ accounts / {account_id} / rulesets
/ accounts / {account_id} / rulesets / {ruleset_id}
/ accounts / {account_id} / rulesets / {ruleset_id} / rules
/ accounts / {account_id} / rulesets / {ruleset_id} / rules / {rule_id}
/ accounts / {account_id} / rulesets / {ruleset_id} / versions
/ accounts / {account_id} / rulesets / {ruleset_id} / versions / {ruleset_version}
/ accounts / {account_id} / rulesets / {ruleset_id} / versions / {ruleset_version} / by_tag / {rule_tag}
/ accounts / {account_id} / rulesets / phases / {ruleset_phase} / entrypoint
/ accounts / {account_id} / rulesets / phases / {ruleset_phase} / entrypoint / versions
/ accounts / {account_id} / rulesets / phases / {ruleset_phase} / entrypoint / versions / {ruleset_version}
/ accounts / {account_identifier} / addressing / address_maps
/ accounts / {account_identifier} / addressing / address_maps / {address_map_identifier}
/ accounts / {account_identifier} / addressing / address_maps / {address_map_identifier} / ips / {ip_address}
/ accounts / {account_identifier} / addressing / address_maps / {address_map_identifier} / zones / {zone_identifier}
/ accounts / {account_identifier} / addressing / loa_documents
/ accounts / {account_identifier} / addressing / loa_documents / {loa_document_identifier} / download
/ accounts / {account_identifier} / addressing / prefixes
/ accounts / {account_identifier} / addressing / prefixes / {prefix_identifier}
/ accounts / {account_identifier} / addressing / prefixes / {prefix_identifier} / bgp / status
/ accounts / {account_identifier} / addressing / prefixes / {prefix_identifier} / delegations
/ accounts / {account_identifier} / addressing / prefixes / {prefix_identifier} / delegations / {delegation_identifier}
/ accounts / {account_identifier} / audit_logs
/ accounts / {account_identifier} / billing / profile
/ accounts / {account_identifier} / brand-protection / submit
/ accounts / {account_identifier} / brand-protection / url-info
/ accounts / {account_identifier} / cfd_tunnel
/ accounts / {account_identifier} / cfd_tunnel / {tunnel_id}
/ accounts / {account_identifier} / cfd_tunnel / {tunnel_id} / configurations
/ accounts / {account_identifier} / cfd_tunnel / {tunnel_id} / connections
/ accounts / {account_identifier} / cfd_tunnel / {tunnel_id} / token
/ accounts / {account_identifier} / custom_pages
/ accounts / {account_identifier} / custom_pages / {identifier}
/ accounts / {account_identifier} / diagnostics / traceroute
/ accounts / {account_identifier} / dlp / patterns / validate
/ accounts / {account_identifier} / dlp / profiles
/ accounts / {account_identifier} / dlp / profiles / {profile_id}
/ accounts / {account_identifier} / dlp / profiles / custom
/ accounts / {account_identifier} / dlp / profiles / custom / {profile_id}
/ accounts / {account_identifier} / dlp / profiles / predefined / {profile_id}
/ accounts / {account_identifier} / dns_firewall
/ accounts / {account_identifier} / dns_firewall / {identifier}
/ accounts / {account_identifier} / dns_firewall / {identifier} / dns_analytics / report
/ accounts / {account_identifier} / dns_firewall / {identifier} / dns_analytics / report / bytime
/ accounts / {account_identifier} / email / routing / addresses
/ accounts / {account_identifier} / email / routing / addresses / {destination_address_identifier}
/ accounts / {account_identifier} / firewall / access_rules / rules
/ accounts / {account_identifier} / firewall / access_rules / rules / {identifier}
/ accounts / {account_identifier} / images / v1
/ accounts / {account_identifier} / images / v1 / {identifier}
/ accounts / {account_identifier} / images / v1 / {identifier} / blob
/ accounts / {account_identifier} / images / v1 / direct_upload
/ accounts / {account_identifier} / images / v1 / keys
/ accounts / {account_identifier} / images / v1 / stats
/ accounts / {account_identifier} / images / v1 / variants
/ accounts / {account_identifier} / images / v1 / variants / {identifier}
/ accounts / {account_identifier} / images / v2 / direct_upload
/ accounts / {account_identifier} / intel / asn / {asn}
/ accounts / {account_identifier} / intel / asn / {asn} / subnets
/ accounts / {account_identifier} / intel / dns
/ accounts / {account_identifier} / intel / domain
/ accounts / {account_identifier} / intel / domain-history
/ accounts / {account_identifier} / intel / domain / bulk
/ accounts / {account_identifier} / intel / ip
/ accounts / {account_identifier} / intel / ip-list
/ accounts / {account_identifier} / intel / miscategorization
/ accounts / {account_identifier} / intel / whois
/ accounts / {account_identifier} / load_balancers / monitors
/ accounts / {account_identifier} / load_balancers / monitors / {identifier}
/ accounts / {account_identifier} / load_balancers / monitors / {identifier} / preview
/ accounts / {account_identifier} / load_balancers / monitors / {identifier} / references
/ accounts / {account_identifier} / load_balancers / pools
/ accounts / {account_identifier} / load_balancers / pools / {identifier}
/ accounts / {account_identifier} / load_balancers / pools / {identifier} / health
/ accounts / {account_identifier} / load_balancers / pools / {identifier} / preview
/ accounts / {account_identifier} / load_balancers / pools / {identifier} / references
/ accounts / {account_identifier} / load_balancers / preview / {preview_id}
/ accounts / {account_identifier} / load_balancers / regions
/ accounts / {account_identifier} / load_balancers / regions / {region_code}
/ accounts / {account_identifier} / load_balancers / search
/ accounts / {account_identifier} / magic / cf_interconnects
/ accounts / {account_identifier} / magic / cf_interconnects / {tunnel_identifier}
/ accounts / {account_identifier} / magic / gre_tunnels
/ accounts / {account_identifier} / magic / gre_tunnels / {tunnel_identifier}
/ accounts / {account_identifier} / magic / ipsec_tunnels
/ accounts / {account_identifier} / magic / ipsec_tunnels / {tunnel_identifier}
/ accounts / {account_identifier} / magic / ipsec_tunnels / {tunnel_identifier} / psk_generate
/ accounts / {account_identifier} / magic / routes
/ accounts / {account_identifier} / magic / routes / {route_identifier}
/ accounts / {account_identifier} / members
/ accounts / {account_identifier} / members / {identifier}
/ accounts / {account_identifier} / mnm / config
/ accounts / {account_identifier} / mnm / config / full
/ accounts / {account_identifier} / mnm / rules
/ accounts / {account_identifier} / mnm / rules / {rule_identifier}
/ accounts / {account_identifier} / mnm / rules / {rule_identifier} / advertisement
/ accounts / {account_identifier} / pages / projects
/ accounts / {account_identifier} / pages / projects / {project_name}
/ accounts / {account_identifier} / pages / projects / {project_name} / deployments
/ accounts / {account_identifier} / pages / projects / {project_name} / deployments / {deployment_identifier}
/ accounts / {account_identifier} / pages / projects / {project_name} / deployments / {deployment_identifier} / history / logs
/ accounts / {account_identifier} / pages / projects / {project_name} / deployments / {deployment_identifier} / retry
/ accounts / {account_identifier} / pages / projects / {project_name} / deployments / {deployment_identifier} / rollback
/ accounts / {account_identifier} / pages / projects / {project_name} / domains
/ accounts / {account_identifier} / pages / projects / {project_name} / domains / {domain_name}
/ accounts / {account_identifier} / pcaps
/ accounts / {account_identifier} / pcaps / {identifier}
/ accounts / {account_identifier} / pcaps / {identifier} / download
/ accounts / {account_identifier} / pcaps / ownership
/ accounts / {account_identifier} / pcaps / ownership / {identifier}
/ accounts / {account_identifier} / pcaps / ownership / validate
/ accounts / {account_identifier} / r2 / buckets
/ accounts / {account_identifier} / r2 / buckets / {bucket_name}
/ accounts / {account_identifier} / railguns
/ accounts / {account_identifier} / railguns / {identifier}
/ accounts / {account_identifier} / railguns / {railgun_identifier} / connections
/ accounts / {account_identifier} / railguns / {railgun_identifier} / connections / {identifier}
/ accounts / {account_identifier} / registrar / domains
/ accounts / {account_identifier} / registrar / domains / {domain_name}
/ accounts / {account_identifier} / roles
/ accounts / {account_identifier} / roles / {identifier}
/ accounts / {account_identifier} / rules / lists
/ accounts / {account_identifier} / rules / lists / {list_id}
/ accounts / {account_identifier} / rules / lists / {list_id} / items
/ accounts / {account_identifier} / rules / lists / {list_id} / items / {item_id}
/ accounts / {account_identifier} / rules / lists / bulk_operations / {operation_id}
/ accounts / {account_identifier} / secondary_dns / acls
/ accounts / {account_identifier} / secondary_dns / acls / {identifier}
/ accounts / {account_identifier} / secondary_dns / peers
/ accounts / {account_identifier} / secondary_dns / peers / {identifier}
/ accounts / {account_identifier} / secondary_dns / tsigs
/ accounts / {account_identifier} / secondary_dns / tsigs / {identifier}
/ accounts / {account_identifier} / storage / analytics
/ accounts / {account_identifier} / storage / analytics / stored
/ accounts / {account_identifier} / storage / kv / namespaces
/ accounts / {account_identifier} / storage / kv / namespaces / {namespace_identifier}
/ accounts / {account_identifier} / storage / kv / namespaces / {namespace_identifier} / bulk
/ accounts / {account_identifier} / storage / kv / namespaces / {namespace_identifier} / keys
/ accounts / {account_identifier} / storage / kv / namespaces / {namespace_identifier} / metadata / {key_name}
/ accounts / {account_identifier} / storage / kv / namespaces / {namespace_identifier} / values / {key_name}
/ accounts / {account_identifier} / stream
/ accounts / {account_identifier} / stream / {identifier}
/ accounts / {account_identifier} / stream / {identifier} / embed
/ accounts / {account_identifier} / stream / {identifier} / token
/ accounts / {account_identifier} / stream / {video_identifier} / captions
/ accounts / {account_identifier} / stream / {video_identifier} / captions / {language}
/ accounts / {account_identifier} / stream / {video_identifier} / downloads
/ accounts / {account_identifier} / stream / clip
/ accounts / {account_identifier} / stream / copy
/ accounts / {account_identifier} / stream / direct_upload
/ accounts / {account_identifier} / stream / keys
/ accounts / {account_identifier} / stream / keys / {identifier}
/ accounts / {account_identifier} / stream / live_inputs
/ accounts / {account_identifier} / stream / live_inputs / {live_input_identifier}
/ accounts / {account_identifier} / stream / live_inputs / {live_input_identifier} / outputs
/ accounts / {account_identifier} / stream / live_inputs / {live_input_identifier} / outputs / {output_identifier}
/ accounts / {account_identifier} / stream / watermarks
/ accounts / {account_identifier} / stream / watermarks / {identifier}
/ accounts / {account_identifier} / stream / webhook
/ accounts / {account_identifier} / subscriptions
/ accounts / {account_identifier} / subscriptions / {subscription_identifier}
/ accounts / {account_identifier} / teamnet / routes
/ accounts / {account_identifier} / teamnet / routes / ip / {ip}
/ accounts / {account_identifier} / teamnet / routes / network / {ip_network_encoded}
/ accounts / {account_identifier} / teamnet / virtual_networks
/ accounts / {account_identifier} / teamnet / virtual_networks / {vnet_id}
/ accounts / {account_identifier} / tunnels
/ accounts / {account_identifier} / tunnels / {tunnel_id}
/ accounts / {account_identifier} / tunnels / {tunnel_id} / connections
/ accounts / {account_identifier} / virtual_dns
/ accounts / {account_identifier} / virtual_dns / {identifier}
/ accounts / {account_identifier} / virtual_dns / {identifier} / dns_analytics / report
/ accounts / {account_identifier} / virtual_dns / {identifier} / dns_analytics / report / bytime
/ accounts / {account_identifier} / workers / account-settings
/ accounts / {account_identifier} / workers / deployments / by-script / {script_identifier}
/ accounts / {account_identifier} / workers / deployments / by-script / {script_identifier} / detail / {deployment_identifier}
/ accounts / {account_identifier} / workers / domains
/ accounts / {account_identifier} / workers / domains / {domain_identifier}
/ accounts / {account_identifier} / workers / durable_objects / namespaces
/ accounts / {account_identifier} / workers / durable_objects / namespaces / {id} / objects
/ accounts / {account_identifier} / workers / queues
/ accounts / {account_identifier} / workers / queues / {name}
/ accounts / {account_identifier} / workers / queues / {name} / consumers
/ accounts / {account_identifier} / workers / queues / {name} / consumers / {consumer_name}
/ accounts / {account_identifier} / workers / scripts
/ accounts / {account_identifier} / workers / scripts / {script_name}
/ accounts / {account_identifier} / workers / scripts / {script_name} / schedules
/ accounts / {account_identifier} / workers / scripts / {script_name} / tails
/ accounts / {account_identifier} / workers / scripts / {script_name} / tails / {id}
/ accounts / {account_identifier} / workers / scripts / {script_name} / usage-model
/ accounts / {account_identifier} / workers / subdomain
/ accounts / {account_identifier1} / addressing / address_maps / {address_map_identifier} / accounts / {account_identifier}
/ accounts / {identifier}
/ accounts / {identifier} / access / apps
/ accounts / {identifier} / access / apps / {app_id}
/ accounts / {identifier} / access / apps / {app_id} / revoke_tokens
/ accounts / {identifier} / access / apps / {app_id} / user_policy_checks
/ accounts / {identifier} / access / apps / {uuid} / ca
/ accounts / {identifier} / access / apps / {uuid} / policies
/ accounts / {identifier} / access / apps / {uuid1} / policies / {uuid}
/ accounts / {identifier} / access / apps / ca
/ accounts / {identifier} / access / bookmarks
/ accounts / {identifier} / access / bookmarks / {uuid}
/ accounts / {identifier} / access / certificates
/ accounts / {identifier} / access / certificates / {uuid}
/ accounts / {identifier} / access / groups
/ accounts / {identifier} / access / groups / {uuid}
/ accounts / {identifier} / access / identity_providers
/ accounts / {identifier} / access / identity_providers / {uuid}
/ accounts / {identifier} / access / keys
/ accounts / {identifier} / access / keys / rotate
/ accounts / {identifier} / access / logs / access_requests
/ accounts / {identifier} / access / organizations
/ accounts / {identifier} / access / organizations / revoke_user
/ accounts / {identifier} / access / seats
/ accounts / {identifier} / access / service_tokens
/ accounts / {identifier} / access / service_tokens / {uuid}
/ accounts / {identifier} / access / service_tokens / {uuid} / refresh
/ accounts / {identifier} / access / service_tokens / {uuid} / rotate
/ accounts / {identifier} / access / users
/ accounts / {identifier} / access / users / {id} / failed_logins
/ accounts / {identifier} / alerting / v3 / available_alerts
/ accounts / {identifier} / alerting / v3 / destinations / eligible
/ accounts / {identifier} / alerting / v3 / destinations / pagerduty
/ accounts / {identifier} / alerting / v3 / destinations / webhooks
/ accounts / {identifier} / alerting / v3 / destinations / webhooks / {uuid}
/ accounts / {identifier} / alerting / v3 / history
/ accounts / {identifier} / alerting / v3 / policies
/ accounts / {identifier} / alerting / v3 / policies / {uuid}
/ accounts / {identifier} / custom_ns
/ accounts / {identifier} / custom_ns / {ns_name}
/ accounts / {identifier} / custom_ns / availability
/ accounts / {identifier} / custom_ns / verify
/ accounts / {identifier} / devices
/ accounts / {identifier} / devices / {uuid}
/ accounts / {identifier} / devices / {uuid} / override_codes
/ accounts / {identifier} / devices / policies
/ accounts / {identifier} / devices / policy
/ accounts / {identifier} / devices / policy / {uuid}
/ accounts / {identifier} / devices / policy / {uuid} / exclude
/ accounts / {identifier} / devices / policy / {uuid} / fallback_domains
/ accounts / {identifier} / devices / policy / {uuid} / include
/ accounts / {identifier} / devices / policy / exclude
/ accounts / {identifier} / devices / policy / fallback_domains
/ accounts / {identifier} / devices / policy / include
/ accounts / {identifier} / devices / posture
/ accounts / {identifier} / devices / posture / {uuid}
/ accounts / {identifier} / devices / posture / integration
/ accounts / {identifier} / devices / posture / integration / {uuid}
/ accounts / {identifier} / devices / revoke
/ accounts / {identifier} / devices / settings
/ accounts / {identifier} / devices / unrevoke
/ accounts / {identifier} / gateway
/ accounts / {identifier} / gateway / app_types
/ accounts / {identifier} / gateway / configuration
/ accounts / {identifier} / gateway / lists
/ accounts / {identifier} / gateway / lists / {uuid}
/ accounts / {identifier} / gateway / lists / {uuid} / items
/ accounts / {identifier} / gateway / locations
/ accounts / {identifier} / gateway / locations / {uuid}
/ accounts / {identifier} / gateway / logging
/ accounts / {identifier} / gateway / proxy_endpoints
/ accounts / {identifier} / gateway / proxy_endpoints / {uuid}
/ accounts / {identifier} / gateway / rules
/ accounts / {identifier} / gateway / rules / {uuid}
/ certificates
/ certificates / {identifier}
/ ips
/ memberships
/ memberships / {identifier}
/ organizations / {identifier}
/ organizations / {organization_identifier} / audit_logs
/ organizations / {organization_identifier} / invites
/ organizations / {organization_identifier} / invites / {identifier}
/ organizations / {organization_identifier} / members
/ organizations / {organization_identifier} / members / {identifier}
/ organizations / {organization_identifier} / railguns
/ organizations / {organization_identifier} / railguns / {identifier}
/ organizations / {organization_identifier} / railguns / {identifier} / zones
/ organizations / {organization_identifier} / roles
/ organizations / {organization_identifier} / roles / {identifier}
/ radar / annotations / outages
/ radar / annotations / outages / locations
/ radar / attacks / layer3 / summary
/ radar / attacks / layer3 / timeseries
/ radar / attacks / layer3 / timeseries_groups
/ radar / attacks / layer7 / summary
/ radar / attacks / layer7 / timeseries
/ radar / attacks / layer7 / timeseries_groups
/ radar / attacks / layer7 / top / ases / origin
/ radar / attacks / layer7 / top / attacks
/ radar / attacks / layer7 / top / locations / origin
/ radar / attacks / layer7 / top / locations / target
/ radar / bgp / leaks / events
/ radar / bgp / timeseries
/ radar / bgp / top / ases
/ radar / bgp / top / prefixes
/ radar / datasets
/ radar / datasets / {alias}
/ radar / datasets / download
/ radar / dns / top / ases
/ radar / dns / top / locations
/ radar / entities / asns
/ radar / entities / asns / {asn}
/ radar / entities / asns / ip
/ radar / entities / locations
/ radar / entities / locations / {location}
/ radar / http / summary / bot_class
/ radar / http / summary / device_type
/ radar / http / summary / http_protocol
/ radar / http / summary / http_version
/ radar / http / summary / ip_version
/ radar / http / summary / tls_version
/ radar / http / timeseries / bot_class
/ radar / http / timeseries / browser
/ radar / http / timeseries / browser_family
/ radar / http / timeseries / device_type
/ radar / http / timeseries / http_protocol
/ radar / http / timeseries / http_version
/ radar / http / timeseries / ip_version
/ radar / http / timeseries / tls_version
/ radar / http / top / ases
/ radar / http / top / ases / bot_class / {bot_class}
/ radar / http / top / ases / device_type / {device_type}
/ radar / http / top / ases / http_protocol / {http_protocol}
/ radar / http / top / ases / http_version / {http_version}
/ radar / http / top / ases / ip_version / {ip_version}
/ radar / http / top / ases / tls_version / {tls_version}
/ radar / http / top / browser_families
/ radar / http / top / browsers
/ radar / http / top / locations
/ radar / http / top / locations / bot_class / {bot_class}
/ radar / http / top / locations / device_type / {device_type}
/ radar / http / top / locations / http_protocol / {http_protocol}
/ radar / http / top / locations / http_version / {http_version}
/ radar / http / top / locations / ip_version / {ip_version}
/ radar / http / top / locations / tls_version / {tls_version}
/ radar / netflows / timeseries
/ radar / netflows / top / ases
/ radar / netflows / top / locations
/ radar / ranking / timeseries
/ radar / ranking / top
/ radar / search / global
/ radar / specialevents
/ radar / specialevents / {eventAlias}
/ radar / specialevents / {eventAlias} / {categoryAlias}
/ radar / verified_bots / top / bots
/ radar / verified_bots / top / categories
/ railguns
/ railguns / {identifier}
/ railguns / {identifier} / zones
/ user
/ user / audit_logs
/ user / billing / history
/ user / billing / profile
/ user / firewall / access_rules / rules
/ user / firewall / access_rules / rules / {identifier}
/ user / invites
/ user / invites / {identifier}
/ user / load_balancers / monitors
/ user / load_balancers / monitors / {identifier}
/ user / load_balancers / monitors / {identifier} / preview
/ user / load_balancers / monitors / {identifier} / references
/ user / load_balancers / pools
/ user / load_balancers / pools / {identifier}
/ user / load_balancers / pools / {identifier} / health
/ user / load_balancers / pools / {identifier} / preview
/ user / load_balancers / pools / {identifier} / references
/ user / load_balancers / preview / {preview_id}
/ user / load_balancing_analytics / events
/ user / organizations
/ user / organizations / {identifier}
/ user / subscriptions
/ user / subscriptions / {identifier}
/ user / tokens
/ user / tokens / {identifier}
/ user / tokens / {identifier} / value
/ user / tokens / permission_groups
/ user / tokens / verify
/ zones
/ zones / {identifier}
/ zones / {identifier} / access / apps
/ zones / {identifier} / access / apps / {app_id}
/ zones / {identifier} / access / apps / {app_id} / revoke_tokens
/ zones / {identifier} / access / apps / {app_id} / user_policy_checks
/ zones / {identifier} / access / apps / {uuid} / ca
/ zones / {identifier} / access / apps / {uuid} / policies
/ zones / {identifier} / access / apps / {uuid1} / policies / {uuid}
/ zones / {identifier} / access / apps / ca
/ zones / {identifier} / access / certificates
/ zones / {identifier} / access / certificates / {uuid}
/ zones / {identifier} / access / groups
/ zones / {identifier} / access / groups / {uuid}
/ zones / {identifier} / access / identity_providers
/ zones / {identifier} / access / identity_providers / {uuid}
/ zones / {identifier} / access / organizations
/ zones / {identifier} / access / organizations / revoke_user
/ zones / {identifier} / access / service_tokens
/ zones / {identifier} / access / service_tokens / {uuid}
/ zones / {identifier} / activation_check
/ zones / {identifier} / dns_analytics / report
/ zones / {identifier} / dns_analytics / report / bytime
/ zones / {identifier} / load_balancers
/ zones / {identifier} / purge_cache
/ zones / {identifier} / secondary_dns / force_axfr
/ zones / {identifier} / secondary_dns / incoming
/ zones / {identifier} / secondary_dns / outgoing
/ zones / {identifier} / secondary_dns / outgoing / disable
/ zones / {identifier} / secondary_dns / outgoing / enable
/ zones / {identifier} / secondary_dns / outgoing / force_notify
/ zones / {identifier} / secondary_dns / outgoing / status
/ zones / {identifier} / ssl / analyze
/ zones / {identifier} / subscription
/ zones / {identifier1} / load_balancers / {identifier}
/ zones / {zone_id} / activation_check
/ zones / {zone_id} / api_gateway / configuration
/ zones / {zone_id} / api_gateway / discovery
/ zones / {zone_id} / api_gateway / operations
/ zones / {zone_id} / api_gateway / operations / {operation_id}
/ zones / {zone_id} / api_gateway / schemas
/ zones / {zone_id} / firewall / access_rules / rules
/ zones / {zone_id} / firewall / access_rules / rules / {identifier}
/ zones / {zone_id} / firewall / waf / packages / {package_id} / rules
/ zones / {zone_id} / firewall / waf / packages / {package_id} / rules / {identifier}
/ zones / {zone_id} / managed_headers
/ zones / {zone_id} / page_shield
/ zones / {zone_id} / page_shield / connections
/ zones / {zone_id} / page_shield / connections / {id}
/ zones / {zone_id} / page_shield / scripts
/ zones / {zone_id} / page_shield / scripts / {id}
/ zones / {zone_id} / rulesets
/ zones / {zone_id} / rulesets / {ruleset_id}
/ zones / {zone_id} / rulesets / {ruleset_id} / rules
/ zones / {zone_id} / rulesets / {ruleset_id} / rules / {rule_id}
/ zones / {zone_id} / rulesets / {ruleset_id} / versions
/ zones / {zone_id} / rulesets / {ruleset_id} / versions / {ruleset_version}
/ zones / {zone_id} / rulesets / phases / {phase} / entrypoint
/ zones / {zone_id} / rulesets / phases / {ruleset_phase} / entrypoint
/ zones / {zone_id} / rulesets / phases / {ruleset_phase} / entrypoint / versions
/ zones / {zone_id} / rulesets / phases / {ruleset_phase} / entrypoint / versions / {ruleset_version}
/ zones / {zone_id} / rulesets / phases / http_custom_errors / entrypoint
/ zones / {zone_id} / url_normalization
/ zones / {zone_id} / workers / filters
/ zones / {zone_id} / workers / filters / {filter_id}
/ zones / {zone_id} / workers / routes
/ zones / {zone_id} / workers / routes / {route_id}
/ zones / {zone_identifier} / acm / total_tls
/ zones / {zone_identifier} / analytics / colos
/ zones / {zone_identifier} / analytics / dashboard
/ zones / {zone_identifier} / analytics / latency
/ zones / {zone_identifier} / analytics / latency / colos
/ zones / {zone_identifier} / argo / smart_routing
/ zones / {zone_identifier} / available_plans
/ zones / {zone_identifier} / available_plans / {plan_identifier}
/ zones / {zone_identifier} / available_rate_plans
/ zones / {zone_identifier} / cache / cache_reserve
/ zones / {zone_identifier} / cache / variants
/ zones / {zone_identifier} / custom_certificates
/ zones / {zone_identifier} / custom_certificates / {identifier}
/ zones / {zone_identifier} / custom_certificates / prioritize
/ zones / {zone_identifier} / custom_hostnames
/ zones / {zone_identifier} / custom_hostnames / {identifier}
/ zones / {zone_identifier} / custom_hostnames / fallback_origin
/ zones / {zone_identifier} / custom_ns
/ zones / {zone_identifier} / custom_pages
/ zones / {zone_identifier} / custom_pages / {identifier}
/ zones / {zone_identifier} / dns_records
/ zones / {zone_identifier} / dns_records / {identifier}
/ zones / {zone_identifier} / dns_records / export
/ zones / {zone_identifier} / dns_records / import
/ zones / {zone_identifier} / dns_records / scan
/ zones / {zone_identifier} / dnssec
/ zones / {zone_identifier} / email / routing
/ zones / {zone_identifier} / email / routing / disable
/ zones / {zone_identifier} / email / routing / dns
/ zones / {zone_identifier} / email / routing / enable
/ zones / {zone_identifier} / email / routing / rules
/ zones / {zone_identifier} / email / routing / rules / {rule_identifier}
/ zones / {zone_identifier} / email / routing / rules / catch_all
/ zones / {zone_identifier} / filters
/ zones / {zone_identifier} / filters / {id}
/ zones / {zone_identifier} / firewall / lockdowns
/ zones / {zone_identifier} / firewall / lockdowns / {id}
/ zones / {zone_identifier} / firewall / rules
/ zones / {zone_identifier} / firewall / rules / {id}
/ zones / {zone_identifier} / firewall / ua_rules
/ zones / {zone_identifier} / firewall / ua_rules / {id}
/ zones / {zone_identifier} / firewall / waf / overrides
/ zones / {zone_identifier} / firewall / waf / overrides / {id}
/ zones / {zone_identifier} / firewall / waf / packages
/ zones / {zone_identifier} / firewall / waf / packages / {identifier}
/ zones / {zone_identifier} / firewall / waf / packages / {package_identifier} / groups
/ zones / {zone_identifier} / firewall / waf / packages / {package_identifier} / groups / {identifier}
/ zones / {zone_identifier} / healthchecks
/ zones / {zone_identifier} / healthchecks / {identifier}
/ zones / {zone_identifier} / healthchecks / preview
/ zones / {zone_identifier} / healthchecks / preview / {identifier}
/ zones / {zone_identifier} / keyless_certificates
/ zones / {zone_identifier} / keyless_certificates / {identifier}
/ zones / {zone_identifier} / logpush / datasets / {dataset} / fields
/ zones / {zone_identifier} / logpush / datasets / {dataset} / jobs
/ zones / {zone_identifier} / logpush / jobs
/ zones / {zone_identifier} / logpush / jobs / {job_identifier}
/ zones / {zone_identifier} / logpush / ownership
/ zones / {zone_identifier} / logpush / ownership / validate
/ zones / {zone_identifier} / logpush / validate / destination / exists
/ zones / {zone_identifier} / logpush / validate / origin
/ zones / {zone_identifier} / logs / control / retention / flag
/ zones / {zone_identifier} / logs / rayids / {ray_identifier}
/ zones / {zone_identifier} / logs / received
/ zones / {zone_identifier} / logs / received / fields
/ zones / {zone_identifier} / origin_tls_client_auth
/ zones / {zone_identifier} / origin_tls_client_auth / {identifier}
/ zones / {zone_identifier} / origin_tls_client_auth / hostnames
/ zones / {zone_identifier} / origin_tls_client_auth / hostnames / {hostname}
/ zones / {zone_identifier} / origin_tls_client_auth / hostnames / certificates
/ zones / {zone_identifier} / origin_tls_client_auth / hostnames / certificates / {identifier}
/ zones / {zone_identifier} / origin_tls_client_auth / settings
/ zones / {zone_identifier} / pagerules
/ zones / {zone_identifier} / pagerules / {identifier}
/ zones / {zone_identifier} / pagerules / settings
/ zones / {zone_identifier} / railguns
/ zones / {zone_identifier} / railguns / {identifier}
/ zones / {zone_identifier} / railguns / {identifier} / diagnose
/ zones / {zone_identifier} / rate_limits
/ zones / {zone_identifier} / rate_limits / {id}
/ zones / {zone_identifier} / settings
/ zones / {zone_identifier} / settings / 0rtt
/ zones / {zone_identifier} / settings / advanced_ddos
/ zones / {zone_identifier} / settings / always_online
/ zones / {zone_identifier} / settings / always_use_https
/ zones / {zone_identifier} / settings / automatic_https_rewrites
/ zones / {zone_identifier} / settings / automatic_platform_optimization
/ zones / {zone_identifier} / settings / brotli
/ zones / {zone_identifier} / settings / browser_cache_ttl
/ zones / {zone_identifier} / settings / browser_check
/ zones / {zone_identifier} / settings / cache_level
/ zones / {zone_identifier} / settings / challenge_ttl
/ zones / {zone_identifier} / settings / ciphers
/ zones / {zone_identifier} / settings / development_mode
/ zones / {zone_identifier} / settings / early_hints
/ zones / {zone_identifier} / settings / email_obfuscation
/ zones / {zone_identifier} / settings / h2_prioritization
/ zones / {zone_identifier} / settings / hotlink_protection
/ zones / {zone_identifier} / settings / http2
/ zones / {zone_identifier} / settings / http3
/ zones / {zone_identifier} / settings / image_resizing
/ zones / {zone_identifier} / settings / ip_geolocation
/ zones / {zone_identifier} / settings / ipv6
/ zones / {zone_identifier} / settings / min_tls_version
/ zones / {zone_identifier} / settings / minify
/ zones / {zone_identifier} / settings / mirage
/ zones / {zone_identifier} / settings / mobile_redirect
/ zones / {zone_identifier} / settings / nel
/ zones / {zone_identifier} / settings / opportunistic_encryption
/ zones / {zone_identifier} / settings / opportunistic_onion
/ zones / {zone_identifier} / settings / orange_to_orange
/ zones / {zone_identifier} / settings / origin_error_page_pass_thru
/ zones / {zone_identifier} / settings / origin_max_http_version
/ zones / {zone_identifier} / settings / polish
/ zones / {zone_identifier} / settings / prefetch_preload
/ zones / {zone_identifier} / settings / privacy_pass
/ zones / {zone_identifier} / settings / proxy_read_timeout
/ zones / {zone_identifier} / settings / pseudo_ipv4
/ zones / {zone_identifier} / settings / response_buffering
/ zones / {zone_identifier} / settings / rocket_loader
/ zones / {zone_identifier} / settings / security_header
/ zones / {zone_identifier} / settings / security_level
/ zones / {zone_identifier} / settings / server_side_exclude
/ zones / {zone_identifier} / settings / sort_query_string_for_cache
/ zones / {zone_identifier} / settings / ssl
/ zones / {zone_identifier} / settings / ssl_recommender
/ zones / {zone_identifier} / settings / tls_1_3
/ zones / {zone_identifier} / settings / tls_client_auth
/ zones / {zone_identifier} / settings / true_client_ip_header
/ zones / {zone_identifier} / settings / waf
/ zones / {zone_identifier} / settings / webp
/ zones / {zone_identifier} / settings / websockets
/ zones / {zone_identifier} / ssl / certificate_packs
/ zones / {zone_identifier} / ssl / certificate_packs / {identifier}
/ zones / {zone_identifier} / ssl / certificate_packs / order
/ zones / {zone_identifier} / ssl / certificate_packs / quota
/ zones / {zone_identifier} / ssl / recommendation
/ zones / {zone_identifier} / ssl / universal / settings
/ zones / {zone_identifier} / ssl / verification
/ zones / {zone_identifier} / ssl / verification / {cert_pack_uuid}
/ zones / {zone_identifier} / waiting_rooms
/ zones / {zone_identifier} / waiting_rooms / {waiting_room_id}
/ zones / {zone_identifier} / waiting_rooms / {waiting_room_id} / events
/ zones / {zone_identifier} / waiting_rooms / {waiting_room_id} / events / {event_id}
/ zones / {zone_identifier} / waiting_rooms / {waiting_room_id} / events / {event_id} / details
/ zones / {zone_identifier} / waiting_rooms / {waiting_room_id} / rules
/ zones / {zone_identifier} / waiting_rooms / {waiting_room_id} / rules / {rule_id}
/ zones / {zone_identifier} / waiting_rooms / {waiting_room_id} / status
/ zones / {zone_identifier} / waiting_rooms / preview
/ zones / {zone_identifier} / web3 / hostnames
/ zones / {zone_identifier} / web3 / hostnames / {identifier}
/ zones / {zone_identifier} / web3 / hostnames / {identifier} / ipfs_universal_path / content_list
/ zones / {zone_identifier} / web3 / hostnames / {identifier} / ipfs_universal_path / content_list / entries
/ zones / {zone_identifier} / web3 / hostnames / {identifier} / ipfs_universal_path / content_list / entries / {content_list_entry_identifier}
/ zones / {zone_identifier} / workers / script
/ zones / {zone_identifier} / workers / script / bindings
/ zones / {zone} / spectrum / analytics / aggregate / current
/ zones / {zone} / spectrum / analytics / events / bytime
/ zones / {zone} / spectrum / analytics / events / summary
/ zones / {zone} / spectrum / apps
/ zones / {zone} / spectrum / apps / {app_id}
No API Resources

(Product) (Docs)

---

{"class":["gateway"],"properties":{"name":"Kong","provider":"Kong","slug":"kong","rating":1,"license":"Proprietary, Open Source (Apache-2.0)","status":"Pending Review","researchDate":"2021-10","description":"Kong is presented as both an open source Gateway and as an enterprise platform named Kong Konnect. The platform consists of an Gateway, a Service Mesh, a Portal, an API client, and more. Kong has gained a strong footing for internal use cases, leading to its integrations with Kubernetes and Envoy.\n","platformCapabilities":["Design","Gateway","Analytics","Monitoring","Portal","Threat Protection"],"gatewayCapabilities":["Custom Code Execution","Protocol Transformation","Traffic Management","Mediation","OpenAPI Integration"],"customCodeSupport":["Lua"],"upstreamProtocols":["HTTP/1.1","HTTP/2","gRPC","GraphQL","Kafka"],"downstreamProtocols":["HTTP/1.1","HTTP/2","GraphQL"],"deliveryModels":["SaaS","Customer Managed (Cloud)","Customer Managed (On-Premises)"],"policies":[{"category":"Traffic Management","capabilities":["Canary Release","GraphQL Caching","Rate Limiting","Mocking","Cache Lookup","Cache Invalidation","Cache Population","Cache Target Response","Quota","Request Size Limiting"]},{"category":"Mediation","capabilities":["GraphQL to REST","Request Transformation","Response Transformation","Context Persistence","JSON to XML"]},{"category":"Security","capabilities":["IP Access Rules","Basic Authentication","API Key","OAuth 2.0","HMAC","JWT","LDAP","Message Inspection","SAML Assertion","Mutual TLS","OpenID Connect","HashiCorp Vault Authentication","Okta","Let's Encrypt","Bot Detection","CORS","Access Control Lists"]},{"category":"Extensions","capabilities":["Serverless Integrations","Monitoring Integrations","Statistics Collection","Message Logging"]}]},"links":[{"rel":["urn:gateway:product"],"title":"Product","href":"https://konghq.com/"},{"rel":["urn:gateway:docs"],"title":"Documentation","href":"https://docs.konghq.com/"},{"rel":["urn:gateway:logo"],"title":"Logo","href":"/images/gateways/kong.svg"},{"rel":["urn:gateway:screenshot"],"title":"Screenshot","href":"https://kinlane-productions2.s3.amazonaws.com/api-gateways/kong.png"}]}

Kong

Kong is presented as both an open source Gateway and as an enterprise platform named Kong Konnect. The platform consists of an Gateway, a Service Mesh, a Portal, an API client, and more. Kong has gained a strong footing for internal use cases, leading to its integrations with Kubernetes and Envoy.

Platform Capabilities

These are the wider capabilities beyond the gateway they offer.

• Design
• Gateway
• Analytics
• Monitoring
• Portal
• Threat Protection

Gateway Capabilities

These are the capabilities the gateway supports.

• Custom Code Execution
• Protocol Transformation
• Traffic Management
• Mediation
• OpenAPI Integration

Upstream Protocols

The different protocols they support upstream.

• HTTP/1.1
• HTTP/2
• gRPC
• GraphQL
• Kafka

Downtream Protocols

The different protocols they support downstream.

• HTTP/1.1
• HTTP/2
• GraphQL

Custom Code

If they offer plugin, extension, and custom coding options.

• Lua

Delivery Models

These are they ways you can deliver this solution.

• SaaS
• Customer Managed (Cloud)
• Customer Managed (On-Premises)

Policies

These are the policies available across the gateway capabilities.

Traffic Management

• Canary Release
• GraphQL Caching
• Rate Limiting
• Mocking
• Cache Lookup
• Cache Invalidation
• Cache Population
• Cache Target Response
• Quota
• Request Size Limiting

Mediation

• GraphQL to REST
• Request Transformation
• Response Transformation
• Context Persistence
• JSON to XML

Security

• IP Access Rules
• Basic Authentication
• API Key
• OAuth 2.0
• HMAC
• JWT
• LDAP
• Message Inspection
• SAML Assertion
• Mutual TLS
• OpenID Connect
• HashiCorp Vault Authentication
• Okta
• Let's Encrypt
• Bot Detection
• CORS
• Access Control Lists

Extensions

• Serverless Integrations
• Monitoring Integrations
• Statistics Collection
• Message Logging

API Resources

Dev Portal API OpenAPI	{"openapi":"3.1.0","info":{"title":"Dev Portal API","version":"1.0","summary":"Kong Dev Portal (On-Prem) API","contact":{"name":"Michael Heap"},"description":"Welcome to the documentation for the Dev Portal API, self-managed edition. <br><br><b>Disclaimer:</b> This document is currently in beta. It might not contain all possible endpoints and requests, and request descriptions are not complete. <br>If you find a missing request or run into an error in the documentation, please file an issue in our <a href=\"https://github.com/Kong/docs.konghq.com/issues\">Github repository</a>, or submit a PR to update the <a href=\"https://github.com/Kong/docs.konghq.com/blob/main/app/api/developer-portal.json\">Dev Portal API spec</a>."},"paths":{"/auth":{"get":{"summary":"Create Session","tags":["authentication"],"operationId":"create-session","description":"Log in to a Dev Portal account using HTTP Basic auth.\n\nThe `username` is your developer portal account email address. The `password` is the password you chose when signing up.\n\nFor example:\n\n`Authorization: Basic base64(user@example.com:password)`\n\nThis endpoint returns a `Set-Cookie` header that looks similar to the following:\n\n```\nportal_session=LBTguN3iEqQlYK3089Ij2Q|1622804485|AXQzsTuR_M3TGFkUV6PzzXPpFtA; Path=/; SameSite=Strict; HttpOnly\n```\n\nThis ID must be sent on all subsequent requests in the `Cookie` header like so:\n\n```\nCookie: portal_session=LBTguN3iEqQlYK3089Ij2Q|1622804485|AXQzsTuR_M3TGFkUV6PzzXPpFtA\n```","responses":{"204":{"description":"No Content"},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"","type":"object","properties":{"message":{"type":"string"}},"required":["message"]},"examples":{}}}}},"security":[{"DeveloperCredentials":[]}]},"delete":{"summary":"Delete Session","operationId":"delete-session","responses":{"200":{"description":"OK"}},"description":"Destroy the active session","tags":["authentication"],"parameters":[{"schema":{"type":"string"},"in":"query","name":"session_logout","description":"true"}]}},"/register":{"post":{"summary":"Register Account","operationId":"register","responses":{"200":{"description":"OK","content":{"application/x-www-form-urlencoded":{"schema":{"description":"","type":"object","properties":{"email":{"type":"object","required":["sent","error"],"properties":{"sent":{"type":"object","required":["emails","count"],"properties":{"emails":{"type":"object","required":["noreply@konghq.com"],"properties":{"noreply@konghq.com":{"type":"boolean"}}},"count":{"type":"number"}}},"error":{"type":"object","required":["emails","count"],"properties":{"emails":{"type":"object"},"count":{"type":"number"}}}}},"developer":{"type":"object","required":["id","created_at","updated_at","consumer","status","email","meta"],"properties":{"id":{"type":"string"},"created_at":{"type":"number"},"updated_at":{"type":"number"},"consumer":{"type":"object","required":["id"],"properties":{"id":{"type":"string"}}},"status":{"type":"number"},"email":{"type":"string","format":"email"},"meta":{"type":"string"}}}},"required":["email","developer"]},"examples":{"success":{"value":{"email":{"sent":{"emails":{"noreply@konghq.com":true},"count":1},"error":{"emails":{},"count":0}},"developer":{"id":"fc824f6d-d078-4403-ab7e-ee610f48cecf","created_at":1622808888,"updated_at":1622808888,"consumer":{"id":"a913e107-456f-470e-ab0a-0cc8e911ff95"},"status":1,"email":"user@example.com","meta":"{\"full_name\":\"User\"}"}}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"description":"","type":"object","properties":{"fields":{"type":"object","minProperties":1},"code":{"type":"number"}},"required":["fields","code"]},"examples":{"missing-password":{"value":{"fields":{"password":"password is required"},"code":2}},"missing-email":{"value":{"fields":{"email":"required field missing"},"code":2}},"missing-meta":{"value":{"fields":{"meta":{"full_name":"required field missing"}},"code":2}}}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"description":"","type":"object","properties":{"fields":{"type":"object","properties":{"email":{"type":"string","minLength":1}},"required":["email"]},"code":{"type":"number"}},"required":["fields","code"]}}}}},"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"description":"","type":"object","properties":{"password":{"type":"string","example":"my_password"},"email":{"type":"string","example":"user@example.com","format":"email"},"meta":{"type":"string","example":"{\"full_name\":\"User\"}"}},"required":["password","email","meta"]},"examples":{"create":{"value":{"password":"my_password","email":"user@example.com","meta":"{\"full_name\":\"User\"}"}}}}},"description":""},"description":"Create a new Dev Portal account","tags":["account"]}},"/verify-account":{"post":{"summary":"Verify account","tags":["account"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"description":"","type":"object","properties":{"status":{"type":"number"}},"required":["status"]},"examples":{"success":{"value":{"status":1}}}}}},"400":{"$ref":"#/components/responses/TokenIsRequired"},"401":{"description":"Token is invalid or has already been used/invalidated","content":{"application/json":{"schema":{"description":"","type":"object","properties":{"message":{"type":"string","minLength":1}},"required":["message"]},"examples":{"error":{"value":{"message":"Unauthorized"}}}}}}},"operationId":"verify-account","description":"Verify an account that has been approved by an admin by providing a JWT that has been emailed to the developer","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"description":"","type":"object","properties":{"token":{"type":"string","example":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHAiOjE2MjI4MzA4NTYsImlkIjoiMWM1YzA4YTUtOTQ3Mi00NzgzLTg3NzktMDk5YzcxZGIzZTcxIn0.OcwU9QfdnzlWfdGy9iEfcARuwpRDwTDe9zcXrHbr9dQ"}},"required":["token"]},"examples":{"token":{"value":{"token":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE2MjE1NTA5MDEsImlkIjoiZTQwOWU0YjEtZDkwNi00ZDI4LThlMzItYjJmOTQ4OWM4YTU4In0.HmOOvH-30mD4Xx3ss_6WXadJKB9qukvh5D178rG9qo0"}}}}},"description":""}}},"/resend-account-verification":{"post":{"summary":"Resend Account Verification Email","operationId":"resend-account-verification","responses":{"204":{"description":"No Content"}},"description":"Trigger redelivery of the account verification email","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"email":{"type":"string"}}},"examples":{"reset":{"value":{"email":"user%40example.com"}}}}},"description":""},"tags":["account"]}},"/invalidate-account-verification":{"post":{"summary":"Invalidate Account Verification Token","operationId":"invalidate-account-verification","responses":{"204":{"description":"No Content"},"401":{"$ref":"#/components/responses/TokenIsRequired"}},"description":"Prevent an account validation token from being used","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"description":"","type":"object","properties":{"token":{"type":"string"}},"required":["token"]},"examples":{"token":{"value":{"token":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHAiOjE2MjI4MzE0MjksImlkIjoiOTQzYTM3MmEtMGJiOC00YTlhLWIxNDYtYTY2ZGRlYWY2OGY0In0.UMXMmxic3km5HcU7rW5i_V5drZq6ilDWilSrmm8n0fs"}}}}}},"tags":["account"]}},"/validate-reset":{"post":{"summary":"Validate Reset","operationId":"validate-reset","responses":{"200":{"description":"Token is valid. This endpoint does not return a body"},"400":{"$ref":"#/components/responses/TokenIsRequired"}},"tags":["account"],"description":"Check if the reset token provided is valid. This endpoint does not invalidate the token after checking","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"description":"","type":"object","properties":{"token":{"type":"string","minLength":1}},"required":["token"],"x-examples":{"example-1":{"token":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZCI6IjA2ZTVlYTc0LTIxMWUtNDQ1NC05MmNiLTNmOTliY2U0ZGIxMCIsImV4cCI6MTYyMjg0MDEwMn0.jVabgJpL1VAT4P-QX2VaT_cGk1xxPyeVT-nobqATjZM"}}}}}}}},"/reset-password":{"post":{"summary":"Reset Password","operationId":"reset-password","responses":{"200":{"description":"Password reset. This endpoint does not return a body"},"400":{"$ref":"#/components/responses/TokenIsRequired"}},"description":"Reset a password by providing a token and a new password","tags":["account"],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"description":"","type":"object","properties":{"token":{"type":"string","minLength":1},"password":{"type":"string","minLength":1}},"required":["token","password"],"x-examples":{"example-1":{"token":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZCI6IjA2ZTVlYTc0LTIxMWUtNDQ1NC05MmNiLTNmOTliY2U0ZGIxMCIsImV4cCI6MTYyMjg0MDc3MH0.ZmSHLE_StJHQZMqjxL35zlI0aNJemk80yOteuKqDnWs","password":"password"}}}}}}}},"/forgot-password":{"post":{"summary":"Forgot Password","operationId":"forgot-password","responses":{"200":{"description":"Reset email sent. This endpoint does not return a body"}},"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"description":"","type":"object","properties":{"email":{"type":"string","minLength":1}},"required":["email"],"x-examples":{"example-1":{"email":"user@example.com"}}}}}},"description":"Trigger a forgotten password email","tags":["account"]}},"/files":{"get":{"summary":"List Files","tags":["files"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"description":"","type":"object","properties":{"next":{"type":"string","minLength":1},"offset":{"type":"string","minLength":1},"data":{"type":"array","uniqueItems":true,"minItems":1,"items":{"required":["checksum","id","path","created_at","contents"],"properties":{"checksum":{"type":"string","minLength":1},"id":{"type":"string","minLength":1},"path":{"type":"string","minLength":1},"created_at":{"type":"number"},"contents":{"type":"string","minLength":1}}}}},"required":["next","offset","data"],"x-examples":{"example-1":{"next":"/files?offset=f75ec1aa-639a-47a4-9063-6c4b14f0463a","offset":"f75ec1aa-639a-47a4-9063-6c4b14f0463a","data":[{"checksum":"62add248168d176068865b526234294392ef86736fab23e66c5c99853987994e","id":"05f103ff-5782-492e-bfb0-3ecf4eada68e","path":"themes/base/assets/styles/normalize.min.css","created_at":1621585953,"contents":"/*! normalize.css v8.0.1 | MIT License | github.com/necolas/normalize.css */html{line-height:1.15;-webkit-text-size-adjust:100%}body{margin:0}main{display:block}h1{font-size:2em;margin:.67em 0}hr{box-sizing:content-box;height:0;overflow:visible}pre{font-family:monospace,monospace;font-size:1em}a{background-color:transparent}abbr[title]{border-bottom:none;text-decoration:underline;text-decoration:underline dotted}b,strong{font-weight:bolder}code,kbd,samp{font-family:monospace,monospace;font-size:1em}small{font-size:80%}sub,sup{font-size:75%;line-height:0;position:relative;vertical-align:baseline}sub{bottom:-.25em}sup{top:-.5em}img{border-style:none}button,input,optgroup,select,textarea{font-family:inherit;font-size:100%;line-height:1.15;margin:0}button,input{overflow:visible}button,select{text-transform:none}[type=button],[type=reset],[type=submit],button{-webkit-appearance:button}[type=button]::-moz-focus-inner,[type=reset]::-moz-focus-inner,[type=submit]::-moz-focus-inner,button::-moz-focus-inner{border-style:none;padding:0}[type=button]:-moz-focusring,[type=reset]:-moz-focusring,[type=submit]:-moz-focusring,button:-moz-focusring{outline:1px dotted ButtonText}fieldset{padding:.35em .75em .625em}legend{box-sizing:border-box;color:inherit;display:table;max-width:100%;padding:0;white-space:normal}progress{vertical-align:baseline}textarea{overflow:auto}[type=checkbox],[type=radio]{box-sizing:border-box;padding:0}[type=number]::-webkit-inner-spin-button,[type=number]::-webkit-outer-spin-button{height:auto}[type=search]{-webkit-appearance:textfield;outline-offset:-2px}[type=search]::-webkit-search-decoration{-webkit-appearance:none}::-webkit-file-upload-button{-webkit-appearance:button;font:inherit}details{display:block}summary{display:list-item}template{display:none}[hidden]{display:none}\n"}]}}},"examples":{"success":{"value":{"next":"/files?offset=f75ec1aa-639a-47a4-9063-6c4b14f0463a","offset":"f75ec1aa-639a-47a4-9063-6c4b14f0463a","data":[{"checksum":"99b7da64f6913643358ea0c8b8b4185cfb9ff03d6d82ddd9fa4eca9dfa23d997","id":"07f1b7e2-43b6-411b-89d7-2a2593e1a76d","path":"themes/base/partials/homepage/clients.html","created_at":1621585953,"contents":"<section class=\"homepage-clients\">\n <h2>You're in Good Company</h2>\n <p>Developers from all industries use our platform to build integrations and custom applications.</p>\n <ul class=\"client-list\">\n <a class=\"client\">COMPANY</a>\n <a class=\"client\">COMPANY</a>\n <a class=\"client\">COMPANY</a>\n <a class=\"client\">COMPANY</a>\n <a class=\"client\">COMPANY</a>\n <a class=\"client\">COMPANY</a>\n </ul>\n</section>\n "}]}}}}}}},"operationId":"list-files","description":"List all of the files uploaded to the portal"}},"/developer":{"get":{"summary":"Get Logged-in Developer","tags":["developer"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"description":"","type":"object","properties":{"updated_at":{"type":"number"},"meta":{"type":"string","minLength":1},"created_at":{"type":"number"},"email":{"type":"string","minLength":1},"consumer":{"type":"object","properties":{"id":{"type":"string","minLength":1}},"required":["id"]},"id":{"type":"string","minLength":1},"status":{"type":"number"}},"required":["updated_at","meta","created_at","email","consumer","id","status"],"x-examples":{"example-1":{"updated_at":1622818516,"meta":"{\"full_name\":\"User\"}","created_at":1622818473,"email":"user@example.com","consumer":{"id":"06e5ea74-211e-4454-92cb-3f99bce4db10"},"id":"7581dec6-3f16-4509-86ef-b5c65179a532","status":0}}},"examples":{"success":{"value":{"updated_at":1622818516,"meta":"{\"full_name\":\"User\"}","created_at":1622818473,"email":"user@example.com","consumer":{"id":"06e5ea74-211e-4454-92cb-3f99bce4db10"},"id":"7581dec6-3f16-4509-86ef-b5c65179a532","status":0}}}}}}},"operationId":"get-developer","description":"Get the currently logged in developer's details"},"delete":{"summary":"Delete Developer","operationId":"delete-developer","responses":{"204":{"description":"No Content"},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"","type":"object","properties":{"message":{"type":"string","minLength":1}},"required":["message"],"x-examples":{"example-1":{"message":"Invalid authentication credentials"}}},"examples":{"error":{"value":{"message":"Invalid authentication credentials"}}}}}}},"description":"Delete the current developer's account","tags":["developer"]}},"/developer/meta_fields":{"get":{"summary":"Your GET endpoint","tags":["developer"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","description":"","minItems":1,"uniqueItems":true,"items":{"type":"object","required":["title","label","is_email","validator"],"properties":{"title":{"type":"string","minLength":1},"label":{"type":"string","minLength":1},"is_email":{"type":"boolean"},"validator":{"type":"object","properties":{"type":{"type":"string","minLength":1},"required":{"type":"boolean"}},"required":["type","required"]}}},"x-examples":{"example-1":[{"title":"full_name","label":"Full Name","is_email":false,"validator":{"type":"string","required":true}}]}},"examples":{"success":{"value":[{"title":"full_name","label":"Full Name","is_email":false,"validator":{"type":"string","required":true}}]}}}}}},"operationId":"get-developer-meta","description":"Get metadata associated with the current user"}},"/developer/password":{"patch":{"summary":"Update Password","operationId":"update-password","responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"description":"","type":"object","properties":{"message":{"type":"string","minLength":1}},"required":["message"],"x-examples":{"example-1":{"message":"Old password is invalid"}}},"examples":{"error":{"value":{"message":"Old password is invalid"}}}}}}},"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"description":"","type":"object","properties":{"password":{"type":"string","minLength":1},"old_password":{"type":"string","minLength":1}},"required":["password","old_password"],"x-examples":{"example-1":{"password":"password123","old_password":"password"}}},"examples":{"update-password":{"value":{"password":"password","old_password":"password123"}}}}}},"tags":["developer"],"description":"Change the currently logged in user's password"}},"/developer/email":{"patch":{"summary":"Update Email","operationId":"update-email","responses":{"200":{"description":"OK"}},"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"description":"","type":"object","properties":{"email":{"type":"string","minLength":1}},"required":["email"],"x-examples":{"example-1":{"email":"user@example.com"}}},"examples":{"update-email":{"value":{"email":"user@example.com"}}}}}},"tags":["developer"],"description":"Update the currently logged in user's email"}},"/developer/meta":{"patch":{"summary":"","operationId":"update-meta","responses":{"200":{"description":"Metadata updated. This endpoint does not return a body"}},"description":"Update developer meta fields","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"description":"","type":"object","properties":{"meta":{"type":"string","minLength":1}},"required":["meta"],"x-examples":{"example-1":{"meta":"{\"full_name\":\"Bob\"}"}}},"examples":{"update-meta":{"value":{"meta":"{\"full_name\":\"Bob\"}"}}}}}},"tags":["developer"]}},"/credentials/key-auth":{"get":{"summary":"Get Credentials (Key Auth)","tags":["credentials"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"description":"","type":"object","properties":{"next":{},"data":{"type":"array","uniqueItems":true,"minItems":1,"items":{"required":["created_at","key","id"],"properties":{"consumer":{"type":"object","properties":{"id":{"type":"string","minLength":1}},"required":["id"]},"created_at":{"type":"number"},"key":{"type":"string","minLength":1},"id":{"type":"string","minLength":1}}}},"total":{"type":"number"}},"required":["data","total"],"x-examples":{"example-1":{"next":null,"data":[{"consumer":{"id":"52b6eefa-1962-42b1-a5c7-26370c5427c5"},"created_at":1621616464,"key":"demo123","id":"567276e0-2b15-4592-b9d4-c40f5439873f"}],"total":1}}},"examples":{"success":{"value":{"data":[{"key":"demo123","consumer":{"id":"797625f9-5bff-4270-8857-ca4e9c192f17"},"id":"4d00b0be-651e-468d-baba-12f5ca6988b5","created_at":1622826008}],"next":null,"total":1}}}}}}},"operationId":"get-credentials-key-auth","description":"List available key-auth credentials"},"post":{"summary":"Create Credential (key-auth)","operationId":"create-credentials-key-auth","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"description":"","type":"object","properties":{"key":{"type":"string","minLength":1},"consumer":{"type":"object","properties":{"id":{"type":"string","minLength":1}},"required":["id"]},"id":{"type":"string","minLength":1},"created_at":{"type":"number"}},"required":["key","consumer","id","created_at"],"x-examples":{"example-1":{"key":"demo123","consumer":{"id":"797625f9-5bff-4270-8857-ca4e9c192f17"},"id":"4d00b0be-651e-468d-baba-12f5ca6988b5","created_at":1622826008}}},"examples":{"success":{"value":{"key":"demo123","consumer":{"id":"797625f9-5bff-4270-8857-ca4e9c192f17"},"id":"4d00b0be-651e-468d-baba-12f5ca6988b5","created_at":1622826008}}}}}}},"description":"Create key-auth credentials","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"description":"","type":"object","x-examples":{"example-1":{"key":"demo123"}},"properties":{"key":{"type":"string","minLength":1}}},"examples":{"create":{"value":{"key":"demo123"}}}}}},"tags":["credentials"]}},"/credentials/jwt":{"get":{"summary":"Get Credentials (JWT)","tags":["credentials"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/JWTHS"},{"$ref":"#/components/schemas/JWTRS"}]}}}},"examples":{"success":{"value":{"data":[{"algorithm":"HS256","id":"4802966c-38fb-44f6-b31b-9c39ea688c99","created_at":1622826359,"secret":"secret1","consumer":{"id":"797625f9-5bff-4270-8857-ca4e9c192f17"},"key":"demo123"},{"algorithm":"RS256","id":"b6559540-f68d-4ecb-9791-f5668f92dd9e","created_at":1622826371,"secret":"secret1","consumer":{"id":"797625f9-5bff-4270-8857-ca4e9c192f17"},"rsa_public_key":"-----BEGIN PUBLIC KEY-----\nMIICIjANBgkqhkiG9w0BAQEFAAOCAg8AMIICCgKCAgEAtZGewwUOx8dRq7txWGVt\nFBd/s3RNcRDe8uNRM//LxNoMFlK+LCT3r8sUp7x5JQ9ee+rLVV5YpUWHYhQ0XtBP\nFritRKabw/6cid+cBdeIQZ/BufVhxDybwm+Bq0CL+dHkXR1nLUoG6I1/CvSSjMVj\nILtsBDUC9B8PVpjRo66U5vx0mBCtItx4bblcSrAVkUHRH3fx9bHNrqQhNx8wNf08\nVHuiCGKM7fo4YdhUJtXSCh5CKafnxjGLUMPKum82l23vNkhrV7H7FjKv9OpWeIQt\nxLq1gtUXLXUy0hM/WqtXDLzq3b3iXLHpilrPAUsaBGDvaO9qnqfJ7/kLJXz4Zxn8\nV70ucfMABJc5lAiEZpBVtSJ5QTIurdIvAIBuCU7VS3wHwPtNwKIdLQVNLqUYsSGl\nyp5zfAhKjrdmKCNUgdIMmFiCB1UqfTWESw7OT7kfu4xc15QIZc+JJD24QwUSJLwl\nOgHDzFigMcPuLYpmswPEIYjOcZefe8PreZcVzDSBQkMDS8TP9MUYpd225AtyVChB\nxUxLZ8Ca4C1pWI/Jlh9E5ZRk1dnvgypcipkSzj24uTazZQUws0qbCE0ZaEd0yxYz\n1MIQaWMQ/hk38h4ogkdatTXjalFIHJ+Vrt7nkfcOzD2/ujBacMvr/9WB1xcBNEUg\nZRP0UdnTaVZ5EqWVwqNTUvcCAwEAAQ==\n-----END PUBLIC KEY-----","key":"demo999"}],"next":null,"total":2}}}}}}},"operationId":"get-credentials-jwt","description":"List available JWT credentials"},"post":{"summary":"Create Credential (JWT)","operationId":"create-credential-jwt","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{}}}}}},"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"description":"","type":"object","x-examples":{"example-1":{"key":"demo123","secret":"secret1","algorithm":"HS256"}},"properties":{"key":{"type":"string","minLength":1},"secret":{"type":"string","minLength":1},"algorithm":{"type":"string","minLength":1},"rsa_public_key":{"type":"string"},"":{"type":"string"}},"required":["key","secret","algorithm"]},"examples":{"HS256":{"value":{"key":"hs-key","secret":"secret1","algorithm":"HS256"}},"RS256":{"value":{"key":"rs-key","secret":"secret1","algorithm":"RS256","rsa_public_key":"-----BEGIN PUBLIC KEY-----\nMIICIjANBgkqhkiG9w0BAQEFAAOCAg8AMIICCgKCAgEAtZGewwUOx8dRq7txWGVt\nFBd/s3RNcRDe8uNRM//LxNoMFlK+LCT3r8sUp7x5JQ9ee+rLVV5YpUWHYhQ0XtBP\nFritRKabw/6cid+cBdeIQZ/BufVhxDybwm+Bq0CL+dHkXR1nLUoG6I1/CvSSjMVj\nILtsBDUC9B8PVpjRo66U5vx0mBCtItx4bblcSrAVkUHRH3fx9bHNrqQhNx8wNf08\nVHuiCGKM7fo4YdhUJtXSCh5CKafnxjGLUMPKum82l23vNkhrV7H7FjKv9OpWeIQt\nxLq1gtUXLXUy0hM/WqtXDLzq3b3iXLHpilrPAUsaBGDvaO9qnqfJ7/kLJXz4Zxn8\nV70ucfMABJc5lAiEZpBVtSJ5QTIurdIvAIBuCU7VS3wHwPtNwKIdLQVNLqUYsSGl\nyp5zfAhKjrdmKCNUgdIMmFiCB1UqfTWESw7OT7kfu4xc15QIZc+JJD24QwUSJLwl\nOgHDzFigMcPuLYpmswPEIYjOcZefe8PreZcVzDSBQkMDS8TP9MUYpd225AtyVChB\nxUxLZ8Ca4C1pWI/Jlh9E5ZRk1dnvgypcipkSzj24uTazZQUws0qbCE0ZaEd0yxYz\n1MIQaWMQ/hk38h4ogkdatTXjalFIHJ+Vrt7nkfcOzD2/ujBacMvr/9WB1xcBNEUg\nZRP0UdnTaVZ5EqWVwqNTUvcCAwEAAQ==\n-----END PUBLIC KEY-----"}}}}}},"description":"Create a new JWT credential","tags":["credentials"]},"parameters":[]},"/credentials/jwt/{id}":{"get":{"summary":"Get Credential (JWT)","tags":["credentials"],"operationId":"get-credential-jwt","description":"Get JWT Credential","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/JWTHS"},{"$ref":"#/components/schemas/JWTRS"}]}}}}},"parameters":[]},"patch":{"summary":"Update Credential (JWT)","operationId":"patch-credential-jwt","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/JWTHS"},{"$ref":"#/components/schemas/JWTRS"}]},"examples":{"success":{"value":{"algorithm":"HS256","id":"4802966c-38fb-44f6-b31b-9c39ea688c99","created_at":1622826359,"secret":"secret2","consumer":{"id":"797625f9-5bff-4270-8857-ca4e9c192f17"},"key":"demo1234"}}}}}}},"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"$ref":"#/components/schemas/JWT"}}}},"description":"Update an existing JWT credential","tags":["credentials"]},"parameters":[{"schema":{"type":"string"},"name":"id","in":"path","required":true}],"delete":{"summary":"Delete Credential (JWT)","operationId":"delete-credential-jwt","responses":{"204":{"description":"No Content"}},"description":"Delete an existing JWT credential","tags":["credentials"]}},"/applications":{"get":{"summary":"List applications","tags":["application"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"description":"","type":"object","properties":{"data":{"type":"array","uniqueItems":true,"minItems":1,"items":{"required":["created_at","id","redirect_uri","updated_at","name"],"properties":{"created_at":{"type":"number"},"id":{"type":"string","minLength":1},"redirect_uri":{"type":"string","minLength":1},"updated_at":{"type":"number"},"developer":{"type":"object","properties":{"id":{"type":"string","minLength":1}},"required":["id"]},"name":{"type":"string","minLength":1},"consumer":{"type":"object","properties":{"id":{"type":"string","minLength":1}},"required":["id"]}}}},"next":{},"total":{"type":"number"}},"required":["data","total"],"x-examples":{"example-1":{"data":[{"created_at":1626966853,"id":"3c929386-bd89-4c55-92b5-b4966f7957ab","redirect_uri":"https://example.com","updated_at":1626966853,"developer":{"id":"7bd5256c-00e0-47c5-86a7-949aef632a21"},"name":"Demo","consumer":{"id":"b9b6a89d-3fb3-483a-a2df-0bdf4d7d26fe"}}],"next":null,"total":1}}},"examples":{"success":{"value":{"data":[{"created_at":1626966853,"id":"3c929386-bd89-4c55-92b5-b4966f7957ab","redirect_uri":"https://example.com","updated_at":1626966853,"developer":{"id":"7bd5256c-00e0-47c5-86a7-949aef632a21"},"name":"Demo","consumer":{"id":"b9b6a89d-3fb3-483a-a2df-0bdf4d7d26fe"}}],"next":null,"total":1}}}}}}},"operationId":"list-applications","description":"List applications"},"post":{"summary":"Create Application","operationId":"post-applications","responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"description":"","type":"object","properties":{"created_at":{"type":"number"},"id":{"type":"string","minLength":1},"redirect_uri":{"type":"string","minLength":1},"updated_at":{"type":"number"},"developer":{"type":"object","properties":{"id":{"type":"string","minLength":1}},"required":["id"]},"name":{"type":"string","minLength":1},"consumer":{"type":"object","properties":{"id":{"type":"string","minLength":1}},"required":["id"]}},"required":["created_at","id","redirect_uri","updated_at","developer","name","consumer"],"x-examples":{"example-1":{"created_at":1626967086,"id":"fa18fdb0-8cc3-4356-95e5-813ca6bf21de","redirect_uri":"http://localhost","updated_at":1626967086,"developer":{"id":"7bd5256c-00e0-47c5-86a7-949aef632a21"},"name":"My Application","consumer":{"id":"051d9ad2-0fc6-41a6-9bf3-4132117d980e"}}}}}}}},"tags":["application"],"description":"Create an application","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"description":"","type":"object","properties":{"redirect_uri":{"type":"string","minLength":1},"name":{"type":"string","minLength":1}},"required":["redirect_uri","name"],"x-examples":{"example-1":{"redirect_uri":"http://localhost","name":"My Application"}}},"examples":{"create":{"value":{"redirect_uri":"string","name":"string"}}}}}}}},"/applications/{id}":{"get":{"summary":"Get Application","tags":["application"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"description":"","type":"object","properties":{"data":{"type":"array","uniqueItems":true,"minItems":1,"items":{"required":["created_at","id","redirect_uri","updated_at","name"],"properties":{"created_at":{"type":"number"},"id":{"type":"string","minLength":1},"redirect_uri":{"type":"string","minLength":1},"updated_at":{"type":"number"},"developer":{"type":"object","properties":{"id":{"type":"string","minLength":1}},"required":["id"]},"name":{"type":"string","minLength":1},"consumer":{"type":"object","properties":{"id":{"type":"string","minLength":1}},"required":["id"]}}}},"next":{},"total":{"type":"number"}},"required":["data","total"],"x-examples":{"example-1":{"data":[{"created_at":1626966853,"id":"3c929386-bd89-4c55-92b5-b4966f7957ab","redirect_uri":"https://example.com","updated_at":1626966853,"developer":{"id":"7bd5256c-00e0-47c5-86a7-949aef632a21"},"name":"Demo","consumer":{"id":"b9b6a89d-3fb3-483a-a2df-0bdf4d7d26fe"}}],"next":null,"total":1}}},"examples":{"application":{"value":{"created_at":1626967086,"id":"fa18fdb0-8cc3-4356-95e5-813ca6bf21de","redirect_uri":"http://localhost","updated_at":1626967086,"developer":{"id":"7bd5256c-00e0-47c5-86a7-949aef632a21"},"name":"My Application","consumer":{"id":"051d9ad2-0fc6-41a6-9bf3-4132117d980e"}}}}}}}},"operationId":"get-application","description":"Get application"},"parameters":[{"schema":{"type":"string"},"name":"id","in":"path","required":true,"description":"Application ID"}],"patch":{"summary":"Update Application","operationId":"update-application","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"description":"","type":"object","properties":{"created_at":{"type":"number"},"id":{"type":"string","minLength":1},"redirect_uri":{"type":"string","minLength":1},"updated_at":{"type":"number"},"developer":{"type":"object","properties":{"id":{"type":"string","minLength":1}},"required":["id"]},"name":{"type":"string","minLength":1},"consumer":{"type":"object","properties":{"id":{"type":"string","minLength":1}},"required":["id"]}},"required":["created_at","id","redirect_uri","updated_at","developer","name","consumer"],"x-examples":{"example-1":{"created_at":1626967086,"id":"fa18fdb0-8cc3-4356-95e5-813ca6bf21de","redirect_uri":"http://localhost","updated_at":1626967282,"developer":{"id":"7bd5256c-00e0-47c5-86a7-949aef632a21"},"name":"Another","consumer":{"id":"051d9ad2-0fc6-41a6-9bf3-4132117d980e"}}}},"examples":{"updated":{"value":{"created_at":0,"id":"string","redirect_uri":"string","updated_at":0,"developer":{"id":"string"},"name":"string","consumer":{"id":"string"}}}}}}}},"description":"Update application","tags":["application"],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"description":"","type":"object","x-examples":{"example-1":{"name":"Another"}},"properties":{"name":{"type":"string","minLength":1},"request_uri":{"type":"string"}},"required":["name"]},"examples":{"update":{"value":{"redirect_uri":"string","name":"string"}}}}}}},"delete":{"summary":"Delete Application","operationId":"delete-application","responses":{"204":{"description":"No Content"}},"tags":["application"],"description":"Delete application"}},"/application_services":{"get":{"summary":"List Application Services","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"description":"","type":"object","properties":{"data":{"type":"array","uniqueItems":true,"minItems":1,"items":{"required":["name","id"],"properties":{"name":{"type":"string","minLength":1},"app_registration_config":{"type":"object","properties":{"description":{"type":"string","minLength":1},"show_issuer":{"type":"boolean"},"display_name":{"type":"string","minLength":1},"auto_approve":{"type":"boolean"}},"required":["description","show_issuer","display_name","auto_approve"]},"id":{"type":"string","minLength":1}}}},"next":{},"total":{"type":"number"}},"required":["data","total"],"x-examples":{"example-1":{"data":[{"name":"Demo Name","app_registration_config":{"description":"Demo Description","show_issuer":false,"display_name":"Demo Name","auto_approve":false},"id":"d2b5a2c9-51a2-45f9-a62b-17cb5e8ce2ad"}],"next":null,"total":1}}},"examples":{"pending":{"value":{"data":[{"name":"Demo Name","app_registration_config":{"description":"Demo Description","show_issuer":false,"display_name":"Demo App","auto_approve":false},"id":"d2b5a2c9-51a2-45f9-a62b-17cb5e8ce2ad"}],"next":null,"total":1}}}}}}},"operationId":"get-application_services","description":"List available services","tags":["application-services"]}},"/applications/{id}/application_instances":{"get":{"summary":"List Application Services","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"description":"","type":"object","properties":{"data":{"type":"array","uniqueItems":true,"minItems":1,"items":{"required":["name","id"],"properties":{"name":{"type":"string","minLength":1},"app_registration_config":{"type":"object","properties":{"description":{"type":"string","minLength":1},"show_issuer":{"type":"boolean"},"display_name":{"type":"string","minLength":1},"auto_approve":{"type":"boolean"}},"required":["description","show_issuer","display_name","auto_approve"]},"id":{"type":"string","minLength":1}}}},"next":{},"total":{"type":"number"}},"required":["data","total"],"x-examples":{"example-1":{"data":[{"name":"Demo Name","app_registration_config":{"description":"Demo Description","show_issuer":false,"display_name":"Demo Name","auto_approve":false},"id":"d2b5a2c9-51a2-45f9-a62b-17cb5e8ce2ad"}],"next":null,"total":1}}},"examples":{"pending":{"value":{"data":[{"name":"Demo Name","app_registration_config":{"description":"Demo Description","show_issuer":false,"display_name":"Demo App","auto_approve":false},"id":"d2b5a2c9-51a2-45f9-a62b-17cb5e8ce2ad"}],"next":null,"total":1}}}}}}},"operationId":"list-application-services","description":"List application services","tags":["application-instances"]},"parameters":[{"schema":{"type":"string"},"name":"id","in":"path","required":true}],"post":{"summary":"Create Application Instance","operationId":"create-application-instance","responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"description":"","type":"object","properties":{"created_at":{"type":"number"},"suspended":{"type":"boolean"},"status":{"type":"number"},"id":{"type":"string","minLength":1},"composite_id":{"type":"string","minLength":1},"updated_at":{"type":"number"},"application":{"type":"object","properties":{"id":{"type":"string","minLength":1}},"required":["id"]},"service":{"type":"object","properties":{"id":{"type":"string","minLength":1}},"required":["id"]}},"required":["created_at","suspended","status","id","composite_id","updated_at","application","service"],"x-examples":{"example-1":{"created_at":1626968283,"suspended":false,"status":1,"id":"9968b0d6-7358-4989-b359-e1ab913753f7","composite_id":"3c929386-bd89-4c55-92b5-b4966f7957ab_d2b5a2c9-51a2-45f9-a62b-17cb5e8ce2ad","updated_at":1626968283,"application":{"id":"3c929386-bd89-4c55-92b5-b4966f7957ab"},"service":{"id":"d2b5a2c9-51a2-45f9-a62b-17cb5e8ce2ad"}}}},"examples":{"success":{"value":{"created_at":1626968283,"suspended":false,"status":1,"id":"9968b0d6-7358-4989-b359-e1ab913753f7","composite_id":"3c929386-bd89-4c55-92b5-b4966f7957ab_d2b5a2c9-51a2-45f9-a62b-17cb5e8ce2ad","updated_at":1626968283,"application":{"id":"3c929386-bd89-4c55-92b5-b4966f7957ab"},"service":{"id":"d2b5a2c9-51a2-45f9-a62b-17cb5e8ce2ad"}}}}}}}},"description":"Create Application Instance","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"description":"","type":"object","properties":{"service.id":{"type":"string","minLength":1}},"required":["service.id"],"x-examples":{"example-1":{"service.id":"d2b5a2c9-51a2-45f9-a62b-17cb5e8ce2ad"}}},"examples":{"create":{"value":{"service.id":"d2b5a2c9-51a2-45f9-a62b-17cb5e8ce2ad"}}}}}},"tags":["application-instances"]}},"/applications/{id}/application_instances/{instance}":{"get":{"summary":"Get Application Instance","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"description":"","type":"object","properties":{"created_at":{"type":"number"},"suspended":{"type":"boolean"},"status":{"type":"number"},"id":{"type":"string","minLength":1},"composite_id":{"type":"string","minLength":1},"updated_at":{"type":"number"},"application":{"type":"object","properties":{"id":{"type":"string","minLength":1}},"required":["id"]},"service":{"type":"object","properties":{"id":{"type":"string","minLength":1}},"required":["id"]}},"required":["created_at","suspended","status","id","composite_id","updated_at","application","service"],"x-examples":{"example-1":{"created_at":1626967481,"suspended":false,"status":0,"id":"724e758a-0633-4ecc-ab92-8727c42820e7","composite_id":"3c929386-bd89-4c55-92b5-b4966f7957ab_d2b5a2c9-51a2-45f9-a62b-17cb5e8ce2ad","updated_at":1626967581,"application":{"id":"3c929386-bd89-4c55-92b5-b4966f7957ab"},"service":{"id":"d2b5a2c9-51a2-45f9-a62b-17cb5e8ce2ad"}}}},"examples":{"pending":{"value":{"data":[{"name":"Demo Name","app_registration_config":{"description":"Demo Description","show_issuer":false,"display_name":"Demo App","auto_approve":false},"id":"d2b5a2c9-51a2-45f9-a62b-17cb5e8ce2ad"}],"next":null,"total":1}}}}}}},"operationId":"get-application-instance","description":"Get an application instance","tags":["application-instances"]},"parameters":[{"schema":{"type":"string"},"name":"id","in":"path","required":true},{"schema":{"type":"string"},"name":"instance","in":"path","required":true}],"delete":{"summary":"Delete Application Instance","operationId":"delete-application-instance","responses":{"204":{"description":"No Content"}},"description":"Delete application instance","tags":["application-instances"]}},"/applications/{id}/credentials":{"parameters":[{"schema":{"type":"string"},"name":"id","in":"path","required":true}],"get":{"summary":"List Application Credentials","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"description":"","type":"object","properties":{"data":{"type":"array","uniqueItems":true,"minItems":1,"items":{"required":["created_at","id","client_type","name","hash_secret","client_id","client_secret"],"properties":{"consumer":{"type":"object","properties":{"id":{"type":"string","minLength":1}},"required":["id"]},"created_at":{"type":"number"},"id":{"type":"string","minLength":1},"client_type":{"type":"string","minLength":1},"name":{"type":"string","minLength":1},"hash_secret":{"type":"boolean"},"client_id":{"type":"string","minLength":1},"client_secret":{"type":"string","minLength":1},"redirect_uris":{"type":"array","items":{"required":[],"properties":{}}}}}},"next":{},"total":{"type":"number"}},"required":["data","total"],"x-examples":{"example-1":{"data":[{"consumer":{"id":"b9b6a89d-3fb3-483a-a2df-0bdf4d7d26fe"},"created_at":1626967455,"id":"40cc2b81-e92e-4208-8859-83a58bad6136","client_type":"confidential","name":"Demo","hash_secret":false,"client_id":"CqXDjc0UTN5mjHwh38yTU6a8yMeAG3S7","client_secret":"KxKCqk0a097i2cXfe46iVVAyTY2r7KCC","redirect_uris":["https://example.com"]}],"next":null,"total":1}}},"examples":{"credentials":{"value":{"data":[{"consumer":{"id":"string"},"created_at":0,"id":"string","client_type":"string","name":"string","hash_secret":true,"client_id":"string","client_secret":"string","redirect_uris":[{}]}],"next":null,"total":0}}}}}}},"operationId":"list-application-credentials","description":"List Application Credentials","tags":["application-credentials"]},"post":{"summary":"Create application credentials","operationId":"create-application-credentials","responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"description":"","type":"object","properties":{"consumer":{"type":"object","properties":{"id":{"type":"string","minLength":1}},"required":["id"]},"created_at":{"type":"number"},"id":{"type":"string","minLength":1},"client_type":{"type":"string","minLength":1},"name":{"type":"string","minLength":1},"hash_secret":{"type":"boolean"},"client_id":{"type":"string","minLength":1},"client_secret":{"type":"string","minLength":1},"redirect_uris":{"type":"array","items":{"required":[],"properties":{}}}},"required":["consumer","created_at","id","client_type","name","hash_secret","client_id","client_secret","redirect_uris"],"x-examples":{"example-1":{"consumer":{"id":"b9b6a89d-3fb3-483a-a2df-0bdf4d7d26fe"},"created_at":1626968440,"id":"fb1ea628-1adc-4d67-b86e-395e7a12d689","client_type":"confidential","name":"Demo","hash_secret":false,"client_id":"uleOEF5HkPrq2aogk5Y0f2yfB8qmX6xZ","client_secret":"I8hoJyPSO6WAFmwv7giaUbwtZPmIy7Uo","redirect_uris":["https://example.com"]}}},"examples":{"success":{"value":{"consumer":{"id":"b9b6a89d-3fb3-483a-a2df-0bdf4d7d26fe"},"created_at":1626968440,"id":"fb1ea628-1adc-4d67-b86e-395e7a12d689","client_type":"confidential","name":"Demo","hash_secret":false,"client_id":"uleOEF5HkPrq2aogk5Y0f2yfB8qmX6xZ","client_secret":"I8hoJyPSO6WAFmwv7giaUbwtZPmIy7Uo","redirect_uris":["https://example.com"]}}}}}}},"description":"Create application credentials","tags":["application-credentials"]}},"/applications/{id}/credentials/{credential}":{"parameters":[{"schema":{"type":"string"},"name":"id","in":"path","required":true},{"schema":{"type":"string"},"name":"credential","in":"path","required":true}],"get":{"summary":"Get Application Credentials","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"description":"","type":"object","properties":{"data":{"type":"array","uniqueItems":true,"minItems":1,"items":{"required":["created_at","id","client_type","name","hash_secret","client_id","client_secret"],"properties":{"consumer":{"type":"object","properties":{"id":{"type":"string","minLength":1}},"required":["id"]},"created_at":{"type":"number"},"id":{"type":"string","minLength":1},"client_type":{"type":"string","minLength":1},"name":{"type":"string","minLength":1},"hash_secret":{"type":"boolean"},"client_id":{"type":"string","minLength":1},"client_secret":{"type":"string","minLength":1},"redirect_uris":{"type":"array","items":{"required":[],"properties":{}}}}}},"next":{},"total":{"type":"number"}},"required":["data","total"],"x-examples":{"example-1":{"data":[{"consumer":{"id":"b9b6a89d-3fb3-483a-a2df-0bdf4d7d26fe"},"created_at":1626967455,"id":"40cc2b81-e92e-4208-8859-83a58bad6136","client_type":"confidential","name":"Demo","hash_secret":false,"client_id":"CqXDjc0UTN5mjHwh38yTU6a8yMeAG3S7","client_secret":"KxKCqk0a097i2cXfe46iVVAyTY2r7KCC","redirect_uris":["https://example.com"]}],"next":null,"total":1}}},"examples":{"credentials":{"value":{"data":[{"consumer":{"id":"string"},"created_at":0,"id":"string","client_type":"string","name":"string","hash_secret":true,"client_id":"string","client_secret":"string","redirect_uris":[{}]}],"next":null,"total":0}}}}}}},"operationId":"get-application-credential","description":"Get Application Credentials","tags":["application-credentials"]},"delete":{"summary":"Delete Application Credential","operationId":"delete-application-credential","responses":{"204":{"description":"No Content"}},"description":"Delete Application Credential","tags":["application-credentials"]}}},"components":{"securitySchemes":{"DeveloperCredentials":{"type":"http","scheme":"basic"}},"responses":{"TokenIsRequired":{"description":"Bad Request","content":{"application/json":{"schema":{"description":"","type":"object","properties":{"message":{"type":"string","minLength":1}},"required":["message"]},"examples":{"missing-token":{"value":{"message":"token is required"}}}}}}},"schemas":{"JWT":{"title":"JWT","description":"","type":"object","x-examples":{"example-1":{"key":"demo123","secret":"secret1","algorithm":"HS256"}},"properties":{"key":{"type":"string","minLength":1},"secret":{"type":"string","minLength":1},"algorithm":{"type":"string","minLength":1},"rsa_public_key":{"type":"string"},"":{"type":"string"}},"required":["key","secret","algorithm"]},"JWTHS":{"description":"","type":"object","properties":{"algorithm":{"type":"string","minLength":1},"id":{"type":"string","minLength":1},"created_at":{"type":"number"},"secret":{"type":"string","minLength":1},"consumer":{"type":"object","properties":{"id":{"type":"string","minLength":1}},"required":["id"]},"key":{"type":"string","minLength":1}},"required":["algorithm","id","created_at","secret","consumer","key"]},"JWTRS":{"description":"","type":"object","properties":{"algorithm":{"type":"string","minLength":1},"id":{"type":"string","minLength":1},"created_at":{"type":"number"},"secret":{"type":"string","minLength":1},"consumer":{"type":"object","properties":{"id":{"type":"string","minLength":1}},"required":["id"]},"rsa_public_key":{"type":"string","minLength":1},"key":{"type":"string","minLength":1}},"required":["algorithm","id","created_at","secret","consumer","rsa_public_key","key"]}}},"tags":[{"name":"account"},{"name":"application"},{"name":"application-instances"},{"name":"application-credentials"},{"name":"application-services"},{"name":"authentication"},{"name":"configuration"},{"name":"credentials"},{"name":"developer"},{"name":"files"},{"name":"vitals"}]}
/ auth
/ register
/ verify-account
/ resend-account-verification
/ invalidate-account-verification
/ validate-reset
/ reset-password
/ forgot-password
/ files
/ developer
/ developer / meta_fields
/ developer / password
/ developer / email
/ developer / meta
/ credentials / key-auth
/ credentials / jwt
/ credentials / jwt / {id}
/ applications
/ applications / {id}
/ application_services
/ applications / {id} / application_instances
/ applications / {id} / application_instances / {instance}
/ applications / {id} / credentials
/ applications / {id} / credentials / {credential}
Konnect Identity API OpenAPI	{"openapi":"3.0.2","info":{"title":"Konnect Identity API","version":"2.0.0","description":"The management API for Kong Konnect Identity resources.","contact":{"name":"Kong","url":"https://konghq.com"}},"servers":[{"url":"https://global.api.konghq.com/v2","description":"Global Base URL"}],"paths":{"/accept-invite":{"post":{"summary":"Accept Invite","description":"Manually accept the Konnect invitation. This endpoint allows you to manually accept the invitation to join a Konnect organization. Upon accepting the invitation, the user's name and password are set and the active state is set to true. This can be used as an alternative to the https://cloud.konghq.com/login link in the email which will finish the registration process in a web browser.","operationId":"accept-invite","requestBody":{"$ref":"#/components/requestBodies/AcceptInvite"},"responses":{"202":{"description":"Accepted"},"400":{"$ref":"#/components/responses/BadRequest"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Invites"]}},"/invites":{"post":{"summary":"Invite User","description":"Send an invitation email to invite a user to the Konnect organization. The email contains a link with a one time token to accept the invitation. Upon accepting the invitation, the user is directed to https://cloud.konghq.com/login to complete registration.","operationId":"invite-user","requestBody":{"$ref":"#/components/requestBodies/InviteUser"},"responses":{"201":{"description":"Created"},"400":{"$ref":"#/components/responses/BadRequest"},"409":{"$ref":"#/components/responses/Conflict"},"429":{"$ref":"#/components/responses/RateLimited"}},"tags":["Invites"]}},"/identity-provider/team-mappings":{"put":{"summary":"Update Team Mappings","operationId":"update-idp-team-mappings","responses":{"200":{"$ref":"#/components/responses/TeamMappingCollection"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/PermissionDenied"},"404":{"$ref":"#/components/responses/NotFound"},"412":{"$ref":"#/components/responses/PreconditionFailed"}},"tags":["IdPs"],"description":"Update the IdP group to Konnect team mapping.","requestBody":{"$ref":"#/components/requestBodies/UpdateTeamMappings"}},"get":{"summary":"Fetch Team Mapping","operationId":"get-idp-team-mappings","responses":{"200":{"$ref":"#/components/responses/TeamMappingResponse"},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/PermissionDenied"},"404":{"$ref":"#/components/responses/NotFound"},"412":{"$ref":"#/components/responses/PreconditionFailed"}},"tags":["IdPs"],"description":"Fetch the IdP group to Konnect team mapping."}},"/roles":{"get":{"summary":"Get Predefined Roles","description":"Retrieve the predefined, or system managed, roles.","operationId":"get-predefined-roles","responses":{"200":{"$ref":"#/components/responses/Roles"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthenticated"}},"tags":["Roles"]}},"/teams":{"get":{"summary":"List Teams","responses":{"200":{"$ref":"#/components/responses/TeamCollection"},"400":{"$ref":"#/components/responses/BadRequest"},"404":{"$ref":"#/components/responses/NotFound"}},"operationId":"list-teams","description":"Returns an array of team objects containing information about the Konnect Teams.","parameters":[{"$ref":"#/components/parameters/PageSize"},{"$ref":"#/components/parameters/PageNumber"},{"schema":{"type":"string","example":"filter[name]=Organization+Admins"},"in":"query","name":"filter[field]","description":"A field to filter on. Supported fields: name"}],"tags":["Teams"]},"parameters":[],"post":{"summary":"Create Team","operationId":"create-team","responses":{"201":{"$ref":"#/components/responses/TeamSingle"},"400":{"$ref":"#/components/responses/BadRequest"},"403":{"$ref":"#/components/responses/PermissionDenied"}},"tags":["Teams"],"requestBody":{"$ref":"#/components/requestBodies/CreateTeam"},"description":"Create a team in the Konnect Organization. "}},"/teams/{teamId}/users":{"parameters":[{"schema":{"type":"string","example":"d32d905a-ed33-46a3-a093-d8f536af9a8a","format":"uuid"},"name":"teamId","in":"path","required":true,"description":"ID of the team."}],"get":{"summary":"List Team Users","responses":{"200":{"$ref":"#/components/responses/UserCollection"},"400":{"$ref":"#/components/responses/BadRequest"},"404":{"$ref":"#/components/responses/NotFound"}},"operationId":"list-team-users","description":"Returns a paginated list of users that belong to the team specified in the path parameter.","parameters":[{"$ref":"#/components/parameters/PageSize"},{"$ref":"#/components/parameters/PageNumber"}],"tags":["Team Membership"]},"post":{"summary":"Add User","operationId":"add-user-to-team","responses":{"201":{"description":"Created"},"400":{"$ref":"#/components/responses/BadRequest"},"404":{"$ref":"#/components/responses/NotFound"}},"description":"Add a user to a team.","requestBody":{"$ref":"#/components/requestBodies/AddUserToTeam"},"tags":["Team Membership"]}},"/teams/{teamId}":{"parameters":[{"schema":{"type":"string","format":"uuid","example":"d32d905a-ed33-46a3-a093-d8f536af9a8a"},"name":"teamId","in":"path","required":true,"description":"The team ID"}],"get":{"summary":"Fetch Team","responses":{"200":{"$ref":"#/components/responses/TeamSingle"},"400":{"$ref":"#/components/responses/BadRequest"},"404":{"$ref":"#/components/responses/NotFound"}},"operationId":"get-team","description":"Returns information about a team from a given team ID.","tags":["Teams"]},"patch":{"summary":"Update Team","operationId":"update-team","responses":{"200":{"$ref":"#/components/responses/TeamSingle"},"400":{"$ref":"#/components/responses/BadRequest"},"404":{"$ref":"#/components/responses/NotFound"}},"description":"Update an individual team.","requestBody":{"$ref":"#/components/requestBodies/UpdateTeam"},"tags":["Teams"]},"delete":{"summary":"Delete Team","operationId":"delete-team","responses":{"204":{"description":"No Content"},"400":{"$ref":"#/components/responses/BadRequest"}},"description":"Delete an individual team.","tags":["Teams"]}},"/teams/{teamId}/users/{userId}":{"parameters":[{"schema":{"type":"string","format":"uuid","example":"d32d905a-ed33-46a3-a093-d8f536af9a8a"},"name":"userId","in":"path","required":true,"description":"User ID"},{"schema":{"type":"string","example":"d32d905a-ed33-46a3-a093-d8f536af9a8a","format":"uuid"},"name":"teamId","in":"path","required":true,"description":"Team ID."}],"delete":{"summary":"Remove User","operationId":"remove-user-from-team","responses":{"204":{"description":"No Content"},"400":{"$ref":"#/components/responses/BadRequest"},"404":{"$ref":"#/components/responses/NotFound"}},"description":"Remove a user from a team.\nIf the user was removed successfully, returns a 204 empty response.","tags":["Team Membership"]}},"/teams/{teamId}/assigned-roles":{"parameters":[{"schema":{"type":"string","format":"uuid","example":"e81bc3e5-e9db-4764-b7dd-e81e39072cbe"},"name":"teamId","in":"path","required":true,"description":"The team ID"}],"get":{"summary":"List Team Roles","tags":["Roles"],"responses":{"200":{"$ref":"#/components/responses/AssignedRoleCollection"},"404":{"$ref":"#/components/responses/NotFound"}},"operationId":"list-team-roles","description":"List the roles belonging to a team.","parameters":[{"schema":{"type":"string"},"in":"query","name":"filter[field]","description":"A field to filter on. Supported fields: role_name, entity_type_name"}]},"post":{"summary":"Assign Role","operationId":"teams-assign-role","responses":{"201":{"$ref":"#/components/responses/AssignedRoleSingle"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/PermissionDenied"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/Conflict"}},"description":"Assign a role to a team. Returns 409 if role is already assigned.","requestBody":{"$ref":"#/components/requestBodies/AssignRole"},"tags":["Roles"]}},"/teams/{teamId}/assigned-roles/{roleId}":{"parameters":[{"schema":{"type":"string","format":"uuid","example":"e81bc3e5-e9db-4764-b7dd-e81e39072cbe"},"name":"teamId","in":"path","required":true,"description":"The team ID."},{"schema":{"type":"string","example":"8350205f-a305-4e39-abe9-bc082a80091a","format":"uuid"},"name":"roleId","in":"path","required":true,"description":"The role ID."}],"delete":{"summary":"Remove Role","operationId":"teams-remove-role","responses":{"204":{"description":"No Content"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/PermissionDenied"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Roles"],"description":"Remove an assigned role from a team."}},"/users":{"get":{"summary":"List Users","tags":["Users"],"responses":{"200":{"$ref":"#/components/responses/UserCollection"},"400":{"$ref":"#/components/responses/BadRequest"}},"operationId":"list-users","description":"Returns a paginated list of user objects.","parameters":[{"$ref":"#/components/parameters/PageSize"},{"$ref":"#/components/parameters/PageNumber"},{"schema":{"type":"string","example":"filter[active]=true"},"in":"query","name":"filter[field]","description":"A field to filter on. Supported fields: id, email, full_name, active"}]}},"/users/{userId}":{"parameters":[{"schema":{"type":"string","format":"uuid","example":"d32d905a-ed33-46a3-a093-d8f536af9a8a"},"name":"userId","in":"path","required":true,"description":"The ID of the user being deleted."}],"get":{"summary":"Fetch User","tags":["Users"],"responses":{"200":{"$ref":"#/components/responses/UserSingle"},"400":{"$ref":"#/components/responses/BadRequest"},"404":{"$ref":"#/components/responses/NotFound"}},"operationId":"get-user","description":"Returns the user object for the user ID specified as a path parameter."},"patch":{"summary":"Update User","operationId":"update-user","responses":{"200":{"$ref":"#/components/responses/UserSingle"},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/PermissionDenied"},"404":{"$ref":"#/components/responses/NotFound"}},"description":"Update an individual user.","requestBody":{"$ref":"#/components/requestBodies/UpdateUser"},"tags":["Users"]},"delete":{"summary":"Delete User","operationId":"delete-user","responses":{"204":{"description":"No Content"}},"description":"Delete an individual user.","tags":["Users"]}},"/users/{userId}/teams":{"parameters":[{"schema":{"type":"string","example":"d32d905a-ed33-46a3-a093-d8f536af9a8a","format":"uuid"},"name":"userId","in":"path","required":true,"description":"The user ID."}],"get":{"summary":"List User Teams","responses":{"200":{"$ref":"#/components/responses/TeamCollection"},"404":{"$ref":"#/components/responses/NotFound"}},"operationId":"list-user-teams","description":"Returns a paginated list of a teams that the belong to the user ID parameter.","parameters":[{"$ref":"#/components/parameters/PageSize"},{"$ref":"#/components/parameters/PageNumber"}],"tags":["Team Membership"]}},"/users/{userId}/assigned-roles":{"parameters":[{"schema":{"type":"string","format":"uuid","example":"e81bc3e5-e9db-4764-b7dd-e81e39072cbe"},"name":"userId","in":"path","required":true,"description":"The user ID"}],"get":{"summary":"List User Roles","tags":["Roles"],"responses":{"200":{"$ref":"#/components/responses/AssignedRoleCollection"},"404":{"$ref":"#/components/responses/NotFound"}},"operationId":"list-user-roles","description":"List the roles assigned to a user.","parameters":[{"schema":{"type":"string"},"in":"query","name":"filter[field]","description":"A field to filter on. Supported fields: role_name, entity_type_name"}]},"post":{"summary":"Assign Role","operationId":"users-assign-role","responses":{"201":{"$ref":"#/components/responses/AssignedRoleSingle"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/PermissionDenied"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/NotFound"}},"description":"Assign a role to a user. Returns 409 if role is already assigned.","requestBody":{"$ref":"#/components/requestBodies/AssignRole"},"tags":["Roles"]}},"/users/{userId}/assigned-roles/{roleId}":{"parameters":[{"schema":{"type":"string","format":"uuid","example":"e81bc3e5-e9db-4764-b7dd-e81e39072cbe"},"name":"userId","in":"path","required":true},{"schema":{"type":"string","example":"8350205f-a305-4e39-abe9-bc082a80091a","format":"uuid"},"name":"roleId","in":"path","required":true}],"delete":{"summary":"Remove Role","operationId":"users-remove-role","responses":{"204":{"description":"No Content"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthenticated"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Roles"],"description":"Remove an assigned role from a user."}}},"components":{"parameters":{"PageSize":{"name":"page[size]","description":"How many items to include in a page.","in":"query","required":false,"schema":{"type":"integer","example":10},"allowEmptyValue":true},"PageNumber":{"name":"page[number]","description":"The specific page number in the collection results.","in":"query","required":false,"schema":{"type":"integer","example":2},"allowEmptyValue":true}},"responses":{"UserSingle":{"description":"A get action response of a single user.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/User"},"examples":{"Example":{"$ref":"#/components/examples/Get-User-Response"}}}}},"UserCollection":{"description":"A paginated list response for a collection of users.","content":{"application/json":{"schema":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/PaginatedMeta"},"data":{"type":"array","items":{"$ref":"#/components/schemas/User"}}}},"examples":{"User Collection Response":{"$ref":"#/components/examples/user-collection-response-example"}}}}},"TeamSingle":{"description":"A response including a single team.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Team"},"examples":{"Single team response":{"$ref":"#/components/examples/single-team-response"}}}}},"TeamCollection":{"description":"A paginated list response for a collection of users.","content":{"application/json":{"schema":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/PaginatedMeta"},"data":{"type":"array","items":{"$ref":"#/components/schemas/Team"}}}},"examples":{"Team Collection":{"value":{"meta":{"page":{"number":2,"size":1,"total":10}},"data":[{"id":"7f9fd312-a987-4628-b4c5-bb4f4fddd5f7","name":"IDM - Developers","description":"The developers for the IDM API.","system_team":false,"created_at":"2022-02-07T17:46:57.52Z","updated_at":"2022-09-25T13:00:00.00Z"}]}}}}}},"TeamMappingCollection":{"description":"A paginated list response for a collection of team mappings.","content":{"application/json":{"schema":{"type":"object","properties":{"mappings":{"type":"array","items":{"$ref":"#/components/schemas/TeamMapping"}}}},"examples":{"Team Mapping Collection":{"$ref":"#/components/examples/team-mapping-collection"}}}}},"AssignedRoleSingle":{"description":"A get action response of a single assigned role.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AssignedRole"},"examples":{"Assigned Role Example":{"$ref":"#/components/examples/Assigned-Role-Example"}}}}},"AssignedRoleCollection":{"description":"A paginated list response for a collection of assigned roles.","content":{"application/json":{"schema":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/PaginatedMeta"},"data":{"type":"array","description":"An Array","items":{"$ref":"#/components/schemas/AssignedRole"}}}},"examples":{"CollectionExample":{"$ref":"#/components/examples/collection-example"}}}}},"BadRequest":{"description":"Bad Request","content":{"application/problem+json":{"schema":{"type":"object","description":"The error object","properties":{"status":{"type":"integer","description":"The HTTP response code","example":400},"title":{"type":"string","example":"Bad Request","description":"The Error response"},"instance":{"type":"string","description":"The Konnect traceback ID.","example":"konnect:trace:3674017986744198214"},"invalid_parameters":{"type":"array","description":"An array of objects that contains information related to the error response.","items":{"type":"object","properties":{"field":{"type":"string"},"reason":{"type":"string"}}}}}},"examples":{"Request Format is Invalid":{"$ref":"#/components/examples/400-request-format-is-invalid"},"Cannot be Blank":{"$ref":"#/components/examples/400-cannot-be-blank"},"Invalid ID format":{"$ref":"#/components/examples/400-invalid-id-format"},"Must be a valid UUID v4":{"$ref":"#/components/examples/400-valid-uuid"},"System teams cannot be modified":{"$ref":"#/components/examples/400-systems-team-modified"}}}}},"Conflict":{"description":"Conflict","content":{"application/problem+json":{"schema":{"type":"object","description":"The error object","properties":{"status":{"type":"integer","description":"The HTTP response code","example":409},"title":{"type":"string","example":"Resource Conflict","description":"The Error response"},"instance":{"type":"string","description":"The Konnect traceback ID.","example":"konnect:trace:3674017986744198214"},"detail":{"type":"string","description":"Detailed explanation of the error response.","example":"User is already active"}}},"examples":{"User is Already Active":{"$ref":"#/components/examples/409-user-is-already-active"}}}}},"PermissionDenied":{"description":"Permission denied","content":{"application/problem+json":{"schema":{"type":"object","x-examples":{"Example 1":{"status":403,"title":"Permission denied","instance":"konnect:trace:2822394689570210664","detail":"Only enterprise organizations can create teams"}},"description":"The error object.","properties":{"status":{"type":"integer","description":"HTTP status code.","example":403},"title":{"type":"string","example":"Bad Request","description":"HTTP status code"},"instance":{"type":"string","description":"Konnect traceback error code.","example":"konnect:trace:3674017986744198214"},"detail":{"type":"string","description":"Information about the error response.","example":"Only enterprise organizations can create teams"}}},"examples":{"Permission Denied":{"$ref":"#/components/examples/403-permission-denied"},"Invalid Permissions":{"$ref":"#/components/examples/403-invalid-permissions"},"Username or Password invalid":{"$ref":"#/components/examples/403-auth-invalid"}}}}},"PreconditionFailed":{"description":"Precondition Failed","content":{"application/problem+json":{"schema":{"type":"object","x-examples":{"Example 1":{"status":412,"title":"Precondition Failed","instance":"konnect:trace:1896611024257578096","detail":"IdP configuration not found"}},"description":"The error response object.","properties":{"status":{"type":"integer","description":"The HTTP status code.","example":412},"title":{"type":"string","description":"The error response code.","example":"Precondition Failed"},"instance":{"type":"string","description":"The Konnect traceback code.","example":"konnect:trace:1896611024257578096"},"detail":{"type":"string","description":"Details about the error response.","example":"IdP configuration not found"}}},"examples":{"Precondition Failed":{"$ref":"#/components/examples/412-precondition-failed"}}},"multipart/form-data":{"schema":{"type":"object","x-examples":{"Example 1":{"status":412,"title":"Precondition Failed","instance":"konnect:trace:1896611024257578096","detail":"IdP configuration not found"}},"description":"The error response object.","properties":{"status":{"type":"integer","description":"The HTTP status code.","example":412},"title":{"type":"string","description":"The Error Response.","example":"Precondition Failed"},"instance":{"type":"string","description":"The Konnect traceback code.","example":"konnect:trace:1896611024257578096"},"detail":{"type":"string","description":"Detailed explanation of the error response.","example":"IdP configuration not found"}}},"examples":{"IdP configuration not found":{"value":{"status":412,"title":"Precondition Failed","instance":"konnect:trace:1896611024257578096","detail":"IdP configuration not found"}}}}}},"RateLimited":{"description":"Rate Limited","content":{"application/problem+json":{"schema":{"type":"object","description":"The error object","properties":{"status":{"type":"integer","description":"The HTTP response code","example":429},"title":{"type":"string","example":"Rate Limited","description":"The Error response"},"instance":{"type":"string","description":"The Konnect traceback ID.","example":"konnect:trace:3674017986744198214"},"detail":{"type":"string","description":"Detailed explanation of the error response.","example":"Too many requests"}}},"examples":{"Rate Limited":{"$ref":"#/components/examples/429-rate-limited"}}}}},"Unauthenticated":{"description":"Unauthenticated","content":{"application/problem+json":{"schema":{"type":"object","x-examples":{"Example 1":{"status":401,"title":"Unauthenticated","instance":"konnect:trace:952172606039454040","detail":"A valid token is required"}},"description":"The error response object.","properties":{"status":{"type":"integer","example":401,"description":"The HTTP status code."},"title":{"type":"string","description":"The Error Response.","example":"Unauthenticated"},"instance":{"type":"string","description":"The Konnect traceback code.","example":"konnect:trace:952172606039454040"},"detail":{"type":"string","description":"Details about the error response.","example":"A valid token is required"}}},"examples":{"Unauthorized":{"$ref":"#/components/examples/401-unauthenticated"}}}}},"NotFound":{"description":"Not Found","content":{"application/problem+json":{"schema":{"type":"object","x-examples":{"Example 1":{"status":404,"title":"Not Found","instance":"konnect:trace:2287285207635123011","detail":"The requested team was not found"}},"description":"The error response object.","properties":{"status":{"type":"integer","description":"The HTTP status code.","example":404},"title":{"type":"string","description":"The error response code.","example":"Not Found"},"instance":{"type":"string","example":"konnect:trace:2287285207635123011","description":"The Konnect traceback code"},"detail":{"type":"string","example":"The requested team was not found","description":"Details about the error."}}},"examples":{"Not Found":{"$ref":"#/components/examples/404-not-found"}}}}},"TeamMappingResponse":{"description":"A paginated list response for a collection of team mappings.","content":{"application/json":{"schema":{"type":"object","x-examples":{"Example 1":{"meta":{"page":{"number":1,"size":10,"total":6}},"data":[{"group":"111(@&*$)(@*#_@(gfds re gdsf dfg","team_ids":["c0010105-e840-4824-b7ee-787f22267c36"]},{"group":"2222","team_ids":["af91db4c-6e51-403e-a2bf-33d27ae50c0a"]},{"group":"group1","team_ids":["3df49db8-39ff-490d-9fe1-251a3361fb13"]},{"group":"group2","team_ids":["3df49db8-39ff-490d-9fe1-251a3361fb13","73e6d38a-424d-4217-91af-70cbd7e9e38c"]},{"group":"group3","team_ids":["73e6d38a-424d-4217-91af-70cbd7e9e38c","8cc1d620-49ce-4fb8-ae18-e394f34faafc","3df49db8-39ff-490d-9fe1-251a3361fb13"]},{"group":"group4","team_ids":["93d6d4d5-0d76-4379-b62b-1fcdc78b1563","3df49db8-39ff-490d-9fe1-251a3361fb13","73e6d38a-424d-4217-91af-70cbd7e9e38c","8cc1d620-49ce-4fb8-ae18-e394f34faafc"]}]}},"properties":{"meta":{"type":"object","description":"Contains pagination data.","properties":{"page":{"type":"object","description":"The page object.","properties":{"number":{"type":"integer","description":"Page number.","example":1},"size":{"type":"integer","description":"Page size.","example":9},"total":{"type":"integer","description":"Total number of results.","example":5}}}}},"data":{"type":"array","items":{"type":"object","properties":{"group":{"type":"string","description":"Group names.","example":"111(@&*$)(@*#_@(gfds re gdsf dfg"},"team_ids":{"type":"array","description":"Team ID's that belong to the specified group.","items":{"type":"string","example":"3df49db8-39ff-490d-9fe1-251a3361fb13"}}}}}}},"examples":{"Group Collection":{"$ref":"#/components/examples/group-collection-example"}}}}},"Roles":{"description":"The predefined, or system managed, roles.","content":{"application/json":{"schema":{"type":"object","properties":{"runtime_groups":{"type":"object","additionalProperties":false,"required":["name","roles"],"properties":{"name":{"type":"string","enum":["Runtime Groups"]},"roles":{"type":"object","properties":{"admin":{"type":"object","additionalProperties":false,"required":["name","description"],"properties":{"name":{"type":"string","enum":["Admin"]},"description":{"type":"string","example":"This role grants full write access to all entities within a runtime group.","enum":["This role grants full write access to all entities within a runtime group."]}}},"certificate_admin":{"type":"object","additionalProperties":false,"required":["name","description"],"properties":{"name":{"type":"string","enum":["Certificate Admin"]},"description":{"type":"string","example":"This role grants full write access to administer certificates.","enum":["This role grants full write access to administer certificates."]}}},"consumer_admin":{"type":"object","additionalProperties":false,"required":["name","description"],"properties":{"name":{"type":"string","enum":["Consumer Admin"]},"description":{"type":"string","example":"This role grants full write access to administer consumers.","enum":["This role grants full write access to administer consumers."]}}},"creator":{"type":"object","additionalProperties":false,"required":["name","description"],"properties":{"name":{"type":"string","enum":["Creator"]},"description":{"type":"string","example":"Creates a new Runtime Group in an organization. The creator becomes the owner of the Runtimegroup they create.","enum":["Creates a new Runtime Group in an organization. The creator becomes the owner of the Runtimegroup they create."]}}},"deployer":{"type":"object","additionalProperties":false,"required":["name","description"],"properties":{"name":{"type":"string","enum":["Deployer"]},"description":{"type":"string","example":"This role grants full write access to administer services, routes and plugins necessary to deploy services in Service Hub.","enum":["This role grants full write access to administer services, routes and plugins necessary to deploy services in Service Hub."]}}},"gateway_service_admin":{"type":"object","additionalProperties":false,"required":["name","description"],"properties":{"name":{"type":"string","enum":["Gateway Service Admin"]},"description":{"type":"string","example":"This role grants full write access to administer gateway services.","enum":["This role grants full write access to administer gateway services."]}}},"plugin_admin":{"type":"object","additionalProperties":false,"required":["name","description"],"properties":{"name":{"type":"string","enum":["Plugin Admin"]},"description":{"type":"string","example":"This role grants full write access to administer plugins.","enum":["This role grants full write access to administer plugins."]}}},"route_admin":{"type":"object","additionalProperties":false,"required":["name","description"],"properties":{"name":{"type":"string","enum":["Route Admin"]},"description":{"type":"string","example":"This role grants full write access to administer routes.","enum":["This role grants full write access to administer routes."]}}},"sni_admin":{"type":"object","additionalProperties":false,"required":["name","description"],"properties":{"name":{"type":"string","enum":["SNI Admin"]},"description":{"type":"string","example":"This role grants full write access to administer SNIs.","enum":["This role grants full write access to administer SNIs."]}}},"upstream_admin":{"type":"object","additionalProperties":false,"required":["name","description"],"properties":{"name":{"type":"string","enum":["Upstream Admin"]},"description":{"type":"string","example":"This role grants full write access to administer upstreams.","enum":["This role grants full write access to administer upstreams."]}}},"viewer":{"type":"object","additionalProperties":false,"required":["name","description"],"properties":{"name":{"type":"string","enum":["Viewer"]},"description":{"type":"string","example":"This role grants read only access to all entities within a runtime group.","enum":["This role grants read only access to all entities within a runtime group."]}}}}}}},"services":{"type":"object","additionalProperties":false,"required":["name","roles"],"properties":{"name":{"type":"string","enum":["Services"]},"roles":{"type":"object","properties":{"admin":{"type":"object","additionalProperties":false,"required":["name","description"],"properties":{"name":{"type":"string","enum":["Admin"]},"description":{"type":"string","example":"Admin of an existing Service. The admins have all write access permissions related to a Service, service version, service package etc.","enum":["Admin of an existing Service. The admins have all write access permissions related to a Service, service version, service package etc."]}}},"application_registration":{"type":"object","additionalProperties":false,"required":["name","description"],"properties":{"name":{"type":"string","enum":["Application Registration"]},"description":{"type":"string","example":"This role grants permission to enable and disable application registration on a service.","enum":["This role grants permission to enable and disable application registration on a service."]}}},"creator":{"type":"object","additionalProperties":false,"required":["name","description"],"properties":{"name":{"type":"string","enum":["Creator"]},"description":{"type":"string","example":"This access is required to create a service. In addition the creators are granted Admin access to the service they create. This access is not for creating sub-entities such as service versions, implementations, API specs etc.","enum":["This access is required to create a service. In addition the creators are granted Admin access to the service they create. This access is not for creating sub-entities such as service versions, implementations, API specs etc."]}}},"deployer":{"type":"object","additionalProperties":false,"required":["name","description"],"properties":{"name":{"type":"string","enum":["Deployer"]},"description":{"type":"string","example":"This role grants permission to deploy and remove a service from a runtime group.","enum":["This role grants permission to deploy and remove a service from a runtime group."]}}},"maintainer":{"type":"object","additionalProperties":false,"required":["name","description"],"properties":{"name":{"type":"string","enum":["Maintainer"]},"description":{"type":"string","example":"This role grants all write permission to manage a service and to administer plugins.","enum":["This role grants all write permission to manage a service and to administer plugins."]}}},"plugins_admin":{"type":"object","additionalProperties":false,"required":["name","description"],"properties":{"name":{"type":"string","enum":["Plugins Admin"]},"description":{"type":"string","example":"This role grants full write permission to administer plugins.","enum":["This role grants full write permission to administer plugins."]}}},"publisher":{"type":"object","additionalProperties":false,"required":["name","description"],"properties":{"name":{"type":"string","enum":["Publisher"]},"description":{"type":"string","example":"This role grants permission to publish a service to one or more portals.","enum":["This role grants permission to publish a service to one or more portals."]}}},"viewer":{"type":"object","additionalProperties":false,"required":["name","description"],"properties":{"name":{"type":"string","enum":["Viewer"]},"description":{"type":"string","example":"Viewer has read-only access to all the configurations of a service, attributes, versions, reports, vitals and plugins.","enum":["Viewer has read-only access to all the configurations of a service, attributes, versions, reports, vitals and plugins."]}}}}}}}}},"examples":{"Predefined Roles":{"value":{"runtime_groups":{"name":"Runtime Groups","roles":{"admin":{"name":"Admin","description":"This role grants full write access to all entities within a runtime group."},"certificate_admin":{"name":"Certificate Admin","description":"This role grants full write access to administer certificates."},"consumer_admin":{"name":"Consumer Admin","description":"This role grants full write access to administer consumers."},"creator":{"name":"Creator","description":"Creates a new Runtime Group in an organization. The creator becomes the owner of the Runtimegroup they create."},"deployer":{"name":"Deployer","description":"This role grants full write access to administer services, routes and plugins necessary to deploy services in Service Hub."},"gateway_service_admin":{"name":"Gateway Service Admin","description":"This role grants full write access to administer gateway services."},"plugin_admin":{"name":"Plugin Admin","description":"This role grants full write access to administer plugins."},"route_admin":{"name":"Route Admin","description":"This role grants full write access to administer routes."},"sni_admin":{"name":"SNI Admin","description":"This role grants full write access to administer SNIs."},"upstream_admin":{"name":"Upstream Admin","description":"This role grants full write access to administer upstreams."},"viewer":{"name":"Viewer","description":"This role grants read only access to all entities within a runtime group."}}},"services":{"name":"Services","roles":{"admin":{"name":"Admin","description":"Admin of an existing Service. The admins have all write access permissions related to a Service, service version, service package etc."},"application_registration":{"name":"Application Registration","description":"This role grants permission to enable and disable application registration on a service."},"creator":{"name":"Creator","description":"This access is required to create a service. In addition the creators are granted Admin access to the service they create. This access is not for creating sub-entities such as service versions, implementations, API specs etc."},"deployer":{"name":"Deployer","description":"This role grants permission to deploy and remove a service from a runtime group."},"maintainer":{"name":"Maintainer","description":"This role grants all write permission to manage a service and to administer plugins."},"plugins_admin":{"name":"Plugins Admin","description":"This role grants full write permission to administer plugins."},"publisher":{"name":"Publisher","description":"This role grants permission to publish a service to one or more portals."},"viewer":{"name":"Viewer","description":"Viewer has read-only access to all the configurations of a service, attributes, versions, reports, vitals and plugins."}}}}}}}}}},"requestBodies":{"UpdateUser":{"description":"The request schema for the update user request.","content":{"application/json":{"schema":{"type":"object","properties":{"full_name":{"type":"string","pattern":"^[\\w \\W]+$","example":"James C. Woods","description":"The user's full name.","writeOnly":true},"preferred_name":{"type":"string","maxLength":250,"example":"Jimmy","description":"The user's desired name.","writeOnly":true}}},"examples":{"Example Request Body":{"$ref":"#/components/examples/Update-User-Request"}}}}},"CreateTeam":{"description":"The request schema for the create team request.\n\nIf you pass the same `name` and `description` of an existing team in the request, a team with the same `name` and `description` will be created. The two teams will have different `team_id` values to differntiate them.","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","example":"IDM - Developers","pattern":"^[\\w \\W]+$","description":"A name for the team being created.","writeOnly":true},"description":{"type":"string","maxLength":250,"example":"The Identity Management (IDM) team.","description":"The description of the new team.","writeOnly":true}},"required":["name"]},"examples":{"Example Request Body":{"$ref":"#/components/examples/CreateTeamExample"}}}}},"UpdateTeam":{"description":"The request schema for the update team request.","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","example":"IDM - Developers","pattern":"^[\\w \\W]+$","description":"The name of the team.","writeOnly":true},"description":{"type":"string","maxLength":250,"example":"The Identity Management (IDM) API team.","description":"The description of the team.","writeOnly":true}}},"examples":{"Example Request Body":{"$ref":"#/components/examples/Update-Team-Request"}}}}},"AddUserToTeam":{"description":"The request schema for adding a user to a team.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":"df120cb4-f60b-47bc-a2f8-6a28e6a3c63b","format":"uuid","description":"The user ID for the user being added to a team.","writeOnly":true}},"required":["id"]},"examples":{"Example request body":{"$ref":"#/components/examples/Add-User-Request"}}}}},"UpdateTeamMappings":{"content":{"application/json":{"schema":{"type":"object","x-examples":{"Example 1":{"mappings":[{"group":"Service Developers","team_ids":["af91db4c-6e51-403e-a2bf-33d27ae50c0a"]}]}},"properties":{"mappings":{"type":"array","description":"The mappings object.","items":{"type":"object","properties":{"group":{"type":"string"},"team_ids":{"type":"array","items":{"type":"string"}}}}}}},"examples":{"Example Request Body":{"$ref":"#/components/examples/Update-Team-Mappings"}}}},"description":"The request schema for updating IdP team mappings."},"AssignRole":{"content":{"application/json":{"schema":{"type":"object","description":"An assigned role is a role that has been assigned to a user or team.","x-examples":{"US Example":{"id":"11e342b4-cdc4-463c-b47c-78ff927e7514","role_name":"Viewer","entity_id":"18ee2573-dec0-4b83-be99-fa7700bcdc61","entity_type_name":"Runtime Groups","entity_region":"us"},"All Regions Example":{"id":"8f7fff49-de9d-4a77-8669-33216744ce2d","role_name":"Admin","entity_id":"18ee2573-dec0-4b83-be99-fa7700bcdc61","entity_type_name":"Reports","entity_region":"*"}},"properties":{"role_name":{"type":"string","example":"Viewer","description":"The desired role."},"entity_id":{"type":"string","format":"uuid","example":"e67490ce-44dc-4cbd-b65e-b52c746fc26a","description":"The ID of the entity."},"entity_type_name":{"type":"string","example":"Runtime Groups","description":"The type of entity."},"entity_region":{"type":"string","enum":["us","eu","*"],"example":"eu","description":"The region of the team."}}},"examples":{"Assigned Roles US":{"$ref":"#/components/examples/Assign-Roles-US"},"Assigned Roles Global":{"$ref":"#/components/examples/Assign-Roles-Global"}}}},"description":"Assign a role to a user or a team."},"AcceptInvite":{"content":{"application/json":{"schema":{"type":"object","properties":{"password":{"type":"string","example":"TestPassword123!!","format":"password","writeOnly":true,"description":"Sets the password for the user."},"full_name":{"type":"string","example":"James C. Woods","writeOnly":true,"description":"Full name of the user."},"preferred_name":{"type":"string","example":"Tiger","description":"Preferred name of the user."},"token":{"type":"string","format":"uuid","example":"7690d649-86fc-4d10-8771-c094d2efbd85","writeOnly":true,"description":"The one time token in accept-invitation link."}},"required":["password","full_name","preferred_name","token"]}}},"description":"The request schema for the accept invite request."},"InviteUser":{"content":{"application/json":{"schema":{"type":"object","properties":{"email":{"type":"string","format":"email","example":"james.c.woods@example.com","writeOnly":true}},"required":["email"]}}},"description":"The request schema for the invite user request.\n\nIf you pass an `email` that is not already an active user in the request, a fresh invitation email will be created and sent to the new user."}},"schemas":{"PaginatedMeta":{"type":"object","x-examples":{"example-1":{"page":{"number":2,"size":10,"total":100}}},"title":"PaginatedMeta","description":"Returns pagination information","properties":{"page":{"type":"object","description":"Contains pagination query parameters and the total number of objects returned.","properties":{"number":{"type":"integer","example":2,"description":"Specifies the number of objects returned per page."},"size":{"type":"integer","example":10,"maximum":100,"description":"Specifies the size of the page."},"total":{"type":"integer","maximum":1000,"example":100,"description":"Integer representation of the amount of items returned."}}}}},"User":{"title":"User","type":"object","description":"The user object contains information about an individual user who can use the Konnect application and API.","x-examples":{"Example":{"id":"7f9fd312-a987-4628-b4c5-bb4f4fddd5f7","email":"user@email.com","full_name":"Test User","preferred_name":"test","active":true,"created_at":"2022-02-07T17:46:57.52Z","updated_at":"2022-10-08T17:00:00.52Z"}},"properties":{"id":{"type":"string","format":"uuid","example":"7f9fd312-a987-4628-b4c5-bb4f4fddd5f7","description":"The User ID.","readOnly":true},"email":{"type":"string","format":"email","example":"user@email.com","maxLength":250,"description":"The email registered to the user."},"full_name":{"type":"string","pattern":"^[\\w \\W]+$","maxLength":250,"description":"The User's full name.","example":"Jane Doe"},"preferred_name":{"type":"string","example":"Jane","maxLength":250,"description":"The User's preffered name."},"active":{"type":"boolean","default":true,"description":"Returns True if a user has verified their email address.","readOnly":true},"created_at":{"type":"string","format":"date-time","example":"2022-02-07T17:46:57.52Z","description":"The time stamp for the date the account was registered.","readOnly":true},"updated_at":{"type":"string","format":"date-time","example":"2022-10-08T17:00:00.52Z","description":"A Unix timestamp representation of the most recent change to the User account.","readOnly":true}}},"Team":{"title":"Team","type":"object","description":"The team object contains information about a group of users.","x-examples":{"Example":{"id":"7f9fd312-a987-4628-b4c5-bb4f4fddd5f7","name":"IDM - Developers","description":"The developers for the IDM API.","system_team":false,"created_at":"1992-02-07T17:46:57.52Z","updated_at":"2022-08-31T17:00:00.52Z"}},"properties":{"id":{"type":"string","format":"uuid","example":"7f9fd312-a987-4628-b4c5-bb4f4fddd5f7","description":"The team ID.","readOnly":true},"name":{"type":"string","pattern":"^[\\w \\W]+$","example":"IDM - Developers","maxLength":250,"description":"The name of the team."},"description":{"type":"string","example":"The developers for the IDM API.","maxLength":250,"description":"The team description in Konnect."},"system_team":{"type":"boolean","default":false,"description":"Returns True if a user belongs to a `system_team`. System teams are teams that can manage Konnect objects, like \"Organization Admin\", or \"Service","readOnly":true},"created_at":{"type":"string","format":"date-time","example":"1992-02-07T17:46:57.52Z","description":"A Unix timestamp representation of team creation.","readOnly":true},"updated_at":{"type":"string","format":"date-time","example":"2022-02-07T17:00:00.52Z","description":"A Unix timestamp representation of the most recent change to the team object in Konnect.\n","readOnly":true}}},"TeamMapping":{"title":"TeamMapping","type":"object","description":"A team assignment is a mapping of an IdP group to a Konnect Team.","x-examples":{"Example":{"group":"Service Developers","team_ids":["6801e673-cc10-498a-94cd-4271de07a0d3"]}},"properties":{"group":{"type":"string","example":"Service Developers","description":"The IdP group."},"team_ids":{"type":"array","uniqueItems":true,"description":"An array of ID's that are mapped to the specified group.","items":{"type":"string","format":"uuid","example":"6801e673-cc10-498a-94cd-4271de07a0d3"}}}},"AssignedRole":{"title":"AssignedRole","type":"object","description":"An assigned role is a role that has been assigned to a user or team.","x-examples":{"US Example":{"id":"54cc6168-ebb1-4300-8168-d62a0dd08fc8","role_name":"Viewer","entity_id":"18ee2573-dec0-4b83-be99-fa7700bcdc61","entity_type_name":"Runtime Groups","entity_region":"us"},"All Regions Example":{"id":"745bc744-7a3d-46c0-a9ea-04302e44fb44","role_name":"Admin","entity_id":"18ee2573-dec0-4b83-be99-fa7700bcdc61","entity_type_name":"Services","entity_region":"*"}},"properties":{"id":{"type":"string","format":"uuid","example":"eaf7adf1-32c8-4bbf-b960-d1f8456afe67","description":"The ID of the role assignment."},"role_name":{"type":"string","example":"Viewer","description":"Name of the role being assigned."},"entity_id":{"type":"string","format":"uuid","example":"817d0422-45c9-4d88-8d64-45aef05c1ae7","description":"A RBAC entity ID."},"entity_type_name":{"type":"string","example":"Runtime Groups","description":"Name of the entity type the role is being assigned to."},"entity_region":{"type":"string","enum":["us","eu","*"],"example":"eu","description":"Region of the entity."}}}},"securitySchemes":{"personalAccessToken":{"type":"http","scheme":"bearer","bearerFormat":"Token","description":"You can generate a Personal Access Token (PAT) from the [personal access token page](https://cloud.konghq.com/global/tokens/) in the Konnect dashboard.\nThe PAT token must be passed in the header of a request, for example:\n `curl -X GET 'https://global.api.konghq.tech/v2/users/' --header 'Authorization: Bearer kpat_xgfT'`\n"}},"examples":{"400-request-format-is-invalid":{"value":{"status":400,"title":"Bad Request","instance":"konnect:trace:3674017986744198214","invalid_parameters":[{"field":"body","reason":"request format is invalid"}]}},"400-cannot-be-blank":{"value":{"status":400,"title":"Bad Request","instance":"konnect:trace:6644808935508571943","invalid_parameters":[{"field":"name","reason":"cannot be blank"}]}},"400-invalid-id-format":{"value":{"status":400,"title":"Bad Request","instance":"konnect:trace:8988732526256293040","invalid_parameters":[{"field":"teamID","reason":"invalid ID format"}]}},"400-valid-uuid":{"value":{"status":400,"title":"Bad Request","instance":"konnect:trace:7680390984800447837","invalid_parameters":[{"field":"id","reason":"must be a valid UUID v4"}]}},"400-systems-team-modified":{"value":{"status":400,"title":"Bad Request","instance":"konnect:trace:1738820719742148545","invalid_parameters":[{"field":"teamID","reason":"system teams cannot be modified"}]}},"404-not-found":{"value":{"status":404,"title":"Not Found","instance":"konnect:trace:2287285207635123011","detail":"The requested team was not found"}},"403-permission-denied":{"value":{"status":403,"title":"Permission denied","instance":"konnect:trace:2822394689570210664","detail":"Only enterprise organizations can create teams"}},"403-invalid-permissions":{"value":{"status":403,"title":"Invalid Permissions","detail":"You must have the [administrator] role to perform this action","instance":"konnect:trace:6c1ef33ae5bce33634d7d7d695c7f203"}},"403-auth-invalid":{"value":{"type":"https://kongapi.info/konnect/invalid-permissions","status":403,"title":"Invalid Permissions","detail":"You must have the [administrator] role to perform this action","instance":"konnect:trace:6c1ef33ae5bce33634d7d7d695c7f203"}},"409-user-is-already-active":{"value":{"status":409,"title":"Resource Conflict","instance":"konnect:trace:6644808935508571943","detail":"User is already active"}},"412-precondition-failed":{"value":{"status":412,"title":"Precondition Failed","instance":"konnect:trace:1896611024257578096","detail":"IdP configuration not found"}},"429-rate-limited":{"value":{"status":429,"title":"Rate Limited","instance":"konnect:trace:6644808935508571943","detail":"Too many requests"}},"collection-example":{"value":{"meta":{"page":{"number":2,"size":10,"total":100}},"data":[{"id":"b02e23c5-8ee4-4e5a-99f4-43329923adcd","role_name":"Viewer","entity_id":"437c7192-fea0-4f35-8478-c8d57783f8c1","entity_type_name":"Runtime Groups","entity_region":"eu"},{"id":"869d9402-f117-4f9a-840f-69acaf70a81a","role_name":"Admin","entity_id":"18ee2573-dec0-4b83-be99-fa7700bcdc61","entity_type_name":"Services","entity_region":"*"}]}},"Assigned-Role-Example":{"value":{"id":"eaf7adf1-32c8-4bbf-b960-d1f8456afe67","role_name":"Viewer","entity_id":"817d0422-45c9-4d88-8d64-45aef05c1ae7","entity_type_name":"Runtime Groups","entity_region":"eu"}},"group-collection-example":{"value":{"meta":{"page":{"number":1,"size":10,"total":6}},"data":[{"group":"111(@&*$)(@*#_@(gfds re gdsf dfg","team_ids":["c0010105-e840-4824-b7ee-787f22267c36"]},{"group":"2222","team_ids":["af91db4c-6e51-403e-a2bf-33d27ae50c0a"]}]}},"single-team-response":{"value":{"id":"7f9fd312-a987-4628-b4c5-bb4f4fddd5f7","name":"IDM - Developers","description":"The developers for the IDM API.","system_team":false,"created_at":"2022-02-07T17:46:57.52Z","updated_at":"2022-09-25T13:00:00.00Z"}},"team-mapping-collection":{"value":{"mappings":[{"group":"Service Developers","team_ids":["6801e673-cc10-498a-94cd-4271de07a0d3"]}]}},"401-unauthenticated":{"value":{"status":401,"title":"Unauthenticated","instance":"konnect:trace:952172606039454040","detail":"A valid token is required"}},"user-collection-response-example":{"value":{"meta":{"page":{"number":2,"size":1,"total":10}},"data":[{"id":"7f9fd312-a987-4628-b4c5-bb4f4fddd5f7","email":"james.woods@email.com","full_name":"James Woods","preferred_name":"Jimmy","active":true,"created_at":"2022-08-17T17:46:57.52Z","updated_at":"2022-10-03T17:00:00.00Z"}]}},"Get-User-Response":{"value":{"id":"7f9fd312-a987-4628-b4c5-bb4f4fddd5f7","email":"james.woods@email.com","full_name":"James Woods","preferred_name":"Jimmy","active":true,"created_at":"1992-02-07T17:46:57.52Z","updated_at":"2022-02-07T17:00:00.52Z"}},"Assign-Roles-US":{"value":{"role_name":"Viewer","entity_id":"18ee2573-dec0-4b83-be99-fa7700bcdc61","entity_type_name":"runtime_groups","entity_region":"us"}},"Assign-Roles-Global":{"value":{"role_name":"Admin","entity_id":"18ee2573-dec0-4b83-be99-fa7700bcdc61","entity_type_name":"services","entity_region":"*"}},"CreateTeamExample":{"value":{"name":"IDM - Developers","description":"The Identity Management (IDM) team."}},"Update-Team-Request":{"value":{"name":"IDM - Developers","description":"The Identity Management (IDM) API team."}},"Update-Team-Mappings":{"value":{"mappings":[{"group":"Service Developers","team_ids":["af91db4c-6e51-403e-a2bf-33d27ae50c0a"]}]}},"Update-User-Request":{"value":{"full_name":"James C Woods","preferred_name":"Jimmy"}},"Add-User-Request":{"value":{"id":"df120cb4-f60b-47bc-a2f8-6a28e6a3c63b"}}}},"security":[{"personalAccessToken":[]}],"tags":[{"name":"IdPs"},{"name":"Invites"},{"name":"Roles"},{"name":"Team Membership"},{"name":"Teams"},{"name":"Users"}]}
/ accept-invite
/ invites
/ identity-provider / team-mappings
/ roles
/ teams
/ teams / {teamId} / users
/ teams / {teamId}
/ teams / {teamId} / users / {userId}
/ teams / {teamId} / assigned-roles
/ teams / {teamId} / assigned-roles / {roleId}
/ users
/ users / {userId}
/ users / {userId} / teams
/ users / {userId} / assigned-roles
/ users / {userId} / assigned-roles / {roleId}
Kong Admin API OpenAPI	{"openapi":"3.1.0","components":{"schemas":{"upstreams":{"type":"object","properties":{"slots":{"type":"integer","default":10000},"algorithm":{"type":"string","default":"round-robin"},"hash_on":{"type":"string","default":"none"},"hash_fallback":{"type":"string","default":"none"},"hash_on_header":{"type":"string"},"hash_fallback_header":{"type":"string"},"hash_on_cookie":{"type":"string"},"hash_on_cookie_path":{"type":"string","default":"/"},"hash_on_query_arg":{"type":"string"},"name":{"type":"string"},"hash_on_uri_capture":{"type":"string"},"client_certificate":{"$ref":"#/components/schemas/certificates"},"hash_fallback_uri_capture":{"type":"string"},"tags":{"type":"array"},"host_header":{"type":"string"},"id":{"type":"string","format":"uuid"},"healthchecks":{"type":"array","default":{"passive":{"type":"http","healthy":{"successes":0,"http_statuses":[200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308]},"unhealthy":{"tcp_failures":0,"timeouts":0,"http_failures":0,"http_statuses":[429,500,503]}},"active":{"timeout":1,"type":"http","concurrency":10,"http_path":"/","healthy":{"successes":0,"interval":0,"http_statuses":[200,302]},"https_verify_certificate":true,"unhealthy":{"tcp_failures":0,"timeouts":0,"http_failures":0,"interval":0,"http_statuses":[429,404,500,501,502,503,504,505]}}}},"created_at":{"type":"integer","format":"int32"},"hash_fallback_query_arg":{"type":"string"}},"required":["name"]},"clustering_data_planes":{"type":"object","properties":{"ip":{"type":"string"},"sync_status":{"type":"string","default":"unknown"},"hostname":{"type":"string"},"version":{"type":"string"},"last_seen":{"type":"integer","format":"int32"},"config_hash":{"type":"string"},"id":{"type":"string"}},"required":["id","ip","hostname","sync_status"]},"parameters":{"type":"object","properties":{"key":{"type":"string"},"created_at":{"type":"integer","format":"int32"},"value":{"type":"string"}},"required":["key","value"]},"tags":{"type":"object","properties":{"entity_name":{"type":"string"},"tag":{"type":"string"},"entity_id":{"type":"string"}},"required":["tag","entity_name","entity_id"]},"vaults":{"type":"object","properties":{"config":{"type":"array"},"description":{"type":"string"},"updated_at":{"type":"integer","format":"int32"},"tags":{"type":"array"},"created_at":{"type":"integer","format":"int32"},"name":{"type":"string"},"prefix":{"type":"string"},"id":{"type":"string","format":"uuid"}},"required":["prefix","name"]},"targets":{"type":"object","properties":{"upstream":{"$ref":"#/components/schemas/upstreams"},"target":{"type":"string"},"tags":{"type":"array"},"weight":{"type":"integer","default":100},"created_at":{"type":"number","format":"float"},"id":{"type":"string","format":"uuid"}},"required":["upstream","target"]},"workspaces":{"type":"object","properties":{"config":{"type":"array"},"meta":{"type":"array"},"comment":{"type":"string"},"name":{"type":"string"},"created_at":{"type":"integer","format":"int32"},"id":{"type":"string","format":"uuid"}},"required":["name"]},"services":{"type":"object","properties":{"protocol":{"type":"string","default":"http"},"tags":{"type":"array"},"path":{"type":"string"},"id":{"type":"string","format":"uuid"},"retries":{"type":"integer","default":5},"connect_timeout":{"type":"integer","default":60000},"host":{"type":"string"},"write_timeout":{"type":"integer","default":60000},"port":{"type":"integer","default":80},"client_certificate":{"$ref":"#/components/schemas/certificates"},"tls_verify":{"type":"boolean"},"tls_verify_depth":{"type":"integer","nullable":true,"default":null},"enabled":{"type":"boolean","default":true},"ca_certificates":{"type":"array"},"name":{"type":"string"},"read_timeout":{"type":"integer","default":60000},"created_at":{"type":"integer","format":"int32"},"updated_at":{"type":"integer","format":"int32"}},"required":["protocol","host","port","enabled"]},"routes":{"type":"object","properties":{"sources":{"type":"array"},"tags":{"type":"array"},"id":{"type":"string","format":"uuid"},"strip_path":{"type":"boolean","default":true},"path_handling":{"type":"string","default":"v0"},"preserve_host":{"type":"boolean","default":false},"request_buffering":{"type":"boolean","default":true},"response_buffering":{"type":"boolean","default":true},"regex_priority":{"type":"integer","default":0},"service":{"$ref":"#/components/schemas/services"},"https_redirect_status_code":{"type":"integer","default":426},"name":{"type":"string"},"protocols":{"type":"array","default":["http","https"]},"snis":{"type":"array"},"destinations":{"type":"array"},"paths":[],"hosts":{"type":"array"},"headers":{"type":"array"},"methods":{"type":"array"},"created_at":{"type":"integer","format":"int32"},"updated_at":{"type":"integer","format":"int32"}},"required":["protocols","https_redirect_status_code","strip_path","preserve_host","request_buffering","response_buffering"]},"consumers":{"type":"object","properties":{"username":{"type":"string"},"custom_id":{"type":"string"},"tags":{"type":"array"},"created_at":{"type":"integer","format":"int32"},"id":{"type":"string","format":"uuid"}},"required":[]},"plugins":{"type":"object","properties":{"service":{"default":null,"nullable":true,"$ref":"#/components/schemas/services"},"tags":{"type":"array"},"name":{"type":"string"},"id":{"type":"string","format":"uuid"},"consumer":{"default":null,"nullable":true,"$ref":"#/components/schemas/consumers"},"enabled":{"type":"boolean","default":true},"config":{"type":"array"},"route":{"default":null,"nullable":true,"$ref":"#/components/schemas/routes"},"created_at":{"type":"integer","format":"int32"},"protocols":{"type":"array","enum":["http","https","tcp","tls","udp","grpc","grpcs"],"default":["grpc","grpcs","http","https"]}},"required":["name","protocols","enabled"]},"certificates":{"type":"object","properties":{"key_alt":{"type":"string"},"cert_alt":{"type":"string"},"tags":{"type":"array"},"key":{"type":"string"},"cert":{"type":"string"},"created_at":{"type":"integer","format":"int32"},"id":{"type":"string","format":"uuid"}},"required":["cert","key"]},"ca_certificates":{"type":"object","properties":{"tags":{"type":"array"},"id":{"type":"string","format":"uuid"},"cert":{"type":"string"},"created_at":{"type":"integer","format":"int32"},"cert_digest":{"type":"string"}},"required":["cert"]},"snis":{"type":"object","properties":{"tags":{"type":"array"},"certificate":{"$ref":"#/components/schemas/certificates"},"name":{"type":"string"},"created_at":{"type":"integer","format":"int32"},"id":{"type":"string","format":"uuid"}},"required":["name","certificate"]}}},"info":{"description":" {{site.base_gateway}} comes with an **internal** RESTful Admin API for administration purposes.\n Requests to the Admin API can be sent to any node in the cluster, and Kong will\n keep the configuration consistent across all nodes.\n\n - `8001` is the default port on which the Admin API listens.\n - `8444` is the default port for HTTPS traffic to the Admin API.\n\n This API is designed for internal use and provides full control over Kong, so\n care should be taken when setting up Kong environments to avoid undue public\n exposure of this API. See [this document][secure-admin-api] for a discussion\n of methods to secure the Admin API.\n ","contact":{"url":"https://github.com/Kong/kong","name":"Kong"},"version":"3.1.0","title":"Kong Admin API","license":{"url":"https://github.com/Kong/kong/blob/master/LICENSE","name":"Apache 2.0"},"summary":"Kong RESTful Admin API for administration purposes."},"paths":{"/cache/{key}":{"get":[],"delete":{"description":"This method is not available when using DB-less mode."}},"/upstreams/{upstreams}/targets/all":{"get":{"summary":"List all Targets"}},"/":{"get":{"summary":"Retrieve node information"}},"/upstreams/{upstreams}/targets/{targets}/{address}/unhealthy":{"put":{"description":"This method is not available when using DB-less mode."}},"/upstreams/{upstreams}/targets":{"get":[],"post":{"description":"This method is not available when using DB-less mode."}},"/routes/{routes}/plugins/{plugins}":{"patch":{"description":"This method is not available when using DB-less mode."}},"/certificates/{certificates}/snis/{snis}":[],"/upstreams/{upstreams}/targets/{targets}":{"delete":{"summary":"Delete Target","description":"This method is not available when using DB-less mode."},"patch":{"summary":"Update Target","description":"This method is not available when using DB-less mode."},"get":[],"put":{"description":"This method is not available when using DB-less mode."}},"/upstreams/{upstreams}/targets/{targets}/unhealthy":{"put":{"description":"This method is not available when using DB-less mode."}},"/consumers":{"get":[]},"/services/{services}/plugins":{"post":{"description":"This method is not available when using DB-less mode."}},"/services/{services}/plugins/{plugins}":{"patch":{"description":"This method is not available when using DB-less mode."}},"/upstreams/{upstreams}/targets/{targets}/{address}/healthy":{"put":{"description":"This method is not available when using DB-less mode."}},"/targets/{targets}":[],"/consumers/{consumers}/plugins":{"post":{"description":"This method is not available when using DB-less mode."}},"/consumers/{consumers}/plugins/{plugins}":{"patch":{"description":"This method is not available when using DB-less mode."}},"/schemas/{db_entity_name}/validate":{"post":{"summary":"Validate a configuration against a schema","description":"This method is not available when using DB-less mode."}},"/targets/{targets}/upstream":[],"/schemas/{name}":{"get":{"summary":"Retrieve Entity Schema"}},"/tags/{tags}":{"get":{"summary":" List entity IDs by tag "}},"/schemas/plugins/validate":{"post":{"summary":"Validate a plugin configuration against the schema","description":"This method is not available when using DB-less mode."}},"/snis/{snis}/certificate":[],"/plugins/{plugins}":{"patch":{"description":"This method is not available when using DB-less mode."}},"/schemas/plugins/{name}":{"get":{"summary":"Retrieve Plugin Schema"}},"/plugins/enabled":{"get":{"summary":"Retrieve Enabled Plugins"}},"/plugins/schema/{name}":{"get":[]},"/upstreams/{upstreams}/health":{"get":{"summary":"Show Upstream health for node"}},"/plugins":{"post":{"description":"This method is not available when using DB-less mode."}},"/upstreams/{upstreams}/targets/{targets}/healthy":{"put":{"description":"This method is not available when using DB-less mode."}},"/status":{"get":{"summary":"Retrieve node status"}},"/cache":{"delete":{"description":"This method is not available when using DB-less mode."}},"/certificates/{certificates}":{"patch":{"description":"This method is not available when using DB-less mode."},"put":{"description":"This method is not available when using DB-less mode."},"get":[]},"/certificates/{certificates}/snis":[],"/targets":[],"/routes/{routes}/plugins":{"post":{"description":"This method is not available when using DB-less mode."}},"/clustering/data-planes":[],"/clustering/status":[],"/timers":{"get":{"summary":"Retrieve runtime debugging info of Kong's timers"}},"/config":{"get":{"description":"This method is only available when using DB-less mode."},"post":{"description":"This method is only available when using DB-less mode."}},"/endpoints":{"get":{"summary":"List available endpoints"}}},"servers":[{"url":"http://localhost:8001","description":"8001 is the default port on which the Admin API listens."},{"url":"https://localhost:8444","description":"8444 is the default port for HTTPS traffic to the Admin API."}]}
/ cache / {key}
/ upstreams / {upstreams} / targets / all
/
/ upstreams / {upstreams} / targets / {targets} / {address} / unhealthy
/ upstreams / {upstreams} / targets
/ routes / {routes} / plugins / {plugins}
/ certificates / {certificates} / snis / {snis}
/ upstreams / {upstreams} / targets / {targets}
/ upstreams / {upstreams} / targets / {targets} / unhealthy
/ consumers
/ services / {services} / plugins
/ services / {services} / plugins / {plugins}
/ upstreams / {upstreams} / targets / {targets} / {address} / healthy
/ targets / {targets}
/ consumers / {consumers} / plugins
/ consumers / {consumers} / plugins / {plugins}
/ schemas / {db_entity_name} / validate
/ targets / {targets} / upstream
/ schemas / {name}
/ tags / {tags}
/ schemas / plugins / validate
/ snis / {snis} / certificate
/ plugins / {plugins}
/ schemas / plugins / {name}
/ plugins / enabled
/ plugins / schema / {name}
/ upstreams / {upstreams} / health
/ plugins
/ upstreams / {upstreams} / targets / {targets} / healthy
/ status
/ cache
/ certificates / {certificates}
/ certificates / {certificates} / snis
/ targets
/ routes / {routes} / plugins
/ clustering / data-planes
/ clustering / status
/ timers
/ config
/ endpoints
No API Resources

(Product) (Docs)

---

{"class":["gateway"],"properties":{"name":"MuleSoft Anypoint Platform","provider":"MuleSoft","slug":"mulesoft-anypoint-platform","rating":1,"license":"Proprietary","status":"Active Research","researchDate":"2021-10","description":"MuleSoft offers a broad suite of products to deliver integration solutions. The Anypoint platform is often listed in the iPaaS category, and as part of that, it contains Gateway functionality.\n","platformCapabilities":["Gateway","Design","Threat Protection","Portal","Monitoring"],"gatewayCapabilities":["Mediation","Traffic Management","Versioning","Protocol Transformation","Mocking"],"customCodeSupport":["JavaScript"],"upstreamProtocols":["HTTP/1.1"],"downstreamProtocols":["HTTP/1.1"],"deliveryModels":["SaaS","Customer Managed (Cloud)","Customer Managed (On-Premises)","Hybrid"],"policies":[{"category":"Security","capabilities":["Client ID and Secret (MuleSoft-specific API security model)","Basic Authentication","LDAP Authentication","IP Access Rules","CORS","JSON Threat Protection","JWT","OAuth 2.0","OpenID Connect","PingFederate OAuth2.0 Token","JSON Threat Protection","XML Threat Protection"]},{"category":"Traffic Management","capabilities":["Cache Lookup","Cache Validation","Cache Eviction","Rate Limiting","Spike Control"]},{"category":"Mediation","capabilities":["Request Transformation"]},{"category":"Extension","capabilities":["Message Logging","Custom Policies"]}]},"links":[{"rel":["urn:gateway:product"],"title":"Product","href":"https://www.mulesoft.com/platform/enterprise-integration"},{"rel":["urn:gateway:docs"],"title":"Documentation","href":"https://docs.mulesoft.com/general/"},{"rel":["urn:gateway:logo"],"title":"Logo","href":"/images/gateways/mulesoft-anypoint-platform.png"},{"rel":["urn:gateway:screenshot"],"title":"Screenshot","href":"https://kinlane-productions2.s3.amazonaws.com/api-gateways/mulesoft-anypoint-platform.png"}]}

MuleSoft Anypoint Platform

MuleSoft offers a broad suite of products to deliver integration solutions. The Anypoint platform is often listed in the iPaaS category, and as part of that, it contains Gateway functionality.

Platform Capabilities

These are the wider capabilities beyond the gateway they offer.

• Gateway
• Design
• Threat Protection
• Portal
• Monitoring

Gateway Capabilities

These are the capabilities the gateway supports.

• Mediation
• Traffic Management
• Versioning
• Protocol Transformation
• Mocking

Upstream Protocols

The different protocols they support upstream.

• HTTP/1.1

Downtream Protocols

The different protocols they support downstream.

• HTTP/1.1

Custom Code

If they offer plugin, extension, and custom coding options.

• JavaScript

Delivery Models

These are they ways you can deliver this solution.

• SaaS
• Customer Managed (Cloud)
• Customer Managed (On-Premises)
• Hybrid

Policies

These are the policies available across the gateway capabilities.

Security

• Client ID and Secret (MuleSoft-specific API security model)
• Basic Authentication
• LDAP Authentication
• IP Access Rules
• CORS
• JSON Threat Protection
• JWT
• OAuth 2.0
• OpenID Connect
• PingFederate OAuth2.0 Token
• JSON Threat Protection
• XML Threat Protection

Traffic Management

• Cache Lookup
• Cache Validation
• Cache Eviction
• Rate Limiting
• Spike Control

Mediation

• Request Transformation

Extension

• Message Logging
• Custom Policies

API Resources

No API Resources

(Product) (Docs)

---

{"class":["gateway"],"properties":{"name":"NGINX Plus","provider":"NGINX Plus","slug":"nginx","rating":1,"license":"Proprietary, Open Source (Apache-2.0)","status":"Pending Review","researchDate":"2021-10","description":"Modern app infrastructure and dev teams love NGINX Plus. More than just the fastest web server around, NGINX Plus brings you everything you love about NGINX Open Source, adding enterprise‑grade features like high availability, active health checks, DNS system discovery, session persistence, and a RESTful API. NGINX Plus is a cloud‑native, easy-to-use reverse proxy, load balancer, and API gateway. Whether you need to integrate advanced monitoring, strengthen security controls, or orchestrate Kubernetes containers, NGINX Plus delivers with the five‑star support you expect from NGINX.\n","platformCapabilities":["Gateway","Analytics"],"gatewayCapabilities":["Mediation","Traffic Management","Versioning"],"customCodeSupport":["None"],"upstreamProtocols":["HTTP/1.1","gRPC","IMAP","POP3","SMTP","TCP","UDP"],"downstreamProtocols":["HTTP/1.1","gRPC"],"deliveryModels":["SaaS"],"policies":[{"category":"Traffic Management","capabilities":["Cache Eviction","Cache Invalidation","Cache Lookup","Cache Population","Cache Storage","Cache Target Response","Cache Validation","Conditional Routing","Content-Based Routing","DNS","Health Checks","Load Balancer Routing","Quota","Quota Reset","Rate Limiting","Request Size Limiting","Reverse Proxy","Service Mesh","Service Discovery","Session Persistence","Throttling","Traffic Optimization"]},{"category":"Mediation","capabilities":["CORS","Cache Eviction","Cache Lookup","Cache Store","Request Size Limit","Request Termination","Request Transformation","Response Transformation","GZip"]},{"category":"Security","capabilities":["API Key","API Key Authentication","Access Control Lists","Audit Logs","Basic Authentication","CORS","IP Access Rules","JWS","JWT Validation","JWT authorizers","JWT authorizers (Custom","Mutual TLS"]},{"category":"Extensions","capabilities":["HTTP Callout","HTTP integrations","Containers","Content Deliver Network","Kubernetes","DNS","App Dynamics","Datadog","Dynatrace","Amazon Web Services","Google Cloud","Microsoft Azure","FastCGI","Memcached"]}]},"links":[{"rel":["urn:gateway:product"],"title":"Product","href":"https://www.nginx.com/products/nginx/"},{"rel":["urn:gateway:docs"],"title":"Documentation","href":"https://www.nginx.com/products/nginx/"},{"rel":["urn:gateway:logo"],"title":"Logo","href":"/images/gateways/name.svg"},{"rel":["urn:gateway:screenshot"],"title":"Screenshot","href":"https://kinlane-productions2.s3.amazonaws.com/api-gateways/nginx.png"}]}

NGINX Plus

Modern app infrastructure and dev teams love NGINX Plus. More than just the fastest web server around, NGINX Plus brings you everything you love about NGINX Open Source, adding enterprise‑grade features like high availability, active health checks, DNS system discovery, session persistence, and a RESTful API. NGINX Plus is a cloud‑native, easy-to-use reverse proxy, load balancer, and API gateway. Whether you need to integrate advanced monitoring, strengthen security controls, or orchestrate Kubernetes containers, NGINX Plus delivers with the five‑star support you expect from NGINX.

Platform Capabilities

These are the wider capabilities beyond the gateway they offer.

• Gateway
• Analytics

Gateway Capabilities

These are the capabilities the gateway supports.

• Mediation
• Traffic Management
• Versioning

Upstream Protocols

The different protocols they support upstream.

• HTTP/1.1
• gRPC
• IMAP
• POP3
• SMTP
• TCP
• UDP

Downtream Protocols

The different protocols they support downstream.

• HTTP/1.1
• gRPC

Custom Code

If they offer plugin, extension, and custom coding options.

• None

Delivery Models

These are they ways you can deliver this solution.

• SaaS

Policies

These are the policies available across the gateway capabilities.

Traffic Management

• Cache Eviction
• Cache Invalidation
• Cache Lookup
• Cache Population
• Cache Storage
• Cache Target Response
• Cache Validation
• Conditional Routing
• Content-Based Routing
• DNS
• Health Checks
• Load Balancer Routing
• Quota
• Quota Reset
• Rate Limiting
• Request Size Limiting
• Reverse Proxy
• Service Mesh
• Service Discovery
• Session Persistence
• Throttling
• Traffic Optimization

Mediation

• CORS
• Cache Eviction
• Cache Lookup
• Cache Store
• Request Size Limit
• Request Termination
• Request Transformation
• Response Transformation
• GZip

Security

• API Key
• API Key Authentication
• Access Control Lists
• Audit Logs
• Basic Authentication
• CORS
• IP Access Rules
• JWS
• JWT Validation
• JWT authorizers
• JWT authorizers (Custom
• Mutual TLS

Extensions

• HTTP Callout
• HTTP integrations
• Containers
• Content Deliver Network
• Kubernetes
• DNS
• App Dynamics
• Datadog
• Dynatrace
• Amazon Web Services
• Google Cloud
• Microsoft Azure
• FastCGI
• Memcached

API Resources

Gateways API OpenAPI	{"openapi":"3.0.0","servers":[{"description":"NGINX Controller API","url":"https://{{CONTROLLER_FQDN}}/api/v1"}],"info":{"title":"Gateways API","description":"Use the Gateways API to manage Gateway resources.","version":"v1"},"paths":{"/services/environments/{environmentName}/gateways":{"get":{"tags":["Gateways"],"summary":"List all Gateways","description":"Returns a list of all Gateways in the specified Environment.\n","operationId":"listGateways","responses":{"200":{"description":"Successfully retrieved a list of all Gateways for the specified Environment.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/GatewayList"}}}}},"400":{"description":"Bad input parameter, or possibly a bad URI. Check the input for typos and try again.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"404":{"description":"The resource defined in the URI could not be found. Check the URI for errors and try again.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}}}},"post":{"tags":["Gateways"],"summary":"Create a Gateway","description":"Creates a new Gateway resource.\n","operationId":"createGateway","requestBody":{"description":"Defines the Gateway resource to create.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Gateway"}}}},"responses":{"201":{"description":"Successfully created the specified Gateway resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Gateway"}}}},"202":{"description":"The Gateway resource has been accepted for creation. The Gateway will be created after it is done configuring.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Gateway"}}}},"400":{"description":"Bad input parameter, or possibly a bad URI. Check the input for typos and try again.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"404":{"description":"The resource defined in the URI could not be found. Check the URI for errors and try again.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"409":{"description":"The request failed due to a naming conflict with an existing resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"429":{"description":"The request to create a Gateway resource failed due to exceeding request processing threshold.\nAllow the server to process existing requests, then try again.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}}}},"parameters":[{"name":"environmentName","description":"The name of the Environment that contains the Gateway resource.","in":"path","required":true,"schema":{"$ref":"#/components/schemas/EnvironmentName"}}]},"/services/environments/{environmentName}/gateways/{gatewayName}":{"get":{"tags":["Gateways"],"summary":"Get a Gateway","description":"Returns information for the specified Gateway resource.\n","operationId":"getGateway","responses":{"200":{"description":"Successfully retrieved the requested Gateway resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Gateway"}}}},"400":{"description":"Bad input parameter, or possibly a bad URI. Check the input for typos and try again.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"404":{"description":"The resource defined in the URI could not be found. Check the URI for errors and try again.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}}}},"put":{"tags":["Gateways"],"summary":"Upsert a Gateway","description":"Creates a new Gateway or updates an existing Gateway resource.\n","operationId":"updateGateway","requestBody":{"description":"Defines the Gateway resource to create or the updates to make to an existing Gateway resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Gateway"}}}},"responses":{"200":{"description":"Successfully updated the specified Gateway resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Gateway"}}}},"201":{"description":"Successfully created the specified Gateway resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Gateway"}}}},"202":{"description":"The Gateway resource has been accepted for creation or update. The Gateway will be created or updated after it is done configuring.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Gateway"}}}},"400":{"description":"Bad input parameter, or possibly a bad URI. Check the input for typos and try again.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"404":{"description":"The resource defined in the URI could not be found. Check the URI for errors and try again.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"429":{"description":"The request to update or create a Gateway resource failed due to exceeding request processing threshold.\nAllow the server to process existing requests, then try again.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}}}},"delete":{"tags":["Gateways"],"summary":"Delete a Gateway","description":"Deletes the specified Gateway resource.","operationId":"deleteGateway","responses":{"202":{"description":"The Gateway resource has been marked for deletion. The Gateway will be deleted after the underlying resources have been deleted.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Gateway"}}}},"204":{"description":"Successfully deleted the specified Gateway resource. No content is returned.\n"},"404":{"description":"The resource defined in the URI could not be found. Check the URI for errors and try again.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"409":{"description":"The request to delete a Gateway resource failed.\nThe Gateway is referenced by an App Component(s) and cannot be deleted.\nDelete the App Component or remove the reference, then try again.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"429":{"description":"The request to delete a Gateway resource failed due to exceeding request processing threshold.\nAllow the server to process existing requests, then try again.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}}}},"parameters":[{"name":"environmentName","description":"The name of the Environment that contains the Gateway resource.","in":"path","required":true,"schema":{"$ref":"#/components/schemas/EnvironmentName"}},{"name":"gatewayName","description":"The name of the Gateway.","in":"path","required":true,"schema":{"$ref":"#/components/schemas/GatewayName"}}]}},"components":{"schemas":{"GatewayName":{"type":"string"},"GatewayList":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/Gateway"}}}},"EnvironmentName":{"type":"string"},"SelfLinks":{"type":"object","description":"The SelfLinks object contains a link from the resource to itself.\nThis object is used only in responses.\n","properties":{"rel":{"type":"string","example":"/api/v1/services/environments/prod","description":"`rel` contains the complete path fragment of a URI and can be used\nto construct a query to the object.\n"}}},"ResourceMeta":{"type":"object","required":["name"],"properties":{"name":{"type":"string","pattern":"^[^A-Z\\s\\x00-\\x1f\\x60\\x7f\\;\\*\\\"\\[\\]\\{\\}\\\\\\/%\\?:=&\\~\\^|#<>]+$","minLength":1,"maxLength":1024,"example":"resource-name","description":"Resource name is a unique identifier for a resource within the context of a namespace.\nResource names must conform to [RFC 1738 Section 2.2](https://www.ietf.org/rfc/rfc1738.txt) and have a valid syntax for email addresses. The following rules are enforced:\n\n- do not utilize URL encoding;\n- do not include spaces;\n- do not use uppercase characters, for example, 'A-Z'; extended character sets are supported;\n- do not use the following characters: `\"`, `*`, `:`, `;`, `/`, `\\`, `%`, `?`, `hash`, `=`, `&`, `|`, `~`, `^`, `{`, `}`, `[`, `]`, `<`, `>`;\n- cannot start or end with an `@` sign;\n\nFor example: For a collection resource located at\n\n`https://controller.example.com/api/v1/services/apps/shopping_@1`\n\nthe resource name is \"shopping_@1\".\n"},"displayName":{"type":"string","example":"My Display Name","description":"`displayName` is a user friendly resource name. It can be used to define \na longer, and less constrained, name for a resource.\n\nDisplay names:\n\n- are optional (defaults to an empty string if no value is provided),\n- do not have to be unique, \n- cannot be assigned by the server.\n"},"description":{"type":"string","example":"This is a sample description string. It provides information about the resource.","description":"`description` is a free-form text property. You can use it to provide information that helps \nto identify the resource.\n\nDescriptions:\n\n- are optional (defaults to an empty string if no value is provided),\n- do not have to be unique, \n- cannot be assigned by the server.\n"},"kind":{"type":"string","example":"<collection>-<object>","description":"Kind is a string representation of an API resource's data type.\nIt is assigned by the server and cannot be changed. \n\nWhen creating a `kind`, the server uses hyphens to connect word segments; \nsingleton and collection item resources are not pluralized.\n"},"uid":{"type":"string","format":"uuid","example":"d290f1ee-6c54-4b01-90e6-d701748f0851","description":"Unique Identifier (UID)\n\nUID is a unique identifier in time and space for a resource. \nWhen you create a resource, the server assigns a UID to the resource.\n\nRefer to [IETF RFC 4122](https://tools.ietf.org/html/rfc4122) for more information.\n"},"tags":{"type":"array","items":{"type":"string"},"example":["production_public","dev","new_app","us-west-1","emea"],"description":"You can assign `tags` to a resource as a way to help map, scope, \nand organize resources. \n\nThe system uses tag selectors to specify selection criteria that \nmatch resources that have particular tags.\n"},"ref":{"type":"string","example":"/services/environments/prod","description":"The `ref` field contains a reference to another NGINX Controller resource.\n"},"links":{"$ref":"#/components/schemas/SelfLinks"},"createTime":{"type":"string","format":"date-time","example":"2019-07-29T09:12:33.001Z","description":"A timestamp that represents the server time when the resource was created.\n\nCreate time is not guaranteed to be set in \"happens-before\" order\nacross separate operations.\n\nIn JSON format, `create_time` type is encoded as a string in the\n[RFC 3339](https://www.ietf.org/rfc/rfc3339.txt).\n\nFor example: 2018-04-01T01:30:15.01Z\n\nCreate Time is assigned by the server and cannot be changed.\n"},"updateTime":{"type":"string","format":"date-time","example":"2019-07-29T10:12:33.001Z","description":"A timestamp that represents the server time when the resource was last modified.\n\nResources that have never been updated do not have an `update_time` stamp.\n\nThe default value for resources that have never been updated is the local \nlanguage-specific equivalent of \"null\".\n\nIn JSON format, `update_time` type is encoded as a string as described in \n[RFC 3339](https://www.ietf.org/rfc/rfc3339.txt).\n"}}},"NamedLinks":{"allOf":[{"$ref":"#/components/schemas/SelfLinks"},{"type":"object","description":"Contains information about the object being referred to.\n\nThese are generally details -- like the object name and display name --\nthat are useful to a consumer of the API that performs further\nprocessing. \n\nThis object is only present in responses.\n \n","properties":{"name":{"type":"string","example":"production","description":"The name of the linked resource.\n"},"displayName":{"type":"string","example":"Production Environment","description":"A user friendly resource name."}}}]},"ResourceRef":{"type":"object","required":["ref"],"properties":{"ref":{"type":"string","example":"/services/environments/prod","description":"A reference to another NGINX Controller resource.\n"},"links":{"$ref":"#/components/schemas/NamedLinks"}}},"GZip":{"properties":{"isEnabled":{"type":"boolean","externalDocs":{"url":"http://nginx.org/en/docs/http/ngx_http_gzip_module.html#gzip"}},"buffers":{"type":"object","properties":{"number":{"type":"integer"},"size":{"type":"string","pattern":"^[0-9]+[k|K|m|M]{1}$"}},"externalDocs":{"url":"http://nginx.org/en/docs/http/ngx_http_gzip_module.html#gzip_buffers"}},"level":{"type":"integer","minimum":1,"maximum":9,"externalDocs":{"url":"http://nginx.org/en/docs/http/ngx_http_gzip_module.html#gzip_comp_level"}},"disabledUserAgents":{"type":"array","items":{"type":"string"},"minItems":1,"uniqueItems":true,"externalDocs":{"url":"http://nginx.org/en/docs/http/ngx_http_gzip_module.html#gzip_disable"}},"httpVersion":{"type":"string","pattern":"^[1-3]{1}\\.[0-1]{1}$","externalDocs":{"url":"http://nginx.org/en/docs/http/ngx_http_gzip_module.html#gzip_http_version"}},"minLength":{"type":"integer","externalDocs":{"url":"http://nginx.org/en/docs/http/ngx_http_gzip_module.html#gzip_min_length"}},"proxied":{"type":"string","enum":["DISABLED","EXPIRED","NOCACHE","NOSTORE","PRIVATE","NOLASTMODIFIED","NOETAG","AUTH","ANY"],"externalDocs":{"url":"http://nginx.org/en/docs/http/ngx_http_gzip_module.html#gzip_proxied"}},"mimeTypes":{"type":"array","items":{"type":"string"},"minItems":1,"uniqueItems":true,"externalDocs":{"url":"http://nginx.org/en/docs/http/ngx_http_gzip_module.html#gzip_types"}},"vary":{"type":"string","enum":["DISABLED","ENABLED"],"externalDocs":{"url":"http://nginx.org/en/docs/http/ngx_http_gzip_module.html#gzip_vary"}},"static":{"type":"string","enum":["DISABLED","ENABLED","ALWAYS"],"externalDocs":{"url":"http://nginx.org/en/docs/http/ngx_http_gzip_static_module.html#gzip_static"}}}},"Compression":{"description":"Gzip compression settings.","type":"object","properties":{"gzip":{"$ref":"#/components/schemas/GZip"}}},"GatewayWebState":{"description":"Non-ingress settings in a Gateway that apply only to Web Components.","type":"object","properties":{"errorSetRef":{"$ref":"#/components/schemas/ResourceRef"},"compression":{"$ref":"#/components/schemas/Compression"}}},"NginxDirective":{"x-f5-experimental":true,"required":["directive"],"properties":{"directive":{"type":"string","description":"The name of the NGINX directive. For a list of NGINX Directives, refer to [the NGINX documentation](http://nginx.org/en/docs/dirindex.html).\n"},"args":{"type":"array","description":"Directive arguments.","items":{"type":"string"}},"block":{"type":"array","description":"The directives to include within a block directive or context.","items":{"$ref":"#/components/schemas/NginxDirective"}}}},"NginxConf":{"x-f5-experimental":true,"required":["path","op","block"],"properties":{"path":{"type":"string","description":"Path is a JSONPath expression. See [goessner.net/articles/JsonPath](https://goessner.net/articles/JsonPath/) for more information on JSONPath.\n","example":"$..[?(@.directive=='server')]"},"op":{"type":"string","description":"Indicates where to insert the block of directives in relation to the directives\nselected by the given path.\n\n* `APPEND` - Add after the selected directives\n\n* `APPEND_CHILD` - Add after the last directive in the selected directives' block\n\n* `PREPEND` - Add before the selected directives\n\n* `PREPEND_CHILD` - Add before the first directive in the selected directives' block\n","enum":["APPEND","APPEND_CHILD","PREPEND","PREPEND_CHILD"]},"block":{"type":"array","description":"Block contains a list of directives that you want to add to the NGINX configuration.\n","items":{"$ref":"#/components/schemas/NginxDirective"}}}},"NginxConfs":{"x-f5-experimental":true,"description":"NGINX raw configuration","type":"array","items":{"$ref":"#/components/schemas/NginxConf"}},"HA":{"description":"Data path high availability settings","type":"object","properties":{"isEnabled":{"type":"boolean","description":"Enables or disables HA.\n\nWhen set to `true`, supports configuring instances in an active‑passive, high‑availability (HA) setup.\n\nTo configure the gateway on HA mode:\n - `keepalived` must be installed and configured on the desired instances.\n - At least one listen IP address must be specified in the `listenIps` section within `InstanceRefs`\n\n See the `listenIps` section for additional requirements for configuring HA.\n"}}},"GatewayStateCommon":{"description":"Non-ingress settings in a Gateway that apply to Web and TCP/UDP Components.","type":"object","properties":{"nginxConfs":{"$ref":"#/components/schemas/NginxConfs"},"ha":{"$ref":"#/components/schemas/HA"}}},"ServiceConfigState":{"type":"string","enum":["ENABLED","DISABLED"],"default":"DISABLED"},"GatewaySocketSettings":{"description":"Socket settings in a Gateway.","type":"object","properties":{"setFib":{"x-f5-experimental":true,"type":"integer"},"fastOpen":{"x-f5-experimental":true,"type":"integer"},"acceptFilter":{"x-f5-experimental":true,"type":"string","enum":["DATA_READY","HTTP_READY"]},"deferred":{"x-f5-experimental":true,"$ref":"#/components/schemas/ServiceConfigState"},"backlog":{"x-f5-experimental":true,"type":"integer","default":-1},"isIpv6Only":{"x-f5-experimental":true,"type":"boolean","default":false},"reusePort":{"x-f5-experimental":true,"$ref":"#/components/schemas/ServiceConfigState"},"tcpKeepAlive":{"type":"object","properties":{"state":{"$ref":"#/components/schemas/ServiceConfigState"},"idle":{"type":"string","pattern":"^[0-9]+[h|m|s]{1}$"},"interval":{"type":"string","pattern":"^[0-9]+[h|m|s]{1}$"},"count":{"type":"integer"}}},"receiveBufferSize":{"type":"string","pattern":"^[0-9]+[k|K|m|M]{1}$"},"sendBufferSize":{"type":"string","pattern":"^[0-9]+[k|K|m|M]{1}$"}}},"URIMatchMethod":{"description":"Specifies how to determine a match between an incoming Web URI and configured Web URI.","type":"string","enum":["PREFIX","REGEX","REGEX_CASE_SENSITIVE","SUFFIX","EXACT"],"default":"PREFIX"},"TLS":{"description":"TLS settings applicable to URIs.","type":"object","required":["certRef"],"properties":{"certRef":{"$ref":"#/components/schemas/ResourceRef"},"protocols":{"type":"array","items":{"type":"string","pattern":"TLSv1|TLSv1\\.[1-3]|SSLv2|SSLv3"}},"cipher":{"type":"string","example":"ALL:!aNULL:!EXPORT56:RC4+RSA:+HIGH:+MEDIUM:+LOW:+SSLv2:+EXP;"},"preferServerCipher":{"$ref":"#/components/schemas/ServiceConfigState"},"sessionCache":{"type":"string","enum":["OFF","NONE","BUILTIN","SHARED"],"default":"OFF"}}},"IngressUri":{"type":"object","properties":{"matchMethod":{"$ref":"#/components/schemas/URIMatchMethod"},"tls":{"$ref":"#/components/schemas/TLS"},"serverPoolPort":{"x-f5-experimental":true,"description":"The port number used when the IngressUri is deployed to an Instance that's a member of a BIG-IP server pool.","type":"integer"}}},"IngressUris":{"type":"object","description":"Defines the URI in Gateways and Components. The URI has different requirements depending on where it is used.\n\nFor Web URIs in Gateways, `uris` must be a complete URI that follows the format `<http|https>://host[:port]`;\nadditionally each URI can have a match method specified and an HTTPS URI can include TLS information.\n Examples:\n - `http://www.f5.com`\n - `https://www.f5.com`\n - `http://www.f5.com:8080`\n - `http://*.info.f5.com`\n\nFor Web URIs in Components, `uris` can be either a complete URI that follows the format `<http|https>://host[:port][/path]`\nor a relative path that follows the format `/path[/...]`;\nadditionally each URI can have a match method specified and an HTTPS URI can include TLS information.\n Examples:\n - `/images`\n - `/*.jpg`\n - `/locations/us/wa*`\n - `http://www.f5.com:8080/sales`\n - `http://*.f5.com:5050/testing`\n\nFor TCP/UDP URIs in Gateways and Components,`uris` must be a complete URI that follows the format `<tcp|udp|tcp+tls>://<*|IP>:<port|portRange>`;\nadditionally a tcp+tls URI can include TLS information. Match method is not applicable to TCP/UDP URIs.\n Examples:\n - `tcp://192.168.1.1:12345`\n - `tcp+tls://192.168.1.1:12346`\n - `tcp://192.168.1.1:12345-12350`\n - `tcp://*:12345`\n - `udp://192.168.1.1:12345`\n - `udp://*:12345`\n\nIn a TCP/UDP Component, URIs can either all have a protocol of udp or a mix of TCP and tcp+tls.\n","additionalProperties":{"description":"Provide the URI associated with the resource.","$ref":"#/components/schemas/IngressUri"}},"InstanceRef":{"allOf":[{"$ref":"#/components/schemas/ResourceRef"},{"type":"object","properties":{"listenIps":{"x-f5-experimental":true,"description":"The list of Listen IP addresses.\n\nSets the IP address(es) on which the server listens for and accepts requests.\n\nWhen using Gateway in high availability (HA) mode, this field has the following requirements:\n\n- Requires `keepalived` to be installed and configured on the instances. The `keepalived.conf` file must\n be present at a standard location or a symlink must be provided at `/etc/nginx/keepalived.conf`.\n\n- The `virtual_ipaddress` section within the `keepalived.conf` file must be marked as follows:\n\n```\nvirtual_ipaddress {\n\n #NGINX_CONTROLLER_HA_BEGIN\n\n #NGINX_CONTROLLER_HA_END\n\n}\n```\n","type":"array","items":{"type":"string","pattern":"^(?:(?:25[0-5]|2[0-4]\\d|[01]?\\d\\d?)\\.){3}(?:25[0-5]|2[0-4]\\d|[01]?\\d\\d?)$","example":"1.1.1.1"}}}}]},"InstanceGroupRef":{"x-f5-experimental":true,"allOf":[{"$ref":"#/components/schemas/ResourceRef"},{"type":"object","properties":{"listenIps":{"x-f5-experimental":true,"description":"The list of Listen IP addresses.\nSets the BIG-IP virtual address(es) on which the server listens for and accepts requests.\n","type":"array","items":{"type":"string","pattern":"^(?:(?:25[0-5]|2[0-4]\\d|[01]?\\d\\d?)\\.){3}(?:25[0-5]|2[0-4]\\d|[01]?\\d\\d?)$","example":"1.1.1.1"}}}}]},"Placement":{"description":"Instances that have NGINX configuration applied corresponding to the Gateway and associated Components settings.","type":"object","properties":{"instanceRefs":{"type":"array","items":{"$ref":"#/components/schemas/InstanceRef"}},"instanceGroupRefs":{"type":"array","items":{"$ref":"#/components/schemas/InstanceGroupRef"}}}},"GatewayIngressCommon":{"description":"Ingress settings in a Gateway that apply to Web and TCP/UDP Components.","allOf":[{"$ref":"#/components/schemas/GatewaySocketSettings"},{"type":"object","required":["uris","placement"],"properties":{"uris":{"$ref":"#/components/schemas/IngressUris"},"tls":{"$ref":"#/components/schemas/TLS"},"placement":{"$ref":"#/components/schemas/Placement"}}}]},"HeaderMatchMethod":{"type":"string","enum":["PREFIX","REGEX","REGEX_CASE_SENSITIVE","SUFFIX","EXACT"],"default":"REGEX"},"IngressHeader":{"type":"object","properties":{"name":{"type":"string"},"nameMatchMethod":{"$ref":"#/components/schemas/HeaderMatchMethod"},"value":{"type":"string"},"valueMatchMethod":{"$ref":"#/components/schemas/HeaderMatchMethod"}}},"WebIngressCommon":{"description":"Ingress settings in a Gateway and Component that apply only to Web Components.","type":"object","properties":{"methods":{"description":"Specifies the HTTP method to use in requests.","type":"array","items":{"type":"string","enum":["POST","GET","PUT","DELETE","PATCH","HEAD","TRACE","OPTIONS","CONNECT"]}},"clientMaxBodySize":{"description":"Sets the maximum allowed size of the client request body, specified in the “Content-Length” request header field.","type":"string","pattern":"^[0-9]+[k|K|m|M]{1}$","deprecated":true,"externalDocs":{"url":"https://nginx.org/en/docs/http/ngx_http_core_module.html#client_max_body_size"}},"headers":{"description":"Specifies the match method for headers to be used in requests.","x-f5-experimental":true,"type":"array","items":{"$ref":"#/components/schemas/IngressHeader"}},"http2":{"description":"Enable or disable HTTP/2 connections on the port. Normally, for this to work the `ssl` parameter should be specified as well,\nbut NGINX can also be configured to accept HTTP/2 connections without SSL.\nPossible values are `ENABLED` or `DISABLED`.\n","x-f5-experimental":true,"$ref":"#/components/schemas/ServiceConfigState","externalDocs":{"url":"https://nginx.org/en/docs/http/ngx_http_core_module.html#listen"}},"spdy":{"description":"Enables or disables acceptance of the SPDY connections on the specified port.\nNormally, for this to work the `ssl` parameter should be specified as well,\nbut NGINX can also be configured to accept SPDY connections without SSL. Possible values are `ENABLED` or `DISABLED`.\n","x-f5-experimental":true,"$ref":"#/components/schemas/ServiceConfigState","externalDocs":{"url":"https://nginx.org/en/docs/http/ngx_http_core_module.html#listen"}},"proxyProtocol":{"description":"Enables or disables the proxy protocol for all connections accepted on the specified port.\nThe `proxy protocol` enables NGINX and NGINX Plus to receive client connection information passed through proxy servers and load balancers,\nsuch as HAproxy and Amazon Elastic Load Balancer (ELB). The possible values are `ENABLED` or `DISABLED`.\n","x-f5-experimental":true,"$ref":"#/components/schemas/ServiceConfigState","externalDocs":{"url":"https://nginx.org/en/docs/http/ngx_http_core_module.html#listen"}},"notFoundStatusCode":{"x-f5-experimental":true,"type":"integer","default":404},"headersHashBucketSize":{"description":"Sets the bucket size for hash tables used by the `proxy_hide_header` and `proxy_set_header` directives.","type":"integer","minimum":1,"externalDocs":{"url":"https://nginx.org/en/docs/http/ngx_http_proxy_module.html#proxy_headers_hash_bucket_size"}},"headersHashMaxSize":{"description":"Sets the maximum size of hash tables used by the `proxy_hide_header` and `proxy_set_header` directives.","type":"integer","minimum":1,"externalDocs":{"url":"https://nginx.org/en/docs/http/ngx_http_proxy_module.html#proxy_headers_hash_max_size"}}}},"GatewayWebIngressClient":{"description":"Non-buffer settings in a Gateway applicable to Web client requests.","type":"object","properties":{"bodyInFileOnly":{"description":"Determines whether NGINX Controller should save the entire client request body into a file.","type":"string","enum":["ENABLED","DISABLED","CLEAN"],"default":"DISABLED","externalDocs":{"url":"https://nginx.org/en/docs/http/ngx_http_core_module.html#client_body_in_file_only"}},"bodyTimeout":{"description":"Defines a timeout for reading the client request body.","type":"string","pattern":"^[0-9]{1,12}[hms]?$","externalDocs":{"url":"https://nginx.org/en/docs/http/ngx_http_core_module.html#client_body_timeout"}},"headerTimeout":{"description":"Defines a timeout for reading the client request header.","type":"string","pattern":"^[0-9]{1,12}[hms]?$","externalDocs":{"url":"https://nginx.org/en/docs/http/ngx_http_core_module.html#client_header_timeout"}},"maxBodySize":{"description":"Sets the maximum allowed size of the client request body, specified in the “Content-Length” request header field.\n\nDisables checking of client request body size when set to 0.\n","type":"string","pattern":"^[0-9]{1,12}[kKmM]?$","externalDocs":{"url":"https://nginx.org/en/docs/http/ngx_http_core_module.html#client_max_body_size"}}}},"WebIngressBuffersCommon":{"description":"Buffer settings common to a Gateway and Component applicable to web client requests.","type":"object","properties":{"clientBodyBufferingIsEnabled":{"description":"Enables or disables buffering of a client request body.","type":"boolean","externalDocs":{"url":"https://nginx.org/en/docs/http/ngx_http_proxy_module.html#proxy_request_buffering"}},"clientBodyBufferSize":{"description":"Sets the buffer size for reading the client request body.","type":"string","pattern":"^[0-9]{1,12}[kKmM]?$","externalDocs":{"url":"https://nginx.org/en/docs/http/ngx_http_core_module.html#client_body_buffer_size"}},"clientBodyInSingleBuffer":{"description":"Determines whether NGINX Controller should save the entire client request body in a single buffer.","type":"string","enum":["ENABLED","DISABLED"],"externalDocs":{"url":"https://nginx.org/en/docs/http/ngx_http_core_module.html#client_body_in_single_buffer"}}}},"GatewayWebIngress":{"description":"Ingress settings in a Gateway that apply only to Web Components.","type":"object","properties":{"client":{"$ref":"#/components/schemas/GatewayWebIngressClient"},"allowUnderscoresInHeaders":{"type":"boolean","default":false,"description":"Allows the use of underscores in client request header fields.\n\nWhen set to `disabled`, request headers with names that contain underscores are considered invalid and are ignored.\n"},"buffers":{"allOf":[{"$ref":"#/components/schemas/WebIngressBuffersCommon"},{"type":"object","properties":{"clientHeaderBufferSize":{"description":"Sets the buffer size for reading the client request header.","type":"string","pattern":"^[0-9]{1,12}[kKmM]?$","externalDocs":{"url":"https://nginx.org/en/docs/http/ngx_http_core_module.html#client_header_buffer_size"}}}}]}}},"GatewayIngress":{"description":"Ingress settings in a Gateway.","allOf":[{"$ref":"#/components/schemas/GatewayIngressCommon"},{"$ref":"#/components/schemas/WebIngressCommon"},{"$ref":"#/components/schemas/GatewayWebIngress"}]},"GatewayDesiredState":{"description":"The desired gateway settings that the user wants in the configuration on NGINX instances referenced by this Gateway.","allOf":[{"$ref":"#/components/schemas/GatewayWebState"},{"$ref":"#/components/schemas/GatewayStateCommon"},{"type":"object","required":["ingress"],"properties":{"ingress":{"$ref":"#/components/schemas/GatewayIngress"}}}]},"ConfigStateTally":{"type":"object","properties":{"isConfigured":{"type":"boolean","description":"The configuration operation is complete."},"isConfiguring":{"type":"boolean","description":"The configuration of the resource, or of its child(ren), is in process."},"isError":{"type":"boolean","description":"An error occurred while configuring the resource or its child(ren)."},"isDeleting":{"type":"boolean","description":"A delete operation is in progress for the resource or its child(ren)."},"total":{"type":"integer","description":"The total number of resources to which the configuration operation applies."},"configured":{"type":"integer","description":"The number of resources that have a complete and valid configuration."},"configuring":{"type":"integer","description":"The number of resources that are in the process of being configured."},"error":{"type":"integer","description":"The number of resources that have encountered an error during the configuration process."},"deleting":{"type":"integer","description":"The number of resources that are in the process of being deleted."}}},"ConfigCondition":{"type":"object","properties":{"type":{"type":"string","description":"The condition type."},"message":{"type":"string","description":"A human-readable message that provides additional information about the configuration operation."}}},"ConfigState":{"type":"object","description":"A representation of the resource's current configuration state \nthat comprises the status of the resource itself (`selfConfigState`) and any child \nresources (`childrenConfigState`).\n\nThe conditions array provides additional information during configuration changes.\n","properties":{"selfConfigState":{"$ref":"#/components/schemas/ConfigStateTally"},"childrenConfigState":{"$ref":"#/components/schemas/ConfigStateTally"},"conditions":{"type":"array","items":{"$ref":"#/components/schemas/ConfigCondition"}}}},"GatewayCurrentStatus":{"description":"The current snapshot of the gateway settings that are reflected in the configuration on NGINX instances referenced by this Gateway.\nThese settings should converge to those in Desired State as the new configuration is applied unless there are issues;\nthe State setting gives a summary of how the convergence is proceeding.\n","allOf":[{"$ref":"#/components/schemas/GatewayWebState"},{"$ref":"#/components/schemas/GatewayStateCommon"},{"type":"object","properties":{"ingress":{"$ref":"#/components/schemas/GatewayIngress"},"state":{"$ref":"#/components/schemas/ConfigState"}}}]},"Gateway":{"type":"object","description":"A Gateway represents the initial network entry point of application and/or API traffic into an NGINX instance that is\nin the data path of this traffic. Gateway settings are combined with Component settings that reference the Gateway;\nthe resulting composite config is sent to the NGINX instances that the Gateway references.\n\nA Gateway can be referenced by either web components and/or TCP/UDP components. Web-only settings in the Gateway (for example, web URIs)\napply only to web components. TCP/UDP-only settings in the Gateway (for example, TCP/UDP URIs) apply only to TCP/UDP components.\nWeb and TCP/UDP common settings in the Gateway (for example, global TLS, socket) apply to both web and TCP/UDP components.\n\nExamples:\nGateway with web and TCP/UDP URIs, web-specific settings, common settings. Web URIs and web settings apply to web components.\nCommon settings apply to both component types. TCP/UDP URIs apply only to TCP/UDP components –- presently, there are no other TCP/UDP only settings.\n\nGateway web URIs (for example, https://www.xyz.com) combined with web component URIs (for example, /blog) define web URI config (https://www.xyz.com/blog).\nComponent TCP/UDP URIs define TCP/UDP URI config (for example, tcp+tls://192.168.1.1:200); Gateway TCP/UDP URIs can provide TLS info plus restrict\nwhich TCP/UDP URIs can be in the component. Alternatively, component URIs fully define the URI config if the Gateway has no URIs.\n\nIf only a single URI type is in the Gateway, the URI config for that type is determined by combining the Gateway URIs with\nthe URIs from components of that type; only component URIs are used for the URI config for the other type.\n\nFor HTTPS URIs, global Gateway TLS settings are used when more specific TLS info is not present in the Gateway URIs,\nor for component URIs that have an HTTPS protocol and hostnames with no specific URI or component global TLS settings defined.\n\nFor tcp+tls URIs, Gateway TLS settings are used when TLS info is not defined in a component URI or component global TLS.\nA Gateway URI’s TLS info is used if it encompasses the component URI. For example, tcp+tls://192.168.1.5:100-104 in the Gateway and\ncomponent URI of tcp+tls://192.168.1.5:100. Global Gateway TLS is used if no other TLS settings apply.\n","required":["metadata","desiredState"],"properties":{"metadata":{"$ref":"#/components/schemas/ResourceMeta"},"desiredState":{"$ref":"#/components/schemas/GatewayDesiredState"},"currentStatus":{"$ref":"#/components/schemas/GatewayCurrentStatus"}}},"ErrorDetail":{"type":"object","required":["description"],"properties":{"description":{"type":"string","example":"Error doing <action>: <reason for error>. This can lead to <potential consequences>. Try <action> to resolve the issue.","description":"A detailed error message returned by the server. \n\nThese messages contain the following information, where applicable:\n\n- What happened.\n- Why it happened.\n- What the consequences are (if any).\n- Recommended action to take to resolve the issue.\n"}}},"ErrorModel":{"type":"object","required":["message","code"],"properties":{"message":{"type":"string","example":"Error doing <action>.","description":"A human-readable message, in English, that describes the error.\n"},"code":{"type":"integer","example":1234567,"description":"A numeric error code that can be used to identify errors for support purposes.\n"},"details":{"type":"array","items":{"$ref":"#/components/schemas/ErrorDetail"}}}}}}}
/ services / environments / {environmentName} / gateways
/ services / environments / {environmentName} / gateways / {gatewayName}
Certs API OpenAPI	{"openapi":"3.0.0","servers":[{"description":"NGINX Controller API","url":"https://{{CONTROLLER_FQDN}}/api/v1"}],"info":{"description":"Use the Certs API to manage the certificates used to secure your App traffic.","version":"v1","title":"Certs API"},"paths":{"/services/environments/{environmentName}/certs":{"get":{"tags":["Certs"],"summary":"List all Certs","description":"Returns a list of Cert metadata objects for all of the Certs in the specified environment.","operationId":"listCerts","responses":{"200":{"description":"Successfully retrieved a list of Certs for the specified Environment.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CertList"}}}},"400":{"description":"Bad input parameter, or possibly a bad URI. Check the input for typos and try again.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"404":{"description":"The resource defined in the URI could not be found. Check the URI for errors and try again.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}}}},"post":{"tags":["Certs"],"summary":"Create a Cert","operationId":"createCert","description":"Creates a new Cert resource in the specified Environment.\n","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Cert"}}}},"responses":{"201":{"description":"Successfully created the specified Cert resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CertStatus"}}}},"400":{"description":"Bad input parameter, or possibly a bad URI. Check the input for typos and try again.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"404":{"description":"The resource defined in the URI could not be found. Check the URI for errors and try again.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"409":{"description":"The request failed due to a naming conflict with an existing resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}}}},"parameters":[{"name":"environmentName","description":"The name of the Environment that contains the Cert.","in":"path","required":true,"schema":{"$ref":"#/components/schemas/EnvironmentName"}}]},"/services/environments/{environmentName}/certs/{certName}":{"get":{"tags":["Certs"],"summary":"Get a Cert","operationId":"getCert","description":"Returns information for a specific Cert resource.","responses":{"200":{"description":"Sucessfully retrieved the requested Cert.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CertStatus"}}}},"400":{"description":"Bad input parameter, or possibly a bad URI. Check the input for typos and try again.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"404":{"description":"The resource defined in the URI could not be found. Check the URI for errors and try again.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}}}},"put":{"tags":["Certs"],"summary":"Upsert a Cert","operationId":"updateCert","description":"Creates a new Cert or updates an existing Cert resource.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Cert"}}}},"responses":{"200":{"description":"Sucessfully updated the specified Cert resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CertStatus"}}}},"201":{"description":"Successfully created the requested Cert resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CertStatus"}}}},"400":{"description":"Bad input parameter, or possibly a bad URI. Check the input for typos and try again.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"404":{"description":"The resource defined in the URI could not be found. Check the URI for errors and try again.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}}}},"delete":{"tags":["Certs"],"summary":"Delete a Cert","operationId":"deleteCert","description":"Deletes the specified Cert resource.","responses":{"204":{"description":"The specified Cert resource was successfully deleted."},"404":{"description":"The resource defined in the URI could not be found. Check the URI for errors and try again.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"409":{"description":"The request to delete the specified Cert resource failed.\nThe Cert is referenced by active objects and cannot be deleted. Delete the referencing objects or remove the references, then try again.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}}}},"parameters":[{"name":"environmentName","description":"The name of the Environment that contains the Cert.","in":"path","required":true,"schema":{"$ref":"#/components/schemas/EnvironmentName"}},{"name":"certName","description":"The name of the Cert.","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ResourceName"}}]}},"components":{"schemas":{"ResourceName":{"type":"string","description":"The name of a resource.","example":"production"},"CertMetadata":{"type":"object","description":"Public certificate metadata.","required":["authorityKeyIdentifier","commonName","expired","expiry","issuer","publicKeyType","serialNumber","signatureAlgorithm","subject","subjectAlternativeName","subjectKeyIdentifier","thumbprint","thumbprintAlgorithm","validFrom","validTo","version"],"properties":{"authorityKeyIdentifier":{"type":"string","example":"2B D0 69 47 94 76 09 FE F4 6B 8D 2E 40 A6 F7 47 4D 7F 08 5E","description":"The identifier of the signing authority for the certificate."},"commonName":{"type":"string","example":"www.myapp.com","description":"The Common Name (CN) for the certificate. This is typically a Fully Qualified Domain Name (FQDN), and must be the same as the web address users access when connecting to a web site."},"expired":{"type":"boolean","example":false,"description":"Indicates the expiration status of the certificate."},"expiry":{"type":"integer","example":35500034,"description":"The number of seconds until the certificate will expire."},"issuer":{"type":"string","example":"DigiCert Class 3 Extended Validation SSL SGC CA.","description":"Identifies the entity who signed and issued the certificate."},"publicKeyType":{"type":"string","example":"RSA (2048 Bits)","description":"Identifies the encryption algorithm used to create the public key for the ceritficate."},"serialNumber":{"type":"string","example":"16469416336579571270","description":"A unique identifier for the certificate."},"signatureAlgorithm":{"type":"string","example":"SHA-256","description":"Identifies the algorithm used to sign the certificate."},"subject":{"type":"string","example":"www.myapp.com","description":"Contains the Distinguished Name (DN) information for the certificate."},"subjectAlternativeName":{"type":"string","example":"DNS Name=static.xxxx","description":"Defines additional identifies bound to the subject of the certificate. For example, the DNS name is used to add addtional domain names to a certificate."},"subjectKeyIdentifier":{"type":"string","example":"31 EA 76 A9 23 74 A5 DF D4 FD EE A0 C1 A6 9E C6 11 0E 11 EC","description":"A hash value of the SSL certificate that can be used to identify certificates that contain a particular public key."},"thumbprint":{"type":"string","example":"E6 A7 87 96 E0 C7 A3 E5 43 78 35 CA 16 78 5B 48 5A A9 DD C4 5C CD 0A 65 AA 89 33 E3 C3 D0 89 71","description":"A hash to ensure that the certificate has not been modified."},"thumbprintAlgorithm":{"type":"string","example":"SHA-1","description":"Defines the algorithm used to hash the certificate."},"validFrom":{"type":"string","example":"2019-07-29T09:12:33.001Z","description":"The start of the validity period for the certificate."},"validTo":{"type":"string","example":"2029-07-29T09:12:33.001Z","description":"The end of the validity period for the certificate."},"version":{"type":"integer","example":3,"description":"The version of the certificate, typically 3 for X.509 certificates."}}},"CertDesiredState":{"type":"object","discriminator":{"propertyName":"type","mapping":{"PEM":"#/components/schemas/PEM","PKCS12":"#/components/schemas/PKCS12","REMOTE_FILE":"#/components/schemas/RemoteFile"}},"oneOf":[{"$ref":"#/components/schemas/PEM"},{"$ref":"#/components/schemas/PKCS12"},{"$ref":"#/components/schemas/RemoteFile"}]},"CertList":{"type":"object","required":["items"],"properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/CertStatus"}}}},"CertStatus":{"type":"object","required":["metadata","desiredState","currentStatus"],"properties":{"metadata":{"$ref":"#/components/schemas/ResourceMeta"},"desiredState":{"$ref":"#/components/schemas/CertDesiredState"},"currentStatus":{"$ref":"#/components/schemas/CertCurrentStatus"}}},"CertCurrentStatus":{"type":"object","description":"'Shows the current status of the certificate.\n\nWhen any certificates have expired, the Certs service sets `state.selfConfigState.isConfigured` and `state.selfConfigState.isError` to `true`. The service will also add a value to the conditons array with the type \"expiration\" and a message that shows when the first certificate will expire. For example, `conditions: [{type: \"expiration\", message: \"Certificate www.example.com will expire in 29 days.\"}])`'\n","required":["state","certMetadata","type"],"properties":{"type":{"type":"string"},"privateKey":{"type":"string"},"publicCert":{"type":"string"},"data":{"type":"string"},"password":{"type":"string"},"caCerts":{"type":"array","items":{"type":"string"}},"state":{"$ref":"#/components/schemas/ConfigState"},"certMetadata":{"type":"array","description":"Public certificate metadata.","items":{"$ref":"#/components/schemas/CertMetadata"}}}},"Cert":{"type":"object","description":"Contains the certificate to upload.","required":["metadata","desiredState"],"properties":{"metadata":{"$ref":"#/components/schemas/ResourceMeta"},"desiredState":{"$ref":"#/components/schemas/CertDesiredState"}}},"PEM":{"type":"object","description":"Defines a PEM-formatted certificate that contains a key and certificates.\n\nBecause JSON does not support multi-line strings, you must replace binary line feeds with ASCII line feeds (`\\n`).\nThe private key data will be redacted in the response for all get and list requests.\n","required":["privateKey","publicCert","type"],"properties":{"type":{"type":"string","enum":["PEM"]},"password":{"type":"string","example":"myPa$$w0rd","description":"The passphrase to use to decrypt the private key. Required if the private key is encrypted."},"privateKey":{"type":"string","example":"-----BEGIN PRIVATE KEY-----\\n MIICdwIBADANBgkqhkiG9w0BAQEFAASCAmEwggJdAgEAAoGBALSQBtRafNJtTqN0\\n <EXAMPLE_SNIPPED> nYiZq6TZUsHjfG2R9PlK6jsvno9O6amN96Al6ZSTTDjhr4VU7/RJ0p/cisiCboCX\\n 4cCq6lFKpIpeZJI=\\n -----END PRIVATE KEY-----","description":"The private key used to sign the public certificate.\n\nBecause JSON does not support multi-line strings, you must replace binary line feeds with ASCII line feeds (`\\n`). The private key data will be redacted in the response for all get and list requests.\n"},"publicCert":{"type":"string","example":"-----BEGIN CERTIFICATE-----\\n MIICpzCCAhACCQDkjx7mP9cuRjANBgkqhkiG9w0BAQsFADCBlzELMAkGA1UEBhMC\\n <EXAMPLE_SNIPPED> MiJVGawyxDzBm2UhzNOE0ABHfjAgM6PAYmtMhhQawk6bmttXYhJeqhLSji4LEj5d\\n Z4FmXQ5rWM0RWBs=\\n -----END CERTIFICATE-----","description":"The end-entity certificate, in PEM format.\n\nBecause JSON does not support multi-line strings, you must replace binary line feeds with ASCII line feeds (`\\n`).\n"},"caCerts":{"type":"array","items":{"type":"string"},"example":["-----BEGIN CERTIFICATE-----\\n MIIE+zCCBGSgAwIBAgICAQ0wDQYJKoZIhvcNAQEFBQAwgbsxJDAiBgNVBAcTG1Zh\\n <EXAMPLE_SNIPPED> WBsUs5iB0QQeyAfJg594RAoYC5jcdnplDQ1tgMQLARzLrUc+cb53S8wGd9D0Vmsf\\n SxOaFIqII6hR8INMqzW/Rn453HWkrugp++85j09VZw==\\n -----END CERTIFICATE-----"],"description":"An optional list of intermediate certificates in PEM format that are used to validate the public certificate.\n\nBecause JSON does not support multi-line strings, you must replace binary line feeds with ASCII line feeds (`\\n`).\n"}}},"PKCS12":{"type":"object","description":"Defines a cert with key and certificates encoded in PKCS12 format.","required":["data","type"],"properties":{"type":{"type":"string","enum":["PKCS12"]},"data":{"type":"string","example":"MIIGoQIBAzCCBmcGCSqGSIb3DQEHAaCCBlgEggZUMIIGUDCCA08GCSqGSIb3DQEHBqCCA0AwggM8AgEAMIIDNQYJKoZIhvcNAQcBMBwGCiqGSIb3DQEMAQYwDgQIe7ZblBoEW3QCAggAgIIDCCgLEvzp9n6<EXAMPLE_SNIPPED>9QbpGT0MDEwITAJBgUrDgMCGgUABBQJs6ZgeAMcxVLrq1hU+TlUOArMuQQIGK59vCBn0wECAggA","description":"A base-64-encoded string that contains a private key, a public certificate, and, optionally, other intermediate certificates."},"password":{"type":"string","example":"myPa$$w0rd","description":"The password to use to decrypt PKCS12 data."}}},"RemoteFile":{"type":"object","description":"Define a Cert resource by providing references to remote files.\n\n> **Note:** These are file path references only. The system can not validate the file contents or extract the certificate metadata. Providing a PEM or PKCS12 certificate is recommended.\n","required":["privateKey","publicCert","type"],"properties":{"type":{"type":"string","enum":["REMOTE_FILE"]},"privateKey":{"type":"string","example":"/certs/www.example.com/example.key","description":"The path to the private key file."},"publicCert":{"type":"string","example":"/certs/www.example.com/example.crt","description":"The path to the certificate bundle file. The file must contain the public certificate and may contain additional intermediate certificates."}}},"EnvironmentName":{"type":"string"},"SelfLinks":{"type":"object","description":"The SelfLinks object contains a link from the resource to itself.\nThis object is used only in responses.\n","properties":{"rel":{"type":"string","example":"/api/v1/services/environments/prod","description":"`rel` contains the complete path fragment of a URI and can be used\nto construct a query to the object.\n"}}},"ResourceMeta":{"type":"object","required":["name"],"properties":{"name":{"type":"string","pattern":"^[^A-Z\\s\\x00-\\x1f\\x60\\x7f\\;\\*\\\"\\[\\]\\{\\}\\\\\\/%\\?:=&\\~\\^|#<>]+$","minLength":1,"maxLength":1024,"example":"resource-name","description":"Resource name is a unique identifier for a resource within the context of a namespace.\nResource names must conform to [RFC 1738 Section 2.2](https://www.ietf.org/rfc/rfc1738.txt) and have a valid syntax for email addresses. The following rules are enforced:\n\n- do not utilize URL encoding;\n- do not include spaces;\n- do not use uppercase characters, for example, 'A-Z'; extended character sets are supported;\n- do not use the following characters: `\"`, `*`, `:`, `;`, `/`, `\\`, `%`, `?`, `hash`, `=`, `&`, `|`, `~`, `^`, `{`, `}`, `[`, `]`, `<`, `>`;\n- cannot start or end with an `@` sign;\n\nFor example: For a collection resource located at\n\n`https://controller.example.com/api/v1/services/apps/shopping_@1`\n\nthe resource name is \"shopping_@1\".\n"},"displayName":{"type":"string","example":"My Display Name","description":"`displayName` is a user friendly resource name. It can be used to define \na longer, and less constrained, name for a resource.\n\nDisplay names:\n\n- are optional (defaults to an empty string if no value is provided),\n- do not have to be unique, \n- cannot be assigned by the server.\n"},"description":{"type":"string","example":"This is a sample description string. It provides information about the resource.","description":"`description` is a free-form text property. You can use it to provide information that helps \nto identify the resource.\n\nDescriptions:\n\n- are optional (defaults to an empty string if no value is provided),\n- do not have to be unique, \n- cannot be assigned by the server.\n"},"kind":{"type":"string","example":"<collection>-<object>","description":"Kind is a string representation of an API resource's data type.\nIt is assigned by the server and cannot be changed. \n\nWhen creating a `kind`, the server uses hyphens to connect word segments; \nsingleton and collection item resources are not pluralized.\n"},"uid":{"type":"string","format":"uuid","example":"d290f1ee-6c54-4b01-90e6-d701748f0851","description":"Unique Identifier (UID)\n\nUID is a unique identifier in time and space for a resource. \nWhen you create a resource, the server assigns a UID to the resource.\n\nRefer to [IETF RFC 4122](https://tools.ietf.org/html/rfc4122) for more information.\n"},"tags":{"type":"array","items":{"type":"string"},"example":["production_public","dev","new_app","us-west-1","emea"],"description":"You can assign `tags` to a resource as a way to help map, scope, \nand organize resources. \n\nThe system uses tag selectors to specify selection criteria that \nmatch resources that have particular tags.\n"},"ref":{"type":"string","example":"/services/environments/prod","description":"The `ref` field contains a reference to another NGINX Controller resource.\n"},"links":{"$ref":"#/components/schemas/SelfLinks"},"createTime":{"type":"string","format":"date-time","example":"2019-07-29T09:12:33.001Z","description":"A timestamp that represents the server time when the resource was created.\n\nCreate time is not guaranteed to be set in \"happens-before\" order\nacross separate operations.\n\nIn JSON format, `create_time` type is encoded as a string in the\n[RFC 3339](https://www.ietf.org/rfc/rfc3339.txt).\n\nFor example: 2018-04-01T01:30:15.01Z\n\nCreate Time is assigned by the server and cannot be changed.\n"},"updateTime":{"type":"string","format":"date-time","example":"2019-07-29T10:12:33.001Z","description":"A timestamp that represents the server time when the resource was last modified.\n\nResources that have never been updated do not have an `update_time` stamp.\n\nThe default value for resources that have never been updated is the local \nlanguage-specific equivalent of \"null\".\n\nIn JSON format, `update_time` type is encoded as a string as described in \n[RFC 3339](https://www.ietf.org/rfc/rfc3339.txt).\n"}}},"ConfigStateTally":{"type":"object","properties":{"isConfigured":{"type":"boolean","description":"The configuration operation is complete."},"isConfiguring":{"type":"boolean","description":"The configuration of the resource, or of its child(ren), is in process."},"isError":{"type":"boolean","description":"An error occurred while configuring the resource or its child(ren)."},"isDeleting":{"type":"boolean","description":"A delete operation is in progress for the resource or its child(ren)."},"total":{"type":"integer","description":"The total number of resources to which the configuration operation applies."},"configured":{"type":"integer","description":"The number of resources that have a complete and valid configuration."},"configuring":{"type":"integer","description":"The number of resources that are in the process of being configured."},"error":{"type":"integer","description":"The number of resources that have encountered an error during the configuration process."},"deleting":{"type":"integer","description":"The number of resources that are in the process of being deleted."}}},"ConfigCondition":{"type":"object","properties":{"type":{"type":"string","description":"The condition type."},"message":{"type":"string","description":"A human-readable message that provides additional information about the configuration operation."}}},"ConfigState":{"type":"object","description":"A representation of the resource's current configuration state \nthat comprises the status of the resource itself (`selfConfigState`) and any child \nresources (`childrenConfigState`).\n\nThe conditions array provides additional information during configuration changes.\n","properties":{"selfConfigState":{"$ref":"#/components/schemas/ConfigStateTally"},"childrenConfigState":{"$ref":"#/components/schemas/ConfigStateTally"},"conditions":{"type":"array","items":{"$ref":"#/components/schemas/ConfigCondition"}}}},"ErrorDetail":{"type":"object","required":["description"],"properties":{"description":{"type":"string","example":"Error doing <action>: <reason for error>. This can lead to <potential consequences>. Try <action> to resolve the issue.","description":"A detailed error message returned by the server. \n\nThese messages contain the following information, where applicable:\n\n- What happened.\n- Why it happened.\n- What the consequences are (if any).\n- Recommended action to take to resolve the issue.\n"}}},"ErrorModel":{"type":"object","required":["message","code"],"properties":{"message":{"type":"string","example":"Error doing <action>.","description":"A human-readable message, in English, that describes the error.\n"},"code":{"type":"integer","example":1234567,"description":"A numeric error code that can be used to identify errors for support purposes.\n"},"details":{"type":"array","items":{"$ref":"#/components/schemas/ErrorDetail"}}}}}}}
/ services / environments / {environmentName} / certs
/ services / environments / {environmentName} / certs / {certName}
Identity Provider API OpenAPI	{"openapi":"3.0.0","info":{"title":"Identity Provider API","description":"Use the Identity Provider API to manage Identity providers in the API-M Credential Management partition.","version":"v1"},"servers":[{"description":"NGINX Controller API","url":"https://{{CONTROLLER_FQDN}}/api/v1"}],"paths":{"/security/identity-providers":{"get":{"tags":["Identity Providers"],"summary":"List Identity Providers","description":"Returns a list of all Identity Provider resources.\n\n> **Note:** These resources were known as Client Groups in pre-3.x versions of NGINX Controller.\n","operationId":"identityProvidersSearch","responses":{"200":{"description":"Successfully retrieved a list of Identity Provider resources.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IdentityProviderList"}}}},"400":{"description":"Bad input parameter, or possibly a bad URI. Check the input for typos and try again.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}}}}},"/security/identity-providers/{identityProviderName}":{"get":{"tags":["Identity Providers"],"summary":"Get an Identity Provider","description":"Returns the specified Identity Provider resource.","operationId":"identityProvidersGet","responses":{"200":{"description":"Successfully returnd the specified Identity Provider resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IdentityProvider"}}}},"403":{"description":"The request failed due to insufficient privileges.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"404":{"description":"The specified Identity Provider resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"500":{"description":"The request cannot be processed because of an internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}}}},"put":{"tags":["Identity Providers"],"summary":"Upsert an Identity Provider","description":"Creates a new Identity Provider, or creates an existing Identity Provider resource.\n","operationId":"identityProvidersPut","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IdentityProvider"},"examples":{"IdentityProviderRequest":{"$ref":"#/components/examples/IdentityProviderRequest"}}}}},"responses":{"200":{"description":"Successfully updated the specified Identity Provider resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IdentityProvider"}}}},"201":{"description":"Successfully created the requested Identity Provider resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IdentityProvider"}}}},"202":{"description":"Successfully accepted the requested Identity Provider resource and is currently processing it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IdentityProvider"}}}},"400":{"description":"Bad input parameter, or possibly a bad URI. Check the input for typos and try again.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"429":{"description":"The request to update or create an Identity Provider resource failed due to exceeding request processing threshold.\nAllow the server to process existing requests, then try again.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}}}},"delete":{"tags":["Identity Providers"],"summary":"Delete an Identity Provider","description":"Deletes the specified Identity Provider resource.","operationId":"identityProvidersDelete","responses":{"202":{"description":"The Identity Provider resource has been marked for deletion. The resource will be deleted after the publish/cleanup succeeds.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IdentityProvider"}}}},"204":{"description":"Successfully deleted the specified Identity Provider resource. No content is returned."},"400":{"description":"Bad input parameter, or possibly a bad URI. Check the input for typos and try again.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"404":{"description":"The specified Identity Provider resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"429":{"description":"The request to delete an Identity Provider resource failed due to exceeding request processing threshold.\nAllow the server to process existing requests, then try again.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"500":{"description":"The request cannot be processed because of an internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}}}},"parameters":[{"$ref":"#/components/parameters/identityProviderName"}]},"/security/identity-providers/{identityProviderName}/clients":{"get":{"tags":["Identity Provider Clients"],"summary":"List Identity Provider Clients","description":"Returns a list of all Identity Provider Client resources.\n","operationId":"identityProviderClientsSearch","responses":{"200":{"description":"Successfully retrieved a list of Identity Provider Client resources.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IdentityProviderClientList"}}}},"400":{"description":"Bad input parameter, or possibly a bad URI. Check the input for typos and try again.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"404":{"description":"The specified Identity Provider resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}}}},"put":{"tags":["Identity Provider Clients"],"summary":"Create Multiple Identity Provider Clients","description":"Creates or updates multiple Identity Provider Client resources.\n","operationId":"identityProviderClientsPutList","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IdentityProviderClientList"},"examples":{"IdentityProviderClientListRequest":{"$ref":"#/components/examples/IdentityProviderClientListRequest"}}}}},"responses":{"200":{"description":"Successfully upserted the Identity Provider Client resources.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IdentityProviderClientList"}}}},"202":{"description":"Successfully accepted the requested Identity Provider Client resources and is currently processing it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IdentityProviderClientList"}}}},"400":{"description":"Bad input parameter, or possibly a bad URI. Check the input for typos and try again.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"404":{"description":"The specified Identity Provider resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"409":{"description":"The Identity Provider Client resource conflicts with another resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}}}},"parameters":[{"$ref":"#/components/parameters/identityProviderName"}]},"/security/identity-providers/{identityProviderName}/clients/{identityProviderClientName}":{"get":{"tags":["Identity Provider Clients"],"summary":"Get an Identity Provider Client","description":"Returns information for the specified Identity Provider Client resource.","operationId":"identityProviderClientsGet","responses":{"200":{"description":"Successfully returned the specified Identity Provider Client resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IdentityProviderClient"}}}},"404":{"description":"The specified Identity Provider Client resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}}}},"put":{"tags":["Identity Provider Clients"],"summary":"Update an Identity Provider Client","description":"Updates the specified Identity Provider Client resource.","operationId":"identityProviderClientsPut","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IdentityProviderClient"},"examples":{"IdentityProviderClientRequest":{"$ref":"#/components/examples/IdentityProviderClientRequest"}}}}},"responses":{"200":{"description":"Successfully updated the specified Identity Provider Client resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IdentityProviderClient"}}}},"201":{"description":"Successfully created the specified Identity Provider Client resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IdentityProviderClient"}}}},"202":{"description":"Successfully accepted the requested Identity Provider Client resource and is currently processing it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IdentityProviderClient"}}}},"400":{"description":"Bad input parameter, or possibly a bad URI. Check the input for typos and try again.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"404":{"description":"The specified Identity Provider resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"429":{"description":"The request to update or create an Identity Provider Client resource failed due to exceeding request processing threshold.\nAllow the server to process existing requests, then try again.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}}}},"patch":{"tags":["Identity Provider Clients"],"summary":"Update an Identity Provider Client","description":"Updates the specified Identity Provider Client resource.","operationId":"identityProviderClientsPatch","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateIdentityProviderClient"},"examples":{"IdentityProviderClientPatchMetadataRequest":{"$ref":"#/components/examples/IdentityProviderClientPatchMetadataRequest"},"IdentityProviderClientPatchDesiredStateRequest":{"$ref":"#/components/examples/IdentityProviderClientPatchDesiredStateRequest"}}}}},"responses":{"200":{"description":"Successfully updated the specified Identity Provider Client resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IdentityProviderClient"}}}},"202":{"description":"Successfully accepted the request to update an Identity Provider Client resource and is currently processing it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IdentityProviderClient"}}}},"400":{"description":"Bad input parameter, or possibly a bad URI. Check the input for typos and try again.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"404":{"description":"The specified Identity Provider Client resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"429":{"description":"The request to update an Identity Provider Client resource failed due to exceeding request processing threshold.\nAllow the server to process existing requests, then try again.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}}}},"delete":{"tags":["Identity Provider Clients"],"summary":"Delete an Identity Provider Client","description":"Deletes the specified Identity Provider Client resource.","operationId":"identityProviderClientsDelete","responses":{"202":{"description":"Identity Provider Client resource has been marked for deletion. The resource will be\ndeleted after the publish/cleanup succeeds.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IdentityProviderClient"}}}},"204":{"description":"Successfully deleted the specified Identity Provider Client resource. No content is returned."},"400":{"description":"Bad input parameter, or possibly a bad URI. Check the input for typos and try again.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"404":{"description":"The specified Identity Provider Client resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"429":{"description":"The request to delete an Identity Provider Client resource failed due to exceeding request processing threshold.\nAllow the server to process existing requests, then try again.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}}}},"parameters":[{"$ref":"#/components/parameters/identityProviderName"},{"$ref":"#/components/parameters/identityProviderClientName"}]}},"components":{"schemas":{"IdentityProviderList":{"type":"object","description":"Contains a list of Identity Provider resources.","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/IdentityProvider"}}}},"APIKeyIdentityProvider":{"required":["type"],"type":"object","description":"Use an API key for authentication.\n\n> **Note:** Use of API Key authN is not recommended in production environments.\n","properties":{"type":{"type":"string","enum":["API_KEY"]}}},"JWTIdentityProvider":{"required":["jwkFile","type"],"type":"object","description":"Use a JWT for authentication.","properties":{"type":{"type":"string","enum":["JWT"]},"jwkFile":{"description":"Provide the path to - or URI for - a `.jwk` file to use for authentication.\nYou can also provide the `.jwk` file contents inline.\n","discriminator":{"propertyName":"type","mapping":{"INLINE":"#/components/schemas/JWKInline","REMOTE_FILE":"#/components/schemas/JWKRemoteFile"}},"oneOf":[{"$ref":"#/components/schemas/JWKInline"},{"$ref":"#/components/schemas/JWKRemoteFile"}]}}},"IdentityProviderDesiredState":{"required":["environmentRefs","identityProvider"],"type":"object","properties":{"environmentRefs":{"description":"The Enviroment associated with the Identity Provider.","type":"array","items":{"$ref":"#/components/schemas/ResourceRef"}},"identityProvider":{"$ref":"#/components/schemas/IdentityProviderData"}},"example":{"environmentRefs":[{"ref":"/services/environments/env1"}],"identityProvider":{"type":"JWT","jwkFile":{"type":"REMOTE_FILE","uri":"https://example.com/keys.jwk","cacheExpire":"10h"}}}},"IdentityProviderCurrentStatus":{"required":["environmentRefs","identityProvider","state"],"type":"object","properties":{"environmentRefs":{"type":"array","items":{"$ref":"#/components/schemas/ResourceRef"}},"state":{"$ref":"#/components/schemas/ConfigState"},"identityProvider":{"$ref":"#/components/schemas/IdentityProviderData"}}},"IdentityProvider":{"required":["desiredState","metadata"],"type":"object","properties":{"metadata":{"$ref":"#/components/schemas/ResourceMeta"},"currentStatus":{"$ref":"#/components/schemas/IdentityProviderCurrentStatus"},"desiredState":{"$ref":"#/components/schemas/IdentityProviderDesiredState"}}},"IdentityProviderData":{"description":"The means of authentication used by the Identity Provider (JWT or APIKey).","oneOf":[{"$ref":"#/components/schemas/JWTIdentityProvider"},{"$ref":"#/components/schemas/APIKeyIdentityProvider"}],"discriminator":{"propertyName":"type","mapping":{"API_KEY":"#/components/schemas/APIKeyIdentityProvider","JWT":"#/components/schemas/JWTIdentityProvider"}}},"IdentityProviderClientDesiredState":{"type":"object","properties":{"credential":{"$ref":"#/components/schemas/IdentityProviderClientCredential"}}},"IdentityProviderClientCurrentStatus":{"type":"object","properties":{"state":{"$ref":"#/components/schemas/ConfigState"},"credential":{"$ref":"#/components/schemas/IdentityProviderClientCredential"}}},"IdentityProviderClient":{"type":"object","properties":{"metadata":{"$ref":"#/components/schemas/ResourceMeta"},"currentStatus":{"$ref":"#/components/schemas/IdentityProviderClientCurrentStatus"},"desiredState":{"$ref":"#/components/schemas/IdentityProviderClientDesiredState"}}},"IdentityProviderClientCredential":{"oneOf":[{"$ref":"#/components/schemas/IdentityProviderAPIKey"}],"discriminator":{"propertyName":"type","mapping":{"API_KEY":"#/components/schemas/IdentityProviderAPIKey"}}},"IdentityProviderClientList":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/IdentityProviderClient"}}}},"UpdateIdentityProviderClient":{"type":"object","properties":{"metadata":{"$ref":"#/components/schemas/ResourceMeta"},"currentStatus":{"$ref":"#/components/schemas/IdentityProviderClientCurrentStatus"},"desiredState":{"$ref":"#/components/schemas/IdentityProviderClientDesiredState"}}},"JWK":{"type":"object","properties":{"kty":{"type":"string","description":"The cryptographic algorithm family used with the key, such as \"RSA\" or \"EC\"."},"use":{"type":"string","description":"The intended use of the public key, whether for encrypting data or verifying the signature on data."},"key_ops":{"type":"array","items":{"type":"string"},"description":"The operation(s) for which the key is intended to be used."},"alg":{"type":"string","description":"The algorithm intended for use with the key."},"kid":{"type":"string","description":"The key ID used to match a specific key."},"x5u":{"type":"string","description":"The X.509 URL that refers to a resource for an X.509 public key certificate or certificate chain."},"x5c":{"type":"array","items":{"type":"string"},"description":"The X.509 Certificate Chain of one or more PKIX certificates. The PKIX certificate containing the key value MUST be the first certificate."},"x5t":{"type":"string","description":"The X.509 Certificate SHA-1 Thumbprint (a.k.a. digest) of the DER encoding of an X.509 certificate."},"x5t256":{"type":"string","description":"The X.509 Certificate SHA-256 Thumbprint (a.k.a. digest) of the DER encoding of an X.509 certificate."},"p2s":{"type":"string","description":"The salt input value for PBES2 key encryption, which is used as part of the PBKDF2 salt value."},"p2c":{"type":"string","description":"The PBKDF2 iteration count for PBES2 key encryption, represented as a positive JSON integer. The iteration count adds computational expense, ideally compounded by the possible range of keys introduced by the salt. A minimum iteration count of 1000 is RECOMMENDED."},"crv":{"type":"string","description":"The cryptographic curve used for an Elliptic Curve public key."},"x":{"type":"string","description":"The x coordinate of the point for an Elliptic Curve public key."},"y":{"type":"string","description":"The y coordinate of the point for an Elliptic Curve public key."},"e":{"type":"string","description":"The exponent value for an RSA public key."},"exp":{"type":"string","description":"The exponent value for an RSA public key."},"n":{"type":"string","description":"The modulus value for an RSA public key."},"mod":{"type":"string","description":"The modulus value for an RSA public key."},"d":{"type":"string","description":"The private key value for an Elliptic Curve private key OR the private exponent value for an RSA private key."},"p":{"type":"string","description":"The first prime factor for an RSA private key."},"q":{"type":"string","description":"The second prime factor for an RSA private key."},"dp":{"type":"string","description":"The Chinese Remainder Theorem (CRT) exponent of the first factor for an RSA private key."},"dq":{"type":"string","description":"The CRT exponent of the second factor for an RSA private key."},"qi":{"type":"string","description":"The CRT coefficient of the second factor for an RSA private key."},"oth":{"description":"An array of information about any third and subsequent primes, should they exist.","type":"array","items":{"type":"object","properties":{"r":{"type":"string","description":"The prime factor."},"d":{"type":"string","description":"The factor CRT exponent of the corresponding prime factor."},"t":{"type":"string","description":"The factor CRT coefficient of the corresponding prime factor."}}}},"iv":{"type":"string","description":"The base64url-encoded representation of the 96-bit Initialization Vector value used for the AES GCM key encryption operation."},"tag":{"type":"string","description":"The base64url-encoded representation of the 128-bit Authentication Tag value resulting from the AES GCM key encryption operation."},"k":{"type":"string","description":"The key value of the symmetric (or other single-valued) key."},"enc":{"type":"string","description":"The encryption algorithm for JWE."},"epk":{"type":"object","description":"The ephemeral public key value created by the originator for use in ECDH-ES key agreement algorithms."},"apu":{"type":"string","description":"The agreement PartyUInfo for ECDH-ES key agreement algorithms, containing information about the producer."},"apv":{"type":"string","description":"The agreement PartyVInfo for ECDH-ES key agreement algorithms."}}},"JWKInline":{"required":["type","keys"],"type":"object","properties":{"type":{"type":"string","enum":["INLINE"]},"keys":{"type":"array","description":"The JSON Web Keys.\n","items":{"$ref":"#/components/schemas/JWK"},"example":[{"k":"ZmFudGFzdGljand0","kty":"oct","kid":1}]}},"description":"Inline contents of a JWK JSON file.\n"},"JWKRemoteFile":{"required":["uri","type"],"type":"object","properties":{"type":{"type":"string","enum":["REMOTE_FILE"]},"uri":{"type":"string"},"cacheExpire":{"pattern":"^[0-9]+[h|m|s]{1}$","type":"string","description":"The length of time for which to cache the remote file.\nNGINX will retrieve the file from the source URI when the cache time expires.\n","example":"10h"}}},"IdentityProviderAPIKey":{"required":["type"],"type":"object","properties":{"type":{"type":"string","enum":["API_KEY"]},"apiKey":{"type":"string","description":"If left empty, a key will automatically be generated.\nThe apikey must contain only alphanumeric characters, underscores, and hyphens.\nThe length of the apikey must be between 8 - 256 characters.\n","example":"ADv-2ZheQnL_jVx5klhQ39"}}},"SelfLinks":{"type":"object","description":"The SelfLinks object contains a link from the resource to itself.\nThis object is used only in responses.\n","properties":{"rel":{"type":"string","example":"/api/v1/services/environments/prod","description":"`rel` contains the complete path fragment of a URI and can be used\nto construct a query to the object.\n"}}},"ResourceMeta":{"type":"object","required":["name"],"properties":{"name":{"type":"string","pattern":"^[^A-Z\\s\\x00-\\x1f\\x60\\x7f\\;\\*\\\"\\[\\]\\{\\}\\\\\\/%\\?:=&\\~\\^|#<>]+$","minLength":1,"maxLength":1024,"example":"resource-name","description":"Resource name is a unique identifier for a resource within the context of a namespace.\nResource names must conform to [RFC 1738 Section 2.2](https://www.ietf.org/rfc/rfc1738.txt) and have a valid syntax for email addresses. The following rules are enforced:\n\n- do not utilize URL encoding;\n- do not include spaces;\n- do not use uppercase characters, for example, 'A-Z'; extended character sets are supported;\n- do not use the following characters: `\"`, `*`, `:`, `;`, `/`, `\\`, `%`, `?`, `hash`, `=`, `&`, `|`, `~`, `^`, `{`, `}`, `[`, `]`, `<`, `>`;\n- cannot start or end with an `@` sign;\n\nFor example: For a collection resource located at\n\n`https://controller.example.com/api/v1/services/apps/shopping_@1`\n\nthe resource name is \"shopping_@1\".\n"},"displayName":{"type":"string","example":"My Display Name","description":"`displayName` is a user friendly resource name. It can be used to define \na longer, and less constrained, name for a resource.\n\nDisplay names:\n\n- are optional (defaults to an empty string if no value is provided),\n- do not have to be unique, \n- cannot be assigned by the server.\n"},"description":{"type":"string","example":"This is a sample description string. It provides information about the resource.","description":"`description` is a free-form text property. You can use it to provide information that helps \nto identify the resource.\n\nDescriptions:\n\n- are optional (defaults to an empty string if no value is provided),\n- do not have to be unique, \n- cannot be assigned by the server.\n"},"kind":{"type":"string","example":"<collection>-<object>","description":"Kind is a string representation of an API resource's data type.\nIt is assigned by the server and cannot be changed. \n\nWhen creating a `kind`, the server uses hyphens to connect word segments; \nsingleton and collection item resources are not pluralized.\n"},"uid":{"type":"string","format":"uuid","example":"d290f1ee-6c54-4b01-90e6-d701748f0851","description":"Unique Identifier (UID)\n\nUID is a unique identifier in time and space for a resource. \nWhen you create a resource, the server assigns a UID to the resource.\n\nRefer to [IETF RFC 4122](https://tools.ietf.org/html/rfc4122) for more information.\n"},"tags":{"type":"array","items":{"type":"string"},"example":["production_public","dev","new_app","us-west-1","emea"],"description":"You can assign `tags` to a resource as a way to help map, scope, \nand organize resources. \n\nThe system uses tag selectors to specify selection criteria that \nmatch resources that have particular tags.\n"},"ref":{"type":"string","example":"/services/environments/prod","description":"The `ref` field contains a reference to another NGINX Controller resource.\n"},"links":{"$ref":"#/components/schemas/SelfLinks"},"createTime":{"type":"string","format":"date-time","example":"2019-07-29T09:12:33.001Z","description":"A timestamp that represents the server time when the resource was created.\n\nCreate time is not guaranteed to be set in \"happens-before\" order\nacross separate operations.\n\nIn JSON format, `create_time` type is encoded as a string in the\n[RFC 3339](https://www.ietf.org/rfc/rfc3339.txt).\n\nFor example: 2018-04-01T01:30:15.01Z\n\nCreate Time is assigned by the server and cannot be changed.\n"},"updateTime":{"type":"string","format":"date-time","example":"2019-07-29T10:12:33.001Z","description":"A timestamp that represents the server time when the resource was last modified.\n\nResources that have never been updated do not have an `update_time` stamp.\n\nThe default value for resources that have never been updated is the local \nlanguage-specific equivalent of \"null\".\n\nIn JSON format, `update_time` type is encoded as a string as described in \n[RFC 3339](https://www.ietf.org/rfc/rfc3339.txt).\n"}}},"NamedLinks":{"allOf":[{"$ref":"#/components/schemas/SelfLinks"},{"type":"object","description":"Contains information about the object being referred to.\n\nThese are generally details -- like the object name and display name --\nthat are useful to a consumer of the API that performs further\nprocessing. \n\nThis object is only present in responses.\n \n","properties":{"name":{"type":"string","example":"production","description":"The name of the linked resource.\n"},"displayName":{"type":"string","example":"Production Environment","description":"A user friendly resource name."}}}]},"ResourceRef":{"type":"object","required":["ref"],"properties":{"ref":{"type":"string","example":"/services/environments/prod","description":"A reference to another NGINX Controller resource.\n"},"links":{"$ref":"#/components/schemas/NamedLinks"}}},"ConfigStateTally":{"type":"object","properties":{"isConfigured":{"type":"boolean","description":"The configuration operation is complete."},"isConfiguring":{"type":"boolean","description":"The configuration of the resource, or of its child(ren), is in process."},"isError":{"type":"boolean","description":"An error occurred while configuring the resource or its child(ren)."},"isDeleting":{"type":"boolean","description":"A delete operation is in progress for the resource or its child(ren)."},"total":{"type":"integer","description":"The total number of resources to which the configuration operation applies."},"configured":{"type":"integer","description":"The number of resources that have a complete and valid configuration."},"configuring":{"type":"integer","description":"The number of resources that are in the process of being configured."},"error":{"type":"integer","description":"The number of resources that have encountered an error during the configuration process."},"deleting":{"type":"integer","description":"The number of resources that are in the process of being deleted."}}},"ConfigCondition":{"type":"object","properties":{"type":{"type":"string","description":"The condition type."},"message":{"type":"string","description":"A human-readable message that provides additional information about the configuration operation."}}},"ConfigState":{"type":"object","description":"A representation of the resource's current configuration state \nthat comprises the status of the resource itself (`selfConfigState`) and any child \nresources (`childrenConfigState`).\n\nThe conditions array provides additional information during configuration changes.\n","properties":{"selfConfigState":{"$ref":"#/components/schemas/ConfigStateTally"},"childrenConfigState":{"$ref":"#/components/schemas/ConfigStateTally"},"conditions":{"type":"array","items":{"$ref":"#/components/schemas/ConfigCondition"}}}},"ErrorDetail":{"type":"object","required":["description"],"properties":{"description":{"type":"string","example":"Error doing <action>: <reason for error>. This can lead to <potential consequences>. Try <action> to resolve the issue.","description":"A detailed error message returned by the server. \n\nThese messages contain the following information, where applicable:\n\n- What happened.\n- Why it happened.\n- What the consequences are (if any).\n- Recommended action to take to resolve the issue.\n"}}},"ErrorModel":{"type":"object","required":["message","code"],"properties":{"message":{"type":"string","example":"Error doing <action>.","description":"A human-readable message, in English, that describes the error.\n"},"code":{"type":"integer","example":1234567,"description":"A numeric error code that can be used to identify errors for support purposes.\n"},"details":{"type":"array","items":{"$ref":"#/components/schemas/ErrorDetail"}}}}},"parameters":{"identityProviderName":{"name":"identityProviderName","in":"path","description":"The name of the Identity Provider.","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},"identityProviderClientName":{"name":"identityProviderClientName","in":"path","description":"The name of the Identity Provider Client.","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}},"examples":{"IdentityProviderRequest":{"value":{"metadata":{"name":"resource-name","displayName":"My Display Name","description":"This is a sample description string. It provides information about the resource.","tags":["production_public","dev","new_app","us-west-1","emea"]},"desiredState":{"environmentRefs":[{"ref":"/services/environments/dev"}],"identityProvider":{"type":"API_KEY"}}}},"IdentityProviderClientListRequest":{"value":{"items":[{"metadata":{"name":"resource-name","displayName":"My Display Name","description":"This is a sample description string. It provides information about the resource.","tags":["production_public","dev","new_app","us-west-1","emea"]},"desiredState":{"credential":{"type":"API_KEY","apiKey":"ADv2ZheQnLjVx5klhQ39"}}}]}},"IdentityProviderClientRequest":{"value":{"metadata":{"name":"resource-name","displayName":"My Display Name","description":"This is a sample description string. It provides information about the resource.","tags":["production_public","dev","new_app","us-west-1","emea"]},"desiredState":{"credential":{"type":"API_KEY","apiKey":"ADv2ZheQnLjVx5klhQ39"}}}},"IdentityProviderClientPatchMetadataRequest":{"value":{"metadata":{"name":"resource-name","description":"This is a sample description string. It provides information about the resource."}}},"IdentityProviderClientPatchDesiredStateRequest":{"value":{"desiredState":{"credential":{"type":"API_KEY","apiKey":"ADv2ZheQnLjVx5klhQ39"}}}}}}}
/ security / identity-providers
/ security / identity-providers / {identityProviderName}
/ security / identity-providers / {identityProviderName} / clients
/ security / identity-providers / {identityProviderName} / clients / {identityProviderClientName}
Events API OpenAPI	{"openapi":"3.0.0","servers":[{"description":"NGINX Controller API","url":"https://{{CONTROLLER_FQDN}}/api/v1"}],"info":{"description":"Use the Events API to retrieve information about system Events.","version":"v1","title":"Events API"},"paths":{"/analytics/events":{"get":{"tags":["Events"],"summary":"Get Events","operationId":"queryEvents","description":"Returns a list of system Events.","parameters":[{"name":"startTime","in":"query","description":"Indicates the start of the time window to include Events from (inclusive).\n\n- Must be provided if `endTime` was specified.\n- If you do not set 'startTime`, the most recent 100 Events will be returned.\n- `startTime` and `endTime` can be formatted as Event IDs (UUID format). If you use this format for any boundary, the validity of that boundary (for example, if endTime is greater than startTime) will not be checked.\n","schema":{"$ref":"#/components/schemas/Time"}},{"name":"endTime","in":"query","description":"Indicates the end of the time window to include Events from (non-inclusive).\n\n- Must be greater than `startTime`.\n- Must be provided if `startTime` was specified.\n","schema":{"$ref":"#/components/schemas/Time"}},{"name":"filter","in":"query","description":"Filters results based on dimension values.\n\nConsists of one or more predicates in the form `<dimension><operator><dimension value>` where:\n- `<dimension>` is the name of the dimension,\n- `<operator>` is one of the supported operators (`=`, `!=`, `<`, `<=`, `>=` `>`, `in` or `not`)\n- `<dimension value>` is the value of the dimension(s) that you want to filter on,\n- `<dimension> and <dimension value>` are case sensitive.\n\nFor example: 'count > 100'\n\nPredicates can be combined into logical expressions using `OR`, `AND`, and `(` `)`.\nFor matching values, wildcard (`*`) use is supported.\n\nWrapping predicates in single quotes is recommended to ensure that the full query string is processed correctly.\n","schema":{"type":"string","example":"category IN ('agent','controller') AND level='debug' AND count > 100"},"allowReserved":true},{"name":"orderBy","in":"query","description":"Indicates how the results will be ordered.\n\nConsists of at most three comma-separated clauses in the form `<dimension><single space><sort order>` or `<dimension>` where:\n- `<dimension>` is the name of the dimension.\n- `<sort order>` is the order by which the specified dimension will be sorted. Valid sort order is either \"ASC\" for ascending order, or \"DESC\" for descending order. If no sort order is provided, the default one (\"ASC\") will be used.\n\nNote that if no orderBy is provided, the default combination of descending \"timestamp\" and ascending \"id\" will be used regardless. If you provide different order for \"timestamp\" or \"id\" in orderBy, the default one will be overwritten.\n","schema":{"type":"string","example":"name ASC,timestamp DESC"}},{"name":"page","in":"query","description":"page number","required":false,"schema":{"type":"integer","default":1,"example":1}},{"name":"pageToken","in":"query","description":"Transactional token used for pagination.\n\nThe token ensures consistency of the query results across requests for various pages of data. It provides a snapshot of the database contents from the time at which the query was received.\n\nIf `pageToken` is not provided with a page request, a token is automatically generated and will be returned in the response metadata. You should include the token in subsequent requests for pages in the query results.\n\nSending a query without a `pageToken` refreshes the query results.\n","schema":{"type":"string","example":"1573653786"}},{"name":"pageSize","in":"query","description":"Defines the number of returned items per page.\n\n- The maximum value is 100. If value is greater, it is automatically set down to 100.\n- If `pageSize`=0, pagination is disabled and all Events will be returned in response.\n- The response size is limited to 10,000 results. If the number of results exceeds 10,000 a warning is returned.\n","schema":{"type":"integer","default":100,"example":10}},{"name":"includeTotal","in":"query","description":"Defines if the Metadata should include the total count of events.\n","schema":{"type":"boolean","default":false,"example":true}}],"responses":{"200":{"description":"Successfully returned the requested Events.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventQueryResult"}}}},"400":{"description":"Bad input parameter, or possibly a bad URI. Check the input for typos and try again.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}}}}},"/analytics/events/{id}":{"get":{"tags":["Events"],"summary":"Get an Event","operationId":"queryEventsById","description":"Returns the specified Event.","parameters":[{"name":"id","in":"path","description":"Identifies the Event that you want to retrieve.","required":true,"schema":{"type":"string","example":"00112233-4455-6677-8899-aabbccddeeff"}}],"responses":{"200":{"description":"Successfully retrieved the requested Event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Event"}}}},"400":{"description":"Bad input parameter, or possibly a bad URI. Check the input for typos and try again.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}}}}}},"components":{"schemas":{"Time":{"description":"Indicates a point in time.\n\nYou can provide time using ISO 8601 format or as an offset. An offset is a string that starts with `+` or `-`, followed by a number and a unit of time (`y`, `M`, `w`, `d`, `h`, `m` or `s`).\nExamples: \"2019-08-07T09:57:36.088757764Z\", \"now-3h\"\n","type":"string","example":"2019-08-07T09:57:36.088757764Z"},"EventQueryResult":{"type":"object","properties":{"Metadata":{"$ref":"#/components/schemas/Metadata"},"items":{"type":"array","items":{"$ref":"#/components/schemas/Event"}}}},"Event":{"type":"object","description":"An Event is a system message.","properties":{"timestamp":{"type":"string","format":"date-time","example":"2019-08-07T09:57:36.088757764Z"},"id":{"type":"string","format":"uuid","example":"00112233-4455-6677-8899-aabbccddeeff"},"message":{"type":"string","example":"nginx stub_status detected, https://127.0.0.1:443/basic_status"},"count":{"type":"integer","example":99},"category":{"type":"string"},"level":{"type":"string","enum":["DEBUG","INFO","WARNING","ERROR","CRITICAL"],"example":"INFO"},"hostname":{"type":"string","example":"d0784771a503"},"alias":{"type":"string","example":"my_system"},"status":{"type":"string","example":"success"},"error":{"type":"string"},"local_id":{"type":"string","example":"d23c85484ee760ee5f4619c0434e1968b5290964487541da0889964eb783613c"},"root_uuid":{"type":"string","example":"759e842f6b9f51a7803f57da1e9f5ae8"},"tags":{"type":"array","items":{"type":"string"},"example":"[\"tag1\", \"tag2\"]"},"instance":{"type":"string","example":"2"},"location":{"type":"string","example":"unspecified"},"correlationId":{"type":"string","example":"e5f355e4de82edd0afcd74ef6c1ee6aa"},"http.request_endpoint":{"type":"string","example":"/services/environments/dev/apps/app/components/25"},"http.request_method":{"type":"string","example":"POST"},"user":{"type":"string","example":"admin@nginx.test"},"environment":{"type":"string","example":"dev-environment"},"app":{"type":"string","example":"finance-app"},"component":{"type":"string","example":"secure-component"},"gateway":{"type":"string","example":"dev-gateway"},"request_outcome":{"type":"string","enum":["REJECTED","PASSED"],"example":"REJECTED"},"request_outcome_reason":{"type":"string","enum":["SECURITY_WAF_OK","SECURITY_WAF_VIOLATION","SECURITY_WAF_FLAGGED","SECURITY_WAF_BYPASS","SECURITY_NGINX_VIOLATION"],"example":"SECURITY_WAF_FLAGGED"},"http.response_code":{"type":"integer","example":200},"http.hostname":{"type":"string","example":"itay-108-117.f5net.com"},"http.remote_addr":{"type":"string","example":"127.0.0.1"},"http.remote_port":{"type":"integer","example":4000},"http.server_addr":{"type":"string","example":"0.0.0.0"},"http.server_port":{"type":"integer","example":80},"http.request":{"type":"string","example":"GET /test.exe HTTP/1.1\\r\\nUser-Agent: curl/7.29.0\\r\\nHost: localhost\\r\\nAccept: */*\\r\\n"},"waf.support_id":{"type":"string","example":"161339000577578694"},"waf.signature_ids":{"type":"string","example":"200001475,200000098"},"waf.policy":{"type":"string","example":"/Common/policy1"},"waf.attack_types":{"type":"string","example":"Non-browser Client,Abuse of Functionality,Cross Site Scripting (XSS)"},"waf.violation_rating":{"type":"string","enum":["RISK_COULD_NOT_BE_DETERMINED","POSSIBLE_ATTACK","MOST_LIKELY_ATTACK"],"example":"MOST_LIKELY_ATTACK"},"waf.signature_names":{"type":"string","example":"XSS script tag end (Parameter) (2),XSS script tag (Parameter)"},"waf.is_truncated":{"type":"string","example":"true"},"waf.signature_cves":{"type":"string","example":"CVE-2017-8759,CVE-2015-1641"},"waf.sub_violations":{"type":"string","example":"HTTP protocol compliance failed:Host header contains IP address"},"waf.violations":{"type":"string","example":"HTTP protocol compliance failed,Illegal meta character in value,Attack signature detected"},"waf.x_forwarded_for_header_value":{"type":"string","example":"87.233.120.158"},"waf.bot_anomalies":{"type":"string","example":"Search Engine Verification Failed"},"waf.bot_category":{"type":"string","example":"Search Engine"},"waf.bot_client_class":{"type":"string","example":"Malicious Bot"},"waf.bot_signature_name":{"type":"string","example":"Google"},"waf.enforced_bot_anomalies":{"type":"string","example":"Search Engine Verification Failed"},"action_type":{"type":"string","example":"login"},"action_outcome":{"type":"string","example":"success"},"auth_provider.name":{"type":"string","example":"local"},"auth_provider.type":{"type":"string","example":"BASIC"},"resource_name":{"type":"string","example":"datadog-forwarder"},"big_ip_address":{"type":"string","example":"https://87.233.120.158"},"workload_health_state":{"type":"string","example":"unhealthy"}}},"Metadata":{"type":"object","properties":{"pagination":{"$ref":"#/components/schemas/MetadataPagination"}}},"MetadataPagination":{"type":"object","required":["pageToken"],"properties":{"pageToken":{"type":"string","example":"1594048781"},"links":{"$ref":"#/components/schemas/PaginationLinks"},"total":{"type":"integer","example":3600}}},"PaginationLinks":{"type":"object","properties":{"next":{"$ref":"#/components/schemas/SelfLinks"},"prev":{"$ref":"#/components/schemas/SelfLinks"}}},"ErrorModel":{"type":"object","required":["message","code"],"properties":{"message":{"type":"string","example":"Invalid filter param key: 'server'","description":"Support oriented and human readable error message in English.\nThe message explains the error condition and may offer a solution.\n"},"code":{"type":"integer","example":0,"description":"Support oriented numerical error code in English.\nNote that this is not the HTTP code representing the error.\nThe message should explain the error.\n"},"details":{"type":"array","items":{"$ref":"#/components/schemas/ErrorDetail"}}}},"ErrorDetail":{"type":"object","required":["description"],"properties":{"description":{"type":"string","description":"An internal error detail returned from the server.\n"}}},"SelfLinks":{"type":"object","description":"The SelfLinks object includes links to the resource.\n\nThe object is used only in responses.\n","properties":{"rel":{"type":"string","example":"/api/v1/analytics/events?pageToken=1594048781&page=2","description":"`rel` contains the complete path fragment of a URI and can be used\nto construct a query to the object."}}}}}}
/ analytics / events
/ analytics / events / {id}
Services API OpenAPI	{"openapi":"3.0.0","servers":[{"description":"NGINX Controller API","url":"https://{{CONTROLLER_FQDN}}/api/v1"}],"info":{"title":"Services API","description":"Use the Services API to request a metadata list of a desired resource within a single environment or across all environments.\nCurrently supported resources include:\n - published-apis\n","version":"v1"},"paths":{"/services":{"x-f5-experimental":true,"get":{"tags":["Services"],"summary":"List the metadata for all instances of the desired resource.","description":"Returns a metadata list of the requested resource. The resources that can be queried is currently restricted to published-apis.\n","operationId":"listResources","responses":{"200":{"description":"Successfully retrieved a metadata list of the requested resource.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ResourceMeta"}}}}},"400":{"description":"The resource defined in the query parameters could not be found or is not yet supported. Check the input for typos and try again.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"404":{"description":"The environment defined in the query parameters could not be found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}}}},"parameters":[{"name":"resource","in":"query","description":"Desired resource to list.","required":true,"style":"form","explode":false,"schema":{"type":"string","enum":["published-apis"]}},{"name":"environment","in":"query","description":"Filter desired resource based on the environment.","required":false,"style":"form","explode":false,"schema":{"type":"string"}}]}},"components":{"schemas":{"SelfLinks":{"type":"object","description":"The SelfLinks object contains a link from the resource to itself.\nThis object is used only in responses.\n","properties":{"rel":{"type":"string","example":"/api/v1/services/environments/prod","description":"`rel` contains the complete path fragment of a URI and can be used\nto construct a query to the object.\n"}}},"ResourceMeta":{"type":"object","required":["name"],"properties":{"name":{"type":"string","pattern":"^[^A-Z\\s\\x00-\\x1f\\x60\\x7f\\;\\*\\\"\\[\\]\\{\\}\\\\\\/%\\?:=&\\~\\^|#<>]+$","minLength":1,"maxLength":1024,"example":"resource-name","description":"Resource name is a unique identifier for a resource within the context of a namespace.\nResource names must conform to [RFC 1738 Section 2.2](https://www.ietf.org/rfc/rfc1738.txt) and have a valid syntax for email addresses. The following rules are enforced:\n\n- do not utilize URL encoding;\n- do not include spaces;\n- do not use uppercase characters, for example, 'A-Z'; extended character sets are supported;\n- do not use the following characters: `\"`, `*`, `:`, `;`, `/`, `\\`, `%`, `?`, `hash`, `=`, `&`, `|`, `~`, `^`, `{`, `}`, `[`, `]`, `<`, `>`;\n- cannot start or end with an `@` sign;\n\nFor example: For a collection resource located at\n\n`https://controller.example.com/api/v1/services/apps/shopping_@1`\n\nthe resource name is \"shopping_@1\".\n"},"displayName":{"type":"string","example":"My Display Name","description":"`displayName` is a user friendly resource name. It can be used to define \na longer, and less constrained, name for a resource.\n\nDisplay names:\n\n- are optional (defaults to an empty string if no value is provided),\n- do not have to be unique, \n- cannot be assigned by the server.\n"},"description":{"type":"string","example":"This is a sample description string. It provides information about the resource.","description":"`description` is a free-form text property. You can use it to provide information that helps \nto identify the resource.\n\nDescriptions:\n\n- are optional (defaults to an empty string if no value is provided),\n- do not have to be unique, \n- cannot be assigned by the server.\n"},"kind":{"type":"string","example":"<collection>-<object>","description":"Kind is a string representation of an API resource's data type.\nIt is assigned by the server and cannot be changed. \n\nWhen creating a `kind`, the server uses hyphens to connect word segments; \nsingleton and collection item resources are not pluralized.\n"},"uid":{"type":"string","format":"uuid","example":"d290f1ee-6c54-4b01-90e6-d701748f0851","description":"Unique Identifier (UID)\n\nUID is a unique identifier in time and space for a resource. \nWhen you create a resource, the server assigns a UID to the resource.\n\nRefer to [IETF RFC 4122](https://tools.ietf.org/html/rfc4122) for more information.\n"},"tags":{"type":"array","items":{"type":"string"},"example":["production_public","dev","new_app","us-west-1","emea"],"description":"You can assign `tags` to a resource as a way to help map, scope, \nand organize resources. \n\nThe system uses tag selectors to specify selection criteria that \nmatch resources that have particular tags.\n"},"ref":{"type":"string","example":"/services/environments/prod","description":"The `ref` field contains a reference to another NGINX Controller resource.\n"},"links":{"$ref":"#/components/schemas/SelfLinks"},"createTime":{"type":"string","format":"date-time","example":"2019-07-29T09:12:33.001Z","description":"A timestamp that represents the server time when the resource was created.\n\nCreate time is not guaranteed to be set in \"happens-before\" order\nacross separate operations.\n\nIn JSON format, `create_time` type is encoded as a string in the\n[RFC 3339](https://www.ietf.org/rfc/rfc3339.txt).\n\nFor example: 2018-04-01T01:30:15.01Z\n\nCreate Time is assigned by the server and cannot be changed.\n"},"updateTime":{"type":"string","format":"date-time","example":"2019-07-29T10:12:33.001Z","description":"A timestamp that represents the server time when the resource was last modified.\n\nResources that have never been updated do not have an `update_time` stamp.\n\nThe default value for resources that have never been updated is the local \nlanguage-specific equivalent of \"null\".\n\nIn JSON format, `update_time` type is encoded as a string as described in \n[RFC 3339](https://www.ietf.org/rfc/rfc3339.txt).\n"}}},"ErrorDetail":{"type":"object","required":["description"],"properties":{"description":{"type":"string","example":"Error doing <action>: <reason for error>. This can lead to <potential consequences>. Try <action> to resolve the issue.","description":"A detailed error message returned by the server. \n\nThese messages contain the following information, where applicable:\n\n- What happened.\n- Why it happened.\n- What the consequences are (if any).\n- Recommended action to take to resolve the issue.\n"}}},"ErrorModel":{"type":"object","required":["message","code"],"properties":{"message":{"type":"string","example":"Error doing <action>.","description":"A human-readable message, in English, that describes the error.\n"},"code":{"type":"integer","example":1234567,"description":"A numeric error code that can be used to identify errors for support purposes.\n"},"details":{"type":"array","items":{"$ref":"#/components/schemas/ErrorDetail"}}}}}}}
/ services
Policies API OpenAPI	{"openapi":"3.0.0","servers":[{"description":"NGINX Controller API","url":"https://{{CONTROLLER_FQDN}}/api/v1"}],"info":{"description":"Use the Policies API to manage the policies used to secure your App traffic.","version":"v1","title":"Policies API"},"paths":{"/security/policies":{"x-f5-experimental":true,"get":{"x-f5-experimental":true,"tags":["Policies"],"summary":"List all Policies","description":"Returns a list of Policy metadata objects for all of the Policies.","operationId":"listPolicies","responses":{"200":{"description":"Successfully retrieved a list of Policies.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PolicyList"}}}},"400":{"description":"Bad input parameter, or possibly a bad URI. Check the input for typos and try again.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"404":{"description":"The resource defined in the URI could not be found. Check the URI for errors and try again.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}}}},"post":{"x-f5-experimental":true,"tags":["Policies"],"summary":"Create a Policy","operationId":"createPolicy","description":"Creates a new Policy resource.\n","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Policy"}}}},"responses":{"201":{"description":"Successfully created the specified Policy resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PolicyStatus"}}}},"400":{"description":"Bad input parameter, or possibly a bad URI. Check the input for typos and try again.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"404":{"description":"The resource defined in the URI could not be found. Check the URI for errors and try again.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"409":{"description":"The request failed due to a naming conflict with an existing resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}}}}},"/security/policies/{policyName}":{"get":{"x-f5-experimental":true,"tags":["Policies"],"summary":"Get a Policy","operationId":"getPolicy","description":"Returns information for a specific Policy resource.","responses":{"200":{"description":"Sucessfully retrieved the requested Policy.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PolicyStatus"}}}},"400":{"description":"Bad input parameter, or possibly a bad URI. Check the input for typos and try again.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"404":{"description":"The resource defined in the URI could not be found. Check the URI for errors and try again.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}}}},"put":{"x-f5-experimental":true,"tags":["Policies"],"summary":"Upsert a Policy","operationId":"updatePolicy","description":"Creates a new Policy or updates an existing Policy resource.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Policy"}}}},"responses":{"200":{"description":"Sucessfully updated the specified Policy resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PolicyStatus"}}}},"201":{"description":"Successfully created the requested Policy resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PolicyStatus"}}}},"400":{"description":"Bad input parameter, or possibly a bad URI. Check the input for typos and try again.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"404":{"description":"The resource defined in the URI could not be found. Check the URI for errors and try again.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}}}},"delete":{"x-f5-experimental":true,"tags":["Policies"],"summary":"Delete a Policy","operationId":"deletePolicy","description":"Deletes the specified Policy resource.","responses":{"204":{"description":"The specified Policy resource was successfully deleted."},"404":{"description":"The resource defined in the URI could not be found. Check the URI for errors and try again.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"409":{"description":"The request to delete the specified Policy resource failed.\nThe Policy is referenced by active objects and cannot be deleted. Delete the referencing objects or remove the references, then try again.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}}}},"parameters":[{"name":"policyName","description":"The name of the Policy.","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ResourceName"}}]}},"components":{"schemas":{"ResourceName":{"type":"string","description":"The name of a resource.","example":"production"},"PolicyDesiredState":{"type":"object","description":"The defired state of the policy","required":["content"],"properties":{"content":{"type":"object","$ref":"#/components/schemas/PolicyData","example":"{\"policy\": {\"name\": \"/Common/NAPBlockingDefaultPolicy\", \"template\": {\"name\": \"POLICY_TEMPLATE_NGINX_BASE\"}, \"applicationLanguage\": \"utf-8\", \"enforcementMode\": \"blocking\", \"signatures\": [], \"bot-defense\": {\"settings\": {\"isEnabled\": false}}, \"headers\": [{\"name\": \"*\", \"type\": \"wildcard\", \"decodeValueAsBase64\": \"disabled\"}, {\"name\": \"*-bin\", \"type\": \"wildcard\", \"decodeValueAsBase64\": \"required\"},{\"name\": \"Referer\", \"type\": \"explicit\", \"decodeValueAsBase64\": \"disabled\"}, {\"name\": \"Authorization\", \"type\": \"explicit\", \"decodeValueAsBase64\": \"disabled\"}, {\"name\": \"Transfer-Encoding\", \"type\": \"explicit\", \"decodeValueAsBase64\": \"disabled\"}], \"cookies\": [{\"name\": \"*\", \"type\": \"wildcard\", \"decodeValueAsBase64\": \"disabled\"}], \"parameters\": [{\"name\": \"*\", \"type\": \"wildcard\", \"decodeValueAsBase64\": \"disabled\"}]}}"}}},"PolicyList":{"type":"object","required":["items"],"properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/PolicyStatus"}}}},"PolicyStatus":{"type":"object","required":["metadata","desiredState","currentStatus"],"properties":{"metadata":{"$ref":"#/components/schemas/ResourceMeta"},"desiredState":{"$ref":"#/components/schemas/PolicyDesiredState"},"currentStatus":{"$ref":"#/components/schemas/PolicyCurrentStatus"}}},"PolicyCurrentStatus":{"type":"object","description":"Shows the current status of the policy.","required":["state","data"],"properties":{"content":{"type":"object","$ref":"#/components/schemas/PolicyData"},"state":{"$ref":"#/components/schemas/ConfigState"}}},"Policy":{"type":"object","description":"Contains the policy to upload.","required":["metadata","desiredState"],"properties":{"metadata":{"$ref":"#/components/schemas/ResourceMeta"},"desiredState":{"$ref":"#/components/schemas/PolicyDesiredState"}}},"PolicyData":{"type":"object","description":"Contains the policy to upload."},"SelfLinks":{"type":"object","description":"The SelfLinks object contains a link from the resource to itself.\nThis object is used only in responses.\n","properties":{"rel":{"type":"string","example":"/api/v1/services/environments/prod","description":"`rel` contains the complete path fragment of a URI and can be used\nto construct a query to the object.\n"}}},"ResourceMeta":{"type":"object","required":["name"],"properties":{"name":{"type":"string","pattern":"^[^A-Z\\s\\x00-\\x1f\\x60\\x7f\\;\\*\\\"\\[\\]\\{\\}\\\\\\/%\\?:=&\\~\\^|#<>]+$","minLength":1,"maxLength":1024,"example":"resource-name","description":"Resource name is a unique identifier for a resource within the context of a namespace.\nResource names must conform to [RFC 1738 Section 2.2](https://www.ietf.org/rfc/rfc1738.txt) and have a valid syntax for email addresses. The following rules are enforced:\n\n- do not utilize URL encoding;\n- do not include spaces;\n- do not use uppercase characters, for example, 'A-Z'; extended character sets are supported;\n- do not use the following characters: `\"`, `*`, `:`, `;`, `/`, `\\`, `%`, `?`, `hash`, `=`, `&`, `|`, `~`, `^`, `{`, `}`, `[`, `]`, `<`, `>`;\n- cannot start or end with an `@` sign;\n\nFor example: For a collection resource located at\n\n`https://controller.example.com/api/v1/services/apps/shopping_@1`\n\nthe resource name is \"shopping_@1\".\n"},"displayName":{"type":"string","example":"My Display Name","description":"`displayName` is a user friendly resource name. It can be used to define \na longer, and less constrained, name for a resource.\n\nDisplay names:\n\n- are optional (defaults to an empty string if no value is provided),\n- do not have to be unique, \n- cannot be assigned by the server.\n"},"description":{"type":"string","example":"This is a sample description string. It provides information about the resource.","description":"`description` is a free-form text property. You can use it to provide information that helps \nto identify the resource.\n\nDescriptions:\n\n- are optional (defaults to an empty string if no value is provided),\n- do not have to be unique, \n- cannot be assigned by the server.\n"},"kind":{"type":"string","example":"<collection>-<object>","description":"Kind is a string representation of an API resource's data type.\nIt is assigned by the server and cannot be changed. \n\nWhen creating a `kind`, the server uses hyphens to connect word segments; \nsingleton and collection item resources are not pluralized.\n"},"uid":{"type":"string","format":"uuid","example":"d290f1ee-6c54-4b01-90e6-d701748f0851","description":"Unique Identifier (UID)\n\nUID is a unique identifier in time and space for a resource. \nWhen you create a resource, the server assigns a UID to the resource.\n\nRefer to [IETF RFC 4122](https://tools.ietf.org/html/rfc4122) for more information.\n"},"tags":{"type":"array","items":{"type":"string"},"example":["production_public","dev","new_app","us-west-1","emea"],"description":"You can assign `tags` to a resource as a way to help map, scope, \nand organize resources. \n\nThe system uses tag selectors to specify selection criteria that \nmatch resources that have particular tags.\n"},"ref":{"type":"string","example":"/services/environments/prod","description":"The `ref` field contains a reference to another NGINX Controller resource.\n"},"links":{"$ref":"#/components/schemas/SelfLinks"},"createTime":{"type":"string","format":"date-time","example":"2019-07-29T09:12:33.001Z","description":"A timestamp that represents the server time when the resource was created.\n\nCreate time is not guaranteed to be set in \"happens-before\" order\nacross separate operations.\n\nIn JSON format, `create_time` type is encoded as a string in the\n[RFC 3339](https://www.ietf.org/rfc/rfc3339.txt).\n\nFor example: 2018-04-01T01:30:15.01Z\n\nCreate Time is assigned by the server and cannot be changed.\n"},"updateTime":{"type":"string","format":"date-time","example":"2019-07-29T10:12:33.001Z","description":"A timestamp that represents the server time when the resource was last modified.\n\nResources that have never been updated do not have an `update_time` stamp.\n\nThe default value for resources that have never been updated is the local \nlanguage-specific equivalent of \"null\".\n\nIn JSON format, `update_time` type is encoded as a string as described in \n[RFC 3339](https://www.ietf.org/rfc/rfc3339.txt).\n"}}},"ConfigStateTally":{"type":"object","properties":{"isConfigured":{"type":"boolean","description":"The configuration operation is complete."},"isConfiguring":{"type":"boolean","description":"The configuration of the resource, or of its child(ren), is in process."},"isError":{"type":"boolean","description":"An error occurred while configuring the resource or its child(ren)."},"isDeleting":{"type":"boolean","description":"A delete operation is in progress for the resource or its child(ren)."},"total":{"type":"integer","description":"The total number of resources to which the configuration operation applies."},"configured":{"type":"integer","description":"The number of resources that have a complete and valid configuration."},"configuring":{"type":"integer","description":"The number of resources that are in the process of being configured."},"error":{"type":"integer","description":"The number of resources that have encountered an error during the configuration process."},"deleting":{"type":"integer","description":"The number of resources that are in the process of being deleted."}}},"ConfigCondition":{"type":"object","properties":{"type":{"type":"string","description":"The condition type."},"message":{"type":"string","description":"A human-readable message that provides additional information about the configuration operation."}}},"ConfigState":{"type":"object","description":"A representation of the resource's current configuration state \nthat comprises the status of the resource itself (`selfConfigState`) and any child \nresources (`childrenConfigState`).\n\nThe conditions array provides additional information during configuration changes.\n","properties":{"selfConfigState":{"$ref":"#/components/schemas/ConfigStateTally"},"childrenConfigState":{"$ref":"#/components/schemas/ConfigStateTally"},"conditions":{"type":"array","items":{"$ref":"#/components/schemas/ConfigCondition"}}}},"ErrorDetail":{"type":"object","required":["description"],"properties":{"description":{"type":"string","example":"Error doing <action>: <reason for error>. This can lead to <potential consequences>. Try <action> to resolve the issue.","description":"A detailed error message returned by the server. \n\nThese messages contain the following information, where applicable:\n\n- What happened.\n- Why it happened.\n- What the consequences are (if any).\n- Recommended action to take to resolve the issue.\n"}}},"ErrorModel":{"type":"object","required":["message","code"],"properties":{"message":{"type":"string","example":"Error doing <action>.","description":"A human-readable message, in English, that describes the error.\n"},"code":{"type":"integer","example":1234567,"description":"A numeric error code that can be used to identify errors for support purposes.\n"},"details":{"type":"array","items":{"$ref":"#/components/schemas/ErrorDetail"}}}}}}}
/ security / policies
/ security / policies / {policyName}
Environments API OpenAPI	{"openapi":"3.0.0","servers":[{"description":"NGINX Controller API","url":"https://{{CONTROLLER_FQDN}}/api/v1"}],"info":{"title":"Environments API","description":"Use the Environments API to manage your Application Environments.","version":"v1"},"paths":{"/services/environments":{"get":{"tags":["Environments"],"summary":"List all Environments","description":"Returns a list of all Environment resources.\n","operationId":"listEnvironments","responses":{"200":{"description":"Successfully retrieved a list of all Environment resources.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/EnvironmentList"}}}}},"400":{"description":"Bad input parameter, or possibly a bad URI. Check the input for typos and try again.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}}}},"post":{"tags":["Environments"],"summary":"Create an Environment","description":"Creates a new Environment resource.\n","operationId":"createEnvironment","requestBody":{"description":"Defines the Environment resource to create.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Environment"}}}},"responses":{"201":{"description":"Successfully created the specified Environment.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Environment"}}}},"202":{"description":"The Environment resource has been accepted for creation. The Environment will be created after it is done configuring.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Environment"}}}},"400":{"description":"Bad input parameter, or possibly a bad URI. Check the input for typos and try again.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"409":{"description":"The request failed due to a naming conflict with an existing resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}}}}},"/services/environments/{environmentName}":{"get":{"tags":["Environments"],"summary":"Get an Environment","description":"Returns information for the specified Environment.\n","operationId":"getEnvironment","responses":{"200":{"description":"Successfully returned information for the specified Environment resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Environment"}}}},"400":{"description":"Bad input parameter, or possibly a bad URI. Check the input for typos and try again.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"404":{"description":"The resource defined in the URI could not be found. Check the URI for errors and try again.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}}}},"put":{"tags":["Environments"],"summary":"Upsert an Environment","description":"Creates a new Environment or updates an existing Environment resource.\n","operationId":"updateEnvironment","requestBody":{"description":"Defines the Environment to create or the updates to make to an existing Environment.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Environment"}}}},"responses":{"200":{"description":"Successfully updated the specified Environment resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Environment"}}}},"201":{"description":"Successfully created the specified Environment resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Environment"}}}},"202":{"description":"The Environment resource has been accepted for creation or update. The Environment will be created or updated after it is done configuring.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Environment"}}}},"400":{"description":"Bad input parameter, or possibly a bad URI. Check the input for typos and try again.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"404":{"description":"The resource defined in the URI could not be found. Check the URI for errors and try again.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}}}},"delete":{"tags":["Environments"],"summary":"Delete an Environment","description":"Deletes the specified Environment resource.","operationId":"deleteEnvironment","responses":{"202":{"description":"The Environment resource has been marked for deletion. The Environment will be deleted after the underlying resources have been deleted.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Environment"}}}},"204":{"description":"Successfully deleted the specified Environment resource. No content returned.\n"},"404":{"description":"The resource defined in the URI could not be found. Check the URI for errors and try again.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"409":{"description":"Failed to delete the requested Environment resource.\n\nThe Environment contains references to other objects. Delete the referenced objects or remove the references, then try again.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}}}},"parameters":[{"name":"environmentName","description":"The name of the Environment.","in":"path","required":true,"schema":{"$ref":"#/components/schemas/EnvironmentName"}}]}},"components":{"schemas":{"EnvironmentList":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/Environment"}}}},"Environment":{"type":"object","description":"An Environment is a logical container that you can use to organize your Apps. A few commonly-used examples of Environments are \"dev\" and \"production\".","required":["metadata"],"properties":{"metadata":{"$ref":"#/components/schemas/ResourceMeta"},"desiredState":{"x-f5-experimental":true,"type":"object"},"currentStatus":{"$ref":"#/components/schemas/EnvironmentCurrentStatus"}}},"EnvironmentCurrentStatus":{"type":"object","properties":{"state":{"$ref":"#/components/schemas/ConfigState"},"gatewayRefs":{"type":"array","items":{"$ref":"#/components/schemas/ResourceRef"}},"appRefs":{"type":"array","items":{"$ref":"#/components/schemas/ResourceRef"}},"certRefs":{"type":"array","items":{"$ref":"#/components/schemas/ResourceRef"}}}},"SelfLinks":{"type":"object","description":"The SelfLinks object contains a link from the resource to itself.\nThis object is used only in responses.\n","properties":{"rel":{"type":"string","example":"/api/v1/services/environments/prod","description":"`rel` contains the complete path fragment of a URI and can be used\nto construct a query to the object.\n"}}},"ResourceMeta":{"type":"object","required":["name"],"properties":{"name":{"type":"string","pattern":"^[^A-Z\\s\\x00-\\x1f\\x60\\x7f\\;\\*\\\"\\[\\]\\{\\}\\\\\\/%\\?:=&\\~\\^|#<>]+$","minLength":1,"maxLength":1024,"example":"resource-name","description":"Resource name is a unique identifier for a resource within the context of a namespace.\nResource names must conform to [RFC 1738 Section 2.2](https://www.ietf.org/rfc/rfc1738.txt) and have a valid syntax for email addresses. The following rules are enforced:\n\n- do not utilize URL encoding;\n- do not include spaces;\n- do not use uppercase characters, for example, 'A-Z'; extended character sets are supported;\n- do not use the following characters: `\"`, `*`, `:`, `;`, `/`, `\\`, `%`, `?`, `hash`, `=`, `&`, `|`, `~`, `^`, `{`, `}`, `[`, `]`, `<`, `>`;\n- cannot start or end with an `@` sign;\n\nFor example: For a collection resource located at\n\n`https://controller.example.com/api/v1/services/apps/shopping_@1`\n\nthe resource name is \"shopping_@1\".\n"},"displayName":{"type":"string","example":"My Display Name","description":"`displayName` is a user friendly resource name. It can be used to define \na longer, and less constrained, name for a resource.\n\nDisplay names:\n\n- are optional (defaults to an empty string if no value is provided),\n- do not have to be unique, \n- cannot be assigned by the server.\n"},"description":{"type":"string","example":"This is a sample description string. It provides information about the resource.","description":"`description` is a free-form text property. You can use it to provide information that helps \nto identify the resource.\n\nDescriptions:\n\n- are optional (defaults to an empty string if no value is provided),\n- do not have to be unique, \n- cannot be assigned by the server.\n"},"kind":{"type":"string","example":"<collection>-<object>","description":"Kind is a string representation of an API resource's data type.\nIt is assigned by the server and cannot be changed. \n\nWhen creating a `kind`, the server uses hyphens to connect word segments; \nsingleton and collection item resources are not pluralized.\n"},"uid":{"type":"string","format":"uuid","example":"d290f1ee-6c54-4b01-90e6-d701748f0851","description":"Unique Identifier (UID)\n\nUID is a unique identifier in time and space for a resource. \nWhen you create a resource, the server assigns a UID to the resource.\n\nRefer to [IETF RFC 4122](https://tools.ietf.org/html/rfc4122) for more information.\n"},"tags":{"type":"array","items":{"type":"string"},"example":["production_public","dev","new_app","us-west-1","emea"],"description":"You can assign `tags` to a resource as a way to help map, scope, \nand organize resources. \n\nThe system uses tag selectors to specify selection criteria that \nmatch resources that have particular tags.\n"},"ref":{"type":"string","example":"/services/environments/prod","description":"The `ref` field contains a reference to another NGINX Controller resource.\n"},"links":{"$ref":"#/components/schemas/SelfLinks"},"createTime":{"type":"string","format":"date-time","example":"2019-07-29T09:12:33.001Z","description":"A timestamp that represents the server time when the resource was created.\n\nCreate time is not guaranteed to be set in \"happens-before\" order\nacross separate operations.\n\nIn JSON format, `create_time` type is encoded as a string in the\n[RFC 3339](https://www.ietf.org/rfc/rfc3339.txt).\n\nFor example: 2018-04-01T01:30:15.01Z\n\nCreate Time is assigned by the server and cannot be changed.\n"},"updateTime":{"type":"string","format":"date-time","example":"2019-07-29T10:12:33.001Z","description":"A timestamp that represents the server time when the resource was last modified.\n\nResources that have never been updated do not have an `update_time` stamp.\n\nThe default value for resources that have never been updated is the local \nlanguage-specific equivalent of \"null\".\n\nIn JSON format, `update_time` type is encoded as a string as described in \n[RFC 3339](https://www.ietf.org/rfc/rfc3339.txt).\n"}}},"ConfigStateTally":{"type":"object","properties":{"isConfigured":{"type":"boolean","description":"The configuration operation is complete."},"isConfiguring":{"type":"boolean","description":"The configuration of the resource, or of its child(ren), is in process."},"isError":{"type":"boolean","description":"An error occurred while configuring the resource or its child(ren)."},"isDeleting":{"type":"boolean","description":"A delete operation is in progress for the resource or its child(ren)."},"total":{"type":"integer","description":"The total number of resources to which the configuration operation applies."},"configured":{"type":"integer","description":"The number of resources that have a complete and valid configuration."},"configuring":{"type":"integer","description":"The number of resources that are in the process of being configured."},"error":{"type":"integer","description":"The number of resources that have encountered an error during the configuration process."},"deleting":{"type":"integer","description":"The number of resources that are in the process of being deleted."}}},"ConfigCondition":{"type":"object","properties":{"type":{"type":"string","description":"The condition type."},"message":{"type":"string","description":"A human-readable message that provides additional information about the configuration operation."}}},"ConfigState":{"type":"object","description":"A representation of the resource's current configuration state \nthat comprises the status of the resource itself (`selfConfigState`) and any child \nresources (`childrenConfigState`).\n\nThe conditions array provides additional information during configuration changes.\n","properties":{"selfConfigState":{"$ref":"#/components/schemas/ConfigStateTally"},"childrenConfigState":{"$ref":"#/components/schemas/ConfigStateTally"},"conditions":{"type":"array","items":{"$ref":"#/components/schemas/ConfigCondition"}}}},"NamedLinks":{"allOf":[{"$ref":"#/components/schemas/SelfLinks"},{"type":"object","description":"Contains information about the object being referred to.\n\nThese are generally details -- like the object name and display name --\nthat are useful to a consumer of the API that performs further\nprocessing. \n\nThis object is only present in responses.\n \n","properties":{"name":{"type":"string","example":"production","description":"The name of the linked resource.\n"},"displayName":{"type":"string","example":"Production Environment","description":"A user friendly resource name."}}}]},"ResourceRef":{"type":"object","required":["ref"],"properties":{"ref":{"type":"string","example":"/services/environments/prod","description":"A reference to another NGINX Controller resource.\n"},"links":{"$ref":"#/components/schemas/NamedLinks"}}},"ErrorDetail":{"type":"object","required":["description"],"properties":{"description":{"type":"string","example":"Error doing <action>: <reason for error>. This can lead to <potential consequences>. Try <action> to resolve the issue.","description":"A detailed error message returned by the server. \n\nThese messages contain the following information, where applicable:\n\n- What happened.\n- Why it happened.\n- What the consequences are (if any).\n- Recommended action to take to resolve the issue.\n"}}},"ErrorModel":{"type":"object","required":["message","code"],"properties":{"message":{"type":"string","example":"Error doing <action>.","description":"A human-readable message, in English, that describes the error.\n"},"code":{"type":"integer","example":1234567,"description":"A numeric error code that can be used to identify errors for support purposes.\n"},"details":{"type":"array","items":{"$ref":"#/components/schemas/ErrorDetail"}}}},"EnvironmentName":{"type":"string"}}}}
/ services / environments
/ services / environments / {environmentName}
Locations API OpenAPI	{"openapi":"3.0.0","servers":[{"description":"NGINX Controller API","url":"https://{{CONTROLLER_FQDN}}/api/v1"}],"info":{"title":"Locations API","description":"Use the Locations API to manage the deployment locations for NGINX Controller.","version":"v1"},"paths":{"/infrastructure/locations":{"get":{"tags":["Locations"],"summary":"List all Locations","description":"Returns a list of all Locations.","operationId":"listLocations","responses":{"200":{"description":"Successfully retrieved a list of all of the configured Locations.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListLocationResponse"},"example":{"value":{"items":[{"currentStatus":{"type":"OTHER_LOCATION"},"desiredState":{"type":"OTHER_LOCATION"},"metadata":{"createTime":"2020-05-13T09:29:49.464273Z","description":"Location for instances where location has not been specified","displayName":"Unspecified (default)","kind":"location","links":{"rel":"/api/v1/infrastructure/locations/unspecified"},"name":"unspecified","tags":["default"],"uid":"802ef1f8-9105-474a-b9a7-599837efd6b4","updateTime":"2020-05-13T09:29:49.464273Z"}},{"currentStatus":{"type":"OTHER_LOCATION"},"desiredState":{"type":"OTHER_LOCATION"},"metadata":{"createTime":"2020-05-13T16:58:17.058124Z","description":"Other Location for managing instances","displayName":"OtherLocation-1","kind":"location","links":{"rel":"/api/v1/infrastructure/locations/my-other-location"},"name":"my-other-location","tags":["dev","prod"],"uid":"97d06b70-0d00-4863-b86d-40ab29efefdc","updateTime":"2020-05-13T16:58:17.058124Z"}}]}}}}},"401":{"$ref":"#/components/responses/Unauthorized"}}},"post":{"tags":["Locations"],"summary":"Create a Location","description":"Creates a new Location resource.","operationId":"addLocation","requestBody":{"description":"Defines the Location resource to be added.","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Location"},"examples":{"OTHER_LOCATION":{"$ref":"#/components/examples/OtherLocationRequest"},"AWS_LOCATION":{"$ref":"#/components/examples/AWSLocationRequest"},"AZURE_LOCATION":{"$ref":"#/components/examples/AzureLocationRequest"}}}}},"responses":{"201":{"description":"Successfully created the requested Location.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetLocationResponse"},"examples":{"OTHER_LOCATION":{"$ref":"#/components/examples/OtherLocationResponse"},"AWS_LOCATION":{"$ref":"#/components/examples/AWSLocationResponse"},"AZURE_LOCATION":{"$ref":"#/components/examples/AzureLocationResponse"}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"405":{"$ref":"#/components/responses/NotAllowed"},"409":{"$ref":"#/components/responses/Conflict"}}}},"/infrastructure/locations/{locationName}":{"get":{"tags":["Locations"],"summary":"Get a Location","description":"Returns information about a specified Location resource.","operationId":"getLocation","parameters":[{"$ref":"#/components/parameters/LocationName"}],"responses":{"200":{"description":"Successfully retrieved the requested Location resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetLocationResponse"},"examples":{"OTHER_LOCATION":{"$ref":"#/components/examples/OtherLocationResponse"},"AWS_LOCATION":{"$ref":"#/components/examples/AWSLocationResponse"},"AZURE_LOCATION":{"$ref":"#/components/examples/AzureLocationResponse"}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"}}},"put":{"tags":["Locations"],"summary":"Upsert a Location","description":"Creates a new Location resource or updates an existing Location resource.","operationId":"upsertLocation","parameters":[{"$ref":"#/components/parameters/LocationName"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Location"},"examples":{"OTHER_LOCATION":{"$ref":"#/components/examples/OtherLocationRequest"},"AWS_LOCATION":{"$ref":"#/components/examples/AWSLocationRequest"},"AZURE_LOCATION":{"$ref":"#/components/examples/AzureLocationRequest"}}}},"required":true},"responses":{"200":{"description":"Successfully received the request to update the specified Location resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetLocationResponse"},"examples":{"OTHER_LOCATION":{"$ref":"#/components/examples/OtherLocationResponse"},"AWS_LOCATION":{"$ref":"#/components/examples/AWSLocationResponse"},"AZURE_LOCATION":{"$ref":"#/components/examples/AzureLocationResponse"}}}}},"201":{"description":"Successfully updated the specified Location resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetLocationResponse"},"examples":{"OTHER_LOCATION":{"$ref":"#/components/examples/OtherLocationResponse"},"AWS_LOCATION":{"$ref":"#/components/examples/AWSLocationResponse"},"AZURE_LOCATION":{"$ref":"#/components/examples/AzureLocationResponse"}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"405":{"$ref":"#/components/responses/NotAllowed"}}},"delete":{"tags":["Locations"],"summary":"Delete a Location","description":"Deletes the specified Location resource.","operationId":"deleteLocation","parameters":[{"$ref":"#/components/parameters/LocationName"}],"responses":{"204":{"description":"Successfully deleted the specified Location resource."},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"405":{"$ref":"#/components/responses/NotAllowed"},"409":{"$ref":"#/components/responses/Conflict"}}}}},"components":{"parameters":{"LocationName":{"name":"locationName","in":"path","description":"The name of the Location.","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}},"schemas":{"Location":{"required":["metadata","desiredState"],"type":"object","properties":{"metadata":{"$ref":"#/components/schemas/ResourceMeta"},"desiredState":{"$ref":"#/components/schemas/LocationState"},"currentStatus":{"$ref":"#/components/schemas/LocationState"}}},"GetLocationResponse":{"allOf":[{"$ref":"#/components/schemas/Location"}]},"ListLocationResponse":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/Location"}}}},"LocationState":{"oneOf":[{"$ref":"#/components/schemas/OtherLocation"},{"$ref":"#/components/schemas/AWSLocation"},{"$ref":"#/components/schemas/AzureLocation"}],"discriminator":{"propertyName":"type","mapping":{"OTHER_LOCATION":"#/components/schemas/OtherLocation","AWS_LOCATION":"#/components/schemas/AWSLocation","AZURE_LOCATION":"#/components/schemas/AzureLocation"}}},"AWSLocation":{"type":"object","required":["vpcID","region","integrationRef","type"],"properties":{"type":{"type":"string","description":"The location type. Select the environment where you want to create the location. \nTo create a location that’s specific to the AWS cloud environment, select AWS_LOCATION.\n","enum":["AWS_LOCATION"]},"region":{"description":"The AWS region.\n","type":"string"},"vpcID":{"type":"string","description":"The vpcID of the AWS Virtual Private Cloud (VPC) where new Instances created under this location should reside.\nThe VPC must be in the specified AWS region.\n"},"integrationRef":{"$ref":"#/components/schemas/ResourceRef"}}},"AzureLocation":{"x-f5-experimental":true,"type":"object","required":["type","region","resourceGroup","subscriptionID","integrationRef"],"properties":{"type":{"type":"string","description":"The location type.","enum":["AZURE_LOCATION"]},"region":{"description":"The Azure region.","type":"string"},"resourceGroup":{"type":"string","description":"The name of the resourceGroup."},"subscriptionID":{"type":"string","description":"The unique alphanumeric string that identifies the Azure subscription."},"integrationRef":{"description":"Integration ref.","$ref":"#/components/schemas/ResourceRef"}}},"OtherLocation":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"The location type. Select the environment where you want to create the location. \nTo create a location that’s not specific to any cloud environment, select OTHER_LOCATION.\n","enum":["OTHER_LOCATION"]}}},"SelfLinks":{"type":"object","description":"The SelfLinks object contains a link from the resource to itself.\nThis object is used only in responses.\n","properties":{"rel":{"type":"string","example":"/api/v1/services/environments/prod","description":"`rel` contains the complete path fragment of a URI and can be used\nto construct a query to the object.\n"}}},"ResourceMeta":{"type":"object","required":["name"],"properties":{"name":{"type":"string","pattern":"^[^A-Z\\s\\x00-\\x1f\\x60\\x7f\\;\\*\\\"\\[\\]\\{\\}\\\\\\/%\\?:=&\\~\\^|#<>]+$","minLength":1,"maxLength":1024,"example":"resource-name","description":"Resource name is a unique identifier for a resource within the context of a namespace.\nResource names must conform to [RFC 1738 Section 2.2](https://www.ietf.org/rfc/rfc1738.txt) and have a valid syntax for email addresses. The following rules are enforced:\n\n- do not utilize URL encoding;\n- do not include spaces;\n- do not use uppercase characters, for example, 'A-Z'; extended character sets are supported;\n- do not use the following characters: `\"`, `*`, `:`, `;`, `/`, `\\`, `%`, `?`, `hash`, `=`, `&`, `|`, `~`, `^`, `{`, `}`, `[`, `]`, `<`, `>`;\n- cannot start or end with an `@` sign;\n\nFor example: For a collection resource located at\n\n`https://controller.example.com/api/v1/services/apps/shopping_@1`\n\nthe resource name is \"shopping_@1\".\n"},"displayName":{"type":"string","example":"My Display Name","description":"`displayName` is a user friendly resource name. It can be used to define \na longer, and less constrained, name for a resource.\n\nDisplay names:\n\n- are optional (defaults to an empty string if no value is provided),\n- do not have to be unique, \n- cannot be assigned by the server.\n"},"description":{"type":"string","example":"This is a sample description string. It provides information about the resource.","description":"`description` is a free-form text property. You can use it to provide information that helps \nto identify the resource.\n\nDescriptions:\n\n- are optional (defaults to an empty string if no value is provided),\n- do not have to be unique, \n- cannot be assigned by the server.\n"},"kind":{"type":"string","example":"<collection>-<object>","description":"Kind is a string representation of an API resource's data type.\nIt is assigned by the server and cannot be changed. \n\nWhen creating a `kind`, the server uses hyphens to connect word segments; \nsingleton and collection item resources are not pluralized.\n"},"uid":{"type":"string","format":"uuid","example":"d290f1ee-6c54-4b01-90e6-d701748f0851","description":"Unique Identifier (UID)\n\nUID is a unique identifier in time and space for a resource. \nWhen you create a resource, the server assigns a UID to the resource.\n\nRefer to [IETF RFC 4122](https://tools.ietf.org/html/rfc4122) for more information.\n"},"tags":{"type":"array","items":{"type":"string"},"example":["production_public","dev","new_app","us-west-1","emea"],"description":"You can assign `tags` to a resource as a way to help map, scope, \nand organize resources. \n\nThe system uses tag selectors to specify selection criteria that \nmatch resources that have particular tags.\n"},"ref":{"type":"string","example":"/services/environments/prod","description":"The `ref` field contains a reference to another NGINX Controller resource.\n"},"links":{"$ref":"#/components/schemas/SelfLinks"},"createTime":{"type":"string","format":"date-time","example":"2019-07-29T09:12:33.001Z","description":"A timestamp that represents the server time when the resource was created.\n\nCreate time is not guaranteed to be set in \"happens-before\" order\nacross separate operations.\n\nIn JSON format, `create_time` type is encoded as a string in the\n[RFC 3339](https://www.ietf.org/rfc/rfc3339.txt).\n\nFor example: 2018-04-01T01:30:15.01Z\n\nCreate Time is assigned by the server and cannot be changed.\n"},"updateTime":{"type":"string","format":"date-time","example":"2019-07-29T10:12:33.001Z","description":"A timestamp that represents the server time when the resource was last modified.\n\nResources that have never been updated do not have an `update_time` stamp.\n\nThe default value for resources that have never been updated is the local \nlanguage-specific equivalent of \"null\".\n\nIn JSON format, `update_time` type is encoded as a string as described in \n[RFC 3339](https://www.ietf.org/rfc/rfc3339.txt).\n"}}},"NamedLinks":{"allOf":[{"$ref":"#/components/schemas/SelfLinks"},{"type":"object","description":"Contains information about the object being referred to.\n\nThese are generally details -- like the object name and display name --\nthat are useful to a consumer of the API that performs further\nprocessing. \n\nThis object is only present in responses.\n \n","properties":{"name":{"type":"string","example":"production","description":"The name of the linked resource.\n"},"displayName":{"type":"string","example":"Production Environment","description":"A user friendly resource name."}}}]},"ResourceRef":{"type":"object","required":["ref"],"properties":{"ref":{"type":"string","example":"/services/environments/prod","description":"A reference to another NGINX Controller resource.\n"},"links":{"$ref":"#/components/schemas/NamedLinks"}}},"ErrorDetail":{"type":"object","required":["description"],"properties":{"description":{"type":"string","example":"Error doing <action>: <reason for error>. This can lead to <potential consequences>. Try <action> to resolve the issue.","description":"A detailed error message returned by the server. \n\nThese messages contain the following information, where applicable:\n\n- What happened.\n- Why it happened.\n- What the consequences are (if any).\n- Recommended action to take to resolve the issue.\n"}}},"ErrorModel":{"type":"object","required":["message","code"],"properties":{"message":{"type":"string","example":"Error doing <action>.","description":"A human-readable message, in English, that describes the error.\n"},"code":{"type":"integer","example":1234567,"description":"A numeric error code that can be used to identify errors for support purposes.\n"},"details":{"type":"array","items":{"$ref":"#/components/schemas/ErrorDetail"}}}}},"responses":{"BadRequest":{"description":"Bad input parameter, or possibly a bad URI. Check the input for typos and try again.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"},"example":{"code":120305,"message":"Error creating the location: could not parse the request payload. Check the format of the request, then try again."}}}},"Unauthorized":{"description":"User authentication is invalid or missing.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"},"example":{"code":401,"message":"authentication needed"}}}},"NotFound":{"description":"The specified location resource was not found.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"},"example":{"code":120303,"message":"Error getting the location: the specified location does not exist. Check the location name, then try again."}}}},"NotAllowed":{"description":"The request is not allowed on the specified resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"},"example":{"code":120322,"message":"Error deleting the location: the name 'unspecified' is reserved. Specify a different name for the location, then try again."}}}},"Conflict":{"description":"The request failed due to a conflict with an existing location resource.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"},"example":{"code":120308,"message":"Error adding the location: the location already exists. Use a unique name for the location, then try again."}}}}},"examples":{"OtherLocationRequest":{"value":{"metadata":{"name":"my-other-location","description":"Other Location for managing instances","displayName":"OtherLocation-1","tags":["dev","prod"]},"desiredState":{"type":"OTHER_LOCATION"}}},"AWSLocationRequest":{"value":{"metadata":{"name":"my-aws-location","description":"AWS Location for us-east-1","displayName":"us-east-1-location","tags":["dev","prod"]},"desiredState":{"type":"AWS_LOCATION","vpcID":"vpc-1234","region":"us-east-1","integrationRef":{"ref":"/api/v1/platform/integrations/my-aws-integration"}}}},"AzureLocationRequest":{"value":{"metadata":{"name":"my-azure-location","description":"Azure Location for West US 2","displayName":"westus2-location","tags":["dev","prod"]},"desiredState":{"type":"AZURE_LOCATION","resourceGroup":"myResourceGroup","subscriptionID":"mySubscriptionID","region":"westus2","integrationRef":{"ref":"/api/v1/platform/integrations/my-azure-integration"}}}},"OtherLocationResponse":{"value":{"currentStatus":{"type":"OTHER_LOCATION"},"desiredState":{"type":"OTHER_LOCATION"},"metadata":{"createTime":"2020-05-13T16:58:17.058124Z","description":"Other Location for managing instances","displayName":"OtherLocation-1","kind":"location","links":{"rel":"/api/v1/infrastructure/locations/my-other-location"},"name":"my-other-location","tags":["dev","prod"],"uid":"97d06b70-0d00-4863-b86d-40ab29efefdc","updateTime":"2020-05-13T16:58:17.058124Z"}}},"AWSLocationResponse":{"value":{"currentStatus":{"integrationRef":{"ref":"/api/v1/platform/integrations/my-aws-integration"},"region":"us-east-1","type":"AWS_LOCATION","vpcID":"vpc-1234"},"desiredState":{"integrationRef":{"ref":"/api/v1/platform/integrations/my-aws-integration"},"region":"us-east-1","type":"AWS_LOCATION","vpcID":"vpc-1234"},"metadata":{"createTime":"2020-05-13T16:57:02.931198Z","description":"AWS Location for us-east-1","displayName":"us-east-1-location","kind":"location","links":{"rel":"/api/v1/infrastructure/locations/my-aws-location"},"name":"my-aws-location","tags":["dev","prod"],"uid":"62f72025-59a1-4c11-8cca-798b5e12efb8","updateTime":"2020-05-13T16:57:02.931198Z"}}},"AzureLocationResponse":{"value":{"currentStatus":{"integrationRef":{"ref":"/api/v1/platform/integrations/my-azure-integration"},"type":"AZURE_LOCATION","subscriptionID":"mySubscriptionID","region":"westus2"},"desiredState":{"integrationRef":{"ref":"/api/v1/platform/integrations/my-azure-integration"},"type":"AZURE_LOCATION","subscriptionID":"mySubscriptionID","region":"westus2"},"metadata":{"createTime":"2020-05-13T16:57:02.931198Z","description":"Azure Location for West US 2","displayName":"westus2-location","kind":"location","links":{"rel":"/api/v1/infrastructure/locations/my-azure-location"},"name":"my-azure-location","tags":["dev","prod"],"uid":"62f72025-59a1-4c11-8cca-798b5e12efb8","updateTime":"2020-05-13T16:57:02.931198Z"}}},"ListLocationResponse":{"value":{"items":[{"currentStatus":{"type":"OTHER_LOCATION"},"desiredState":{"type":"OTHER_LOCATION"},"metadata":{"createTime":"2020-05-13T09:29:49.464273Z","description":"Location for instances where location has not been specified","displayName":"Unspecified (default)","kind":"location","links":{"rel":"/api/v1/infrastructure/locations/unspecified"},"name":"unspecified","tags":["default"],"uid":"802ef1f8-9105-474a-b9a7-599837efd6b4","updateTime":"2020-05-13T09:29:49.464273Z"}},{"currentStatus":{"type":"OTHER_LOCATION"},"desiredState":{"type":"OTHER_LOCATION"},"metadata":{"createTime":"2020-05-13T16:58:17.058124Z","description":"Other Location for managing instances","displayName":"OtherLocation-1","kind":"location","links":{"rel":"/api/v1/infrastructure/locations/my-other-location"},"name":"my-other-location","tags":["dev","prod"],"uid":"97d06b70-0d00-4863-b86d-40ab29efefdc","updateTime":"2020-05-13T16:58:17.058124Z"}}]}}}}}
/ infrastructure / locations
/ infrastructure / locations / {locationName}
Metrics API OpenAPI	{"openapi":"3.0.0","servers":[{"description":"NGINX Controller API","url":"https://{{CONTROLLER_FQDN}}/api/v1"}],"info":{"description":"Use the Metrics API to retrieve system Metrics.","version":"v1","title":"Metrics API"},"paths":{"/analytics/metrics":{"get":{"tags":["Metrics"],"summary":"Get Metrics","operationId":"queryMetrics","description":"Returns system Metrics data based on the query parameters provided.\n\nSupports filtering based on name and/or timestamp; aggregation over a configurable time span; and grouping by dimension.\n","parameters":[{"name":"names","in":"query","description":"Identifies the Metrics data that you want to receive.\n\n- Provide multiple names as a comma-separated list.\n- You can provide an aggregate function for each Metric (`AVG`, `SUM`, `COUNT`, `MAX`, `MIN`, or `RATE`).\n- Combining non-aggregated and aggregated Metrics in a single query would apply any `groupBy` clause to only the latter.\n- Metrics with aggregates require the `startTime` parameter.\n","required":true,"schema":{"type":"string","example":"AVG(controller.agent.cpu.system),SUM(plus.upstream.bytes_rcvd)"}},{"name":"startTime","in":"query","description":"Indicates the start of the time window to include Metrics from (inclusive).\n\n- If `startTime` is omitted, the last recorded value for the queried Metrics will be returned.\n- For aggregated Metrics, you must provide `startTime` in order to calculate the resolution.\n","schema":{"$ref":"#/components/schemas/Time"},"example":"now-5h"},{"name":"endTime","in":"query","description":"Indicates the end of the time window to include Metrics from (non-inclusive).\n\n- Must be greater than `startTime`.\n- If `endTime` is not specified when `startTime` is present, `endTime` defaults to the current time.\n","schema":{"$ref":"#/components/schemas/Time"}},{"name":"resolution","in":"query","description":"Changes the granularity of the returned data.\n\n- Must be a valid duration -- a string starting with a number followed by a unit of time (`y`, `M`, `w`, `d`, `h`, `m` or `s`).\n- When using a resolution, you must provide an aggregate function (or functions) in the `names` parameter and `startTime`.\n- If you do not provide a resolution, the maximum available resolution will be returned (`endTime` - `startTime`).\n","schema":{"type":"string","example":"30s"}},{"name":"filter","in":"query","description":"Filters results based on dimension values.\n\nConsists of one or more predicates in the form `<dimension><operator><dimension value>` where:\n- `<dimension>` is the name of the dimension.\n- `<operator>` is one of the supported operators (`=`, `!=`, `<`, `<=`, `>=` `>`, `in` or `not`).\n- `<dimension value>` is value of the dimension(s) that you want to filter on.\n- `<dimension> and <dimension value>` is case sensitive.\n\nFor example: 'count > 100'\n\nPredicates can be combined into logical expressions using `OR`, `AND`, and `(` `)`.\nFor matching values, wildcard (`*`) use is supported.\n\nWrapping predicates in single quotes is recommended to ensure that the full query string is processed correctly.\n\nSee the Dimensions [Catalog](#/tags/catalogs) to find out more about Dimensions.\n","schema":{"type":"string","example":"((app!='app1' OR app='app2') AND environment in ('aa', 'bb')) AND (tags!='*tag1*' AND interface='ens*')"}},{"name":"groupBy","in":"query","description":"Groups the results according to the specified dimension(s).\n\n- Provide multiple dimension names as a comma-separated list.\n- All Metric names that you pass into the `names` parameter must be aggregated for the `groupBy` to work.\n","schema":{"type":"string","example":"app,environment"}},{"name":"seriesLimit","in":"query","description":"Sets an upper limit on the number of series returned.\nAlways returns additional series with dimension value named `all` (aggregating the values of all the metrics included in the results).\nIf the result does not include `all` stored dimensions values, the Metrics query returns series with dimension value named `other` (aggregating the values of all the metrics not included in the results).\nHas to be used along with the `orderSeriesBy` parameter.\n\n- Exactly one groupBy parameter must be provided in the query\n- Cannot be used along with `dimensions` parameter.\n","schema":{"type":"integer","example":25}},{"name":"orderSeriesBy","in":"query","description":"Sorts the results according to the order specified. \n\nUsed along with the `seriesLimit` parameter.\n","schema":{"type":"string","example":"MAX DESC","default":"SUM DESC"}},{"name":"dimensions","in":"query","description":"List of dimensions that should be returned in the response for each metric series.\n\nDimensions not specified in this parameter will be hidden in the results.\nThis might result in series having exact same dimension set, but being visible as separate.\n\nIf the `aggregation` and `groupBy` parameters are provided for a metric, any dimension provided in\nthe `dimensions` query parameter also has to be provided in the `groupBy` parameter.\n\nDimensions provided in the `groupBy` query parameter do not have to be provided in the `dimensions` query parameter.\n\n- To get a single series, provide the metric name with aggregation and the dimensions parameter with an empty value.\n- Cannot be used along with `seriesLimit`.\n","schema":{"type":"string","example":"app,environment"}}],"responses":{"200":{"description":"Successfully returned the requested Metrics data.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MetricQueryResult"}}}},"400":{"description":"Bad input parameter, or possibly a bad URI. Check the input for typos and try again.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}}}}}},"components":{"schemas":{"Time":{"description":"Indicates a point in time.\n\nYou can provide time using ISO 8601 format or as an offset. An offset is a string that starts with `+` or `-`, followed by a number and a unit of time (`y`, `M`, `w`, `d`, `h`, `m` or `s`).\nExamples: \"2019-08-07T09:57:36.088757764Z\", \"now-3h\"\n","type":"string","example":"2019-08-07T09:57:36.088757764Z"},"MetricQueryResult":{"type":"object","properties":{"queryMetadata":{"$ref":"#/components/schemas/MetricQueryMetadata"},"metrics":{"type":"array","items":{"$ref":"#/components/schemas/Metric"}},"responseMetadata":{"$ref":"#/components/schemas/MetricResponseMetadata"}}},"MetricResponseMetadata":{"type":"object","properties":{"warning":{"type":"string"}}},"MetricQueryMetadata":{"type":"object","properties":{"startTime":{"type":"string","format":"date-time","example":"2019-08-07T09:57:36.088757764Z"},"endTime":{"type":"string","format":"date-time","example":"2019-08-07T09:57:36.088757764Z"},"resolution":{"type":"string","example":"30m"}}},"Metric":{"type":"object","description":"Metrics provide a means of measuring and analyzing the performance of your systems and of NGINX Controller.","properties":{"name":{"type":"string","example":"plus.upstream.response.count"},"aggr":{"type":"string","enum":["AVG","COUNT","SUM","MAX","MIN","RATE"],"example":"AVG"},"series":{"type":"array","items":{"$ref":"#/components/schemas/Series"}}}},"Series":{"type":"object","properties":{"dimensions":{"type":"object","additionalProperties":{"type":"string"},"example":{"app":"app1","env":"prod"}},"timestamps":{"type":"array","items":{"type":"string","format":"date-time"},"example":["2019-08-07T09:57:30","2019-08-07T09:57:35"]},"values":{"type":"array","items":{"type":"number"},"example":[4.2,4.4]}}},"ErrorModel":{"type":"object","required":["message","code"],"properties":{"message":{"type":"string","example":" 'url' is not a valid dimension of 'http.request.bytes_rcvd'.","description":"Support oriented and human readable error message in English.\nThe message explains the error condition and may offer a solution.\n"},"code":{"type":"integer","example":0,"description":"Support oriented numerical error code in English.\nNote that this is not the HTTP code representing the error.\nThe message should explain the error.\n"},"details":{"type":"array","items":{"$ref":"#/components/schemas/ErrorDetail"}}}},"ErrorDetail":{"type":"object","required":["description"],"properties":{"description":{"type":"string","description":"An internal error detail returned from the server."}}}}}}
/ analytics / metrics
Instance API OpenAPI	{"openapi":"3.0.0","servers":[{"description":"NGINX Controller API","url":"https://{{CONTROLLER_FQDN}}/api/v1"}],"info":{"title":"Instance API","description":"Use the Instance API to manage NGINX Controller Instance resources.","version":"v1"},"paths":{"/infrastructure/locations/{locationName}/instances":{"get":{"tags":["Instances"],"summary":"List all Instances in a Location","description":"Returns the status and metadata for all of the Instances in the specified Location.","operationId":"listInstances","parameters":[{"$ref":"#/components/parameters/LocationName"}],"responses":{"200":{"description":"Successfully returned the status and metadata for all of the Instances in the specified Location.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListInstanceResponse"},"examples":{"INSTANCES":{"$ref":"#/components/examples/ListInstanceResponse"}}}}}}},"post":{"tags":["Instances"],"summary":"Create an Instance","description":"Creates a new Instance resource.","operationId":"createInstance","parameters":[{"$ref":"#/components/parameters/LocationName"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InstanceRequest"},"examples":{"AWS_INSTANCE":{"$ref":"#/components/examples/AWSInstanceRequest"},"AZURE_INSTANCE":{"$ref":"#/components/examples/AzureInstanceRequest"}}}}},"responses":{"202":{"description":"The Instance resource has been accepted for creation. The Instance will be created after it is done configuring.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetInstanceResponse"},"examples":{"AWS_INSTANCE":{"$ref":"#/components/examples/AWSInstance"}}}}},"400":{"description":"Bad input parameter or URI. Check the input for typos and try again.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"},"example":{"message":"Error creating the instance: could not parse the request payload. Check the format of the request, then try again.","code":120647}}}},"409":{"description":"The request failed due to a conflict with an existing Instance resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"},"example":{"message":"Error creating the instance: the instance already exists. Use a unique name for the instance, then try again.","code":120652}}}}}}},"/infrastructure/locations/{locationName}/instances/{instanceName}":{"get":{"tags":["Instances"],"summary":"Get an Instance","description":"Returns the status and metadata for a single Instance.","operationId":"getInstance","parameters":[{"$ref":"#/components/parameters/LocationName"},{"$ref":"#/components/parameters/InstanceName"}],"responses":{"200":{"description":"Successfully returned the details for an Instance.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetInstanceResponse"},"examples":{"OTHER_INSTANCE":{"$ref":"#/components/examples/OtherInstance"},"AWS_INSTANCE":{"$ref":"#/components/examples/AWSInstance"},"AZURE_INSTANCE":{"$ref":"#/components/examples/AzureInstance"}}}}},"404":{"description":"Instance not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"},"example":{"message":"Error getting the instance: the specified instance does not exist. Check the instance name, then try again.","code":120603}}}}}},"put":{"tags":["Instances"],"summary":"Update an Instance","description":"Updates the description or display name of an existing Instance.","operationId":"updateInstance","parameters":[{"$ref":"#/components/parameters/LocationName"},{"$ref":"#/components/parameters/InstanceName"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InstanceRequest"},"examples":{"OTHER_INSTANCE":{"$ref":"#/components/examples/InstanceUpdateRequest"},"AWS_INSTANCE":{"$ref":"#/components/examples/InstanceUpdateRequest"},"AZURE_INSTANCE":{"$ref":"#/components/examples/InstanceUpdateRequest"}}}}},"responses":{"200":{"description":"Successfully updated the existing Instance.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetInstanceResponse"},"examples":{"OTHER_INSTANCE":{"$ref":"#/components/examples/OtherInstance"},"AWS_INSTANCE":{"$ref":"#/components/examples/AWSInstance"},"AZURE_INSTANCE":{"$ref":"#/components/examples/AzureInstance"}}}}},"400":{"description":"Bad input parameter or URI. Check the input for typos and try again.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"},"example":{"message":"Error updating the instance: could not parse the request payload. Check the format of the request, then try again.","code":120612}}}},"404":{"description":"Instance not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"},"example":{"message":"Error updating the instance: the specified instance does not exist. Check the instance name, then try again.","code":120614}}}}}},"delete":{"tags":["Instances"],"summary":"Delete an Instance","operationId":"deleteInstance","description":"Deletes the specified Instance.","parameters":[{"$ref":"#/components/parameters/LocationName"},{"$ref":"#/components/parameters/InstanceName"}],"responses":{"202":{"description":"Request for delete accepted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetInstanceResponse"}}}},"204":{"description":"Successfully deleted the Instance. No content is returned."},"404":{"description":"Instance not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"},"example":{"message":"Error deleting the instance: the specified instance does not exist. Check the instance name, then try again.","code":120609}}}},"409":{"description":"Failed to delete the requested Instance resource.\n\nThe Instance is referenced by another resource. Remove the references to the Instance, then try again.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"},"example":{"message":"Error deleting the instance: the NGINX instance is being configured. Try again later. If the problem persists, contact the system administrator.","code":120640}}}}}}}},"components":{"parameters":{"LocationName":{"name":"locationName","in":"path","description":"The name of the Location that contains the Instance.","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},"InstanceName":{"name":"instanceName","in":"path","description":"The name of the Instance.","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}},"schemas":{"Instance":{"type":"object","description":"An NGINX Instance.","required":["metadata"],"properties":{"metadata":{"$ref":"#/components/schemas/ResourceMeta"},"currentStatus":{"$ref":"#/components/schemas/InstanceCurrentStatus"},"desiredState":{"$ref":"#/components/schemas/InstanceDesiredState"}}},"GetInstanceResponse":{"allOf":[{"$ref":"#/components/schemas/Instance"}]},"ListInstanceResponse":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/Instance"}}}},"InstanceRequest":{"allOf":[{"$ref":"#/components/schemas/Instance"}],"description":"Describes the Instance to update."},"InstanceDesiredState":{"oneOf":[{"$ref":"#/components/schemas/OtherInstanceDesiredState"},{"$ref":"#/components/schemas/AWSInstanceDesiredState"},{"$ref":"#/components/schemas/AzureInstanceDesiredState"}],"discriminator":{"propertyName":"type","mapping":{"OTHER_INSTANCE":"#/components/schemas/OtherInstanceDesiredState","AWS_INSTANCE":"#/components/schemas/AWSInstanceDesiredState","AZURE_INSTANCE":"#/components/schemas/AzureInstanceDesiredState"}}},"InstanceCurrentStatus":{"oneOf":[{"$ref":"#/components/schemas/OtherInstanceCurrentStatus"},{"$ref":"#/components/schemas/AWSInstanceCurrentStatus"},{"$ref":"#/components/schemas/AzureInstanceCurrentStatus"}],"discriminator":{"propertyName":"type","mapping":{"OTHER_INSTANCE":"#/components/schemas/OtherInstanceCurrentStatus","AWS_INSTANCE":"#/components/schemas/AWSInstanceCurrentStatus","AZURE_INSTANCE":"#/components/schemas/AzureInstanceCurrentStatus"}}},"OtherInstanceDesiredState":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"OTHER_INSTANCE is an Instance pre-installed and self-registered during NGINX installation.\n","enum":["OTHER_INSTANCE"]},"nginx":{"$ref":"#/components/schemas/Nginx"}}},"AWSInstanceDesiredState":{"type":"object","required":["type","templateRef"],"properties":{"type":{"type":"string","description":"AWS_INSTANCE is an Instance hosted in Amazon Web Services (AWS).\n","enum":["AWS_INSTANCE"]},"templateRef":{"$ref":"#/components/schemas/TemplateRef"},"nginx":{"$ref":"#/components/schemas/Nginx"}}},"AzureInstanceDesiredState":{"x-f5-experimental":true,"type":"object","required":["type","templateRef"],"properties":{"type":{"type":"string","description":"AZURE_INSTANCE is an Instance hosted in Microsoft Azure.","enum":["AZURE_INSTANCE"]},"templateRef":{"$ref":"#/components/schemas/TemplateRef"},"nginx":{"$ref":"#/components/schemas/Nginx"}}},"OtherInstanceCurrentStatus":{"type":"object","description":"Contains the current status of the Other Instance.","required":["type","hostname","version","agent","status","muted"],"properties":{"hostname":{"type":"string","description":"The hostname of the Instance."},"version":{"type":"string","description":"The version of NGINX running on the Instance."},"muted":{"type":"boolean","description":"Indicates the status of notifications and alerts.\n- 'True' means that notifications and alerts are muted.\n- 'False' means that notifications and alerts are active.\n","deprecated":true},"type":{"type":"string","description":"OTHER_INSTANCE is an Instance pre-installed and self-registered during NGINX installation.\n","enum":["OTHER_INSTANCE"]},"networkConfig":{"$ref":"#/components/schemas/OtherNetworkConfig"},"agent":{"$ref":"#/components/schemas/Agent"},"nginx":{"$ref":"#/components/schemas/Nginx"},"status":{"deprecated":true,"allOf":[{"$ref":"#/components/schemas/ConfigState"}]},"state":{"$ref":"#/components/schemas/ConfigState"},"legacyNginxMetadata":{"deprecated":true,"$ref":"#/components/schemas/LegacyNginxMetadata"},"legacySystemMetadata":{"deprecated":true,"$ref":"#/components/schemas/LegacySystemMetadata"}}},"AWSInstanceCurrentStatus":{"type":"object","description":"Contains the current status of the AWS Instance.","required":["type","hostname","version","agent","muted"],"properties":{"hostname":{"type":"string","description":"The hostname of the Instance."},"instanceID":{"type":"string","description":"The ID of the Instance."},"version":{"type":"string","description":"The version of NGINX running on the Instance."},"muted":{"type":"boolean","description":"Indicates the status of notifications and alerts.\n- 'True' means that notifications and alerts are muted.\n- 'False' means that notifications and alerts are active.\n","deprecated":true},"type":{"type":"string","description":"AWS_INSTANCE is an Instance hosted in Amazon Web Services (AWS).\n","enum":["AWS_INSTANCE"]},"networkConfig":{"$ref":"#/components/schemas/AWSNetworkConfig"},"agent":{"$ref":"#/components/schemas/Agent"},"templateRef":{"$ref":"#/components/schemas/TemplateRef"},"nginx":{"$ref":"#/components/schemas/Nginx"},"state":{"$ref":"#/components/schemas/ConfigState"},"legacyNginxMetadata":{"deprecated":true,"$ref":"#/components/schemas/LegacyNginxMetadata"},"legacySystemMetadata":{"deprecated":true,"$ref":"#/components/schemas/LegacySystemMetadata"}}},"AzureInstanceCurrentStatus":{"x-f5-experimental":true,"type":"object","description":"Contains the current status of the Azure Instance.","required":["type","hostname","version","agent"],"properties":{"hostname":{"type":"string","description":"The hostname of the Instance."},"instanceID":{"type":"string","description":"The ID of the Instance."},"version":{"type":"string","description":"The version of NGINX running on the Instance."},"muted":{"type":"boolean","description":"Indicates the mute status of notifications and alerts.\n- 'True' means that notifications and alerts are muted.\n- 'False' means that notifications and alerts are active.\n","deprecated":true},"type":{"type":"string","description":"AZURE_INSTANCE is an Instance hosted in Microsoft Azure.","enum":["AZURE_INSTANCE"]},"networkConfig":{"$ref":"#/components/schemas/AzureNetworkConfig"},"agent":{"$ref":"#/components/schemas/Agent"},"templateRef":{"$ref":"#/components/schemas/TemplateRef"},"nginx":{"$ref":"#/components/schemas/Nginx"},"state":{"$ref":"#/components/schemas/ConfigState"},"legacyNginxMetadata":{"deprecated":true,"$ref":"#/components/schemas/LegacyNginxMetadata"},"legacySystemMetadata":{"deprecated":true,"$ref":"#/components/schemas/LegacySystemMetadata"}}},"TemplateRef":{"type":"object","allOf":[{"$ref":"#/components/schemas/ResourceRef"}],"description":"Reference to an existing Instance Template resource. This field cannot be updated."},"LegacySystemMetadata":{"type":"object","deprecated":true,"description":"Metadata that describe the operating system attributes and properties of an Instance host system. It is\nintended for internal use only and is subject to change.\n","additionalProperties":true},"LegacyNginxMetadata":{"type":"object","deprecated":true,"description":"Metadata that describe an Instance's NGINX process configuration and properties. It is intended\nfor internal use only and is subject to change.\n","additionalProperties":true},"Agent":{"type":"object","description":"The properties of the Controller Agent running on the Instance","required":["version"],"properties":{"version":{"type":"string","description":"The version of Controller Agent that is currently running on the Instance."},"online":{"type":"boolean","description":"The status of Controller Agent that is currently running on the Instance."},"credentials":{"$ref":"#/components/schemas/AgentCredentials"}}},"AgentCredentials":{"type":"object","description":"The credentials of the Controller Agent running on the Instance.","properties":{"hostname":{"type":"string","description":"The hostname of the Agent."},"uuid":{"type":"string","description":"The uuid of the Agent."}}},"OtherNetworkConfig":{"type":"object","description":"The network config of a customer deployed Instance.","properties":{"networkInterfaces":{"type":"array","items":{"$ref":"#/components/schemas/OtherNetworkInterface"}}}},"OtherNetworkInterface":{"type":"object","description":"A network interface for a customer deployed Instance.","properties":{"name":{"type":"string","description":"The name of the network interface attached to the Instance."},"privateDnsName":{"type":"string","description":"The private, internal hostname of the instance, which resolves to the Instance's private IP address.\n"},"privateIP":{"type":"string","description":"The private IP address of the network interface."},"privateIPv6":{"type":"string","description":"The private IPv6 address of the network interface."},"alternateIPList":{"type":"array","items":{"type":"string"}},"alternateIPv6List":{"type":"array","items":{"type":"string"}},"subnet":{"type":"object","description":"The subnet that contains the interface.","properties":{"cidrIPv4":{"type":"string","description":"The IPv4 CIDR for the subnet."},"cidrIPv6":{"type":"string","description":"The IPv6 CIDR for the subnet."}}}}},"AWSNetworkConfig":{"type":"object","description":"The network config of an AWS Instance.","properties":{"networkInterfaces":{"type":"array","items":{"$ref":"#/components/schemas/AWSNetworkInterface"}}}},"AWSNetworkInterface":{"type":"object","description":"A network interface for an AWS Instance.","properties":{"name":{"type":"string","description":"The name of the network interface attached to the Instance."},"privateDnsName":{"type":"string","description":"The private, internal hostname of the instance, which resolves to the Instance's private IP address. \n"},"publicDnsName":{"type":"string","description":"The public hostname of the instance, which resolves to the public IP address of the Instance. \n"},"privateIP":{"type":"string","description":"The private IP address of the network interface."},"publicIP":{"type":"string","description":"The public IP address of the network interface."},"subnet":{"type":"object","description":"The subnet that contains the interface.","properties":{"subnetID":{"type":"string","description":"The ID of the subnet into which the instance was launched."},"cidrIPv4":{"type":"string","description":"The IPv4 CIDR for the subnet."},"cidrIPv6":{"type":"string","description":"The IPv6 CIDR for the subnet."}}}}},"AzureNetworkConfig":{"type":"object","description":"The network config of an Azure Instance.","properties":{"networkInterfaces":{"type":"array","items":{"$ref":"#/components/schemas/AzureNetworkInterface"}}}},"AzureNetworkInterface":{"type":"object","description":"A network interface associated with an Azure Instance.","properties":{"name":{"type":"string","description":"The name of the network interface attached to the Instance."},"publicDnsName":{"type":"string","description":"The public hostname of the instance, which resolves to the public IP address of the Instance. \n"},"privateIP":{"type":"string","description":"The private IP address of the network interface."},"publicIP":{"type":"string","description":"The public IP address of the network interface."},"privateIPv6":{"type":"string","description":"The private IPv6 address of the network interface."},"publicIPv6":{"type":"string","description":"The public IPv6 address of the network interface."},"subnet":{"type":"object","description":"The subnet that contains the interface.","properties":{"subnetID":{"type":"string","description":"The ID of the subnet that contains the Instance."},"cidrIPv4":{"type":"string","description":"The IPv4 CIDR for the subnet."},"cidrIPv6":{"type":"string","description":"The IPv6 CIDR for the subnet."}}}}},"Nginx":{"type":"object","description":"Defines properties and configuration values for Nginx.\n","properties":{"process":{"$ref":"#/components/schemas/NginxProcess"}}},"NginxProcess":{"type":"object","description":"Defines configuration directives that are defined in the main configuration context.\n","properties":{"user":{"type":"string","description":"Defines user credentials used by worker processes.\n","default":"nginx"},"group":{"type":"string","description":"Defines group credentials used by worker processes. This will be ignored if the user\nproperty is not defined.\n","default":"nginx"}}},"SelfLinks":{"type":"object","description":"The SelfLinks object contains a link from the resource to itself.\nThis object is used only in responses.\n","properties":{"rel":{"type":"string","example":"/api/v1/services/environments/prod","description":"`rel` contains the complete path fragment of a URI and can be used\nto construct a query to the object.\n"}}},"ResourceMeta":{"type":"object","required":["name"],"properties":{"name":{"type":"string","pattern":"^[^A-Z\\s\\x00-\\x1f\\x60\\x7f\\;\\*\\\"\\[\\]\\{\\}\\\\\\/%\\?:=&\\~\\^|#<>]+$","minLength":1,"maxLength":1024,"example":"resource-name","description":"Resource name is a unique identifier for a resource within the context of a namespace.\nResource names must conform to [RFC 1738 Section 2.2](https://www.ietf.org/rfc/rfc1738.txt) and have a valid syntax for email addresses. The following rules are enforced:\n\n- do not utilize URL encoding;\n- do not include spaces;\n- do not use uppercase characters, for example, 'A-Z'; extended character sets are supported;\n- do not use the following characters: `\"`, `*`, `:`, `;`, `/`, `\\`, `%`, `?`, `hash`, `=`, `&`, `|`, `~`, `^`, `{`, `}`, `[`, `]`, `<`, `>`;\n- cannot start or end with an `@` sign;\n\nFor example: For a collection resource located at\n\n`https://controller.example.com/api/v1/services/apps/shopping_@1`\n\nthe resource name is \"shopping_@1\".\n"},"displayName":{"type":"string","example":"My Display Name","description":"`displayName` is a user friendly resource name. It can be used to define \na longer, and less constrained, name for a resource.\n\nDisplay names:\n\n- are optional (defaults to an empty string if no value is provided),\n- do not have to be unique, \n- cannot be assigned by the server.\n"},"description":{"type":"string","example":"This is a sample description string. It provides information about the resource.","description":"`description` is a free-form text property. You can use it to provide information that helps \nto identify the resource.\n\nDescriptions:\n\n- are optional (defaults to an empty string if no value is provided),\n- do not have to be unique, \n- cannot be assigned by the server.\n"},"kind":{"type":"string","example":"<collection>-<object>","description":"Kind is a string representation of an API resource's data type.\nIt is assigned by the server and cannot be changed. \n\nWhen creating a `kind`, the server uses hyphens to connect word segments; \nsingleton and collection item resources are not pluralized.\n"},"uid":{"type":"string","format":"uuid","example":"d290f1ee-6c54-4b01-90e6-d701748f0851","description":"Unique Identifier (UID)\n\nUID is a unique identifier in time and space for a resource. \nWhen you create a resource, the server assigns a UID to the resource.\n\nRefer to [IETF RFC 4122](https://tools.ietf.org/html/rfc4122) for more information.\n"},"tags":{"type":"array","items":{"type":"string"},"example":["production_public","dev","new_app","us-west-1","emea"],"description":"You can assign `tags` to a resource as a way to help map, scope, \nand organize resources. \n\nThe system uses tag selectors to specify selection criteria that \nmatch resources that have particular tags.\n"},"ref":{"type":"string","example":"/services/environments/prod","description":"The `ref` field contains a reference to another NGINX Controller resource.\n"},"links":{"$ref":"#/components/schemas/SelfLinks"},"createTime":{"type":"string","format":"date-time","example":"2019-07-29T09:12:33.001Z","description":"A timestamp that represents the server time when the resource was created.\n\nCreate time is not guaranteed to be set in \"happens-before\" order\nacross separate operations.\n\nIn JSON format, `create_time` type is encoded as a string in the\n[RFC 3339](https://www.ietf.org/rfc/rfc3339.txt).\n\nFor example: 2018-04-01T01:30:15.01Z\n\nCreate Time is assigned by the server and cannot be changed.\n"},"updateTime":{"type":"string","format":"date-time","example":"2019-07-29T10:12:33.001Z","description":"A timestamp that represents the server time when the resource was last modified.\n\nResources that have never been updated do not have an `update_time` stamp.\n\nThe default value for resources that have never been updated is the local \nlanguage-specific equivalent of \"null\".\n\nIn JSON format, `update_time` type is encoded as a string as described in \n[RFC 3339](https://www.ietf.org/rfc/rfc3339.txt).\n"}}},"ConfigStateTally":{"type":"object","properties":{"isConfigured":{"type":"boolean","description":"The configuration operation is complete."},"isConfiguring":{"type":"boolean","description":"The configuration of the resource, or of its child(ren), is in process."},"isError":{"type":"boolean","description":"An error occurred while configuring the resource or its child(ren)."},"isDeleting":{"type":"boolean","description":"A delete operation is in progress for the resource or its child(ren)."},"total":{"type":"integer","description":"The total number of resources to which the configuration operation applies."},"configured":{"type":"integer","description":"The number of resources that have a complete and valid configuration."},"configuring":{"type":"integer","description":"The number of resources that are in the process of being configured."},"error":{"type":"integer","description":"The number of resources that have encountered an error during the configuration process."},"deleting":{"type":"integer","description":"The number of resources that are in the process of being deleted."}}},"ConfigCondition":{"type":"object","properties":{"type":{"type":"string","description":"The condition type."},"message":{"type":"string","description":"A human-readable message that provides additional information about the configuration operation."}}},"ConfigState":{"type":"object","description":"A representation of the resource's current configuration state \nthat comprises the status of the resource itself (`selfConfigState`) and any child \nresources (`childrenConfigState`).\n\nThe conditions array provides additional information during configuration changes.\n","properties":{"selfConfigState":{"$ref":"#/components/schemas/ConfigStateTally"},"childrenConfigState":{"$ref":"#/components/schemas/ConfigStateTally"},"conditions":{"type":"array","items":{"$ref":"#/components/schemas/ConfigCondition"}}}},"NamedLinks":{"allOf":[{"$ref":"#/components/schemas/SelfLinks"},{"type":"object","description":"Contains information about the object being referred to.\n\nThese are generally details -- like the object name and display name --\nthat are useful to a consumer of the API that performs further\nprocessing. \n\nThis object is only present in responses.\n \n","properties":{"name":{"type":"string","example":"production","description":"The name of the linked resource.\n"},"displayName":{"type":"string","example":"Production Environment","description":"A user friendly resource name."}}}]},"ResourceRef":{"type":"object","required":["ref"],"properties":{"ref":{"type":"string","example":"/services/environments/prod","description":"A reference to another NGINX Controller resource.\n"},"links":{"$ref":"#/components/schemas/NamedLinks"}}},"ErrorDetail":{"type":"object","required":["description"],"properties":{"description":{"type":"string","example":"Error doing <action>: <reason for error>. This can lead to <potential consequences>. Try <action> to resolve the issue.","description":"A detailed error message returned by the server. \n\nThese messages contain the following information, where applicable:\n\n- What happened.\n- Why it happened.\n- What the consequences are (if any).\n- Recommended action to take to resolve the issue.\n"}}},"ErrorModel":{"type":"object","required":["message","code"],"properties":{"message":{"type":"string","example":"Error doing <action>.","description":"A human-readable message, in English, that describes the error.\n"},"code":{"type":"integer","example":1234567,"description":"A numeric error code that can be used to identify errors for support purposes.\n"},"details":{"type":"array","items":{"$ref":"#/components/schemas/ErrorDetail"}}}}},"examples":{"AWSInstanceRequest":{"value":{"metadata":{"name":"nginx-dp-1","displayName":"nginx-dp-1","tags":["prod-1","dev-1"]},"desiredState":{"type":"AWS_INSTANCE","templateRef":{"ref":"/infrastructure/locations/aws-east/instance-templates/small-dev-template"}}}},"AzureInstanceRequest":{"value":{"metadata":{"name":"nginx-dp-1","displayName":"nginx-dp-1","tags":["prod-1","dev-1"]},"desiredState":{"type":"AZURE_INSTANCE","templateRef":{"ref":"/infrastructure/locations/azure-westus2/instance-templates/small-dev-template"}}}},"InstanceUpdateRequest":{"value":{"metadata":{"name":"nginx-dp-1","displayName":"nginx-dp-1","description":"An example NGINX Instance.","tags":["prod-1","dev-1"]}}},"AWSInstance":{"value":{"metadata":{"name":"instance-1","displayName":"My Instance","tags":["prod-1","dev-1"],"links":{"rel":"/infrastructure/locations/unspecified/instances/instance-1"},"createTime":"2019-07-29T09:12:33.001Z","updateTime":"2019-07-29T09:12:33.001Z"},"desiredState":{"type":"AWS_INSTANCE","templateRef":{"ref":"/infrastructure/locations/aws-uswest-2/instance-templates/my-t2-medium"}},"currentStatus":{"type":"AWS_INSTANCE","state":{"selfConfigState":{"configured":1,"configuring":0,"deleting":0,"error":0,"isConfigured":true,"isConfiguring":false,"isDeleting":false,"isError":false,"total":1}},"hostname":"instance-1.mycloud.net","version":"1.17.3","muted":false,"networkConfig":{"networkInterfaces":[{"name":"eth0","privateDnsName":"ip-172-16-0-71.us-west-2.compute.internal","publicDnsName":"ec2-54-212-110-173.us-west-2.compute.amazonaws.com","privateIP":"172.16.0.71","publicIP":"54.212.110.173","subnet":{"subnetID":"subnet-055d28be58feb0a7d","cidrIPv4":"172.16.0.0/24"}}]},"agent":{"credentials":{"hostname":"instance-1.mycloud.net","uuid":"c1088edfd9f35cd38d5b4ce109508fe9"},"version":2.8},"legacyNginxMetadata":{"build":"nginx-plus-r19","built_from_source":false,"last_seen":"2019-11-12T23:47:52.966Z","pid":2749,"properties":{"conf-path":"/etc/nginx/nginx.conf","error-log-path":"/var/log/nginx/error.log","group":"nginx","http-client-body-temp-path":"/var/cache/nginx/client_temp","http-fastcgi-temp-path":"/var/cache/nginx/fastcgi_temp","http-log-path":"/var/log/nginx/access.log","http-proxy-temp-path":"/var/cache/nginx/proxy_temp","http-scgi-temp-path":"/var/cache/nginx/scgi_temp","http-uwsgi-temp-path":"/var/cache/nginx/uwsgi_temp","loadable_modules":[],"lock-path":"/var/run/nginx.lock","modules-path":"/usr/lib/nginx/modules","packages":{"nginx-plus":"19-1~bionic"},"path":{"bin":"/usr/sbin/nginx","conf":"/etc/nginx/nginx.conf"},"pid-path":"/var/run/nginx.pid","prefix":"/etc/nginx","sbin-path":"/usr/sbin/nginx","status_module_enabled":false,"stub_status_enabled":false,"stub_status_url":null,"user":"nginx","with-cc-opt":"-g -O2 -fdebug-prefix-map=/data/builder/debuild/nginx-plus-1.17.3/debian/debuild-base/nginx-plus-1.17.3=. -fstack-protector-strong -Wformat -Werror=format-security -Wp,-D_FORTIFY_SOURCE=2 -fPIC","with-compat":true,"with-file-aio":true,"with-http_addition_module":true,"with-http_auth_jwt_module":true,"with-http_auth_request_module":true,"with-http_dav_module":true,"with-http_f4f_module":true,"with-http_flv_module":true,"with-http_gunzip_module":true,"with-http_gzip_static_module":true,"with-http_hls_module":true,"with-http_mp4_module":true,"with-http_random_index_module":true,"with-http_realip_module":true,"with-http_secure_link_module":true,"with-http_session_log_module":true,"with-http_slice_module":true,"with-http_ssl_module":true,"with-http_stub_status_module":true,"with-http_sub_module":true,"with-http_v2_module":true,"with-ld-opt":"-Wl,-Bsymbolic-functions -Wl,-z,relro -Wl,-z,now -Wl,--as-needed -pie","with-mail":true,"with-mail_ssl_module":true,"with-stream":true,"with-stream_realip_module":true,"with-stream_ssl_module":true,"with-stream_ssl_preread_module":true,"with-threads":true},"running":true,"ssl":{"built":["OpenSSL","1.1.1","11 Sep 2018"],"run":["OpenSSL","1.1.1","11 Sep 2018"]},"start_time":1573580604000},"legacySystemMetadata":{"boot":1573580280000,"disk_partitions":[{"device":"/dev/sda2","fstype":"ext4","mountpoint":"/"},{"device":"/dev/sda1","fstype":"ext3","mountpoint":"/boot"}],"network":{"default":"lo","interfaces":{"ipv4":{"address":"127.0.0.1","netmask":"255.0.0.0","prefixlen":8},"ipv6":{"address":"::1","netmask":"ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff","prefixlen":128},"mac":"00:00:00:00:00:00","name":"lo"}},"os-type":"linux","processor":{"architecture":"x86_64","cache":{"L1d":"32K","L1i":"32K","L2":"1024K","L3":"25344K"},"cores":1,"cpus":4,"hypervisor":"VMware","mhz":2300,"model":"Intel(R) Xeon(R) Gold 6140 CPU @ 2.30GHz","virtualization":"full"},"release":{"codename":"bionic","id":"ubuntu","name":"Ubuntu","version":"18.04.2 LTS (Bionic Beaver)","version_id":18.04}}}}},"AzureInstance":{"value":{"metadata":{"name":"instance-1","createTime":"2020-10-27T22:14:36.994172Z","description":"My Azure Instance","displayName":"Instance-1","tags":["prod-1","dev-1"],"kind":"instance","links":{"rel":"/api/v1/infrastructure/locations/azure-westus2/instances/instance-1"},"ref":"/infrastructure/locations/azure-westus2/instances/instance-1","uid":"4ed722ec-1bc0-47a1-9772-87718fa9ddb8","updateTime":"2020-10-27T22:14:36.994172Z"},"desiredState":{"nginx":{"process":{"group":"test","user":"testuser"}},"templateRef":{"ref":"/infrastructure/locations/azure-westus2/instance-templates/azure-standard-ds1v2"},"type":"AZURE_INSTANCE"},"currentStatus":{"networkConfig":{"networkInterfaces":[{"name":"my-nic-1","publicDnsName":"myapp.westus2.cloudapp.azure.com","privateIP":"10.0.1.4","publicIP":"52.229.16.198","subnet":{"subnetID":"subnet-test","cidrIPv4":"10.0.1.0/24"}}]},"agent":{"credentials":{"hostname":"instance-1.mycloud.net","uuid":"c1088edfd9f35cd38d5b4ce109508fe9"},"version":"3.12.5"},"hostname":"instance-1","instanceID":"ce266e67-42ec-41a0-b8f4-f4cd0be01828","legacyNginxMetadata":{"build":"nginx-plus-r22","built_from_source":true,"id":6,"last_seen":"2020-10-27T22:30:34.376659Z","pid":1138,"properties":{"conf-path":"/etc/nginx/nginx.conf","error-log-path":"/var/log/nginx/error.log","group":"nginx","http-client-body-temp-path":"/var/cache/nginx/client_temp","http-fastcgi-temp-path":"/var/cache/nginx/fastcgi_temp","http-log-path":"/var/log/nginx/access.log","http-proxy-temp-path":"/var/cache/nginx/proxy_temp","http-scgi-temp-path":"/var/cache/nginx/scgi_temp","http-uwsgi-temp-path":"/var/cache/nginx/uwsgi_temp","loadable_modules":["ngx_http_f5_metrics_module-debug.so","ngx_http_f5_metrics_module.so"],"lock-path":"/var/run/nginx.lock","modules-path":"/usr/lib/nginx/modules","packages":{"nginx-plus":"nginx-plus-r22"},"path":{"bin":"/usr/sbin/nginx","conf":"/etc/nginx/nginx.conf"},"pid-path":"/var/run/nginx.pid","prefix":"/etc/nginx","sbin-path":"/usr/sbin/nginx","status_module_enabled":false,"stub_status_enabled":false,"stub_status_url":"","user":"nginx","with-compat":true,"with-file-aio":true,"with-http_addition_module":true,"with-http_auth_jwt_module":true,"with-http_auth_request_module":true,"with-http_dav_module":true,"with-http_f4f_module":true,"with-http_flv_module":true,"with-http_gunzip_module":true,"with-http_gzip_static_module":true,"with-http_hls_module":true,"with-http_mp4_module":true,"with-http_random_index_module":true,"with-http_realip_module":true,"with-http_secure_link_module":true,"with-http_session_log_module":true,"with-http_slice_module":true,"with-http_ssl_module":true,"with-http_stub_status_module":true,"with-http_sub_module":true,"with-http_v2_module":true,"with-ld-opt":"'-Wl,-Bsymbolic-functions -Wl,-z,relro -Wl,-z,now -Wl,--as-needed -pie'","with-mail":true,"with-mail_ssl_module":true,"with-stream":true,"with-stream_realip_module":true,"with-stream_ssl_module":true,"with-stream_ssl_preread_module":true,"with-threads":true},"running":true,"ssl":{"built":["OpenSSL","1.1.1"," 11 Sep 2018"],"run":["OpenSSL","1.1.1"," 11 Sep 2018"]},"start_time":1603836993,"version":"1.19.0"},"legacySystemMetadata":{"boot":1603836911000,"disk_partitions":[{"device":"/dev/sda1","fstype":"ext4","mountpoint":"/"},{"device":"/dev/sda15","fstype":"vfat","mountpoint":"/boot/efi"},{"device":"/dev/sdb1","fstype":"ext4","mountpoint":"/mnt"}],"id":5,"network":{"default":"eth0","interfaces":[{"ipv4":{"address":"127.0.0.1","netmask":"255.0.0.0","prefixlen":8},"ipv6":{"address":"::1","netmask":"ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff","prefixlen":128},"mac":"00:00:00:00:00:00","name":"lo"},{"ipv4":{"address":"10.0.1.4","netmask":"255.255.255.0","prefixlen":24},"ipv6":{"address":"fe80::20d:3aff:fec5:3f80","netmask":"ffff:ffff:ffff:ffff::","prefixlen":64},"mac":"00:0d:3a:c5:3f:80","name":"eth0"}]},"os-type":"linux","processor":{"architecture":"x86_64","cache":{"L1d":"32K","L1i":"32K","L2":"1024K","L3":"36608K"},"cores":"1","cpus":"1","hypervisor":"Microsoft","mhz":"2095.191","model":"Intel(R) Xeon(R) Platinum 8171M CPU @ 2.60GHz","virtualization":"full"},"release":{"codename":"bionic","id":"ubuntu","name":"Ubuntu","version":"18.04.5 LTS (Bionic Beaver)","version_id":"18.04"}},"muted":false,"nginx":{"process":{"group":"test","user":"testuser"}},"state":{"conditions":[],"selfConfigState":{"configured":1,"configuring":0,"deleting":0,"error":0,"isConfigured":true,"isConfiguring":false,"isDeleting":false,"isError":false,"total":1}},"templateRef":{"ref":"/infrastructure/locations/azure-westus2/instance-templates/azure-standard-ds1v2"},"type":"AZURE_INSTANCE","version":"1.19.0"}}},"OtherInstance":{"value":{"metadata":{"name":"test_instance_1","displayName":"Test Instance 1","links":{"rel":"/api/v1/infrastructure/locations/unspecified/instances/test_instance_1"},"createTime":"2020-05-20T20:02:18.107875Z","updateTime":"2020-05-20T20:02:18.107875Z"},"desiredState":{"type":"OTHER_INSTANCE"},"currentStatus":{"type":"OTHER_INSTANCE","state":{"selfConfigState":{"configured":1,"configuring":0,"deleting":0,"error":0,"isConfigured":true,"isConfiguring":false,"isDeleting":false,"isError":false,"total":1}},"status":{"selfConfigState":{"configured":1,"configuring":0,"deleting":0,"error":0,"isConfigured":true,"isConfiguring":false,"isDeleting":false,"isError":false,"total":1}},"agent":{"credentials":{"hostname":"instance-1.mycloud.net","uuid":"c1088edfd9f35cd38d5b4ce109508fe9"},"version":"999.0.0-1"},"hostname":"test-fab4edf8-data-1.test","legacyNginxMetadata":{"build":"nginx-plus-r21","built_from_source":false,"id":2,"last_seen":"2020-05-20T20:40:21.146894Z","pid":2995,"properties":{"conf-path":"/etc/nginx/nginx.conf","error-log-path":"/var/log/nginx/error.log","group":"nginx","http-client-body-temp-path":"/var/cache/nginx/client_temp","http-fastcgi-temp-path":"/var/cache/nginx/fastcgi_temp","http-log-path":"/var/log/nginx/access.log","http-proxy-temp-path":"/var/cache/nginx/proxy_temp","http-scgi-temp-path":"/var/cache/nginx/scgi_temp","http-uwsgi-temp-path":"/var/cache/nginx/uwsgi_temp","loadable_modules":["ngx_http_f5_metrics_module-debug.so","ngx_http_f5_metrics_module.so"],"lock-path":"/var/run/nginx.lock","modules-path":"/usr/lib/nginx/modules","packages":{"nginx-plus":"21-1~bionic"},"path":{"bin":"/usr/sbin/nginx","conf":"/etc/nginx/nginx.conf"},"pid-path":"/var/run/nginx.pid","prefix":"/etc/nginx","sbin-path":"/usr/sbin/nginx","status_module_enabled":false,"stub_status_enabled":false,"stub_status_url":null,"user":"nginx","with-cc-opt":"'-g -O2 -fdebug-prefix-map=/data/builder/debuild/nginx-plus-1.17.9/debian/debuild-base/nginx-plus-1.17.9=. -fstack-protector-strong -Wformat -Werror=format-security,-D_FORTIFY_SOURCE=2 -fPIC'","with-compat":true,"with-file-aio":true,"with-http_addition_module":true,"with-http_auth_jwt_module":true,"with-http_auth_request_module":true,"with-http_dav_module":true,"with-http_f4f_module":true,"with-http_flv_module":true,"with-http_gunzip_module":true,"with-http_gzip_static_module":true,"with-http_hls_module":true,"with-http_mp4_module":true,"with-http_random_index_module":true,"with-http_realip_module":true,"with-http_secure_link_module":true,"with-http_session_log_module":true,"with-http_slice_module":true,"with-http_ssl_module":true,"with-http_stub_status_module":true,"with-http_sub_module":true,"with-http_v2_module":true,"with-ld-opt":"'-Wl,-Bsymbolic-functions -Wl,-z,relro -Wl,-z,now -Wl,--as-needed -pie'","with-mail":true,"with-mail_ssl_module":true,"with-stream":true,"with-stream_realip_module":true,"with-stream_ssl_module":true,"with-stream_ssl_preread_module":true,"with-threads":true},"running":true,"ssl":{"built":["OpenSSL","1.1.1","11 Sep 2018"],"run":["OpenSSL","1.1.1","11 Sep 2018"]},"start_time":1590004864000},"legacySystemMetadata":{"boot":1590004492000,"disk_partitions":[{"device":"/dev/sda2","fstype":"ext4","mountpoint":"/"},{"device":"/dev/sda1","fstype":"ext3","mountpoint":"/boot"}],"id":1,"network":{"default":"lo","interfaces":[{"ipv4":{"address":"127.0.0.1","netmask":"255.0.0.0","prefixlen":8},"ipv6":{"address":"::1","netmask":"ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff","prefixlen":128},"mac":"00:00:00:00:00:00","name":"lo"},{"ipv4":{"address":"192.0.10.1","netmask":"255.255.255.0","prefixlen":24},"mac":"02:42:98:fb:40:48","name":"docker0"},{"ipv4":{"address":"10.149.41.181","netmask":"255.255.240.0","prefixlen":20},"ipv6":{"address":"fe80::250:56ff:fe98:e2f1","netmask":"ffff:ffff:ffff:ffff::","prefixlen":64},"mac":"00:50:56:98:e2:f1","name":"ens32"}]},"os-type":"linux","processor":{"architecture":"x86_64","cache":{"L1d":"32K","L1i":"32K","L2":"1024K","L3":"25344K"},"cores":"1","cpus":"4","hypervisor":"VMware","mhz":"2300.000","model":"Intel(R) Xeon(R) Gold 6140 CPU @ 2.30GHz","virtualization":"full"},"release":{"codename":"bionic","id":"ubuntu","name":"Ubuntu","version":"18.04.2 LTS (Bionic Beaver)","version_id":"18.04"}},"muted":false,"version":"1.17.9"}}},"ListInstanceResponse":{"value":{"items":[{"currentStatus":{"agent":{"version":"3.7.44"},"hostname":"i-563457274582","legacyNginxMetadata":{"build":"nginx-plus-r22","built_from_source":false,"id":2,"last_seen":"2020-07-08T17:24:07.869745Z","pid":3104,"properties":{"conf-path":"/etc/nginx/nginx.conf","error-log-path":"/var/log/nginx/error.log","group":"nginx","http-client-body-temp-path":"/var/cache/nginx/client_temp","http-fastcgi-temp-path":"/var/cache/nginx/fastcgi_temp","http-log-path":"/var/log/nginx/access.log","http-proxy-temp-path":"/var/cache/nginx/proxy_temp","http-scgi-temp-path":"/var/cache/nginx/scgi_temp","http-uwsgi-temp-path":"/var/cache/nginx/uwsgi_temp","loadable_modules":["ngx_http_f5_metrics_module-debug.so","ngx_http_f5_metrics_module.so"],"lock-path":"/var/run/nginx.lock","modules-path":"/usr/lib/nginx/modules","packages":{},"path":{"bin":"/usr/sbin/nginx","conf":"/etc/nginx/nginx.conf"},"pid-path":"/var/run/nginx.pid","prefix":"/etc/nginx","sbin-path":"/usr/sbin/nginx","status_module_enabled":false,"stub_status_enabled":false,"stub_status_url":"","user":"nginx","with-compat":true,"with-file-aio":true,"with-http_addition_module":true,"with-http_auth_jwt_module":true,"with-http_auth_request_module":true,"with-http_dav_module":true,"with-http_f4f_module":true,"with-http_flv_module":true,"with-http_gunzip_module":true,"with-http_gzip_static_module":true,"with-http_hls_module":true,"with-http_mp4_module":true,"with-http_random_index_module":true,"with-http_realip_module":true,"with-http_secure_link_module":true,"with-http_session_log_module":true,"with-http_slice_module":true,"with-http_ssl_module":true,"with-http_stub_status_module":true,"with-http_sub_module":true,"with-http_v2_module":true,"with-ld-opt":"'-Wl,-Bsymbolic-functions -Wl,-z,relro -Wl,-z,now -Wl,--as-needed -pie'","with-mail":true,"with-mail_ssl_module":true,"with-stream":true,"with-stream_realip_module":true,"with-stream_ssl_module":true,"with-stream_ssl_preread_module":true,"with-threads":true},"running":true,"ssl":{"built":["OpenSSL","1.1.1","","11","Sep","2018"],"run":["OpenSSL","1.1.1","","11","Sep","2018"]},"start_time":0},"legacySystemMetadata":{"boot":1594225800000,"disk_partitions":[{"device":"/dev/sda2","fstype":"ext4","mountpoint":"/"},{"device":"/dev/sda1","fstype":"ext3","mountpoint":"/boot"}],"id":1,"network":{"default":"","interfaces":[{"ipv4":{"address":"127.0.0.1","netmask":"255.0.0.0","prefixlen":8},"ipv6":{"address":"::1","netmask":"ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff","prefixlen":128},"mac":"00:00:00:00:00:00","name":"lo"},{"ipv4":{"address":"10.149.41.97","netmask":"255.255.240.0","prefixlen":20},"ipv6":{"address":"fe80::250:56ff:fe98:b512","netmask":"ffff:ffff:ffff:ffff::","prefixlen":64},"mac":"00:50:56:98:b5:12","name":"ens32"},{"ipv4":{"address":"192.0.10.1","netmask":"255.255.255.0","prefixlen":24},"mac":"02:42:24:f1:ae:8a","name":"docker0"}]},"os-type":"linux","processor":{"architecture":"x86_64","cache":{"L1d":"32K","L1i":"32K","L2":"1024K","L3":"25344K"},"cores":"1","cpus":"4","hypervisor":"VMware","mhz":"2300.000","model":"Intel(R) Xeon(R) Gold 6140 CPU @ 2.30GHz","virtualization":"full"},"release":{"codename":"bionic","id":"ubuntu","name":"Ubuntu","version":"18.04.2 LTS (Bionic Beaver)","version_id":"18.04"}},"muted":false,"state":{"selfConfigState":{"configured":1,"configuring":0,"deleting":0,"error":0,"isConfigured":true,"isConfiguring":false,"isDeleting":false,"isError":false,"total":1}},"status":{"selfConfigState":{"configured":1,"configuring":0,"deleting":0,"error":0,"isConfigured":true,"isConfiguring":false,"isDeleting":false,"isError":false,"total":1}},"type":"OTHER_INSTANCE","version":"1.19.0"},"desiredState":{"type":"OTHER_INSTANCE"},"metadata":{"createTime":"2020-07-08T16:42:07.97301Z","displayName":"Test Instance 1","kind":"instance","links":{"rel":"/api/v1/infrastructure/locations/unspecified/instances/instance-1"},"name":"instance-1","ref":"/infrastructure/locations/unspecified/instances/instance-1","uid":"ec8d8dac-10b6-4195-943b-1a5d65dd131c","updateTime":"2020-07-08T16:42:07.97301Z"}}]}}}}}
/ infrastructure / locations / {locationName} / instances
/ infrastructure / locations / {locationName} / instances / {instanceName}
Alerts API OpenAPI	{"openapi":"3.0.0","servers":[{"description":"NGINX Controller API","url":"https://{{CONTROLLER_FQDN}}/api/v1"}],"info":{"title":"Alerts API","description":"Use the Alerts API to manage the Alert Rule resources and retrieve information about the Alerts.","version":"v1"},"paths":{"/analytics/alerts/rules":{"get":{"tags":["Alert Rules"],"summary":"List all Alert Rules","operationId":"listAlertRules","x-f5-experimental":true,"description":"Returns a list of all the Alert Rule resources.","responses":{"200":{"description":"Successfully retrieved a list of all the Alert Rule resources.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AlertRule"}}}}},"400":{"description":"Bad input parameter, or possibly a bad URI. Check the input for typos and try again.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"500":{"description":"The request cannot be processed because of an internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}}}},"post":{"tags":["Alert Rules"],"summary":"Create an Alert Rule","description":"Creates a new Alert Rule resource.","operationId":"createAlertRule","x-f5-experimental":true,"requestBody":{"description":"Defines the Alert Rule resource to create.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlertRule"}}}},"responses":{"201":{"description":"Successfully created the specified Alert Rule resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlertRule"}}}},"400":{"description":"Bad input parameter, or possibly a bad URI. Check the input for typos and try again.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"409":{"description":"The request failed due to a naming conflict with an existing resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"500":{"description":"The request cannot be processed because of an internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}}}}},"/analytics/alerts/rules/{alertRuleName}":{"parameters":[{"name":"alertRuleName","description":"Identifies the Alert Rule resource.","in":"path","required":true,"schema":{"type":"string"}}],"get":{"tags":["Alert Rules"],"summary":"Get an Alert Rule","description":"Returns information for the specified Alert Rule.","operationId":"getAlertRule","x-f5-experimental":true,"responses":{"200":{"description":"Successfully returned the requested Alert Rule resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlertRule"}}}},"400":{"description":"Bad input parameter, or possibly a bad URI. Check the input for typos and try again.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"404":{"description":"The resource defined in the URI could not be found. Check the URI for errors and try again.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"500":{"description":"The request cannot be processed because of an internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}}}},"put":{"tags":["Alert Rules"],"summary":"Upsert a Alert Rule","description":"Creates a new Alert Rule or updates an existing Alert Rule resource.","operationId":"updateAlertRule","x-f5-experimental":true,"requestBody":{"description":"Defines the Alert Rule resource to create or the updates to make.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlertRule"}}}},"responses":{"200":{"description":"Successfully updated the specified Alert Rule resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlertRule"}}}},"201":{"description":"Successfully created the specified Alert Rule resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlertRule"}}}},"400":{"description":"Bad input parameter, or possibly a bad URI. Check the input for typos and try again.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"500":{"description":"The request cannot be processed because of an internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}}}},"delete":{"tags":["Alert Rules"],"summary":"Delete an Alert Rule","description":"Deletes the specified Alert Rule resource.","operationId":"deleteAlertRule","x-f5-experimental":true,"responses":{"204":{"description":"Successfully deleted the specified Alert Rule resource."},"400":{"description":"Bad input parameter, or possibly a bad URI. Check the input for typos and try again.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"404":{"description":"The resource defined in the URI could not be found. Check the URI for errors and try again.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"500":{"description":"The request cannot be processed because of an internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}}}}},"/analytics/alerts/rules/{alertRuleName}/alerts":{"parameters":[{"name":"alertRuleName","description":"Identifies the Alert Rule resource.","in":"path","required":true,"schema":{"type":"string"}}],"get":{"tags":["Alerts"],"summary":"Get ongoing Alerts","description":"Returns information about Alerts for the specified Alert Rule.","operationId":"getAlerts","x-f5-experimental":true,"responses":{"200":{"description":"Successfully returned the requested Alerts.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Alert"}}}}},"400":{"description":"Bad input parameter, or possibly a bad URI. Check the input for typos and try again.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"404":{"description":"The resource defined in the URI could not be found. Check the URI for errors and try again.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"500":{"description":"The request cannot be processed because of an internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}}}}},"/analytics/alerts/rules/{alertRuleName}/alerts/{alertId}":{"parameters":[{"name":"alertRuleName","description":"Identifies the Alert Rule resource.","in":"path","required":true,"schema":{"type":"string"}},{"name":"alertId","description":"Identifies the Alert resource.","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"get":{"tags":["Alerts"],"summary":"Get Alert","description":"Returns information about the requested Alert for the specified Alert Rule.","operationId":"getAlert","responses":{"200":{"description":"Successfully returned the requested Alert.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Alert"}}}},"400":{"description":"Bad input parameter, or possibly a bad URI. Check the input for typos and try again.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"404":{"description":"The resource defined in the URI could not be found. Check the URI for errors and try again.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"500":{"description":"The request cannot be processed because of an internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}}}}}},"components":{"schemas":{"Alert":{"title":"alert","type":"object","properties":{"uid":{"type":"string","format":"uuid"},"dimensions":{"type":"object","additionalProperties":{"type":"string"}},"startedTimestamp":{"type":"string","format":"date-time","example":"2019-07-29T09:12:33.001Z","description":"Timestamp when the Alert started."},"startedValue":{"type":"number","description":"Value of the metric that caused the Alert to start."},"lastCheckedTimestamp":{"type":"string","format":"date-time","example":"2019-07-29T09:12:33.001Z","description":"Timestamp when the Alert was last checked."},"lastCheckedValue":{"type":"number","description":"Value of the metric when the Alert was last checked."}},"required":["uid","dimensions","startedTimestamp","startedValue","lastCheckedTimestamp","lastCheckedValue"]},"AlertRuleStatus":{"title":"AlertRuleStatus","type":"object","properties":{"alertsCount":{"type":"integer","description":"Number of times an Alert for the Alert Rule has been started since creation."},"status":{"type":"string","enum":["ok","ongoing"],"description":"Alert Rule status:\n- `ok`: All the Alerts have expired or have never started.\n- `ongoing`: At least one Alert is currently ongoing.\n"},"lastStartedTimestamp":{"type":"string","format":"date-time","example":"2019-07-29T09:12:33.001Z","description":"Timestamp when the Alert Rule transfered from 'ok' to 'ongoing' status."},"lastExpiredTimestamp":{"type":"string","format":"date-time","example":"2019-07-29T09:12:33.001Z","description":"Timestamp when the Alert Rule transfered from 'ongoing' to 'ok' status."},"lastCheckedTimestamp":{"type":"string","format":"date-time","example":"2019-07-29T09:12:33.001Z","description":"Timestamp of the last successful check of the Alert Rule."}}},"AlertRule":{"title":"AlertRule","type":"object","properties":{"metadata":{"$ref":"#/components/schemas/ResourceMeta"},"userEmail":{"type":"string","format":"email","readOnly":true,"description":"Email of the user who created the Alert Rule."},"metric":{"type":"string","description":"A valid metric from the catalog.","example":"upstream.network.latency.max"},"aggregation":{"type":"string","description":"Aggregation of the metric over the configured period of time.","readOnly":true},"filter":{"type":"string","description":"The use of filter parameter limits the metrics data samples being taken into account for Alert Rule calculation\nto those matching the filter expression.\nFilter parameter syntax works the same as for `/analytics/metrics` API.\n\n- An empty filter parameter indicates that all collected data is going to be taken into account for Alert Rule calculation\n- `filter=app='myapp' AND (env='prod' or env='dev')` indicates that only samples related to desired app/env will be taken into account\n","example":"((app!='app1' OR app='app2') AND environment in ('dev', 'prod')) AND (tags!='*tag1*' AND interface='ens*')"},"groupBy":{"type":"string","description":"When `groupBy` is provided, alerts will be triggered for each distinct group of provided dimension(s).\nGroupBy parameter syntax works the same as for `/analytics/metrics` API.\n","example":"app,environment"},"threshold":{"type":"number","description":"Threshold to which the metric value will be compared to."},"operator":{"type":"string","enum":["ge","le"],"description":"Operator that defines which metric values will trigger an alert:\n\n- `ge`: metric value must be greater than or equal to the threshold in order to trigger an alert\n- `le`: metric value must be less than or equal to the threshold in order to trigger an alert\n"},"period":{"type":"string","example":"1h","description":"Period from which the metric aggregated value is calculated.\n\nMust be a valid duration - a string starting with a number followed by a unit of time (`h`, `m` or `s`).\n\n24h is the maximum allowed period.\n"},"notificationType":{"description":"Defines how notifications about triggered Alerts will be delivered to the user.","type":"string","enum":["email"]},"emailAddresses":{"type":"array","minItems":1,"uniqueItems":true,"items":{"type":"string","format":"email","example":"user@example.com"}},"mute":{"type":"boolean","description":"Indicates if the Alert Rule is muted. (Muted Alert Rules will not trigger notifications).","default":false},"status":{"$ref":"#/components/schemas/AlertRuleStatus","readOnly":true}},"required":["metadata","metric","threshold","operator","period"]},"SelfLinks":{"type":"object","description":"The SelfLinks object contains a link from the resource to itself.\nThis object is used only in responses.\n","properties":{"rel":{"type":"string","example":"/api/v1/services/environments/prod","description":"`rel` contains the complete path fragment of a URI and can be used\nto construct a query to the object.\n"}}},"ResourceMeta":{"type":"object","required":["name"],"properties":{"name":{"type":"string","pattern":"^[^A-Z\\s\\x00-\\x1f\\x60\\x7f\\;\\*\\\"\\[\\]\\{\\}\\\\\\/%\\?:=&\\~\\^|#<>]+$","not":{"type":"string","enum":[".",".."]},"minLength":1,"maxLength":1024,"example":"resource-name","description":"Resource name is a unique identifier for a resource within the context of a namespace.\nResource names must conform to [RFC 1738 Section 2.2](https://www.ietf.org/rfc/rfc1738.txt) and have a valid syntax for email addresses. The following rules are enforced:\n\n- do not utilize URL encoding;\n- do not include spaces;\n- do not use uppercase characters, for example, 'A-Z'; extended character sets are supported;\n- do not use the following characters: `\"`, `*`, `:`, `;`, `/`, `\\`, `%`, `?`, `hash`, `=`, `&`, `|`, `~`, `^`, `{`, `}`, `[`, `]`, `<`, `>`;\n- cannot start or end with an `@` sign;\n- cannot be only `.` or `..`\n\nFor example: For a collection resource located at\n\n`https://controller.example.com/api/v1/services/apps/shopping_@1`\n\nthe resource name is \"shopping_@1\".\n"},"displayName":{"type":"string","example":"My Display Name","description":"`displayName` is a user friendly resource name. It can be used to define \na longer, and less constrained, name for a resource.\n\nDisplay names:\n\n- are optional (defaults to an empty string if no value is provided),\n- do not have to be unique, \n- cannot be assigned by the server.\n"},"description":{"type":"string","example":"This is a sample description string. It provides information about the resource.","description":"`description` is a free-form text property. You can use it to provide information that helps \nto identify the resource.\n\nDescriptions:\n\n- are optional (defaults to an empty string if no value is provided),\n- do not have to be unique, \n- cannot be assigned by the server.\n"},"kind":{"type":"string","example":"<collection>-<object>","description":"Kind is a string representation of an API resource's data type.\nIt is assigned by the server and cannot be changed. \n\nWhen creating a `kind`, the server uses hyphens to connect word segments; \nsingleton and collection item resources are not pluralized.\n"},"uid":{"type":"string","format":"uuid","example":"d290f1ee-6c54-4b01-90e6-d701748f0851","description":"Unique Identifier (UID)\n\nUID is a unique identifier in time and space for a resource. \nWhen you create a resource, the server assigns a UID to the resource.\n\nRefer to [IETF RFC 4122](https://tools.ietf.org/html/rfc4122) for more information.\n"},"tags":{"type":"array","items":{"type":"string"},"example":["production_public","dev","new_app","us-west-1","emea"],"description":"You can assign `tags` to a resource as a way to help map, scope, \nand organize resources. \n\nThe system uses tag selectors to specify selection criteria that \nmatch resources that have particular tags.\n"},"ref":{"type":"string","example":"/services/environments/prod","description":"The `ref` field contains a reference to another NGINX Controller resource.\n"},"links":{"$ref":"#/components/schemas/SelfLinks"},"createTime":{"type":"string","format":"date-time","example":"2019-07-29T09:12:33.001Z","description":"A timestamp that represents the server time when the resource was created.\n\nCreate time is not guaranteed to be set in \"happens-before\" order\nacross separate operations.\n\nIn JSON format, `create_time` type is encoded as a string in the\n[RFC 3339](https://www.ietf.org/rfc/rfc3339.txt).\n\nFor example: 2018-04-01T01:30:15.01Z\n\nCreate Time is assigned by the server and cannot be changed.\n"},"updateTime":{"type":"string","format":"date-time","example":"2019-07-29T10:12:33.001Z","description":"A timestamp that represents the server time when the resource was last modified.\n\nResources that have never been updated do not have an `update_time` stamp.\n\nThe default value for resources that have never been updated is the local \nlanguage-specific equivalent of \"null\".\n\nIn JSON format, `update_time` type is encoded as a string as described in \n[RFC 3339](https://www.ietf.org/rfc/rfc3339.txt).\n"}}},"ErrorDetail":{"type":"object","required":["description"],"properties":{"description":{"type":"string","example":"Error doing <action>: <reason for error>. This can lead to <potential consequences>. Try <action> to resolve the issue.","description":"A detailed error message returned by the server. \n\nThese messages contain the following information, where applicable:\n\n- What happened.\n- Why it happened.\n- What the consequences are (if any).\n- Recommended action to take to resolve the issue.\n"}}},"ErrorModel":{"type":"object","required":["message","code"],"properties":{"message":{"type":"string","example":"Error doing <action>.","description":"A human-readable message, in English, that describes the error.\n"},"code":{"type":"integer","example":1234567,"description":"A numeric error code that can be used to identify errors for support purposes.\n"},"details":{"type":"array","items":{"$ref":"#/components/schemas/ErrorDetail"}}}}}}}
/ analytics / alerts / rules
/ analytics / alerts / rules / {alertRuleName}
/ analytics / alerts / rules / {alertRuleName} / alerts
/ analytics / alerts / rules / {alertRuleName} / alerts / {alertId}
Roles API OpenAPI	{"openapi":"3.0.0","info":{"version":"v1","title":"Roles API","description":"Use the Roles API to manage NGINX Controller User Roles."},"servers":[{"description":"NGINX Controller API","url":"https://{{CONTROLLER_FQDN}}/api/v1"}],"paths":{"/platform/roles":{"get":{"tags":["Roles"],"summary":"List Roles","description":"Returns an unfiltered list of all Role resources.","operationId":"getRoles","responses":{"200":{"description":"Successfully retrieved a list of all of the Role resources.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RoleListResponse"},"example":{"items":[{"currentStatus":{"permissions":[{"access":"FULL","path":"/"}]},"desiredState":{"permissions":[{"access":"FULL","path":"/"}]},"metadata":{"createTime":"2020-02-24T21:29:59.866708Z","kind":"role","name":"admin"}}]}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"500":{"$ref":"#/components/responses/Internal"}}},"post":{"tags":["Roles"],"summary":"Create a Role","description":"Creates a new Role resource.","operationId":"createRole","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Role"},"example":{"desiredState":{"permissions":[{"access":"READ","path":"/services/environments/dev/"},{"access":"WRITE","path":"/services/environments/test/"}]},"metadata":{"kind":"role","name":"role1","tags":["dev","test"]}}}}},"responses":{"201":{"description":"Successfully created the requested Role resource.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Role"},"example":{"currentStatus":{"permissions":[{"access":"READ","path":"/services/environments/dev/"},{"access":"WRITE","path":"/services/environments/test/"}]},"desiredState":{"permissions":[{"access":"READ","path":"/services/environments/dev/"},{"access":"WRITE","path":"/services/environments/test/"}]},"metadata":{"createTime":"2020-02-24T22:55:51.729272Z","kind":"role","name":"role1","tags":["dev","test"]}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"409":{"$ref":"#/components/responses/Conflict"},"500":{"$ref":"#/components/responses/Internal"}}}},"/platform/roles/{roleName}":{"get":{"tags":["Roles"],"summary":"Get a Role","description":"Returns information about a specific Role resource by its name.\n","operationId":"getRoleByName","parameters":[{"$ref":"#/components/parameters/roleName"}],"responses":{"200":{"description":"Successfully retrieved the requested Role resource.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Role"},"example":{"currentStatus":{"permissions":[{"access":"READ","path":"/services/environments/test/"},{"access":"WRITE","path":"/services/environments/dev/"}]},"desiredState":{"permissions":[{"access":"READ","path":"/services/environments/test/"},{"access":"WRITE","path":"/services/environments/dev/"}]},"metadata":{"createTime":"2020-02-24T22:38:33.842929Z","kind":"role","name":"role1","tags":["dev","test"]}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/Internal"}}},"put":{"tags":["Roles"],"summary":"Upsert a Role","description":"Creates a new Role resource or updates an existing Role resource.\n","operationId":"upsertRole","parameters":[{"$ref":"#/components/parameters/roleName"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Role"},"example":{"desiredState":{"permissions":[{"access":"WRITE","path":"/services/environments/dev/"}]},"metadata":{"kind":"role","name":"role1","tags":["dev","test"]}}}}},"responses":{"200":{"description":"Successfully updated the specified Role resource.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Role"},"example":{"currentStatus":{"permissions":[{"access":"WRITE","path":"/services/environments/dev/"}]},"desiredState":{"permissions":[{"access":"WRITE","path":"/services/environments/dev/"}]},"metadata":{"createTime":"2020-02-24T22:38:33.842929Z","kind":"role","name":"role1","updateTime":"2020-02-24T22:53:14.340686Z","tags":["dev","test"]}}}}},"201":{"description":"Successfully created the specified Role resource.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Role"},"example":{"currentStatus":{"permissions":[{"access":"WRITE","path":"/services/environments/dev/"}]},"desiredState":{"permissions":[{"access":"WRITE","path":"/services/environments/dev/"}]},"metadata":{"createTime":"2020-02-24T22:38:33.842929Z","kind":"role","name":"role1","updateTime":"2020-02-24T22:53:14.340686Z","tags":["dev","test"]}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"500":{"$ref":"#/components/responses/Internal"}}},"delete":{"tags":["Roles"],"summary":"Delete a Role","description":"Deletes a specific Role resource.","operationId":"deleteRole","parameters":[{"$ref":"#/components/parameters/roleName"}],"responses":{"204":{"description":"Successfully deleted the role. No content was returned."},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/Conflict"},"500":{"$ref":"#/components/responses/Internal"}}}}},"components":{"securitySchemes":{"cookieAuth":{"type":"apiKey","in":"cookie","name":"session"}},"parameters":{"roleName":{"in":"path","name":"roleName","schema":{"type":"string"},"required":true,"description":"The name of the Role.\n"}},"responses":{"BadRequest":{"description":"Bad input parameter, or possibly a bad URI. Check the input for typos and try again.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"},"example":{"code":100,"details":[{"description":"Request body has an error: doesn't match the schema: Error at \"/desiredState/permissions/0/access\":JSON value is not one of the allowed values\nSchema:\n {\n \"enum\": [\n \"NONE\",\n \"READ\",\n \"WRITE\",\n \"FULL\"\n ],\n \"type\": \"string\"\n }\n\nValue:\n \"DELETE\"\n"}],"message":"Failed to validate Request"}}}},"Unauthorized":{"description":"User authentication is invalid or missing.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"},"example":{"code":401,"message":"authentication needed"}}}},"Forbidden":{"description":"The request failed due to insufficient privileges.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"},"example":{"code":403,"message":"unauthorized"}}}},"Internal":{"description":"The request cannot be processed because of an internal server error.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"},"example":{"code":8913,"message":"Failed to add permissions to database."}}}},"NotFound":{"description":"The specified Role was not found.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"},"example":{"code":8920,"message":"Error getting or deleting role: role not found."}}}},"Conflict":{"description":"The request failed due to a conflict with an existing Role, Group, or User resource.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"},"example":{"code":8919,"message":"Error creating role: role already exists."}}}}},"schemas":{"RoleListResponse":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/Role"},"description":"Contains list of Role objects.\n"}}},"Role":{"type":"object","required":["metadata","desiredState"],"properties":{"metadata":{"$ref":"#/components/schemas/ResourceMeta"},"desiredState":{"$ref":"#/components/schemas/RoleDef"},"currentStatus":{"$ref":"#/components/schemas/RoleDef"}}},"RoleDef":{"type":"object","required":["permissions"],"description":"A Role is a collection of permissions and child Roles. All Roles are globally unique. You can assign Roles to users or to other Roles.\n","properties":{"permissions":{"type":"array","minItems":1,"items":{"$ref":"#/components/schemas/Permission"}}}},"Permission":{"type":"object","required":["access","path"],"description":"A Permission is a pair consisting of a path or object and the desired level of access. Permissions govern Users ability to access specific paths or objects within an Environment.\n","properties":{"path":{"type":"string","example":"/services/environments/dev/","pattern":"^(\\/[^A-Z\\s\\x00-\\x1f\\x60\\x7f\\;\\\"\\[\\]\\{\\}\\\\\\/]*)+","description":"The path represents an area of the platform to which the Role grants access. For example, to allow the Role to access an Environment named \"dev\", you would define the path \"/services/environments/dev\".\n"},"access":{"type":"string","enum":["NONE","READ","WRITE","FULL"],"description":"Access determines the Role's ability to access a path or object. The options are:\n* NONE: Does not have any access to the path or object\n* READ: Has read only access (HTTP GET requests)\n* WRITE: Has read and write access (POST, PUT, PATCH requests) but cannot delete\n* FULL: Has read, write and delete access\n"}}},"SelfLinks":{"type":"object","description":"The SelfLinks object contains a link from the resource to itself.\nThis object is used only in responses.\n","properties":{"rel":{"type":"string","example":"/api/v1/services/environments/prod","description":"`rel` contains the complete path fragment of a URI and can be used\nto construct a query to the object.\n"}}},"ResourceMeta":{"type":"object","required":["name"],"properties":{"name":{"type":"string","pattern":"^[^A-Z\\s\\x00-\\x1f\\x60\\x7f\\;\\*\\\"\\[\\]\\{\\}\\\\\\/%\\?:=&\\~\\^|#<>]+$","not":{"type":"string","enum":[".",".."]},"minLength":1,"maxLength":1024,"example":"resource-name","description":"Resource name is a unique identifier for a resource within the context of a namespace.\nResource names must conform to [RFC 1738 Section 2.2](https://www.ietf.org/rfc/rfc1738.txt) and have a valid syntax for email addresses. The following rules are enforced:\n\n- do not utilize URL encoding;\n- do not include spaces;\n- do not use uppercase characters, for example, 'A-Z'; extended character sets are supported;\n- do not use the following characters: `\"`, `*`, `:`, `;`, `/`, `\\`, `%`, `?`, `hash`, `=`, `&`, `|`, `~`, `^`, `{`, `}`, `[`, `]`, `<`, `>`;\n- cannot start or end with an `@` sign;\n- cannot be only `.` or `..`\n\nFor example: For a collection resource located at\n\n`https://controller.example.com/api/v1/services/apps/shopping_@1`\n\nthe resource name is \"shopping_@1\".\n"},"displayName":{"type":"string","example":"My Display Name","description":"`displayName` is a user friendly resource name. It can be used to define \na longer, and less constrained, name for a resource.\n\nDisplay names:\n\n- are optional (defaults to an empty string if no value is provided),\n- do not have to be unique, \n- cannot be assigned by the server.\n"},"description":{"type":"string","example":"This is a sample description string. It provides information about the resource.","description":"`description` is a free-form text property. You can use it to provide information that helps \nto identify the resource.\n\nDescriptions:\n\n- are optional (defaults to an empty string if no value is provided),\n- do not have to be unique, \n- cannot be assigned by the server.\n"},"kind":{"type":"string","example":"<collection>-<object>","description":"Kind is a string representation of an API resource's data type.\nIt is assigned by the server and cannot be changed. \n\nWhen creating a `kind`, the server uses hyphens to connect word segments; \nsingleton and collection item resources are not pluralized.\n"},"uid":{"type":"string","format":"uuid","example":"d290f1ee-6c54-4b01-90e6-d701748f0851","description":"Unique Identifier (UID)\n\nUID is a unique identifier in time and space for a resource. \nWhen you create a resource, the server assigns a UID to the resource.\n\nRefer to [IETF RFC 4122](https://tools.ietf.org/html/rfc4122) for more information.\n"},"tags":{"type":"array","items":{"type":"string"},"example":["production_public","dev","new_app","us-west-1","emea"],"description":"You can assign `tags` to a resource as a way to help map, scope, \nand organize resources. \n\nThe system uses tag selectors to specify selection criteria that \nmatch resources that have particular tags.\n"},"ref":{"type":"string","example":"/services/environments/prod","description":"The `ref` field contains a reference to another NGINX Controller resource.\n"},"links":{"$ref":"#/components/schemas/SelfLinks"},"createTime":{"type":"string","format":"date-time","example":"2019-07-29T09:12:33.001Z","description":"A timestamp that represents the server time when the resource was created.\n\nCreate time is not guaranteed to be set in \"happens-before\" order\nacross separate operations.\n\nIn JSON format, `create_time` type is encoded as a string in the\n[RFC 3339](https://www.ietf.org/rfc/rfc3339.txt).\n\nFor example: 2018-04-01T01:30:15.01Z\n\nCreate Time is assigned by the server and cannot be changed.\n"},"updateTime":{"type":"string","format":"date-time","example":"2019-07-29T10:12:33.001Z","description":"A timestamp that represents the server time when the resource was last modified.\n\nResources that have never been updated do not have an `update_time` stamp.\n\nThe default value for resources that have never been updated is the local \nlanguage-specific equivalent of \"null\".\n\nIn JSON format, `update_time` type is encoded as a string as described in \n[RFC 3339](https://www.ietf.org/rfc/rfc3339.txt).\n"}}},"ErrorDetail":{"type":"object","required":["description"],"properties":{"description":{"type":"string","example":"Error doing <action>: <reason for error>. This can lead to <potential consequences>. Try <action> to resolve the issue.","description":"A detailed error message returned by the server. \n\nThese messages contain the following information, where applicable:\n\n- What happened.\n- Why it happened.\n- What the consequences are (if any).\n- Recommended action to take to resolve the issue.\n"}}},"ErrorModel":{"type":"object","required":["message","code"],"properties":{"message":{"type":"string","example":"Error doing <action>.","description":"A human-readable message, in English, that describes the error.\n"},"code":{"type":"integer","example":1234567,"description":"A numeric error code that can be used to identify errors for support purposes.\n"},"details":{"type":"array","items":{"$ref":"#/components/schemas/ErrorDetail"}}}}}}}
/ platform / roles
/ platform / roles / {roleName}
Features API OpenAPI	{"openapi":"3.0.0","servers":[{"description":"NGINX Controller API","url":"https://{{CONTROLLER_FQDN}}/api/v1"}],"info":{"description":"Use the Features API to manage NGINX Controller features.","version":"v1","title":"Features API"},"paths":{"/platform/global/features":{"x-f5-experimental":true,"get":{"x-f5-experimental":true,"tags":["Global Features"],"summary":"Get the Global Features","operationId":"getGlobalFeatures","description":"Gets information about the global features for NGINX Controller.","responses":{"200":{"description":"Successfully retrieved the global features for NGINX Controller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GlobalFeatures"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"500":{"$ref":"#/components/responses/Internal"}}}}},"components":{"responses":{"Internal":{"description":"The request cannot be processed because of an internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"Unauthorized":{"description":"User authentication is invalid or missing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"Forbidden":{"description":"The request failed due to insufficient privileges.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}}},"schemas":{"GlobalFeatures":{"type":"object","required":["metadata"],"properties":{"metadata":{"$ref":"#/components/schemas/ResourceMeta"},"desiredState":{"type":"object","properties":{"featureFlags":{"type":"array","description":"Flags to describe or extend NGINX Controller behavior (optional).","items":{"$ref":"#/components/schemas/FeatureFlagsDef"}}}},"currentStatus":{"type":"object","properties":{"state":{"$ref":"#/components/schemas/ConfigState"},"featureFlags":{"type":"array","description":"Flags to describe or extend NGINX Controller behavior (optional).","items":{"$ref":"#/components/schemas/FeatureFlagsDef"}}}}}},"FeatureFlagsDef":{"type":"object","required":["name","value"],"properties":{"name":{"type":"string"},"value":{"type":"string"}},"example":{"name":"reserved","value":"true"}},"SelfLinks":{"type":"object","description":"The SelfLinks object contains a link from the resource to itself.\nThis object is used only in responses.\n","properties":{"rel":{"type":"string","example":"/api/v1/services/environments/prod","description":"`rel` contains the complete path fragment of a URI and can be used\nto construct a query to the object.\n"}}},"ResourceMeta":{"type":"object","required":["name"],"properties":{"name":{"type":"string","pattern":"^[^A-Z\\s\\x00-\\x1f\\x60\\x7f\\;\\*\\\"\\[\\]\\{\\}\\\\\\/%\\?:=&\\~\\^|#<>]+$","not":{"type":"string","enum":[".",".."]},"minLength":1,"maxLength":1024,"example":"resource-name","description":"Resource name is a unique identifier for a resource within the context of a namespace.\nResource names must conform to [RFC 1738 Section 2.2](https://www.ietf.org/rfc/rfc1738.txt) and have a valid syntax for email addresses. The following rules are enforced:\n\n- do not utilize URL encoding;\n- do not include spaces;\n- do not use uppercase characters, for example, 'A-Z'; extended character sets are supported;\n- do not use the following characters: `\"`, `*`, `:`, `;`, `/`, `\\`, `%`, `?`, `hash`, `=`, `&`, `|`, `~`, `^`, `{`, `}`, `[`, `]`, `<`, `>`;\n- cannot start or end with an `@` sign;\n- cannot be only `.` or `..`\n\nFor example: For a collection resource located at\n\n`https://controller.example.com/api/v1/services/apps/shopping_@1`\n\nthe resource name is \"shopping_@1\".\n"},"displayName":{"type":"string","example":"My Display Name","description":"`displayName` is a user friendly resource name. It can be used to define \na longer, and less constrained, name for a resource.\n\nDisplay names:\n\n- are optional (defaults to an empty string if no value is provided),\n- do not have to be unique, \n- cannot be assigned by the server.\n"},"description":{"type":"string","example":"This is a sample description string. It provides information about the resource.","description":"`description` is a free-form text property. You can use it to provide information that helps \nto identify the resource.\n\nDescriptions:\n\n- are optional (defaults to an empty string if no value is provided),\n- do not have to be unique, \n- cannot be assigned by the server.\n"},"kind":{"type":"string","example":"<collection>-<object>","description":"Kind is a string representation of an API resource's data type.\nIt is assigned by the server and cannot be changed. \n\nWhen creating a `kind`, the server uses hyphens to connect word segments; \nsingleton and collection item resources are not pluralized.\n"},"uid":{"type":"string","format":"uuid","example":"d290f1ee-6c54-4b01-90e6-d701748f0851","description":"Unique Identifier (UID)\n\nUID is a unique identifier in time and space for a resource. \nWhen you create a resource, the server assigns a UID to the resource.\n\nRefer to [IETF RFC 4122](https://tools.ietf.org/html/rfc4122) for more information.\n"},"tags":{"type":"array","items":{"type":"string"},"example":["production_public","dev","new_app","us-west-1","emea"],"description":"You can assign `tags` to a resource as a way to help map, scope, \nand organize resources. \n\nThe system uses tag selectors to specify selection criteria that \nmatch resources that have particular tags.\n"},"ref":{"type":"string","example":"/services/environments/prod","description":"The `ref` field contains a reference to another NGINX Controller resource.\n"},"links":{"$ref":"#/components/schemas/SelfLinks"},"createTime":{"type":"string","format":"date-time","example":"2019-07-29T09:12:33.001Z","description":"A timestamp that represents the server time when the resource was created.\n\nCreate time is not guaranteed to be set in \"happens-before\" order\nacross separate operations.\n\nIn JSON format, `create_time` type is encoded as a string in the\n[RFC 3339](https://www.ietf.org/rfc/rfc3339.txt).\n\nFor example: 2018-04-01T01:30:15.01Z\n\nCreate Time is assigned by the server and cannot be changed.\n"},"updateTime":{"type":"string","format":"date-time","example":"2019-07-29T10:12:33.001Z","description":"A timestamp that represents the server time when the resource was last modified.\n\nResources that have never been updated do not have an `update_time` stamp.\n\nThe default value for resources that have never been updated is the local \nlanguage-specific equivalent of \"null\".\n\nIn JSON format, `update_time` type is encoded as a string as described in \n[RFC 3339](https://www.ietf.org/rfc/rfc3339.txt).\n"}}},"ConfigStateTally":{"type":"object","properties":{"isConfigured":{"type":"boolean","description":"The configuration operation is complete."},"isConfiguring":{"type":"boolean","description":"The configuration of the resource, or of its child(ren), is in process."},"isError":{"type":"boolean","description":"An error occurred while configuring the resource or its child(ren)."},"isDeleting":{"type":"boolean","description":"A delete operation is in progress for the resource or its child(ren)."},"total":{"type":"integer","description":"The total number of resources to which the configuration operation applies."},"configured":{"type":"integer","description":"The number of resources that have a complete and valid configuration."},"configuring":{"type":"integer","description":"The number of resources that are in the process of being configured."},"error":{"type":"integer","description":"The number of resources that have encountered an error during the configuration process."},"deleting":{"type":"integer","description":"The number of resources that are in the process of being deleted."}}},"ConfigCondition":{"type":"object","properties":{"type":{"type":"string","description":"The condition type."},"message":{"type":"string","description":"A human-readable message that provides additional information about the configuration operation."}}},"ConfigState":{"type":"object","description":"A representation of the resource's current configuration state \nthat comprises the status of the resource itself (`selfConfigState`) and any child \nresources (`childrenConfigState`).\n\nThe conditions array provides additional information during configuration changes.\n","properties":{"selfConfigState":{"$ref":"#/components/schemas/ConfigStateTally"},"childrenConfigState":{"$ref":"#/components/schemas/ConfigStateTally"},"conditions":{"type":"array","items":{"$ref":"#/components/schemas/ConfigCondition"}}}},"ErrorDetail":{"type":"object","required":["description"],"properties":{"description":{"type":"string","example":"Error doing <action>: <reason for error>. This can lead to <potential consequences>. Try <action> to resolve the issue.","description":"A detailed error message returned by the server. \n\nThese messages contain the following information, where applicable:\n\n- What happened.\n- Why it happened.\n- What the consequences are (if any).\n- Recommended action to take to resolve the issue.\n"}}},"ErrorModel":{"type":"object","required":["message","code"],"properties":{"message":{"type":"string","example":"Error doing <action>.","description":"A human-readable message, in English, that describes the error.\n"},"code":{"type":"integer","example":1234567,"description":"A numeric error code that can be used to identify errors for support purposes.\n"},"details":{"type":"array","items":{"$ref":"#/components/schemas/ErrorDetail"}}}}}}}
/ platform / global / features
Integrations API OpenAPI	{"openapi":"3.0.0","info":{"title":"Integrations API","description":"Use the Integrations API to manage integrated cloud provider or data collector accounts.","version":"v1"},"servers":[{"description":"NGINX Controller API","url":"https://{{CONTROLLER_FQDN}}/api/v1"}],"paths":{"/platform/integrations":{"get":{"tags":["Integrations"],"summary":"List all Integrations","description":"Returns an unfiltered list of integration accounts.","operationId":"listIntegrations","responses":{"200":{"description":"Successfully retreived a list of integration accounts.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListIntegrationResponse"},"examples":{"INTEGRATIONS":{"$ref":"#/components/examples/ListIntegrationResponse"}}}}}}},"post":{"tags":["Integrations"],"summary":"Create an Integration account","description":"Creates a new integration account.","operationId":"addIntegration","requestBody":{"description":"Defines the integration account to be added.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Integration"},"examples":{"AWS":{"$ref":"#/components/examples/AWSRequest"},"Splunk":{"$ref":"#/components/examples/SplunkRequest"}}}}},"responses":{"201":{"description":"Successfully created the requested integration.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetIntegrationResponse"},"examples":{"AWS":{"$ref":"#/components/examples/AWSResponse"},"Splunk":{"$ref":"#/components/examples/SplunkResponse"}}}}},"400":{"description":"Bad input parameter, or possibly a bad URI. Check the input for typos and try again.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"},"examples":{"BadReq":{"$ref":"#/components/examples/BadRequestError"}}}}},"409":{"description":"The request failed due to a conflict with an existing integration.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"},"examples":{"AlreadyExists":{"$ref":"#/components/examples/AlreadyExistsError"}}}}}}}},"/platform/integrations/{integrationName}":{"get":{"tags":["Integrations"],"summary":"Get an Integration account","description":"Gets information about a specific integration account.","operationId":"getIntegration","parameters":[{"$ref":"#/components/parameters/IntegrationName"}],"responses":{"200":{"description":"Successfully retrieved the requested integration account.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetIntegrationResponse"},"examples":{"AWS":{"$ref":"#/components/examples/AWSResponse"}}}}},"404":{"description":"Integration resource not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"},"examples":{"NotFound":{"$ref":"#/components/examples/NotFoundError"}}}}}}},"put":{"tags":["Integrations"],"summary":"Upsert an Integration account","description":"Creates a new integration account or updates an existing integration account.","operationId":"upsertIntegration","parameters":[{"$ref":"#/components/parameters/IntegrationName"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Integration"},"examples":{"AWS":{"$ref":"#/components/examples/AWSRequest"},"Splunk":{"$ref":"#/components/examples/SplunkRequest"}}}},"required":true},"responses":{"200":{"description":"Successfully received the request to update the specified integration account.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetIntegrationResponse"},"examples":{"AWS":{"$ref":"#/components/examples/AWSResponse"},"Splunk":{"$ref":"#/components/examples/SplunkResponse"}}}}},"201":{"description":"Successfully updated the specified integration account.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetIntegrationResponse"},"examples":{"AWS":{"$ref":"#/components/examples/AWSResponse"},"Splunk":{"$ref":"#/components/examples/SplunkResponse"}}}}},"400":{"description":"Bad input parameter, or possibly a bad URI. Check the input for typos and try again.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"},"examples":{"BadReq":{"$ref":"#/components/examples/BadRequestError"}}}}}}},"patch":{"tags":["Integrations"],"summary":"Update an Integration account","description":"Updates an existing integration account.","operationId":"updateIntegration","parameters":[{"$ref":"#/components/parameters/IntegrationName"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateIntegration"},"examples":{"AWS":{"$ref":"#/components/examples/AWSRequestForPatch"},"Splunk":{"$ref":"#/components/examples/SplunkRequestForPatch"}}}},"required":true},"responses":{"200":{"description":"Successfully received the request to update the specified integration account.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateIntegration"},"examples":{"AWS":{"$ref":"#/components/examples/AWSResponseForPatch"},"Splunk":{"$ref":"#/components/examples/SplunkResponseForPatch"}}}}},"400":{"description":"Bad input parameter, or possibly a bad URI. Check the input for typos and try again.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"},"examples":{"BadReq":{"$ref":"#/components/examples/BadRequestError"}}}}},"404":{"description":"Integration resource not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"},"examples":{"NotFound":{"$ref":"#/components/examples/NotFoundError"}}}}}}},"delete":{"tags":["Integrations"],"summary":"Delete an Integration account","description":"Deletes the specified integration account.","operationId":"deleteIntegration","parameters":[{"$ref":"#/components/parameters/IntegrationName"}],"responses":{"204":{"description":"Successfully deleted the specified integration account."},"404":{"description":"Integration not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"},"examples":{"NotFound":{"$ref":"#/components/examples/NotFoundError"}}}}}}}}},"components":{"parameters":{"IntegrationName":{"name":"integrationName","in":"path","description":"The name of the integration account.","required":true,"schema":{"type":"string"}}},"schemas":{"Integration":{"type":"object","description":"The Integration resource defines the account credentials and endpoint needed for NGINX Controller to connect to external services.\n","required":["metadata","desiredState"],"properties":{"metadata":{"$ref":"#/components/schemas/ResourceMeta"},"desiredState":{"$ref":"#/components/schemas/IntegrationState"},"currentStatus":{"$ref":"#/components/schemas/IntegrationState"}}},"GetIntegrationResponse":{"allOf":[{"$ref":"#/components/schemas/Integration"}]},"ListIntegrationResponse":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/Integration"}}}},"UpdateIntegration":{"type":"object","required":["metadata"],"properties":{"metadata":{"$ref":"#/components/schemas/ResourceMeta"},"desiredState":{"$ref":"#/components/schemas/UpdateIntegrationState"},"currentStatus":{"$ref":"#/components/schemas/UpdateIntegrationState"}}},"UpdateIntegrationState":{"oneOf":[{"$ref":"#/components/schemas/AWSIntegrationForUpdate"},{"$ref":"#/components/schemas/AzureIntegrationForUpdate"},{"$ref":"#/components/schemas/GenericIntegrationForUpdate"},{"$ref":"#/components/schemas/VSphereIntegrationForUpdate"}],"discriminator":{"propertyName":"type","mapping":{"AWS_INTEGRATION":"#/components/schemas/AWSIntegrationForUpdate","AZURE_INTEGRATION":"#/components/schemas/AzureIntegrationForUpdate","GENERIC_INTEGRATION":"#/components/schemas/GenericIntegrationForUpdate","VSPHERE_INTEGRATION":"#/components/schemas/VSphereIntegrationForUpdate"}}},"AWSIntegrationForUpdate":{"description":"The AWS integration stores the AWS access key for programmatic access to the AWS cloud API.\n","required":["type"],"type":"object","properties":{"type":{"type":"string","description":"The AWS_INTEGRATION is an integration for connecting to Amazon Web Services (AWS).","enum":["AWS_INTEGRATION"]},"endpointUri":{"type":"string","description":"The URI of the AWS cloud service endpoint."},"credential":{"description":"Account credentials for AWS cloud API.\n","oneOf":[{"$ref":"#/components/schemas/AWSAccessKeyCredential"}],"discriminator":{"propertyName":"type","mapping":{"AWS_ACCESS_KEY":"#/components/schemas/AWSAccessKeyCredential"}}}}},"AzureIntegrationForUpdate":{"description":"The Azure integration stores the Azure credentials for programmatic access to the Azure cloud API.\n","required":["type"],"type":"object","properties":{"type":{"type":"string","description":"The AZURE_INTEGRATION is an integration for connecting to Microsoft Azure.","enum":["AZURE_INTEGRATION"]},"credential":{"description":"Account credentials for Azure cloud API.\n","oneOf":[{"$ref":"#/components/schemas/AzureServicePrincipal"}],"discriminator":{"propertyName":"type","mapping":{"AZURE_SERVICE_PRINCIPAL":"#/components/schemas/AzureServicePrincipal"}}}}},"VSphereIntegrationForUpdate":{"type":"object","description":"The VSphere integration stores the credentials for programmatic access to the VSphere cloud API.\n","required":["type"],"properties":{"type":{"type":"string","description":"The VSPHERE_INTEGRATION is an Integration for connecting to the VSphere datacenter.\n","enum":["VSPHERE_INTEGRATION"]},"hostname":{"type":"string","description":"VSphere instance hostname ( FQDN or IP ), Connection to it from the controller is through https, the VSphere server certificate is not verified."},"rawCa":{"type":"string","description":"Raw CA Certificate used to verify the vSphere server certificate","example":"-----BEGIN CERTIFICATE-----\n MIIDMTCCasdfAwIBAgIUWw25xyNvQPxtjGUZopz0KeoaaQkwDQYJKoZIhvcNAQEL\n [SNIP]\n 2CPqdhpmQhAbzx9ElT8KyC7/08IdV0JK/kSWjfE4jOPOJyI2q0DWExKLuYe+rO+Q\n rg7hesA=\n -----END CERTIFICATE-----"},"credential":{"oneOf":[{"$ref":"#/components/schemas/UserPassCredential"}],"discriminator":{"propertyName":"type","mapping":{"USER_PASS":"#/components/schemas/UserPassCredential"}}}}},"GenericIntegrationForUpdate":{"required":["type"],"type":"object","description":"A Generic integration stores the credentials and URI endpoint to connect to external services\nthat require a username and password or an API token for authentication, or accept an unauthenticated connection.\n","properties":{"type":{"type":"string","description":"The GENERIC_INTEGRATION is an integration for connecting to external services that require a\nusername and password or an API key, or accept an unauthenticated connection.\n","enum":["GENERIC_INTEGRATION"]},"endpointUri":{"type":"string","description":"The URI of the service endpoint."},"credential":{"oneOf":[{"$ref":"#/components/schemas/UserPassCredential"},{"$ref":"#/components/schemas/ApiKeyCredential"},{"$ref":"#/components/schemas/Unauthenticated"}],"discriminator":{"propertyName":"type","mapping":{"USER_PASS":"#/components/schemas/UserPassCredential","API_KEY":"#/components/schemas/ApiKeyCredential","UNAUTHENTICATED":"#/components/schemas/Unauthenticated"}}}}},"IntegrationState":{"oneOf":[{"$ref":"#/components/schemas/AWSIntegration"},{"$ref":"#/components/schemas/AzureIntegration"},{"$ref":"#/components/schemas/GenericIntegration"},{"$ref":"#/components/schemas/VSphereIntegration"}],"discriminator":{"propertyName":"type","mapping":{"AWS_INTEGRATION":"#/components/schemas/AWSIntegration","AZURE_INTEGRATION":"#/components/schemas/AzureIntegration","GENERIC_INTEGRATION":"#/components/schemas/GenericIntegration","VSPHERE_INTEGRATION":"#/components/schemas/VSphereIntegration"}}},"AzureIntegration":{"description":"The Azure integration stores the Azure credentials for programmatic access to the Azure cloud API.\n","required":["type","credential"],"type":"object","properties":{"type":{"type":"string","description":"The AZURE_INTEGRATION is an integration for connecting to Microsoft Azure.","enum":["AZURE_INTEGRATION"]},"credential":{"description":"Account credentials for Azure cloud API.\n","oneOf":[{"$ref":"#/components/schemas/AzureServicePrincipal"}],"discriminator":{"propertyName":"type","mapping":{"AZURE_SERVICE_PRINCIPAL":"#/components/schemas/AzureServicePrincipal"}}}}},"AWSIntegration":{"description":"The AWS integration stores the AWS access key for programmatic access to the AWS cloud API.\n","required":["type","credential"],"type":"object","properties":{"type":{"type":"string","description":"The AWS_INTEGRATION is an integration for connecting to Amazon Web Services (AWS).","enum":["AWS_INTEGRATION"]},"endpointUri":{"type":"string","description":"The URI of the AWS cloud service endpoint."},"credential":{"description":"Account credentials for AWS cloud API.\n","oneOf":[{"$ref":"#/components/schemas/AWSAccessKeyCredential"}],"discriminator":{"propertyName":"type","mapping":{"AWS_ACCESS_KEY":"#/components/schemas/AWSAccessKeyCredential"}}}}},"AWSAccessKeyCredential":{"required":["type","accessKeyID","secretAccessKey"],"type":"object","description":"AWS access key credentials: access key ID and secret access key.\n","properties":{"type":{"type":"string","description":"AWS_ACCESS_KEY credentials are used to access the AWS API programmatically.\n","enum":["AWS_ACCESS_KEY"]},"accessKeyID":{"type":"string","description":"The access key ID of the AWS access key credential."},"secretAccessKey":{"type":"string","description":"The secret access key of the AWS access key credential."}}},"AzureServicePrincipal":{"required":["type","clientID","clientSecret","tenantID"],"type":"object","properties":{"type":{"type":"string","description":"","enum":["AZURE_SERVICE_PRINCIPAL"]},"clientID":{"type":"string","description":"The Client ID of the service principal."},"clientSecret":{"type":"string","description":"The secret associated with the service principal."},"tenantID":{"type":"string","description":"The ID for the Active Directory tenant to which the service principal belongs."}}},"VSphereIntegration":{"type":"object","description":"The VSphere integration stores the credentials for programmatic access to the VSphere cloud API.\n","required":["type","hostname","credential"],"properties":{"type":{"type":"string","description":"The VSPHERE_INTEGRATION is an Integration for connecting to the VSphere cloud.\n","enum":["VSPHERE_INTEGRATION"]},"hostname":{"type":"string","description":"VSphere instance hostname ( FQDN or IP ), Connection to it from the controller is through https, the VSphere server certificate is not verified."},"rawCa":{"type":"string","description":"Raw CA Certificate used to verify the vSphere server certificate","example":"-----BEGIN CERTIFICATE-----\n MIIDMTCCasdfAwIBAgIUWw25xyNvQPxtjGUZopz0KeoaaQkwDQYJKoZIhvcNAQEL\n [SNIP]\n 2CPqdhpmQhAbzx9ElT8KyC7/08IdV0JK/kSWjfE4jOPOJyI2q0DWExKLuYe+rO+Q\n rg7hesA=\n -----END CERTIFICATE-----"},"credential":{"oneOf":[{"$ref":"#/components/schemas/UserPassCredential"}],"discriminator":{"propertyName":"type","mapping":{"USER_PASS":"#/components/schemas/UserPassCredential"}}}}},"GenericIntegration":{"required":["type","endpointUri","credential"],"type":"object","description":"A Generic integration resource stores the credentials and URI endpoint to connect to external services\nthat require a username and password or API token for authentication, or accept unauthenticated connection.\n","properties":{"type":{"type":"string","description":"The GENERIC_INTEGRATION is an Integration for connecting to external services that require a\nusername and password or an API key, or accept an unauthenticated connection.\n","enum":["GENERIC_INTEGRATION"]},"endpointUri":{"type":"string","description":"The URI of the service endpoint."},"credential":{"oneOf":[{"$ref":"#/components/schemas/UserPassCredential"},{"$ref":"#/components/schemas/ApiKeyCredential"},{"$ref":"#/components/schemas/Unauthenticated"}],"discriminator":{"propertyName":"type","mapping":{"USER_PASS":"#/components/schemas/UserPassCredential","API_KEY":"#/components/schemas/ApiKeyCredential","UNAUTHENTICATED":"#/components/schemas/Unauthenticated"}}}}},"UserPassCredential":{"description":"A credential consisting of a username and password. In the case of splunk HEC, username can be any string.","required":["type","password","username"],"type":"object","properties":{"type":{"type":"string","description":"USER_PASS credentials are used to connect to web services that accept a username and password for authentication.\n","enum":["USER_PASS"]},"username":{"type":"string"},"password":{"type":"string"}}},"ApiKeyCredential":{"description":"For API key based authentication.","required":["type","apiKey"],"type":"object","properties":{"type":{"type":"string","description":"API_KEY credentials are used to connect to web services that accept an API key for authentication.\n","enum":["API_KEY"]},"apiKey":{"type":"string"}}},"Unauthenticated":{"description":"For unauthenticated connections.","required":["type"],"type":"object","properties":{"type":{"type":"string","description":"Unauthenticated can be used for services that do not need authentication.\n","enum":["UNAUTHENTICATED"]}}},"SelfLinks":{"type":"object","description":"The SelfLinks object contains a link from the resource to itself.\nThis object is used only in responses.\n","properties":{"rel":{"type":"string","example":"/api/v1/services/environments/prod","description":"`rel` contains the complete path fragment of a URI and can be used\nto construct a query to the object.\n"}}},"ResourceMeta":{"type":"object","required":["name"],"properties":{"name":{"type":"string","pattern":"^[^A-Z\\s\\x00-\\x1f\\x60\\x7f\\;\\*\\\"\\[\\]\\{\\}\\\\\\/%\\?:=&\\~\\^|#<>]+$","not":{"type":"string","enum":[".",".."]},"minLength":1,"maxLength":1024,"example":"resource-name","description":"Resource name is a unique identifier for a resource within the context of a namespace.\nResource names must conform to [RFC 1738 Section 2.2](https://www.ietf.org/rfc/rfc1738.txt) and have a valid syntax for email addresses. The following rules are enforced:\n\n- do not utilize URL encoding;\n- do not include spaces;\n- do not use uppercase characters, for example, 'A-Z'; extended character sets are supported;\n- do not use the following characters: `\"`, `*`, `:`, `;`, `/`, `\\`, `%`, `?`, `hash`, `=`, `&`, `|`, `~`, `^`, `{`, `}`, `[`, `]`, `<`, `>`;\n- cannot start or end with an `@` sign;\n- cannot be only `.` or `..`\n\nFor example: For a collection resource located at\n\n`https://controller.example.com/api/v1/services/apps/shopping_@1`\n\nthe resource name is \"shopping_@1\".\n"},"displayName":{"type":"string","example":"My Display Name","description":"`displayName` is a user friendly resource name. It can be used to define \na longer, and less constrained, name for a resource.\n\nDisplay names:\n\n- are optional (defaults to an empty string if no value is provided),\n- do not have to be unique, \n- cannot be assigned by the server.\n"},"description":{"type":"string","example":"This is a sample description string. It provides information about the resource.","description":"`description` is a free-form text property. You can use it to provide information that helps \nto identify the resource.\n\nDescriptions:\n\n- are optional (defaults to an empty string if no value is provided),\n- do not have to be unique, \n- cannot be assigned by the server.\n"},"kind":{"type":"string","example":"<collection>-<object>","description":"Kind is a string representation of an API resource's data type.\nIt is assigned by the server and cannot be changed. \n\nWhen creating a `kind`, the server uses hyphens to connect word segments; \nsingleton and collection item resources are not pluralized.\n"},"uid":{"type":"string","format":"uuid","example":"d290f1ee-6c54-4b01-90e6-d701748f0851","description":"Unique Identifier (UID)\n\nUID is a unique identifier in time and space for a resource. \nWhen you create a resource, the server assigns a UID to the resource.\n\nRefer to [IETF RFC 4122](https://tools.ietf.org/html/rfc4122) for more information.\n"},"tags":{"type":"array","items":{"type":"string"},"example":["production_public","dev","new_app","us-west-1","emea"],"description":"You can assign `tags` to a resource as a way to help map, scope, \nand organize resources. \n\nThe system uses tag selectors to specify selection criteria that \nmatch resources that have particular tags.\n"},"ref":{"type":"string","example":"/services/environments/prod","description":"The `ref` field contains a reference to another NGINX Controller resource.\n"},"links":{"$ref":"#/components/schemas/SelfLinks"},"createTime":{"type":"string","format":"date-time","example":"2019-07-29T09:12:33.001Z","description":"A timestamp that represents the server time when the resource was created.\n\nCreate time is not guaranteed to be set in \"happens-before\" order\nacross separate operations.\n\nIn JSON format, `create_time` type is encoded as a string in the\n[RFC 3339](https://www.ietf.org/rfc/rfc3339.txt).\n\nFor example: 2018-04-01T01:30:15.01Z\n\nCreate Time is assigned by the server and cannot be changed.\n"},"updateTime":{"type":"string","format":"date-time","example":"2019-07-29T10:12:33.001Z","description":"A timestamp that represents the server time when the resource was last modified.\n\nResources that have never been updated do not have an `update_time` stamp.\n\nThe default value for resources that have never been updated is the local \nlanguage-specific equivalent of \"null\".\n\nIn JSON format, `update_time` type is encoded as a string as described in \n[RFC 3339](https://www.ietf.org/rfc/rfc3339.txt).\n"}}},"ErrorDetail":{"type":"object","required":["description"],"properties":{"description":{"type":"string","example":"Error doing <action>: <reason for error>. This can lead to <potential consequences>. Try <action> to resolve the issue.","description":"A detailed error message returned by the server. \n\nThese messages contain the following information, where applicable:\n\n- What happened.\n- Why it happened.\n- What the consequences are (if any).\n- Recommended action to take to resolve the issue.\n"}}},"ErrorModel":{"type":"object","required":["message","code"],"properties":{"message":{"type":"string","example":"Error doing <action>.","description":"A human-readable message, in English, that describes the error.\n"},"code":{"type":"integer","example":1234567,"description":"A numeric error code that can be used to identify errors for support purposes.\n"},"details":{"type":"array","items":{"$ref":"#/components/schemas/ErrorDetail"}}}}},"examples":{"AWSRequest":{"value":{"metadata":{"name":"my-aws-integration","description":"AWS integration for us-west-1","displayName":"UsWest1-Integration","tags":["us-west-1"]},"desiredState":{"type":"AWS_INTEGRATION","endpointUri":"https://ec2.us-west-1.amazonaws.com","credential":{"type":"AWS_ACCESS_KEY","accessKeyID":"AKIAJ3N2PZUMZE3Y67ZA","secretAccessKey":"wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY)"}}}},"AWSResponse":{"value":{"metadata":{"name":"my-aws-integration","description":"AWS integration for us-west-1","displayName":"UsWest1-Integration","tags":["us-west-1"],"uid":"619887de-a748-4931-853d-c6b706f95ddf","createTime":"2019-09-18T16:42:15.1183523Z","updateTime":"2019-09-18T16:42:15.1183523Z"},"desiredState":{"type":"AWS_INTEGRATION","endpointUri":"https://ec2.us-west-1.amazonaws.com","credential":{"type":"AWS_ACCESS_KEY","accessKeyID":"AKIAJ3N2PZUMZE3Y67ZA","secretAccessKey":"*********"}},"currentStatus":{"type":"AWS_INTEGRATION","endpointUri":"https://ec2.us-west-1.amazonaws.com","credential":{"type":"AWS_ACCESS_KEY","accessKeyID":"AKIAJ3N2PZUMZE3Y67ZA","secretAccessKey":"*********"}}}},"SplunkRequest":{"value":{"metadata":{"name":"my-splunk-integration","description":"Splunk integration","displayName":"splunk-Integration","tags":["dev"]},"desiredState":{"type":"GENERIC_INTEGRATION","endpointUri":"https://splunk.com:8080/services/collector","credential":{"type":"USER_PASS","user":"x","password":"CF179AE4-3C99-45F5-A7CC-3284AA91CF67"}}}},"SplunkResponse":{"value":{"metadata":{"name":"my-splunk-integration","description":"Splunk integration","displayName":"splunk-Integration","tags":["dev"],"uid":"619887de-a748-4931-853d-c6b706f95ddf","createTime":"2019-09-18T16:42:15.1183523Z","updateTime":"2019-09-18T16:42:15.1183523Z"},"desiredState":{"type":"GENERIC_INTEGRATION","endpointUri":"https://splunk.com:8080/services/collector","credential":{"type":"USER_PASS","user":"x","password":"*********"}},"currentStatus":{"type":"GENERIC_INTEGRATION","endpointUri":"https://splunk.com:8080/services/collector","credential":{"type":"USER_PASS","user":"x","password":"*********"}}}},"AWSRequestForPatch":{"value":{"metadata":{"name":"my-aws-integration","description":"AWS integration for us-west-1","displayName":"UsWest1-Integration","tags":["us-west-1"]},"desiredState":{"type":"AWS_INTEGRATION","credential":{"type":"AWS_ACCESS_KEY","accessKeyID":"AKIAJ3N2PZUMZE3Y67ZA","secretAccessKey":"*********"}}}},"AWSResponseForPatch":{"value":{"metadata":{"name":"my-aws-integration","description":"AWS integration for us-west-1","displayName":"UsWest1-Integration","tags":["us-west-1"],"uid":"619887de-a748-4931-853d-c6b706f95ddf","createTime":"2019-09-18T16:42:15.1183523Z","updateTime":"2019-09-18T16:42:15.1183523Z"},"desiredState":{"type":"AWS_INTEGRATION","endpointUri":"https://ec2.us-west-1.amazonaws.com","credential":{"type":"AWS_ACCESS_KEY","accessKeyID":"AKIAJ3N2PZUMZE3Y67ZA","secretAccessKey":"*********"}},"currentStatus":{"type":"AWS_INTEGRATION","endpointUri":"https://ec2.us-west-1.amazonaws.com","credential":{"type":"AWS_ACCESS_KEY","accessKeyID":"AKIAJ3N2PZUMZE3Y67ZA","secretAccessKey":"*********"}}}},"SplunkRequestForPatch":{"value":{"metadata":{"name":"my-splunk-integration","description":"Splunk integration","displayName":"splunk-Integration","tags":["dev"]},"desiredState":{"type":"GENERIC_INTEGRATION","credential":{"type":"USER_PASS","user":"x","password":"CF179AE4-3C99-45F5-A7CC-3284AA91CF67"}}}},"SplunkResponseForPatch":{"value":{"metadata":{"name":"my-splunk-integration","description":"Splunk integration","displayName":"splunk-Integration","tags":["dev"],"uid":"619887de-a748-4931-853d-c6b706f95ddf","createTime":"2019-09-18T16:42:15.1183523Z","updateTime":"2019-09-18T16:42:15.1183523Z"},"desiredState":{"type":"GENERIC_INTEGRATION","endpointUri":"https://splunk.com:8080/services/collector","credential":{"type":"USER_PASS","user":"x","password":"*********"}},"currentStatus":{"type":"GENERIC_INTEGRATION","endpointUri":"https://splunk.com:8080/services/collector","credential":{"type":"USER_PASS","user":"x","password":"*********"}}}},"ListIntegrationResponse":{"value":{"items":[{"metadata":{"name":"my-aws-integration","description":"AWS integration for us-west-1","displayName":"UsWest1-Integration","tags":["us-west-1"],"uid":"619887de-a748-4931-853d-c6b706f95ddf","createTime":"2019-09-18T16:42:15.1183523Z","updateTime":"2019-09-18T16:42:15.1183523Z"},"desiredState":{"type":"AWS_INTEGRATION","endpointUri":"https://ec2.us-west-1.amazonaws.com","credential":{"type":"AWS_ACCESS_KEY","accessKeyID":"AKIAJ3N2PZUMZE3Y67ZA","secretAccessKey":"*********"}},"currentStatus":{"type":"AWS_INTEGRATION","endpointUri":"https://ec2.us-west-1.amazonaws.com","credential":{"type":"AWS_ACCESS_KEY","accessKeyID":"AKIAJ3N2PZUMZE3Y67ZA","secretAccessKey":"*********"}}},{"metadata":{"name":"my-splunk-integration","description":"Splunk integration","displayName":"splunk-Integration","tags":["dev"],"uid":"619887de-a748-4931-853d-c6b706f95ddf","createTime":"2019-09-18T16:42:15.1183523Z","updateTime":"2019-09-18T16:42:15.1183523Z"},"desiredState":{"type":"GENERIC_INTEGRATION","endpointUri":"https://splunk.com:8080/services/collector","credential":{"type":"USER_PASS","user":"x","password":"*****"}},"currentStatus":{"type":"GENERIC_INTEGRATION","endpointUri":"https://splunk.com:8080/services/collector","credential":{"type":"USER_PASS","user":"x","password":"*****"}}}]}},"NotFoundError":{"value":{"code":120003,"message":"Error getting the Integration resource: the specified integration does not exist. Check the name of the Integration resource, then try again."}},"BadRequestError":{"value":{"code":120004,"message":"Error creating the Integration resource: could not parse the request payload. Check the format of the request, then try again."}},"AlreadyExistsError":{"value":{"code":120007,"message":"Error creating the Integration resource: the integration already exists. Use a unique name for the Integration resource, then try again."}}}}}
/ platform / integrations
/ platform / integrations / {integrationName}
Users API OpenAPI	{"openapi":"3.0.0","servers":[{"description":"NGINX Controller API","url":"https://{{CONTROLLER_FQDN}}/api/v1"}],"info":{"title":"Users API","description":"Use the Users API to manage NGINX Controller User accounts.","version":"v1"},"paths":{"/platform/users":{"get":{"tags":["Users"],"summary":"List all Users","operationId":"listUsers","description":"Returns an unfiltered list of all User resources.","responses":{"200":{"description":"Successfully retrieved a list of User resources.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserListResponse"},"example":{"items":[{"metadata":{"name":"john.doe@nginx.com","kind":"user","createTime":"2019-07-29T09:12:33.001Z","displayName":"John Doe","description":"NGINX controller user with prod env role"},"desiredState":{"firstName":"John","lastName":"Doe","email":"john.doe@nginx.com","password":"********","roles":[{"ref":"/platform/roles/prod"}]},"currentStatus":{"account":"1","id":123,"firstName":"John","lastName":"Doe","lastLogin":1570132969,"email":"john.doe@nginx.com","authn":"amplify","password":"********","roles":[{"ref":"/platform/roles/prod","links":{"rel":"/api/v1/platform/roles/prod","name":"prod"}}]}}]}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"500":{"$ref":"#/components/responses/InternalServerError"}}},"post":{"tags":["Users"],"summary":"Create a User","operationId":"addUser","description":"Creates a new User resource.","requestBody":{"description":"Defines the details to use for the new User resource.","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/User"},"example":{"metadata":{"name":"john.doe@nginx.com","displayName":"John Doe","description":"NGINX controller user with prod env role"},"desiredState":{"firstName":"John","lastName":"Doe","email":"john.doe@nginx.com","password":"passwd123","roles":[{"ref":"/platform/roles/prod"}],"groups":[{"ref":"/platform/groups/guest"}]}}}}},"responses":{"201":{"description":"Successfully created the requested User resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/User"},"example":{"metadata":{"name":"john.doe@nginx.com","kind":"user","createTime":"2019-07-29T09:12:33.001Z","displayName":"John Doe","description":"NGINX controller user with prod env role"},"desiredState":{"firstName":"John","lastName":"Doe","email":"john.doe@nginx.com","password":"********","roles":[{"ref":"/platform/roles/prod"}],"groups":[{"ref":"/platform/groups/guest"}]},"currentStatus":{"account":"1","id":123,"firstName":"John","lastName":"Doe","lastLogin":1570132969,"email":"john.doe@nginx.com","authn":"amplify","password":"********","roles":[{"ref":"/platform/roles/prod","links":{"rel":"/api/v1/platform/roles/prod","name":"prod"}}],"groups":[{"links":{"rel":"/api/v1/platform/auth/groups/guest","name":"guest"},"ref":"/platform/groups/guest"}]}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"409":{"$ref":"#/components/responses/Conflict"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/platform/users/{userName}":{"get":{"tags":["Users"],"summary":"Get a User","operationId":"getUser","description":"Gets information for an existing User resource.","parameters":[{"$ref":"#/components/parameters/userName"}],"responses":{"200":{"description":"Successfully retrieved the requested User resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/User"},"example":{"metadata":{"name":"john.doe@nginx.com","kind":"user","createTime":"2019-07-29T09:12:33.001Z","displayName":"John Doe","description":"NGINX controller user with prod env role"},"desiredState":{"firstName":"John","lastName":"Doe","email":"john.doe@nginx.com","password":"********","roles":[{"ref":"/platform/roles/prod"}]},"currentStatus":{"account":"1","id":123,"firstName":"John","lastName":"Doe","lastLogin":1570132969,"email":"john.doe@nginx.com","authn":"amplify","password":"********","roles":[{"ref":"/platform/roles/prod","links":{"rel":"/api/v1/platform/roles/prod","name":"prod"}}]}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}},"patch":{"tags":["Users"],"summary":"Update a User","operationId":"updateUser","description":"Updates an existing User resource.","parameters":[{"$ref":"#/components/parameters/userName"}],"requestBody":{"description":"Defines the updates to make to the specified User resource.","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateUser"},"example":{"metadata":{"name":"john.doe@nginx.com","displayName":"Jane Doe","description":"NGINX controller user with prod env role"},"desiredState":{"firstName":"Jane","lastName":"Doe","password":"NewPassWd1234","verifyPassword":"OldPassWd1234","roles":[{"ref":"/platform/roles/new"}]}}}}},"responses":{"200":{"description":"Successfully updated the specified User resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateUser"},"example":{"metadata":{"name":"john.doe@nginx.com","kind":"user","createTime":"2019-07-29T09:12:33.001Z","displayName":"Jane Doe","description":"NGINX controller user with prod env role"},"desiredState":{"firstName":"Jane","lastName":"Doe","password":"********","roles":[{"ref":"/platform/roles/new"}]},"currentStatus":{"account":"1","id":123,"firstName":"Jane","lastName":"Doe","lastLogin":1570132969,"email":"john.doe@nginx.com","authn":"amplify","password":"********","roles":[{"ref":"/platform/roles/new","links":{"rel":"/api/v1/platform/roles/new","name":"new"}}]}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"500":{"$ref":"#/components/responses/InternalServerError"}}},"delete":{"tags":["Users"],"summary":"Delete a User","operationId":"deleteUser","description":"Deletes a User resource.","parameters":[{"$ref":"#/components/parameters/userName"}],"responses":{"204":{"description":"Successfully deleted the user. No content was returned."},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}}},"components":{"securitySchemes":{"cookieAuth":{"type":"apiKey","in":"cookie","name":"session"}},"parameters":{"userName":{"in":"path","name":"userName","schema":{"type":"string","format":"email"},"required":true,"description":"The name for the User resource.\n"}},"responses":{"BadRequest":{"description":"Bad input parameter, or possibly a bad URI. Check the input for typos and try again.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"},"example":{"message":"Error parsing the user to create from the request payload.","code":3457}}}},"Unauthorized":{"description":"User authentication is invalid or missing.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"},"example":{"message":"No session cookie found in the request header.","code":3463}}}},"Forbidden":{"description":"The request failed due to insufficient privileges.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"},"example":{"message":"user is not authorized","code":1235}}}},"InternalServerError":{"description":"The request cannot be processed because of an internal server error.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"},"example":{"message":"Error getting users from the database.","code":3464}}}},"NotFound":{"description":"The specified User resource was not found.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"},"example":{"message":"Error getting user: user not found.","code":3472}}}},"Conflict":{"description":"The request failed due to a conflict with an existing User resource.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"},"example":{"message":"Error creating user: user already exists.","code":3469}}}}},"schemas":{"UpdateUser":{"type":"object","required":["metadata","desiredState"],"properties":{"metadata":{"$ref":"#/components/schemas/ResourceMeta"},"desiredState":{"$ref":"#/components/schemas/UpdateUserDef"},"currentStatus":{"$ref":"#/components/schemas/UserDef"}},"example":{"metadata":{"name":"john.doe@nginx.com","kind":"user","createTime":"2019-07-29T09:12:33.001Z","displayName":"Jane Doe","description":"NGINX Controller user with a production environment role."},"desiredState":{"firstName":"Jane","lastName":"Doe","password":"NewPassWd1234","verifyPassword":"OldPassWd1234","roles":[{"ref":"/platform/roles/new"}]},"currentStatus":{"account":"1","id":123,"firstName":"Jane","lastName":"Doe","lastLogin":1570132969,"email":"john.doe@nginx.com","authn":"amplify","password":"********","roles":[{"ref":"/platform/roles/prod","links":{"rel":"/api/v1/platform/roles/prod","name":"prod"}}]}}},"UpdateUserDef":{"type":"object","properties":{"firstName":{"type":"string","minLength":1,"maxLength":64,"example":"Jane","description":"Given name."},"lastName":{"type":"string","minLength":1,"maxLength":64,"example":"Doe","description":"Surname."},"password":{"type":"string","format":"password","minLength":8,"maxLength":64,"description":"The user's password must meet the following requirements:\n\n - Length must be between 8 and 64 characters\n - Must contain at least 1 letter\n - Must contain at least 1 number\n - Must be different from the old password\n - Dictionary words, mangled dictionary words, or systematic passwords like '1234567a' are not allowed\n \n"},"verifyPassword":{"type":"string","format":"password","description":"The user's current password. Users must verify their current password to make updates to their user profiles. The current password does not need to be verified when an admin user updates other users' profiles."},"roles":{"type":"array","items":{"$ref":"#/components/schemas/ResourceRef"}}},"example":{"firstName":"Jane","lastName":"Doe","password":"NewPassWd1234","verifyPassword":"OldPassWd1234","roles":[{"ref":"/platform/roles/new"}]}},"UserListResponse":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/User"},"description":"List of User resources."}},"example":{"items":[{"metadata":{"name":"john.doe@nginx.com","kind":"user","createTime":"2019-07-29T09:12:33.001Z","displayName":"John Doe","description":"NGINX Controller user with production environment role"},"desiredState":{"firstName":"John","lastName":"Doe","email":"john.doe@nginx.com","password":"********","roles":[{"ref":"/platform/roles/prod"}]},"currentStatus":{"account":"1","id":123,"firstName":"John","lastName":"Doe","lastLogin":1570132969,"email":"john.doe@nginx.com","authn":"amplify","password":"********","roles":[{"ref":"/platform/roles/prod","links":{"rel":"/api/v1/platform/roles/prod","name":"prod"}}]}}]}},"SelfLinks":{"type":"object","description":"The SelfLinks object contains a link from the resource to itself.\nThis object is used only in responses.\n","properties":{"rel":{"type":"string","example":"/api/v1/services/environments/prod","description":"`rel` contains the complete path fragment of a URI and can be used\nto construct a query to the object.\n"}}},"ResourceMeta":{"type":"object","required":["name"],"properties":{"name":{"type":"string","pattern":"^[^A-Z\\s\\x00-\\x1f\\x60\\x7f\\;\\*\\\"\\[\\]\\{\\}\\\\\\/%\\?:=&\\~\\^|#<>]+$","not":{"type":"string","enum":[".",".."]},"minLength":1,"maxLength":1024,"example":"resource-name","description":"Resource name is a unique identifier for a resource within the context of a namespace.\nResource names must conform to [RFC 1738 Section 2.2](https://www.ietf.org/rfc/rfc1738.txt) and have a valid syntax for email addresses. The following rules are enforced:\n\n- do not utilize URL encoding;\n- do not include spaces;\n- do not use uppercase characters, for example, 'A-Z'; extended character sets are supported;\n- do not use the following characters: `\"`, `*`, `:`, `;`, `/`, `\\`, `%`, `?`, `hash`, `=`, `&`, `|`, `~`, `^`, `{`, `}`, `[`, `]`, `<`, `>`;\n- cannot start or end with an `@` sign;\n- cannot be only `.` or `..`\n\nFor example: For a collection resource located at\n\n`https://controller.example.com/api/v1/services/apps/shopping_@1`\n\nthe resource name is \"shopping_@1\".\n"},"displayName":{"type":"string","example":"My Display Name","description":"`displayName` is a user friendly resource name. It can be used to define \na longer, and less constrained, name for a resource.\n\nDisplay names:\n\n- are optional (defaults to an empty string if no value is provided),\n- do not have to be unique, \n- cannot be assigned by the server.\n"},"description":{"type":"string","example":"This is a sample description string. It provides information about the resource.","description":"`description` is a free-form text property. You can use it to provide information that helps \nto identify the resource.\n\nDescriptions:\n\n- are optional (defaults to an empty string if no value is provided),\n- do not have to be unique, \n- cannot be assigned by the server.\n"},"kind":{"type":"string","example":"<collection>-<object>","description":"Kind is a string representation of an API resource's data type.\nIt is assigned by the server and cannot be changed. \n\nWhen creating a `kind`, the server uses hyphens to connect word segments; \nsingleton and collection item resources are not pluralized.\n"},"uid":{"type":"string","format":"uuid","example":"d290f1ee-6c54-4b01-90e6-d701748f0851","description":"Unique Identifier (UID)\n\nUID is a unique identifier in time and space for a resource. \nWhen you create a resource, the server assigns a UID to the resource.\n\nRefer to [IETF RFC 4122](https://tools.ietf.org/html/rfc4122) for more information.\n"},"tags":{"type":"array","items":{"type":"string"},"example":["production_public","dev","new_app","us-west-1","emea"],"description":"You can assign `tags` to a resource as a way to help map, scope, \nand organize resources. \n\nThe system uses tag selectors to specify selection criteria that \nmatch resources that have particular tags.\n"},"ref":{"type":"string","example":"/services/environments/prod","description":"The `ref` field contains a reference to another NGINX Controller resource.\n"},"links":{"$ref":"#/components/schemas/SelfLinks"},"createTime":{"type":"string","format":"date-time","example":"2019-07-29T09:12:33.001Z","description":"A timestamp that represents the server time when the resource was created.\n\nCreate time is not guaranteed to be set in \"happens-before\" order\nacross separate operations.\n\nIn JSON format, `create_time` type is encoded as a string in the\n[RFC 3339](https://www.ietf.org/rfc/rfc3339.txt).\n\nFor example: 2018-04-01T01:30:15.01Z\n\nCreate Time is assigned by the server and cannot be changed.\n"},"updateTime":{"type":"string","format":"date-time","example":"2019-07-29T10:12:33.001Z","description":"A timestamp that represents the server time when the resource was last modified.\n\nResources that have never been updated do not have an `update_time` stamp.\n\nThe default value for resources that have never been updated is the local \nlanguage-specific equivalent of \"null\".\n\nIn JSON format, `update_time` type is encoded as a string as described in \n[RFC 3339](https://www.ietf.org/rfc/rfc3339.txt).\n"}}},"NamedLinks":{"allOf":[{"$ref":"#/components/schemas/SelfLinks"},{"type":"object","description":"Contains information about the object being referred to.\n\nThese are generally details -- like the object name and display name --\nthat are useful to a consumer of the API that performs further\nprocessing. \n\nThis object is only present in responses.\n \n","properties":{"name":{"type":"string","example":"production","description":"The name of the linked resource.\n"},"displayName":{"type":"string","example":"Production Environment","description":"A user friendly resource name."}}}]},"ResourceRef":{"type":"object","required":["ref"],"properties":{"ref":{"type":"string","example":"/services/environments/prod","description":"A reference to another NGINX Controller resource.\n"},"links":{"$ref":"#/components/schemas/NamedLinks"}}},"UserDef":{"type":"object","required":["firstName","lastName","email","password"],"properties":{"account":{"type":"string","minLength":1,"maxLength":64,"example":1,"deprecated":true,"description":"The account number of the tentant."},"id":{"type":"integer","example":123,"description":"Account ID"},"firstName":{"type":"string","minLength":1,"maxLength":64,"example":"John","description":"Given name."},"lastName":{"type":"string","minLength":1,"maxLength":64,"example":"Doe","description":"Surname."},"lastLogin":{"type":"integer","example":1570132969,"description":"Unix time (seconds since Epoch) of last login."},"email":{"type":"string","example":"john.doe@nginx.com","description":"An email address that serves as the account's username. This must match the resource's metadata.name property.","format":"email"},"authn":{"type":"string","enum":["amplify"]},"password":{"type":"string","format":"password","minLength":8,"maxLength":64,"description":"Passwords must meet the following requirements:\n\n - length must be between 8 and 64 characters\n - must contain at least 1 letter\n - must contain at least 1 number\n - must be different from the old password\n\n Dictionary words, mangled dictionary words, or systematic passwords like '1234567a' are not allowed.\n"},"apiKey":{"type":"string","example":"761ab961448865d86ef71c67fd74432b","deprecated":true,"description":"User api key."},"isEnabled":{"type":"boolean","description":"Indicates if the account is enabled.","default":false},"roles":{"type":"array","items":{"$ref":"#/components/schemas/ResourceRef"}},"groups":{"type":"array","items":{"$ref":"#/components/schemas/ResourceRef"}}}},"User":{"type":"object","required":["metadata","desiredState"],"properties":{"metadata":{"$ref":"#/components/schemas/ResourceMeta"},"desiredState":{"$ref":"#/components/schemas/UserDef"},"currentStatus":{"$ref":"#/components/schemas/UserDef"}}},"ErrorDetail":{"type":"object","required":["description"],"properties":{"description":{"type":"string","example":"Error doing <action>: <reason for error>. This can lead to <potential consequences>. Try <action> to resolve the issue.","description":"A detailed error message returned by the server. \n\nThese messages contain the following information, where applicable:\n\n- What happened.\n- Why it happened.\n- What the consequences are (if any).\n- Recommended action to take to resolve the issue.\n"}}},"ErrorModel":{"type":"object","required":["message","code"],"properties":{"message":{"type":"string","example":"Error doing <action>.","description":"A human-readable message, in English, that describes the error.\n"},"code":{"type":"integer","example":1234567,"description":"A numeric error code that can be used to identify errors for support purposes.\n"},"details":{"type":"array","items":{"$ref":"#/components/schemas/ErrorDetail"}}}}}}}
/ platform / users
/ platform / users / {userName}
Global Settings API OpenAPI	{"openapi":"3.0.0","servers":[{"description":"NGINX Controller API","url":"https://{{CONTROLLER_FQDN}}/api/v1"}],"info":{"description":"Use the Global Settings API to manage the system-wide configurations for NGINX Controller and Controller Agent.","version":"v1","title":"Global Settings API"},"paths":{"/platform/global":{"get":{"tags":["Global Settings"],"summary":"Get the Global Settings","operationId":"getGlobalSettings","description":"Gets information about the global settings for NGINX Controller.","responses":{"200":{"description":"Successfully retrieved the global settings for NGINX Controller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GlobalSettings"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"500":{"$ref":"#/components/responses/Internal"}}},"put":{"tags":["Global Settings"],"operationId":"putGlobalSettings","description":"Updates the global settings used by NGINX Controller.","summary":"Update the Global Settings","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GlobalSettings"}}}},"responses":{"200":{"description":"Successfully updated the global settings for NGINX Controller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GlobalSettings"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"500":{"$ref":"#/components/responses/Internal"}}},"patch":{"tags":["Global Settings"],"operationId":"patchGlobalSettings","description":"Updates the global settings for NGINX Controller.","summary":"Update part of the Global Settings","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GlobalSettings"}}}},"responses":{"200":{"description":"Successfully updated the global settings for NGINX Controller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GlobalSettings"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"500":{"$ref":"#/components/responses/Internal"}}}}},"components":{"responses":{"Internal":{"description":"The request cannot be processed because of an internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"Unauthorized":{"description":"User authentication is invalid or missing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"Forbidden":{"description":"The request failed due to insufficient privileges.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"BadRequest":{"description":"Bad input parameter, or possibly a bad URI. Check the input for typos and try again.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}}},"schemas":{"GlobalSettings":{"type":"object","required":["metadata"],"properties":{"metadata":{"$ref":"#/components/schemas/ResourceMeta"},"desiredState":{"type":"object","properties":{"agentSettings":{"$ref":"#/components/schemas/AgentSettingsData"},"platformSettings":{"$ref":"#/components/schemas/PlatformSettingsData"}}},"currentStatus":{"type":"object","properties":{"state":{"$ref":"#/components/schemas/ConfigState"},"agentSettings":{"$ref":"#/components/schemas/AgentSettingsData"},"platformVersion":{"$ref":"#/components/schemas/PlatformVersionData"},"platformSettings":{"$ref":"#/components/schemas/PlatformSettingsData"}}}}},"AgentSettingsData":{"type":"object","description":"Sets the global settings for NGINX Controller Agent.","properties":{"enableNGINXConfigAnalyzer":{"type":"boolean","description":"Disable or enable NGINX configuration file analysis.","default":true},"enablePeriodicNGINX-T":{"type":"boolean","description":"Disable or enable periodic NGINX configuration syntax checking with \\\"nginx -t\\\".","default":false},"enableAnalyzeSSLCertificates":{"type":"boolean","description":"Disable or enable analyzing SSL certs.","default":true},"apiKey":{"type":"string","description":"Access token to retrieve Agent installer."}}},"PlatformVersionData":{"type":"object","description":"Returns the version information for NGINX Controller and its sub-components.","required":["version","buildNumber","components"],"properties":{"version":{"type":"string","description":"The version number."},"buildNumber":{"type":"string","description":"Build number of the artifact used for installation."},"components":{"type":"array","description":"The NGINX Controller sub-components.","items":{"$ref":"#/components/schemas/componentDef"}}},"example":{"version":"3.0.0","buildNumber":"2313201","components":[{"application":"secrets","version":"0.9.1"},{"application":"platform-mgr","version":"0.2.2"}]}},"componentDef":{"type":"object","required":["application","version"],"properties":{"application":{"type":"string"},"version":{"type":"string"}},"example":{"application":"secrets","version":"0.9.1"}},"PlatformSettingsData":{"type":"object","description":"Sets the platform settings for NGINX Controller.","properties":{"apigwCert":{"type":"string","description":"SSL/TLS certificate (PEM format) for API Gateway.\nBecause JSON does not support multi-line strings, you must replace binary line feeds with ASCII line feeds (`\\n`).\n","example":"-----BEGIN CERTIFICATE-----\\n MIICpzCCAhACCQDkjx7mP9cuRjANBgkqhkiG9w0BAQsFADCBlzELMAkGA1UEBhMC\\n <EXAMPLE_SNIPPED> MiJVGawyxDzBm2UhzNOE0ABHfjAgM6PAYmtMhhQawk6bmttXYhJeqhLSji4LEj5d\\n Z4FmXQ5rWM0RWBs=\\n -----END CERTIFICATE-----"},"apigwKey":{"type":"string","writeOnly":true,"description":"Private key (PEM format) for API Gateway. Key must match certificate.\nBecause JSON does not support multi-line strings, you must replace binary line feeds with ASCII line feeds (`\\n`).\n","example":"-----BEGIN PRIVATE KEY-----\\n MIICdwIBADANBgkqhkiG9w0BAQEFAASCAmEwggJdAgEAAoGBALSQBtRafNJtTqN0\\n <EXAMPLE_SNIPPED> nYiZq6TZUsHjfG2R9PlK6jsvno9O6amN96Al6ZSTTDjhr4VU7/RJ0p/cisiCboCX\\n 4cCq6lFKpIpeZJI=\\n -----END PRIVATE KEY-----"},"FQDN":{"type":"string","description":"Fully qualified domain name for the NGINX Controller server, which users and Controller Agents will use when connecting to NGINX Controller."},"smtpHost":{"type":"string","description":"SMTP host"},"smtpPort":{"type":"integer","description":"SMTP port","minimum":1,"maximum":65535},"smtpAuthentication":{"type":"boolean","description":"Specify if SMTP server requires username and password."},"smtpUseTLS":{"type":"boolean","description":"Specify if SMTP should use TLS."},"smtpFrom":{"type":"string","description":"Specify the email to show in the 'FROM' field."},"smtpUser":{"type":"string","description":"SMTP user (required when smtpAuthentication is enabled)."},"smtpPassword":{"type":"string","description":"SMTP password (required when smtpAuthentication is enabled)."},"dbType":{"type":"string","enum":["external","embedded"],"description":"Config database type - embedded or external. Read-only.","readOnly":true,"example":"embedded"},"dbHost":{"type":"string","description":"Config database host (read-only if using an embedded Config database)."},"dbPort":{"type":"integer","description":"Config database port (read-only if using internal Config database).","minimum":1,"maximum":65535},"dbUser":{"type":"string","description":"Config database username (read-only if using internal Config database)."},"dbPassword":{"type":"string","description":"Config database password (read-only if using internal Config database)."},"dbUseTLS":{"type":"boolean","description":"Specify wether the Config database connection uses TLS or not (read-only if using internal Config database)."},"dbCA":{"type":"string","description":"SSL/TLS Certificate Authority certificate (PEM format) for verifying Config database server certificate. Only required if server certificate is signed by a private CA.\nBecause JSON does not support multi-line strings, you must replace line feed and/or carriage return characters with their literal equivalents as two characters - `\\n`, a backslash and letter `n`.\nRead-only if using internal Config database.\n","example":"-----BEGIN CERTIFICATE-----\\nMIICpzCCAhACCQDkjx7mP9cuRjANBgkqhkiG9w0BAQsFADCBlzELMAkGA1UEBhMC\\n<EXAMPLE_SNIPPED>Z4FmXQ5rWM0RWBs=\\n-----END CERTIFICATE-----"},"dbClientCert":{"type":"string","description":"SSL/TLS client certificate (PEM format) for authenticating when connecting to the Config database.\nBecause JSON does not support multi-line strings, you must replace binary line feeds with ASCII line feeds (`\\n`).\nRead-only if using internal Config database.\n","example":"-----BEGIN CERTIFICATE-----\\nMIICpzCCAhACCQDkjx7mP9cuRjANBgkqhkiG9w0BAQsFADCBlzELMAkGA1UEBhMC\\n<EXAMPLE_SNIPPED>Z4FmXQ5rWM0RWBs=\\n-----END CERTIFICATE-----"},"dbClientKey":{"type":"string","description":"Private key (PEM format) for Config database connection. Key must match certificate.\nBecause JSON does not support multi-line strings, you must replace binary line feeds with ASCII line feeds (`\\n`).\nRead-only if using internal Config database.\n","example":"-----BEGIN PRIVATE KEY-----\\nMIICdwIBADANBgkqhkiG9w0BAQEFAASCAmEwggJdAgEAAoGBALSQBtRafNJtTqN0\\n<EXAMPLE_SNIPPED>nYiZq6TZUsHjfG2R9PlK6jsvno9O6amN96Al6ZSTTDjhr4VU7/RJ0p/cisiCboCX\\n4cCq6lFKpIpeZJI=\\n-----END PRIVATE KEY-----"},"tsdbVolumeType":{"type":"string","description":"Time Series database volume type.","enum":["local","nfs","aws"],"readOnly":true},"tsdbNFSHost":{"type":"string","description":"Time Series database NFS host.","readOnly":true},"tsdbNFSPath":{"type":"string","description":"Time Series database NFS path.","readOnly":true},"tsdbAWSVolumeID":{"type":"string","description":"Time Series database AWS Volume ID.","readOnly":true},"clusterFloatingIP":{"type":"string","pattern":"^(?:(?:25[0-5]|2[0-4]\\d|[01]?\\d\\d?)\\.){3}(?:25[0-5]|2[0-4]\\d|[01]?\\d\\d?)$|^$","description":"Floating IPv4 address used to communicate with Controller in multinode/cluster mode.\nThis setting is only valid for local (non-cloud) installations. Set empty value to disable floating IP.\n"},"clusterLoadBalancer":{"type":"string","description":"Hostname or IP of the external cluster load balancer. Read-only.","readOnly":true}}},"SelfLinks":{"type":"object","description":"The SelfLinks object contains a link from the resource to itself.\nThis object is used only in responses.\n","properties":{"rel":{"type":"string","example":"/api/v1/services/environments/prod","description":"`rel` contains the complete path fragment of a URI and can be used\nto construct a query to the object.\n"}}},"ResourceMeta":{"type":"object","required":["name"],"properties":{"name":{"type":"string","pattern":"^[^A-Z\\s\\x00-\\x1f\\x60\\x7f\\;\\*\\\"\\[\\]\\{\\}\\\\\\/%\\?:=&\\~\\^|#<>]+$","not":{"type":"string","enum":[".",".."]},"minLength":1,"maxLength":1024,"example":"resource-name","description":"Resource name is a unique identifier for a resource within the context of a namespace.\nResource names must conform to [RFC 1738 Section 2.2](https://www.ietf.org/rfc/rfc1738.txt) and have a valid syntax for email addresses. The following rules are enforced:\n\n- do not utilize URL encoding;\n- do not include spaces;\n- do not use uppercase characters, for example, 'A-Z'; extended character sets are supported;\n- do not use the following characters: `\"`, `*`, `:`, `;`, `/`, `\\`, `%`, `?`, `hash`, `=`, `&`, `|`, `~`, `^`, `{`, `}`, `[`, `]`, `<`, `>`;\n- cannot start or end with an `@` sign;\n- cannot be only `.` or `..`\n\nFor example: For a collection resource located at\n\n`https://controller.example.com/api/v1/services/apps/shopping_@1`\n\nthe resource name is \"shopping_@1\".\n"},"displayName":{"type":"string","example":"My Display Name","description":"`displayName` is a user friendly resource name. It can be used to define \na longer, and less constrained, name for a resource.\n\nDisplay names:\n\n- are optional (defaults to an empty string if no value is provided),\n- do not have to be unique, \n- cannot be assigned by the server.\n"},"description":{"type":"string","example":"This is a sample description string. It provides information about the resource.","description":"`description` is a free-form text property. You can use it to provide information that helps \nto identify the resource.\n\nDescriptions:\n\n- are optional (defaults to an empty string if no value is provided),\n- do not have to be unique, \n- cannot be assigned by the server.\n"},"kind":{"type":"string","example":"<collection>-<object>","description":"Kind is a string representation of an API resource's data type.\nIt is assigned by the server and cannot be changed. \n\nWhen creating a `kind`, the server uses hyphens to connect word segments; \nsingleton and collection item resources are not pluralized.\n"},"uid":{"type":"string","format":"uuid","example":"d290f1ee-6c54-4b01-90e6-d701748f0851","description":"Unique Identifier (UID)\n\nUID is a unique identifier in time and space for a resource. \nWhen you create a resource, the server assigns a UID to the resource.\n\nRefer to [IETF RFC 4122](https://tools.ietf.org/html/rfc4122) for more information.\n"},"tags":{"type":"array","items":{"type":"string"},"example":["production_public","dev","new_app","us-west-1","emea"],"description":"You can assign `tags` to a resource as a way to help map, scope, \nand organize resources. \n\nThe system uses tag selectors to specify selection criteria that \nmatch resources that have particular tags.\n"},"ref":{"type":"string","example":"/services/environments/prod","description":"The `ref` field contains a reference to another NGINX Controller resource.\n"},"links":{"$ref":"#/components/schemas/SelfLinks"},"createTime":{"type":"string","format":"date-time","example":"2019-07-29T09:12:33.001Z","description":"A timestamp that represents the server time when the resource was created.\n\nCreate time is not guaranteed to be set in \"happens-before\" order\nacross separate operations.\n\nIn JSON format, `create_time` type is encoded as a string in the\n[RFC 3339](https://www.ietf.org/rfc/rfc3339.txt).\n\nFor example: 2018-04-01T01:30:15.01Z\n\nCreate Time is assigned by the server and cannot be changed.\n"},"updateTime":{"type":"string","format":"date-time","example":"2019-07-29T10:12:33.001Z","description":"A timestamp that represents the server time when the resource was last modified.\n\nResources that have never been updated do not have an `update_time` stamp.\n\nThe default value for resources that have never been updated is the local \nlanguage-specific equivalent of \"null\".\n\nIn JSON format, `update_time` type is encoded as a string as described in \n[RFC 3339](https://www.ietf.org/rfc/rfc3339.txt).\n"}}},"ConfigStateTally":{"type":"object","properties":{"isConfigured":{"type":"boolean","description":"The configuration operation is complete."},"isConfiguring":{"type":"boolean","description":"The configuration of the resource, or of its child(ren), is in process."},"isError":{"type":"boolean","description":"An error occurred while configuring the resource or its child(ren)."},"isDeleting":{"type":"boolean","description":"A delete operation is in progress for the resource or its child(ren)."},"total":{"type":"integer","description":"The total number of resources to which the configuration operation applies."},"configured":{"type":"integer","description":"The number of resources that have a complete and valid configuration."},"configuring":{"type":"integer","description":"The number of resources that are in the process of being configured."},"error":{"type":"integer","description":"The number of resources that have encountered an error during the configuration process."},"deleting":{"type":"integer","description":"The number of resources that are in the process of being deleted."}}},"ConfigCondition":{"type":"object","properties":{"type":{"type":"string","description":"The condition type."},"message":{"type":"string","description":"A human-readable message that provides additional information about the configuration operation."}}},"ConfigState":{"type":"object","description":"A representation of the resource's current configuration state \nthat comprises the status of the resource itself (`selfConfigState`) and any child \nresources (`childrenConfigState`).\n\nThe conditions array provides additional information during configuration changes.\n","properties":{"selfConfigState":{"$ref":"#/components/schemas/ConfigStateTally"},"childrenConfigState":{"$ref":"#/components/schemas/ConfigStateTally"},"conditions":{"type":"array","items":{"$ref":"#/components/schemas/ConfigCondition"}}}},"ErrorDetail":{"type":"object","required":["description"],"properties":{"description":{"type":"string","example":"Error doing <action>: <reason for error>. This can lead to <potential consequences>. Try <action> to resolve the issue.","description":"A detailed error message returned by the server. \n\nThese messages contain the following information, where applicable:\n\n- What happened.\n- Why it happened.\n- What the consequences are (if any).\n- Recommended action to take to resolve the issue.\n"}}},"ErrorModel":{"type":"object","required":["message","code"],"properties":{"message":{"type":"string","example":"Error doing <action>.","description":"A human-readable message, in English, that describes the error.\n"},"code":{"type":"integer","example":1234567,"description":"A numeric error code that can be used to identify errors for support purposes.\n"},"details":{"type":"array","items":{"$ref":"#/components/schemas/ErrorDetail"}}}}}}}
/ platform / global
Instance Groups API OpenAPI	{"openapi":"3.0.0","servers":[{"description":"NGINX Controller API","url":"https://{{CONTROLLER_FQDN}}/api/v1"}],"info":{"title":"Instance Groups API","description":"Use the Instance Groups API to manage a set of instances that can be used for scaling and high availability.","version":"v1"},"paths":{"/infrastructure/instance-groups":{"get":{"tags":["Instance Groups"],"summary":"List Instance Groups","description":"Returns an unfiltered list of all Instance Group resources.","operationId":"listInstanceGroups","responses":{"200":{"description":"Successfully retieved a list of all the configured Instance Groups.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListInstanceGroupsResponse"},"example":{"value":{"items":[{"currentStatus":{"instanceRefs":[],"state":{"conditions":[],"selfConfigState":{"configured":1,"configuring":0,"deleting":0,"error":0,"isConfigured":true,"isConfiguring":false,"isDeleting":false,"isError":false,"total":1}}},"desiredState":{},"metadata":{"createTime":"2020-05-13T09:29:49.464273Z","description":"us-west-2 autoscale group","displayName":"aws-autoscale-group","kind":"instance-group","links":{"rel":"/api/v1/infrastructure/instance-groups/amz-us-west-2-as-group"},"name":"amz-us-west-2-as-group","uid":"802ef1f8-9105-474a-b9a7-599837efd6b4","updateTime":"2020-05-13T09:29:49.464273Z"}},{"currentStatus":{"instanceRefs":[{"ref":"/infrastructure/locations/eks-cluster/instances/30dc361a3729"},{"ref":"/infrastructure/locations/eks-cluster/instances/01a9eead50e5"}],"state":{"conditions":[],"selfConfigState":{"configured":1,"configuring":0,"deleting":0,"error":0,"isConfigured":true,"isConfiguring":false,"isDeleting":false,"isError":false,"total":1}}},"desiredState":{},"metadata":{"createTime":"2020-05-13T16:58:17.058124Z","description":"K8S NGINX+ deployment","displayName":"k8s-nginx-deploy","kind":"instance-group","links":{"rel":"/api/v1/infrastructure/instance-groups/k8s-nginx-deploy"},"name":"k8s-nginx-deploy","uid":"97d06b70-0d00-4863-b86d-40ab29efefdc","updateTime":"2020-05-13T16:58:17.058124Z"}}]}}}}},"401":{"$ref":"#/components/responses/Unauthorized"}}},"post":{"tags":["Instance Groups"],"summary":"Create an Instance Group","description":"Creates an new Instance Group resource.","operationId":"addInstanceGroup","requestBody":{"description":"Defines the Instance Group resource to be added.","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InstanceGroup"},"example":{"value":{"metadata":{"name":"k8s-nginx-deploy","displayName":"K8S NGINX+ deployment","description":"k8s-nginx-deploy"},"desiredState":{}}}}}},"responses":{"202":{"description":"The Instance Group resource has been accepted for creation. The Instance Group will be created after it is done configuring.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetInstanceGroupResponse"},"example":{"value":{"metadata":{"createTime":"2020-05-13T16:58:17.058124Z","description":"K8S NGINX+ deployment","displayName":"k8s-nginx-deploy","kind":"instance-group","links":{"rel":"/api/v1/infrastructure/instance-groups/k8s-nginx-deploy"},"name":"k8s-nginx-deploy","uid":"97d06b70-0d00-4863-b86d-40ab29efefdc","updateTime":"2020-05-13T16:58:17.058124Z"},"desiredState":{},"currentStatus":{"instanceRefs":[{"ref":"/infrastructure/locations/eks-cluster/instances/30dc361a3729"},{"ref":"/infrastructure/locations/eks-cluster/instances/01a9eead50e5"}],"state":{"conditions":[],"selfConfigState":{"configured":1,"configuring":0,"deleting":0,"error":0,"isConfigured":true,"isConfiguring":false,"isDeleting":false,"isError":false,"total":1}}}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"409":{"$ref":"#/components/responses/Conflict"}}}},"/infrastructure/instance-groups/{instanceGroupName}":{"get":{"tags":["Instance Groups"],"summary":"Get an Instance Group","description":"Returns information about a specified Instance Groupe resource.","operationId":"getInstanceGroup","parameters":[{"$ref":"#/components/parameters/InstanceGroupName"}],"responses":{"200":{"description":"Successfully retrieved the requested Instance Group resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetInstanceGroupResponse"},"example":{"value":{"metadata":{"createTime":"2020-05-13T16:58:17.058124Z","description":"K8S NGINX+ deployment","displayName":"k8s-nginx-deploy","kind":"instance-group","links":{"rel":"/api/v1/infrastructure/instance-groups/k8s-nginx-deploy"},"name":"k8s-nginx-deploy","uid":"97d06b70-0d00-4863-b86d-40ab29efefdc","updateTime":"2020-05-13T16:58:17.058124Z"},"desiredState":{},"currentStatus":{"instanceRefs":[{"ref":"/infrastructure/locations/eks-cluster/instances/30dc361a3729"},{"ref":"/infrastructure/locations/eks-cluster/instances/01a9eead50e5"}],"state":{"conditions":[],"selfConfigState":{"configured":1,"configuring":0,"deleting":0,"error":0,"isConfigured":true,"isConfiguring":false,"isDeleting":false,"isError":false,"total":1}}}}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"}}},"put":{"tags":["Instance Groups"],"summary":"Upsert an Instance Group","description":"Creates a new Instance Group resource or updates an existing Instance Group resource.","operationId":"upsertInstanceGroup","parameters":[{"$ref":"#/components/parameters/InstanceGroupName"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InstanceGroup"},"example":{"value":{"metadata":{"name":"k8s-nginx-deploy","displayName":"K8S NGINX+ deployment","description":"k8s-nginx-deploy"},"desiredState":{}}}}},"required":true},"responses":{"202":{"description":"The Instance Group resource has been accepted for creation or update.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetInstanceGroupResponse"},"example":{"value":{"metadata":{"createTime":"2020-05-13T16:58:17.058124Z","description":"K8S NGINX+ deployment","displayName":"k8s-nginx-deploy","kind":"instance-group","links":{"rel":"/api/v1/infrastructure/instance-groups/k8s-nginx-deploy"},"name":"k8s-nginx-deploy","uid":"97d06b70-0d00-4863-b86d-40ab29efefdc","updateTime":"2020-05-13T16:58:17.058124Z"},"desiredState":{},"currentStatus":{"instanceRefs":[{"ref":"/infrastructure/locations/eks-cluster/instances/30dc361a3729"},{"ref":"/infrastructure/locations/eks-cluster/instances/01a9eead50e5"}],"state":{"conditions":[],"selfConfigState":{"configured":1,"configuring":0,"deleting":0,"error":0,"isConfigured":true,"isConfiguring":false,"isDeleting":false,"isError":false,"total":1}}}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"}}},"delete":{"tags":["Instance Groups"],"summary":"Delete an Instance Group","description":"Deletes the specified Instance Group resource.","operationId":"deleteInstanceGroup","parameters":[{"$ref":"#/components/parameters/InstanceGroupName"}],"responses":{"204":{"description":"Successfully deleted the specified Instance Group resource."},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/Conflict"}}}}},"components":{"parameters":{"InstanceGroupName":{"name":"instanceGroupName","in":"path","description":"The name of the Instance Group.","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}},"schemas":{"ListInstanceGroupsResponse":{"x-f5-experimental":true,"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/InstanceGroup"}}}},"GetInstanceGroupResponse":{"x-f5-experimental":true,"allOf":[{"$ref":"#/components/schemas/InstanceGroup"}]},"InstanceGroup":{"x-f5-experimental":true,"type":"object","required":["metadata","desiredState"],"properties":{"metadata":{"$ref":"#/components/schemas/ResourceMeta"},"desiredState":{"$ref":"#/components/schemas/InstanceGroupState"},"currentStatus":{"$ref":"#/components/schemas/InstanceGroupStatus"}}},"InstanceGroupState":{"x-f5-experimental":true,"type":"object","properties":{"bigIpIntegration":{"$ref":"#/components/schemas/BigIpIntegration"}}},"InstanceGroupStatus":{"x-f5-experimental":true,"type":"object","required":["state"],"properties":{"instanceRefs":{"type":"array","items":{"$ref":"#/components/schemas/InstanceRef"}},"bigIpIntegration":{"$ref":"#/components/schemas/BigIpIntegration"},"state":{"$ref":"#/components/schemas/ConfigState"}}},"InstanceRef":{"x-f5-experimental":true,"type":"object","allOf":[{"$ref":"#/components/schemas/ResourceRef"}],"description":"Reference to a member Instance resource."},"BigIpIntegration":{"x-f5-experimental":true,"type":"object","properties":{"integrationRef":{"description":"Reference to a BIG-IP Integration object, indicating that the Instances will be members of a BIG-IP server pool.","$ref":"#/components/schemas/ResourceRef"},"serverPoolIp":{"description":"The Instance IP address or CIDR to use when the Instance is a member of a BIG-IP server pool.\nIf this is a CIDR, then the Instance IP address that matches the mask will be the member address in the BIG-IP server pool.\nOtherwise, if this is an absolute IP address, that will be used as the server-pool member address.\n","type":"string"}}},"SelfLinks":{"type":"object","description":"The SelfLinks object contains a link from the resource to itself.\nThis object is used only in responses.\n","properties":{"rel":{"type":"string","example":"/api/v1/services/environments/prod","description":"`rel` contains the complete path fragment of a URI and can be used\nto construct a query to the object.\n"}}},"ResourceMeta":{"type":"object","required":["name"],"properties":{"name":{"type":"string","pattern":"^[^A-Z\\s\\x00-\\x1f\\x60\\x7f\\;\\*\\\"\\[\\]\\{\\}\\\\\\/%\\?:=&\\~\\^|#<>]+$","minLength":1,"maxLength":1024,"example":"resource-name","description":"Resource name is a unique identifier for a resource within the context of a namespace.\nResource names must conform to [RFC 1738 Section 2.2](https://www.ietf.org/rfc/rfc1738.txt) and have a valid syntax for email addresses. The following rules are enforced:\n\n- do not utilize URL encoding;\n- do not include spaces;\n- do not use uppercase characters, for example, 'A-Z'; extended character sets are supported;\n- do not use the following characters: `\"`, `*`, `:`, `;`, `/`, `\\`, `%`, `?`, `hash`, `=`, `&`, `|`, `~`, `^`, `{`, `}`, `[`, `]`, `<`, `>`;\n- cannot start or end with an `@` sign;\n\nFor example: For a collection resource located at\n\n`https://controller.example.com/api/v1/services/apps/shopping_@1`\n\nthe resource name is \"shopping_@1\".\n"},"displayName":{"type":"string","example":"My Display Name","description":"`displayName` is a user friendly resource name. It can be used to define \na longer, and less constrained, name for a resource.\n\nDisplay names:\n\n- are optional (defaults to an empty string if no value is provided),\n- do not have to be unique, \n- cannot be assigned by the server.\n"},"description":{"type":"string","example":"This is a sample description string. It provides information about the resource.","description":"`description` is a free-form text property. You can use it to provide information that helps \nto identify the resource.\n\nDescriptions:\n\n- are optional (defaults to an empty string if no value is provided),\n- do not have to be unique, \n- cannot be assigned by the server.\n"},"kind":{"type":"string","example":"<collection>-<object>","description":"Kind is a string representation of an API resource's data type.\nIt is assigned by the server and cannot be changed. \n\nWhen creating a `kind`, the server uses hyphens to connect word segments; \nsingleton and collection item resources are not pluralized.\n"},"uid":{"type":"string","format":"uuid","example":"d290f1ee-6c54-4b01-90e6-d701748f0851","description":"Unique Identifier (UID)\n\nUID is a unique identifier in time and space for a resource. \nWhen you create a resource, the server assigns a UID to the resource.\n\nRefer to [IETF RFC 4122](https://tools.ietf.org/html/rfc4122) for more information.\n"},"tags":{"type":"array","items":{"type":"string"},"example":["production_public","dev","new_app","us-west-1","emea"],"description":"You can assign `tags` to a resource as a way to help map, scope, \nand organize resources. \n\nThe system uses tag selectors to specify selection criteria that \nmatch resources that have particular tags.\n"},"ref":{"type":"string","example":"/services/environments/prod","description":"The `ref` field contains a reference to another NGINX Controller resource.\n"},"links":{"$ref":"#/components/schemas/SelfLinks"},"createTime":{"type":"string","format":"date-time","example":"2019-07-29T09:12:33.001Z","description":"A timestamp that represents the server time when the resource was created.\n\nCreate time is not guaranteed to be set in \"happens-before\" order\nacross separate operations.\n\nIn JSON format, `create_time` type is encoded as a string in the\n[RFC 3339](https://www.ietf.org/rfc/rfc3339.txt).\n\nFor example: 2018-04-01T01:30:15.01Z\n\nCreate Time is assigned by the server and cannot be changed.\n"},"updateTime":{"type":"string","format":"date-time","example":"2019-07-29T10:12:33.001Z","description":"A timestamp that represents the server time when the resource was last modified.\n\nResources that have never been updated do not have an `update_time` stamp.\n\nThe default value for resources that have never been updated is the local \nlanguage-specific equivalent of \"null\".\n\nIn JSON format, `update_time` type is encoded as a string as described in \n[RFC 3339](https://www.ietf.org/rfc/rfc3339.txt).\n"}}},"NamedLinks":{"allOf":[{"$ref":"#/components/schemas/SelfLinks"},{"type":"object","description":"Contains information about the object being referred to.\n\nThese are generally details -- like the object name and display name --\nthat are useful to a consumer of the API that performs further\nprocessing. \n\nThis object is only present in responses.\n \n","properties":{"name":{"type":"string","example":"production","description":"The name of the linked resource.\n"},"displayName":{"type":"string","example":"Production Environment","description":"A user friendly resource name."}}}]},"ResourceRef":{"type":"object","required":["ref"],"properties":{"ref":{"type":"string","example":"/services/environments/prod","description":"A reference to another NGINX Controller resource.\n"},"links":{"$ref":"#/components/schemas/NamedLinks"}}},"ConfigStateTally":{"type":"object","properties":{"isConfigured":{"type":"boolean","description":"The configuration operation is complete."},"isConfiguring":{"type":"boolean","description":"The configuration of the resource, or of its child(ren), is in process."},"isError":{"type":"boolean","description":"An error occurred while configuring the resource or its child(ren)."},"isDeleting":{"type":"boolean","description":"A delete operation is in progress for the resource or its child(ren)."},"total":{"type":"integer","description":"The total number of resources to which the configuration operation applies."},"configured":{"type":"integer","description":"The number of resources that have a complete and valid configuration."},"configuring":{"type":"integer","description":"The number of resources that are in the process of being configured."},"error":{"type":"integer","description":"The number of resources that have encountered an error during the configuration process."},"deleting":{"type":"integer","description":"The number of resources that are in the process of being deleted."}}},"ConfigCondition":{"type":"object","properties":{"type":{"type":"string","description":"The condition type."},"message":{"type":"string","description":"A human-readable message that provides additional information about the configuration operation."}}},"ConfigState":{"type":"object","description":"A representation of the resource's current configuration state \nthat comprises the status of the resource itself (`selfConfigState`) and any child \nresources (`childrenConfigState`).\n\nThe conditions array provides additional information during configuration changes.\n","properties":{"selfConfigState":{"$ref":"#/components/schemas/ConfigStateTally"},"childrenConfigState":{"$ref":"#/components/schemas/ConfigStateTally"},"conditions":{"type":"array","items":{"$ref":"#/components/schemas/ConfigCondition"}}}},"ErrorDetail":{"type":"object","required":["description"],"properties":{"description":{"type":"string","example":"Error doing <action>: <reason for error>. This can lead to <potential consequences>. Try <action> to resolve the issue.","description":"A detailed error message returned by the server. \n\nThese messages contain the following information, where applicable:\n\n- What happened.\n- Why it happened.\n- What the consequences are (if any).\n- Recommended action to take to resolve the issue.\n"}}},"ErrorModel":{"type":"object","required":["message","code"],"properties":{"message":{"type":"string","example":"Error doing <action>.","description":"A human-readable message, in English, that describes the error.\n"},"code":{"type":"integer","example":1234567,"description":"A numeric error code that can be used to identify errors for support purposes.\n"},"details":{"type":"array","items":{"$ref":"#/components/schemas/ErrorDetail"}}}}},"responses":{"BadRequest":{"description":"Bad input parameter, or possibly a bad URI. Check the input for typos and try again.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"Unauthorized":{"description":"User authentication is invalid or missing.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"NotFound":{"description":"The specified instance group resource was not found.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"Conflict":{"description":"The request failed due to a conflict with an existing instance group resource.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}}},"examples":{"InstanceGroupRequest":{"value":{"metadata":{"name":"k8s-nginx-deploy","displayName":"K8S NGINX+ deployment","description":"k8s-nginx-deploy"},"desiredState":{}}},"GetInstanceGroupResponse":{"value":{"metadata":{"createTime":"2020-05-13T16:58:17.058124Z","description":"K8S NGINX+ deployment","displayName":"k8s-nginx-deploy","kind":"instance-group","links":{"rel":"/api/v1/infrastructure/instance-groups/k8s-nginx-deploy"},"name":"k8s-nginx-deploy","uid":"97d06b70-0d00-4863-b86d-40ab29efefdc","updateTime":"2020-05-13T16:58:17.058124Z"},"desiredState":{},"currentStatus":{"instanceRefs":[{"ref":"/infrastructure/locations/eks-cluster/instances/30dc361a3729"},{"ref":"/infrastructure/locations/eks-cluster/instances/01a9eead50e5"}],"state":{"conditions":[],"selfConfigState":{"configured":1,"configuring":0,"deleting":0,"error":0,"isConfigured":true,"isConfiguring":false,"isDeleting":false,"isError":false,"total":1}}}}},"ListInstanceGroupsResponse":{"value":{"items":[{"currentStatus":{"instanceRefs":[],"state":{"conditions":[],"selfConfigState":{"configured":1,"configuring":0,"deleting":0,"error":0,"isConfigured":true,"isConfiguring":false,"isDeleting":false,"isError":false,"total":1}}},"desiredState":{},"metadata":{"createTime":"2020-05-13T09:29:49.464273Z","description":"us-west-2 autoscale group","displayName":"aws-autoscale-group","kind":"instance-group","links":{"rel":"/api/v1/infrastructure/instance-groups/amz-us-west-2-as-group"},"name":"amz-us-west-2-as-group","uid":"802ef1f8-9105-474a-b9a7-599837efd6b4","updateTime":"2020-05-13T09:29:49.464273Z"}},{"currentStatus":{"instanceRefs":[{"ref":"/infrastructure/locations/eks-cluster/instances/30dc361a3729"},{"ref":"/infrastructure/locations/eks-cluster/instances/01a9eead50e5"}],"state":{"conditions":[],"selfConfigState":{"configured":1,"configuring":0,"deleting":0,"error":0,"isConfigured":true,"isConfiguring":false,"isDeleting":false,"isError":false,"total":1}}},"desiredState":{},"metadata":{"createTime":"2020-05-13T16:58:17.058124Z","description":"K8S NGINX+ deployment","displayName":"k8s-nginx-deploy","kind":"instance-group","links":{"rel":"/api/v1/infrastructure/instance-groups/k8s-nginx-deploy"},"name":"k8s-nginx-deploy","uid":"97d06b70-0d00-4863-b86d-40ab29efefdc","updateTime":"2020-05-13T16:58:17.058124Z"}}]}}}}}
/ infrastructure / instance-groups
/ infrastructure / instance-groups / {instanceGroupName}
Authentication Provider API OpenAPI	{"openapi":"3.0.0","info":{"version":"v1","title":"Authentication Provider API","description":"Use the Authentication Provider API to create, update, or remove authentication providers."},"servers":[{"description":"NGINX Controller API","url":"https://{{CONTROLLER_FQDN}}/api/v1"}],"paths":{"/platform/auth/providers":{"post":{"tags":["Authentication Providers"],"summary":"Create an Authentication Provider","description":"Creates a new authentication provider.\n","operationId":"configureAuthProvider","requestBody":{"description":"Contains the configuration for a supported authentication provider.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthProvider"},"example":{"desiredState":{"provider":{"type":"ACTIVE_DIRECTORY","domain":"DC=mydomain,DC=example,DC=com","defaultLoginDomain":"mydomain","connection":[{"uri":"ldaps://dc1.mydomain.com","sslMode":"VERIFY_CA","rawCa":"-----BEGIN CERTIFICATE-----\n MIIDMTCCasdfAwIBAgIUWw25xyNvQPxtjGUZopz0KeoaaQkwDQYJKoZIhvcNAQEL\n [SNIP]\n 2CPqdhpmQhAbzx9ElT8KyC7/08IdV0JK/kSWjfE4jOPOJyI2q0DWExKLuYe+rO+Q\n rg7hesA=\n -----END CERTIFICATE-----"}],"groupSearchFilter":"(objectClass=group)","groupMemberAttribute":"memberof","userFormat":"UPN","bindUser":{"type":"PASSWORD","username":"user@mydomain","password":"passwd1234"},"pollIntervalSec":3600,"groupCacheTimeSec":7200,"honorStaleGroups":false,"groupMappings":[{"external":"Engineering-US-West","caseSensitive":true,"internal":{"ref":"/platform/auth/groups/eng-west"}},{"external":"Engineering-US-East","caseSensitive":true,"internal":{"ref":"/platform/auth/groups/eng-east"}}]}},"metadata":{"kind":"auth-provider","name":"ad-dc-1","tags":["dev","us-1"]}}}}},"responses":{"201":{"description":"Successfully created the authentication provider.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthProvider"},"example":{"currentStatus":{"provider":{"type":"ACTIVE_DIRECTORY","status":"CONNECTED_BOUND","domain":"DC=mydomain,DC=example,DC=com","defaultLoginDomain":"mydomain","connection":[{"uri":"ldap://dc1.mydomain.com","sslMode":"REQUIRE","rawCa":"-----BEGIN CERTIFICATE-----\n MIIDMTCCasdfAwIBAgIUWw25xyNvQPxtjGUZopz0KeoaaQkwDQYJKoZIhvcNAQEL\n [SNIP]\n 2CPqdhpmQhAbzx9ElT8KyC7/08IdV0JK/kSWjfE4jOPOJyI2q0DWExKLuYe+rO+Q\n rg7hesA=\n -----END CERTIFICATE-----"}],"groupSearchFilter":"(objectClass=group)","groupMemberAttribute":"memberof","userFormat":"UPN","bindUser":{"type":"PASSWORD","username":"user@mydomain","password":"********"},"pollIntervalSec":3600,"groupCacheTimeSec":7200,"honorStaleGroups":false,"groupMappings":[{"external":"Engineering-US-West","caseSensitive":true,"internal":{"ref":"/platform/auth/groups/eng-west","links":{"rel":"/api/v1/platform/auth/groups/eng-west","name":"eng-west","displayName":"West engineering"}}},{"external":"Engineering-US-East","caseSensitive":true,"internal":{"ref":"/platform/auth/groups/eng-east","links":{"rel":"/api/v1/platform/auth/groups/eng-east","name":"eng-east","displayName":"East engineering"}}}]}},"desiredState":{"provider":{"type":"ACTIVE_DIRECTORY","domain":"DC=mydomain,DC=example,DC=com","defaultLoginDomain":"mydomain","connection":[{"uri":"ldap://dc1.mydomain.com","sslMode":"REQUIRE","rawCa":"-----BEGIN CERTIFICATE-----\n MIIDMTCCasdfAwIBAgIUWw25xyNvQPxtjGUZopz0KeoaaQkwDQYJKoZIhvcNAQEL\n [SNIP]\n 2CPqdhpmQhAbzx9ElT8KyC7/08IdV0JK/kSWjfE4jOPOJyI2q0DWExKLuYe+rO+Q\n rg7hesA=\n -----END CERTIFICATE-----"}],"groupSearchFilter":"(objectClass=group)","groupMemberAttribute":"memberof","userFormat":"UPN","bindUser":{"type":"PASSWORD","username":"user@mydomain","password":"********"},"pollIntervalSec":3600,"groupCacheTimeSec":7200,"honorStaleGroups":false,"groupMappings":[{"external":"Engineering-US-West","caseSensitive":true,"internal":{"ref":"/platform/auth/groups/eng-west"}},{"external":"Engineering-US-East","caseSensitive":true,"internal":{"ref":"/platform/auth/groups/eng-east"}}]}},"metadata":{"createTime":"2020-02-24T22:55:51.729272Z","kind":"auth-provider","name":"ad-dc-1","tags":["dev","us-1"]}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"409":{"$ref":"#/components/responses/Conflict"},"500":{"$ref":"#/components/responses/Internal"}}},"get":{"tags":["Authentication Providers"],"summary":"List all Authentication Providers","description":"Returns a list of all authentication providers.\n","operationId":"listAuthProviders","responses":{"200":{"description":"Successfully returned a list of authentication providers.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListAuthProviders"},"example":{"items":[{"currentStatus":{"provider":{"type":"ACTIVE_DIRECTORY","status":"CONNECTED_BOUND","domain":"DC=mydomain,DC=example,DC=com","defaultLoginDomain":"mydomain","connection":[{"uri":"ldap://dc1.mydomain.com","sslMode":"REQUIRE","rawCa":"-----BEGIN CERTIFICATE-----\n MIIDMTCCasdfAwIBAgIUWw25xyNvQPxtjGUZopz0KeoaaQkwDQYJKoZIhvcNAQEL\n [SNIP]\n 2CPqdhpmQhAbzx9ElT8KyC7/08IdV0JK/kSWjfE4jOPOJyI2q0DWExKLuYe+rO+Q\n rg7hesA=\n -----END CERTIFICATE-----"}],"groupSearchFilter":"(objectClass=group)","groupMemberAttribute":"memberof","userFormat":"UPN","bindUser":{"type":"PASSWORD","username":"user@mydomain","password":"********"},"filteredGroups":["CN=Office_Admins_SF,OU=San Francisco,OU=North America,OU=Acme Financial","CN=RM_SF,OU=San Francisco,OU=North America,OU=Acme Financial","CN=Sales_Warsaw,OU=Warsaw,OU=Europe,OU=Acme Financial","CN=ACC_EU,OU=Europe,OU=Acme Financial"],"pollIntervalSec":3600,"groupCacheTimeSec":7200,"honorStaleGroups":false,"groupMappings":[{"external":"Engineering-US-West","caseSensitive":true,"internal":{"ref":"/platform/auth/groups/eng-west","links":{"rel":"/api/v1/platform/auth/groups/eng-west","name":"eng-west","displayName":"West engineering"}}},{"external":"Engineering-US-East","caseSensitive":true,"internal":{"ref":"/platform/auth/groups/eng-east","links":{"rel":"/api/v1/platform/auth/groups/eng-east","name":"eng-east","displayName":"East engineering"}}}]}},"desiredState":{"provider":{"type":"ACTIVE_DIRECTORY","domain":"DC=mydomain,DC=example,DC=com","defaultLoginDomain":"mydomain","connection":[{"uri":"ldap://dc1.mydomain.com","sslMode":"REQUIRE","rawCa":"-----BEGIN CERTIFICATE-----\n MIIDMTCCasdfAwIBAgIUWw25xyNvQPxtjGUZopz0KeoaaQkwDQYJKoZIhvcNAQEL\n [SNIP]\n 2CPqdhpmQhAbzx9ElT8KyC7/08IdV0JK/kSWjfE4jOPOJyI2q0DWExKLuYe+rO+Q\n rg7hesA=\n -----END CERTIFICATE-----"}],"groupSearchFilter":"(objectClass=group)","groupMemberAttribute":"memberof","userFormat":"UPN","bindUser":{"type":"PASSWORD","username":"user@mydomain","password":"********"},"filteredGroups":["CN=Office_Admins_SF,OU=San Francisco,OU=North America,OU=Acme Financial","CN=RM_SF,OU=San Francisco,OU=North America,OU=Acme Financial","CN=Sales_Warsaw,OU=Warsaw,OU=Europe,OU=Acme Financial","CN=ACC_EU,OU=Europe,OU=Acme Financial"],"pollIntervalSec":3600,"groupCacheTimeSec":7200,"honorStaleGroups":false,"groupMappings":[{"external":"Engineering-US-West","caseSensitive":true,"internal":{"ref":"/platform/auth/groups/eng-west"}},{"external":"Engineering-US-East","caseSensitive":true,"internal":{"ref":"/platform/auth/groups/eng-east"}}]}},"metadata":{"createTime":"2020-02-24T22:55:51.729272Z","kind":"auth-provider","name":"ad-dc-1","tags":["dev","us-1"]}}]}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"500":{"$ref":"#/components/responses/Internal"}}}},"/platform/auth/providers/{providerName}":{"get":{"tags":["Authentication Providers"],"summary":"Get an Authentication Provider","description":"Returns information about the specified authentication provider.","parameters":[{"name":"providerName","in":"path","description":"The name of the authentication provider.","required":true,"schema":{"type":"string"}}],"operationId":"getProvider","responses":{"200":{"description":"Successfully returned the requested authentication provider.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthProvider"},"example":{"currentStatus":{"provider":{"type":"ACTIVE_DIRECTORY","status":"CONNECTED_BOUND","domain":"DC=mydomain,DC=example,DC=com","defaultLoginDomain":"mydomain","connection":[{"uri":"ldap://dc1.mydomain.com","sslMode":"REQUIRE","rawCa":"-----BEGIN CERTIFICATE-----\n MIIDMTCCasdfAwIBAgIUWw25xyNvQPxtjGUZopz0KeoaaQkwDQYJKoZIhvcNAQEL\n [SNIP]\n 2CPqdhpmQhAbzx9ElT8KyC7/08IdV0JK/kSWjfE4jOPOJyI2q0DWExKLuYe+rO+Q\n rg7hesA=\n -----END CERTIFICATE-----"}],"groupSearchFilter":"(objectClass=group)","groupMemberAttribute":"memberof","userFormat":"UPN","bindUser":{"type":"PASSWORD","username":"user@mydomain","password":"********"},"pollIntervalSec":3600,"groupCacheTimeSec":7200,"honorStaleGroups":false,"filteredGroups":["CN=Office_Admins_SF,OU=San Francisco,OU=North America,OU=Acme Financial","CN=RM_SF,OU=San Francisco,OU=North America,OU=Acme Financial","CN=Sales_Warsaw,OU=Warsaw,OU=Europe,OU=Acme Financial","CN=ACC_EU,OU=Europe,OU=Acme Financial"],"groupMappings":[{"external":"Engineering-US-West","caseSensitive":true,"internal":{"ref":"/platform/auth/groups/eng-west","links":{"rel":"/api/v1/platform/auth/groups/eng-west","name":"eng-west","displayName":"West engineering"}}},{"external":"Engineering-US-East","caseSensitive":true,"internal":{"ref":"/platform/auth/groups/eng-east","links":{"rel":"/api/v1/platform/auth/groups/eng-east","name":"eng-east","displayName":"East engineering"}}}]}},"desiredState":{"provider":{"type":"ACTIVE_DIRECTORY","domain":"DC=mydomain,DC=example,DC=com","defaultLoginDomain":"mydomain","connection":[{"uri":"ldap://dc1.mydomain.com","sslMode":"REQUIRE","rawCa":"-----BEGIN CERTIFICATE-----\n MIIDMTCCasdfAwIBAgIUWw25xyNvQPxtjGUZopz0KeoaaQkwDQYJKoZIhvcNAQEL\n [SNIP]\n 2CPqdhpmQhAbzx9ElT8KyC7/08IdV0JK/kSWjfE4jOPOJyI2q0DWExKLuYe+rO+Q\n rg7hesA=\n -----END CERTIFICATE-----"}],"groupSearchFilter":"(objectClass=group)","groupMemberAttribute":"memberof","userFormat":"UPN","bindUser":{"type":"PASSWORD","username":"user@mydomain","password":"********"},"pollIntervalSec":3600,"groupCacheTimeSec":7200,"honorStaleGroups":false,"filteredGroups":["CN=Office_Admins_SF,OU=San Francisco,OU=North America,OU=Acme Financial","CN=RM_SF,OU=San Francisco,OU=North America,OU=Acme Financial","CN=Sales_Warsaw,OU=Warsaw,OU=Europe,OU=Acme Financial","CN=ACC_EU,OU=Europe,OU=Acme Financial"],"groupMappings":[{"external":"Engineering-US-West","caseSensitive":true,"internal":{"ref":"/platform/auth/groups/eng-west"}},{"external":"Engineering-US-East","caseSensitive":true,"internal":{"ref":"/platform/auth/groups/eng-east"}}]}},"metadata":{"createTime":"2020-02-24T22:55:51.729272Z","kind":"auth-provider","name":"ad-dc-1","tags":["dev","us-1"]}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/Internal"}}},"patch":{"tags":["Authentication Providers"],"summary":"Update an Authentication Provider","description":"Updates the configuration for an existing authentication provider.\n\n> **Note:** You can use PATCH to update one or more specific configurations. Any settings not specified in the request will not be changed.\n","parameters":[{"name":"providerName","in":"path","description":"The name of the authentication provider.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Contains the desired configuration changes for an authentication provider.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthProvider"},"example":{"desiredState":{"provider":{"type":"ACTIVE_DIRECTORY","domain":"DC=mydomain,DC=example,DC=com","defaultLoginDomain":"mydomain","connection":[{"uri":"ldap://dc1.mydomain.com","sslMode":"REQUIRE","rawCa":"-----BEGIN CERTIFICATE-----\n MIIDMTCCasdfAwIBAgIUWw25xyNvQPxtjGUZopz0KeoaaQkwDQYJKoZIhvcNAQEL\n [SNIP]\n 2CPqdhpmQhAbzx9ElT8KyC7/08IdV0JK/kSWjfE4jOPOJyI2q0DWExKLuYe+rO+Q\n rg7hesA=\n -----END CERTIFICATE-----"}],"groupSearchFilter":"(objectClass=group)","groupMemberAttribute":"memberof","userFormat":"UPN","bindUser":{"type":"PASSWORD","username":"user@mydomain","password":"passwd1234"},"pollIntervalSec":3600,"groupCacheTimeSec":7200,"honorStaleGroups":false,"groupMappings":[{"external":"Engineering-US-West","caseSensitive":true,"internal":{"ref":"/platform/auth/groups/eng-west"}},{"external":"Engineering-US-East","caseSensitive":true,"internal":{"ref":"/platform/auth/groups/eng-east"}}]}},"metadata":{"kind":"auth-provider","name":"ad-dc-1","tags":["dev","us-1"]}}}}},"operationId":"partialUpdateProvider","responses":{"200":{"description":"Successfully updated the configuration for the authentication provider.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthProvider"},"example":{"currentStatus":{"provider":{"type":"ACTIVE_DIRECTORY","status":"CONNECTED_BOUND","domain":"DC=mydomain,DC=example,DC=com","defaultLoginDomain":"mydomain","connection":[{"uri":"ldap://dc1.mydomain.com","sslMode":"REQUIRE","rawCa":"-----BEGIN CERTIFICATE-----\n MIIDMTCCasdfAwIBAgIUWw25xyNvQPxtjGUZopz0KeoaaQkwDQYJKoZIhvcNAQEL\n [SNIP]\n 2CPqdhpmQhAbzx9ElT8KyC7/08IdV0JK/kSWjfE4jOPOJyI2q0DWExKLuYe+rO+Q\n rg7hesA=\n -----END CERTIFICATE-----"}],"groupSearchFilter":"(objectClass=group)","groupMemberAttribute":"memberof","userFormat":"UPN","bindUser":{"type":"PASSWORD","username":"user@mydomain","password":"********"},"pollIntervalSec":3600,"groupCacheTimeSec":7200,"honorStaleGroups":false,"groupMappings":[{"external":"Engineering-US-West","caseSensitive":true,"internal":{"ref":"/platform/auth/groups/eng-west","links":{"rel":"/api/v1/platform/auth/groups/eng-west","name":"eng-west","displayName":"West engineering"}}},{"external":"Engineering-US-East","caseSensitive":true,"internal":{"ref":"/platform/auth/groups/eng-east","links":{"rel":"/api/v1/platform/auth/groups/eng-east","name":"eng-east","displayName":"East engineering"}}}]}},"desiredState":{"provider":{"type":"ACTIVE_DIRECTORY","domain":"DC=mydomain,DC=example,DC=com","defaultLoginDomain":"mydomain","connection":[{"uri":"ldap://dc1.mydomain.com","sslMode":"REQUIRE","rawCa":"-----BEGIN CERTIFICATE-----\n MIIDMTCCasdfAwIBAgIUWw25xyNvQPxtjGUZopz0KeoaaQkwDQYJKoZIhvcNAQEL\n [SNIP]\n 2CPqdhpmQhAbzx9ElT8KyC7/08IdV0JK/kSWjfE4jOPOJyI2q0DWExKLuYe+rO+Q\n rg7hesA=\n -----END CERTIFICATE-----"}],"groupSearchFilter":"(objectClass=group)","groupMemberAttribute":"memberof","userFormat":"UPN","bindUser":{"type":"PASSWORD","username":"user@mydomain","password":"********"},"pollIntervalSec":3600,"groupCacheTimeSec":7200,"honorStaleGroups":false,"groupMappings":[{"external":"Engineering-US-West","caseSensitive":true,"internal":{"ref":"/platform/auth/groups/eng-west"}},{"external":"Engineering-US-East","caseSensitive":true,"internal":{"ref":"/platform/auth/groups/eng-east"}}]}},"metadata":{"createTime":"2020-02-24T22:55:51.729272Z","kind":"auth-provider","name":"ad-dc-1","tags":["dev","us-1"]}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/Internal"}}},"put":{"tags":["Authentication Providers"],"summary":"Update an Authentication Provider","description":"Updates all of the configurations for an existing authentication provider.\n","parameters":[{"name":"providerName","in":"path","description":"The name of the authentication provider.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Contains the desired configuration for the authentication provider.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthProvider"},"example":{"desiredState":{"provider":{"type":"ACTIVE_DIRECTORY","domain":"DC=mydomain,DC=example,DC=com","defaultLoginDomain":"mydomain","connection":[{"uri":"ldap://dc1.mydomain.com","sslMode":"REQUIRE","rawCa":"-----BEGIN CERTIFICATE-----\n MIIDMTCCasdfAwIBAgIUWw25xyNvQPxtjGUZopz0KeoaaQkwDQYJKoZIhvcNAQEL\n [SNIP]\n 2CPqdhpmQhAbzx9ElT8KyC7/08IdV0JK/kSWjfE4jOPOJyI2q0DWExKLuYe+rO+Q\n rg7hesA=\n -----END CERTIFICATE-----"}],"groupSearchFilter":"(objectClass=group)","groupMemberAttribute":"memberof","userFormat":"UPN","bindUser":{"type":"PASSWORD","username":"user@mydomain","password":"passwd1234"},"pollIntervalSec":3600,"groupCacheTimeSec":7200,"honorStaleGroups":false,"groupMappings":[{"external":"Engineering-US-West","caseSensitive":true,"internal":{"ref":"/platform/auth/groups/eng-west"}},{"external":"Engineering-US-East","caseSensitive":true,"internal":{"ref":"/platform/auth/groups/eng-east"}}]}},"metadata":{"kind":"auth-provider","name":"ad-dc-1","tags":["dev","us-1"]}}}}},"operationId":"updateProvider","responses":{"200":{"description":"Successfully updated the configuration for the authentication provider.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthProvider"},"example":{"currentStatus":{"provider":{"type":"ACTIVE_DIRECTORY","status":"CONNECTED_BOUND","domain":"DC=mydomain,DC=example,DC=com","defaultLoginDomain":"mydomain","connection":[{"uri":"ldap://dc1.mydomain.com","sslMode":"REQUIRE","rawCa":"-----BEGIN CERTIFICATE-----\n MIIDMTCCasdfAwIBAgIUWw25xyNvQPxtjGUZopz0KeoaaQkwDQYJKoZIhvcNAQEL\n [SNIP]\n 2CPqdhpmQhAbzx9ElT8KyC7/08IdV0JK/kSWjfE4jOPOJyI2q0DWExKLuYe+rO+Q\n rg7hesA=\n -----END CERTIFICATE-----"}],"groupSearchFilter":"(objectClass=group)","groupMemberAttribute":"memberof","userFormat":"UPN","bindUser":{"type":"PASSWORD","username":"user@mydomain","password":"********"},"pollIntervalSec":3600,"groupCacheTimeSec":7200,"honorStaleGroups":false,"groupMappings":[{"external":"Engineering-US-West","caseSensitive":true,"internal":{"ref":"/platform/auth/groups/eng-west","links":{"rel":"/api/v1/platform/auth/groups/eng-west","name":"eng-west","displayName":"West engineering"}}},{"external":"Engineering-US-East","caseSensitive":true,"internal":{"ref":"/platform/auth/groups/eng-east","links":{"rel":"/api/v1/platform/auth/groups/eng-east","name":"eng-east","displayName":"East engineering"}}}]}},"desiredState":{"provider":{"type":"ACTIVE_DIRECTORY","domain":"DC=mydomain,DC=example,DC=com","defaultLoginDomain":"mydomain","connection":[{"uri":"ldap://dc1.mydomain.com","sslMode":"REQUIRE","rawCa":"-----BEGIN CERTIFICATE-----\n MIIDMTCCasdfAwIBAgIUWw25xyNvQPxtjGUZopz0KeoaaQkwDQYJKoZIhvcNAQEL\n [SNIP]\n 2CPqdhpmQhAbzx9ElT8KyC7/08IdV0JK/kSWjfE4jOPOJyI2q0DWExKLuYe+rO+Q\n rg7hesA=\n -----END CERTIFICATE-----"}],"groupSearchFilter":"(objectClass=group)","groupMemberAttribute":"memberof","userFormat":"UPN","bindUser":{"type":"PASSWORD","username":"user@mydomain","password":"********"},"pollIntervalSec":3600,"groupCacheTimeSec":7200,"honorStaleGroups":false,"groupMappings":[{"external":"Engineering-US-West","caseSensitive":true,"internal":{"ref":"/platform/auth/groups/eng-west"}},{"external":"Engineering-US-East","caseSensitive":true,"internal":{"ref":"/platform/auth/groups/eng-east"}}]}},"metadata":{"createTime":"2020-02-24T22:55:51.729272Z","kind":"auth-provider","name":"ad-dc-1","tags":["dev","us-1"]}}}}},"201":{"description":"Successfully created the configuration for the provider.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthProvider"},"example":{"currentStatus":{"provider":{"type":"ACTIVE_DIRECTORY","status":"CONNECTED_BOUND","domain":"DC=mydomain,DC=example,DC=com","defaultLoginDomain":"mydomain","connection":[{"uri":"ldap://dc1.mydomain.com","sslMode":"REQUIRE","rawCa":"********"}],"groupSearchFilter":"(objectClass=group)","groupMemberAttribute":"memberof","userFormat":"UPN","bindUser":{"type":"PASSWORD","username":"user@mydomain","password":"*******"},"pollIntervalSec":3600,"groupCacheTimeSec":7200,"honorStaleGroups":false,"groupMappings":[{"external":"Engineering-US-West","caseSensitive":true,"internal":{"ref":"/platform/auth/groups/eng-west","links":{"rel":"/api/v1/platform/auth/groups/eng-west","name":"eng-west","displayName":"West engineering"}}},{"external":"Engineering-US-East","caseSensitive":true,"internal":{"ref":"/platform/auth/groups/eng-east","links":{"rel":"/api/v1/platform/auth/groups/eng-east","name":"eng-east","displayName":"East engineering"}}}]}},"desiredState":{"provider":{"type":"ACTIVE_DIRECTORY","domain":"DC=mydomain,DC=example,DC=com","defaultLoginDomain":"mydomain","connection":[{"uri":"ldap://dc1.mydomain.com","sslMode":"REQUIRE","rawCa":"********"}],"groupSearchFilter":"(objectClass=group)","groupMemberAttribute":"memberof","userFormat":"UPN","bindUser":{"type":"PASSWORD","username":"user@mydomain","password":"*******"},"pollIntervalSec":3600,"groupCacheTimeSec":7200,"honorStaleGroups":false,"groupMappings":[{"external":"Engineering-US-West","caseSensitive":true,"internal":{"ref":"/platform/auth/groups/eng-west"}},{"external":"Engineering-US-East","caseSensitive":true,"internal":{"ref":"/platform/auth/groups/eng-east"}}]}},"metadata":{"createTime":"2020-02-24T22:55:51.729272Z","kind":"auth-provider","name":"ad-dc-1","tags":["dev","us-1"]}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"500":{"$ref":"#/components/responses/Internal"}}},"delete":{"tags":["Authentication Providers"],"summary":"Delete an Authentication Provider","description":"Deletes the authentication provider.","parameters":[{"name":"providerName","in":"path","description":"The name of the authentication provider.","required":true,"schema":{"type":"string"}}],"operationId":"disable","responses":{"204":{"description":"Successfully deleted the authentication provider."},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/Internal"}}}}},"components":{"responses":{"BadRequest":{"description":"Bad input parameter, or possibly a bad URI. Check the input for typos and try again.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"Unauthorized":{"description":"User authentication cookie is invalid or missing.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"},"example":{"message":"No session cookie found in the request header.","code":3463}}}},"Forbidden":{"description":"The request failed due to insufficient privileges.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"},"example":{"message":"user is not authorized","code":1235}}}},"Conflict":{"description":"The request failed due to a conflict with an existing authentication provider.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"},"example":{"message":"Error creating provider: provider already exists.","code":3469}}}},"NotFound":{"description":"The requested resource was not found.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"},"example":{"message":"Error getting provider: provider not found.","code":3472}}}},"Internal":{"description":"The request cannot be processed because of an internal server error.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}}},"schemas":{"ListAuthProviders":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/AuthProvider"}}}},"AuthProvider":{"type":"object","required":["metadata","desiredState"],"properties":{"metadata":{"$ref":"#/components/schemas/ResourceMeta"},"currentStatus":{"$ref":"#/components/schemas/AuthProviderDef"},"desiredState":{"$ref":"#/components/schemas/AuthProviderDef"}}},"AuthProviderDef":{"type":"object","properties":{"provider":{"oneOf":[{"$ref":"#/components/schemas/ActiveDirectory"},{"$ref":"#/components/schemas/AzureActiveDirectory"}],"discriminator":{"propertyName":"type","mapping":{"ACTIVE_DIRECTORY":"#/components/schemas/ActiveDirectory","AZURE_ACTIVE_DIRECTORY":"#/components/schemas/AzureActiveDirectory"}},"example":{"provider":{"type":"ACTIVE_DIRECTORY","status":"CONNECTED_BOUND","domain":"DC=mydomain,DC=example,DC=com","defaultLoginDomain":"mydomain","connection":[{"uri":"ldap://dc1.mydomain.com","sslMode":"REQUIRE","rawCa":"-----BEGIN CERTIFICATE-----\n MIIDMTCCasdfAwIBAgIUWw25xyNvQPxtjGUZopz0KeoaaQkwDQYJKoZIhvcNAQEL\n [SNIP]\n 2CPqdhpmQhAbzx9ElT8KyC7/08IdV0JK/kSWjfE4jOPOJyI2q0DWExKLuYe+rO+Q\n rg7hesA=\n -----END CERTIFICATE-----"}],"groupSearchFilter":"(objectClass=group)","groupMemberAttribute":"memberof","userFormat":"UPN","bindUser":{"type":"PASSWORD","username":"user@mydomain","password":"********"},"pollIntervalSec":3600,"groupCacheTimeSec":7200,"honorStaleGroups":false,"filteredGroups":["CN=Office_Admins_SF,OU=San Francisco,OU=North America,OU=Acme Financial","CN=RM_SF,OU=San Francisco,OU=North America,OU=Acme Financial","CN=Sales_Warsaw,OU=Warsaw,OU=Europe,OU=Acme Financial","CN=ACC_EU,OU=Europe,OU=Acme Financial"],"groupMappings":[{"external":"Engineering-US-West","caseSensitive":true,"internal":{"ref":"/platform/auth/groups/eng-west","links":{"rel":"/api/v1/platform/auth/groups/eng-west","name":"eng-west","displayName":"West engineering"}}},{"external":"Engineering-US-East","caseSensitive":true,"internal":{"ref":"/platform/auth/groups/eng-east","links":{"rel":"/api/v1/platform/auth/groups/eng-east","name":"eng-east","displayName":"East engineering"}}}]}}}}},"ActiveDirectory":{"type":"object","properties":{"type":{"type":"string","enum":["ACTIVE_DIRECTORY"]},"status":{"type":"string","description":"This field is read only and will only be reflected in currentStatus and ignored in desiredState.","enum":["CONNECTED_BOUND","CONNECTED_BIND_FAILED","SSL_CA_FAILURE","CONNECTION_FAILURE","PENDING"]},"domain":{"type":"string","description":"The LDAP domain to authenticate against. The domain is unique per each configured Active Directory authentication provider. This field cannot be updated.\n","pattern":"^(DC=[^,=<>]+)(,DC=[^,,=<>]+)*$","example":"DC=mydomain,DC=example,DC=com"},"defaultLoginDomain":{"type":"string","description":"The login domain to use when a user authenticates with only a username rather than specifying DOMAIN\\username or username@domain.fqdn. \n","example":"mydomain.mycompany.com"},"groupSearchFilter":{"type":"string","description":"The search filter to use when finding users within a root domain.\n","example":"(objectClass=group)"},"groupMemberAttribute":{"type":"string","description":"The LDAP attribute to use for specifying membership in an AD Group.\n","example":"memberof"},"userFormat":{"type":"string","enum":["USER_DOMAIN","UPN"],"description":"The username format. \n\n- UPN = username@domain\n- USER_DOMAIN = domain/user\n","example":"UPN"},"connection":{"type":"array","minItems":1,"maxItems":1,"items":{"$ref":"#/components/schemas/AuthConnection"}},"groupMappings":{"type":"array","description":"Maps AD Group(s) to NGINX Controller Group(s).\n","items":{"$ref":"#/components/schemas/GroupMapping"}},"bindUser":{"$ref":"#/components/schemas/BindUser"},"pollIntervalSec":{"type":"integer","description":"Time, in seconds, between refresh of AD information, including the organization unit list.\n","minimum":300,"default":3600},"groupCacheTimeSec":{"type":"integer","description":"Time, in seconds, for which the list of organizational units is honored before being considered stale. \n> This value should be double the configured `pollIntervalSec`.\n","minimum":600,"default":7200},"honorStaleGroups":{"type":"boolean","default":false,"description":"Controls whether a stale AD Group list should be honored when authorizing and authenticating users.\n"},"filteredGroups":{"type":"array","description":"List of groups in the AD that satifies the `groupSearchFilter` field. This field is read only. \n","items":{"type":"string"}}},"required":["type"]},"AzureActiveDirectory":{"type":"object","properties":{"type":{"type":"string","enum":["AZURE_ACTIVE_DIRECTORY"]},"status":{"type":"string","description":"This field is read-only, it is reflected in currentStatus and ignored in desiredState.","enum":["CONNECTED_BOUND","CONNECTION_FAILURE","PENDING"]},"groupFilter":{"type":"string","description":"The filter attribute is used to filter groups in an Azure AD tenant. See [here](https://docs.microsoft.com/en-us/graph/query-parameters#filter-parameter) for more details.\n","example":"groupTypes/any(c:c+eq+'Unified')"},"oidcConfig":{"$ref":"#/components/schemas/OIDCConfig"},"groupMappings":{"type":"array","description":"Maps Azure AD Group(s) to NGINX Controller Group(s).\n","items":{"$ref":"#/components/schemas/GroupMapping"}},"pollIntervalSec":{"type":"integer","description":"Time (sec) interval for refreshing Azure AD information, including the groups and group membership information.\n","minimum":300,"default":3600},"groupCacheTimeSec":{"type":"integer","description":"Time (sec) interval for which the group and group membership information are honored before being considered stale.\n> This value should be double the configured `pollIntervalSec`.\n","minimum":600,"default":7200},"honorStaleGroups":{"type":"boolean","default":false,"description":"Controls whether a stale Azure AD group membership information is honored or not when authorizing and authenticating users.\n"},"filteredGroups":{"type":"array","description":"List of groups in the Azure AD which satisfy the `groupFilter` field. This field is read-only.\n","items":{"type":"string"}}},"required":["type"]},"AuthConnection":{"type":"object","description":"Connection parameters for an external authentication provider.\n","properties":{"uri":{"type":"string","description":"Connection URI. \n","format":"uri","pattern":"^ldaps?:\\/\\/([\\w\\-]+\\.)+([\\w\\-]*)(:[0-9]+)?$","example":"ldap://dc1.example.com"},"sslMode":{"type":"string","description":"SSL connection parameters.\n- `PLAIN_TEXT`: (Insecure) Unencrypted connection. Does not require SSL certificates.\n- `REQUIRE`: (Default) Require an SSL connection. Unencrypted connections will fail. The server identity is not verified.\n- `VERIFY_CA`: (Most secure) Verify the certificate authority (CA) of the Active Directory connection. The server is verified by checking the certificate chain up to the root certificate stored on the client.\n\n> **Note**: For Production environments, we strongly advise using `VERIFY_CA` for the SSL mode in order to prevent server spoofing.\n","enum":["PLAIN_TEXT","REQUIRE","VERIFY_CA"]},"rawCa":{"type":"string","description":"Raw Certificate","example":"-----BEGIN CERTIFICATE-----\n MIIDMTCCasdfAwIBAgIUWw25xyNvQPxtjGUZopz0KeoaaQkwDQYJKoZIhvcNAQEL\n [SNIP]\n 2CPqdhpmQhAbzx9ElT8KyC7/08IdV0JK/kSWjfE4jOPOJyI2q0DWExKLuYe+rO+Q\n rg7hesA=\n -----END CERTIFICATE-----"}},"required":["uri","sslMode"]},"GroupMapping":{"type":"object","description":"Authentication provider group to NGINX Controller group mapping.\n","properties":{"caseSensitive":{"type":"boolean","description":"Controls whether or not you want to match the external name exactly or if the match should be case-insensitive.","default":false},"external":{"type":"string","description":"The name of the external group.","example":"Engineering-US-West"},"internal":{"$ref":"#/components/schemas/ResourceRef"}},"required":["external","internal"]},"BindUser":{"oneOf":[{"$ref":"#/components/schemas/BindUserPassword"}],"discriminator":{"propertyName":"type","mapping":{"PASSWORD":"#/components/schemas/BindUserPassword"}}},"BindUserPassword":{"type":"object","description":"Credentials used to access data within the AD.\n","properties":{"type":{"type":"string","description":"authentication type.","enum":["PASSWORD"]},"username":{"type":"string","minLength":1,"description":"AD bind username."},"password":{"type":"string","format":"password","minLength":1,"description":"AD bind user password."}},"required":["type","username","password"]},"OIDCConfig":{"type":"object","description":"OpenID Connect config for an external identity provider.\n","properties":{"providerURI":{"type":"string","description":"Identity provider URL. It contains the tenant ID for Azure Identity provider. \n","format":"uri","example":"https://login.microsoftonline.com/d45dfd66-6a3b-40d1-9be0-bf8327d81c56/v2.0"},"clientID":{"type":"string","description":"The Application (client) ID that the identity provider assigns to the NGINX Controller app. For Azure identity providers, you can find it in the portal App registrations.\n","example":"781729sd-87b2-4333-9730-338d3a87340b"},"clientSecret":{"type":"string","description":"A secret string that the application uses to prove its identity when requesting a token.\n","example":"Ic767hk_8anvoip76v"},"scopes":{"type":"array","description":"OpenID Connect Clients use scope values to specify what access privileges are being requested. See [here](https://openid.net/specs/openid-connect-basic-1_0.html#Scopes) for more information.","items":{"type":"string"},"default":["openid","email","profile"]},"redirectURI":{"type":"string","description":"The redirect URI of NGINX controller, where the identity provider sends authentication responses to. This field is read-only. It is reflected in currentStatus and ignored in desiredState. Set this to be one of the redirect URIs in app registration for NGINX Controller in the identity provider's portal.","format":"uri","example":"https://54.212.107.157/api/v1/platform/oidc-handler"}},"required":["providerURI","clientID","clientSecret"]},"SelfLinks":{"type":"object","description":"The SelfLinks object contains a link from the resource to itself.\nThis object is used only in responses.\n","properties":{"rel":{"type":"string","example":"/api/v1/services/environments/prod","description":"`rel` contains the complete path fragment of a URI and can be used\nto construct a query to the object.\n"}}},"ResourceMeta":{"type":"object","required":["name"],"properties":{"name":{"type":"string","pattern":"^[^A-Z\\s\\x00-\\x1f\\x60\\x7f\\;\\*\\\"\\[\\]\\{\\}\\\\\\/%\\?:=&\\~\\^|#<>]+$","not":{"type":"string","enum":[".",".."]},"minLength":1,"maxLength":1024,"example":"resource-name","description":"Resource name is a unique identifier for a resource within the context of a namespace.\nResource names must conform to [RFC 1738 Section 2.2](https://www.ietf.org/rfc/rfc1738.txt) and have a valid syntax for email addresses. The following rules are enforced:\n\n- do not utilize URL encoding;\n- do not include spaces;\n- do not use uppercase characters, for example, 'A-Z'; extended character sets are supported;\n- do not use the following characters: `\"`, `*`, `:`, `;`, `/`, `\\`, `%`, `?`, `hash`, `=`, `&`, `|`, `~`, `^`, `{`, `}`, `[`, `]`, `<`, `>`;\n- cannot start or end with an `@` sign;\n- cannot be only `.` or `..`\n\nFor example: For a collection resource located at\n\n`https://controller.example.com/api/v1/services/apps/shopping_@1`\n\nthe resource name is \"shopping_@1\".\n"},"displayName":{"type":"string","example":"My Display Name","description":"`displayName` is a user friendly resource name. It can be used to define \na longer, and less constrained, name for a resource.\n\nDisplay names:\n\n- are optional (defaults to an empty string if no value is provided),\n- do not have to be unique, \n- cannot be assigned by the server.\n"},"description":{"type":"string","example":"This is a sample description string. It provides information about the resource.","description":"`description` is a free-form text property. You can use it to provide information that helps \nto identify the resource.\n\nDescriptions:\n\n- are optional (defaults to an empty string if no value is provided),\n- do not have to be unique, \n- cannot be assigned by the server.\n"},"kind":{"type":"string","example":"<collection>-<object>","description":"Kind is a string representation of an API resource's data type.\nIt is assigned by the server and cannot be changed. \n\nWhen creating a `kind`, the server uses hyphens to connect word segments; \nsingleton and collection item resources are not pluralized.\n"},"uid":{"type":"string","format":"uuid","example":"d290f1ee-6c54-4b01-90e6-d701748f0851","description":"Unique Identifier (UID)\n\nUID is a unique identifier in time and space for a resource. \nWhen you create a resource, the server assigns a UID to the resource.\n\nRefer to [IETF RFC 4122](https://tools.ietf.org/html/rfc4122) for more information.\n"},"tags":{"type":"array","items":{"type":"string"},"example":["production_public","dev","new_app","us-west-1","emea"],"description":"You can assign `tags` to a resource as a way to help map, scope, \nand organize resources. \n\nThe system uses tag selectors to specify selection criteria that \nmatch resources that have particular tags.\n"},"ref":{"type":"string","example":"/services/environments/prod","description":"The `ref` field contains a reference to another NGINX Controller resource.\n"},"links":{"$ref":"#/components/schemas/SelfLinks"},"createTime":{"type":"string","format":"date-time","example":"2019-07-29T09:12:33.001Z","description":"A timestamp that represents the server time when the resource was created.\n\nCreate time is not guaranteed to be set in \"happens-before\" order\nacross separate operations.\n\nIn JSON format, `create_time` type is encoded as a string in the\n[RFC 3339](https://www.ietf.org/rfc/rfc3339.txt).\n\nFor example: 2018-04-01T01:30:15.01Z\n\nCreate Time is assigned by the server and cannot be changed.\n"},"updateTime":{"type":"string","format":"date-time","example":"2019-07-29T10:12:33.001Z","description":"A timestamp that represents the server time when the resource was last modified.\n\nResources that have never been updated do not have an `update_time` stamp.\n\nThe default value for resources that have never been updated is the local \nlanguage-specific equivalent of \"null\".\n\nIn JSON format, `update_time` type is encoded as a string as described in \n[RFC 3339](https://www.ietf.org/rfc/rfc3339.txt).\n"}}},"NamedLinks":{"allOf":[{"$ref":"#/components/schemas/SelfLinks"},{"type":"object","description":"Contains information about the object being referred to.\n\nThese are generally details -- like the object name and display name --\nthat are useful to a consumer of the API that performs further\nprocessing. \n\nThis object is only present in responses.\n \n","properties":{"name":{"type":"string","example":"production","description":"The name of the linked resource.\n"},"displayName":{"type":"string","example":"Production Environment","description":"A user friendly resource name."}}}]},"ResourceRef":{"type":"object","required":["ref"],"properties":{"ref":{"type":"string","example":"/services/environments/prod","description":"A reference to another NGINX Controller resource.\n"},"links":{"$ref":"#/components/schemas/NamedLinks"}}},"ErrorDetail":{"type":"object","required":["description"],"properties":{"description":{"type":"string","example":"Error doing <action>: <reason for error>. This can lead to <potential consequences>. Try <action> to resolve the issue.","description":"A detailed error message returned by the server. \n\nThese messages contain the following information, where applicable:\n\n- What happened.\n- Why it happened.\n- What the consequences are (if any).\n- Recommended action to take to resolve the issue.\n"}}},"ErrorModel":{"type":"object","required":["message","code"],"properties":{"message":{"type":"string","example":"Error doing <action>.","description":"A human-readable message, in English, that describes the error.\n"},"code":{"type":"integer","example":1234567,"description":"A numeric error code that can be used to identify errors for support purposes.\n"},"details":{"type":"array","items":{"$ref":"#/components/schemas/ErrorDetail"}}}}}}}
/ platform / auth / providers
/ platform / auth / providers / {providerName}
Strategies API OpenAPI	{"openapi":"3.0.0","servers":[{"description":"NGINX Controller API","url":"https://{{CONTROLLER_FQDN}}/api/v1"}],"info":{"description":"Manage Security Strategies for your Apps and APIs. The current supported strategy is an NGINX App Protect Strategy (beta).","version":"v1","title":"Strategies API"},"paths":{"/security/strategies":{"get":{"tags":["Strategies"],"summary":"List all Strategies","description":"Returns a list of Strategy metadata objects for all of the Strategies.","operationId":"StrategyServiceList","responses":{"200":{"description":"Successfully retrieved a list of Strategies.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StrategyList"}}}},"400":{"description":"Bad input parameter, or possibly a bad URI. Check the input for typos and try again.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"404":{"description":"The resource defined in the URI could not be found. Check the URI for errors and try again.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}}}},"post":{"tags":["Strategies"],"summary":"Create a Strategy","operationId":"StrategyServicePost","description":"Creates a new Strategy resource.\n","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Strategy"}}}},"responses":{"201":{"description":"Successfully created the specified Strategy resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StrategyStatus"}}}},"400":{"description":"Bad input parameter, or possibly a bad URI. Check the input for typos and try again.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"404":{"description":"The resource defined in the URI could not be found. Check the URI for errors and try again.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"409":{"description":"The request failed due to a naming conflict with an existing resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}}}}},"/security/strategies/{strategyName}":{"get":{"tags":["Strategies"],"summary":"Get a Strategy","operationId":"StrategyServiceGet","description":"Returns information for a specific Strategy resource.","responses":{"200":{"description":"Sucessfully retrieved the requested Strategy.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StrategyStatus"}}}},"400":{"description":"Bad input parameter, or possibly a bad URI. Check the input for typos and try again.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"404":{"description":"The resource defined in the URI could not be found. Check the URI for errors and try again.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}}}},"put":{"tags":["Strategies"],"summary":"Upsert a Strategy","operationId":"StrategyServicePut","description":"Creates a new Strategy or updates an existing Strategy resource.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Strategy"}}}},"responses":{"200":{"description":"Sucessfully updated the specified Strategy resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StrategyStatus"}}}},"201":{"description":"Successfully created the requested Strategy resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StrategyStatus"}}}},"400":{"description":"Bad input parameter, or possibly a bad URI. Check the input for typos and try again.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"404":{"description":"The resource defined in the URI could not be found. Check the URI for errors and try again.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}}}},"delete":{"tags":["Strategies"],"summary":"Delete a Strategy","operationId":"StrategyServiceDelete","description":"Deletes the specified Strategy resource.","responses":{"204":{"description":"The specified Strategy resource was successfully deleted."},"404":{"description":"The resource defined in the URI could not be found. Check the URI for errors and try again.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"409":{"description":"The request to delete the specified Strategy resource failed.\nThe Strategy is referenced by active objects and cannot be deleted. Delete the referencing objects or remove the references, then try again.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}}}},"parameters":[{"name":"strategyName","description":"The name of the Strategy.","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ResourceName"}}]}},"components":{"schemas":{"ResourceName":{"type":"string","description":"The name of a resource.","example":"production"},"StrategyDesiredState":{"type":"object","description":"The defired state of the strategy","required":["content"],"properties":{"content":{"type":"object","$ref":"#/components/schemas/StrategyData"}}},"StrategyList":{"type":"object","required":["items"],"properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/StrategyStatus"}}}},"StrategyStatus":{"type":"object","required":["metadata","desiredState","currentStatus"],"properties":{"metadata":{"$ref":"#/components/schemas/ResourceMeta"},"desiredState":{"$ref":"#/components/schemas/StrategyDesiredState"},"currentStatus":{"$ref":"#/components/schemas/StrategyCurrentStatus"}}},"StrategyCurrentStatus":{"type":"object","description":"Shows the current status of the strategy.","required":["state","content"],"properties":{"content":{"type":"object","$ref":"#/components/schemas/StrategyData"},"state":{"$ref":"#/components/schemas/ConfigState"}}},"Strategy":{"type":"object","description":"Contains the strategy to upload.","required":["metadata","desiredState"],"properties":{"metadata":{"$ref":"#/components/schemas/ResourceMeta"},"desiredState":{"$ref":"#/components/schemas/StrategyDesiredState"}}},"StrategyData":{"type":"object","description":"Strategy Data.","required":["securityPolicyRef"],"properties":{"securityPolicyRef":{"type":"string","description":"Reference to the Nginx Application Protection policy used in this strategy.","example":"/security/policies/mynappolicy"}}},"SelfLinks":{"type":"object","description":"The SelfLinks object contains a link from the resource to itself.\nThis object is used only in responses.\n","properties":{"rel":{"type":"string","example":"/api/v1/services/environments/prod","description":"`rel` contains the complete path fragment of a URI and can be used\nto construct a query to the object.\n"}}},"ResourceMeta":{"type":"object","required":["name"],"properties":{"name":{"type":"string","pattern":"^[^A-Z\\s\\x00-\\x1f\\x60\\x7f\\;\\*\\\"\\[\\]\\{\\}\\\\\\/%\\?:=&\\~\\^|#<>]+$","not":{"type":"string","enum":[".",".."]},"minLength":1,"maxLength":1024,"example":"resource-name","description":"Resource name is a unique identifier for a resource within the context of a namespace.\nResource names must conform to [RFC 1738 Section 2.2](https://www.ietf.org/rfc/rfc1738.txt) and have a valid syntax for email addresses. The following rules are enforced:\n\n- do not utilize URL encoding;\n- do not include spaces;\n- do not use uppercase characters, for example, 'A-Z'; extended character sets are supported;\n- do not use the following characters: `\"`, `*`, `:`, `;`, `/`, `\\`, `%`, `?`, `hash`, `=`, `&`, `|`, `~`, `^`, `{`, `}`, `[`, `]`, `<`, `>`;\n- cannot start or end with an `@` sign;\n- cannot be only `.` or `..`\n\nFor example: For a collection resource located at\n\n`https://controller.example.com/api/v1/services/apps/shopping_@1`\n\nthe resource name is \"shopping_@1\".\n"},"displayName":{"type":"string","example":"My Display Name","description":"`displayName` is a user friendly resource name. It can be used to define \na longer, and less constrained, name for a resource.\n\nDisplay names:\n\n- are optional (defaults to an empty string if no value is provided),\n- do not have to be unique, \n- cannot be assigned by the server.\n"},"description":{"type":"string","example":"This is a sample description string. It provides information about the resource.","description":"`description` is a free-form text property. You can use it to provide information that helps \nto identify the resource.\n\nDescriptions:\n\n- are optional (defaults to an empty string if no value is provided),\n- do not have to be unique, \n- cannot be assigned by the server.\n"},"kind":{"type":"string","example":"<collection>-<object>","description":"Kind is a string representation of an API resource's data type.\nIt is assigned by the server and cannot be changed. \n\nWhen creating a `kind`, the server uses hyphens to connect word segments; \nsingleton and collection item resources are not pluralized.\n"},"uid":{"type":"string","format":"uuid","example":"d290f1ee-6c54-4b01-90e6-d701748f0851","description":"Unique Identifier (UID)\n\nUID is a unique identifier in time and space for a resource. \nWhen you create a resource, the server assigns a UID to the resource.\n\nRefer to [IETF RFC 4122](https://tools.ietf.org/html/rfc4122) for more information.\n"},"tags":{"type":"array","items":{"type":"string"},"example":["production_public","dev","new_app","us-west-1","emea"],"description":"You can assign `tags` to a resource as a way to help map, scope, \nand organize resources. \n\nThe system uses tag selectors to specify selection criteria that \nmatch resources that have particular tags.\n"},"ref":{"type":"string","example":"/services/environments/prod","description":"The `ref` field contains a reference to another NGINX Controller resource.\n"},"links":{"$ref":"#/components/schemas/SelfLinks"},"createTime":{"type":"string","format":"date-time","example":"2019-07-29T09:12:33.001Z","description":"A timestamp that represents the server time when the resource was created.\n\nCreate time is not guaranteed to be set in \"happens-before\" order\nacross separate operations.\n\nIn JSON format, `create_time` type is encoded as a string in the\n[RFC 3339](https://www.ietf.org/rfc/rfc3339.txt).\n\nFor example: 2018-04-01T01:30:15.01Z\n\nCreate Time is assigned by the server and cannot be changed.\n"},"updateTime":{"type":"string","format":"date-time","example":"2019-07-29T10:12:33.001Z","description":"A timestamp that represents the server time when the resource was last modified.\n\nResources that have never been updated do not have an `update_time` stamp.\n\nThe default value for resources that have never been updated is the local \nlanguage-specific equivalent of \"null\".\n\nIn JSON format, `update_time` type is encoded as a string as described in \n[RFC 3339](https://www.ietf.org/rfc/rfc3339.txt).\n"}}},"ConfigStateTally":{"type":"object","properties":{"isConfigured":{"type":"boolean","description":"The configuration operation is complete."},"isConfiguring":{"type":"boolean","description":"The configuration of the resource, or of its child(ren), is in process."},"isError":{"type":"boolean","description":"An error occurred while configuring the resource or its child(ren)."},"isDeleting":{"type":"boolean","description":"A delete operation is in progress for the resource or its child(ren)."},"total":{"type":"integer","description":"The total number of resources to which the configuration operation applies."},"configured":{"type":"integer","description":"The number of resources that have a complete and valid configuration."},"configuring":{"type":"integer","description":"The number of resources that are in the process of being configured."},"error":{"type":"integer","description":"The number of resources that have encountered an error during the configuration process."},"deleting":{"type":"integer","description":"The number of resources that are in the process of being deleted."}}},"ConfigCondition":{"type":"object","properties":{"type":{"type":"string","description":"The condition type."},"message":{"type":"string","description":"A human-readable message that provides additional information about the configuration operation."}}},"ConfigState":{"type":"object","description":"A representation of the resource's current configuration state \nthat comprises the status of the resource itself (`selfConfigState`) and any child \nresources (`childrenConfigState`).\n\nThe conditions array provides additional information during configuration changes.\n","properties":{"selfConfigState":{"$ref":"#/components/schemas/ConfigStateTally"},"childrenConfigState":{"$ref":"#/components/schemas/ConfigStateTally"},"conditions":{"type":"array","items":{"$ref":"#/components/schemas/ConfigCondition"}}}},"ErrorDetail":{"type":"object","required":["description"],"properties":{"description":{"type":"string","example":"Error doing <action>: <reason for error>. This can lead to <potential consequences>. Try <action> to resolve the issue.","description":"A detailed error message returned by the server. \n\nThese messages contain the following information, where applicable:\n\n- What happened.\n- Why it happened.\n- What the consequences are (if any).\n- Recommended action to take to resolve the issue.\n"}}},"ErrorModel":{"type":"object","required":["message","code"],"properties":{"message":{"type":"string","example":"Error doing <action>.","description":"A human-readable message, in English, that describes the error.\n"},"code":{"type":"integer","example":1234567,"description":"A numeric error code that can be used to identify errors for support purposes.\n"},"details":{"type":"array","items":{"$ref":"#/components/schemas/ErrorDetail"}}}}}}}
/ security / strategies
/ security / strategies / {strategyName}
Verify Authorization API OpenAPI	{"openapi":"3.0.0","info":{"title":"Verify Authorization API","version":"v1","description":"Verifies the current session is authorized to access a list of resources."},"servers":[{"description":"NGINX Controller API","url":"https://{{CONTROLLER_FQDN}}/api/v1"}],"paths":{"/platform/auth/verify":{"x-f5-experimental":true,"post":{"x-f5-experimental":true,"tags":["Verify"],"summary":"Request a collection of permitted actions","description":"Returns a list of authorized actions based on a list of requested actions and resources.\n","operationId":"doVerify","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VerifyList"},"example":{"items":[{"path":"/services/environments/test1","method":"DELETE"},{"path":"/services/environments/test2","method":"PUT"}]}}}},"responses":{"200":{"description":"Successfully retrieved a list of authorized actions.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VerifyList"},"example":{"items":[{"path":"/services/environments/test1","method":"DELETE","permitted":false},{"path":"/services/environments/test2","method":"PUT","permitted":true}]}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"500":{"$ref":"#/components/responses/Internal"}}}}},"components":{"securitySchemes":{"cookieAuth":{"type":"apiKey","in":"cookie","name":"session"}},"responses":{"BadRequest":{"description":"Bad input parameter, or possibly a bad URI. Check the input for typos and try again.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"},"example":{"code":4005,"message":"Error verifying the authorization: could not decode the request. Check the request body and try again."}}}},"Unauthorized":{"description":"User authentication is invalid or missing.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"},"example":{"code":401,"message":"authentication needed"}}}},"Forbidden":{"description":"The request failed because of insufficient privileges.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"},"example":{"code":403,"message":"unauthorized"}}}},"Internal":{"description":"The request cannot be processed because of an internal server error.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"},"example":{"code":4000,"message":"An internal error occurred while verifying the authorization. If the problem persists, contact the system administrator."}}}}},"schemas":{"VerifyList":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/AuthRequest"},"description":"Contains a list of authentication requests.\n"}}},"AuthRequest":{"type":"object","required":["path","method"],"example":{"items":[{"path":"/services/environments/test1","method":"DELETE","permitted":false},{"path":"/services/environments/test2","method":"PUT","permitted":true}]},"properties":{"path":{"type":"string"},"method":{"type":"string","enum":["GET","POST","PUT","DELETE","HEAD","TRACE","PATCH","CONNECT","OPTIONS"]},"permitted":{"type":"boolean"}}},"ErrorDetail":{"type":"object","required":["description"],"properties":{"description":{"type":"string","example":"Error doing <action>: <reason for error>. This can lead to <potential consequences>. Try <action> to resolve the issue.","description":"A detailed error message returned by the server. \n\nThese messages contain the following information, where applicable:\n\n- What happened.\n- Why it happened.\n- What the consequences are (if any).\n- Recommended action to take to resolve the issue.\n"}}},"ErrorModel":{"type":"object","required":["message","code"],"properties":{"message":{"type":"string","example":"Error doing <action>.","description":"A human-readable message, in English, that describes the error.\n"},"code":{"type":"integer","example":1234567,"description":"A numeric error code that can be used to identify errors for support purposes.\n"},"details":{"type":"array","items":{"$ref":"#/components/schemas/ErrorDetail"}}}}}}}
/ platform / auth / verify
Forwarders API OpenAPI	{"openapi":"3.0.0","info":{"version":"v1","title":"Forwarders API","description":"Use the Forwarders API to forward data (metrics, events) to external services."},"servers":[{"description":"NGINX Controller API","url":"https://{{CONTROLLER_FQDN}}/api/v1"}],"paths":{"/analytics/forwarders":{"post":{"tags":["Forwarders"],"summary":"Create a Forwarder","description":"Creates a new Forwarder resource.","operationId":"createForwarder","requestBody":{"description":"Contains the desired settings for the Forwarder resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Forwarder"}}}},"responses":{"202":{"description":"The request to create a Forwarder resource succeeded. The resource will be created when the configuration is complete.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Forwarder"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"409":{"$ref":"#/components/responses/Conflict"},"500":{"$ref":"#/components/responses/Internal"}}},"get":{"tags":["Forwarders"],"summary":"Get a list of Forwarders.","description":"Returns a list of all Forwarder resources.","operationId":"listForwarders","responses":{"200":{"description":"Successfully retrieved a list of all Forwarder resources.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForwarderListResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"500":{"$ref":"#/components/responses/Internal"}}}},"/analytics/forwarders/{forwarderName}":{"get":{"tags":["Forwarders"],"summary":"Get a Forwarder","operationId":"getForwarder","description":"Gets information about an existing Forwarder resource.","parameters":[{"$ref":"#/components/parameters/ForwarderName"}],"responses":{"200":{"description":"Successfully retrieved the requested Forwarder resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Forwarder"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/Internal"}}},"put":{"tags":["Forwarders"],"summary":"Create or update a Forwarder","description":"Creates new or updates an existing Forwarder resource.","operationId":"updateForwarder","requestBody":{"description":"Contains the desired settings for the Forwarder resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Forwarder"}}}},"parameters":[{"$ref":"#/components/parameters/ForwarderName"}],"responses":{"202":{"description":"Successfully initialized the update process of a Forwarder resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Forwarder"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"500":{"$ref":"#/components/responses/Internal"}}},"delete":{"tags":["Forwarders"],"summary":"Delete a Forwarder","operationId":"deleteForwarder","description":"Deletes a Forwarder resource.","parameters":[{"$ref":"#/components/parameters/ForwarderName"}],"responses":{"202":{"description":"The request to delete a Forwarder resource succeeded. The resource is marked for deletion.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Forwarder"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/Internal"}}}}},"components":{"responses":{"BadRequest":{"description":"Bad input parameter, or possibly a bad URI. Check the input for typos and try again.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"Unauthorized":{"description":"User authentication is invalid or missing.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"Forbidden":{"description":"The request failed due to insufficient privileges.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"Internal":{"description":"The request cannot be processed because of an internal server error.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"NotFound":{"description":"The requested resource was not found or is unavailable.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"Conflict":{"description":"The request failed due to a conflict with an existing resource.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}}},"parameters":{"ForwarderName":{"in":"path","name":"forwarderName","schema":{"type":"string"},"required":true,"description":"The name of the Forwarder resource.\n"}},"schemas":{"Forwarder":{"type":"object","required":["metadata","desiredState"],"properties":{"metadata":{"$ref":"#/components/schemas/ResourceMeta"},"desiredState":{"$ref":"#/components/schemas/DesiredState"},"currentStatus":{"$ref":"#/components/schemas/CurrentStatus"}},"example":{"metadata":{"name":"splunk","displayName":"Splunk - Metrics","description":"Metrics forwarder going to Splunk HEC","kind":"forwarder","uid":"d290f1ee-6c54-4b01-90e6-d701748f0851","links":{"rel":"/api/v1/analytics/forwarders/splunk"},"createTime":"2019-07-29T09:12:33.001Z","updateTime":"2019-07-29T10:12:33.001Z"},"desiredState":{"collectorType":"SPLUNK","integrationRef":{"ref":"/platform/integrations/new_splunk_hec"},"streams":[{"inputDataType":"METRICS","outputFormat":"SPLUNK","selector":"names=http.request.bytes_rcvd&filter=app='myapp'"},{"inputDataType":"METRICS","outputFormat":"SPLUNK","selector":"names=http.request.count&filter=app='myapp'"}]},"currentStatus":{"state":{"selfConfigState":{"isConfigured":false,"isConfiguring":true,"isError":false,"isDeleting":false,"total":1,"configured":0,"configuring":1,"error":0,"deleting":0}},"collectorType":"SPLUNK","integrationRef":{"ref":"/platform/integrations/splunk_hec"},"streams":[{"inputDataType":"METRICS","outputFormat":"SPLUNK","selector":"names=http.request.bytes_rcvd&filter=app='myapp'"},{"inputDataType":"METRICS","outputFormat":"SPLUNK","selector":"names=http.request.count&filter=app='myapp'"}]}}},"CurrentStatus":{"type":"object","required":["integrationRef","streams","state","collectorType"],"properties":{"state":{"$ref":"#/components/schemas/ConfigState"},"integrationRef":{"$ref":"#/components/schemas/ResourceRef"},"collectorType":{"type":"string","enum":["DATADOG","SPLUNK","SYSLOG","OTLP_HTTP","OTLP_GRPC"],"description":"The type of Collector receiving forwarded data. The parameter sets the communication protocol\nand how the Forwarder monitors the liveness of the Collector.\n"},"streams":{"type":"array","items":{"$ref":"#/components/schemas/ForwarderStream"}}}},"DesiredState":{"type":"object","required":["integrationRef","streams","collectorType"],"properties":{"integrationRef":{"$ref":"#/components/schemas/ResourceRef"},"collectorType":{"type":"string","enum":["DATADOG","SPLUNK","SYSLOG"],"description":"The type of Collector receiving forwarded data. The parameter sets the communication protocol\nand how the Forwarder monitors the liveness of the Collector.\n"},"streams":{"type":"array","items":{"$ref":"#/components/schemas/ForwarderStream"}}}},"ForwarderStream":{"type":"object","required":["outputFormat","inputDataType","selector"],"description":"There is no global limitation on number of streams.\n\nWhen creating a Stream, be sure that the metrics you select are not already included in an existing Stream.\nWhen you add the same metrics to multiple Streams -- which is known as \"overlapping Streams\" -- you may see significant performance degradation and data duplication. The duplicated data may not be interpreted correctly by the Collector.\n","properties":{"outputFormat":{"type":"string","enum":["SPLUNK","DATADOG","SYSLOG","OTLP"],"description":"The format in which you want to send data to the Collector.\n","example":"SPLUNK"},"inputDataType":{"type":"string","enum":["METRICS","EVENTS"],"description":"The type of data that the stream is processing.","example":"METRICS"},"selector":{"type":"string","description":"The selector object limits the amount of data sent from NGINX Controller to the desired Collector.\nThe format of this parameter depends on the `inputDataType` value (either `METRICS` or `EVENTS`).\nAn empty selector indicates that all collected data is going to be forwarded to the Collector.\nEnsure sending all your data out of NGINX Controller does not cause additional charges.\n\n\nSelector elements and rules for `inputDataType`=`METRICS`:\nAllowed parameters: `excluded_names`, `names`, `filter`. The `filter` parameter and its behavior is not specific to `METRICS` `inputDataType`.\n\n`excluded_names` parameter consists of zero or more metric names that should not be forwarded\n`names` parameter consists of zero or more metric names that should be forwarded\nThe specific rules for these parameters are as follows:\n- if no value is provided or the only value is a wildcard (`*`), then all metric names will be forwarded.\n- if an explicit list of metric names is provided, all of these metrics will be forwarded.\n- any metric name can contain wildcard (`*`) character(s), in which case it will be resolved to all valid metrics that match the pattern.\n- `excluded_names` can be composed of metrics names and a wildcard (`*`) which should not be forwarded\n- any metric resolved from a `names` wildcard can be removed by an explicit or wildcard metric from `excluded_names`\n- any metric provided explicitly (full name without a wildcard) in the `names` parameter cannot be excluded by\n a wildcard or an explicit metric from the `excluded_names` parameter. That is, `names=system.cpu.idle&excluded_names=system.*`\n results in an error\n- `excluded_names` parameter is always applied after the resolution of the metrics from `names` parameter\n\nMake sure that all metrics provided in the `names` and `excluded_names` parameters resolve to an existing catalog metric or metrics.\n\nSample use:\n- `names=http.request.count, http.request.bytes_sent` indicates that only samples of those two metrics will be forwarded\n- `filter=app='myapp' & (env='prod' or env='dev')` indicates that only samples related to desired app/env will be forwarded,\nalso objects that does not contain filtered dimensions won't be sent\n- `names=http.request.count, http.request.bytes_sent&filter=app='myapp' AND (env='prod' or env='dev')` combines both above\n- `excluded_names=nginx.http.request.*` all metrics except matching `http.request.*` will be forwarded\n- `excluded_names=nginx.http.request.time.*&names=nginx.http.request.*` `excluded_names` can be combined\n with the `names` parameter to exclude metrics that were selected with a wildcard in the `names` parameters\n\n\nFiltering rules for `inputDataType`=`EVENTS`:\nAllowed parameters: `filter`. The `filter` parameter and its behavior is not specific to `EVENTS` `inputDataType`.\n\n\nFilter parameter:\nFilter parameter is shared between all supported data types and has the same behavior when used with any of them.\nIt consists of one or more predicates in the form `<dimension><operator><dimension value>` where:\n- `<dimension>` is the name of the dimension,\n- `<operator>` is one of the supported operators (`=`, `!=`, `<`, `<=`, `>=` `>`, `in` or `not`),\n- `<dimension value>` is value of the dimension(s) that you want to filter on,\n- `<dimension> and <dimension value>` is case sensitive.\n\nFor example: 'count > 100'.\nPredicates can be combined into logical expressions using `OR`, `AND`, and `(` `)`.\nWrapping predicates in single quotes is recommended to ensure that the full query string is processed correctly.\n\nFor matching values, wildcard (`*`) use is supported.\n\nMake sure that all dimensions provided in the `filter` parameters resolve to an existing catalog dimension.\n\nAny expression with dimension not present in filtered metric/event will evaluate to `false`. This enables user\nto create filter which will forward metric/event with dimension not valid for particular metric/event but as whole filter expression\nwill evaluate to true and only parts will evaluate to false. Example:\n- `filter=file_path='/etc/hosts' OR instance='instance_name'` will forward `http.request.body_bytes_sent` as `file_path` dimension is invalid but whole expression will evaluate to true\n- `filter=file_path='/etc/hosts' AND instance='instance_name'` will not forward `http.request.body_bytes_sent` as `file_path` dimension is invalid and whole expression will always evaluate to false, but will forward `sytem.disk.used` which has both dimensions\n","example":"names=http.request.count,http.request.*,*latency*&filter=((app!='app1' OR app='app2') AND environment in ('aa', 'bb')) AND (tags!='*tag1*' AND interface='ens*')"}}},"ForwarderListResponse":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/Forwarder"},"description":"List of Forwarder resources."}},"example":{"items":[{"metadata":{"name":"splunk","displayName":"Splunk - Metrics","description":"Metrics forwarder going to Splunk HEC","kind":"forwarder","uid":"d290f1ee-6c54-4b01-90e6-d701748f0851","links":{"rel":"/api/v1/analytics/forwarders/splunk"},"createTime":"2019-07-29T09:12:33.001Z","updateTime":"2019-07-29T10:12:33.001Z"},"desiredState":{"collectorType":"SPLUNK","integrationRef":{"ref":"/platform/integrations/splunk_hec"},"streams":[{"inputDataType":"METRICS","outputFormat":"SPLUNK","selector":"names=http.request.bytes_rcvd"},{"inputDataType":"METRICS","outputFormat":"SPLUNK","selector":"names=http.request.count"}]},"currentStatus":{"state":{"selfConfigState":{"isConfigured":true,"isConfiguring":false,"isError":false,"isDeleting":false,"total":1,"configured":1,"configuring":0,"error":0,"deleting":0},"conditions":[{"type":"error","message":"integration reference not found"}]},"collectorType":"SPLUNK","integrationRef":{"ref":"/platform/integrations/splunk_hec"},"streams":[{"inputDataType":"METRICS","outputFormat":"SPLUNK","selector":"names=http.request.bytes_rcvd&filter=app='myapp'"},{"inputDataType":"METRICS","outputFormat":"SPLUNK","selector":"names=http.request.count&filter=app='myapp'"}]}},{"metadata":{"name":"splunk","displayName":"Splunk - Metrics","description":"Metrics forwarder going to Splunk HEC","kind":"forwarder","uid":"d290f1ee-6c54-4b01-90e6-d701748f0851","links":{"rel":"/api/v1/analytics/forwarders/splunk"},"createTime":"2019-07-29T09:12:33.001Z","updateTime":"2019-07-29T10:12:33.001Z"},"desiredState":{"collectorType":"SPLUNK","integrationRef":{"ref":"/platform/integrations/splunk_hec"},"streams":[{"inputDataType":"METRICS","outputFormat":"SPLUNK","selector":"names=http.request.bytes_rcvd&filter=app='myapp'"},{"inputDataType":"METRICS","outputFormat":"SPLUNK","selector":"names=http.request.count&filter=app='myapp'"}]},"currentStatus":{"state":{"selfConfigState":{"isConfigured":true,"isConfiguring":false,"isError":false,"isDeleting":false,"total":0,"configured":1,"configuring":0,"error":0,"deleting":0},"conditions":[{"type":"error","message":"integration reference not found"}]},"collectorType":"SPLUNK","integrationRef":{"ref":"/platform/integrations/splunk_hec"},"streams":[{"inputDataType":"METRICS","outputFormat":"SPLUNK","selector":"names=http.request.bytes_rcvd&filter=app='myapp'"},{"inputDataType":"METRICS","outputFormat":"SPLUNK","selector":"names=http.request.count&filter=app='myapp'"}]}}]}},"SelfLinks":{"type":"object","description":"The SelfLinks object contains a link from the resource to itself.\nThis object is used only in responses.\n","properties":{"rel":{"type":"string","example":"/api/v1/services/environments/prod","description":"`rel` contains the complete path fragment of a URI and can be used\nto construct a query to the object.\n"}}},"ResourceMeta":{"type":"object","required":["name"],"properties":{"name":{"type":"string","pattern":"^[^A-Z\\s\\x00-\\x1f\\x60\\x7f\\;\\*\\\"\\[\\]\\{\\}\\\\\\/%\\?:=&\\~\\^|#<>]+$","not":{"type":"string","enum":[".",".."]},"minLength":1,"maxLength":1024,"example":"resource-name","description":"Resource name is a unique identifier for a resource within the context of a namespace.\nResource names must conform to [RFC 1738 Section 2.2](https://www.ietf.org/rfc/rfc1738.txt) and have a valid syntax for email addresses. The following rules are enforced:\n\n- do not utilize URL encoding;\n- do not include spaces;\n- do not use uppercase characters, for example, 'A-Z'; extended character sets are supported;\n- do not use the following characters: `\"`, `*`, `:`, `;`, `/`, `\\`, `%`, `?`, `hash`, `=`, `&`, `|`, `~`, `^`, `{`, `}`, `[`, `]`, `<`, `>`;\n- cannot start or end with an `@` sign;\n- cannot be only `.` or `..`\n\nFor example: For a collection resource located at\n\n`https://controller.example.com/api/v1/services/apps/shopping_@1`\n\nthe resource name is \"shopping_@1\".\n"},"displayName":{"type":"string","example":"My Display Name","description":"`displayName` is a user friendly resource name. It can be used to define \na longer, and less constrained, name for a resource.\n\nDisplay names:\n\n- are optional (defaults to an empty string if no value is provided),\n- do not have to be unique, \n- cannot be assigned by the server.\n"},"description":{"type":"string","example":"This is a sample description string. It provides information about the resource.","description":"`description` is a free-form text property. You can use it to provide information that helps \nto identify the resource.\n\nDescriptions:\n\n- are optional (defaults to an empty string if no value is provided),\n- do not have to be unique, \n- cannot be assigned by the server.\n"},"kind":{"type":"string","example":"<collection>-<object>","description":"Kind is a string representation of an API resource's data type.\nIt is assigned by the server and cannot be changed. \n\nWhen creating a `kind`, the server uses hyphens to connect word segments; \nsingleton and collection item resources are not pluralized.\n"},"uid":{"type":"string","format":"uuid","example":"d290f1ee-6c54-4b01-90e6-d701748f0851","description":"Unique Identifier (UID)\n\nUID is a unique identifier in time and space for a resource. \nWhen you create a resource, the server assigns a UID to the resource.\n\nRefer to [IETF RFC 4122](https://tools.ietf.org/html/rfc4122) for more information.\n"},"tags":{"type":"array","items":{"type":"string"},"example":["production_public","dev","new_app","us-west-1","emea"],"description":"You can assign `tags` to a resource as a way to help map, scope, \nand organize resources. \n\nThe system uses tag selectors to specify selection criteria that \nmatch resources that have particular tags.\n"},"ref":{"type":"string","example":"/services/environments/prod","description":"The `ref` field contains a reference to another NGINX Controller resource.\n"},"links":{"$ref":"#/components/schemas/SelfLinks"},"createTime":{"type":"string","format":"date-time","example":"2019-07-29T09:12:33.001Z","description":"A timestamp that represents the server time when the resource was created.\n\nCreate time is not guaranteed to be set in \"happens-before\" order\nacross separate operations.\n\nIn JSON format, `create_time` type is encoded as a string in the\n[RFC 3339](https://www.ietf.org/rfc/rfc3339.txt).\n\nFor example: 2018-04-01T01:30:15.01Z\n\nCreate Time is assigned by the server and cannot be changed.\n"},"updateTime":{"type":"string","format":"date-time","example":"2019-07-29T10:12:33.001Z","description":"A timestamp that represents the server time when the resource was last modified.\n\nResources that have never been updated do not have an `update_time` stamp.\n\nThe default value for resources that have never been updated is the local \nlanguage-specific equivalent of \"null\".\n\nIn JSON format, `update_time` type is encoded as a string as described in \n[RFC 3339](https://www.ietf.org/rfc/rfc3339.txt).\n"}}},"NamedLinks":{"allOf":[{"$ref":"#/components/schemas/SelfLinks"},{"type":"object","description":"Contains information about the object being referred to.\n\nThese are generally details -- like the object name and display name --\nthat are useful to a consumer of the API that performs further\nprocessing. \n\nThis object is only present in responses.\n \n","properties":{"name":{"type":"string","example":"production","description":"The name of the linked resource.\n"},"displayName":{"type":"string","example":"Production Environment","description":"A user friendly resource name."}}}]},"ResourceRef":{"type":"object","required":["ref"],"properties":{"ref":{"type":"string","example":"/services/environments/prod","description":"A reference to another NGINX Controller resource.\n"},"links":{"$ref":"#/components/schemas/NamedLinks"}}},"ConfigStateTally":{"type":"object","properties":{"isConfigured":{"type":"boolean","description":"The configuration operation is complete."},"isConfiguring":{"type":"boolean","description":"The configuration of the resource, or of its child(ren), is in process."},"isError":{"type":"boolean","description":"An error occurred while configuring the resource or its child(ren)."},"isDeleting":{"type":"boolean","description":"A delete operation is in progress for the resource or its child(ren)."},"total":{"type":"integer","description":"The total number of resources to which the configuration operation applies."},"configured":{"type":"integer","description":"The number of resources that have a complete and valid configuration."},"configuring":{"type":"integer","description":"The number of resources that are in the process of being configured."},"error":{"type":"integer","description":"The number of resources that have encountered an error during the configuration process."},"deleting":{"type":"integer","description":"The number of resources that are in the process of being deleted."}}},"ConfigCondition":{"type":"object","properties":{"type":{"type":"string","description":"The condition type."},"message":{"type":"string","description":"A human-readable message that provides additional information about the configuration operation."}}},"ConfigState":{"type":"object","description":"A representation of the resource's current configuration state \nthat comprises the status of the resource itself (`selfConfigState`) and any child \nresources (`childrenConfigState`).\n\nThe conditions array provides additional information during configuration changes.\n","properties":{"selfConfigState":{"$ref":"#/components/schemas/ConfigStateTally"},"childrenConfigState":{"$ref":"#/components/schemas/ConfigStateTally"},"conditions":{"type":"array","items":{"$ref":"#/components/schemas/ConfigCondition"}}}},"ErrorDetail":{"type":"object","required":["description"],"properties":{"description":{"type":"string","example":"Error doing <action>: <reason for error>. This can lead to <potential consequences>. Try <action> to resolve the issue.","description":"A detailed error message returned by the server. \n\nThese messages contain the following information, where applicable:\n\n- What happened.\n- Why it happened.\n- What the consequences are (if any).\n- Recommended action to take to resolve the issue.\n"}}},"ErrorModel":{"type":"object","required":["message","code"],"properties":{"message":{"type":"string","example":"Error doing <action>.","description":"A human-readable message, in English, that describes the error.\n"},"code":{"type":"integer","example":1234567,"description":"A numeric error code that can be used to identify errors for support purposes.\n"},"details":{"type":"array","items":{"$ref":"#/components/schemas/ErrorDetail"}}}}}}}
/ analytics / forwarders
/ analytics / forwarders / {forwarderName}
Login Providers API OpenAPI	{"openapi":"3.0.0","info":{"version":"v1","title":"Login Providers API","description":"Use the Login Providers API to retrieve a list of the available authentication providers."},"servers":[{"description":"NGINX Controller API","url":"https://{{CONTROLLER_FQDN}}/api/v1"}],"paths":{"/platform/login-providers":{"get":{"tags":["Login Providers"],"summary":"List all Active Authentication Providers","description":"Returns a list of all [authentication providers](#tag/Authentication-Providers) that are configured and ready for use.\n","operationId":"listReadyProviders","responses":{"200":{"description":"Successfully returned a list of the available authentication providers.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListReadyProviders"},"example":{"providers":[{"type":"BASIC","name":"local"}]}}}}}}}},"components":{"schemas":{"ListReadyProviders":{"type":"object","required":["items"],"properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/SimpleAuthProvider"}}}},"SimpleAuthProvider":{"type":"object","required":["name","type"],"properties":{"name":{"type":"string"},"type":{"type":"string","enum":["BASIC","ACTIVE_DIRECTORY","AZURE_ACTIVE_DIRECTORY"]}}}}}}
/ platform / login-providers
Catalogs API OpenAPI	{"openapi":"3.0.0","servers":[{"description":"NGINX Controller API","url":"https://{{CONTROLLER_FQDN}}/api/v1"}],"info":{"description":"Use the Catalogs API to find out about the Metrics and Dimensions that you can use to refine your Analytics data queries.","version":"v1","title":"Catalogs API"},"paths":{"/analytics/catalogs/metrics":{"get":{"tags":["Catalogs"],"summary":"List the Metrics Catalog","operationId":"listMetricsDescriptions","description":"Lists all of the Metric resources in the Catalog.\n\nThe Metrics Catalog contains the definitions for all of the available NGINX and NGINX Controller Agent metrics.\nYou can use the Catalogs API to find information about the available Metrics, then use those Metrics to refine your Analytics data queries.\n","responses":{"200":{"description":"Successfully returned the Metrics Catalog list.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListMetricsDescriptionsResponse"}}}}}}},"/analytics/catalogs/metrics/{metricName}":{"get":{"tags":["Catalogs"],"summary":"Get a Metric Description","operationId":"getMetricDescription","description":"Gets the description of the specified Metric.\n","parameters":[{"in":"path","name":"metricName","description":"Name of the Metric resource.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successfully returned the requested Metric resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MetricDescriptionResponse"}}}},"400":{"description":"Bad input parameter, or possibly a bad URI. Check the input for typos and try again.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"404":{"description":"The specified Metric resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}}}}},"/analytics/catalogs/dimensions":{"get":{"tags":["Catalogs"],"summary":"List the Dimensions Catalog","operationId":"listDimensionsDescriptions","description":"Lists all of the Dimension resources in the Catalog.\n\nDimensions provide a means of refining the data returned by metrics and events queries.\nYou can use the List Dimensions Catalog endpoint to find out what Dimensions are available.\nThen, use the Get a Dimension endpoint to find out more about a specific dimension.\n","responses":{"200":{"description":"Successfully returned the requested Dimension resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListDimensionsDescriptionsResponse"}}}}}}},"/analytics/catalogs/dimensions/{dimensionName}":{"get":{"tags":["Catalogs"],"summary":"Get a Dimension Description","operationId":"getDimensionDescription","description":"Gets the description of the specified Dimension resource.\n","parameters":[{"in":"path","name":"dimensionName","description":"Name of the Dimension","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successfully returned the requested Dimension resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetDimensionDescriptionResponse"}}}},"400":{"description":"Bad input parameter, or possibly a bad URI. Check the input for typos and try again.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"404":{"description":"The specified Dimension resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}}}}}},"components":{"schemas":{"ListMetricsDescriptionsResponse":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/MetricDescriptionRecord"}}}},"MetricDescriptionResponse":{"$ref":"#/components/schemas/MetricDescriptionRecord"},"MetricDescriptionRecord":{"type":"object","required":["metadata","currentStatus"],"properties":{"metadata":{"$ref":"#/components/schemas/ResourceMeta"},"currentStatus":{"$ref":"#/components/schemas/MetricDescription"}}},"MetricDescription":{"type":"object","description":"The information record for a Metrics Catalog resource.","properties":{"name":{"type":"string","example":"nginx.http.request.bytes_sent"},"description":{"type":"string","example":"Number of bytes sent to clients."},"unit":{"type":"string","example":"bytes"},"aggregations":{"type":"array","items":{"type":"string","enum":["AVG","COUNT","SUM","MAX","MIN"]},"example":["AVG","SUM"]},"type":{"type":"string","enum":["counter","gauge","incremental"],"example":"incremental"},"categories":{"type":"array","items":{"type":"string"},"example":["nginx","apimgmt_environment","apimgmt_definition","apimgmt_entry_point"],"description":"An array of freeform strings containing the category(ies) of a Metrics Catalog resource."},"dimensions":{"type":"array","items":{"$ref":"#/components/schemas/ResourceRef"},"description":"An array of the Dimensions that apply to a Metrics Catalog resource."}}},"ListDimensionsDescriptionsResponse":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/DimensionDescriptionRecord"}}}},"GetDimensionDescriptionResponse":{"$ref":"#/components/schemas/DimensionDescriptionRecord"},"DimensionDescriptionRecord":{"type":"object","required":["metadata","currentStatus"],"properties":{"metadata":{"$ref":"#/components/schemas/ResourceMeta"},"currentStatus":{"$ref":"#/components/schemas/DimensionDescription"}}},"DimensionDescription":{"type":"object","description":"The information record for a Dimensions Catalog resource.","properties":{"name":{"type":"string","example":"instance"},"description":{"type":"string","example":"Instance name."},"type":{"type":"string","enum":["string","int","list"],"example":"string"},"metrics":{"type":"array","items":{"$ref":"#/components/schemas/ResourceRef"},"description":"An array of the Metrics that the Dimensions resource applies to."}}},"SelfLinks":{"type":"object","description":"The SelfLinks object contains a link from the resource to itself.\nThis object is used only in responses.\n","properties":{"rel":{"type":"string","example":"/api/v1/services/environments/prod","description":"`rel` contains the complete path fragment of a URI and can be used\nto construct a query to the object.\n"}}},"ResourceMeta":{"type":"object","required":["name"],"properties":{"name":{"type":"string","pattern":"^[^A-Z\\s\\x00-\\x1f\\x60\\x7f\\;\\*\\\"\\[\\]\\{\\}\\\\\\/%\\?:=&\\~\\^|#<>]+$","not":{"type":"string","enum":[".",".."]},"minLength":1,"maxLength":1024,"example":"resource-name","description":"Resource name is a unique identifier for a resource within the context of a namespace.\nResource names must conform to [RFC 1738 Section 2.2](https://www.ietf.org/rfc/rfc1738.txt) and have a valid syntax for email addresses. The following rules are enforced:\n\n- do not utilize URL encoding;\n- do not include spaces;\n- do not use uppercase characters, for example, 'A-Z'; extended character sets are supported;\n- do not use the following characters: `\"`, `*`, `:`, `;`, `/`, `\\`, `%`, `?`, `hash`, `=`, `&`, `|`, `~`, `^`, `{`, `}`, `[`, `]`, `<`, `>`;\n- cannot start or end with an `@` sign;\n- cannot be only `.` or `..`\n\nFor example: For a collection resource located at\n\n`https://controller.example.com/api/v1/services/apps/shopping_@1`\n\nthe resource name is \"shopping_@1\".\n"},"displayName":{"type":"string","example":"My Display Name","description":"`displayName` is a user friendly resource name. It can be used to define \na longer, and less constrained, name for a resource.\n\nDisplay names:\n\n- are optional (defaults to an empty string if no value is provided),\n- do not have to be unique, \n- cannot be assigned by the server.\n"},"description":{"type":"string","example":"This is a sample description string. It provides information about the resource.","description":"`description` is a free-form text property. You can use it to provide information that helps \nto identify the resource.\n\nDescriptions:\n\n- are optional (defaults to an empty string if no value is provided),\n- do not have to be unique, \n- cannot be assigned by the server.\n"},"kind":{"type":"string","example":"<collection>-<object>","description":"Kind is a string representation of an API resource's data type.\nIt is assigned by the server and cannot be changed. \n\nWhen creating a `kind`, the server uses hyphens to connect word segments; \nsingleton and collection item resources are not pluralized.\n"},"uid":{"type":"string","format":"uuid","example":"d290f1ee-6c54-4b01-90e6-d701748f0851","description":"Unique Identifier (UID)\n\nUID is a unique identifier in time and space for a resource. \nWhen you create a resource, the server assigns a UID to the resource.\n\nRefer to [IETF RFC 4122](https://tools.ietf.org/html/rfc4122) for more information.\n"},"tags":{"type":"array","items":{"type":"string"},"example":["production_public","dev","new_app","us-west-1","emea"],"description":"You can assign `tags` to a resource as a way to help map, scope, \nand organize resources. \n\nThe system uses tag selectors to specify selection criteria that \nmatch resources that have particular tags.\n"},"ref":{"type":"string","example":"/services/environments/prod","description":"The `ref` field contains a reference to another NGINX Controller resource.\n"},"links":{"$ref":"#/components/schemas/SelfLinks"},"createTime":{"type":"string","format":"date-time","example":"2019-07-29T09:12:33.001Z","description":"A timestamp that represents the server time when the resource was created.\n\nCreate time is not guaranteed to be set in \"happens-before\" order\nacross separate operations.\n\nIn JSON format, `create_time` type is encoded as a string in the\n[RFC 3339](https://www.ietf.org/rfc/rfc3339.txt).\n\nFor example: 2018-04-01T01:30:15.01Z\n\nCreate Time is assigned by the server and cannot be changed.\n"},"updateTime":{"type":"string","format":"date-time","example":"2019-07-29T10:12:33.001Z","description":"A timestamp that represents the server time when the resource was last modified.\n\nResources that have never been updated do not have an `update_time` stamp.\n\nThe default value for resources that have never been updated is the local \nlanguage-specific equivalent of \"null\".\n\nIn JSON format, `update_time` type is encoded as a string as described in \n[RFC 3339](https://www.ietf.org/rfc/rfc3339.txt).\n"}}},"NamedLinks":{"allOf":[{"$ref":"#/components/schemas/SelfLinks"},{"type":"object","description":"Contains information about the object being referred to.\n\nThese are generally details -- like the object name and display name --\nthat are useful to a consumer of the API that performs further\nprocessing. \n\nThis object is only present in responses.\n \n","properties":{"name":{"type":"string","example":"production","description":"The name of the linked resource.\n"},"displayName":{"type":"string","example":"Production Environment","description":"A user friendly resource name."}}}]},"ResourceRef":{"type":"object","required":["ref"],"properties":{"ref":{"type":"string","example":"/services/environments/prod","description":"A reference to another NGINX Controller resource.\n"},"links":{"$ref":"#/components/schemas/NamedLinks"}}},"ErrorDetail":{"type":"object","required":["description"],"properties":{"description":{"type":"string","example":"Error doing <action>: <reason for error>. This can lead to <potential consequences>. Try <action> to resolve the issue.","description":"A detailed error message returned by the server. \n\nThese messages contain the following information, where applicable:\n\n- What happened.\n- Why it happened.\n- What the consequences are (if any).\n- Recommended action to take to resolve the issue.\n"}}},"ErrorModel":{"type":"object","required":["message","code"],"properties":{"message":{"type":"string","example":"Error doing <action>.","description":"A human-readable message, in English, that describes the error.\n"},"code":{"type":"integer","example":1234567,"description":"A numeric error code that can be used to identify errors for support purposes.\n"},"details":{"type":"array","items":{"$ref":"#/components/schemas/ErrorDetail"}}}}}}}
/ analytics / catalogs / metrics
/ analytics / catalogs / metrics / {metricName}
/ analytics / catalogs / dimensions
/ analytics / catalogs / dimensions / {dimensionName}
API Definitions API OpenAPI	{"openapi":"3.0.0","info":{"title":"API Definitions API","description":"Use the \"API Definitions\" API to manage your APIs by using the NGINX Controller API Management module.","version":"v1"},"servers":[{"description":"NGINX Controller API","url":"https://{{CONTROLLER_FQDN}}/api/v1"}],"paths":{"/services/api-definitions":{"get":{"tags":["API Definitions"],"summary":"List API Definitions","description":"Returns a list of API Definition resources.","operationId":"apiDefinitionsSearch","responses":{"200":{"description":"Successfully retrieved a list of all API Definitions.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIDefinitionList"}}}}}}},"/services/api-definitions/{apiDefinitionName}":{"get":{"tags":["API Definitions"],"summary":"Get an API Definition","description":"Gets information about a specified API Definition.\n","operationId":"apiDefinitionsGet","responses":{"200":{"description":"Successfully returned the specified API Definition resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIDefinition"}}}},"404":{"description":"The specified API Definition resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}}}},"put":{"tags":["API Definitions"],"summary":"Upsert an API Definition","description":"Creates a new API Definition or updates an existing API Definition resource.\n","operationId":"apiDefinitionsPut","requestBody":{"description":"Defines the API Definition resource to create, or the updates to apply to an existing API Definition resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIDefinition"}}}},"responses":{"200":{"description":"Successfully updated the specified API Definition resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIDefinition"}}}},"201":{"description":"Successfully created the requested API Definition resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIDefinition"}}}},"400":{"description":"Bad input parameter, or possibly a bad URI. Check the input for typos and try again.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}}}},"delete":{"tags":["API Definitions"],"summary":"Delete an API Definition","description":"Deletes the specified API Definition resource.","operationId":"apiDefinitionsDelete","responses":{"204":{"description":"Successfully deleted the requested API Definition resource. No content is returned.\n"},"404":{"description":"The specified API Definition resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"409":{"description":"Failed to delete the specified API Definition resource. Delete any referenced Published APIs or remove the references, then try again.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}}}},"parameters":[{"$ref":"#/components/parameters/apiDefinitionName"}]},"/services/api-definitions/{apiDefinitionName}/versions":{"get":{"tags":["API Definition Versions"],"summary":"List API Definition Versions","description":"Lists all Versions for the specified API Definition resource.\n","operationId":"definitionVersionsSearch","responses":{"200":{"description":"Successfully retrieved the list of API Definition Version resources.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIDefinitionVersionList"}}}},"404":{"description":"The specified API Definition resource was not found or does not contain any Versions.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}}}},"put":{"tags":["API Definition Versions"],"summary":"Add an API Definition Version","description":"Creates a single new API Definition Version resource or multiple Version resources.\n","operationId":"definitionVersionsPutList","requestBody":{"description":"Creates, updates, or deletes an API Definition Version resource. It interacts with a list of items.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIDefinitionVersionList"}}}},"responses":{"200":{"description":"Successfully received the request to create the API Definition Version resource(s).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIDefinitionVersionList"}}}},"400":{"description":"Bad input parameter, or possibly a bad URI. Check the input for typos and try again.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"409":{"description":"Failed to delete the specified API Definition Version resource(s) as it has at least one dependent Published API. Delete the referenced Published API(s), then try again.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}}}},"delete":{"tags":["API Definition Versions"],"summary":"Delete API Definition Versions","description":"Deletes all Versions for the specified API Definition resource.\n","operationId":"definitionVersionsDeleteList","responses":{"204":{"description":"Successfully deleted the Versions for the requested API Definition resource. No content is returned.\n"},"404":{"description":"The specified API Definition resource was not found or does not contain any Versions.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"409":{"description":"Failed to delete the Versions for the specified API Definition resource. Delete or remove any references to Published APIs, then try again.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}}}},"parameters":[{"$ref":"#/components/parameters/apiDefinitionName"}]},"/services/api-definitions/{apiDefinitionName}/versions/{version}":{"get":{"tags":["API Definition Versions"],"summary":"Get an API Definition Version","description":"Gets information about an API Definition Version resource.\n","operationId":"definitionVersionsGet","responses":{"200":{"description":"Successfully returned the specified API Definition Version resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIDefinitionVersion"}}}},"404":{"description":"The specified API Definition Version resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}}}},"put":{"tags":["API Definition Versions"],"summary":"Upsert an API Definition Version","description":"Creates a single new Version resource or updates an existing API Definition Version resource.\n","operationId":"definitionVersionsPut","requestBody":{"description":"Creates or updates an API Definition Version resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIDefinitionVersion"}}}},"responses":{"200":{"description":"Successfully updated the specified API Definition Version resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIDefinitionVersion"}}}},"201":{"description":"Successfully created the requested API Definition Version resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIDefinitionVersion"}}}},"400":{"description":"Bad input parameter, or possibly a bad URI. Check the input for typos and try again.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}}}},"delete":{"tags":["API Definition Versions"],"summary":"Delete an API Definition Version","description":"Deletes an API Definition Version resource.\n","operationId":"definitionVersionsDelete","responses":{"204":{"description":"Successfully deleted the API Definition Version resource.\n"},"404":{"description":"The specified API Definition Version resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"409":{"description":"Failed to delete the specified API Definition resource. Delete or remove any references to Published APIs, then try again.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}}}},"parameters":[{"$ref":"#/components/parameters/apiDefinitionName"},{"$ref":"#/components/parameters/versionName"}]},"/services/api-definitions/{apiDefinitionName}/versions/{version}/import":{"put":{"tags":["API Definition Version Import"],"summary":"Import an API Definition Version","description":"Imports an API spec to the specified Version of an API Definition.\n\nUse this endpoint to import a raw API specification to define your API.\n\n- This endpoint accepts a valid OpenAPI 3 spec, formatted as valid JSON or YAML.\n- The file provided for import will be validated against the\n [OAS v3 schema](https://github.com/OAI/OpenAPI-Specification/blob/master/schemas/v3.0/schema.yaml).\n- You must specify a \"Content-Type\" header when importing an API spec.\n The endpoint accepts the following \"Content-Type\" values:\n\n - application/json\n - application/yaml\n - text/x-yaml\n - application/x-yaml\n - text/yaml\n - application/xml\n - text/xml\n","operationId":"definitionVersionsImport","requestBody":{"content":{"application/json":{"schema":{"type":"object"}},"application/yaml":{"schema":{"type":"string"}},"text/x-yaml":{"schema":{"type":"string"}},"application/x-yaml":{"schema":{"type":"string"}},"text/yaml":{"schema":{"type":"string"}},"application/xml":{"schema":{"type":"string"}},"text/xml":{"schema":{"type":"string"}}}},"responses":{"200":{"description":"Successfully completed the API Version Import request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIDefinitionVersion"}}}},"201":{"description":"Successfully created the requested API Definition Version resource from the spec provided.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIDefinitionVersion"}}}},"400":{"description":"Bad input parameter, or possibly a bad URI. Check the input for typos and try again.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"415":{"description":"The request body contains an unsupported content type.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}}}},"parameters":[{"$ref":"#/components/parameters/apiDefinitionName"},{"$ref":"#/components/parameters/versionName"}]}},"components":{"schemas":{"APIDefinition":{"type":"object","properties":{"metadata":{"$ref":"#/components/schemas/ResourceMeta"},"currentStatus":{"$ref":"#/components/schemas/APIDefinitionCurrentStatus"}}},"APIDefinitionCurrentStatus":{"type":"object","properties":{"apiDefinitionVersionRefs":{"type":"array","items":{"$ref":"#/components/schemas/ResourceRef"}}}},"APIDefinitionList":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/APIDefinition"}}}},"APIDefinitionSpecMapping":{"type":"object","additionalProperties":{"anyOf":[{"$ref":"#/components/schemas/RESTAPISpec"},{"$ref":"#/components/schemas/gRPCProxySpec"},{"$ref":"#/components/schemas/SOAPAPISpec"}]}},"RESTAPISpec":{"type":"object","description":"Validates an Imported OpenAPI 3 spec formatted as JSON using the [OAS v3 schema.yaml](https://github.com/OAI/OpenAPI-Specification/blob/master/schemas/v3.0/schema.yaml) specification.\n"},"SOAPAPISpec":{"type":"object","description":"Validates and Transforms an Imported WSDL spec.\n","properties":{"wsdl":{"type":"string"},"soap-config":{"$ref":"#/components/schemas/SoapConfig"}},"required":["soap-config"]},"SoapConfig":{"type":"object","description":"Transformed WSDL to OpenAPI spec config.\n","properties":{"name":{"type":"string"},"url":{"type":"string"},"tns":{"type":"string"},"qualifiedFields":{"type":"boolean"},"endpoints":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/SoapConfigEndpoint"}},"types":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/SoapConfigWSDLType"}},"messages":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/SoapConfigMessage"}}},"required":["name","url","tns","endpoints","types","messages","qualifiedFields"]},"SoapConfigEndpoint":{"type":"object","properties":{"name":{"type":"string"},"in":{"type":"string"},"out":{"type":"string"},"enabled":{"type":"boolean"},"restHTTPMethod":{"type":"string","enum":["get","head","post","put","patch","delete"]},"restURI":{"type":"string"}},"required":["name","in","out","enabled","restHTTPMethod","restURI"]},"SoapConfigMessage":{"type":"object","description":"Validates and Transforms an Imported WSDL spec.\n","properties":{"name":{"type":"string"},"parts":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/SoapConfigMessagePart"}}},"required":["name","parts"]},"SoapConfigMessagePart":{"type":"object","properties":{"name":{"type":"string"},"restName":{"type":"string"},"type":{"type":"string"},"ref":{"type":"string"}},"required":["name","restName"]},"SoapConfigWSDLType":{"type":"object","properties":{"name":{"type":"string"},"type":{"type":"string"},"properties":{"type":"array","items":{"$ref":"#/components/schemas/SoapConfigNestedWSDLType"}},"hasOneOfProperties":{"type":"boolean"},"hasOrderedProperties":{"type":"boolean"},"enum":{"type":"array","items":{"type":"string"}}},"required":["name","type","hasOneOfProperties","hasOrderedProperties"]},"SoapConfigNestedWSDLType":{"type":"object","properties":{"name":{"type":"string"},"restName":{"type":"string"},"type":{"type":"string"},"ref":{"type":"string"},"isRequired":{"type":"boolean"},"isArray":{"type":"boolean"}},"required":["name","restName","isRequired","isArray"]},"gRPCProxySpec":{"x-f5-experimental":true,"type":"object","description":"Validates an Imported gRPC spec.\n"},"APIDefinitionVersion":{"type":"object","properties":{"metadata":{"$ref":"#/components/schemas/APIDefinitionVersionMeta"},"desiredState":{"$ref":"#/components/schemas/APIDefinitionVersionDesiredState"},"currentStatus":{"$ref":"#/components/schemas/APIDefinitionVersionCurrentStatus"}}},"APIDefinitionVersionList":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/APIDefinitionVersion"}}}},"APIDefinitionVersionDesiredState":{"type":"object","properties":{"specs":{"$ref":"#/components/schemas/APIDefinitionSpecMapping"}}},"APIDefinitionVersionCurrentStatus":{"type":"object","properties":{"specs":{"$ref":"#/components/schemas/APIDefinitionSpecMapping"},"state":{"$ref":"#/components/schemas/ConfigState"},"publishedApiRefs":{"type":"array","items":{"$ref":"#/components/schemas/ResourceRef"}}}},"apiDefinitionVersionRef":{"type":"object","properties":{"ref":{"type":"string","description":"Reference to the Version of the API Definition.\n","example":"/services/api-definitions/baseball-stats/versions/v1"},"links":{"$ref":"#/components/schemas/NamedLinks"}}},"APIDefinitionVersionMeta":{"allOf":[{"$ref":"#/components/schemas/ResourceMeta"},{"type":"object","properties":{"isDefaultVersion":{"type":"boolean"}}}]},"SelfLinks":{"type":"object","description":"The SelfLinks object contains a link from the resource to itself.\nThis object is used only in responses.\n","properties":{"rel":{"type":"string","example":"/api/v1/services/environments/prod","description":"`rel` contains the complete path fragment of a URI and can be used\nto construct a query to the object.\n"}}},"ResourceMeta":{"type":"object","required":["name"],"properties":{"name":{"type":"string","pattern":"^[^A-Z\\s\\x00-\\x1f\\x60\\x7f\\;\\*\\\"\\[\\]\\{\\}\\\\\\/%\\?:=&\\~\\^|#<>]+$","minLength":1,"maxLength":1024,"example":"resource-name","description":"Resource name is a unique identifier for a resource within the context of a namespace.\nResource names must conform to [RFC 1738 Section 2.2](https://www.ietf.org/rfc/rfc1738.txt) and have a valid syntax for email addresses. The following rules are enforced:\n\n- do not utilize URL encoding;\n- do not include spaces;\n- do not use uppercase characters, for example, 'A-Z'; extended character sets are supported;\n- do not use the following characters: `\"`, `*`, `:`, `;`, `/`, `\\`, `%`, `?`, `hash`, `=`, `&`, `|`, `~`, `^`, `{`, `}`, `[`, `]`, `<`, `>`;\n- cannot start or end with an `@` sign;\n\nFor example: For a collection resource located at\n\n`https://controller.example.com/api/v1/services/apps/shopping_@1`\n\nthe resource name is \"shopping_@1\".\n"},"displayName":{"type":"string","example":"My Display Name","description":"`displayName` is a user friendly resource name. It can be used to define \na longer, and less constrained, name for a resource.\n\nDisplay names:\n\n- are optional (defaults to an empty string if no value is provided),\n- do not have to be unique, \n- cannot be assigned by the server.\n"},"description":{"type":"string","example":"This is a sample description string. It provides information about the resource.","description":"`description` is a free-form text property. You can use it to provide information that helps \nto identify the resource.\n\nDescriptions:\n\n- are optional (defaults to an empty string if no value is provided),\n- do not have to be unique, \n- cannot be assigned by the server.\n"},"kind":{"type":"string","example":"<collection>-<object>","description":"Kind is a string representation of an API resource's data type.\nIt is assigned by the server and cannot be changed. \n\nWhen creating a `kind`, the server uses hyphens to connect word segments; \nsingleton and collection item resources are not pluralized.\n"},"uid":{"type":"string","format":"uuid","example":"d290f1ee-6c54-4b01-90e6-d701748f0851","description":"Unique Identifier (UID)\n\nUID is a unique identifier in time and space for a resource. \nWhen you create a resource, the server assigns a UID to the resource.\n\nRefer to [IETF RFC 4122](https://tools.ietf.org/html/rfc4122) for more information.\n"},"tags":{"type":"array","items":{"type":"string"},"example":["production_public","dev","new_app","us-west-1","emea"],"description":"You can assign `tags` to a resource as a way to help map, scope, \nand organize resources. \n\nThe system uses tag selectors to specify selection criteria that \nmatch resources that have particular tags.\n"},"ref":{"type":"string","example":"/services/environments/prod","description":"The `ref` field contains a reference to another NGINX Controller resource.\n"},"links":{"$ref":"#/components/schemas/SelfLinks"},"createTime":{"type":"string","format":"date-time","example":"2019-07-29T09:12:33.001Z","description":"A timestamp that represents the server time when the resource was created.\n\nCreate time is not guaranteed to be set in \"happens-before\" order\nacross separate operations.\n\nIn JSON format, `create_time` type is encoded as a string in the\n[RFC 3339](https://www.ietf.org/rfc/rfc3339.txt).\n\nFor example: 2018-04-01T01:30:15.01Z\n\nCreate Time is assigned by the server and cannot be changed.\n"},"updateTime":{"type":"string","format":"date-time","example":"2019-07-29T10:12:33.001Z","description":"A timestamp that represents the server time when the resource was last modified.\n\nResources that have never been updated do not have an `update_time` stamp.\n\nThe default value for resources that have never been updated is the local \nlanguage-specific equivalent of \"null\".\n\nIn JSON format, `update_time` type is encoded as a string as described in \n[RFC 3339](https://www.ietf.org/rfc/rfc3339.txt).\n"}}},"NamedLinks":{"allOf":[{"$ref":"#/components/schemas/SelfLinks"},{"type":"object","description":"Contains information about the object being referred to.\n\nThese are generally details -- like the object name and display name --\nthat are useful to a consumer of the API that performs further\nprocessing. \n\nThis object is only present in responses.\n \n","properties":{"name":{"type":"string","example":"production","description":"The name of the linked resource.\n"},"displayName":{"type":"string","example":"Production Environment","description":"A user friendly resource name."}}}]},"ResourceRef":{"type":"object","required":["ref"],"properties":{"ref":{"type":"string","example":"/services/environments/prod","description":"A reference to another NGINX Controller resource.\n"},"links":{"$ref":"#/components/schemas/NamedLinks"}}},"ErrorDetail":{"type":"object","required":["description"],"properties":{"description":{"type":"string","example":"Error doing <action>: <reason for error>. This can lead to <potential consequences>. Try <action> to resolve the issue.","description":"A detailed error message returned by the server. \n\nThese messages contain the following information, where applicable:\n\n- What happened.\n- Why it happened.\n- What the consequences are (if any).\n- Recommended action to take to resolve the issue.\n"}}},"ErrorModel":{"type":"object","required":["message","code"],"properties":{"message":{"type":"string","example":"Error doing <action>.","description":"A human-readable message, in English, that describes the error.\n"},"code":{"type":"integer","example":1234567,"description":"A numeric error code that can be used to identify errors for support purposes.\n"},"details":{"type":"array","items":{"$ref":"#/components/schemas/ErrorDetail"}}}},"ConfigStateTally":{"type":"object","properties":{"isConfigured":{"type":"boolean","description":"The configuration operation is complete."},"isConfiguring":{"type":"boolean","description":"The configuration of the resource, or of its child(ren), is in process."},"isError":{"type":"boolean","description":"An error occurred while configuring the resource or its child(ren)."},"isDeleting":{"type":"boolean","description":"A delete operation is in progress for the resource or its child(ren)."},"total":{"type":"integer","description":"The total number of resources to which the configuration operation applies."},"configured":{"type":"integer","description":"The number of resources that have a complete and valid configuration."},"configuring":{"type":"integer","description":"The number of resources that are in the process of being configured."},"error":{"type":"integer","description":"The number of resources that have encountered an error during the configuration process."},"deleting":{"type":"integer","description":"The number of resources that are in the process of being deleted."}}},"ConfigCondition":{"type":"object","properties":{"type":{"type":"string","description":"The condition type."},"message":{"type":"string","description":"A human-readable message that provides additional information about the configuration operation."}}},"ConfigState":{"type":"object","description":"A representation of the resource's current configuration state \nthat comprises the status of the resource itself (`selfConfigState`) and any child \nresources (`childrenConfigState`).\n\nThe conditions array provides additional information during configuration changes.\n","properties":{"selfConfigState":{"$ref":"#/components/schemas/ConfigStateTally"},"childrenConfigState":{"$ref":"#/components/schemas/ConfigStateTally"},"conditions":{"type":"array","items":{"$ref":"#/components/schemas/ConfigCondition"}}}},"EnvironmentName":{"type":"string"},"AppName":{"type":"string"}},"parameters":{"environmentName":{"name":"environmentName","description":"The name of the Environment that contains the Component's parent App.","in":"path","required":true,"schema":{"$ref":"#/components/schemas/EnvironmentName"}},"appName":{"name":"appName","description":"The name of the App that contains the Component resource.","in":"path","required":true,"schema":{"$ref":"#/components/schemas/AppName"}},"apiDefinitionName":{"name":"apiDefinitionName","in":"path","description":"The name of the API Definition resource.","required":true,"style":"simple","explode":false,"example":"shopping-app-api-def","schema":{"type":"string"}},"publishedApiName":{"name":"publishedApiName","in":"path","description":"The name of the Published API resource.","required":true,"style":"simple","explode":false,"example":"shopping-app-api-staging","schema":{"type":"string"}},"versionName":{"name":"version","in":"path","description":"The Version of the API Definition.","required":true,"style":"simple","explode":false,"example":"v1_2fd4e1c6","schema":{"type":"string"}}}}}
/ services / api-definitions
/ services / api-definitions / {apiDefinitionName}
/ services / api-definitions / {apiDefinitionName} / versions
/ services / api-definitions / {apiDefinitionName} / versions / {version}
/ services / api-definitions / {apiDefinitionName} / versions / {version} / import
Components API OpenAPI	{"openapi":"3.0.0","servers":[{"description":"NGINX Controller API","url":"https://{{CONTROLLER_FQDN}}/api/v1"}],"info":{"title":"Components API","description":"Use the Components API to define child components (for example, microservices) for your Apps.","version":"v1"},"paths":{"/services/environments/{environmentName}/apps/{appName}/components":{"get":{"tags":["Components"],"summary":"List all Components","description":"Returns a list of all of the Component resources that are contained by the specified App.\n","operationId":"listAppComponents","responses":{"200":{"description":"Successfully retrieved a list of Component resources.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ComponentList"}}}},"400":{"description":"Bad input parameter, or possibly a bad URI. Check the input for typos and try again.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"404":{"description":"The resource defined in the URI could not be found. Check the URI for errors and try again.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}}}},"post":{"tags":["Components"],"summary":"Create a Component","description":"Creates a new Component resource.\n","operationId":"createAppComponent","requestBody":{"description":"Defines the Component resource to create.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Component"},"examples":{"ComponentRequest":{"$ref":"#/components/examples/ComponentRequest"}}}}},"responses":{"201":{"description":"Successfully created the requested Component resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Component"}}}},"202":{"description":"The Component resource has been accepted for creation. The Component will be created after it is done configuring.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Component"}}}},"400":{"description":"Bad input parameter, or possibly a bad URI. Check the input for typos and try again.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"404":{"description":"The resource defined in the URI could not be found. Check the URI for errors and try again.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"409":{"description":"The request failed due to a conflict with an existing resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"429":{"description":"The request to create a Component resource failed due to exceeding request processing threshold.\nAllow the server to process existing requests, then try again.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}}}},"parameters":[{"name":"environmentName","description":"The name of the Environment that contains the Component's parent App.","in":"path","required":true,"schema":{"$ref":"#/components/schemas/EnvironmentName"}},{"name":"appName","description":"The name of the App that contains the Component resource.","in":"path","required":true,"schema":{"$ref":"#/components/schemas/AppName"}}]},"/services/environments/{environmentName}/apps/{appName}/components/{componentName}":{"get":{"tags":["Components"],"summary":"Get a Component","description":"Returns information for the specified Component.\n","operationId":"getAppComponent","responses":{"200":{"description":"Successfully returned the requested Component resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Component"}}}},"400":{"description":"Bad input parameter, or possibly a bad URI. Check the input for typos and try again.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"404":{"description":"The resource defined in the URI could not be found. Check the URI for errors and try again.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}}}},"put":{"tags":["Components"],"summary":"Upsert a Component","description":"Creates a new Component or updates an existing Component resource.\n","operationId":"updateAppComponent","requestBody":{"description":"Defines the Component resource to create or update.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Component"},"examples":{"ComponentRequest":{"$ref":"#/components/examples/ComponentRequest"}}}}},"responses":{"200":{"description":"Successfully updated the specified Component resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Component"}}}},"201":{"description":"Successfully created the specified Component resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Component"}}}},"202":{"description":"The Component resource has been accepted for creation or update. The Component will be created or updated after it is done configuring.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Component"}}}},"400":{"description":"Bad input parameter, or possibly a bad URI. Check the input for typos and try again.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"404":{"description":"The resource defined in the URI could not be found. Check the URI for errors and try again.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"409":{"description":"The request failed due to a conflict with an existing resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"429":{"description":"The request to update or create a Component resource failed due to exceeding request processing threshold.\nAllow the server to process existing requests, then try again.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}}}},"delete":{"tags":["Components"],"summary":"Delete a Component","description":"Deletes the specified Component resource.","operationId":"deleteAppComponent","responses":{"202":{"description":"Component resource has been marked for deletion. The resource will be\ndeleted after the underlying resources have been freed.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Component"}}}},"204":{"description":"Successfully deleted the specified Component. No content returned.\n"},"404":{"description":"The resource defined in the URI could not be found. Check the URI for errors and try again.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"429":{"description":"The request to delete a Component resource failed due to exceeding request processing threshold.\nAllow the server to process existing requests, then try again.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}}}},"parameters":[{"name":"environmentName","description":"The name of the Environment that contains the Component's parent App.","in":"path","required":true,"schema":{"$ref":"#/components/schemas/EnvironmentName"}},{"name":"appName","description":"The name of the App that contains the Component resource.","in":"path","required":true,"schema":{"$ref":"#/components/schemas/AppName"}},{"name":"componentName","description":"The name of the Component resource.","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ComponentName"}}]}},"components":{"schemas":{"ComponentList":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/Component"}}}},"EnvironmentName":{"type":"string"},"AppName":{"type":"string"},"SelfLinks":{"type":"object","description":"The SelfLinks object contains a link from the resource to itself.\nThis object is used only in responses.\n","properties":{"rel":{"type":"string","example":"/api/v1/services/environments/prod","description":"`rel` contains the complete path fragment of a URI and can be used\nto construct a query to the object.\n"}}},"ResourceMeta":{"type":"object","required":["name"],"properties":{"name":{"type":"string","pattern":"^[^A-Z\\s\\x00-\\x1f\\x60\\x7f\\;\\*\\\"\\[\\]\\{\\}\\\\\\/%\\?:=&\\~\\^|#<>]+$","minLength":1,"maxLength":1024,"example":"resource-name","description":"Resource name is a unique identifier for a resource within the context of a namespace.\nResource names must conform to [RFC 1738 Section 2.2](https://www.ietf.org/rfc/rfc1738.txt) and have a valid syntax for email addresses. The following rules are enforced:\n\n- do not utilize URL encoding;\n- do not include spaces;\n- do not use uppercase characters, for example, 'A-Z'; extended character sets are supported;\n- do not use the following characters: `\"`, `*`, `:`, `;`, `/`, `\\`, `%`, `?`, `hash`, `=`, `&`, `|`, `~`, `^`, `{`, `}`, `[`, `]`, `<`, `>`;\n- cannot start or end with an `@` sign;\n\nFor example: For a collection resource located at\n\n`https://controller.example.com/api/v1/services/apps/shopping_@1`\n\nthe resource name is \"shopping_@1\".\n"},"displayName":{"type":"string","example":"My Display Name","description":"`displayName` is a user friendly resource name. It can be used to define \na longer, and less constrained, name for a resource.\n\nDisplay names:\n\n- are optional (defaults to an empty string if no value is provided),\n- do not have to be unique, \n- cannot be assigned by the server.\n"},"description":{"type":"string","example":"This is a sample description string. It provides information about the resource.","description":"`description` is a free-form text property. You can use it to provide information that helps \nto identify the resource.\n\nDescriptions:\n\n- are optional (defaults to an empty string if no value is provided),\n- do not have to be unique, \n- cannot be assigned by the server.\n"},"kind":{"type":"string","example":"<collection>-<object>","description":"Kind is a string representation of an API resource's data type.\nIt is assigned by the server and cannot be changed. \n\nWhen creating a `kind`, the server uses hyphens to connect word segments; \nsingleton and collection item resources are not pluralized.\n"},"uid":{"type":"string","format":"uuid","example":"d290f1ee-6c54-4b01-90e6-d701748f0851","description":"Unique Identifier (UID)\n\nUID is a unique identifier in time and space for a resource. \nWhen you create a resource, the server assigns a UID to the resource.\n\nRefer to [IETF RFC 4122](https://tools.ietf.org/html/rfc4122) for more information.\n"},"tags":{"type":"array","items":{"type":"string"},"example":["production_public","dev","new_app","us-west-1","emea"],"description":"You can assign `tags` to a resource as a way to help map, scope, \nand organize resources. \n\nThe system uses tag selectors to specify selection criteria that \nmatch resources that have particular tags.\n"},"ref":{"type":"string","example":"/services/environments/prod","description":"The `ref` field contains a reference to another NGINX Controller resource.\n"},"links":{"$ref":"#/components/schemas/SelfLinks"},"createTime":{"type":"string","format":"date-time","example":"2019-07-29T09:12:33.001Z","description":"A timestamp that represents the server time when the resource was created.\n\nCreate time is not guaranteed to be set in \"happens-before\" order\nacross separate operations.\n\nIn JSON format, `create_time` type is encoded as a string in the\n[RFC 3339](https://www.ietf.org/rfc/rfc3339.txt).\n\nFor example: 2018-04-01T01:30:15.01Z\n\nCreate Time is assigned by the server and cannot be changed.\n"},"updateTime":{"type":"string","format":"date-time","example":"2019-07-29T10:12:33.001Z","description":"A timestamp that represents the server time when the resource was last modified.\n\nResources that have never been updated do not have an `update_time` stamp.\n\nThe default value for resources that have never been updated is the local \nlanguage-specific equivalent of \"null\".\n\nIn JSON format, `update_time` type is encoded as a string as described in \n[RFC 3339](https://www.ietf.org/rfc/rfc3339.txt).\n"}}},"NginxDirective":{"x-f5-experimental":true,"required":["directive"],"properties":{"directive":{"type":"string","description":"The name of the NGINX directive. For a list of NGINX Directives, refer to [the NGINX documentation](http://nginx.org/en/docs/dirindex.html).\n"},"args":{"type":"array","description":"Directive arguments.","items":{"type":"string"}},"block":{"type":"array","description":"The directives to include within a block directive or context.","items":{"$ref":"#/components/schemas/NginxDirective"}}}},"NginxConf":{"x-f5-experimental":true,"required":["path","op","block"],"properties":{"path":{"type":"string","description":"Path is a JSONPath expression. See [goessner.net/articles/JsonPath](https://goessner.net/articles/JsonPath/) for more information on JSONPath.\n","example":"$..[?(@.directive=='server')]"},"op":{"type":"string","description":"Indicates where to insert the block of directives in relation to the directives\nselected by the given path.\n\n* `APPEND` - Add after the selected directives\n\n* `APPEND_CHILD` - Add after the last directive in the selected directives' block\n\n* `PREPEND` - Add before the selected directives\n\n* `PREPEND_CHILD` - Add before the first directive in the selected directives' block\n","enum":["APPEND","APPEND_CHILD","PREPEND","PREPEND_CHILD"]},"block":{"type":"array","description":"Block contains a list of directives that you want to add to the NGINX configuration.\n","items":{"$ref":"#/components/schemas/NginxDirective"}}}},"NginxConfs":{"x-f5-experimental":true,"description":"NGINX raw configuration","type":"array","items":{"$ref":"#/components/schemas/NginxConf"}},"ComponentStateCommon":{"type":"object","description":"Settings common to Web & TCP/UDP Components.","properties":{"nginxConfs":{"$ref":"#/components/schemas/NginxConfs"}}},"URIMatchMethod":{"description":"Specifies how to determine a match between an incoming Web URI and configured Web URI.","type":"string","enum":["PREFIX","REGEX","REGEX_CASE_SENSITIVE","SUFFIX","EXACT"],"default":"PREFIX"},"NamedLinks":{"allOf":[{"$ref":"#/components/schemas/SelfLinks"},{"type":"object","description":"Contains information about the object being referred to.\n\nThese are generally details -- like the object name and display name --\nthat are useful to a consumer of the API that performs further\nprocessing. \n\nThis object is only present in responses.\n \n","properties":{"name":{"type":"string","example":"production","description":"The name of the linked resource.\n"},"displayName":{"type":"string","example":"Production Environment","description":"A user friendly resource name."}}}]},"ResourceRef":{"type":"object","required":["ref"],"properties":{"ref":{"type":"string","example":"/services/environments/prod","description":"A reference to another NGINX Controller resource.\n"},"links":{"$ref":"#/components/schemas/NamedLinks"}}},"ServiceConfigState":{"type":"string","enum":["ENABLED","DISABLED"],"default":"DISABLED"},"TLS":{"description":"TLS settings applicable to URIs.","type":"object","required":["certRef"],"properties":{"certRef":{"$ref":"#/components/schemas/ResourceRef"},"protocols":{"type":"array","items":{"type":"string","pattern":"TLSv1|TLSv1\\.[1-3]|SSLv2|SSLv3"}},"cipher":{"type":"string","example":"ALL:!aNULL:!EXPORT56:RC4+RSA:+HIGH:+MEDIUM:+LOW:+SSLv2:+EXP;"},"preferServerCipher":{"$ref":"#/components/schemas/ServiceConfigState"},"sessionCache":{"type":"string","enum":["OFF","NONE","BUILTIN","SHARED"],"default":"OFF"}}},"IngressUri":{"type":"object","properties":{"matchMethod":{"$ref":"#/components/schemas/URIMatchMethod"},"tls":{"$ref":"#/components/schemas/TLS"},"serverPoolPort":{"x-f5-experimental":true,"description":"The port number used when the IngressUri is deployed to an Instance that's a member of a BIG-IP server pool.","type":"integer"}}},"IngressUris":{"type":"object","description":"Defines the URI in Gateways and Components. The URI has different requirements depending on where it is used.\n\nFor Web URIs in Gateways, `uris` must be a complete URI that follows the format `<http|https>://host[:port]`;\nadditionally each URI can have a match method specified and an HTTPS URI can include TLS information.\n Examples:\n - `http://www.f5.com`\n - `https://www.f5.com`\n - `http://www.f5.com:8080`\n - `http://*.info.f5.com`\n\nFor Web URIs in Components, `uris` can be either a complete URI that follows the format `<http|https>://host[:port][/path]`\nor a relative path that follows the format `/path[/...]`;\nadditionally each URI can have a match method specified and an HTTPS URI can include TLS information.\n Examples:\n - `/images`\n - `/*.jpg`\n - `/locations/us/wa*`\n - `http://www.f5.com:8080/sales`\n - `http://*.f5.com:5050/testing`\n\nFor TCP/UDP URIs in Gateways and Components,`uris` must be a complete URI that follows the format `<tcp|udp|tcp+tls>://<*|IP>:<port|portRange>`;\nadditionally a tcp+tls URI can include TLS information. Match method is not applicable to TCP/UDP URIs.\n Examples:\n - `tcp://192.168.1.1:12345`\n - `tcp+tls://192.168.1.1:12346`\n - `tcp://192.168.1.1:12345-12350`\n - `tcp://*:12345`\n - `udp://192.168.1.1:12345`\n - `udp://*:12345`\n\nIn a TCP/UDP Component, URIs can either all have a protocol of udp or a mix of TCP and tcp+tls.\n","additionalProperties":{"description":"Provide the URI associated with the resource.","$ref":"#/components/schemas/IngressUri"}},"ComponentIngressCommon":{"description":"Ingress settings common to Web and TCP/UDP components.","type":"object","required":["uris"],"properties":{"uris":{"$ref":"#/components/schemas/IngressUris"},"gatewayRefs":{"description":"Reference(s) to existing Gateway resource(s).","type":"array","items":{"$ref":"#/components/schemas/ResourceRef"}},"tls":{"$ref":"#/components/schemas/TLS"}}},"HeaderMatchMethod":{"type":"string","enum":["PREFIX","REGEX","REGEX_CASE_SENSITIVE","SUFFIX","EXACT"],"default":"REGEX"},"IngressHeader":{"type":"object","properties":{"name":{"type":"string"},"nameMatchMethod":{"$ref":"#/components/schemas/HeaderMatchMethod"},"value":{"type":"string"},"valueMatchMethod":{"$ref":"#/components/schemas/HeaderMatchMethod"}}},"WebIngressCommon":{"description":"Ingress settings in a Gateway and Component that apply only to Web Components.","type":"object","properties":{"methods":{"description":"Specifies the HTTP method to use in requests.","type":"array","items":{"type":"string","enum":["POST","GET","PUT","DELETE","PATCH","HEAD","TRACE","OPTIONS","CONNECT"]}},"clientMaxBodySize":{"description":"Sets the maximum allowed size of the client request body, specified in the “Content-Length” request header field.","type":"string","pattern":"^[0-9]+[k|K|m|M]{1}$","deprecated":true,"externalDocs":{"url":"https://nginx.org/en/docs/http/ngx_http_core_module.html#client_max_body_size"}},"headers":{"description":"Specifies the match method for headers to be used in requests.","x-f5-experimental":true,"type":"array","items":{"$ref":"#/components/schemas/IngressHeader"}},"http2":{"description":"Enable or disable HTTP/2 connections on the port. Normally, for this to work the `ssl` parameter should be specified as well,\nbut NGINX can also be configured to accept HTTP/2 connections without SSL.\nPossible values are `ENABLED` or `DISABLED`.\n","x-f5-experimental":true,"$ref":"#/components/schemas/ServiceConfigState","externalDocs":{"url":"https://nginx.org/en/docs/http/ngx_http_core_module.html#listen"}},"spdy":{"description":"Enables or disables acceptance of the SPDY connections on the specified port.\nNormally, for this to work the `ssl` parameter should be specified as well,\nbut NGINX can also be configured to accept SPDY connections without SSL. Possible values are `ENABLED` or `DISABLED`.\n","x-f5-experimental":true,"$ref":"#/components/schemas/ServiceConfigState","externalDocs":{"url":"https://nginx.org/en/docs/http/ngx_http_core_module.html#listen"}},"proxyProtocol":{"description":"Enables or disables the proxy protocol for all connections accepted on the specified port.\nThe `proxy protocol` enables NGINX and NGINX Plus to receive client connection information passed through proxy servers and load balancers,\nsuch as HAproxy and Amazon Elastic Load Balancer (ELB). The possible values are `ENABLED` or `DISABLED`.\n","x-f5-experimental":true,"$ref":"#/components/schemas/ServiceConfigState","externalDocs":{"url":"https://nginx.org/en/docs/http/ngx_http_core_module.html#listen"}},"notFoundStatusCode":{"x-f5-experimental":true,"type":"integer","default":404},"headersHashBucketSize":{"description":"Sets the bucket size for hash tables used by the `proxy_hide_header` and `proxy_set_header` directives.","type":"integer","minimum":1,"externalDocs":{"url":"https://nginx.org/en/docs/http/ngx_http_proxy_module.html#proxy_headers_hash_bucket_size"}},"headersHashMaxSize":{"description":"Sets the maximum size of hash tables used by the `proxy_hide_header` and `proxy_set_header` directives.","type":"integer","minimum":1,"externalDocs":{"url":"https://nginx.org/en/docs/http/ngx_http_proxy_module.html#proxy_headers_hash_max_size"}}}},"ComponentWebIngressClient":{"description":"Non-buffer settings in a Component applicable to Web client requests.","type":"object","properties":{"bodyInFileOnly":{"description":"Determines whether NGINX Controller should save the entire client request body into a file.","type":"string","enum":["ENABLED","DISABLED","CLEAN"],"default":"DISABLED","externalDocs":{"url":"https://nginx.org/en/docs/http/ngx_http_core_module.html#client_body_in_file_only"}},"bodyTimeout":{"description":"Defines a timeout for reading the client request body.","type":"string","pattern":"^[0-9]{1,12}[hms]?$","externalDocs":{"url":"https://nginx.org/en/docs/http/ngx_http_core_module.html#client_body_timeout"}},"maxBodySize":{"description":"Sets the maximum allowed size of the client request body, specified in the “Content-Length” request header field.\n\nDisables checking of client request body size when set to 0.\n","type":"string","pattern":"^[0-9]{1,12}[kKmM]?$","externalDocs":{"url":"https://nginx.org/en/docs/http/ngx_http_core_module.html#client_max_body_size"}}}},"WebIngressBuffersCommon":{"description":"Buffer settings common to a Gateway and Component applicable to web client requests.","type":"object","properties":{"clientBodyBufferingIsEnabled":{"description":"Enables or disables buffering of a client request body.","type":"boolean","externalDocs":{"url":"https://nginx.org/en/docs/http/ngx_http_proxy_module.html#proxy_request_buffering"}},"clientBodyBufferSize":{"description":"Sets the buffer size for reading the client request body.","type":"string","pattern":"^[0-9]{1,12}[kKmM]?$","externalDocs":{"url":"https://nginx.org/en/docs/http/ngx_http_core_module.html#client_body_buffer_size"}},"clientBodyInSingleBuffer":{"description":"Determines whether NGINX Controller should save the entire client request body in a single buffer.","type":"string","enum":["ENABLED","DISABLED"],"externalDocs":{"url":"https://nginx.org/en/docs/http/ngx_http_core_module.html#client_body_in_single_buffer"}}}},"ComponentWebIngress":{"description":"Ingress settings in a Web Component.","allOf":[{"$ref":"#/components/schemas/ComponentIngressCommon"},{"$ref":"#/components/schemas/WebIngressCommon"},{"type":"object","properties":{"client":{"$ref":"#/components/schemas/ComponentWebIngressClient"},"buffers":{"$ref":"#/components/schemas/WebIngressBuffersCommon"}}}]},"MonitoringCommon":{"description":"Monitor settings common to Web and TCP/UDP.","type":"object","properties":{"defaultState":{"type":"string","enum":["HEALTHY","UNHEALTHY"],"default":"HEALTHY"},"interval":{"type":"integer","minimum":1,"default":5},"consecutiveSuccessThreshold":{"type":"integer","minimum":1,"default":1},"consecutiveFailureThreshold":{"type":"integer","minimum":1,"default":1},"port":{"type":"integer","minimum":1,"maximum":65535}}},"MonitorResponseStatus":{"type":"object","properties":{"range":{"type":"object","properties":{"startCode":{"type":"integer","minimum":100,"maximum":599},"endCode":{"type":"integer","minimum":100,"maximum":599}}},"codes":{"type":"array","items":{"type":"integer","minimum":100,"maximum":599}},"match":{"type":"boolean","default":true}}},"MonitorResponseContent":{"type":"object","properties":{"content":{"type":"string"},"match":{"type":"boolean","default":true}}},"WebMonitorResponse":{"description":"Settings that define successful responses to a Web monitor.","type":"object","properties":{"status":{"$ref":"#/components/schemas/MonitorResponseStatus"},"headers":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/MonitorResponseContent"}},"body":{"$ref":"#/components/schemas/MonitorResponseContent"}}},"WebMonitoring":{"description":"Health monitor settings across all workload groups in a Web Component.","allOf":[{"$ref":"#/components/schemas/MonitoringCommon"},{"type":"object","properties":{"uri":{"description":"URI containing the relative path that the monitor probe is sent to; the host is specified in the URI in the workload group.","type":"string","default":"/"},"response":{"description":"Settings that define successful responses to a Web monitor.","$ref":"#/components/schemas/WebMonitorResponse"}}}]},"RoundRobinLB":{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["ROUND_ROBIN"]}}},"IPHashLB":{"type":"object","description":"IP Hash Load Balancing only applicable to Web Components.","required":["type"],"properties":{"type":{"type":"string","enum":["IPHASH"]}}},"LeastConnLB":{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["LEAST_CONNECTIONS"]}}},"HashLBMethod":{"type":"object","required":["type","userKey"],"properties":{"type":{"type":"string","enum":["HASH"]},"userKey":{"type":"string"},"consistentHash":{"$ref":"#/components/schemas/ServiceConfigState"}}},"LeastTimeLBMethod":{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["LEAST_TIME"]},"latencyParameter":{"type":"string","description":"Values applicable to a Web Component are: [HEADER, LAST_BYTE, LAST_BYTE_INFLIGHT];\nValues applicable to a TCP/UDP Component are: [CONNECT, FIRST_BYTE, LAST_BYTE, LAST_BYTE_INFLIGHT].\nThe default value is used for a web Component; there is no default for a TCP/UDP Component.\n","enum":["HEADER","CONNECT","FIRST_BYTE","LAST_BYTE","LAST_BYTE_INFLIGHT"],"default":"HEADER"}}},"RandomLBMethod":{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["RANDOM"]},"twoServerLBMethod":{"type":"string","description":"Values applicable to a Web Component are: [LEAST_CONNECTIONS, LEAST_TIME_HEADER, LEAST_TIME_LAST_BYTE];\nValues applicable to a TCP/UDP Component are: [LEAST_CONNECTIONS, LEAST_TIME_CONNECT, LEAST_TIME_FIRST_BYTE, LEAST_TIME_LAST_BYTE].\n","enum":["LEAST_CONNECTIONS","LEAST_TIME_HEADER","LEAST_TIME_CONNECT","LEAST_TIME_FIRST_BYTE","LEAST_TIME_LAST_BYTE"]}}},"LoadBalancingMethod":{"discriminator":{"propertyName":"type","mapping":{"ROUND_ROBIN":"#/components/schemas/RoundRobinLB","IPHASH":"#/components/schemas/IPHashLB","LEAST_CONNECTIONS":"#/components/schemas/LeastConnLB","HASH":"#/components/schemas/HashLBMethod","LEAST_TIME":"#/components/schemas/LeastTimeLBMethod","RANDOM":"#/components/schemas/RandomLBMethod"}},"oneOf":[{"$ref":"#/components/schemas/RoundRobinLB"},{"$ref":"#/components/schemas/IPHashLB"},{"$ref":"#/components/schemas/LeastConnLB"},{"$ref":"#/components/schemas/HashLBMethod"},{"$ref":"#/components/schemas/LeastTimeLBMethod"},{"$ref":"#/components/schemas/RandomLBMethod"}]},"DNSServiceDiscovery":{"required":["servers"],"properties":{"servers":{"type":"array","description":"Array of DNS servers. Possible options are:\n- An IPv4 address with an optional port number.\n Port 53 is used if not specified.\n For example, \"10.1.1.1\", \"10.1.1.1:5353\".\n- An IPv6 address with an optional port number.\n Port 53 is used if not specified.\n For example, \"[2001::1]\", \"[2001::1]:5353\",\n- Fully qualified domain name (FQDN). ASCII characters only.\n NGINX uses the OS name server configuration\n to identify the IP addresses of the DNS servers to use.\n","items":{"type":"string","pattern":"^(?:(?:(?:(?:25[0-5]|2[0-4]\\d|[01]?\\d\\d?)\\.){3}(?:25[0-5]|2[0-4]\\d|[01]?\\d\\d?)(?::(?:[1-9]|[1-5]?[0-9]{2,4}|6[1-4][0-9]{3}|65[1-4][0-9]{2}|655[1-2][0-9]|6553[1-5]))?$)|(?:\\[\\s*(?:(?:(?:[0-9a-fA-F]{1,4}:){7}(?:[0-9a-fA-F]{1,4}|:))|(?:(?:[0-9a-fA-F]{1,4}:){6}(?::[0-9a-fA-F]{1,4}|(?:(?:25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(?:\\.(?:25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(?:(?:[0-9a-fA-F]{1,4}:){5}(?:(?:(?::[0-9a-fA-F]{1,4}){1,2})|:(?:(?:25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(?:\\.(?:25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(?:(?:[0-9a-fA-F]{1,4}:){4}(?:(?:(?::[0-9a-fA-F]{1,4}){1,3})|(?:(?::[0-9a-fA-F]{1,4})?:(?:(?:25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(?:\\.(?:25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(?:(?:[0-9a-fA-F]{1,4}:){3}(?:(?:(?::[0-9a-fA-F]{1,4}){1,4})|(?:(?::[0-9a-fA-F]{1,4}){0,2}:(?:(?:25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(?:\\.(?:25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(?:(?:[0-9a-fA-F]{1,4}:){2}(?:(?:(?::[0-9a-fA-F]{1,4}){1,5})|(?:(?::[0-9a-fA-F]{1,4}){0,3}:(?:(?:25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(?:\\.(?:25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(?:(?:[0-9a-fA-F]{1,4}:){1}(?:(?:(?::[0-9a-fA-F]{1,4}){1,6})|(?:(?::[0-9a-fA-F]{1,4}){0,4}:(?:(?:25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(?:\\.(?:25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(?::(?:(?:(?::[0-9a-fA-F]{1,4}){1,7})|(?:(?::[0-9a-fA-F]{1,4}){0,5}:(?:(?:25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(?:\\.(?:25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:)))(?:%.+)?](?::(?:[1-9]|[1-5]?[0-9]{2,4}|6[1-4][0-9]{3}|65[1-4][0-9]{2}|655[1-2][0-9]|6553[1-5]))?\\s*$)|(?:[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?(?:\\.[a-zA-Z0-9](?:[-0-9a-zA-Z]{0,61}[0-9a-zA-Z])?)*$))","minLength":1,"example":"10.1.1.1:5353"},"minItems":1,"uniqueItems":true},"ttl":{"type":"string","pattern":"^[0-9]+[h|m|s]{1}$","description":"Overrides the TTL setting present in the DNS record.","example":"10s"},"timeout":{"type":"string","pattern":"^[0-9]+[h|m|s]{1}$","description":"Sets the timeout for domain name resolution.","example":"10s"}}},"WorkloadGroupCommon":{"description":"Settings common to Web and TCP/UDP workloadGroups.","type":"object","properties":{"locationRefs":{"type":"array","items":{"$ref":"#/components/schemas/ResourceRef"}},"loadBalancingMethod":{"$ref":"#/components/schemas/LoadBalancingMethod"},"dnsServiceDiscovery":{"$ref":"#/components/schemas/DNSServiceDiscovery"}}},"WebProxy":{"description":"Proxy retry and timeout settings applicable to servers in a Web workloadGroup associated with a Component.","type":"object","properties":{"nextUpstream":{"description":"Specifies in which cases a request should be passed to the next server.","type":"array","items":{"type":"string","enum":["ERROR","TIMEOUT","INVALID_HEADER","HTTP_500","HTTP_502","HTTP_503","HTTP_504","HTTP_403","HTTP_404","HTTP_429","NON_IDEMPOTENT","OFF"]}},"connectTimeout":{"description":"Defines a timeout for establishing a connection with a proxied server.","type":"string","pattern":"^[0-9]{1,12}[hms]?$"},"sendTimeout":{"description":"Sets a timeout for transmitting a request to the proxied server.","type":"string","pattern":"^[0-9]{1,12}[hms]?$"}}},"SessionPersistenceCookie":{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["COOKIE"]},"srvID":{"type":"string"},"expireTime":{"type":"string","pattern":"^[0-9]+[h|m|s]{1}$"},"domain":{"type":"string"},"path":{"type":"string"}}},"SessionPersistenceRoute":{"type":"object","required":["type","routeInfoLocation"],"properties":{"type":{"type":"string","enum":["ROUTE"]},"routeInfoLocation":{"type":"string","enum":["COOKIE","URI","BOTH"]}}},"SessionPersistenceCookieLearn":{"type":"object","required":["type","create","lookup"],"properties":{"type":{"type":"string","enum":["COOKIE_LEARN"]},"create":{"type":"string","pattern":"^\\$.+"},"lookup":{"type":"string","pattern":"^\\$.+"}}},"SessionPersistence":{"description":"SessionPersistence settings in a Web workloadGroup.","discriminator":{"propertyName":"type","mapping":{"COOKIE":"#/components/schemas/SessionPersistenceCookie","ROUTE":"#/components/schemas/SessionPersistenceRoute","COOKIE_LEARN":"#/components/schemas/SessionPersistenceCookieLearn"}},"oneOf":[{"$ref":"#/components/schemas/SessionPersistenceCookie"},{"$ref":"#/components/schemas/SessionPersistenceRoute"},{"$ref":"#/components/schemas/SessionPersistenceCookieLearn"}]},"WorkloadUri":{"type":"object","properties":{"weight":{"type":"integer","minimum":1,"default":1},"maxConns":{"type":"integer","minimum":0,"default":0},"maxFails":{"type":"integer","minimum":0,"default":1},"failTimeout":{"x-f5-experimental":true,"type":"string","default":"10s","pattern":"^[0-9]+[h|m|s]{1}$"},"isBackup":{"type":"boolean","default":false},"isDown":{"type":"boolean","default":false},"route":{"x-f5-experimental":true,"type":"string"},"srvService":{"type":"string"},"slowStart":{"x-f5-experimental":true,"type":"integer","minimum":0,"default":0},"isDrain":{"type":"boolean","default":false}}},"WebWorkloadGroup":{"description":"Group of servers hosting a part of a Web application represented by a Component.","allOf":[{"$ref":"#/components/schemas/WorkloadGroupCommon"},{"type":"object","properties":{"proxy":{"$ref":"#/components/schemas/WebProxy"},"sessionPersistence":{"$ref":"#/components/schemas/SessionPersistence"},"uris":{"type":"object","description":"The URI for a server hosting a part of a Web application.\n\nIt must conform to the format `schema://address[:port]`\nwhere schema is chosen from http or https, address is IP or hostname,\nschema and address must be provided.\n\nFor example:\n\n- `http://192.0.2.247`\n- `https://192.0.2.247:8443`\n- `https://www.f5workload.com`\n","additionalProperties":{"$ref":"#/components/schemas/WorkloadUri"}}}}]},"BackendBuffers":{"description":"Proxy buffer settings applicable to servers across all Web workloadGroups associated with a Component.","type":"object","properties":{"headerSize":{"description":"Sets the size of the buffer used for reading the first part of the response received from the proxied server.","type":"string","pattern":"^[0-9]{1,12}[kKmM]?$","externalDocs":{"url":"https://nginx.org/en/docs/http/ngx_http_proxy_module.html#proxy_buffer_size"}},"isEnabled":{"description":"Enables or disables buffering of responses from the proxied server.","type":"boolean","externalDocs":{"url":"https://nginx.org/en/docs/http/ngx_http_proxy_module.html#proxy_buffering"}},"size":{"description":"Sets the number and size of the buffers used for reading a response from the proxied server, for a single connection.","type":"object","properties":{"number":{"type":"integer"},"size":{"type":"string","pattern":"^[0-9]{1,12}[kKmM]?$"}},"externalDocs":{"url":"https://nginx.org/en/docs/http/ngx_http_proxy_module.html#proxy_buffers"}},"busySize":{"description":"When buffering of responses from the proxied server is enabled, it limits the total size of buffers that can be busy sending a response to the client while the response is not yet fully read.","type":"string","pattern":"^[0-9]{1,12}[kKmM]?$","externalDocs":{"url":"https://nginx.org/en/docs/http/ngx_http_proxy_module.html#proxy_busy_buffers_size"}},"ignoreClientAbort":{"description":"Determines whether the connection with a proxied server should be closed when a client closes the connection without waiting for a response.","type":"string","enum":["ENABLED","DISABLED"],"externalDocs":{"url":"https://nginx.org/en/docs/http/ngx_http_proxy_module.html#proxy_ignore_client_abort"}},"forceRanges":{"description":"Enables byte-range support for both cached and uncached responses from the proxied server regardless of the \"Accept-Ranges\" field in these responses.","type":"string","enum":["ENABLED","DISABLED"],"externalDocs":{"url":"https://nginx.org/en/docs/http/ngx_http_proxy_module.html#proxy_force_ranges"}},"httpVersion":{"description":"Sets the HTTP protocol version for proxying.","type":"string","enum":["1.0","1.1"],"externalDocs":{"url":"https://nginx.org/en/docs/http/ngx_http_proxy_module.html#proxy_http_version"}},"rate":{"description":"Limits the speed (in bytes per second) of reading the response from the proxied server.\n\nDisables rate limiting when set to 0. \n","type":"string","pattern":"^[0-9]{1,12}[kKmM]?$","externalDocs":{"url":"https://nginx.org/en/docs/http/ngx_http_proxy_module.html#proxy_limit_rate"}},"readTimeout":{"description":"Defines a timeout for reading a response from the proxied server.","type":"string","pattern":"^[0-9]{1,12}[hms]?$","externalDocs":{"url":"https://nginx.org/en/docs/http/ngx_http_proxy_module.html#proxy_read_timeout"}},"maxTempFileSize":{"description":"Sets the maximum size of the temporary file that the response can be saved into. Note that the buffering of responses from proxied server is enabled and the response does not fit into the buffers.\n\nDisables temporary file usage when set to 0.\n","type":"string","pattern":"^[0-9]{1,12}[kKmM]?$","externalDocs":{"url":"https://nginx.org/en/docs/http/ngx_http_proxy_module.html#proxy_max_temp_file_size"}},"tempFileWriteSize":{"description":"Limits the size of data written to a temporary file at a time, when buffering of responses from the proxied server to temporary files is enabled.\n\nDisables temporary file usage when set to 0.\n","type":"string","pattern":"^[0-9]{1,12}[kKmM]?$","externalDocs":{"url":"https://nginx.org/en/docs/http/ngx_http_proxy_module.html#proxy_temp_file_write_size"}}}},"WebBackend":{"description":"Backend settings in a Web Component.\n","type":"object","properties":{"keepAlive":{"type":"object","properties":{"connections":{"type":"integer","minimum":0,"default":0},"requestsPerConn":{"type":"integer"},"idleTimeout":{"type":"string","pattern":"^[0-9]+[h|m|s]{1}$","example":"1h"}}},"monitoring":{"$ref":"#/components/schemas/WebMonitoring"},"workloadGroups":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/WebWorkloadGroup"}},"preserveHostHeader":{"x-f5-experimental":true,"$ref":"#/components/schemas/ServiceConfigState"},"queue":{"x-f5-experimental":true,"type":"object","required":["length"],"properties":{"length":{"type":"integer"},"timeOut":{"type":"string","pattern":"^[0-9]+[h|m|s]{1}$","example":"1h"}}},"httpVersion":{"x-f5-experimental":true,"type":"string","pattern":"^[1-3]{1}\\.[0-1]{1}$","example":1},"ntlmAuthentication":{"x-f5-experimental":true,"$ref":"#/components/schemas/ServiceConfigState"},"persistentState":{"x-f5-experimental":true,"type":"string"},"buffers":{"$ref":"#/components/schemas/BackendBuffers"},"isSocketKeepaliveEnabled":{"description":"Configures the “TCP keepalive” behavior for outgoing connections to a proxied server.","type":"boolean","externalDocs":{"url":"https://nginx.org/en/docs/http/ngx_http_proxy_module.html#proxy_socket_keepalive"}},"ignoreHeaders":{"description":"Disables processing of certain response header fields from the proxied server.","type":"array","items":{"type":"string"},"example":["X-Accel-Redirect","X-Accel-Expires","X-Accel-Limit-Rate","X-Accel-Buffering","X-Accel-Charset","Expires","Cache-Control","Set-Cookie","Vary"],"externalDocs":{"url":"https://nginx.org/en/docs/http/ngx_http_proxy_module.html#proxy_ignore_headers"}},"debugHeaders":{"description":"Permits passing otherwise disabled header fields from a proxied server to a client.","type":"array","items":{"type":"string"},"example":["X-Accel-Redirect","X-Accel-Expires","X-Accel-Limit-Rate","X-Accel-Buffering","X-Accel-Charset","Expires","Cache-Control","Set-Cookie","Vary"],"externalDocs":{"url":"https://nginx.org/en/docs/http/ngx_http_proxy_module.html#proxy_pass_header"}},"tls":{"description":"TLS settings applicable to servers in Web workloadGroups.","type":"object","properties":{"cipher":{"description":"Specifies the enabled ciphers for requests to a proxied HTTPS server.","type":"string","example":"ALL:!aNULL:!EXPORT56:RC4+RSA:+HIGH:+MEDIUM:+LOW:+SSLv2:+EXP;","externalDocs":{"url":"https://nginx.org/en/docs/http/ngx_http_proxy_module.html#proxy_ssl_ciphers"}},"name":{"description":"Allows overriding the server name used to verify the certificate of the proxied HTTPS server.","type":"string","example":"$proxy_host","externalDocs":{"url":"https://nginx.org/en/docs/http/ngx_http_proxy_module.html#proxy_ssl_name"}},"protocols":{"description":"Enables the specified protocols for requests to a proxied HTTPS server.","type":"array","items":{"type":"string","pattern":"TLSv1|TLSv1\\.[1-3]|SSLv2|SSLv3"},"externalDocs":{"url":"https://nginx.org/en/docs/http/ngx_http_proxy_module.html#proxy_ssl_protocols"}},"isServerNameEnabled":{"description":"Enables or disables passing of the server name through TLS Server Name Indication extension (SNI, RFC 6066) when establishing a connection with the proxied HTTPS server.","type":"boolean","externalDocs":{"url":"https://nginx.org/en/docs/http/ngx_http_proxy_module.html#proxy_ssl_server_name"}},"isSessionReuseEnabled":{"description":"Determines whether SSL sessions can be reused when working with the proxied server.","type":"boolean","externalDocs":{"url":"https://nginx.org/en/docs/http/ngx_http_proxy_module.html#proxy_ssl_session_reuse"}},"isVerifiedEnabled":{"description":"Enables or disables verification of the proxied HTTPS server certificate.","type":"boolean","externalDocs":{"url":"https://nginx.org/en/docs/http/ngx_http_proxy_module.html#proxy_ssl_verify"}},"verifyDepth":{"description":"Sets the verification depth in the proxied HTTPS server certificates chain.","type":"integer","minimum":0,"externalDocs":{"url":"https://nginx.org/en/docs/http/ngx_http_proxy_module.html#proxy_ssl_verify_depth"}}}}}},"ApplicableUri":{"type":"object","required":["uri"],"properties":{"uri":{"type":"string"},"matchMethod":{"$ref":"#/components/schemas/URIMatchMethod"}}},"ApplicableUris":{"type":"array","description":"Defines an array of ingress URIs with a corresponding matchMethod that this rewrite rule applies to.\nBy default, a rewrite rule applies to all of the ingress URIs in the component.\nA rewrite rule can also be applied at a gateway level by specifying ingress URIs\nfrom the gateway. For example \"http://www.nginx.com\". Note that applying the rewrite\nrule to URIs at a gateway level can affect other components. The URI and the matchMethod must\nmatch an ingress URI defined either at the component or gateway level. If no match is found\nthe request is rejected.\n","items":{"$ref":"#/components/schemas/ApplicableUri"}},"UriRewrite":{"type":"object","required":["incomingPattern","rewritePattern"],"properties":{"applicableURIs":{"$ref":"#/components/schemas/ApplicableUris"},"incomingPattern":{"type":"string","description":"The regex pattern to match against the request URIs that are expected to be rewritten."},"rewritePattern":{"type":"string","description":"The replacement regex pattern to apply to the URIs that are to be rewritten.","minLength":1},"afterExecute":{"type":"string","enum":["NONE","LAST","BREAK","REDIRECT","PERMANENT"],"default":"BREAK"}}},"UriRedirect":{"type":"object","required":["responseCode"],"properties":{"applicableURIs":{"$ref":"#/components/schemas/ApplicableUris"},"responseCode":{"type":"integer","minimum":300,"maximum":308},"url":{"type":"string","minLength":1,"description":"The return url to use for responses in the 301-308 range."},"text":{"type":"string","description":"The return text to send for 300 responses."}}},"ProgrammabilityAction":{"type":"string","enum":["ADD","MODIFY","DELETE"]},"CookieModification":{"type":"object","required":["action","cookieName"],"properties":{"action":{"$ref":"#/components/schemas/ProgrammabilityAction"},"cookieName":{"type":"string"},"cookieValue":{"type":"string"}}},"ProgrammabilityAddRequestHeader":{"type":"object","required":["action","headerName","headerValue"],"properties":{"action":{"type":"string","description":"Adds request header details.","enum":["ADD"]},"headerName":{"type":"string","description":"The name of the response header to modify.","minLength":1},"headerValue":{"type":"string","description":"The value to apply to the request header.","minLength":1},"applicableURIs":{"$ref":"#/components/schemas/ApplicableUris"}}},"ProgrammabilityDeleteRequestHeader":{"type":"object","required":["action","headerName"],"properties":{"action":{"type":"string","description":"Deletes request header details.","enum":["DELETE"]},"headerName":{"type":"string","description":"The name of the request header to modify.","minLength":1},"applicableURIs":{"$ref":"#/components/schemas/ApplicableUris"}}},"RequestHeaderModification":{"discriminator":{"propertyName":"action","mapping":{"ADD":"#/components/schemas/ProgrammabilityAddRequestHeader","DELETE":"#/components/schemas/ProgrammabilityDeleteRequestHeader"}},"oneOf":[{"$ref":"#/components/schemas/ProgrammabilityAddRequestHeader"},{"$ref":"#/components/schemas/ProgrammabilityDeleteRequestHeader"}]},"ProgrammabilityAddResponseHeader":{"type":"object","required":["action","headerName","headerValue"],"properties":{"action":{"type":"string","description":"Adds response header details.","enum":["ADD"]},"headerName":{"type":"string","description":"The name of the response header to modify.","minLength":1},"headerValue":{"type":"string","description":"The value to apply to the response header.","minLength":1},"responseCodeFilter":{"type":"string","description":"The value to apply to the response code filter.","enum":["ALWAYS","PRE_DEFINED"],"default":"PRE_DEFINED"},"applicableURIs":{"$ref":"#/components/schemas/ApplicableUris"}}},"ProgrammabilityDeleteResponseHeader":{"type":"object","required":["action","headerName"],"properties":{"action":{"type":"string","description":"Deletes response header details.","enum":["DELETE"]},"headerName":{"type":"string","description":"The name of the response header to modify.\n\n> Warning: `Date`, `Content-Length`, and `Connection` headers cannot be deleted.\n","minLength":1},"applicableURIs":{"$ref":"#/components/schemas/ApplicableUris"}}},"ResponseHeaderModification":{"discriminator":{"propertyName":"action","mapping":{"ADD":"#/components/schemas/ProgrammabilityAddResponseHeader","DELETE":"#/components/schemas/ProgrammabilityDeleteResponseHeader"}},"oneOf":[{"$ref":"#/components/schemas/ProgrammabilityAddResponseHeader"},{"$ref":"#/components/schemas/ProgrammabilityDeleteResponseHeader"}]},"Programmability":{"type":"object","properties":{"uriRewrites":{"type":"array","items":{"$ref":"#/components/schemas/UriRewrite"}},"httpHttpsRedirect":{"x-f5-experimental":true,"$ref":"#/components/schemas/ServiceConfigState"},"uriRedirects":{"x-f5-experimental":true,"type":"array","items":{"$ref":"#/components/schemas/UriRedirect"}},"cookieModifications":{"x-f5-experimental":true,"type":"array","items":{"$ref":"#/components/schemas/CookieModification"}},"requestHeaderModifications":{"type":"array","items":{"$ref":"#/components/schemas/RequestHeaderModification"}},"responseHeaderModifications":{"type":"array","items":{"$ref":"#/components/schemas/ResponseHeaderModification"}}}},"Logging":{"description":"Settings for error logs and access logs.","type":"object","properties":{"errorLog":{"$ref":"#/components/schemas/ServiceConfigState"},"accessLog":{"type":"object","properties":{"state":{"$ref":"#/components/schemas/ServiceConfigState"},"format":{"type":"string"}}}}},"WAF":{"description":"Defines the desired configurations for the WAF associated with the application component.","properties":{"isEnabled":{"type":"boolean","default":true,"description":"Indicates whether the WAF is enabled or not."},"isMonitorOnly":{"type":"boolean","default":true,"description":"Indicates whether the WAF will monitor or block security violations."},"signatureOverrides":{"type":"object","additionalProperties":{"type":"object","properties":{"action":{"type":"string","enum":["IGNORE"]}},"description":"Identifies overrides for the signatures contained within the associated security strategy.\n","example":{"1234":{"action":"IGNORE"},"1235":{"action":"IGNORE"}}}}}},"APIKeyClientAuth":{"description":"Defines how an API client should provide their API Key credentials.","required":["keyLocation"],"properties":{"keyLocation":{"type":"string","enum":["HEADER","QUERY_PARAM"]},"key":{"type":"string"}}},"JWTClientAuth":{"description":"Defines how an API Client should provide their JWT.","required":["keyLocation"],"properties":{"keyLocation":{"type":"string","enum":["BEARER","HEADER","QUERY_PARAM","COOKIE"]},"key":{"type":"string"}}},"ConditionalAuthPolicy":{"description":"Defines further fine-grained access control on top of API Key or JWT Auth.","required":["sourceType","comparisonType","comparisonValues","action","denyStatusCode"],"properties":{"sourceType":{"type":"string","enum":["HEADER","JWT_CLAIM"]},"sourceKey":{"type":"string"},"comparisonType":{"type":"string","enum":["EQUALS","NOT_EQUALS","IN","CONTAINS"]},"comparisonValues":{"type":"array","description":"Valid values for the sourceType.","items":{"oneOf":[{"type":"string"},{"type":"integer"}]}},"action":{"type":"string","enum":["ALLOW","DENY"]},"denyStatusCode":{"type":"integer"}}},"RateLimit":{"required":["rate"],"properties":{"rate":{"type":"string","pattern":"^[0-9]+r\\/[m|s]{1}$","description":"Sets the maximum number of allowed requests.\n\nYou can specify the rate limit as requests per second (r/s) or requests per minute (r/m).\n","example":"10r/s"},"burstBeforeReject":{"type":"integer","minimum":0},"burstBeforeDelay":{"type":"integer","minimum":0},"statusCode":{"type":"integer","default":429},"key":{"type":"string","default":"$binary_remote_addr","description":"Parameters (NGINX variable) for a shared memory zone that stores states for various keys; used for `limit_req_zone`."}}},"Security":{"type":"object","description":"Defines the desired security configurations for the application component.","properties":{"strategyRef":{"$ref":"#/components/schemas/ResourceRef"},"waf":{"$ref":"#/components/schemas/WAF"},"identityProviderRefs":{"type":"array","items":{"$ref":"#/components/schemas/ResourceRef"},"description":"The list of Identity Providers that are used in this Security policy."},"apiKeyClientAuth":{"$ref":"#/components/schemas/APIKeyClientAuth"},"jwtClientAuth":{"$ref":"#/components/schemas/JWTClientAuth"},"conditionalAuthPolicies":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/ConditionalAuthPolicy"}},"rateLimits":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/RateLimit"}},"interceptWorkloadErrors":{"x-f5-experimental":true,"$ref":"#/components/schemas/ServiceConfigState"}}},"PublishedApiRefs":{"type":"array","items":{"$ref":"#/components/schemas/ResourceRef"}},"GZip":{"properties":{"isEnabled":{"type":"boolean","externalDocs":{"url":"http://nginx.org/en/docs/http/ngx_http_gzip_module.html#gzip"}},"buffers":{"type":"object","properties":{"number":{"type":"integer"},"size":{"type":"string","pattern":"^[0-9]+[k|K|m|M]{1}$"}},"externalDocs":{"url":"http://nginx.org/en/docs/http/ngx_http_gzip_module.html#gzip_buffers"}},"level":{"type":"integer","minimum":1,"maximum":9,"externalDocs":{"url":"http://nginx.org/en/docs/http/ngx_http_gzip_module.html#gzip_comp_level"}},"disabledUserAgents":{"type":"array","items":{"type":"string"},"minItems":1,"uniqueItems":true,"externalDocs":{"url":"http://nginx.org/en/docs/http/ngx_http_gzip_module.html#gzip_disable"}},"httpVersion":{"type":"string","pattern":"^[1-3]{1}\\.[0-1]{1}$","externalDocs":{"url":"http://nginx.org/en/docs/http/ngx_http_gzip_module.html#gzip_http_version"}},"minLength":{"type":"integer","externalDocs":{"url":"http://nginx.org/en/docs/http/ngx_http_gzip_module.html#gzip_min_length"}},"proxied":{"type":"string","enum":["DISABLED","EXPIRED","NOCACHE","NOSTORE","PRIVATE","NOLASTMODIFIED","NOETAG","AUTH","ANY"],"externalDocs":{"url":"http://nginx.org/en/docs/http/ngx_http_gzip_module.html#gzip_proxied"}},"mimeTypes":{"type":"array","items":{"type":"string"},"minItems":1,"uniqueItems":true,"externalDocs":{"url":"http://nginx.org/en/docs/http/ngx_http_gzip_module.html#gzip_types"}},"vary":{"type":"string","enum":["DISABLED","ENABLED"],"externalDocs":{"url":"http://nginx.org/en/docs/http/ngx_http_gzip_module.html#gzip_vary"}},"static":{"type":"string","enum":["DISABLED","ENABLED","ALWAYS"],"externalDocs":{"url":"http://nginx.org/en/docs/http/ngx_http_gzip_static_module.html#gzip_static"}}}},"Compression":{"description":"Gzip compression settings.","type":"object","properties":{"gzip":{"$ref":"#/components/schemas/GZip"}}},"ComponentWebDesiredState":{"description":"The desired settings in the Web Component that the user wants in the configuration on NGINX instances associated with\nthe Gateways which this component references.\n","allOf":[{"$ref":"#/components/schemas/ComponentStateCommon"},{"type":"object","required":["ingress","backend"],"properties":{"componentType":{"description":"Defines the Component type. The default type is Web.","type":"string","enum":["WEB"]},"ingress":{"$ref":"#/components/schemas/ComponentWebIngress"},"backend":{"$ref":"#/components/schemas/WebBackend"},"programmability":{"$ref":"#/components/schemas/Programmability"},"logging":{"$ref":"#/components/schemas/Logging"},"security":{"$ref":"#/components/schemas/Security"},"publishedApiRefs":{"$ref":"#/components/schemas/PublishedApiRefs"},"errorSetRef":{"$ref":"#/components/schemas/ResourceRef"},"compression":{"$ref":"#/components/schemas/Compression"}}}]},"ComponentTcpUdpIngress":{"description":"Ingress settings in a TCP/UDP Component.","allOf":[{"$ref":"#/components/schemas/ComponentIngressCommon"}]},"TcpUdpMonitoring":{"description":"Health monitor settings across all workload groups in a TCP/UDP Component.","allOf":[{"$ref":"#/components/schemas/MonitoringCommon"},{"type":"object","properties":{"send":{"description":"Probe request for a TCP/UDP monitor.","type":"string"},"response":{"description":"Case-sensitive regular expression for the expected success response to a TCP/UDP monitor.","type":"string"}}}]},"TcpUdpProxy":{"description":"Proxy retry and timeout settings applicable to servers in a TcpUdp workloadGroup associated with a Component.","type":"object","properties":{"nextUpstream":{"description":"When a connection to the proxied server cannot be established, determines whether a client connection will be passed to the next server.","type":"string","enum":["ON","OFF"],"default":"OFF"},"connectTimeout":{"description":"Defines a timeout for establishing a connection with the proxied server.","type":"string","pattern":"^[0-9]{1,12}[hms]?$"},"proxyTimeout":{"description":"Sets the timeout between two successive read or write operations on client or proxied server connections.","type":"string","pattern":"^[0-9]{1,12}[hms]?$"}}},"TcpUdpWorkloadGroup":{"description":"Group of servers hosting a part of a TCP/UDP application represented by a Component.","allOf":[{"$ref":"#/components/schemas/WorkloadGroupCommon"},{"type":"object","properties":{"proxy":{"$ref":"#/components/schemas/TcpUdpProxy"},"uris":{"type":"object","description":"The URI for a server hosting a part of a TCP/UDP application.\n\nThe URI must conform to the format `schema://address:port`\nwhere schema is chosen from tcp, udp, or tcp+tls, address is IP or hostname.\nAll three of schema, address, and port must be provided.\n\nFor example:\n\n- `tcp://192.0.2.247:8443`\n- `tcp+tls://192.0.2.247:8449`\n- `udp://www.f5workload.com:989`\n","additionalProperties":{"$ref":"#/components/schemas/WorkloadUri"}}}}]},"TcpUdpBackend":{"description":"Backend settings in a TCP/UDP Component.\n","type":"object","properties":{"monitoring":{"$ref":"#/components/schemas/TcpUdpMonitoring"},"workloadGroups":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/TcpUdpWorkloadGroup"}}}},"ComponentTcpUdpDesiredState":{"description":"The desired settings in the TCP/UDP Component to use in the configuration on NGINX instances associated with the Gateways that this Component references.","allOf":[{"$ref":"#/components/schemas/ComponentStateCommon"},{"type":"object","required":["componentType","ingress","backend"],"properties":{"componentType":{"description":"Defines what type of Component this is. The type must be TCPUDP.","type":"string","enum":["TCPUDP"]},"ingress":{"$ref":"#/components/schemas/ComponentTcpUdpIngress"},"backend":{"$ref":"#/components/schemas/TcpUdpBackend"},"logging":{"$ref":"#/components/schemas/Logging"}}}]},"ComponentDesiredState":{"description":"The desired component settings to use in the NGINX instance configuration that's associated with\nthe Gateways that this component references.\n","oneOf":[{"$ref":"#/components/schemas/ComponentWebDesiredState"},{"$ref":"#/components/schemas/ComponentTcpUdpDesiredState"}]},"ConfigStateTally":{"type":"object","properties":{"isConfigured":{"type":"boolean","description":"The configuration operation is complete."},"isConfiguring":{"type":"boolean","description":"The configuration of the resource, or of its child(ren), is in process."},"isError":{"type":"boolean","description":"An error occurred while configuring the resource or its child(ren)."},"isDeleting":{"type":"boolean","description":"A delete operation is in progress for the resource or its child(ren)."},"total":{"type":"integer","description":"The total number of resources to which the configuration operation applies."},"configured":{"type":"integer","description":"The number of resources that have a complete and valid configuration."},"configuring":{"type":"integer","description":"The number of resources that are in the process of being configured."},"error":{"type":"integer","description":"The number of resources that have encountered an error during the configuration process."},"deleting":{"type":"integer","description":"The number of resources that are in the process of being deleted."}}},"ConfigCondition":{"type":"object","properties":{"type":{"type":"string","description":"The condition type."},"message":{"type":"string","description":"A human-readable message that provides additional information about the configuration operation."}}},"ConfigState":{"type":"object","description":"A representation of the resource's current configuration state \nthat comprises the status of the resource itself (`selfConfigState`) and any child \nresources (`childrenConfigState`).\n\nThe conditions array provides additional information during configuration changes.\n","properties":{"selfConfigState":{"$ref":"#/components/schemas/ConfigStateTally"},"childrenConfigState":{"$ref":"#/components/schemas/ConfigStateTally"},"conditions":{"type":"array","items":{"$ref":"#/components/schemas/ConfigCondition"}}}},"ComponentWebCurrentStatus":{"description":"The current snapshot of the web component settings that are reflected in the configuration on NGINX instances associated with\nthe Gateways that this component references.\n\nThese settings should converge to those in Desired State as the new configuration is applied unless there are issues;\nthe State setting gives a summary of how the convergence is proceeding.\n","allOf":[{"$ref":"#/components/schemas/ComponentStateCommon"},{"type":"object","properties":{"componentType":{"description":"Defines what type of Component this is.","type":"string","enum":["WEB"]},"ingress":{"$ref":"#/components/schemas/ComponentWebIngress"},"backend":{"$ref":"#/components/schemas/WebBackend"},"programmability":{"$ref":"#/components/schemas/Programmability"},"logging":{"$ref":"#/components/schemas/Logging"},"security":{"$ref":"#/components/schemas/Security"},"publishedApiRefs":{"$ref":"#/components/schemas/PublishedApiRefs"},"errorSetRef":{"$ref":"#/components/schemas/ResourceRef"},"compression":{"$ref":"#/components/schemas/Compression"},"state":{"$ref":"#/components/schemas/ConfigState"}}}]},"ComponentTcpUdpCurrentStatus":{"description":"The current snapshot of the TCP/UDP component settings that are reflected in the configuration on NGINX instances associated with\nthe Gateways that this component references.\n\nThese settings should converge to those in Desired State as the new configuration is applied unless there are issues;\nthe State setting gives a summary of how the convergence is proceeding.\n","allOf":[{"$ref":"#/components/schemas/ComponentStateCommon"},{"type":"object","properties":{"componentType":{"description":"Defines what type of Component this is.","type":"string","enum":["TCPUDP"]},"ingress":{"$ref":"#/components/schemas/ComponentTcpUdpIngress"},"backend":{"$ref":"#/components/schemas/TcpUdpBackend"},"logging":{"$ref":"#/components/schemas/Logging"},"state":{"$ref":"#/components/schemas/ConfigState"}}}]},"ComponentCurrentStatus":{"description":"The current snapshot of the component settings that are reflected in the configuration on NGINX instances associated with\nthe Gateways that this Component references.\n\nThese settings should converge to those in Desired State as the new configuration is applied unless there are issues;\nthe State setting gives a summary of how the convergence is proceeding.\n","oneOf":[{"$ref":"#/components/schemas/ComponentWebCurrentStatus"},{"$ref":"#/components/schemas/ComponentTcpUdpCurrentStatus"}]},"Component":{"description":"A component represents the processing –- reverse proxying, rate limiting, security policy enforcement, header rewrites, etc.\n–- of traffic associated with a logical part (for example, microservice) of an application/API. It also defines the subsequent\nload balancing of traffic to workloads implementing that part of the application/API.\n\nA component can be either a web or a TCP/UDP component –- indicated by the component type. Web components are used to\nconfigure NGINX functionality associated with HTTP/HTTPS protocols and inherit web and common settings from linked Gateways.\nTCP/UDP components are used to configure NGINX functionality associated with TCP/UDP protocols\nand inherit TCP/UDP and common settings from linked Gateways.\n","type":"object","required":["metadata","desiredState"],"properties":{"metadata":{"$ref":"#/components/schemas/ResourceMeta"},"desiredState":{"$ref":"#/components/schemas/ComponentDesiredState"},"currentStatus":{"$ref":"#/components/schemas/ComponentCurrentStatus"}}},"ErrorDetail":{"type":"object","required":["description"],"properties":{"description":{"type":"string","example":"Error doing <action>: <reason for error>. This can lead to <potential consequences>. Try <action> to resolve the issue.","description":"A detailed error message returned by the server. \n\nThese messages contain the following information, where applicable:\n\n- What happened.\n- Why it happened.\n- What the consequences are (if any).\n- Recommended action to take to resolve the issue.\n"}}},"ErrorModel":{"type":"object","required":["message","code"],"properties":{"message":{"type":"string","example":"Error doing <action>.","description":"A human-readable message, in English, that describes the error.\n"},"code":{"type":"integer","example":1234567,"description":"A numeric error code that can be used to identify errors for support purposes.\n"},"details":{"type":"array","items":{"$ref":"#/components/schemas/ErrorDetail"}}}},"ComponentName":{"type":"string"}},"examples":{"ComponentRequest":{"value":{"metadata":{"name":"resource-name","displayName":"My Display Name","description":"This is a sample description string. It provides information about the resource.","tags":["production_public","dev","new_app","us-west-1","emea"]},"desiredState":{"ingress":{"uris":{"/api/golf/":{"matchMethod":"PREFIX"}},"gatewayRefs":[{"ref":"/services/environments/dev/gateways/sportsgw"}]},"publishedApiRefs":[{"ref":"/services/environments/dev/apps/sports/published-apis/golf-pub"}],"backend":{"workloadGroups":{"serverGrp1":{"uris":{"{{httpWorkloadInstance1}}":{}}}},"monitoring":{}},"security":{"rateLimit":{"defaultLimit":{"rate":1,"rateMeasure":"SECONDS"}}}}}}}}}
/ services / environments / {environmentName} / apps / {appName} / components
/ services / environments / {environmentName} / apps / {appName} / components / {componentName}
License API OpenAPI	{"openapi":"3.0.0","servers":[{"description":"NGINX Controller API","url":"https://{{CONTROLLER_FQDN}}/api/v1"}],"info":{"title":"License API","description":"Use the License API to manage the license(s) for NGINX Controller.","version":"v1"},"paths":{"/platform/license":{"get":{"tags":["License"],"summary":"Get a License","description":"Gets information for the active NGINX Controller license.","operationId":"getLicense","responses":{"200":{"description":"Successfully retrieved the active Controller license.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LicenseResponse"},"example":{"metadata":{"name":"license"},"desiredState":{"content":"******","items":[{"expiry":"2021-05-10T00:00:00Z","instanceCount":250,"product":"NGINX Controller Load Balancing","serial":20145,"type":"PAID","version":1,"id":"ADC"}]},"currentStatus":{"subscription":{"id":"b6d7c577-b708-44ad-839c-9743f85fcf7c"},"entitlement":{"features":[{"name":"NGINX Controller Load Balancing","limit":20,"unitOfMeasure":"WORKLOADS","type":"PAID","id":"ADC","expiry":"1996-02-26T00:00:00.000Z","gracePeriodDays":30}]},"state":{"currentInstance":{"id":"8ce9b80a-f7fc-48fd-ac28-8d5f3fe898d6","type":"NGINX Controller","status":"INVALID","version":"3.3.0","telemetryLastReported":"2021-05-10T00:00:00Z","features":[{"name":"NGINX Controller Load Balancing","used":5,"aggregateUsed":10,"remaining":5,"unitOfMeasure":"WORKLOADS","id":"ADC","daysUntilExpiry":20,"gracePeriodRemainingDays":30}],"configState":{"selfConfigState":{"isConfigured":true,"isConfiguring":false,"isError":false,"isDeleting":false},"conditions":[]}}},"items":[{"expiry":"2021-05-10T00:00:00Z","instanceCount":250,"product":"NGINX Controller Load Balancing","serial":20145,"type":"PAID","version":1,"id":"ADC"}]}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"500":{"$ref":"#/components/responses/Internal"}}},"put":{"tags":["License"],"summary":"Upload a License","description":"Uploads an NGINX Controller license.\n\nProvide your NGINX Controller license in the JSON request body as a base64-encoded string or as an unencoded customer association token.\n","operationId":"putLicense","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PutLicenseRequest"},"example":{"metadata":{"name":"license"},"desiredState":{"content":"<base-64-encoded-license-file-contents or association-token>"}}}}},"responses":{"200":{"description":"Successfully uploaded the license.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LicenseResponse"},"example":{"metadata":{"name":"license"},"desiredState":{"content":"******","items":[{"expiry":"2021-05-10T00:00:00Z","instanceCount":250,"product":"NGINX Controller Load Balancing","serial":20145,"type":"PAID","version":1,"id":"ADC"}]},"currentStatus":{"subscription":{"id":"b6d7c577-b708-44ad-839c-9743f85fcf7c"},"entitlement":{"features":[{"name":"NGINX Controller Load Balancing","limit":20,"unitOfMeasure":"WORKLOADS","type":"PAID","id":"ADC","expiry":"2021-02-26T00:00:00.000Z","gracePeriodDays":30}]},"state":{"currentInstance":{"id":"8ce9b80a-f7fc-48fd-ac28-8d5f3fe898d6","type":"NGINX Controller","status":"INVALID","version":"3.3.0","telemetryLastReported":"2021-05-10T00:00:00Z","features":[{"name":"NGINX Controller Load Balancing","used":5,"aggregateUsed":10,"remaining":5,"unitOfMeasure":"WORKLOADS","id":"ADC","daysUntilExpiry":20,"gracePeriodRemainingDays":0}],"configState":{"selfConfigState":{"isConfigured":true,"isConfiguring":false,"isError":false,"isDeleting":false},"conditions":[]}}},"items":[{"expiry":"2021-05-10T00:00:00Z","instanceCount":250,"product":"NGINX Controller Load Balancing","serial":20145,"type":"PAID","version":1,"id":"ADC"}]}}}}},"202":{"description":"The request to upload a license succeeded. The License resource will be created when the upload is complete.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LicenseResponse"},"example":{"metadata":{"name":"license"},"desiredState":{"content":"******","items":[{"expiry":"2021-05-10T00:00:00Z","instanceCount":250,"product":"NGINX Controller Load Balancing","serial":20145,"type":"PAID","version":1,"id":"ADC"}]},"currentStatus":{"subscription":{"id":"b6d7c577-b708-44ad-839c-9743f85fcf7c"},"entitlement":{"features":[{"name":"NGINX Controller Load Balancing","limit":20,"unitOfMeasure":"WORKLOADS","type":"PAID","id":"ADC","expiry":"2021-02-26T00:00:00.000Z","gracePeriodDays":30}]},"state":{"currentInstance":{"id":"8ce9b80a-f7fc-48fd-ac28-8d5f3fe898d6","type":"NGINX Controller","status":"INVALID","version":"3.3.0","telemetryLastReported":"2021-05-10T00:00:00Z","features":[{"name":"NGINX Controller Load Balancing","used":5,"aggregateUsed":10,"remaining":5,"unitOfMeasure":"WORKLOADS","id":"ADC","daysUntilExpiry":20,"gracePeriodRemainingDays":0}],"configState":{"selfConfigState":{"isConfigured":false,"isConfiguring":true,"isError":false,"isDeleting":false},"conditions":[]}}},"items":[{"expiry":"2021-05-10T00:00:00Z","instanceCount":250,"product":"NGINX Controller Load Balancing","serial":20145,"type":"PAID","version":1,"id":"ADC"}]}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"500":{"$ref":"#/components/responses/Internal"}}},"delete":{"tags":["License"],"operationId":"deleteLicense","summary":"Delete a License","description":"Deletes an NGINX Controller License resource.","responses":{"202":{"description":"Successfully scheduled the request to delete the license.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LicenseResponse"},"example":{"metadata":{"name":"license"},"desiredState":{"content":"******","items":[{"expiry":"2021-05-10T00:00:00Z","instanceCount":250,"product":"NGINX Controller Load Balancing","serial":20145,"type":"PAID","version":1,"id":"ADC"}]},"currentStatus":{"subscription":{"id":"b6d7c577-b708-44ad-839c-9743f85fcf7c"},"entitlement":{"features":[{"name":"NGINX Controller Load Balancing","limit":20,"unitOfMeasure":"WORKLOADS","type":"PAID","id":"ADC","expiry":"2021-02-26T00:00:00.000Z","gracePeriodDays":30}]},"state":{"currentInstance":{"id":"8ce9b80a-f7fc-48fd-ac28-8d5f3fe898d6","type":"NGINX Controller","status":"INVALID","version":"3.3.0","telemetryLastReported":"2021-05-10T00:00:00Z","features":[{"name":"NGINX Controller Load Balancing","used":5,"aggregateUsed":10,"remaining":5,"unitOfMeasure":"WORKLOADS","id":"ADC","daysUntilExpiry":20,"gracePeriodRemainingDays":0}],"configState":{"selfConfigState":{"isConfigured":false,"isConfiguring":false,"isError":false,"isDeleting":true},"conditions":[]}}},"items":[{"expiry":"2021-05-10T00:00:00Z","instanceCount":250,"product":"NGINX Controller Load Balancing","serial":20145,"type":"PAID","version":1,"id":"ADC"}]}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"500":{"$ref":"#/components/responses/Internal"}}}},"/platform/licenses/nginx-plus-licenses":{"get":{"tags":["License"],"summary":"List all NGINX+ Licenses.","description":"Returns a list of all NGINX Plus licenses.","operationId":"listNginxPlusLicenses","responses":{"200":{"description":"Successfully retrieved the list of NGINX Plus licenses.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NginxPlusLicensesList"},"example":{"items":[{"metadata":{"name":"controller-provided","ref":"/platform/licenses/nginx-plus-licenses/controller-provided","kind":"license"},"currenStatus":{"certKey":"a valid certificate key for NGINX Plus","privateKey":"a valid private key for NGINX Plus"},"desiredState":{"certKey":"a valid certificate key for NGINX Plus","privateKey":"a valid private key for NGINX Plus"}}]}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"402":{"$ref":"#/components/responses/PaymentRequired"},"403":{"$ref":"#/components/responses/Forbidden"},"500":{"$ref":"#/components/responses/Internal"}}}},"/platform/licenses/nginx-plus-licenses/{licenseName}":{"get":{"tags":["License"],"summary":"Get the NGINX Plus certificate and key bundle by name","description":"Gets the NGINX Plus certificate and key as a JSON or gzip file.","operationId":"getNginxPlusLicense","parameters":[{"in":"header","name":"Content-Type","schema":{"type":"string","example":"application/json"}},{"name":"licenseName","description":"The name of the license.","in":"path","required":true,"schema":{"$ref":"#/components/schemas/LicenseName"}}],"responses":{"200":{"description":"Successfully retrieved the specified NGINX Plus license.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NginxPlusLicenseResponse"},"example":{"metadata":{"name":"controller-provided","ref":"/platform/licenses/nginx-plus-licenses/controller-provided","kind":"license"},"currenStatus":{"certKey":"a valid certificate key for NGINX Plus","privateKey":"a valid private key for NGINX Plus"},"desiredState":{"certKey":"a valid certificate key for NGINX Plus","privateKey":"a valid private key for NGINX Plus"}}},"application/gzip":{"schema":{"type":"string","format":"binary"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"402":{"$ref":"#/components/responses/PaymentRequired"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/FileNotFound"},"500":{"$ref":"#/components/responses/Internal"}}}},"/platform/license-file":{"post":{"deprecated":true,"tags":["License"],"summary":"Upload a License","description":"Uploads an NGINX Controller license.\n\nAccepts a single file (encoded as Base64) that may contain one or more product licenses.\n","operationId":"uploadLicense","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LicenseRequest"}}}},"responses":{"200":{"description":"Successfully uploaded a license.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/License"},"example":{"metadata":{"name":"license"},"desiredState":{"items":[{"expiry":"2021-05-10T00:00:00Z","instanceCount":20,"product":"NGINX Controller API Management","serial":20145,"type":"PRODUCTION","version":1,"id":"APIM"}]},"currentStatus":{"items":[{"expiry":"2021-05-10T00:00:00Z","instanceCount":20,"product":"NGINX Controller API Management","serial":20145,"type":"PRODUCTION","version":1,"id":"APIM"}]}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"500":{"$ref":"#/components/responses/Internal"}}}}},"components":{"responses":{"Internal":{"description":"The request cannot be processed because of an internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"},"example":{"code":4581,"details":[{"description":"The request cannot be processed because of an internal server error."}],"message":"An internal error occurred while processing the request. Try again later. If the issue continues, contact your system administrator or NGINX Support."}}}},"Unauthorized":{"description":"User authentication is invalid or missing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"},"example":{"code":401,"message":"authentication needed"}}}},"PaymentRequired":{"description":"The request failed due to missing or expired license.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"},"example":{"code":4700,"details":[{"description":"Error getting the NGINX Plus certificate and public key: the license is either expired or no license exists. Upload a valid license file and then try again."}],"message":"payment required."}}}},"Forbidden":{"description":"The request failed due to insufficient privileges.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"},"example":{"code":403,"message":"unauthorized"}}}},"BadRequest":{"description":"Bad input parameter, or possibly a bad URI. Check the input for typos and try again.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"},"example":{"code":4578,"details":[{"description":"Bad input parameter, or possibly a bad URI. Check the input for typos and try again."}],"message":"Error processing the request: the license file has an invalid signature. Check if the license file is for NGINX Controller, then try again. If the issue continues, contact NGINX Support."}}}},"FileNotFound":{"description":"The requested certificate and key could not be found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"},"example":{"code":4600,"details":[{"description":"The requested resource was not found or is unavailable."}],"message":"The requested NGINX Plus license is not found or is unavailable."}}}}},"securitySchemes":{"cookieAuth":{"type":"apiKey","in":"cookie","name":"session"}},"schemas":{"LicenseRequest":{"type":"object","required":["content"],"properties":{"content":{"type":"string","format":"password","description":"License file contents, encoded as Base64"}}},"PutLicenseRequest":{"type":"object","required":["metadata","desiredState"],"properties":{"metadata":{"$ref":"#/components/schemas/ResourceMeta"},"desiredState":{"type":"object","required":["content"],"properties":{"content":{"type":"string","format":"password","description":"The customer association token or NGINX Controller license, which can be downloaded from your [MyF5](account.f5.com/myf5) account. The license must be formatted as a base64-encoded string, while the association token is unencoded."}}}}},"License":{"type":"object","required":["metadata","desiredState","currentStatus"],"properties":{"metadata":{"$ref":"#/components/schemas/ResourceMeta"},"desiredState":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/LicenseData"}}}},"currentStatus":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/LicenseData"}}}}}},"LicenseResponse":{"type":"object","required":["metadata","desiredState","currentStatus"],"properties":{"metadata":{"$ref":"#/components/schemas/ResourceMeta"},"desiredState":{"type":"object","properties":{"content":{"type":"string","format":"password","description":"Redacted license information."},"items":{"type":"array","deprecated":true,"items":{"$ref":"#/components/schemas/LicenseData"}}}},"currentStatus":{"type":"object","properties":{"subscription":{"$ref":"#/components/schemas/Subscription"},"entitlement":{"$ref":"#/components/schemas/Entitlement"},"state":{"type":"object","required":["currentInstance"],"properties":{"currentInstance":{"$ref":"#/components/schemas/CurrentInstance"}}},"items":{"type":"array","deprecated":true,"items":{"$ref":"#/components/schemas/LicenseData"}}}}}},"LicenseData":{"type":"object","required":["product","expiry","instanceCount","serial","version","type","id"],"description":"Defines the features of a given license","properties":{"product":{"type":"string","description":"The name of the product the license enables.","example":"NGINX Controller Monitoring"},"expiry":{"type":"string","format":"date-time","description":"The date on which the license expires. Represented in Coordinated Universal Time (UTC), specifically using the ISO 8601 standard.","example":"1996-02-26T00:00:00.000Z"},"instanceCount":{"type":"integer","description":"The number of instances that are allowed by the license.","example":20},"serial":{"type":"integer","description":"A unique identifier for the license.","example":20145},"version":{"type":"integer","description":"The product version number.","example":1},"type":{"type":"string","description":"The license type. Lowercase values are deprecated.","enum":["production","beta","internal","partner","trial","PRODUCTION","BETA","INTERNAL","PARTNER","TRIAL","PAID","EVAL"]},"id":{"type":"string","description":"Unique identifier for a product.","enum":["UNKNOWN","ADC","APIM","ANALYTICS"]}}},"Subscription":{"type":"object","required":["id"],"description":"Defines the features of a subscription.","properties":{"id":{"type":"string","format":"uuid","example":"b6d7c577-b708-44ad-839c-9743f85fcf7c","description":"Subscription ID."}}},"Entitlement":{"type":"object","required":["features"],"description":"Defines the elements of an entitlement.","properties":{"features":{"type":"array","description":"Product features.","items":{"$ref":"#/components/schemas/Feature"}}}},"Feature":{"type":"object","required":["name","unitOfMeasure","id","type"],"description":"Defines a product feature, consumption metric, and metric usage limit.","properties":{"name":{"type":"string","description":"Name of the feature.","example":"NGINX Controller Load Balancing"},"limit":{"type":"integer","description":"Maximum limit for the consumption metric.","example":1,"minimum":0},"unlimited":{"type":"boolean","description":"Indicates whether there is a limit for the consumption metric or not.","example":true},"unitOfMeasure":{"$ref":"#/components/schemas/UnitOfMeasure"},"type":{"type":"string","description":"The license type.","example":"PAID","enum":["PRODUCTION","BETA","INTERNAL","PARTNER","TRIAL","PAID","EVAL"]},"id":{"$ref":"#/components/schemas/FeatureID"},"expiry":{"type":"string","format":"date-time","description":"The date on which the license expires. Represented in Coordinated Universal Time (UTC), specifically using the ISO 8601 standard.","example":"1996-02-26T00:00:00.000Z"},"gracePeriodDays":{"type":"integer","description":"Number of grace period days after the license expires.","example":30,"minimum":0}}},"CurrentInstance":{"type":"object","required":["type","version","status","features","configState"],"properties":{"id":{"type":"string","format":"uuid","example":"8ce9b80a-f7fc-48fd-ac28-8d5f3fe898d6","description":"Unique identifier for the current instance."},"telemetryLastReported":{"type":"string","format":"date-time","description":"Date and time when telemetry data was last reported from the current instance. Represented in Coordinated Universal Time (UTC), specifically using the ISO 8601 standard.","example":"1996-02-26T00:00:00.000Z"},"type":{"type":"string","example":"NGINX Controller","description":"Product type."},"status":{"type":"string","description":"Status of the current instance with respect to the license.\n\n- `NONE`: The current instance is not yet licensed.\n- `INVALID`: The current instance has at least one entitlement in non-functional license status.\n- `ENFORCED`: The current instance has at least one entitlement in enforced license status and no entitlements in non-functional status.\n- `GRACE`: The current instance has at least one entitlement in grace period license status and no entitlements in enforced or non-functional status.\n- `VALID`: The current instance has valid entitlement(s) that have no adverse license statuses.\n- `CORRUPTED`: The license for the current instance is corrupted. Upload the license file again to rectify the status.\n","enum":["NONE","INVALID","ENFORCED","GRACE","VALID","CORRUPTED"]},"version":{"type":"string","example":"3.3.0","description":"Product version."},"configState":{"$ref":"#/components/schemas/ConfigState"},"features":{"type":"array","items":{"$ref":"#/components/schemas/FeatureStatus"},"description":"List of the available features and their current usage."}}},"FeatureStatus":{"type":"object","required":["name","unitOfMeasure","id"],"properties":{"name":{"type":"string","description":"Name of the product feature.","example":"NGINX Controller Load Balancing"},"used":{"type":"number","description":"Amount of the feature used by the current NGINX Controller instance.","example":1,"minimum":0},"aggregateUsed":{"type":"number","description":"Amount of the feature used by all NGINX Controller instances in the bucket.","example":1,"minimum":0},"remaining":{"type":"number","description":"Amount of the feature remaining.","example":1,"minimum":0},"unitOfMeasure":{"$ref":"#/components/schemas/UnitOfMeasure"},"id":{"$ref":"#/components/schemas/FeatureID"},"daysUntilExpiry":{"type":"integer","description":"Defines when the current entitlement expires.","example":20,"minimum":0},"gracePeriodRemainingDays":{"type":"integer","description":"Defines the remaining grace period days after the license expires.","minimum":0}}},"UnitOfMeasure":{"type":"string","enum":["INSTANCES","WORKLOADS","DATA_PER_HOUR_IN_GB","SUCCESSFUL_API_CALLS_IN_MILLIONS","SUCCESSFUL_API_CALLS"],"description":"Unit of measure used for computing consumption.","example":"WORKLOADS"},"FeatureID":{"type":"string","enum":["UNKNOWN","ADC","APIM","ANALYTICS"],"example":"ADC","description":"Unique identifier for a product feature."},"LicenseName":{"type":"string","description":"Name of the License resource.","example":"controller-provided"},"NginxPlusLicensesList":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/NginxPlusLicenseResponse"}}}},"NginxPlusLicenseResponse":{"type":"object","required":["metadata","currentStatus","desiredState"],"properties":{"metadata":{"$ref":"#/components/schemas/ResourceMeta"},"currentStatus":{"$ref":"#/components/schemas/NginxPlusKeys"},"desiredState":{"$ref":"#/components/schemas/NginxPlusKeys"}},"example":{"metadata":{"name":"controller-provided","ref":"/platform/licenses/nginx-plus-licenses/controller-provided","kind":"license"},"currenStatus":{"certKey":"a valid certificate key for NGINX Plus","privateKey":"a valid private key for NGINX Plus"},"desiredState":{"certKey":"a valid certificate key for NGINX Plus","privateKey":"a valid private key for NGINX Plus"}}},"NginxPlusKeys":{"type":"object","required":["certKey","privateKey"],"properties":{"certKey":{"type":"string","description":"Contents of the certificate file that is required to install NGINX Plus.\n"},"privateKey":{"type":"string","description":"Contents of the key file that is required to install NGINX Plus.\n"}}},"SelfLinks":{"type":"object","description":"The SelfLinks object contains a link from the resource to itself.\nThis object is used only in responses.\n","properties":{"rel":{"type":"string","example":"/api/v1/services/environments/prod","description":"`rel` contains the complete path fragment of a URI and can be used\nto construct a query to the object.\n"}}},"ResourceMeta":{"type":"object","required":["name"],"properties":{"name":{"type":"string","pattern":"^[^A-Z\\s\\x00-\\x1f\\x60\\x7f\\;\\*\\\"\\[\\]\\{\\}\\\\\\/%\\?:=&\\~\\^|#<>]+$","not":{"type":"string","enum":[".",".."]},"minLength":1,"maxLength":1024,"example":"resource-name","description":"Resource name is a unique identifier for a resource within the context of a namespace.\nResource names must conform to [RFC 1738 Section 2.2](https://www.ietf.org/rfc/rfc1738.txt) and have a valid syntax for email addresses. The following rules are enforced:\n\n- do not utilize URL encoding;\n- do not include spaces;\n- do not use uppercase characters, for example, 'A-Z'; extended character sets are supported;\n- do not use the following characters: `\"`, `*`, `:`, `;`, `/`, `\\`, `%`, `?`, `hash`, `=`, `&`, `|`, `~`, `^`, `{`, `}`, `[`, `]`, `<`, `>`;\n- cannot start or end with an `@` sign;\n- cannot be only `.` or `..`\n\nFor example: For a collection resource located at\n\n`https://controller.example.com/api/v1/services/apps/shopping_@1`\n\nthe resource name is \"shopping_@1\".\n"},"displayName":{"type":"string","example":"My Display Name","description":"`displayName` is a user friendly resource name. It can be used to define \na longer, and less constrained, name for a resource.\n\nDisplay names:\n\n- are optional (defaults to an empty string if no value is provided),\n- do not have to be unique, \n- cannot be assigned by the server.\n"},"description":{"type":"string","example":"This is a sample description string. It provides information about the resource.","description":"`description` is a free-form text property. You can use it to provide information that helps \nto identify the resource.\n\nDescriptions:\n\n- are optional (defaults to an empty string if no value is provided),\n- do not have to be unique, \n- cannot be assigned by the server.\n"},"kind":{"type":"string","example":"<collection>-<object>","description":"Kind is a string representation of an API resource's data type.\nIt is assigned by the server and cannot be changed. \n\nWhen creating a `kind`, the server uses hyphens to connect word segments; \nsingleton and collection item resources are not pluralized.\n"},"uid":{"type":"string","format":"uuid","example":"d290f1ee-6c54-4b01-90e6-d701748f0851","description":"Unique Identifier (UID)\n\nUID is a unique identifier in time and space for a resource. \nWhen you create a resource, the server assigns a UID to the resource.\n\nRefer to [IETF RFC 4122](https://tools.ietf.org/html/rfc4122) for more information.\n"},"tags":{"type":"array","items":{"type":"string"},"example":["production_public","dev","new_app","us-west-1","emea"],"description":"You can assign `tags` to a resource as a way to help map, scope, \nand organize resources. \n\nThe system uses tag selectors to specify selection criteria that \nmatch resources that have particular tags.\n"},"ref":{"type":"string","example":"/services/environments/prod","description":"The `ref` field contains a reference to another NGINX Controller resource.\n"},"links":{"$ref":"#/components/schemas/SelfLinks"},"createTime":{"type":"string","format":"date-time","example":"2019-07-29T09:12:33.001Z","description":"A timestamp that represents the server time when the resource was created.\n\nCreate time is not guaranteed to be set in \"happens-before\" order\nacross separate operations.\n\nIn JSON format, `create_time` type is encoded as a string in the\n[RFC 3339](https://www.ietf.org/rfc/rfc3339.txt).\n\nFor example: 2018-04-01T01:30:15.01Z\n\nCreate Time is assigned by the server and cannot be changed.\n"},"updateTime":{"type":"string","format":"date-time","example":"2019-07-29T10:12:33.001Z","description":"A timestamp that represents the server time when the resource was last modified.\n\nResources that have never been updated do not have an `update_time` stamp.\n\nThe default value for resources that have never been updated is the local \nlanguage-specific equivalent of \"null\".\n\nIn JSON format, `update_time` type is encoded as a string as described in \n[RFC 3339](https://www.ietf.org/rfc/rfc3339.txt).\n"}}},"ConfigStateTally":{"type":"object","properties":{"isConfigured":{"type":"boolean","description":"The configuration operation is complete."},"isConfiguring":{"type":"boolean","description":"The configuration of the resource, or of its child(ren), is in process."},"isError":{"type":"boolean","description":"An error occurred while configuring the resource or its child(ren)."},"isDeleting":{"type":"boolean","description":"A delete operation is in progress for the resource or its child(ren)."},"total":{"type":"integer","description":"The total number of resources to which the configuration operation applies."},"configured":{"type":"integer","description":"The number of resources that have a complete and valid configuration."},"configuring":{"type":"integer","description":"The number of resources that are in the process of being configured."},"error":{"type":"integer","description":"The number of resources that have encountered an error during the configuration process."},"deleting":{"type":"integer","description":"The number of resources that are in the process of being deleted."}}},"ConfigCondition":{"type":"object","properties":{"type":{"type":"string","description":"The condition type."},"message":{"type":"string","description":"A human-readable message that provides additional information about the configuration operation."}}},"ConfigState":{"type":"object","description":"A representation of the resource's current configuration state \nthat comprises the status of the resource itself (`selfConfigState`) and any child \nresources (`childrenConfigState`).\n\nThe conditions array provides additional information during configuration changes.\n","properties":{"selfConfigState":{"$ref":"#/components/schemas/ConfigStateTally"},"childrenConfigState":{"$ref":"#/components/schemas/ConfigStateTally"},"conditions":{"type":"array","items":{"$ref":"#/components/schemas/ConfigCondition"}}}},"ErrorDetail":{"type":"object","required":["description"],"properties":{"description":{"type":"string","example":"Error doing <action>: <reason for error>. This can lead to <potential consequences>. Try <action> to resolve the issue.","description":"A detailed error message returned by the server. \n\nThese messages contain the following information, where applicable:\n\n- What happened.\n- Why it happened.\n- What the consequences are (if any).\n- Recommended action to take to resolve the issue.\n"}}},"ErrorModel":{"type":"object","required":["message","code"],"properties":{"message":{"type":"string","example":"Error doing <action>.","description":"A human-readable message, in English, that describes the error.\n"},"code":{"type":"integer","example":1234567,"description":"A numeric error code that can be used to identify errors for support purposes.\n"},"details":{"type":"array","items":{"$ref":"#/components/schemas/ErrorDetail"}}}}}}}
/ platform / license
/ platform / licenses / nginx-plus-licenses
/ platform / licenses / nginx-plus-licenses / {licenseName}
/ platform / license-file
Groups API OpenAPI	{"openapi":"3.0.0","info":{"version":"v1","title":"Groups API","description":"Use the Groups API to manage NGINX Controller authentication groups."},"servers":[{"description":"NGINX Controller API","url":"https://{{CONTROLLER_FQDN}}/api/v1"}],"paths":{"/platform/auth/groups":{"get":{"tags":["Groups"],"summary":"List Authentication Groups","description":"Returns an unfiltered list of all of the authentication groups.\n\nAn authentication group (or \"AuthN Group\") is a collection of Roles. All AuthN Groups are globally unique. You can assign AuthN Groups to external authentication provider properties (such as AD Groups).\n","operationId":"getGroups","responses":{"200":{"description":"Successfully retrieved a list of all authentication groups.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GroupListResponse"},"example":{"items":[{"currentStatus":{"roles":[{"ref":"/platform/roles/admin","links":{"rel":"/api/v1/platform/roles/admin","name":"admin","displayName":"Admin Role"}}]},"desiredState":{"roles":[{"ref":"/platform/roles/user"}]},"metadata":{"createTime":"2020-02-24T21:29:59.866708Z","kind":"group","name":"us-group-1"}}]}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"500":{"$ref":"#/components/responses/Internal"}}},"post":{"tags":["Groups"],"summary":"Add an Authentication Group","description":"Creates a new authentication group.","operationId":"createGroup","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Group"},"example":{"desiredState":{"roles":[{"ref":"/platform/roles/user"},{"ref":"/platform/roles/custom-1"}]},"metadata":{"kind":"group","name":"group-1"}}}}},"responses":{"201":{"description":"Successfully created the requested authentication group.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Group"},"example":{"currentStatus":{"roles":[{"ref":"/platform/roles/user","links":{"rel":"/api/v1/platform/roles/user","name":"user","displayName":"User Role"}},{"ref":"/platform/roles/custom-1","links":{"rel":"/api/v1/platform/roles/custom-1","name":"custom-1","displayName":"First Custom Role"}}]},"desiredState":{"roles":[{"ref":"/platform/roles/user"},{"ref":"/platform/roles/custom-1"}]},"metadata":{"createTime":"2020-02-24T22:55:51.729272Z","kind":"group","name":"group-1"}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"409":{"$ref":"#/components/responses/Conflict"},"500":{"$ref":"#/components/responses/Internal"}}}},"/platform/auth/groups/{groupName}":{"get":{"tags":["Groups"],"summary":"Get an Authentication Group","description":"Returns information about a specific Authentication Group resource.\n","operationId":"getGroupByName","parameters":[{"$ref":"#/components/parameters/groupName"}],"responses":{"200":{"description":"Successfully retrieved the requested Authentication Group resource.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Group"},"example":{"currentStatus":{"roles":[{"ref":"/platform/roles/user","links":{"rel":"/api/v1/platform/roles/user","name":"user","displayName":"User Role"}},{"ref":"/platform/roles/custom-1","links":{"rel":"/api/v1/platform/roles/custom-1","name":"custom-1","displayName":"First Custom Role"}}]},"desiredState":{"roles":[{"ref":"/platform/roles/user"},{"ref":"/platform/roles/custom-1"}]},"metadata":{"createTime":"2020-02-24T22:38:33.842929Z","kind":"group","name":"group-1"}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/Internal"}}},"put":{"tags":["Groups"],"summary":"Upsert an Authentication Group","description":"Creates a new Authentication Group resource or updates an existing Authentication Group.\n","operationId":"upsertGroup","parameters":[{"$ref":"#/components/parameters/groupName"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Group"},"example":{"desiredState":{"roles":[{"ref":"/platform/roles/user"},{"ref":"/platform/roles/custom-1"}]},"metadata":{"kind":"group","name":"group-1"}}}}},"responses":{"200":{"description":"Successfully updated the specified group.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Group"},"example":{"currentStatus":{"roles":[{"ref":"/platform/roles/user","links":{"rel":"/api/v1/platform/roles/user","name":"user","displayName":"User Role"}},{"ref":"/platform/roles/custom-1","links":{"rel":"/api/v1/platform/roles/custom-1","name":"custom-1","displayName":"First Custom Role"}}]},"desiredState":{"roles":[{"ref":"/platform/roles/user"},{"ref":"/platform/roles/custom-1"}]},"metadata":{"createTime":"2020-02-24T22:38:33.842929Z","kind":"group","name":"group-1","updateTime":"2020-02-24T22:53:14.340686Z"}}}}},"201":{"description":"Successfully created the specified group.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Group"},"example":{"currentStatus":{"roles":[{"ref":"/platform/roles/user","links":{"rel":"/api/v1/platform/roles/user","name":"user","displayName":"User Role"}},{"ref":"/platform/roles/custom-1","links":{"rel":"/api/v1/platform/roles/custom-1","name":"custom-1","displayName":"First Custom Role"}}]},"desiredState":{"roles":[{"ref":"/platform/roles/user"},{"ref":"/platform/roles/custom-1"}]},"metadata":{"createTime":"2020-02-24T22:38:33.842929Z","kind":"group","name":"group-1","updateTime":"2020-02-24T22:53:14.340686Z"}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"500":{"$ref":"#/components/responses/Internal"}}},"delete":{"tags":["Groups"],"summary":"Delete an Authentication Group","description":"Deletes a specific authentication group.","operationId":"deleteGroup","parameters":[{"$ref":"#/components/parameters/groupName"}],"responses":{"204":{"description":"Succesfully deleted the authentication group. No content was returned."},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/Conflict"},"500":{"$ref":"#/components/responses/Internal"}}}}},"components":{"securitySchemes":{"cookieAuth":{"type":"apiKey","in":"cookie","name":"session"}},"parameters":{"groupName":{"in":"path","name":"groupName","schema":{"type":"string"},"required":true,"description":"The name of the group.\n"}},"responses":{"BadRequest":{"description":"Bad input parameter, or possibly a bad URI. Check the input for typos and try again.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"},"example":{"code":3801,"message":"Error parsing group from the request payload: bad request. Check that the request is well-formed, then try resending the request."}}}},"Unauthorized":{"description":"User authentication is invalid or missing.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"},"example":{"code":401,"message":"authentication needed"}}}},"Forbidden":{"description":"The request failed due to insufficient privileges.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"},"example":{"code":403,"message":"unauthorized"}}}},"Internal":{"description":"The request cannot be processed because of an internal server error.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"},"example":{"code":3811,"message":"Error upserting group: an internal error occurred while processing your request. Try resending the request."}}}},"NotFound":{"description":"The specified authentication group was not found.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"},"example":{"code":8920,"message":"Error getting or deleting group: group not found."}}}},"Conflict":{"description":"The request failed due to a conflict with an existing Authentication Group or Authentication Provider resource.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"},"example":{"code":8919,"message":"Error creating group: group already exists."}}}}},"schemas":{"GroupListResponse":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/Group"},"description":"Contains list of authentication groups.\n"}}},"Group":{"type":"object","required":["metadata","desiredState"],"properties":{"metadata":{"$ref":"#/components/schemas/ResourceMeta"},"desiredState":{"$ref":"#/components/schemas/GroupDef"},"currentStatus":{"$ref":"#/components/schemas/GroupDef"}}},"GroupDef":{"type":"object","required":["roles"],"description":"An authentication group (or \"AuthN Group\") is a collection of Roles. All AuthN Groups are globally unique. You can assign AuthN Groups to external authentication provider properties (such as an AD Group).\n","properties":{"roles":{"type":"array","minItems":1,"items":{"$ref":"#/components/schemas/ResourceRef"}}}},"SelfLinks":{"type":"object","description":"The SelfLinks object contains a link from the resource to itself.\nThis object is used only in responses.\n","properties":{"rel":{"type":"string","example":"/api/v1/services/environments/prod","description":"`rel` contains the complete path fragment of a URI and can be used\nto construct a query to the object.\n"}}},"ResourceMeta":{"type":"object","required":["name"],"properties":{"name":{"type":"string","pattern":"^[^A-Z\\s\\x00-\\x1f\\x60\\x7f\\;\\*\\\"\\[\\]\\{\\}\\\\\\/%\\?:=&\\~\\^|#<>]+$","not":{"type":"string","enum":[".",".."]},"minLength":1,"maxLength":1024,"example":"resource-name","description":"Resource name is a unique identifier for a resource within the context of a namespace.\nResource names must conform to [RFC 1738 Section 2.2](https://www.ietf.org/rfc/rfc1738.txt) and have a valid syntax for email addresses. The following rules are enforced:\n\n- do not utilize URL encoding;\n- do not include spaces;\n- do not use uppercase characters, for example, 'A-Z'; extended character sets are supported;\n- do not use the following characters: `\"`, `*`, `:`, `;`, `/`, `\\`, `%`, `?`, `hash`, `=`, `&`, `|`, `~`, `^`, `{`, `}`, `[`, `]`, `<`, `>`;\n- cannot start or end with an `@` sign;\n- cannot be only `.` or `..`\n\nFor example: For a collection resource located at\n\n`https://controller.example.com/api/v1/services/apps/shopping_@1`\n\nthe resource name is \"shopping_@1\".\n"},"displayName":{"type":"string","example":"My Display Name","description":"`displayName` is a user friendly resource name. It can be used to define \na longer, and less constrained, name for a resource.\n\nDisplay names:\n\n- are optional (defaults to an empty string if no value is provided),\n- do not have to be unique, \n- cannot be assigned by the server.\n"},"description":{"type":"string","example":"This is a sample description string. It provides information about the resource.","description":"`description` is a free-form text property. You can use it to provide information that helps \nto identify the resource.\n\nDescriptions:\n\n- are optional (defaults to an empty string if no value is provided),\n- do not have to be unique, \n- cannot be assigned by the server.\n"},"kind":{"type":"string","example":"<collection>-<object>","description":"Kind is a string representation of an API resource's data type.\nIt is assigned by the server and cannot be changed. \n\nWhen creating a `kind`, the server uses hyphens to connect word segments; \nsingleton and collection item resources are not pluralized.\n"},"uid":{"type":"string","format":"uuid","example":"d290f1ee-6c54-4b01-90e6-d701748f0851","description":"Unique Identifier (UID)\n\nUID is a unique identifier in time and space for a resource. \nWhen you create a resource, the server assigns a UID to the resource.\n\nRefer to [IETF RFC 4122](https://tools.ietf.org/html/rfc4122) for more information.\n"},"tags":{"type":"array","items":{"type":"string"},"example":["production_public","dev","new_app","us-west-1","emea"],"description":"You can assign `tags` to a resource as a way to help map, scope, \nand organize resources. \n\nThe system uses tag selectors to specify selection criteria that \nmatch resources that have particular tags.\n"},"ref":{"type":"string","example":"/services/environments/prod","description":"The `ref` field contains a reference to another NGINX Controller resource.\n"},"links":{"$ref":"#/components/schemas/SelfLinks"},"createTime":{"type":"string","format":"date-time","example":"2019-07-29T09:12:33.001Z","description":"A timestamp that represents the server time when the resource was created.\n\nCreate time is not guaranteed to be set in \"happens-before\" order\nacross separate operations.\n\nIn JSON format, `create_time` type is encoded as a string in the\n[RFC 3339](https://www.ietf.org/rfc/rfc3339.txt).\n\nFor example: 2018-04-01T01:30:15.01Z\n\nCreate Time is assigned by the server and cannot be changed.\n"},"updateTime":{"type":"string","format":"date-time","example":"2019-07-29T10:12:33.001Z","description":"A timestamp that represents the server time when the resource was last modified.\n\nResources that have never been updated do not have an `update_time` stamp.\n\nThe default value for resources that have never been updated is the local \nlanguage-specific equivalent of \"null\".\n\nIn JSON format, `update_time` type is encoded as a string as described in \n[RFC 3339](https://www.ietf.org/rfc/rfc3339.txt).\n"}}},"NamedLinks":{"allOf":[{"$ref":"#/components/schemas/SelfLinks"},{"type":"object","description":"Contains information about the object being referred to.\n\nThese are generally details -- like the object name and display name --\nthat are useful to a consumer of the API that performs further\nprocessing. \n\nThis object is only present in responses.\n \n","properties":{"name":{"type":"string","example":"production","description":"The name of the linked resource.\n"},"displayName":{"type":"string","example":"Production Environment","description":"A user friendly resource name."}}}]},"ResourceRef":{"type":"object","required":["ref"],"properties":{"ref":{"type":"string","example":"/services/environments/prod","description":"A reference to another NGINX Controller resource.\n"},"links":{"$ref":"#/components/schemas/NamedLinks"}}},"ErrorDetail":{"type":"object","required":["description"],"properties":{"description":{"type":"string","example":"Error doing <action>: <reason for error>. This can lead to <potential consequences>. Try <action> to resolve the issue.","description":"A detailed error message returned by the server. \n\nThese messages contain the following information, where applicable:\n\n- What happened.\n- Why it happened.\n- What the consequences are (if any).\n- Recommended action to take to resolve the issue.\n"}}},"ErrorModel":{"type":"object","required":["message","code"],"properties":{"message":{"type":"string","example":"Error doing <action>.","description":"A human-readable message, in English, that describes the error.\n"},"code":{"type":"integer","example":1234567,"description":"A numeric error code that can be used to identify errors for support purposes.\n"},"details":{"type":"array","items":{"$ref":"#/components/schemas/ErrorDetail"}}}}}}}
/ platform / auth / groups
/ platform / auth / groups / {groupName}
DevPortals API OpenAPI	{"openapi":"3.0.0","servers":[{"description":"NGINX Controller API","url":"https://{{CONTROLLER_FQDN}}/api/v1"}],"info":{"title":"DevPortals API","description":"Use the DevPortals API to manage DevPortals resources.","version":"v1"},"paths":{"/services/environments/{environmentName}/devportals":{"get":{"tags":["DevPortals"],"summary":"List all DevPortals","description":"Returns a list of all DevPortal resources.\n","operationId":"ListDevPortals","responses":{"200":{"description":"Successfully retrieved a list of all DevPortals resources.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DevPortalsList"}}}}},"400":{"description":"Illegal input parameter or malformed URI specified. Check for typos and try again.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}}}},"post":{"tags":["DevPortals"],"summary":"Create DevPortal","description":"Creates new Dev Portal resource.","operationId":"CreateDevPortal","requestBody":{"description":"A Dev Portal.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DevPortal"}}}},"responses":{"201":{"description":"Successfully created a specified Dev Portal resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DevPortal"}}}},"202":{"description":"Dev Portal resource has been accepted for creation. A Dev Portal will be created after it is done configuring.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DevPortal"}}}},"400":{"description":"Illegal input parameter or malformed URI specified. Check for typos and try again.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"404":{"description":"The resource defined in the URI could not be found. Check the URI for errors and try again.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"409":{"description":"The request failed due to a naming conflict with an existing resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}}}},"parameters":[{"name":"environmentName","description":"The name of the Environment that contains the DevPortal.","in":"path","required":true,"schema":{"$ref":"#/components/schemas/EnvironmentName"}}]},"/services/environments/{environmentName}/devportals/{devPortalName}":{"get":{"tags":["DevPortals"],"summary":"Get Dev Portal","description":"Gets the information for a specific Dev Portal resource.\n","operationId":"GetDevPortal","responses":{"200":{"description":"Successfully retrieved information for the requested Dev Portal resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DevPortal"}}}},"400":{"description":"Illegal input parameter or malformed URI specified. Check for typos and try again.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"404":{"description":"The resource defined in the URI could not be found. Check the URI for errors and try again.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}}}},"put":{"tags":["DevPortals"],"summary":"Upsert Dev Portal","description":"Creates a new Dev Portal resource or updates an existing Dev Portal resource.\n","operationId":"UpsertDevPortal","requestBody":{"description":"Defines a Dev Portal resource to create or update.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DevPortal"}}}},"responses":{"200":{"description":"Successfully updated the specified Dev Portal resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DevPortal"}}}},"201":{"description":"Successfully created the specified Dev Portal resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DevPortal"}}}},"202":{"description":"The Dev Portal resource has been accepted for creation or update. Dev Portal will be created or updated after it is done configuring.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DevPortal"}}}},"400":{"description":"Illegal input parameter or malformed URI specified. Check for typos and try again.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"404":{"description":"The resource defined in the URI could not be found. Check the URI for errors and try again.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}}}},"delete":{"tags":["DevPortals"],"summary":"Delete a DevPortal","description":"Deletes the specified Dev Portal resource.\nYou must delete all of a Dev Portal's child resources before you delete the Dev Portal.\n","operationId":"DeleteDevPortal","responses":{"202":{"description":"The DevPortal resource has been marked for deletion. DevPortal will be deleted after the underlying resources have been deleted.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DevPortal"}}}},"204":{"description":"Successfully deleted the specified DevPortal resource.\n"},"404":{"description":"The resource defined in the URI could not be found. Check the URI for errors and try again.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"409":{"description":"The request to delete the specified App resource failed.\nThe App contains references to active objects and cannot be deleted. Delete the child objects or remove the references, then try again.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}}}},"parameters":[{"name":"environmentName","description":"The name of the Environment that contains the DevPortal.","in":"path","required":true,"schema":{"$ref":"#/components/schemas/EnvironmentName"}},{"name":"devPortalName","description":"The name of the DevPortal.","in":"path","required":true,"schema":{"type":"string"}}]}},"components":{"schemas":{"DevPortalsList":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/DevPortal"}}}},"DevPortal":{"type":"object","description":"A Dev Portal.","required":["metadata","desiredState"],"properties":{"metadata":{"$ref":"#/components/schemas/ResourceMeta"},"desiredState":{"$ref":"#/components/schemas/DevPortalDesiredState"},"currentStatus":{"$ref":"#/components/schemas/DevPortalCurrentStatus"}},"additionalProperties":false},"DevPortalDesiredState":{"type":"object","required":["ingress"],"properties":{"ingress":{"type":"object","required":["gatewayRefs"],"properties":{"gatewayRefs":{"type":"array","description":"Reference to the Gateways that act as a Developer Portal.","items":{"$ref":"#/components/schemas/ResourceRef"}}},"additionalProperties":false},"devPortalTheme":{"$ref":"#/components/schemas/DevPortalTheme"},"publishedApiRefs":{"type":"array","items":{"$ref":"#/components/schemas/ResourceRef"}},"devPortalType":{"type":"string","enum":["private","public","partner"]}},"additionalProperties":false},"DevPortalCurrentStatus":{"type":"object","properties":{"ingress":{"type":"object","required":["gatewayRefs"],"properties":{"gatewayRefs":{"type":"array","description":"Reference to the Gateways that act as a Developer Portal.","items":{"$ref":"#/components/schemas/ResourceRef"}}}},"state":{"$ref":"#/components/schemas/ConfigState"},"devPortalTheme":{"$ref":"#/components/schemas/DevPortalTheme"},"publishedApiRefs":{"type":"array","items":{"$ref":"#/components/schemas/ResourceRef"}},"publishedTime":{"type":"string","format":"date-time","example":"2019-07-29T10:12:33.001Z","description":"Published time is a timestamp that represents the server time when the resource was published.\nResources that have never been published do not have an `published_time` stamp.\nThe default value is language-specific and, in general, should be equivalent of the null construct.\nIn JSON format, `published_time` type is encoded as a string as described in [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt).\n\nFor example: 2018-04-01T01:30:15.01Z\n"}}},"DevPortalTheme":{"description":"Specifies the theming for the Developer Portal.","type":"object","properties":{"overrideDefaultTheme":{"type":"boolean","example":false,"description":"Override the default Dev Portal theme with a custom theme."},"customConfig":{"type":"object","properties":{"primary":{"$ref":"#/components/schemas/ThemeConfig"},"secondary":{"$ref":"#/components/schemas/ThemeConfig"},"fonts":{"type":"object","properties":{"assignments":{"$ref":"#/components/schemas/FontAssignments"}},"additionalProperties":false}},"additionalProperties":false},"brandName":{"$ref":"#/components/schemas/BrandName"},"logo":{"$ref":"#/components/schemas/FileEncodedString"},"defaultLogo":{"$ref":"#/components/schemas/FileEncodedString"},"favicon":{"$ref":"#/components/schemas/FileEncodedString"}},"additionalProperties":false},"ThemeConfig":{"type":"object","properties":{"color":{"$ref":"#/components/schemas/ThemeConfigColors"}},"additionalProperties":false},"ThemeConfigColors":{"type":"object","properties":{"primary":{"type":"string","example":"#575fe6","description":"A CSS color string used as a primary brand theme color."},"accent":{"type":"string","example":"#48dbac","description":"A CSS color string used as an optional second brand theme color."},"gray":{"type":"string","example":"#1e1f27","description":"A CSS color string used to generate a grayscale color palette."},"link":{"type":"string","example":"#0f55bd","description":"A CSS color string used to generate anchor link colors."},"fill":{"type":"string","example":"#fafbfc","description":"A CSS color string used as the main background color."},"ink":{"type":"string","example":"#323441","description":"A CSS color string used as the main text color."},"status":{"$ref":"#/components/schemas/ThemeConfigStatusColors"}},"additionalProperties":false},"ThemeConfigStatusColors":{"type":"object","description":"A collection of CSS color strings used to indicate status.","properties":{"info":{"type":"string","example":"#20a9ea","description":"A CSS color string used to indicate an informational status."},"success":{"type":"string","example":"#37c497","description":"A CSS color string used to indicate a success status."},"error":{"type":"string","example":"#ed4f54","description":"A CSS color string used to indicate an error status."},"warning":{"type":"string","example":"#ffb900","description":"A CSS color string used to indicate a warning status."}},"additionalProperties":false},"ThemeConfigFonts":{"type":"object","description":"A collection of fonts for theming typography.","properties":{"headings":{"allOf":[{"$ref":"#/components/schemas/ThemeConfigFont"}],"description":"A font used for headlines."},"body":{"allOf":[{"$ref":"#/components/schemas/ThemeConfigFont"}],"description":"A font used for body copy."},"cta":{"allOf":[{"$ref":"#/components/schemas/ThemeConfigFont"}],"description":"A font used for calls to action."},"code":{"allOf":[{"$ref":"#/components/schemas/ThemeConfigFont"}],"description":"A font used for code and syntax highlighting."},"special":{"allOf":[{"$ref":"#/components/schemas/ThemeConfigFont"}],"description":"A font used for special accent typography."},"baseFontSize":{"$ref":"#/components/schemas/BaseFontSize"},"embeddedLink":{"$ref":"#/components/schemas/EmbeddedLink"}},"additionalProperties":false},"ThemeConfigFont":{"type":"object","properties":{"kind":{"type":"string","enum":["google-web-font"]},"value":{"type":"string"}},"additionalProperties":false},"FileEncodedString":{"type":"string","example":"c29tZXRoaW5nIA==","description":"Base64 encoded string of a logo."},"BrandName":{"type":"string","example":"Acme","description":"Name of the brand."},"BaseFontSize":{"type":"integer","example":14},"EmbeddedLink":{"type":"string"},"FontAssignments":{"type":"object","$ref":"#/components/schemas/ThemeConfigFonts"},"EnvironmentName":{"type":"string"},"SelfLinks":{"type":"object","description":"The SelfLinks object contains a link from the resource to itself.\nThis object is used only in responses.\n","properties":{"rel":{"type":"string","example":"/api/v1/services/environments/prod","description":"`rel` contains the complete path fragment of a URI and can be used\nto construct a query to the object.\n"}}},"ResourceMeta":{"type":"object","required":["name"],"properties":{"name":{"type":"string","pattern":"^[^A-Z\\s\\x00-\\x1f\\x60\\x7f\\;\\*\\\"\\[\\]\\{\\}\\\\\\/%\\?:=&\\~\\^|#<>]+$","minLength":1,"maxLength":1024,"example":"resource-name","description":"Resource name is a unique identifier for a resource within the context of a namespace.\nResource names must conform to [RFC 1738 Section 2.2](https://www.ietf.org/rfc/rfc1738.txt) and have a valid syntax for email addresses. The following rules are enforced:\n\n- do not utilize URL encoding;\n- do not include spaces;\n- do not use uppercase characters, for example, 'A-Z'; extended character sets are supported;\n- do not use the following characters: `\"`, `*`, `:`, `;`, `/`, `\\`, `%`, `?`, `hash`, `=`, `&`, `|`, `~`, `^`, `{`, `}`, `[`, `]`, `<`, `>`;\n- cannot start or end with an `@` sign;\n\nFor example: For a collection resource located at\n\n`https://controller.example.com/api/v1/services/apps/shopping_@1`\n\nthe resource name is \"shopping_@1\".\n"},"displayName":{"type":"string","example":"My Display Name","description":"`displayName` is a user friendly resource name. It can be used to define \na longer, and less constrained, name for a resource.\n\nDisplay names:\n\n- are optional (defaults to an empty string if no value is provided),\n- do not have to be unique, \n- cannot be assigned by the server.\n"},"description":{"type":"string","example":"This is a sample description string. It provides information about the resource.","description":"`description` is a free-form text property. You can use it to provide information that helps \nto identify the resource.\n\nDescriptions:\n\n- are optional (defaults to an empty string if no value is provided),\n- do not have to be unique, \n- cannot be assigned by the server.\n"},"kind":{"type":"string","example":"<collection>-<object>","description":"Kind is a string representation of an API resource's data type.\nIt is assigned by the server and cannot be changed. \n\nWhen creating a `kind`, the server uses hyphens to connect word segments; \nsingleton and collection item resources are not pluralized.\n"},"uid":{"type":"string","format":"uuid","example":"d290f1ee-6c54-4b01-90e6-d701748f0851","description":"Unique Identifier (UID)\n\nUID is a unique identifier in time and space for a resource. \nWhen you create a resource, the server assigns a UID to the resource.\n\nRefer to [IETF RFC 4122](https://tools.ietf.org/html/rfc4122) for more information.\n"},"tags":{"type":"array","items":{"type":"string"},"example":["production_public","dev","new_app","us-west-1","emea"],"description":"You can assign `tags` to a resource as a way to help map, scope, \nand organize resources. \n\nThe system uses tag selectors to specify selection criteria that \nmatch resources that have particular tags.\n"},"ref":{"type":"string","example":"/services/environments/prod","description":"The `ref` field contains a reference to another NGINX Controller resource.\n"},"links":{"$ref":"#/components/schemas/SelfLinks"},"createTime":{"type":"string","format":"date-time","example":"2019-07-29T09:12:33.001Z","description":"A timestamp that represents the server time when the resource was created.\n\nCreate time is not guaranteed to be set in \"happens-before\" order\nacross separate operations.\n\nIn JSON format, `create_time` type is encoded as a string in the\n[RFC 3339](https://www.ietf.org/rfc/rfc3339.txt).\n\nFor example: 2018-04-01T01:30:15.01Z\n\nCreate Time is assigned by the server and cannot be changed.\n"},"updateTime":{"type":"string","format":"date-time","example":"2019-07-29T10:12:33.001Z","description":"A timestamp that represents the server time when the resource was last modified.\n\nResources that have never been updated do not have an `update_time` stamp.\n\nThe default value for resources that have never been updated is the local \nlanguage-specific equivalent of \"null\".\n\nIn JSON format, `update_time` type is encoded as a string as described in \n[RFC 3339](https://www.ietf.org/rfc/rfc3339.txt).\n"}}},"NamedLinks":{"allOf":[{"$ref":"#/components/schemas/SelfLinks"},{"type":"object","description":"Contains information about the object being referred to.\n\nThese are generally details -- like the object name and display name --\nthat are useful to a consumer of the API that performs further\nprocessing. \n\nThis object is only present in responses.\n \n","properties":{"name":{"type":"string","example":"production","description":"The name of the linked resource.\n"},"displayName":{"type":"string","example":"Production Environment","description":"A user friendly resource name."}}}]},"ResourceRef":{"type":"object","required":["ref"],"properties":{"ref":{"type":"string","example":"/services/environments/prod","description":"A reference to another NGINX Controller resource.\n"},"links":{"$ref":"#/components/schemas/NamedLinks"}}},"ConfigStateTally":{"type":"object","properties":{"isConfigured":{"type":"boolean","description":"The configuration operation is complete."},"isConfiguring":{"type":"boolean","description":"The configuration of the resource, or of its child(ren), is in process."},"isError":{"type":"boolean","description":"An error occurred while configuring the resource or its child(ren)."},"isDeleting":{"type":"boolean","description":"A delete operation is in progress for the resource or its child(ren)."},"total":{"type":"integer","description":"The total number of resources to which the configuration operation applies."},"configured":{"type":"integer","description":"The number of resources that have a complete and valid configuration."},"configuring":{"type":"integer","description":"The number of resources that are in the process of being configured."},"error":{"type":"integer","description":"The number of resources that have encountered an error during the configuration process."},"deleting":{"type":"integer","description":"The number of resources that are in the process of being deleted."}}},"ConfigCondition":{"type":"object","properties":{"type":{"type":"string","description":"The condition type."},"message":{"type":"string","description":"A human-readable message that provides additional information about the configuration operation."}}},"ConfigState":{"type":"object","description":"A representation of the resource's current configuration state \nthat comprises the status of the resource itself (`selfConfigState`) and any child \nresources (`childrenConfigState`).\n\nThe conditions array provides additional information during configuration changes.\n","properties":{"selfConfigState":{"$ref":"#/components/schemas/ConfigStateTally"},"childrenConfigState":{"$ref":"#/components/schemas/ConfigStateTally"},"conditions":{"type":"array","items":{"$ref":"#/components/schemas/ConfigCondition"}}}},"ErrorDetail":{"type":"object","required":["description"],"properties":{"description":{"type":"string","example":"Error doing <action>: <reason for error>. This can lead to <potential consequences>. Try <action> to resolve the issue.","description":"A detailed error message returned by the server. \n\nThese messages contain the following information, where applicable:\n\n- What happened.\n- Why it happened.\n- What the consequences are (if any).\n- Recommended action to take to resolve the issue.\n"}}},"ErrorModel":{"type":"object","required":["message","code"],"properties":{"message":{"type":"string","example":"Error doing <action>.","description":"A human-readable message, in English, that describes the error.\n"},"code":{"type":"integer","example":1234567,"description":"A numeric error code that can be used to identify errors for support purposes.\n"},"details":{"type":"array","items":{"$ref":"#/components/schemas/ErrorDetail"}}}}}}}
/ services / environments / {environmentName} / devportals
/ services / environments / {environmentName} / devportals / {devPortalName}
Published APIs API OpenAPI	{"openapi":"3.0.0","info":{"title":"Published APIs API","description":"Use the Published APIs API to manage your APIs by using the API Management module.","version":"v1"},"servers":[{"description":"NGINX Controller API","url":"https://{{CONTROLLER_FQDN}}/api/v1"}],"paths":{"/services/environments/{environmentName}/apps/{appName}/published-apis":{"get":{"tags":["Published APIs"],"summary":"List Published APIs","description":"Returns a list of all Published APIs for the specified Environment and App.\n","operationId":"listPublishedAPIs","responses":{"200":{"description":"Successfully retrieved the list of Published APIs for the specified Environment.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublishedAPIList"}}}},"400":{"description":"Bad input parameter, or possibly a bad URI. Check the input for typos and try again.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"404":{"description":"The resource defined in the URI could not be found. Check the URI for errors and try again.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}}}},"parameters":[{"$ref":"#/components/parameters/environmentName"},{"$ref":"#/components/parameters/appName"}]},"/services/environments/{environmentName}/apps/{appName}/published-apis/{publishedApiName}":{"get":{"tags":["Published APIs"],"summary":"Get a Published API","description":"Gets information about the specified Published API.\n","operationId":"getPublishedAPI","responses":{"200":{"description":"Successfully retrieved the specified Published API resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublishedAPI"}}}},"400":{"description":"Bad input parameter, or possibly a bad URI. Check the input for typos and try again.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"404":{"description":"The specified Published API resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}}}},"put":{"tags":["Published APIs"],"summary":"Upsert a Published API","description":"Creates a new Published API or updates an existing Published API resource.","operationId":"upsertPublishedAPI","requestBody":{"description":"Defines the Published API to create, or the updates to apply to an existing Published API resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublishedAPI"}}}},"responses":{"200":{"description":"Successfully updated the specified Published API resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublishedAPI"}}}},"201":{"description":"Successfully created the requested Published API resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublishedAPI"}}}},"202":{"description":"The request to create a Published API succeeded. The resource will be created when the configuration is complete.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublishedAPI"}}}},"400":{"description":"Bad input parameter, or possibly a bad URI. Check the input for typos and try again.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"404":{"description":"The resource defined in the URI could not be found. Check the URI for errors and try again.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}}}},"delete":{"tags":["Published APIs"],"summary":"Delete a Published API","description":"Deletes the specified Published API resource.","operationId":"deletePublishedAPI","responses":{"202":{"description":"Published API has been marked for deletion. The resource will be\ndeleted after the publish/cleanup succeeds.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublishedAPI"}}}},"204":{"description":"Successfully deleted the specified Published API resource. No content is returned."},"400":{"description":"Bad input parameter, or possibly a bad URI. Check the input for typos and try again.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"404":{"description":"The specified Published API resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"409":{"description":"The request failed due to a naming conflict with an existing resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}}}},"parameters":[{"$ref":"#/components/parameters/environmentName"},{"$ref":"#/components/parameters/appName"},{"$ref":"#/components/parameters/publishedApiName"}]}},"components":{"schemas":{"PublishedAPIList":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/PublishedAPI"}}}},"PublishedAPI":{"type":"object","properties":{"metadata":{"$ref":"#/components/schemas/ResourceMeta"},"currentStatus":{"$ref":"#/components/schemas/PublishedAPICurrentStatus"},"desiredState":{"$ref":"#/components/schemas/PublishedAPIDesiredState"}}},"PublishedAPICurrentStatus":{"type":"object","properties":{"state":{"$ref":"#/components/schemas/ConfigState"},"basePath":{"type":"string","default":"/"},"stripWorkloadBasePath":{"type":"boolean","default":true},"componentRefs":{"type":"array","items":{"$ref":"#/components/schemas/ResourceRef"}},"apiDefinitionVersionRef":{"description":"Reference to the Version of the API Definition.\n","$ref":"#/components/schemas/ResourceRef"},"gatewayRefs":{"type":"array","description":"Reference to the Gateway associated with the Published API.","items":{"$ref":"#/components/schemas/ResourceRef"}},"devportalRefs":{"type":"array","description":"Reference to the Dev Portal associated with the Published API.","items":{"$ref":"#/components/schemas/ResourceRef"}}}},"PublishedAPIDesiredState":{"type":"object","required":["apiDefinitionVersionRef","gatewayRefs"],"properties":{"basePath":{"type":"string","default":"/"},"stripWorkloadBasePath":{"type":"boolean","default":true},"apiDefinitionVersionRef":{"description":"Reference to the Version of the API Definition.\n","$ref":"#/components/schemas/ResourceRef"},"gatewayRefs":{"type":"array","description":"Reference to the Gateway associated with the Published API.","items":{"$ref":"#/components/schemas/ResourceRef"}},"devportalRefs":{"type":"array","description":"Reference to the Dev Portal associated with the Published API.","items":{"$ref":"#/components/schemas/ResourceRef"}}}},"EnvironmentName":{"type":"string"},"AppName":{"type":"string"},"SelfLinks":{"type":"object","description":"The SelfLinks object contains a link from the resource to itself.\nThis object is used only in responses.\n","properties":{"rel":{"type":"string","example":"/api/v1/services/environments/prod","description":"`rel` contains the complete path fragment of a URI and can be used\nto construct a query to the object.\n"}}},"ResourceMeta":{"type":"object","required":["name"],"properties":{"name":{"type":"string","pattern":"^[^A-Z\\s\\x00-\\x1f\\x60\\x7f\\;\\*\\\"\\[\\]\\{\\}\\\\\\/%\\?:=&\\~\\^|#<>]+$","minLength":1,"maxLength":1024,"example":"resource-name","description":"Resource name is a unique identifier for a resource within the context of a namespace.\nResource names must conform to [RFC 1738 Section 2.2](https://www.ietf.org/rfc/rfc1738.txt) and have a valid syntax for email addresses. The following rules are enforced:\n\n- do not utilize URL encoding;\n- do not include spaces;\n- do not use uppercase characters, for example, 'A-Z'; extended character sets are supported;\n- do not use the following characters: `\"`, `*`, `:`, `;`, `/`, `\\`, `%`, `?`, `hash`, `=`, `&`, `|`, `~`, `^`, `{`, `}`, `[`, `]`, `<`, `>`;\n- cannot start or end with an `@` sign;\n\nFor example: For a collection resource located at\n\n`https://controller.example.com/api/v1/services/apps/shopping_@1`\n\nthe resource name is \"shopping_@1\".\n"},"displayName":{"type":"string","example":"My Display Name","description":"`displayName` is a user friendly resource name. It can be used to define \na longer, and less constrained, name for a resource.\n\nDisplay names:\n\n- are optional (defaults to an empty string if no value is provided),\n- do not have to be unique, \n- cannot be assigned by the server.\n"},"description":{"type":"string","example":"This is a sample description string. It provides information about the resource.","description":"`description` is a free-form text property. You can use it to provide information that helps \nto identify the resource.\n\nDescriptions:\n\n- are optional (defaults to an empty string if no value is provided),\n- do not have to be unique, \n- cannot be assigned by the server.\n"},"kind":{"type":"string","example":"<collection>-<object>","description":"Kind is a string representation of an API resource's data type.\nIt is assigned by the server and cannot be changed. \n\nWhen creating a `kind`, the server uses hyphens to connect word segments; \nsingleton and collection item resources are not pluralized.\n"},"uid":{"type":"string","format":"uuid","example":"d290f1ee-6c54-4b01-90e6-d701748f0851","description":"Unique Identifier (UID)\n\nUID is a unique identifier in time and space for a resource. \nWhen you create a resource, the server assigns a UID to the resource.\n\nRefer to [IETF RFC 4122](https://tools.ietf.org/html/rfc4122) for more information.\n"},"tags":{"type":"array","items":{"type":"string"},"example":["production_public","dev","new_app","us-west-1","emea"],"description":"You can assign `tags` to a resource as a way to help map, scope, \nand organize resources. \n\nThe system uses tag selectors to specify selection criteria that \nmatch resources that have particular tags.\n"},"ref":{"type":"string","example":"/services/environments/prod","description":"The `ref` field contains a reference to another NGINX Controller resource.\n"},"links":{"$ref":"#/components/schemas/SelfLinks"},"createTime":{"type":"string","format":"date-time","example":"2019-07-29T09:12:33.001Z","description":"A timestamp that represents the server time when the resource was created.\n\nCreate time is not guaranteed to be set in \"happens-before\" order\nacross separate operations.\n\nIn JSON format, `create_time` type is encoded as a string in the\n[RFC 3339](https://www.ietf.org/rfc/rfc3339.txt).\n\nFor example: 2018-04-01T01:30:15.01Z\n\nCreate Time is assigned by the server and cannot be changed.\n"},"updateTime":{"type":"string","format":"date-time","example":"2019-07-29T10:12:33.001Z","description":"A timestamp that represents the server time when the resource was last modified.\n\nResources that have never been updated do not have an `update_time` stamp.\n\nThe default value for resources that have never been updated is the local \nlanguage-specific equivalent of \"null\".\n\nIn JSON format, `update_time` type is encoded as a string as described in \n[RFC 3339](https://www.ietf.org/rfc/rfc3339.txt).\n"}}},"ConfigStateTally":{"type":"object","properties":{"isConfigured":{"type":"boolean","description":"The configuration operation is complete."},"isConfiguring":{"type":"boolean","description":"The configuration of the resource, or of its child(ren), is in process."},"isError":{"type":"boolean","description":"An error occurred while configuring the resource or its child(ren)."},"isDeleting":{"type":"boolean","description":"A delete operation is in progress for the resource or its child(ren)."},"total":{"type":"integer","description":"The total number of resources to which the configuration operation applies."},"configured":{"type":"integer","description":"The number of resources that have a complete and valid configuration."},"configuring":{"type":"integer","description":"The number of resources that are in the process of being configured."},"error":{"type":"integer","description":"The number of resources that have encountered an error during the configuration process."},"deleting":{"type":"integer","description":"The number of resources that are in the process of being deleted."}}},"ConfigCondition":{"type":"object","properties":{"type":{"type":"string","description":"The condition type."},"message":{"type":"string","description":"A human-readable message that provides additional information about the configuration operation."}}},"ConfigState":{"type":"object","description":"A representation of the resource's current configuration state \nthat comprises the status of the resource itself (`selfConfigState`) and any child \nresources (`childrenConfigState`).\n\nThe conditions array provides additional information during configuration changes.\n","properties":{"selfConfigState":{"$ref":"#/components/schemas/ConfigStateTally"},"childrenConfigState":{"$ref":"#/components/schemas/ConfigStateTally"},"conditions":{"type":"array","items":{"$ref":"#/components/schemas/ConfigCondition"}}}},"NamedLinks":{"allOf":[{"$ref":"#/components/schemas/SelfLinks"},{"type":"object","description":"Contains information about the object being referred to.\n\nThese are generally details -- like the object name and display name --\nthat are useful to a consumer of the API that performs further\nprocessing. \n\nThis object is only present in responses.\n \n","properties":{"name":{"type":"string","example":"production","description":"The name of the linked resource.\n"},"displayName":{"type":"string","example":"Production Environment","description":"A user friendly resource name."}}}]},"ResourceRef":{"type":"object","required":["ref"],"properties":{"ref":{"type":"string","example":"/services/environments/prod","description":"A reference to another NGINX Controller resource.\n"},"links":{"$ref":"#/components/schemas/NamedLinks"}}},"ErrorDetail":{"type":"object","required":["description"],"properties":{"description":{"type":"string","example":"Error doing <action>: <reason for error>. This can lead to <potential consequences>. Try <action> to resolve the issue.","description":"A detailed error message returned by the server. \n\nThese messages contain the following information, where applicable:\n\n- What happened.\n- Why it happened.\n- What the consequences are (if any).\n- Recommended action to take to resolve the issue.\n"}}},"ErrorModel":{"type":"object","required":["message","code"],"properties":{"message":{"type":"string","example":"Error doing <action>.","description":"A human-readable message, in English, that describes the error.\n"},"code":{"type":"integer","example":1234567,"description":"A numeric error code that can be used to identify errors for support purposes.\n"},"details":{"type":"array","items":{"$ref":"#/components/schemas/ErrorDetail"}}}}},"parameters":{"apiDefinitionName":{"name":"apiDefinitionName","in":"path","description":"The name of the API Definition resource.","required":true,"style":"simple","explode":false,"example":"shopping-app-api-def","schema":{"type":"string"}},"environmentName":{"name":"environmentName","in":"path","description":"The name of the parent Environment resource.","required":true,"style":"simple","explode":false,"example":"dev","schema":{"$ref":"#/components/schemas/EnvironmentName"}},"appName":{"name":"appName","in":"path","description":"The name of the parent App resource.","required":true,"style":"simple","explode":false,"example":"shopping-app","schema":{"$ref":"#/components/schemas/AppName"}},"publishedApiName":{"name":"publishedApiName","in":"path","description":"The name of the Published API resource.","required":true,"style":"simple","explode":false,"example":"shopping-app-api-staging","schema":{"type":"string"}},"versionName":{"name":"version","in":"path","description":"The Version of the API Definition.","required":true,"style":"simple","explode":false,"example":"v1_2fd4e1c6","schema":{"type":"string"}}}}}
/ services / environments / {environmentName} / apps / {appName} / published-apis
/ services / environments / {environmentName} / apps / {appName} / published-apis / {publishedApiName}
Login API OpenAPI	{"openapi":"3.0.0","info":{"version":"v1","title":"Login API","description":"Use the Login API to retrieve an authentication cookie. Include the session ID that's in the authentication cookie in the request header for all subsequent requests."},"servers":[{"description":"NGINX Controller API","url":"https://{{CONTROLLER_FQDN}}/api/v1"}],"paths":{"/platform/login":{"post":{"tags":["Login"],"summary":"Log in to NGINX Controller","description":"Logs in to the NGINX Controller platform and returns the user account's authentication cookie.\n\nThe session ID is returned in an authentication cookie named `session`. You must include this session ID in the request header for all subsequent requests to authenticate to the platform. For example:\n\n`curl -X GET --cookie 'session=<session cookie>' --header 'Content-type: application/json' 'https://192.0.2.10/api/v1/platform/global'`\n\n- The maximum session lifetime is 8 hours. Sessions are purged within 5 minutes of expiring. Once the session lifetime limit is exceeded, you must log in to obtain a fresh session token.\n- Sessions are purged immediately on logout.\n- Sessions are purged immediately if the user is removed.\n","operationId":"login","requestBody":{"description":"A JSON object containing the type and the authentication information itself.\n- If type == 'BASIC', then the username and password are required.\n- If type == 'ACTIVE_DIRECTORY', then the authentication provider name, username, and password are required.\n- If type == 'AZURE_ACTIVE_DIRECTORY', then the authentication provider name, and type are required.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Login"}}}},"security":[],"responses":{"200":{"description":"Received request to login with OIDC. Returns the Azure's authorization URL for SSO.\n"},"204":{"description":"Successfully authenticated.\nThe session ID is returned in an authentication cookie named `session`. You must include this session ID in the request header for all subsequent requests.\n","headers":{"Set-Cookie":{"schema":{"type":"string","example":"session=.eJwlzjEOwzAIQNG7MGcA22DIZSKbgNI1aaaqd2-kLn96w; HttpOnly; Secure; Path=/"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"409":{"$ref":"#/components/responses/StatusConflict"},"500":{"$ref":"#/components/responses/Internal"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}}},"get":{"tags":["Login"],"summary":"Get Login Session","description":"Checks the validity of the current user's session. Returns the user's account info if the session is valid.","operationId":"sessionsStatus","responses":{"200":{"description":"Successfully validated the session ID and returned the associated user account info.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/User"},"example":{"currentStatus":{"account":"1","authn":"amplify","email":"nobody@nodomain.com","firstName":"nobody","id":777,"lastLogin":1580759750,"lastName":"here","password":"********","roles":[{"links":{"rel":"/api/v1/platform/roles/guest","name":"guest"},"ref":"/platform/roles/guest"}],"groups":[{"links":{"rel":"/api/v1/platform/auth/groups/guest","name":"guest"},"ref":"/platform/groups/guest"}]},"desiredState":{"email":"nobody@nodomain.com","firstName":"nobody","lastName":"here","password":"********","roles":[{"ref":"/platform/roles/guest"}]},"metadata":{"createTime":"2020-02-03T19:15:24.916809Z","kind":"user","name":"nobody@nodomain.com","updateTime":"2020-02-03T19:55:50.291147Z"}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"500":{"$ref":"#/components/responses/Internal"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}}}},"/platform/oidc-handler":{"get":{"summary":"OIDC redirect URL, that handles Login into controller using OIDC","description":"The endpoint that OIDC provider talks to after authenticating the user. It returns the user account's authentication cookie.\n\nThe session ID is returned in an authentication cookie named `session`. You must include this session ID in the request header for all subsequent requests to authenticate to the platform. For example:\n\n`curl -X GET --cookie 'session=<session cookie>' --header 'Content-type: application/json' 'https://192.0.2.10/api/v1/platform/global'`\n\n- The maximum session lifetime is 8 hours.\n- Sessions are purged immediately on logout.\n- Sessions are purged immediately if the user is removed or associated Auth provider is removed.\n Read more about this here https://docs.microsoft.com/en-us/azure/active-directory/develop/v2-oauth2-auth-code-flow#successful-response\n","operationId":"oidc-handler","parameters":[{"in":"query","name":"code","schema":{"type":"string"},"description":"The authorization_code that the app requested. The app exchnages teh code to get access token."},{"in":"query","name":"state","schema":{"type":"string"},"description":"State parameter is included if the app added it in the login request to the Identity provider. This helps prevent CSRF attacks."},{"in":"query","name":"error","schema":{"type":"string"},"description":"An error code string sent from the Identity provider when authentication did not go through as expected."},{"in":"query","name":"error_description","schema":{"type":"string"},"description":"A specific error message that describes the root cause of the authentication failure."}],"security":[],"responses":{"302":{"description":"Successfully authenticated and Sends Redirect back to the home page.\nThe session ID is returned in an authentication cookie named `session`. You must include this session ID in the request header for all subsequent requests.\n","headers":{"Set-Cookie":{"schema":{"type":"string","example":"session=.eJwlzjEOwzAIQNG7MGcA22DIZSKbgNI1aaaqd2-kLn96w; HttpOnly; Secure; Path=/"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}}}},"/platform/logout":{"post":{"tags":["Logout"],"summary":"Log out of NGINX Controller","description":"Logs the user account out of the NGINX Controller platform and expires the authentication cookie.","operationId":"logout","responses":{"204":{"description":"The user was successfully logged out.","headers":{"Set-Cookie":{"schema":{"type":"string","example":"session=; Expires=Jan 1 1970; Path=/"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"500":{"$ref":"#/components/responses/Internal"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}}}}},"components":{"securitySchemes":{"cookieAuth":{"type":"apiKey","in":"cookie","name":"session"}},"responses":{"BadRequest":{"description":"Bad input parameter, or possibly a bad URI. Check the request format and try again.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"},"example":{"message":"Error logging in: unknown auth type sent in request. Check the request format and try again.","code":2346}}}},"Unauthorized":{"description":"User authentication cookie is invalid or missing.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"},"example":{"message":"Error getting session status: the session is either invalid or has expired. Log in using your account credentials and then resend the request with the new session token.","code":2373}}}},"StatusConflict":{"description":"Wrong username and/or password.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"},"example":{"message":"Error logging in: incorrect username or password. Check the login credentials, then try resending the request.","code":2379}}}},"Internal":{"description":"The request cannot be processed because of an internal server error.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"},"example":{"message":"Error logging in: could not store session information. Try resending the request.","code":2372}}}},"ServiceUnavailable":{"description":"The request cannot be processed because service is unavailable. Please try resending the request. \n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"},"example":{"message":"Error retrieving the user information. Try resending the request.","code":2351}}}}},"schemas":{"Login":{"type":"object","properties":{"credentials":{"oneOf":[{"$ref":"#/components/schemas/BasicAuth"},{"$ref":"#/components/schemas/ActiveDirectoryAuth"},{"$ref":"#/components/schemas/AzureActiveDirectoryAuth"}],"discriminator":{"propertyName":"type","mapping":{"BASIC":"#/components/schemas/BasicAuth","ACTIVE_DIRECTORY":"#/components/schemas/ActiveDirectoryAuth","AZURE_ACTIVE_DIRECTORY":"#/components/schemas/AzureActiveDirectoryAuth"}},"example":{"type":"BASIC","username":"guest@nginx.com","password":"Guest#12E"}}}},"AzureActiveDirectoryAuth":{"type":"object","properties":{"type":{"type":"string","enum":["AZURE_ACTIVE_DIRECTORY"]},"providerName":{"type":"string","description":"The Azure active directory provider name configured within NGINX Controller.\n"}},"required":["type","providerName"]},"ActiveDirectoryAuth":{"type":"object","properties":{"type":{"type":"string","enum":["ACTIVE_DIRECTORY"]},"username":{"type":"string","description":"The username for the NGINX Controller User account.\n"},"password":{"type":"string","description":"The password for the NGINX Controller User account.\n"},"providerName":{"type":"string","description":"The active directory provider name configured within NGINX Controller.\n"}},"required":["type","username","password","providerName"]},"BasicAuth":{"type":"object","properties":{"type":{"type":"string","enum":["BASIC"]},"username":{"type":"string","description":"The username for the NGINX Controller User account.\n"},"password":{"type":"string","description":"The password for the NGINX Controller User account.\n"}},"required":["type","username","password"]},"SelfLinks":{"type":"object","description":"The SelfLinks object contains a link from the resource to itself.\nThis object is used only in responses.\n","properties":{"rel":{"type":"string","example":"/api/v1/services/environments/prod","description":"`rel` contains the complete path fragment of a URI and can be used\nto construct a query to the object.\n"}}},"ResourceMeta":{"type":"object","required":["name"],"properties":{"name":{"type":"string","pattern":"^[^A-Z\\s\\x00-\\x1f\\x60\\x7f\\;\\*\\\"\\[\\]\\{\\}\\\\\\/%\\?:=&\\~\\^|#<>]+$","not":{"type":"string","enum":[".",".."]},"minLength":1,"maxLength":1024,"example":"resource-name","description":"Resource name is a unique identifier for a resource within the context of a namespace.\nResource names must conform to [RFC 1738 Section 2.2](https://www.ietf.org/rfc/rfc1738.txt) and have a valid syntax for email addresses. The following rules are enforced:\n\n- do not utilize URL encoding;\n- do not include spaces;\n- do not use uppercase characters, for example, 'A-Z'; extended character sets are supported;\n- do not use the following characters: `\"`, `*`, `:`, `;`, `/`, `\\`, `%`, `?`, `hash`, `=`, `&`, `|`, `~`, `^`, `{`, `}`, `[`, `]`, `<`, `>`;\n- cannot start or end with an `@` sign;\n- cannot be only `.` or `..`\n\nFor example: For a collection resource located at\n\n`https://controller.example.com/api/v1/services/apps/shopping_@1`\n\nthe resource name is \"shopping_@1\".\n"},"displayName":{"type":"string","example":"My Display Name","description":"`displayName` is a user friendly resource name. It can be used to define \na longer, and less constrained, name for a resource.\n\nDisplay names:\n\n- are optional (defaults to an empty string if no value is provided),\n- do not have to be unique, \n- cannot be assigned by the server.\n"},"description":{"type":"string","example":"This is a sample description string. It provides information about the resource.","description":"`description` is a free-form text property. You can use it to provide information that helps \nto identify the resource.\n\nDescriptions:\n\n- are optional (defaults to an empty string if no value is provided),\n- do not have to be unique, \n- cannot be assigned by the server.\n"},"kind":{"type":"string","example":"<collection>-<object>","description":"Kind is a string representation of an API resource's data type.\nIt is assigned by the server and cannot be changed. \n\nWhen creating a `kind`, the server uses hyphens to connect word segments; \nsingleton and collection item resources are not pluralized.\n"},"uid":{"type":"string","format":"uuid","example":"d290f1ee-6c54-4b01-90e6-d701748f0851","description":"Unique Identifier (UID)\n\nUID is a unique identifier in time and space for a resource. \nWhen you create a resource, the server assigns a UID to the resource.\n\nRefer to [IETF RFC 4122](https://tools.ietf.org/html/rfc4122) for more information.\n"},"tags":{"type":"array","items":{"type":"string"},"example":["production_public","dev","new_app","us-west-1","emea"],"description":"You can assign `tags` to a resource as a way to help map, scope, \nand organize resources. \n\nThe system uses tag selectors to specify selection criteria that \nmatch resources that have particular tags.\n"},"ref":{"type":"string","example":"/services/environments/prod","description":"The `ref` field contains a reference to another NGINX Controller resource.\n"},"links":{"$ref":"#/components/schemas/SelfLinks"},"createTime":{"type":"string","format":"date-time","example":"2019-07-29T09:12:33.001Z","description":"A timestamp that represents the server time when the resource was created.\n\nCreate time is not guaranteed to be set in \"happens-before\" order\nacross separate operations.\n\nIn JSON format, `create_time` type is encoded as a string in the\n[RFC 3339](https://www.ietf.org/rfc/rfc3339.txt).\n\nFor example: 2018-04-01T01:30:15.01Z\n\nCreate Time is assigned by the server and cannot be changed.\n"},"updateTime":{"type":"string","format":"date-time","example":"2019-07-29T10:12:33.001Z","description":"A timestamp that represents the server time when the resource was last modified.\n\nResources that have never been updated do not have an `update_time` stamp.\n\nThe default value for resources that have never been updated is the local \nlanguage-specific equivalent of \"null\".\n\nIn JSON format, `update_time` type is encoded as a string as described in \n[RFC 3339](https://www.ietf.org/rfc/rfc3339.txt).\n"}}},"NamedLinks":{"allOf":[{"$ref":"#/components/schemas/SelfLinks"},{"type":"object","description":"Contains information about the object being referred to.\n\nThese are generally details -- like the object name and display name --\nthat are useful to a consumer of the API that performs further\nprocessing. \n\nThis object is only present in responses.\n \n","properties":{"name":{"type":"string","example":"production","description":"The name of the linked resource.\n"},"displayName":{"type":"string","example":"Production Environment","description":"A user friendly resource name."}}}]},"ResourceRef":{"type":"object","required":["ref"],"properties":{"ref":{"type":"string","example":"/services/environments/prod","description":"A reference to another NGINX Controller resource.\n"},"links":{"$ref":"#/components/schemas/NamedLinks"}}},"UserDef":{"type":"object","required":["firstName","lastName","email","password"],"properties":{"account":{"type":"string","minLength":1,"maxLength":64,"example":1,"deprecated":true,"description":"The account number of the tentant."},"id":{"type":"integer","example":123,"description":"Account ID"},"firstName":{"type":"string","minLength":1,"maxLength":64,"example":"John","description":"Given name."},"lastName":{"type":"string","minLength":1,"maxLength":64,"example":"Doe","description":"Surname."},"lastLogin":{"type":"integer","example":1570132969,"description":"Unix time (seconds since Epoch) of last login."},"email":{"type":"string","example":"john.doe@nginx.com","description":"An email address that serves as the account's username. This must match the resource's metadata.name property.","format":"email"},"authn":{"type":"string","enum":["amplify"]},"password":{"type":"string","format":"password","minLength":8,"maxLength":64,"description":"Passwords must meet the following requirements:\n\n - length must be between 8 and 64 characters\n - must contain at least 1 letter\n - must contain at least 1 number\n - must be different from the old password\n\n Dictionary words, mangled dictionary words, or systematic passwords like '1234567a' are not allowed.\n"},"apiKey":{"type":"string","example":"761ab961448865d86ef71c67fd74432b","deprecated":true,"description":"User api key."},"isEnabled":{"type":"boolean","description":"Indicates if the account is enabled.","default":false},"roles":{"type":"array","items":{"$ref":"#/components/schemas/ResourceRef"}},"groups":{"type":"array","items":{"$ref":"#/components/schemas/ResourceRef"}}}},"User":{"type":"object","required":["metadata","desiredState"],"properties":{"metadata":{"$ref":"#/components/schemas/ResourceMeta"},"desiredState":{"$ref":"#/components/schemas/UserDef"},"currentStatus":{"$ref":"#/components/schemas/UserDef"}}},"ErrorDetail":{"type":"object","required":["description"],"properties":{"description":{"type":"string","example":"Error doing <action>: <reason for error>. This can lead to <potential consequences>. Try <action> to resolve the issue.","description":"A detailed error message returned by the server. \n\nThese messages contain the following information, where applicable:\n\n- What happened.\n- Why it happened.\n- What the consequences are (if any).\n- Recommended action to take to resolve the issue.\n"}}},"ErrorModel":{"type":"object","required":["message","code"],"properties":{"message":{"type":"string","example":"Error doing <action>.","description":"A human-readable message, in English, that describes the error.\n"},"code":{"type":"integer","example":1234567,"description":"A numeric error code that can be used to identify errors for support purposes.\n"},"details":{"type":"array","items":{"$ref":"#/components/schemas/ErrorDetail"}}}}}}}
/ platform / login
/ platform / oidc-handler
/ platform / logout
Reset Password API OpenAPI	{"openapi":"3.0.0","info":{"version":"v1","title":"Reset Password API","description":"Use the Reset Password API to manage NGINX Controller password recovery."},"servers":[{"description":"NGINX Controller API","url":"https://{{CONTROLLER_FQDN}}/api/v1"}],"paths":{"/platform/auth/password-recovery":{"post":{"tags":["Password"],"summary":"Request password reset","description":"Creates a password recovery code for user with given email and sends an email with reset link. The reset link is valid for an hour.","operationId":"requestResetPassword","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResetPasswordRequest"},"example":{"metadata":{"name":"user@nginx.com"}}}}},"responses":{"204":{"description":"Successfully created the password recovery code. No content was returned."}}}},"/platform/auth/password-recovery/{code}":{"put":{"tags":["Password"],"summary":"Password reset","description":"Check if the new password satisfies the policy constraints and update the password for the user associated with the recovery code.","operationId":"resetPassword","parameters":[{"$ref":"#/components/parameters/code"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResetPassword"},"example":{"desiredState":{"password":"NewPaw12!"},"metadata":{"name":"user@nginx.com"}}}}},"responses":{"204":{"description":"Successfully updated the password for the user. No content was returned."},"400":{"$ref":"#/components/responses/BadRequest"},"500":{"$ref":"#/components/responses/Internal"}}}}},"components":{"parameters":{"code":{"in":"path","name":"code","schema":{"type":"string","minLength":1},"required":true,"description":"The password recovery code.\n"}},"responses":{"BadRequest":{"description":"Bad input parameter, or possibly a bad URI. Password does not follow the policy.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"},"example":{"code":1111,"message":"The user password doesn't meet the password requirements. Passwords must be between 8-64 characters in length and contain at least 1 letter and 1 number. When updating a password, the new password cannot be the same as the old password. Dictionary words, mangled dictionary words, or systematic passwords like '1234567a' are not allowed."}}}},"Internal":{"description":"The request cannot be processed because of an internal server error.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"},"example":{"code":1111,"message":"An internal error occurred while updating the password. Try again later. If the problem persists, contact the system administrator."}}}}},"schemas":{"ResetPasswordRequest":{"type":"object","required":["metadata"],"properties":{"metadata":{"$ref":"#/components/schemas/ResourceMeta"}}},"ResetPassword":{"type":"object","required":["desiredState","metadata"],"properties":{"metadata":{"$ref":"#/components/schemas/ResourceMeta"},"desiredState":{"type":"object","required":["password"],"properties":{"password":{"type":"string","format":"password","example":"TestImpl45!","minLength":8,"maxLength":64,"description":"The user's password must meet the following requirements:\n - Length must be between 8 and 64 characters\n - Must contain at least 1 letter\n - Must contain at least 1 number\n - Must be different from the old password\n - Dictionary words, mangled dictionary words, or systematic passwords like '1234567a' are not allowed.\n"}}}}},"SelfLinks":{"type":"object","description":"The SelfLinks object contains a link from the resource to itself.\nThis object is used only in responses.\n","properties":{"rel":{"type":"string","example":"/api/v1/services/environments/prod","description":"`rel` contains the complete path fragment of a URI and can be used\nto construct a query to the object.\n"}}},"ResourceMeta":{"type":"object","required":["name"],"properties":{"name":{"type":"string","pattern":"^[^A-Z\\s\\x00-\\x1f\\x60\\x7f\\;\\*\\\"\\[\\]\\{\\}\\\\\\/%\\?:=&\\~\\^|#<>]+$","not":{"type":"string","enum":[".",".."]},"minLength":1,"maxLength":1024,"example":"resource-name","description":"Resource name is a unique identifier for a resource within the context of a namespace.\nResource names must conform to [RFC 1738 Section 2.2](https://www.ietf.org/rfc/rfc1738.txt) and have a valid syntax for email addresses. The following rules are enforced:\n\n- do not utilize URL encoding;\n- do not include spaces;\n- do not use uppercase characters, for example, 'A-Z'; extended character sets are supported;\n- do not use the following characters: `\"`, `*`, `:`, `;`, `/`, `\\`, `%`, `?`, `hash`, `=`, `&`, `|`, `~`, `^`, `{`, `}`, `[`, `]`, `<`, `>`;\n- cannot start or end with an `@` sign;\n- cannot be only `.` or `..`\n\nFor example: For a collection resource located at\n\n`https://controller.example.com/api/v1/services/apps/shopping_@1`\n\nthe resource name is \"shopping_@1\".\n"},"displayName":{"type":"string","example":"My Display Name","description":"`displayName` is a user friendly resource name. It can be used to define \na longer, and less constrained, name for a resource.\n\nDisplay names:\n\n- are optional (defaults to an empty string if no value is provided),\n- do not have to be unique, \n- cannot be assigned by the server.\n"},"description":{"type":"string","example":"This is a sample description string. It provides information about the resource.","description":"`description` is a free-form text property. You can use it to provide information that helps \nto identify the resource.\n\nDescriptions:\n\n- are optional (defaults to an empty string if no value is provided),\n- do not have to be unique, \n- cannot be assigned by the server.\n"},"kind":{"type":"string","example":"<collection>-<object>","description":"Kind is a string representation of an API resource's data type.\nIt is assigned by the server and cannot be changed. \n\nWhen creating a `kind`, the server uses hyphens to connect word segments; \nsingleton and collection item resources are not pluralized.\n"},"uid":{"type":"string","format":"uuid","example":"d290f1ee-6c54-4b01-90e6-d701748f0851","description":"Unique Identifier (UID)\n\nUID is a unique identifier in time and space for a resource. \nWhen you create a resource, the server assigns a UID to the resource.\n\nRefer to [IETF RFC 4122](https://tools.ietf.org/html/rfc4122) for more information.\n"},"tags":{"type":"array","items":{"type":"string"},"example":["production_public","dev","new_app","us-west-1","emea"],"description":"You can assign `tags` to a resource as a way to help map, scope, \nand organize resources. \n\nThe system uses tag selectors to specify selection criteria that \nmatch resources that have particular tags.\n"},"ref":{"type":"string","example":"/services/environments/prod","description":"The `ref` field contains a reference to another NGINX Controller resource.\n"},"links":{"$ref":"#/components/schemas/SelfLinks"},"createTime":{"type":"string","format":"date-time","example":"2019-07-29T09:12:33.001Z","description":"A timestamp that represents the server time when the resource was created.\n\nCreate time is not guaranteed to be set in \"happens-before\" order\nacross separate operations.\n\nIn JSON format, `create_time` type is encoded as a string in the\n[RFC 3339](https://www.ietf.org/rfc/rfc3339.txt).\n\nFor example: 2018-04-01T01:30:15.01Z\n\nCreate Time is assigned by the server and cannot be changed.\n"},"updateTime":{"type":"string","format":"date-time","example":"2019-07-29T10:12:33.001Z","description":"A timestamp that represents the server time when the resource was last modified.\n\nResources that have never been updated do not have an `update_time` stamp.\n\nThe default value for resources that have never been updated is the local \nlanguage-specific equivalent of \"null\".\n\nIn JSON format, `update_time` type is encoded as a string as described in \n[RFC 3339](https://www.ietf.org/rfc/rfc3339.txt).\n"}}},"ErrorDetail":{"type":"object","required":["description"],"properties":{"description":{"type":"string","example":"Error doing <action>: <reason for error>. This can lead to <potential consequences>. Try <action> to resolve the issue.","description":"A detailed error message returned by the server. \n\nThese messages contain the following information, where applicable:\n\n- What happened.\n- Why it happened.\n- What the consequences are (if any).\n- Recommended action to take to resolve the issue.\n"}}},"ErrorModel":{"type":"object","required":["message","code"],"properties":{"message":{"type":"string","example":"Error doing <action>.","description":"A human-readable message, in English, that describes the error.\n"},"code":{"type":"integer","example":1234567,"description":"A numeric error code that can be used to identify errors for support purposes.\n"},"details":{"type":"array","items":{"$ref":"#/components/schemas/ErrorDetail"}}}}}}}
/ platform / auth / password-recovery
/ platform / auth / password-recovery / {code}
Nodes API OpenAPI	{"openapi":"3.0.0","servers":[{"description":"NGINX Controller API","url":"https://{{CONTROLLER_FQDN}}/api/v1"}],"info":{"description":"Use the Nodes API to manage NGINX Controller control-plane nodes.","version":"v1","title":"Nodes API"},"paths":{"/platform/nodes":{"get":{"tags":["Nodes"],"summary":"List all Nodes","operationId":"getNodeList","description":"Gets information about the NGINX Controller control-plane nodes.","responses":{"200":{"description":"Successfully retrieved the NGINX Controller nodes.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NodeList"},"example":{"items":[{"currentStatus":{"hostname":"host-1","ip":"192.0.2.1","state":{"conditions":[],"selfConfigState":{"configured":1,"configuring":0,"deleting":0,"error":0,"isConfigured":true,"isConfiguring":false,"isDeleting":false,"isError":false,"total":1}}},"desiredState":{"hostname":"host-1","ip":"192.0.2.1"},"metadata":{"createTime":"2020-09-30T14:14:46Z","kind":"node","name":"host-1"}},{"currentStatus":{"hostname":"host-2","ip":"192.0.2.2","state":{"conditions":[],"selfConfigState":{"configured":1,"configuring":0,"deleting":0,"error":0,"isConfigured":true,"isConfiguring":false,"isDeleting":false,"isError":false,"total":1}}},"desiredState":{"hostname":"host-2","ip":"192.0.2.2"},"metadata":{"createTime":"2020-09-30T14:19:13.755911Z","kind":"node","name":"host-2"}},{"currentStatus":{"hostname":"host-3","ip":"192.0.2.3","state":{"conditions":[],"selfConfigState":{"configured":1,"configuring":0,"deleting":0,"error":0,"isConfigured":true,"isConfiguring":false,"isDeleting":false,"isError":false,"total":1}}},"desiredState":{"hostname":"host-3","ip":"192.0.2.3"},"metadata":{"createTime":"2020-09-30T14:19:16.155299Z","kind":"node","name":"host-3"}}]}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"500":{"$ref":"#/components/responses/InternalServerError"}}},"post":{"tags":["Nodes"],"summary":"Create a Node","operationId":"addNode","description":"Creates a new NGINX Controller control-plane node.\n\nAfter a node has been created, you must install NGINX Controller on the node to finish adding the node to the cluster.\nIn the JSON response, look for the `install.sh` command and join-key located under `currentStatus.state.conditions.message`.\nThe `type` is `install`. Copy and run this command with the join-key on the new node to finish the setup.\n\nNote: (Optional) If you're adding a deleted node back to the cluster, you must uninstall NGINX Controller from the node before \nrunning the `install.sh` command with the new join-key. To uninstall NGINX Controller, run the uninstall script on the node: \n`/opt/nginx-controller/uninstall.sh`.\n","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Node"},"example":{"desiredState":{"hostname":"host-2","ip":"192.0.2.2"},"metadata":{"name":"host-2"}}}}},"responses":{"201":{"description":"Successfully created the NGINX Controller node.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Node"},"example":{"currentStatus":{"hostname":"host-2","ip":"192.0.2.2","state":{"conditions":[{"message":"install.sh --join-key eyJlbmRwb2ludCI6IjE5Mi4wLjIuMTo2NDQzIiwiY2FDZXJ0SGFzaCI6InNoYTI1Njp4IiwiZW5jcnlwdGlvblNlY3JldCI6IngiLCJ0b2tlbiI6IngiLCJjZXJ0aWZpY2F0ZUtleSI6IngifQo=","type":"install"}],"selfConfigState":{"configured":0,"configuring":1,"deleting":0,"error":0,"isConfigured":false,"isConfiguring":true,"isDeleting":false,"isError":false,"total":1}}},"desiredState":{"hostname":"host-2","ip":"192.0.2.2"},"metadata":{"createTime":"2020-10-01T10:03:39.228626Z","kind":"node","name":"host-2"}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"409":{"$ref":"#/components/responses/Conflict"},"500":{"$ref":"#/components/responses/InternalServerError"},"501":{"$ref":"#/components/responses/NotImplemented"}}}},"/platform/nodes/{nodeName}":{"get":{"tags":["Nodes"],"summary":"Get a Node","operationId":"getNode","description":"Gets information about an NGINX Controller control-plane node by name.","parameters":[{"$ref":"#/components/parameters/nodeName"}],"responses":{"200":{"description":"Successfully retrieved the specified NGINX Controller node.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Node"},"example":{"currentStatus":{"hostname":"host-2","ip":"192.0.2.2","state":{"conditions":[{"message":"install.sh --join-key eyJlbmRwb2ludCI6IjE5Mi4wLjIuMTo2NDQzIiwiY2FDZXJ0SGFzaCI6InNoYTI1Njp4IiwiZW5jcnlwdGlvblNlY3JldCI6IngiLCJ0b2tlbiI6IngiLCJjZXJ0aWZpY2F0ZUtleSI6IngifQo=","type":"install"}],"selfConfigState":{"configured":0,"configuring":1,"deleting":0,"error":0,"isConfigured":false,"isConfiguring":true,"isDeleting":false,"isError":false,"total":1}}},"desiredState":{"hostname":"host-2","ip":"192.0.2.2"},"metadata":{"createTime":"2020-10-01T10:03:39.228626Z","kind":"node","name":"host-2"}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}},"delete":{"tags":["Nodes"],"summary":"Delete a Node","operationId":"deleteNode","description":"Deletes an NGINX Controller control-plane node by name.\nThe node's status is `isDeleting` while the workloads\nare being drained from it. Once draining is complete the node is deleted.\n\nNote: (Optional) You must uninstall NGINX Controller from the deleted node before you can add the node back to the cluster. \nTo uninstall NGINX Controller, run the uninstall script on the node: `/opt/nginx-controller/uninstall.sh`.\n","parameters":[{"$ref":"#/components/parameters/nodeName"}],"responses":{"202":{"description":"Successfully scheduled the node to be deleted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Node"},"example":{"currentStatus":{"hostname":"host-2","ip":"192.0.2.2","state":{"conditions":[],"selfConfigState":{"configured":1,"configuring":0,"deleting":1,"error":0,"isConfigured":true,"isConfiguring":false,"isDeleting":true,"isError":false,"total":1}}},"desiredState":{"hostname":"host-2","ip":"192.0.2.2"},"metadata":{"createTime":"2020-10-01T10:03:39.228626Z","kind":"node","name":"host-2"}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"},"501":{"$ref":"#/components/responses/NotImplemented"}}}}},"components":{"parameters":{"nodeName":{"in":"path","name":"nodeName","description":"The name of the node.","schema":{"type":"string"},"required":true}},"responses":{"BadRequest":{"description":"Bad input parameter, or possibly a bad URI. Check the input for typos and try again.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"Unauthorized":{"description":"User authentication is invalid or missing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"Forbidden":{"description":"The request failed due to insufficient privileges.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"NotFound":{"description":"The specified Node resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"},"example":{"message":"Error getting node: node not found.","code":9001}}}},"Conflict":{"description":"The request failed due to a conflict with an existing Node resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"InternalServerError":{"description":"The request cannot be processed because of an internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"NotImplemented":{"description":"The request method is not supported by the server in the current configuration and cannot be handled.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}}},"schemas":{"NodeList":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/Node"}}}},"Node":{"type":"object","required":["metadata","desiredState"],"properties":{"metadata":{"$ref":"#/components/schemas/ResourceMeta"},"currentStatus":{"allOf":[{"properties":{"state":{"$ref":"#/components/schemas/ConfigState"}}},{"$ref":"#/components/schemas/NodeDef"}]},"desiredState":{"$ref":"#/components/schemas/NodeDef"}}},"NodeDef":{"type":"object","properties":{"hostname":{"type":"string","format":"hostname","description":"The hostname for the NGINX Controller control-plane node. When adding a node, you must provide a hostname or an IP address, or you can specify both. The hostname must be the real hostname, which you can look up by running the `hostname` command."},"ip":{"type":"string","format":"ipv4","example":"192.0.2.0","description":"The IP address for the NGINX Controller control-plane node. When adding a node, you must provide an IP address or a hostname, or you can specify both."}}},"SelfLinks":{"type":"object","description":"The SelfLinks object contains a link from the resource to itself.\nThis object is used only in responses.\n","properties":{"rel":{"type":"string","example":"/api/v1/services/environments/prod","description":"`rel` contains the complete path fragment of a URI and can be used\nto construct a query to the object.\n"}}},"ResourceMeta":{"type":"object","required":["name"],"properties":{"name":{"type":"string","pattern":"^[^A-Z\\s\\x00-\\x1f\\x60\\x7f\\;\\*\\\"\\[\\]\\{\\}\\\\\\/%\\?:=&\\~\\^|#<>]+$","not":{"type":"string","enum":[".",".."]},"minLength":1,"maxLength":1024,"example":"resource-name","description":"Resource name is a unique identifier for a resource within the context of a namespace.\nResource names must conform to [RFC 1738 Section 2.2](https://www.ietf.org/rfc/rfc1738.txt) and have a valid syntax for email addresses. The following rules are enforced:\n\n- do not utilize URL encoding;\n- do not include spaces;\n- do not use uppercase characters, for example, 'A-Z'; extended character sets are supported;\n- do not use the following characters: `\"`, `*`, `:`, `;`, `/`, `\\`, `%`, `?`, `hash`, `=`, `&`, `|`, `~`, `^`, `{`, `}`, `[`, `]`, `<`, `>`;\n- cannot start or end with an `@` sign;\n- cannot be only `.` or `..`\n\nFor example: For a collection resource located at\n\n`https://controller.example.com/api/v1/services/apps/shopping_@1`\n\nthe resource name is \"shopping_@1\".\n"},"displayName":{"type":"string","example":"My Display Name","description":"`displayName` is a user friendly resource name. It can be used to define \na longer, and less constrained, name for a resource.\n\nDisplay names:\n\n- are optional (defaults to an empty string if no value is provided),\n- do not have to be unique, \n- cannot be assigned by the server.\n"},"description":{"type":"string","example":"This is a sample description string. It provides information about the resource.","description":"`description` is a free-form text property. You can use it to provide information that helps \nto identify the resource.\n\nDescriptions:\n\n- are optional (defaults to an empty string if no value is provided),\n- do not have to be unique, \n- cannot be assigned by the server.\n"},"kind":{"type":"string","example":"<collection>-<object>","description":"Kind is a string representation of an API resource's data type.\nIt is assigned by the server and cannot be changed. \n\nWhen creating a `kind`, the server uses hyphens to connect word segments; \nsingleton and collection item resources are not pluralized.\n"},"uid":{"type":"string","format":"uuid","example":"d290f1ee-6c54-4b01-90e6-d701748f0851","description":"Unique Identifier (UID)\n\nUID is a unique identifier in time and space for a resource. \nWhen you create a resource, the server assigns a UID to the resource.\n\nRefer to [IETF RFC 4122](https://tools.ietf.org/html/rfc4122) for more information.\n"},"tags":{"type":"array","items":{"type":"string"},"example":["production_public","dev","new_app","us-west-1","emea"],"description":"You can assign `tags` to a resource as a way to help map, scope, \nand organize resources. \n\nThe system uses tag selectors to specify selection criteria that \nmatch resources that have particular tags.\n"},"ref":{"type":"string","example":"/services/environments/prod","description":"The `ref` field contains a reference to another NGINX Controller resource.\n"},"links":{"$ref":"#/components/schemas/SelfLinks"},"createTime":{"type":"string","format":"date-time","example":"2019-07-29T09:12:33.001Z","description":"A timestamp that represents the server time when the resource was created.\n\nCreate time is not guaranteed to be set in \"happens-before\" order\nacross separate operations.\n\nIn JSON format, `create_time` type is encoded as a string in the\n[RFC 3339](https://www.ietf.org/rfc/rfc3339.txt).\n\nFor example: 2018-04-01T01:30:15.01Z\n\nCreate Time is assigned by the server and cannot be changed.\n"},"updateTime":{"type":"string","format":"date-time","example":"2019-07-29T10:12:33.001Z","description":"A timestamp that represents the server time when the resource was last modified.\n\nResources that have never been updated do not have an `update_time` stamp.\n\nThe default value for resources that have never been updated is the local \nlanguage-specific equivalent of \"null\".\n\nIn JSON format, `update_time` type is encoded as a string as described in \n[RFC 3339](https://www.ietf.org/rfc/rfc3339.txt).\n"}}},"ConfigStateTally":{"type":"object","properties":{"isConfigured":{"type":"boolean","description":"The configuration operation is complete."},"isConfiguring":{"type":"boolean","description":"The configuration of the resource, or of its child(ren), is in process."},"isError":{"type":"boolean","description":"An error occurred while configuring the resource or its child(ren)."},"isDeleting":{"type":"boolean","description":"A delete operation is in progress for the resource or its child(ren)."},"total":{"type":"integer","description":"The total number of resources to which the configuration operation applies."},"configured":{"type":"integer","description":"The number of resources that have a complete and valid configuration."},"configuring":{"type":"integer","description":"The number of resources that are in the process of being configured."},"error":{"type":"integer","description":"The number of resources that have encountered an error during the configuration process."},"deleting":{"type":"integer","description":"The number of resources that are in the process of being deleted."}}},"ConfigCondition":{"type":"object","properties":{"type":{"type":"string","description":"The condition type."},"message":{"type":"string","description":"A human-readable message that provides additional information about the configuration operation."}}},"ConfigState":{"type":"object","description":"A representation of the resource's current configuration state \nthat comprises the status of the resource itself (`selfConfigState`) and any child \nresources (`childrenConfigState`).\n\nThe conditions array provides additional information during configuration changes.\n","properties":{"selfConfigState":{"$ref":"#/components/schemas/ConfigStateTally"},"childrenConfigState":{"$ref":"#/components/schemas/ConfigStateTally"},"conditions":{"type":"array","items":{"$ref":"#/components/schemas/ConfigCondition"}}}},"ErrorDetail":{"type":"object","required":["description"],"properties":{"description":{"type":"string","example":"Error doing <action>: <reason for error>. This can lead to <potential consequences>. Try <action> to resolve the issue.","description":"A detailed error message returned by the server. \n\nThese messages contain the following information, where applicable:\n\n- What happened.\n- Why it happened.\n- What the consequences are (if any).\n- Recommended action to take to resolve the issue.\n"}}},"ErrorModel":{"type":"object","required":["message","code"],"properties":{"message":{"type":"string","example":"Error doing <action>.","description":"A human-readable message, in English, that describes the error.\n"},"code":{"type":"integer","example":1234567,"description":"A numeric error code that can be used to identify errors for support purposes.\n"},"details":{"type":"array","items":{"$ref":"#/components/schemas/ErrorDetail"}}}}}}}
/ platform / nodes
/ platform / nodes / {nodeName}
Instance Templates API OpenAPI	{"openapi":"3.0.0","servers":[{"description":"NGINX Controller API","url":"https://{{CONTROLLER_FQDN}}/api/v1"}],"info":{"title":"Instance Templates API","description":"Use the Instance Templates API to manage templates that can be used to deploy new NGINX Plus instances.","version":"v1"},"paths":{"/infrastructure/locations/{locationName}/instance-templates":{"get":{"tags":["Instance Templates"],"summary":"List Instance Templates","description":"Returns an unfiltered list of all Instance Template resources in the specified Location.","operationId":"listInstanceTemplates","parameters":[{"$ref":"#/components/parameters/LocationName"}],"responses":{"200":{"description":"Successfully retrieved a list of all Instance Template resources for the specified Location.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListInstanceTemplateResponse"},"examples":{"INSTANCE_TEMPLATES":{"$ref":"#/components/examples/AWSListResponse"}}}}},"401":{"$ref":"#/components/responses/Unauthorized"}}},"post":{"tags":["Instance Templates"],"summary":"Create an Instance Template","description":"Creates a new Instance Template resource.","operationId":"addInstanceTemplate","parameters":[{"$ref":"#/components/parameters/LocationName"}],"requestBody":{"description":"Defines the Instance Template resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InstanceTemplate"},"examples":{"AWS_INSTANCE_TEMPLATE":{"$ref":"#/components/examples/AWSRequest"},"AZURE_INSTANCE_TEMPLATE":{"$ref":"#/components/examples/AzureRequestWithMarketplaceImageAndUsingExistingNic"}}}}},"responses":{"201":{"description":"Successfully created the requested Instance Template resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetInstanceTemplateResponse"},"examples":{"AWS_INSTANCE_TEMPLATE":{"$ref":"#/components/examples/AWSResponse"},"AZURE_INSTANCE_TEMPLATE":{"$ref":"#/components/examples/AzureResponse"}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"409":{"$ref":"#/components/responses/Conflict"}}}},"/infrastructure/locations/{locationName}/instance-templates/{instanceTemplateName}":{"get":{"tags":["Instance Templates"],"summary":"Get an Instance Template","description":"Gets information for the specified Instance Template resource.","operationId":"getInstanceTemplate","parameters":[{"$ref":"#/components/parameters/LocationName"},{"$ref":"#/components/parameters/InstanceTemplateName"}],"responses":{"200":{"description":"Successfully retrieved the requested Instance Template resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetInstanceTemplateResponse"},"examples":{"AWS_INSTANCE_TEMPLATE":{"$ref":"#/components/examples/AWSResponse"},"AZURE_INSTANCE_TEMPLATE":{"$ref":"#/components/examples/AzureResponse"}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"}}},"put":{"tags":["Instance Templates"],"summary":"Upsert an Instance Template","description":"Creates a new Instance Template resource or updates an existing Instance Template resource.","operationId":"upsertInstanceTemplate","parameters":[{"$ref":"#/components/parameters/LocationName"},{"$ref":"#/components/parameters/InstanceTemplateName"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InstanceTemplate"},"examples":{"AWS_INSTANCE_TEMPLATE":{"$ref":"#/components/examples/AWSRequest"},"AZURE_INSTANCE_TEMPLATE":{"$ref":"#/components/examples/AzureRequestWithCustomImageAndCreatingNewNicAndPublicIP"}}}},"required":true},"responses":{"200":{"description":"Successfully updated the specified Instance Template resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetInstanceTemplateResponse"},"examples":{"AWS_INSTANCE_TEMPLATE":{"$ref":"#/components/examples/AWSResponse"},"AZURE_INSTANCE_TEMPLATE":{"$ref":"#/components/examples/AzureResponse"}}}}},"201":{"description":"Successfully created the requested Instance Template resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetInstanceTemplateResponse"},"examples":{"AWS_INSTANCE_TEMPLATE":{"$ref":"#/components/examples/AWSResponse"},"AZURE_INSTANCE_TEMPLATE":{"$ref":"#/components/examples/AzureResponse"}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"409":{"$ref":"#/components/responses/Conflict"}}},"delete":{"tags":["Instance Templates"],"summary":"Delete an Instance Template","description":"Deletes the specified Instance Template resource.","operationId":"deleteInstanceTemplate","parameters":[{"$ref":"#/components/parameters/LocationName"},{"$ref":"#/components/parameters/InstanceTemplateName"}],"responses":{"204":{"description":"Successfully deleted the specified Instance Template resource."},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"}}}}},"components":{"parameters":{"LocationName":{"name":"locationName","in":"path","description":"The name of the Location that contains the Instance Template resource(s).","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},"InstanceTemplateName":{"name":"instanceTemplateName","in":"path","description":"The name of the Instance Template resource.","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}},"responses":{"BadRequest":{"description":"Bad input parameter, or possibly a bad URI. Check the input for typos and try again.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"},"example":{"code":121220,"message":"Error creating the instance template: could not parse the request payload. Check the format of the request, then try again."}}}},"Unauthorized":{"description":"User authentication is invalid or missing.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"},"example":{"code":401,"message":"authentication needed"}}}},"NotFound":{"description":"The specified Instance Template resource was not found.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"},"example":{"code":120903,"message":"Error getting the list of instance templates: the specified location does not exist. Check the location name, then try again."}}}},"Conflict":{"description":"The request failed due to a conflict with an existing Instance Template resource.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"},"example":{"code":121124,"message":"Error creating the instance template: the instance template already exists. Use a unique name for the instance template, then try again."}}}}},"schemas":{"InstanceTemplate":{"type":"object","required":["metadata","desiredState"],"properties":{"metadata":{"$ref":"#/components/schemas/ResourceMeta"},"desiredState":{"$ref":"#/components/schemas/InstanceTemplateState"},"currentStatus":{"$ref":"#/components/schemas/InstanceTemplateState"}}},"GetInstanceTemplateResponse":{"allOf":[{"$ref":"#/components/schemas/InstanceTemplate"}]},"ListInstanceTemplateResponse":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/InstanceTemplate"}}}},"InstanceTemplateState":{"oneOf":[{"$ref":"#/components/schemas/AWSInstanceTemplate"},{"$ref":"#/components/schemas/AzureInstanceTemplate"}],"discriminator":{"propertyName":"type","mapping":{"AWS_INSTANCE_TEMPLATE":"#/components/schemas/AWSInstanceTemplate","AZURE_INSTANCE_TEMPLATE":"#/components/schemas/AzureInstanceTemplate"}}},"AWSInstanceTemplate":{"type":"object","required":["type","amiID","instanceType","subnetID"],"properties":{"type":{"type":"string","description":"The type of Instance Template.","enum":["AWS_INSTANCE_TEMPLATE"]},"amiID":{"type":"string","description":"The AWS `amiID` for the image to use when deploying an Instance using the template.\n"},"instanceType":{"type":"string","description":"The machine size.\n"},"subnetID":{"type":"string","description":"The `subnetID` of the AWS subnet where new Instances created using the Instance Template should reside.\n\nThe specified subnet must be in the same AWS Virtual Private Cloud (VPC) as the Instance Template's parent Location resource.\n"},"securityGroupIDs":{"type":"array","description":"The list of AWS securityGroupIDs that you want to apply to new Instances. \n\nThe Security GroupIDs must be available in the same AWS region and Virtual Private Cloud (VPC) as the Instance Template's parent Location resource.\n","items":{"type":"string"}},"publicKey":{"type":"string","description":"Provide the public key that you want to use to authenticate to the EC2 instance that this template will create. \n"},"associatePublicIPAddress":{"type":"boolean","description":"Specify if a public IP address should be assigned to the instance.\n"}}},"AzureInstanceTemplate":{"x-f5-experimental":true,"type":"object","required":["type","instanceType","image","networkInterface","adminUser","publicKey"],"properties":{"type":{"type":"string","description":"The type of Instance Template.","enum":["AZURE_INSTANCE_TEMPLATE"]},"image":{"$ref":"#/components/schemas/AzureImage"},"instanceType":{"type":"string","description":"The virtual machine size and type."},"networkInterface":{"$ref":"#/components/schemas/AzureNetworkInterface"},"adminUser":{"type":"string","description":"The name of the administration account."},"publicKey":{"type":"string","description":"The Public Key string for the adminUser."}}},"AzureImage":{"type":"object","oneOf":[{"$ref":"#/components/schemas/AzureImageID"},{"$ref":"#/components/schemas/AzureImageReference"}],"discriminator":{"propertyName":"type","mapping":{"AZURE_IMAGE_ID":"#/components/schemas/AzureImageID","AZURE_IMAGE_REFERENCE":"#/components/schemas/AzureImageReference"}}},"AzureImageID":{"type":"object","description":"The Azure resource ID for the image to use when deploying an Instance.","required":["type","imageID"],"properties":{"type":{"type":"string","description":"The type of the Azure Image.","enum":["AZURE_IMAGE_ID"]},"imageID":{"type":"string","description":"The resource ID of the Azure image."}}},"AzureImageReference":{"type":"object","description":"The parameters that identify which Azure Marketplace image to use for the Instance.","required":["type","publisher","offer","sku"],"properties":{"type":{"type":"string","description":"The type of the Azure Image.","enum":["AZURE_IMAGE_REFERENCE"]},"publisher":{"type":"string","description":"The publisher of the Azure Marketplace image."},"offer":{"type":"string","description":"The offer of the Azure Marketplace image."},"sku":{"type":"string","description":"The SKU of the Azure Marketplace image."},"version":{"type":"string","description":"The version of the Azure Marketplace image (default is latest)."}}},"AzureNetworkInterface":{"type":"object","oneOf":[{"$ref":"#/components/schemas/AzureNetworkID"},{"$ref":"#/components/schemas/AzureNetworkConfig"}],"discriminator":{"propertyName":"type","mapping":{"AZURE_NIC_ID":"#/components/schemas/AzureNetworkID","AZURE_NIC_CONFIG":"#/components/schemas/AzureNetworkConfig"}}},"AzureNetworkID":{"type":"object","description":"Identifies the existing Azure Network Interface that you want the Instance to use.","required":["type","nicID"],"properties":{"type":{"type":"string","description":"The type of the Azure Network Interface.","enum":["AZURE_NIC_ID"]},"nicID":{"type":"string","description":"The ID of the Azure Network Interface."}}},"AzureNetworkConfig":{"type":"object","description":"The parameters needed to create a new Azure Network Interface for the Instance.","required":["type","virtualNetwork","subnet"],"properties":{"type":{"type":"string","description":"The type of the Azure Network Interface.","enum":["AZURE_NIC_CONFIG"]},"virtualNetwork":{"type":"string","description":"Identifies the existing Virtual Network to be associated with the Network Interface."},"subnet":{"type":"string","description":"Identifies the existing Subnet to be associated with the Network Interface."},"securityGroup":{"type":"string","description":"Identifies the existing Network Security Group to be associated with the Network Interface."},"publicIp":{"type":"boolean","default":false,"description":"If true a public IP address will be created and associated with the Network Interface."}}},"SelfLinks":{"type":"object","description":"The SelfLinks object contains a link from the resource to itself.\nThis object is used only in responses.\n","properties":{"rel":{"type":"string","example":"/api/v1/services/environments/prod","description":"`rel` contains the complete path fragment of a URI and can be used\nto construct a query to the object.\n"}}},"ResourceMeta":{"type":"object","required":["name"],"properties":{"name":{"type":"string","pattern":"^[^A-Z\\s\\x00-\\x1f\\x60\\x7f\\;\\*\\\"\\[\\]\\{\\}\\\\\\/%\\?:=&\\~\\^|#<>]+$","minLength":1,"maxLength":1024,"example":"resource-name","description":"Resource name is a unique identifier for a resource within the context of a namespace.\nResource names must conform to [RFC 1738 Section 2.2](https://www.ietf.org/rfc/rfc1738.txt) and have a valid syntax for email addresses. The following rules are enforced:\n\n- do not utilize URL encoding;\n- do not include spaces;\n- do not use uppercase characters, for example, 'A-Z'; extended character sets are supported;\n- do not use the following characters: `\"`, `*`, `:`, `;`, `/`, `\\`, `%`, `?`, `hash`, `=`, `&`, `|`, `~`, `^`, `{`, `}`, `[`, `]`, `<`, `>`;\n- cannot start or end with an `@` sign;\n\nFor example: For a collection resource located at\n\n`https://controller.example.com/api/v1/services/apps/shopping_@1`\n\nthe resource name is \"shopping_@1\".\n"},"displayName":{"type":"string","example":"My Display Name","description":"`displayName` is a user friendly resource name. It can be used to define \na longer, and less constrained, name for a resource.\n\nDisplay names:\n\n- are optional (defaults to an empty string if no value is provided),\n- do not have to be unique, \n- cannot be assigned by the server.\n"},"description":{"type":"string","example":"This is a sample description string. It provides information about the resource.","description":"`description` is a free-form text property. You can use it to provide information that helps \nto identify the resource.\n\nDescriptions:\n\n- are optional (defaults to an empty string if no value is provided),\n- do not have to be unique, \n- cannot be assigned by the server.\n"},"kind":{"type":"string","example":"<collection>-<object>","description":"Kind is a string representation of an API resource's data type.\nIt is assigned by the server and cannot be changed. \n\nWhen creating a `kind`, the server uses hyphens to connect word segments; \nsingleton and collection item resources are not pluralized.\n"},"uid":{"type":"string","format":"uuid","example":"d290f1ee-6c54-4b01-90e6-d701748f0851","description":"Unique Identifier (UID)\n\nUID is a unique identifier in time and space for a resource. \nWhen you create a resource, the server assigns a UID to the resource.\n\nRefer to [IETF RFC 4122](https://tools.ietf.org/html/rfc4122) for more information.\n"},"tags":{"type":"array","items":{"type":"string"},"example":["production_public","dev","new_app","us-west-1","emea"],"description":"You can assign `tags` to a resource as a way to help map, scope, \nand organize resources. \n\nThe system uses tag selectors to specify selection criteria that \nmatch resources that have particular tags.\n"},"ref":{"type":"string","example":"/services/environments/prod","description":"The `ref` field contains a reference to another NGINX Controller resource.\n"},"links":{"$ref":"#/components/schemas/SelfLinks"},"createTime":{"type":"string","format":"date-time","example":"2019-07-29T09:12:33.001Z","description":"A timestamp that represents the server time when the resource was created.\n\nCreate time is not guaranteed to be set in \"happens-before\" order\nacross separate operations.\n\nIn JSON format, `create_time` type is encoded as a string in the\n[RFC 3339](https://www.ietf.org/rfc/rfc3339.txt).\n\nFor example: 2018-04-01T01:30:15.01Z\n\nCreate Time is assigned by the server and cannot be changed.\n"},"updateTime":{"type":"string","format":"date-time","example":"2019-07-29T10:12:33.001Z","description":"A timestamp that represents the server time when the resource was last modified.\n\nResources that have never been updated do not have an `update_time` stamp.\n\nThe default value for resources that have never been updated is the local \nlanguage-specific equivalent of \"null\".\n\nIn JSON format, `update_time` type is encoded as a string as described in \n[RFC 3339](https://www.ietf.org/rfc/rfc3339.txt).\n"}}},"ErrorDetail":{"type":"object","required":["description"],"properties":{"description":{"type":"string","example":"Error doing <action>: <reason for error>. This can lead to <potential consequences>. Try <action> to resolve the issue.","description":"A detailed error message returned by the server. \n\nThese messages contain the following information, where applicable:\n\n- What happened.\n- Why it happened.\n- What the consequences are (if any).\n- Recommended action to take to resolve the issue.\n"}}},"ErrorModel":{"type":"object","required":["message","code"],"properties":{"message":{"type":"string","example":"Error doing <action>.","description":"A human-readable message, in English, that describes the error.\n"},"code":{"type":"integer","example":1234567,"description":"A numeric error code that can be used to identify errors for support purposes.\n"},"details":{"type":"array","items":{"$ref":"#/components/schemas/ErrorDetail"}}}}},"examples":{"AWSRequest":{"value":{"metadata":{"name":"my-instance-template","description":"AWS Instance Template for T2 large","displayName":"T2large-InstanceTemplate","tags":["dev","prod"]},"desiredState":{"type":"AWS_INSTANCE_TEMPLATE","amiID":"ami-a0cfeed8","instanceType":"t2.large","subnetID":"subnet-12345678","securityGroupIDs":["sg-12345678","sg-98765432"],"publicKey":"my-public-key","associatePublicIPAddress":true}}},"AzureRequestWithMarketplaceImageAndUsingExistingNic":{"value":{"metadata":{"name":"my-azure-template-for-standard-A1","description":"Azure Instance Template for Standard A1","displayName":"Standard_A1-instance-template","tags":["dev","prod"]},"desiredState":{"type":"AZURE_INSTANCE_TEMPLATE","image":{"type":"AZURE_IMAGE_REFERENCE","publisher":"nginxinc","offer":"nginx-plus-v1","sku":"nginx-plus-ub1804","version":"latest"},"instanceType":"Standard_A1","adminUser":"azureuser","publicKey":"ssh-rsa my-public-key-string","networkInterface":{"type":"AZURE_NIC_ID","nicID":"/subscriptions/mySubscriptionID/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/myNicID"}}}},"AzureRequestWithCustomImageAndCreatingNewNicAndPublicIP":{"value":{"metadata":{"name":"my-azure-template-for-standard-DS1_v2","description":"Azure Instance Template for Standard DS1v2","displayName":"DS1_v2-instance-template","tags":["dev","prod"]},"desiredState":{"type":"AZURE_INSTANCE_TEMPLATE","image":{"type":"AZURE_IMAGE_ID","imageID":"/subscriptions/mySubscriptionID/resourceGroups/myResourceGroup/providers/Microsoft.Compute/images/myCustomImageID"},"instanceType":"Standard_DS1_v2","adminUser":"azureuser","publicKey":"ssh-rsa my-public-key-string","networkInterface":{"type":"AZURE_NIC_CONFIG","virtualNetwork":"my-virtual-network","subnet":"my-subnet","securityGroup":"my-network-sg","publicIp":true}}}},"AWSResponse":{"value":{"currentStatus":{"amiID":"ami-a0cfeed8","associatePublicIPAddress":true,"instanceType":"t2.large","publicKey":"my-public-key","securityGroupIDs":["sg-12345678","sg-98765432"],"subnetID":"subnet-12345678","type":"AWS_INSTANCE_TEMPLATE"},"desiredState":{"amiID":"ami-a0cfeed8","associatePublicIPAddress":true,"instanceType":"t2.large","publicKey":"my-public-key","securityGroupIDs":["sg-12345678","sg-98765432"],"subnetID":"subnet-12345678","type":"AWS_INSTANCE_TEMPLATE"},"metadata":{"createTime":"2020-04-17T02:18:44.394232Z","description":"AWS Instance Template for T2 large","displayName":"T2large-InstanceTemplate","kind":"instance-template","links":{"rel":"/api/v1/infrastructure/locations/location-1/instance-templates/my-instance-template"},"name":"my-instance-template","uid":"4157d480-cd0e-40a0-8ba8-d0d5ce17c5d6","updateTime":"2020-04-17T02:18:44.394232Z"}}},"AzureResponse":{"value":{"currentStatus":{"type":"AZURE_INSTANCE_TEMPLATE","image":{"type":"AZURE_IMAGE_REFERENCE","publisher":"nginxinc","offer":"nginx-plus-v1","sku":"nginx-plus-ub1804","version":"latest"},"instanceType":"Standard_A1","adminUser":"azureuser","publicKey":"ssh-rsa my-public-key-string","networkInterface":{"type":"AZURE_NIC_ID","nicID":"/subscriptions/mySubscriptionID/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/myNicID"}},"desiredState":{"type":"AZURE_INSTANCE_TEMPLATE","image":{"type":"AZURE_IMAGE_REFERENCE","publisher":"nginxinc","offer":"nginx-plus-v1","sku":"nginx-plus-ub1804","version":"latest"},"instanceType":"Standard_A1","adminUser":"azureuser","publicKey":"ssh-rsa my-public-key-string","networkInterface":{"type":"AZURE_NIC_ID","nicID":"/subscriptions/mySubscriptionID/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/myNicID"}},"metadata":{"createTime":"2020-04-17T02:18:44.394232Z","description":"Azure Instance Template for Standard A1","displayName":"Standard_A1-instance-template","kind":"instance-template","links":{"rel":"/api/v1/infrastructure/locations/azure-westus2/instance-templates/my-azure-template-for-standard-A1"},"name":"my-azure-template-for-standard-A1","uid":"4157d480-cd0e-40a0-8ba8-d0d5ce17c5d6","updateTime":"2020-04-17T02:18:44.394232Z"}}},"AWSListResponse":{"value":{"items":[{"currentStatus":{"amiID":"ami-a0cfeed8","associatePublicIPAddress":true,"instanceType":"t2.large","publicKey":"my-public-key","securityGroupIDs":["sg-12345678","sg-98765432"],"subnetID":"subnet-12345678","type":"AWS_INSTANCE_TEMPLATE"},"desiredState":{"amiID":"ami-a0cfeed8","associatePublicIPAddress":true,"instanceType":"t2.large","publicKey":"my-public-key","securityGroupIDs":["sg-12345678","sg-98765432"],"subnetID":"subnet-12345678","type":"AWS_INSTANCE_TEMPLATE"},"metadata":{"createTime":"2020-04-17T02:18:44.394232Z","description":"AWS Instance Template for T2 large","displayName":"T2large-InstanceTemplate","kind":"instance-template","links":{"rel":"/api/v1/infrastructure/locations/location-1/instance-templates/my-instance-template"},"name":"my-instance-template","uid":"4157d480-cd0e-40a0-8ba8-d0d5ce17c5d6","updateTime":"2020-04-17T02:18:44.394232Z"}}]}}}}}
/ infrastructure / locations / {locationName} / instance-templates
/ infrastructure / locations / {locationName} / instance-templates / {instanceTemplateName}
Error Sets API OpenAPI	{"openapi":"3.0.0","servers":[{"description":"NGINX Controller API","url":"https://{{CONTROLLER_FQDN}}/api/v1"}],"info":{"title":"Error Sets API","description":"Use the Error Sets API to view the default predefined Error Sets.","version":"v1"},"paths":{"/services/errorsets":{"get":{"tags":["ErrorSets"],"summary":"List all Error Sets.","description":"Returns a list of all the Error Sets.","operationId":"listErrorSets","responses":{"200":{"description":"Successfully retrieved a list of Error Sets.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorSetList"}}}}}}},"/services/errorsets/{errorSetName}":{"get":{"tags":["ErrorSets"],"summary":"Get an Error Set.","operationId":"getErrorSet","description":"Returns the information for a specific Error Set.","responses":{"200":{"description":"Successfully retrieved the requested Error Set.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorSet"}}}},"404":{"description":"The resource defined in the URI could not be found. Check the URI for errors and try again.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}}}},"parameters":[{"name":"errorSetName","description":"The name of the Error Set.","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ResourceName"}}]}},"components":{"schemas":{"ResourceName":{"type":"string","description":"The name of a resource.","example":"default-json"},"ErrorSetList":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/ErrorSet"}}}},"ErrorSet":{"type":"object","description":"Defines the set of error messages to be returned for HTTP errors.","required":["metadata","desiredState"],"properties":{"metadata":{"$ref":"#/components/schemas/ResourceMeta"},"desiredState":{"$ref":"#/components/schemas/ErrorSetDesiredState"},"currentStatus":{"$ref":"#/components/schemas/ErrorSetCurrentStatus"}}},"ErrorSetDesiredState":{"type":"object","properties":{"errorCodes":{"type":"array","items":{"$ref":"#/components/schemas/ErrorCode"}}}},"ErrorSetCurrentStatus":{"type":"object","properties":{"errorCodes":{"type":"array","items":{"$ref":"#/components/schemas/ErrorCode"}}}},"ErrorCode":{"type":"object","required":["code","message"],"properties":{"code":{"type":"integer","minimum":400,"maximum":599,"example":404},"message":{"type":"string","example":"{\"status\":404,\"message\":\"Resource not found\"}"}}},"SelfLinks":{"type":"object","description":"The SelfLinks object contains a link from the resource to itself.\nThis object is used only in responses.\n","properties":{"rel":{"type":"string","example":"/api/v1/services/environments/prod","description":"`rel` contains the complete path fragment of a URI and can be used\nto construct a query to the object.\n"}}},"ResourceMeta":{"type":"object","required":["name"],"properties":{"name":{"type":"string","pattern":"^[^A-Z\\s\\x00-\\x1f\\x60\\x7f\\;\\*\\\"\\[\\]\\{\\}\\\\\\/%\\?:=&\\~\\^|#<>]+$","minLength":1,"maxLength":1024,"example":"resource-name","description":"Resource name is a unique identifier for a resource within the context of a namespace.\nResource names must conform to [RFC 1738 Section 2.2](https://www.ietf.org/rfc/rfc1738.txt) and have a valid syntax for email addresses. The following rules are enforced:\n\n- do not utilize URL encoding;\n- do not include spaces;\n- do not use uppercase characters, for example, 'A-Z'; extended character sets are supported;\n- do not use the following characters: `\"`, `*`, `:`, `;`, `/`, `\\`, `%`, `?`, `hash`, `=`, `&`, `|`, `~`, `^`, `{`, `}`, `[`, `]`, `<`, `>`;\n- cannot start or end with an `@` sign;\n\nFor example: For a collection resource located at\n\n`https://controller.example.com/api/v1/services/apps/shopping_@1`\n\nthe resource name is \"shopping_@1\".\n"},"displayName":{"type":"string","example":"My Display Name","description":"`displayName` is a user friendly resource name. It can be used to define \na longer, and less constrained, name for a resource.\n\nDisplay names:\n\n- are optional (defaults to an empty string if no value is provided),\n- do not have to be unique, \n- cannot be assigned by the server.\n"},"description":{"type":"string","example":"This is a sample description string. It provides information about the resource.","description":"`description` is a free-form text property. You can use it to provide information that helps \nto identify the resource.\n\nDescriptions:\n\n- are optional (defaults to an empty string if no value is provided),\n- do not have to be unique, \n- cannot be assigned by the server.\n"},"kind":{"type":"string","example":"<collection>-<object>","description":"Kind is a string representation of an API resource's data type.\nIt is assigned by the server and cannot be changed. \n\nWhen creating a `kind`, the server uses hyphens to connect word segments; \nsingleton and collection item resources are not pluralized.\n"},"uid":{"type":"string","format":"uuid","example":"d290f1ee-6c54-4b01-90e6-d701748f0851","description":"Unique Identifier (UID)\n\nUID is a unique identifier in time and space for a resource. \nWhen you create a resource, the server assigns a UID to the resource.\n\nRefer to [IETF RFC 4122](https://tools.ietf.org/html/rfc4122) for more information.\n"},"tags":{"type":"array","items":{"type":"string"},"example":["production_public","dev","new_app","us-west-1","emea"],"description":"You can assign `tags` to a resource as a way to help map, scope, \nand organize resources. \n\nThe system uses tag selectors to specify selection criteria that \nmatch resources that have particular tags.\n"},"ref":{"type":"string","example":"/services/environments/prod","description":"The `ref` field contains a reference to another NGINX Controller resource.\n"},"links":{"$ref":"#/components/schemas/SelfLinks"},"createTime":{"type":"string","format":"date-time","example":"2019-07-29T09:12:33.001Z","description":"A timestamp that represents the server time when the resource was created.\n\nCreate time is not guaranteed to be set in \"happens-before\" order\nacross separate operations.\n\nIn JSON format, `create_time` type is encoded as a string in the\n[RFC 3339](https://www.ietf.org/rfc/rfc3339.txt).\n\nFor example: 2018-04-01T01:30:15.01Z\n\nCreate Time is assigned by the server and cannot be changed.\n"},"updateTime":{"type":"string","format":"date-time","example":"2019-07-29T10:12:33.001Z","description":"A timestamp that represents the server time when the resource was last modified.\n\nResources that have never been updated do not have an `update_time` stamp.\n\nThe default value for resources that have never been updated is the local \nlanguage-specific equivalent of \"null\".\n\nIn JSON format, `update_time` type is encoded as a string as described in \n[RFC 3339](https://www.ietf.org/rfc/rfc3339.txt).\n"}}},"ErrorDetail":{"type":"object","required":["description"],"properties":{"description":{"type":"string","example":"Error doing <action>: <reason for error>. This can lead to <potential consequences>. Try <action> to resolve the issue.","description":"A detailed error message returned by the server. \n\nThese messages contain the following information, where applicable:\n\n- What happened.\n- Why it happened.\n- What the consequences are (if any).\n- Recommended action to take to resolve the issue.\n"}}},"ErrorModel":{"type":"object","required":["message","code"],"properties":{"message":{"type":"string","example":"Error doing <action>.","description":"A human-readable message, in English, that describes the error.\n"},"code":{"type":"integer","example":1234567,"description":"A numeric error code that can be used to identify errors for support purposes.\n"},"details":{"type":"array","items":{"$ref":"#/components/schemas/ErrorDetail"}}}}}}}
/ services / errorsets
/ services / errorsets / {errorSetName}
Apps API OpenAPI	{"openapi":"3.0.0","servers":[{"description":"NGINX Controller API","url":"https://{{CONTROLLER_FQDN}}/api/v1"}],"info":{"title":"Apps API","description":"Use the Apps API to manage App resources.","version":"v1"},"paths":{"/services/environments/{environmentName}/apps":{"get":{"tags":["Apps"],"summary":"List all Apps","description":"Returns a list of all App resources.\n","operationId":"listApps","responses":{"200":{"description":"Successfully retrieved a list of all App resources.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AppList"}}}}},"400":{"description":"Bad input parameter, or possibly a bad URI. Check the input for typos and try again.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"404":{"description":"The resource defined in the URI could not be found. Check the URI for errors and try again.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}}}},"post":{"tags":["Apps"],"summary":"Create an App","description":"Creates a new App resource.","operationId":"createApp","requestBody":{"description":"An App.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/App"}}}},"responses":{"201":{"description":"Successfully created the specified App resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/App"}}}},"202":{"description":"The App resource has been accepted for creation. The App will be created after it is done configuring.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/App"}}}},"400":{"description":"Bad input parameter, or possibly a bad URI. Check the input for typos and try again.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"404":{"description":"The resource defined in the URI could not be found. Check the URI for errors and try again.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"409":{"description":"The request failed due to a naming conflict with an existing resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}}}},"parameters":[{"name":"environmentName","description":"The name of the Environment that contains the App.","in":"path","required":true,"schema":{"$ref":"#/components/schemas/EnvironmentName"}}]},"/services/environments/{environmentName}/apps/{appName}":{"get":{"tags":["Apps"],"summary":"Get an App","description":"Gets the information for a specific App resource.\n","operationId":"getApp","responses":{"200":{"description":"Successfully retrieved information for the requested App resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/App"}}}},"400":{"description":"Bad input parameter, or possibly a bad URI. Check the input for typos and try again.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"404":{"description":"The resource defined in the URI could not be found. Check the URI for errors and try again.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}}}},"put":{"tags":["Apps"],"summary":"Upsert an App","description":"Creates a new App resource or updates an existing App resource.\n","operationId":"updateApp","requestBody":{"description":"Defines the App resource to create or update.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/App"}}}},"responses":{"200":{"description":"Successfully updated the specified App resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/App"}}}},"201":{"description":"Successfully created the specified App resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/App"}}}},"202":{"description":"The App resource has been accepted for creation or update. The App will be created or updated after it is done configuring.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/App"}}}},"400":{"description":"Bad input parameter, or possibly a bad URI. Check the input for typos and try again.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"404":{"description":"The resource defined in the URI could not be found. Check the URI for errors and try again.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}}}},"delete":{"tags":["Apps"],"summary":"Delete an App","description":"Deletes the specified App resource.\n\nYou must delete all of an App's child resources before you delete the App.\n","operationId":"deleteApp","responses":{"202":{"description":"The App resource has been marked for deletion. The App will be deleted after the underlying resources have been deleted.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/App"}}}},"204":{"description":"Successfully deleted the specified App resource.\n"},"404":{"description":"The resource defined in the URI could not be found. Check the URI for errors and try again.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"409":{"description":"The request to delete the specified App resource failed.\nThe App contains references to active objects and cannot be deleted. Delete the child objects or remove the references, then try again.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}}}},"parameters":[{"name":"environmentName","description":"The name of the Environment that contains the App.","in":"path","required":true,"schema":{"$ref":"#/components/schemas/EnvironmentName"}},{"name":"appName","description":"The name of the App.","in":"path","required":true,"schema":{"$ref":"#/components/schemas/AppName"}}]}},"components":{"schemas":{"AppList":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/App"}}}},"App":{"type":"object","description":"An App is a collection of Components.","required":["metadata"],"properties":{"metadata":{"$ref":"#/components/schemas/ResourceMeta"},"desiredState":{"x-f5-experimental":true,"type":"object"},"currentStatus":{"$ref":"#/components/schemas/AppCurrentStatus"}}},"AppCurrentStatus":{"type":"object","properties":{"state":{"$ref":"#/components/schemas/ConfigState"},"componentRefs":{"type":"array","items":{"$ref":"#/components/schemas/ResourceRef"}}}},"EnvironmentName":{"type":"string"},"SelfLinks":{"type":"object","description":"The SelfLinks object contains a link from the resource to itself.\nThis object is used only in responses.\n","properties":{"rel":{"type":"string","example":"/api/v1/services/environments/prod","description":"`rel` contains the complete path fragment of a URI and can be used\nto construct a query to the object.\n"}}},"ResourceMeta":{"type":"object","required":["name"],"properties":{"name":{"type":"string","pattern":"^[^A-Z\\s\\x00-\\x1f\\x60\\x7f\\;\\*\\\"\\[\\]\\{\\}\\\\\\/%\\?:=&\\~\\^|#<>]+$","minLength":1,"maxLength":1024,"example":"resource-name","description":"Resource name is a unique identifier for a resource within the context of a namespace.\nResource names must conform to [RFC 1738 Section 2.2](https://www.ietf.org/rfc/rfc1738.txt) and have a valid syntax for email addresses. The following rules are enforced:\n\n- do not utilize URL encoding;\n- do not include spaces;\n- do not use uppercase characters, for example, 'A-Z'; extended character sets are supported;\n- do not use the following characters: `\"`, `*`, `:`, `;`, `/`, `\\`, `%`, `?`, `hash`, `=`, `&`, `|`, `~`, `^`, `{`, `}`, `[`, `]`, `<`, `>`;\n- cannot start or end with an `@` sign;\n\nFor example: For a collection resource located at\n\n`https://controller.example.com/api/v1/services/apps/shopping_@1`\n\nthe resource name is \"shopping_@1\".\n"},"displayName":{"type":"string","example":"My Display Name","description":"`displayName` is a user friendly resource name. It can be used to define \na longer, and less constrained, name for a resource.\n\nDisplay names:\n\n- are optional (defaults to an empty string if no value is provided),\n- do not have to be unique, \n- cannot be assigned by the server.\n"},"description":{"type":"string","example":"This is a sample description string. It provides information about the resource.","description":"`description` is a free-form text property. You can use it to provide information that helps \nto identify the resource.\n\nDescriptions:\n\n- are optional (defaults to an empty string if no value is provided),\n- do not have to be unique, \n- cannot be assigned by the server.\n"},"kind":{"type":"string","example":"<collection>-<object>","description":"Kind is a string representation of an API resource's data type.\nIt is assigned by the server and cannot be changed. \n\nWhen creating a `kind`, the server uses hyphens to connect word segments; \nsingleton and collection item resources are not pluralized.\n"},"uid":{"type":"string","format":"uuid","example":"d290f1ee-6c54-4b01-90e6-d701748f0851","description":"Unique Identifier (UID)\n\nUID is a unique identifier in time and space for a resource. \nWhen you create a resource, the server assigns a UID to the resource.\n\nRefer to [IETF RFC 4122](https://tools.ietf.org/html/rfc4122) for more information.\n"},"tags":{"type":"array","items":{"type":"string"},"example":["production_public","dev","new_app","us-west-1","emea"],"description":"You can assign `tags` to a resource as a way to help map, scope, \nand organize resources. \n\nThe system uses tag selectors to specify selection criteria that \nmatch resources that have particular tags.\n"},"ref":{"type":"string","example":"/services/environments/prod","description":"The `ref` field contains a reference to another NGINX Controller resource.\n"},"links":{"$ref":"#/components/schemas/SelfLinks"},"createTime":{"type":"string","format":"date-time","example":"2019-07-29T09:12:33.001Z","description":"A timestamp that represents the server time when the resource was created.\n\nCreate time is not guaranteed to be set in \"happens-before\" order\nacross separate operations.\n\nIn JSON format, `create_time` type is encoded as a string in the\n[RFC 3339](https://www.ietf.org/rfc/rfc3339.txt).\n\nFor example: 2018-04-01T01:30:15.01Z\n\nCreate Time is assigned by the server and cannot be changed.\n"},"updateTime":{"type":"string","format":"date-time","example":"2019-07-29T10:12:33.001Z","description":"A timestamp that represents the server time when the resource was last modified.\n\nResources that have never been updated do not have an `update_time` stamp.\n\nThe default value for resources that have never been updated is the local \nlanguage-specific equivalent of \"null\".\n\nIn JSON format, `update_time` type is encoded as a string as described in \n[RFC 3339](https://www.ietf.org/rfc/rfc3339.txt).\n"}}},"ConfigStateTally":{"type":"object","properties":{"isConfigured":{"type":"boolean","description":"The configuration operation is complete."},"isConfiguring":{"type":"boolean","description":"The configuration of the resource, or of its child(ren), is in process."},"isError":{"type":"boolean","description":"An error occurred while configuring the resource or its child(ren)."},"isDeleting":{"type":"boolean","description":"A delete operation is in progress for the resource or its child(ren)."},"total":{"type":"integer","description":"The total number of resources to which the configuration operation applies."},"configured":{"type":"integer","description":"The number of resources that have a complete and valid configuration."},"configuring":{"type":"integer","description":"The number of resources that are in the process of being configured."},"error":{"type":"integer","description":"The number of resources that have encountered an error during the configuration process."},"deleting":{"type":"integer","description":"The number of resources that are in the process of being deleted."}}},"ConfigCondition":{"type":"object","properties":{"type":{"type":"string","description":"The condition type."},"message":{"type":"string","description":"A human-readable message that provides additional information about the configuration operation."}}},"ConfigState":{"type":"object","description":"A representation of the resource's current configuration state \nthat comprises the status of the resource itself (`selfConfigState`) and any child \nresources (`childrenConfigState`).\n\nThe conditions array provides additional information during configuration changes.\n","properties":{"selfConfigState":{"$ref":"#/components/schemas/ConfigStateTally"},"childrenConfigState":{"$ref":"#/components/schemas/ConfigStateTally"},"conditions":{"type":"array","items":{"$ref":"#/components/schemas/ConfigCondition"}}}},"NamedLinks":{"allOf":[{"$ref":"#/components/schemas/SelfLinks"},{"type":"object","description":"Contains information about the object being referred to.\n\nThese are generally details -- like the object name and display name --\nthat are useful to a consumer of the API that performs further\nprocessing. \n\nThis object is only present in responses.\n \n","properties":{"name":{"type":"string","example":"production","description":"The name of the linked resource.\n"},"displayName":{"type":"string","example":"Production Environment","description":"A user friendly resource name."}}}]},"ResourceRef":{"type":"object","required":["ref"],"properties":{"ref":{"type":"string","example":"/services/environments/prod","description":"A reference to another NGINX Controller resource.\n"},"links":{"$ref":"#/components/schemas/NamedLinks"}}},"ErrorDetail":{"type":"object","required":["description"],"properties":{"description":{"type":"string","example":"Error doing <action>: <reason for error>. This can lead to <potential consequences>. Try <action> to resolve the issue.","description":"A detailed error message returned by the server. \n\nThese messages contain the following information, where applicable:\n\n- What happened.\n- Why it happened.\n- What the consequences are (if any).\n- Recommended action to take to resolve the issue.\n"}}},"ErrorModel":{"type":"object","required":["message","code"],"properties":{"message":{"type":"string","example":"Error doing <action>.","description":"A human-readable message, in English, that describes the error.\n"},"code":{"type":"integer","example":1234567,"description":"A numeric error code that can be used to identify errors for support purposes.\n"},"details":{"type":"array","items":{"$ref":"#/components/schemas/ErrorDetail"}}}},"AppName":{"type":"string"}}}}
/ services / environments / {environmentName} / apps
/ services / environments / {environmentName} / apps / {appName}
No API Resources

(Product) (Docs)

---

{"class":["gateway"],"properties":{"name":"Tyk","provider":"Tyk","slug":"tyk","rating":1,"license":"Proprietary, Open Source (Apache-2.0)","status":"Pending Review","researchDate":"2022-11","description":"Our Gateway is secure, lightweight and highly performant. And it’s yours for free, forever. Legacy systems, REST, GraphQL, Kubernetes… whatever your architecture looks like, our 100% open source Gateway will enable you to achieve what you need to with ease. Deploy the Tyk stack anywhere to enjoy blistering performance and complete power and access control over your requests and responses, with no feature lockout. Ever.\n","platformCapabilities":["Design","Gateway","Portal","Documentation","Analytics","Dashboards"],"gatewayCapabilities":["Custom Code Execution","Mediation","Mocking","OpenAPI Integration","OpenAPI Enforcement","Traffic Management","Versioning","Deprecation"],"customCodeSupport":["None"],"upstreamProtocols":["HTTP/1.1","SOAP","GraphQL"],"downstreamProtocols":["HTTP/1.1","SOAP","GraphQL"],"deliveryModels":["Customer Managed (Cloud)","Customer Managed (On-Premises)","Hybrid","SaaS"],"policies":[{"category":"Traffic Management","capabilities":["Cache Eviction","Cache Invalidation","Cache Lookup","Cache Population","Cache Storage","Cache Target Response","Cache Validation","Canary Release","Circuit Breaker","Conditional Routing","Content-Based Routing","Dynamic Routing","GraphQL Caching","Load Balancer Routing","Mocking","Quota","Quota Reset","Rate Limiting","Regions","Request Size Limiting","Service Discovery","Throttling","Traffic Optimization"]},{"category":"Mediation","capabilities":["CORS","Cache Eviction","Cache Lookup","Cache Store","Custom Exception Handling","GraphQL","JSON Validation","OpenAPI Validation","Request Size Limit","Request Termination","Request Transformation","Response Transformation","SOAP Validation","URL Rewriting","XML to JSON"]},{"category":"Security","capabilities":["Auth0","API Key","API Key Authentication","Access Control Lists (ACL)","Audit Logs","Basic Authentication","CORS","IP Access Rules","JWS","JWT Validation","JWT authorizers","LDAP","LDAP Authentication","Message Inspection","Mutual TLS","OAuth 1.0","OAuth 2.0","Okta","OpenID Connect","Role Based Access Control (RBAC)","Single Sign On (SSO)"]},{"category":"Extensions","capabilities":["HTTP Callout","HTTP integrations","Kubernetes","Notifications","CI/CD","Events","Prometheus","Graphing"]}]},"links":[{"rel":["urn:gateway:product"],"title":"Product","href":"https://tyk.io/"},{"rel":["urn:gateway:docs"],"title":"Documentation","href":"https://tyk.io/"},{"rel":["urn:gateway:logo"],"title":"Logo","href":"/images/gateways/tyk.svg"},{"rel":["urn:gateway:screenshot"],"title":"Screenshot","href":"https://kinlane-productions2.s3.amazonaws.com/api-gateways/tyk.png"}]}

Tyk

Our Gateway is secure, lightweight and highly performant. And it’s yours for free, forever. Legacy systems, REST, GraphQL, Kubernetes… whatever your architecture looks like, our 100% open source Gateway will enable you to achieve what you need to with ease. Deploy the Tyk stack anywhere to enjoy blistering performance and complete power and access control over your requests and responses, with no feature lockout. Ever.

Platform Capabilities

These are the wider capabilities beyond the gateway they offer.

• Design
• Gateway
• Portal
• Documentation
• Analytics
• Dashboards

Gateway Capabilities

These are the capabilities the gateway supports.

• Custom Code Execution
• Mediation
• Mocking
• OpenAPI Integration
• OpenAPI Enforcement
• Traffic Management
• Versioning
• Deprecation

Upstream Protocols

The different protocols they support upstream.

• HTTP/1.1
• SOAP
• GraphQL

Downtream Protocols

The different protocols they support downstream.

• HTTP/1.1
• SOAP
• GraphQL

Custom Code

If they offer plugin, extension, and custom coding options.

• None

Delivery Models

These are they ways you can deliver this solution.

• Customer Managed (Cloud)
• Customer Managed (On-Premises)
• Hybrid
• SaaS

Policies

These are the policies available across the gateway capabilities.

Traffic Management

• Cache Eviction
• Cache Invalidation
• Cache Lookup
• Cache Population
• Cache Storage
• Cache Target Response
• Cache Validation
• Canary Release
• Circuit Breaker
• Conditional Routing
• Content-Based Routing
• Dynamic Routing
• GraphQL Caching
• Load Balancer Routing
• Mocking
• Quota
• Quota Reset
• Rate Limiting
• Regions
• Request Size Limiting
• Service Discovery
• Throttling
• Traffic Optimization

Mediation

• CORS
• Cache Eviction
• Cache Lookup
• Cache Store
• Custom Exception Handling
• GraphQL
• JSON Validation
• OpenAPI Validation
• Request Size Limit
• Request Termination
• Request Transformation
• Response Transformation
• SOAP Validation
• URL Rewriting
• XML to JSON

Security

• Auth0
• API Key
• API Key Authentication
• Access Control Lists (ACL)
• Audit Logs
• Basic Authentication
• CORS
• IP Access Rules
• JWS
• JWT Validation
• JWT authorizers
• LDAP
• LDAP Authentication
• Message Inspection
• Mutual TLS
• OAuth 1.0
• OAuth 2.0
• Okta
• OpenID Connect
• Role Based Access Control (RBAC)
• Single Sign On (SSO)

Extensions

• HTTP Callout
• HTTP integrations
• Kubernetes
• Notifications
• CI/CD
• Events
• Prometheus
• Graphing

API Resources

Tyk Dashboard API OpenAPI	{"openapi":"3.0.0","info":{"title":"Tyk Dashboard API","version":"3.2.0","description":"## <a name=\"introduction\"></a> Introduction\n\nThe Tyk Dashboard API offers granular, programmatic access to a centralised database of resources that your Tyk nodes can pull from. This API has a dynamic user administrative structure which means the secret key that is used to communicate with your Tyk nodes can be kept secret and access to the wider management functions can be handled on a user-by-user and organisation-by-organisation basis.\n\nA common question around using a database-backed configuration is how to programatically add API definitions to your Tyk nodes, the Dashboard API allows much more fine-grained, secure and multi-user access to your Tyk cluster, and should be used to manage a database-backed Tyk node.\n\nThe Tyk Dashboard API works seamlessly with the Tyk Dashboard (and the two come bundled together).\n\n## <a name=\"security-hierarchy\"></a> Security Hierarchy\n\nThe Dashboard API provides a more structured security layer to managing Tyk nodes.\n\n### Organisations, APIs and Users\n\nWith the Dashboard API and a database-backed Tyk setup, (and to an extent with file-based API setups - if diligence is used in naming an creating definitions), the following security model is applied to the management of Upstream APIs:\n\n* **Organisations**: All APIs are *owned* by an organisation, this is designated by the `OrgID` parameter in the API Definition.\n* **Users**: All users created in the Dashboard belong to an organisation (unless an exception is made for super-administrative access).\n* **APIs**: All APIs belong to an Organisation and only Users that belong to that organisation can see the analytics for those APIs and manage their configurations.\n* **API Keys**: API Keys are designated by organisation, this means an API key that has full access rights will not be allowed to access the APIs of another organisation on the same system, but can have full access to all APIs within the organisation.\n* **Access Rights**: Access rights are stored with the key, this enables a key to give access to multiple APIs, this is defined by the session object in the core Tyk API.\n\nIn order to use the Dashboard API, you'll need to get the `Tyk Dashboard API Access Credentials` secret from your user profile on the Dashboard UI.\n\nThe secret you set should then be sent along as a header with each Dashboard API Request in order for it to be successful:\n\n```\nauthorization: <your-secret>\n```"},"servers":[{"url":"http://localhost:3000/"},{"url":"https://localhost:3000/"}],"tags":[{"name":"APIs","description":"API Definitions"},{"name":"Keys","description":"API Key Management"},{"name":"Policies","description":"Policies"},{"name":"Analytics","description":"API Analytics"},{"name":"Additional Permissions","description":"Additional Permissions API"},{"name":"Single Sign On","description":"The Dashboard SSO API allows you to implement custom authentication schemes for the Dashboard and Portal. Our Tyk Identity Broker (TIB) internally also uses this API."},{"name":"Basic Authentication","description":"API Key Management"},{"name":"Open Policy Agent","description":"Open Policy Agent API"},{"name":"Users","description":"User Management"},{"name":"Organisations","description":"Organisations Management"}],"paths":{"/api/portal/policies/":{"get":{"summary":"Get List of Policies","description":"Get List of Policies","operationId":"getPolicies","tags":["Policies"],"responses":{"200":{"description":"List of all policies","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Policy"}}}}}}},"post":{"summary":"Create Policy Definition","description":"Creating policy definitions is slightly different to the core API, API definitions are wrapped inside an api_definition field and event handlers, such as webhooks are not embedded in the main api_defintion object (though they can be), webhooks are instead appended as references into the hook_references field, the API will embed the correct webhook data into the event handler interface.","operationId":"postPolicies","tags":["Policies"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Policy"},"example":{"name":"new policy","quota_max":60,"quota_renewal_rate":60,"allowance":100,"rate":100,"per":5,"org_id":"53ac07777cbb8c2d53000002"}}}},"responses":{"200":{"description":"Policy created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/apiModifyKeySuccess"},"example":{"action":"created","status":"ok"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/apiStatusMessage"},"example":{"message":"Request malformed","status":"error"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/apiStatusMessage"},"example":{"message":"Failed to create file!","status":"error"}}}}}}},"/api/portal/policies/search":{"get":{"summary":"Search List of Policies","description":"Search List of Policies","operationId":"searchPolicies","tags":["Policies"],"parameters":[{"name":"q","in":"query","description":"Search query","schema":{"type":"string"}}],"responses":{"200":{"description":"List of Policies (TODO)"}}}},"/api/portal/policies/{id}":{"get":{"summary":"Get a single Policy by ID","description":"Get a Policy by ID","operationId":"getPolicy","tags":["Policies"],"parameters":[{"name":"id","in":"path","description":"ID of Policy to get.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Get details of a single Policy","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Policy"}}}},"404":{"description":"Policy not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/apiStatusMessage"},"example":{"message":"Policy not found","status":"error"}}}}}},"put":{"summary":"Update Policy Definition","description":"Update a Policy Definition","operationId":"putPolicies","tags":["Policies"],"parameters":[{"name":"id","in":"path","description":"ID of Policy to update.","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Policy"},"example":{"name":"new policy","quota_max":60,"quota_renewal_rate":60,"allowance":100,"rate":100,"per":5,"org_id":"53ac07777cbb8c2d53000002"}}}},"responses":{"200":{"description":"Policy updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/apiModifyKeySuccess"},"example":{"action":"updated","status":"ok"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/apiStatusMessage"},"example":{"message":"PUT operation on different IDs","status":"error"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/apiStatusMessage"},"example":{"message":"Failed to create file!","status":"error"}}}}}},"delete":{"summary":"Delete a single Policy by ID","description":"Delete a Policy by ID","operationId":"deletePolicy","tags":["Policies"],"parameters":[{"name":"id","in":"path","description":"ID of Policy to delete.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Delete policy by ID","content":{"application/json":{"schema":{"$ref":"#/components/schemas/apiModifyKeySuccess"},"example":{"action":"deleted","status":"ok"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/apiStatusMessage"},"example":{"message":"Delete failed","status":"error"}}}}}}},"/api/apis":{"get":{"summary":"Get List of APIs","description":"Get List of APIs","operationId":"getApis","tags":["APIs"],"responses":{"200":{"description":"List of API definitions","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/APIDefinition"}}}}}}},"post":{"summary":"Create API Definition","description":"Create an API Definition. The id and api_id fields in the definition are auto-generated by Tyk and cannot be set by the user.","operationId":"postApis","tags":["APIs"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIDefinition"},"example":{"api_definition":null,"name":"Test","auth":{"auth_header_name":"authorization"},"definition":{"location":"header","key":""},"proxy":{"target_url":"http://httpbin.org/"},"version_data":{"use_extended_paths":true,"not_versioned":true,"versions":{"Default":{"expires":"","name":"Default","paths":{"ignored":[],"white_list":[],"black_list":[]},"extended_paths":{"ignored":[{"path":"/test-path/","method_actions":{"GET":{"action":"no_action","code":200,"data":"","headers":{}}}},{"path":"/test-path/reply","method_actions":{"GET":{"action":"reply","code":200,"data":"{\"foo\":\"bar\"}","headers":{"x-test":"test"}}}}],"white_list":[],"black_list":[]},"use_extended_paths":true}}},"use_oauth2":false,"oauth_meta":{"auth_login_redirect":"","allowed_access_types":[],"allowed_authorize_types":["token"]},"notifications":{"shared_secret":"","oauth_on_keychange_url":""},"enable_ip_whitelisting":true,"allowed_ips":["127.0.0.1"],"use_keyless":false,"enable_signature_checking":false,"use_basic_auth":false,"active":true,"enable_batch_request_support":true,"hook_references":[{"event_name":"QuotaExceeded","hook":{"api_model":{},"id":"54be6c0beba6db07a6000002","org_id":"54b53d3aeba6db5c35000002","name":"Test Post","method":"POST","target_path":"http://httpbin.org/post","template_path":"","header_map":{"x-tyk-test":"123456"},"event_timeout":0},"event_timeout":60}]}}}},"responses":{"200":{"description":"API created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/apiModifyKeySuccess"},"example":{"status":"ok","action":"created","key":"{...API JSON definition...}"}}}},"400":{"description":"Malformed data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/apiStatusMessage"},"example":{"status":"error","message":"Malformed API data"}}}}}}},"/api/apis/search":{"get":{"summary":"Search List of APIs","description":"Search List of APIs","operationId":"searchApis","tags":["APIs"],"parameters":[{"name":"q","in":"query","description":"Search query","schema":{"type":"string"}}],"responses":{"200":{"description":"List of API definitions","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/APIDefinition"}}}}}}}},"/api/apis/{id}":{"get":{"summary":"Get a single API by ID","description":"Get an API by ID","operationId":"getApi","tags":["APIs"],"parameters":[{"name":"id","in":"path","description":"ID of API to get. Can either be internal or public API id.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"API definition","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIDefinition"}}}}}},"put":{"summary":"Update API Definition","description":"Update an API Definition. api_id can be updated for On-Premise installations, but it cannot be updated when the Dashboard resides in Tyk Cloud. Updates to api_id in Tyk Cloud will be ignored.","operationId":"putApi","tags":["APIs"],"parameters":[{"name":"id","in":"path","description":"ID of API to update. Can either be internal or public API id.","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIDefinition"},"example":{"api_definition":{"id":"54c24242eba6db1c9a000002","api_id":"bc2f8cfb7ab241504d9f3574fe407499","name":"Test","auth":{"auth_header_name":"authorization"},"definition":{"location":"header","key":""},"proxy":{"target_url":"http://httpbin.org/"},"version_data":{"use_extended_paths":true,"not_versioned":true,"versions":{"Default":{"expires":"","name":"Default","paths":{"ignored":[],"white_list":[],"black_list":[]},"extended_paths":{"ignored":[{"path":"/test-path/","method_actions":{"GET":{"action":"no_action","code":200,"data":"","headers":{}}}},{"path":"/test-path/reply","method_actions":{"GET":{"action":"reply","code":200,"data":"{\"foo\":\"bar\"}","headers":{"x-test":"test"}}}}],"white_list":[],"black_list":[]},"use_extended_paths":true}}},"use_oauth2":false,"oauth_meta":{"auth_login_redirect":"","allowed_access_types":[],"allowed_authorize_types":["token"]},"notifications":{"shared_secret":"","oauth_on_keychange_url":""},"enable_ip_whitelisting":true,"allowed_ips":["127.0.0.1"],"use_keyless":false,"enable_signature_checking":false,"use_basic_auth":false,"active":true,"enable_batch_request_support":true},"hook_references":[{"event_name":"QuotaExceeded","hook":{"api_model":{},"id":"54be6c0beba6db07a6000002","org_id":"54b53d3aeba6db5c35000002","name":"Test Post","method":"POST","target_path":"http://httpbin.org/post","template_path":"","header_map":{"x-tyk-test":"123456"},"event_timeout":0},"event_timeout":60}]}}}},"responses":{"200":{"description":"API updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/apiModifyKeySuccess"},"example":{"status":"ok","action":"updated","key":"{...API JSON definition...}"}}}},"400":{"description":"Malformed data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/apiStatusMessage"},"example":{"status":"error","message":"Malformed API data"}}}}}},"delete":{"summary":"Delete a single API by ID","description":"Delete an API by ID","operationId":"deleteApi","tags":["APIs"],"parameters":[{"name":"id","in":"path","description":"ID of API to get. Can either be internal or public API id.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"API deleted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/apiStatusMessage"},"example":{"message":"API deleted","status":"ok"}}}},"400":{"description":"No API ID specified","content":{"application/json":{"schema":{"$ref":"#/components/schemas/apiStatusMessage"},"example":{"message":"API ID not specified","status":"error"}}}}}}},"/api/apis/oas":{"post":{"description":"Create an API Definition in OAS format.\nThe id and api_id fields in the definition are auto-generated by Tyk and cannot be set by the user.","tags":["OASAPIs"],"operationId":"createApiOAS","requestBody":{"content":{"application/json":{"schema":{"$ref":"https://raw.githubusercontent.com/OAI/OpenAPI-Specification/main/schemas/v3.0/schema.json"}}}},"responses":{"200":{"description":"API created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/apiModifyKeySuccess"},"example":{"status":"ok","action":"created","key":"{...API JSON definition...}"}}}},"400":{"description":"Malformed data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/apiStatusMessage"},"example":{"status":"error","message":"Malformed API data"}}}}}}},"/api/apis/oas/{apiID}":{"parameters":[{"description":"The API ID","name":"apiID","in":"path","required":true,"schema":{"type":"string"}}],"get":{"description":"Get API definition in OAS format","tags":["OASAPIs"],"parameters":[{"description":"The mode of OAS export. By default the mode is not set which means the OAS spec is exported including the OAS Tyk extension. \nIf the mode is set to public, the OAS spec excluding the Tyk extension is exported.","name":"mode","in":"query","schema":{"type":"string"},"example":"public"}],"operationId":"listApiOAS","responses":{"200":{"description":"API definition","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OASSchemaResponse"}}}}}},"put":{"description":"Updating an API definition uses the same signature object as a `POST`. It will first ensure that the API ID being updated is the same as in the `PUT` object.\nUpdating will completely replace the file descriptor and will not change an API Definition that has already been loaded. The hot-reload endpoint will need to be called to push the new definition to live.\n","tags":["OASAPIs"],"operationId":"updateApiOAS","requestBody":{"content":{"application/json":{"schema":{"$ref":"https://raw.githubusercontent.com/OAI/OpenAPI-Specification/main/schemas/v3.0/schema.json"}}}},"responses":{"200":{"description":"API updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/apiModifyKeySuccess"},"example":{"status":"ok","action":"updated","key":"{...API JSON definition...}"}}}},"400":{"description":"Malformed data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/apiStatusMessage"},"example":{"status":"error","message":"Malformed API data"}}}}}},"patch":{"summary":"Patch a single OAS API by ID","description":"Update an OAS format API. You can use this endpoint to update the OAS part of your Tyk API definition.\nThis endpoint allows you to configure the Tyk OAS extension based on the query parameters provided (similar to import)","tags":["OASAPIs"],"operationId":"patchApiOAS","parameters":[{"$ref":"#/components/parameters/UpstreamURL"},{"$ref":"#/components/parameters/ListenPath"},{"$ref":"#/components/parameters/CustomDomain"},{"$ref":"#/components/parameters/ValidateRequest"},{"$ref":"#/components/parameters/AllowList"},{"$ref":"#/components/parameters/Authentication"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"https://raw.githubusercontent.com/OAI/OpenAPI-Specification/main/schemas/v3.0/schema.json"}}}},"responses":{"200":{"description":"API patched","content":{"application/json":{"schema":{"$ref":"#/components/schemas/apiModifyKeySuccess"},"example":{"status":"ok","action":"modified","key":"{updated APIID}"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/apiStatusMessage"},"examples":{"malformedBody":{"summary":"When the request body is malformed","value":{"message":"Request malformed","status":"error"}},"missingAPIID":{"summary":"When the request is missing the APIID in the query parameter","value":{"message":"Must specify an apiID to patch","status":"error"}},"nonExistingAPIID":{"summary":"When the client sends an APIID which doesn't exist in your Tyk Gateway","value":{"message":"No API found for APIID {APIID}","status":"error"}},"invalidUpstreamURL":{"summary":"When the client sends a query param upstreamURL which isn't valid","value":{"message":"invalid upstream URL","status":"error"}}}}}}}},"delete":{"description":"Deleting an API definition will remove the file from the file store. The API definition will NOT be unloaded and a separate reload request will need to be made to disable the API endpoint.","tags":["OASAPIs"],"operationId":"deleteOASApi","responses":{"200":{"description":"API deleted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/apiStatusMessage"},"example":{"message":"API deleted","status":"ok"}}}},"400":{"description":"No API ID specified","content":{"application/json":{"schema":{"$ref":"#/components/schemas/apiStatusMessage"},"example":{"message":"API ID not specified","status":"error"}}}}}}},"/api/apis/oas/{apiID}/versions":{"parameters":[{"description":"The API ID","name":"apiID","in":"path","required":true,"schema":{"type":"string"}}],"get":{"description":"Listing versions of an OAS API","tags":["OASAPIs"],"operationId":"listOASApiVersions","parameters":[{"$ref":"#/components/parameters/SearchText"},{"$ref":"#/components/parameters/AccessType"}],"responses":{"200":{"description":"API version metas","content":{"application/json":{"schema":{"properties":{"apis":{"type":"array","items":{"$ref":"#/components/schemas/APIVersionMeta"}},"pages":{"type":"integer"}}}}}}}}},"/api/apis/oas/import":{"post":{"description":"Create a new OAS format API, without x-tyk-gateway.\nFor use with an existing OAS API that you want to expose via your Tyk Gateway. (New)","tags":["OASAPIs"],"operationId":"importOAS","parameters":[{"$ref":"#/components/parameters/UpstreamURL"},{"$ref":"#/components/parameters/ListenPath"},{"$ref":"#/components/parameters/CustomDomain"},{"$ref":"#/components/parameters/AllowList"},{"$ref":"#/components/parameters/ValidateRequest"},{"$ref":"#/components/parameters/Authentication"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"https://raw.githubusercontent.com/OAI/OpenAPI-Specification/main/schemas/v3.0/schema.json"}}}},"responses":{"200":{"description":"API definition","content":{"application/json":{"schema":{"$ref":"#/components/schemas/apiModifyKeySuccess"},"example":{"status":"ok","action":"added","key":"{created APIID}"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/apiStatusMessage"},"examples":{"malformedBody":{"summary":"When the request body is malformed","value":{"message":"Request malformed","status":"error"}},"invalidUpstreamURL":{"summary":"When the client sends a query param upstreamURL which isn't valid","value":{"message":"invalid upstream URL","status":"error"}}}}}}}}},"/api/apis/oas/{apiID}/export":{"parameters":[{"description":"The API ID","name":"apiID","in":"path","required":true,"schema":{"type":"string"}}],"get":{"description":"download API definition in OAS format(only APIs saved in OAS format),","tags":["OASAPIs"],"operationId":"downloadApiOASPublic","parameters":[{"description":"Mode of OAS export, by default mode could be empty which means to export OAS spec including OAS Tyk extension.\nWhen mode=public, OAS spec excluding Tyk extension is exported","name":"mode","in":"query","schema":{"type":"string"},"example":"public"}],"responses":{"200":{"description":"API definition","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OASSchemaResponse"}}}}}}},"/api/apis/oas/export":{"get":{"description":"List all OAS format APIs","tags":["OASAPIs"],"operationId":"downloadApisOASPublic","parameters":[{"description":"The mode of OAS export. By default the mode is not set which means the OAS spec is exported including the OAS Tyk extension. \nIf the mode is set to public, the OAS spec excluding the Tyk extension is exported.","name":"mode","in":"query","schema":{"type":"string"},"example":"public"}],"responses":{"200":{"description":"API definition","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/OASSchemaResponse"}}}}}}}},"/api/activity/keys/{keyHash}/{startDay}/{startMonth}/{startYear}/{EndDay}/{EndMonth}/{EndYear}":{"get":{"summary":"Analytics of API Key","description":"It returns analytics of the endpoints of all APIs called using KEY between start and end date.","operationId":"getAnalyticsOfApiKey","tags":["Analytics"],"parameters":[{"name":"keyHash","in":"path","description":"Hash of your API key.","required":true,"schema":{"type":"string"}},{"name":"startDay","in":"path","description":"Day of analytics to query.","required":true,"schema":{"type":"string"}},{"name":"startMonth","in":"path","description":"Month of analytics to query.","required":true,"schema":{"type":"string"}},{"name":"startYear","in":"path","description":"Start year of analytics to query.","required":true,"schema":{"type":"string"}},{"name":"EndDay","in":"path","description":"End date of analytics to query.","required":true,"schema":{"type":"string"}},{"name":"EndMonth","in":"path","description":"End month of analytics to query.","required":true,"schema":{"type":"string"}},{"name":"EndYear","in":"path","description":"End year of analytics to query.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Returns analytics of all endpoints called using the key `7f3c3ca87376cabe` between October 13th 2020 and October 14th 2020.","content":{"application/json":{"example":{"data":[{"id":{"day":0,"month":0,"year":0,"hour":0,"code":0,"path":"/anything","key":"","alias":"","url":"","iso_country":"","api_id":"41351a6a94094da05f75146a695a16f6","api_name":""},"hits":1,"success":1,"error":0,"last_hit":"2020-10-13T13:22:49.667+05:30","request_time":0,"latency":217,"upstream_latency":217,"max_upstream_latency":217,"min_upstream_latency":217,"max_latency":217,"min_latency":217},{"id":{"day":0,"month":0,"year":0,"hour":0,"code":0,"path":"/anything","key":"","alias":"","url":"","iso_country":"","api_id":"1793db2cbb724ad54da582ce3191d383","api_name":""},"hits":1,"success":1,"error":0,"last_hit":"2020-10-13T13:22:20.534+05:30","request_time":568,"latency":568,"upstream_latency":568,"max_upstream_latency":568,"min_upstream_latency":568,"max_latency":568,"min_latency":568}],"pages":1}}}}}}},"/api/activity/oauthid/{OAuthClientID}/{startDay}/{startMonth}/{startYear}/{EndDay}/{EndMonth}/{EndYear}":{"get":{"summary":"Analytics of Oauth Client ID","description":"Returns activity of all endpoints which used OAuth client `27b35a9ed46e429eb2361e440cc4005c` between October 13th 2020 and October 14th 2020.","operationId":"getAnalyticsOfOauthClientId","tags":["Analytics"],"parameters":[{"name":"OAuthClientID","in":"path","description":"OAuthClientID","required":true,"schema":{"type":"string"}},{"name":"startDay","in":"path","description":"Day of analytics to query.","required":true,"schema":{"type":"string"}},{"name":"startMonth","in":"path","description":"Month of analytics to query.","required":true,"schema":{"type":"string"}},{"name":"startYear","in":"path","description":"Start year of analytics to query.","required":true,"schema":{"type":"string"}},{"name":"EndDay","in":"path","description":"End date of analytics to query.","required":true,"schema":{"type":"string"}},{"name":"EndMonth","in":"path","description":"End month of analytics to query.","required":true,"schema":{"type":"string"}},{"name":"EndYear","in":"path","description":"End year of analytics to query.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Returns analytics of all endpoints called using the key `7f3c3ca87376cabe` between October 13th 2020 and October 14th 2020.","content":{"application/json":{"example":{"data":[{"id":{"day":0,"month":0,"year":0,"hour":0,"code":0,"path":"/get","key":"","alias":"","url":"","iso_country":"","api_id":"79fc7cb80df940cc5089772200bd4926","api_name":""},"hits":2,"success":1,"error":1,"last_hit":"2020-10-13T14:48:51.582+05:30","request_time":498,"latency":498,"upstream_latency":497.5,"max_upstream_latency":747,"min_upstream_latency":248,"max_latency":748,"min_latency":248},{"id":{"day":0,"month":0,"year":0,"hour":0,"code":0,"path":"/post","key":"","alias":"","url":"","iso_country":"","api_id":"79fc7cb80df940cc5089772200bd4926","api_name":""},"hits":1,"success":1,"error":0,"last_hit":"2020-10-13T14:49:31.541+05:30","request_time":0,"latency":241,"upstream_latency":239,"max_upstream_latency":239,"min_upstream_latency":239,"max_latency":241,"min_latency":241}],"pages":1}}}}}}},"/api/apis/{apiID}/keys":{"get":{"summary":"List keys","description":"Lists keys that grant access to the API with the ID {apiID}.","operationId":"listKeys","tags":["Keys"],"parameters":[{"name":"apiID","in":"path","description":"ID of API the keys grant access to. Can either be the internal or external API ID.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Keys retrieved successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/apiAllKeys"},"example":{"data":{"keys":["54b53d3aeba6db5c3500000289a8fbc2bbba4ebc4934bb113588c792","54b53d3aeba6db5c3500000230459d8568ec4bbf675bda2ff05e9293","54b53d3aeba6db5c35000002ec9a2b1aca7b495771273a0895cb3627","54b53d3aeba6db5c3500000272d97a10538248e9523ca09e425090b8","54b53d3aeba6db5c3500000252b5c56c61ad42fe765101f6d70cf9c6"]},"pages":1}}}}}}},"/api/apis/{apiID}/keys/{keyID}":{"parameters":[{"name":"apiID","in":"path","description":"ID of API the keys grant access to. Can either be the internal or external API ID.","required":true,"schema":{"type":"string"}},{"name":"keyID","in":"path","description":"The Key ID.","required":true,"schema":{"type":"string"}}],"get":{"summary":"Get key","description":"Fetches the key that grant access to the API with the ID {apiID} and key ID {keyID}.","operationId":"getKey","tags":["Keys"],"responses":{"200":{"description":"Key retrieved successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SessionState"},"example":{"api_model":{},"key_id":"eyJvcmciOiI1ZTlkOTU0NGExZGNkNjAwMDFkMGVkMjAiLCJpZCI6ImhlbGxvLXdvcmxkIiwiaCI6Im11cm11cjY0In0","data":{"last_check":1421674410,"allowance":1000,"rate":1000,"per":60,"expires":1423684135,"quota_max":-1,"quota_renews":1421164189,"quota_remaining":-1,"quota_renewal_rate":60,"access_rights":{"39d2c98be05c424371c600bd8b3e2242":{"api_name":"Nitrous Test","api_id":"39d2c98be05c424371c600bd8b3e2242","versions":["Default"]}}},"org_id":"54b53d3aeba6db5c35000002","oauth_client_id":"","basic_auth_data":{"password":""},"hmac_enabled":true,"hmac_string":""}}}}}},"put":{"summary":"Update key","description":"You can also manually add keys to Tyk using your own key-generation algorithm. It is recommended if using this approach to ensure that the OrgID being used in the API Definition and the key data is blank so that Tyk does not try to prepend or manage the key in any way.","tags":["Keys"],"operationId":"updateKey","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SessionState"},"example":{"last_check":1421674410,"allowance":1000,"rate":1000,"per":60,"expires":1423684135,"quota_max":-1,"quota_renews":1421164189,"quota_remaining":-1,"quota_renewal_rate":60,"access_rights":{"39d2c98be05c424371c600bd8b3e2242":{"api_name":"Nitrous Test","api_id":"39d2c98be05c424371c600bd8b3e2242","versions":["Default"]}},"org_id":"54b53d3aeba6db5c35000002","oauth_client_id":"","basic_auth_data":{"password":""},"hmac_enabled":true,"hmac_string":""}}}},"responses":{"200":{"description":"Key updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SessionState"},"example":{"api_model":{},"key_id":"eyJvcmciOiI1ZTlkOTU0NGExZGNkNjAwMDFkMGVkMjAiLCJpZCI6ImhlbGxvLXdvcmxkIiwiaCI6Im11cm11cjY0In0","data":{"last_check":1421674410,"allowance":1000,"rate":1000,"per":60,"expires":1423684135,"quota_max":-1,"quota_renews":1421164189,"quota_remaining":-1,"quota_renewal_rate":60,"access_rights":{"39d2c98be05c424371c600bd8b3e2242":{"api_name":"Nitrous Test","api_id":"39d2c98be05c424371c600bd8b3e2242","versions":["Default"]}}},"org_id":"54b53d3aeba6db5c35000002","oauth_client_id":"","basic_auth_data":{"password":""},"hmac_enabled":true,"hmac_string":""}}}},"401":{"description":"Unauthorized.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/apiStatusMessage"},"example":{"Status":"Error","Message":"User does not have permission to add API to key Access Rights!"}}}}}},"delete":{"summary":"Delete key","description":"Deleting a key will remove it permanently from the system, however analytics relating to that key will still be available.","tags":["Keys"],"operationId":"deleteKey","responses":{"200":{"description":"Key deleted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/apiStatusMessage"},"example":{"Status":"OK","Message":"Key deleted successfully"}}}},"401":{"description":"Unauthorized.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/apiStatusMessage"},"example":{"Status":"Error","Message":"Attempted access to non-owned key"}}}}}}},"/api/keys":{"post":{"summary":"Create a key","description":"Tyk will generate the access token based on the OrgID specified in the API Definition and a random UUID. This ensures that keys can be \"owned\" by different API Owners should segmentation be needed at an organisational level.\n<br/><br/>\nAPI keys without access_rights data will be written to all APIs on the system (this also means that they will be created across all SessionHandlers and StorageHandlers, it is recommended to always embed access_rights data in a key to ensure that only targeted APIs and their back-ends are written to.","tags":["Keys"],"operationId":"addKey","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SessionState"},"example":{"last_check":1421674410,"allowance":1000,"rate":1000,"per":60,"expires":1423684135,"quota_max":-1,"quota_renews":1421164189,"quota_remaining":-1,"quota_renewal_rate":60,"access_rights":{"39d2c98be05c424371c600bd8b3e2242":{"api_id":"39d2c98be05c424371c600bd8b3e2242","api_name":"Nitrous Test","versions":["Default"]}}}}}},"responses":{"200":{"description":"New Key added","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SessionState"},"example":{"api_model":{},"key_id":"eyJvcmciOiI1ZTlkOTU0NGExZGNkNjAwMDFkMGVkMjAiLCJpZCI6ImhlbGxvLXdvcmxkIiwiaCI6Im11cm11cjY0In0","data":{"last_check":1421674410,"allowance":1000,"rate":1000,"per":60,"expires":1423684135,"quota_max":-1,"quota_renews":1421164189,"quota_remaining":-1,"quota_renewal_rate":60,"access_rights":{"39d2c98be05c424371c600bd8b3e2242":{"api_name":"Nitrous Test","api_id":"39d2c98be05c424371c600bd8b3e2242","versions":["Default"]}}},"org_id":"54b53d3aeba6db5c35000002","oauth_client_id":"","basic_auth_data":{"password":""},"hmac_enabled":true,"hmac_string":""}}}},"401":{"description":"Unauthorized.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/apiStatusMessage"},"example":{"Status":"Error","Message":"User does not have permission to add API to key Access Rights!"}}}}}}},"/api/keys/{keyID}":{"parameters":[{"name":"keyID","in":"path","description":"The Key ID.","required":true,"schema":{"type":"string"}}],"post":{"summary":"Create custom key","description":"Creates a key with a custom key ID.","operationId":"createCustomKey","tags":["Keys"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SessionState"},"example":{"last_check":1421674410,"allowance":1000,"rate":1000,"per":60,"expires":1423684135,"quota_max":-1,"quota_renews":1421164189,"quota_remaining":-1,"quota_renewal_rate":60,"access_rights":{"39d2c98be05c424371c600bd8b3e2242":{"api_id":"39d2c98be05c424371c600bd8b3e2242","api_name":"Nitrous Test","versions":["Default"]}}}}}},"responses":{"200":{"description":"Custom key created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SessionState"},"example":{"api_model":{},"key_id":"eyJvcmciOiI1ZTlkOTU0NGExZGNkNjAwMDFkMGVkMjAiLCJpZCI6ImhlbGxvLXdvcmxkIiwiaCI6Im11cm11cjY0In0","data":{"last_check":1421674410,"allowance":1000,"rate":1000,"per":60,"expires":1423684135,"quota_max":-1,"quota_renews":1421164189,"quota_remaining":-1,"quota_renewal_rate":60,"access_rights":{"39d2c98be05c424371c600bd8b3e2242":{"api_name":"Nitrous Test","api_id":"39d2c98be05c424371c600bd8b3e2242","versions":["Default"]}}},"key_hash":"567b9a5419c3a9ef"}}}},"401":{"description":"Unauthorized.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/apiStatusMessage"},"example":{"Status":"Error","Message":"User does not have permission to add API to key Access Rights!"}}}}}}},"/api/org/permissions":{"get":{"summary":"List additional permissions","description":"This API helps you to add and delete (CRUD) a list of additional (custom) permissions for your Dashboard users. Once created, a custom permission will be added to standard list of user permissions. Only Admin Dashboard users will be authorised to use this API.","operationId":"listAdditionalPermissions","tags":["Additional Permissions"],"responses":{"200":{"description":"Additional Permissions retrieved successfully.","content":{"application/json":{"schema":{"properties":{"additional_permissions":{"type":"object"}}},"example":{"additional_permissions":{"api_developer":"API Developer","api_manager":"API Manager"}}}}},"401":{"description":"Unauthorized.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/apiStatusMessage"},"example":{"Status":"Error","Message":"Not authorised"}}}}}},"put":{"summary":"Modify additional permissions","description":"Whenever you want to add/update/delete an additional permission, just send back the updated list of permissions, through a PUT request to the API.","operationId":"updateAdditionalPermissions","tags":["Additional Permissions"],"requestBody":{"content":{"application/json":{"schema":{"properties":{"additional_permissions":{"type":"object"}}},"example":{"additional_permissions":{"api_developer":"API Developer","api_manager":"API Manager","custom_permission":"Custom Permission"}}}}},"responses":{"200":{"description":"Additional Permissions updated successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/apiStatusMessage"},"example":{"Status":"OK","Message":"Additional Permissions updated in org level"}}}},"401":{"description":"Unauthorized.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/apiStatusMessage"},"example":{"Status":"Error","Message":"Not authorised"}}}}}}},"/api/sso/":{"post":{"summary":"Generate authentication token","description":"The Dashboard exposes the /api/sso Dashboard API which allows you to generate a temporary authentication token, valid for 60 seconds.","operationId":"generateAuthToken","tags":["Single Sign On"],"requestBody":{"content":{"application/json":{"schema":{"properties":{"ForSection":{"type":"string","enum":["dashboard","portal"]},"OrgID":{"type":"string"},"EmailAddress":{"type":"string"},"GroupID":{"type":"string"}}},"example":{"ForSection":"dashboard","OrgID":"588b4f0bb275ff0001cc7471","EmailAddress":"name@somewhere.com","GroupID":""}}}},"responses":{"200":{"description":"Auth Token generated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/apiStatusMessage"},"example":{"Status":"OK","Message":"SSO Nonce created","Meta":"YTNiOGUzZjctYWZkYi00OTNhLTYwODItZTAzMDI3MjM0OTEw"}}}},"400":{"description":"Back Request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/apiStatusMessage"},"example":{"Status":"Error","Message":"Cannot create an SSO session for an invalid payload: [Error: Org id not found ('588b4f0bb275ff0001cc7471').]"}}}},"401":{"description":"Unauthorized.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/apiStatusMessage"},"example":{"Status":"Error","Message":"Not authorised"}}}}}}},"/api/apis/keys/basic/{username}":{"parameters":[{"name":"username","in":"path","description":"Username of Basic Auth user to create, get, update, or delete.","required":true,"schema":{"type":"string"}}],"post":{"summary":"Create a Basic Auth User","description":"Create a Basic Auth user with the username specified in the path {username}.","operationId":"createBasicAuthUser","tags":["Basic Authentication"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SessionState"},"example":{"last_check":0,"allowance":1000,"rate":1000,"per":60,"expires":0,"quota_max":10000,"quota_renews":1424543479,"quota_remaining":10000,"quota_renewal_rate":2520000,"access_rights":{"bc2f8cfb7ab241504d9f3574fe407499":{"api_id":"bc2f8cfb7ab241504d9f3574fe407499","api_name":"Test","versions":["Default"]}},"basic_auth_data":{"password":"test123"}}}}},"responses":{"200":{"description":"User created successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SessionState"},"example":{"api_model":{},"key_id":"54b53d3aeba6db5c3500000test-user","data":{"last_check":0,"allowance":1000,"rate":1000,"per":60,"expires":0,"quota_max":10000,"quota_renews":1424543479,"quota_remaining":10000,"quota_renewal_rate":2520000,"access_rights":null,"bc2f8cfb7ab241504d9f3574fe407499":{"api_name":"Test","api_id":"bc2f8cfb7ab241504d9f3574fe407499","versions":["Default"]},"org_id":"54b53d3aeba6db5c35000002","oauth_client_id":"","basic_auth_data":{"password":""},"hmac_enabled":false,"hmac_string":""}}}}}}},"put":{"summary":"Update a Basic Auth User","description":"Update the Basic Auth user specified in the path {username}.","operationId":"updateBasicAuthUser","tags":["Basic Authentication"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SessionState"},"example":{"last_check":0,"allowance":1000,"rate":1000,"per":60,"expires":0,"quota_max":10000,"quota_renews":1424543479,"quota_remaining":10000,"quota_renewal_rate":2520000,"access_rights":{"bc2f8cfb7ab241504d9f3574fe407499":{"api_id":"bc2f8cfb7ab241504d9f3574fe407499","api_name":"Test","versions":["Default"]}},"basic_auth_data":{"password":"test123"}}}}},"responses":{"200":{"description":"User created successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SessionState"},"example":{"api_model":{},"key_id":"54b53d3aeba6db5c3500000test-user","data":{"last_check":0,"allowance":1000,"rate":1000,"per":60,"expires":0,"quota_max":10000,"quota_renews":1424543479,"quota_remaining":10000,"quota_renewal_rate":2520000,"access_rights":null,"bc2f8cfb7ab241504d9f3574fe407499":{"api_name":"Test","api_id":"bc2f8cfb7ab241504d9f3574fe407499","versions":["Default"]},"org_id":"54b53d3aeba6db5c35000002","oauth_client_id":"","basic_auth_data":{"password":""},"hmac_enabled":false,"hmac_string":""}}}}}}},"get":{"summary":"Get a Basic Auth User","description":"Get the Basic Auth user specified in the path {username}.","operationId":"getBasicAuthUser","tags":["Basic Authentication"],"responses":{"200":{"description":"User created successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SessionState"},"example":{"api_model":{},"key_id":"54b53d3aeba6db5c3500000test-user","data":{"last_check":0,"allowance":1000,"rate":1000,"per":60,"expires":0,"quota_max":10000,"quota_renews":1424543479,"quota_remaining":10000,"quota_renewal_rate":2520000,"access_rights":null,"bc2f8cfb7ab241504d9f3574fe407499":{"api_name":"Test","api_id":"bc2f8cfb7ab241504d9f3574fe407499","versions":["Default"]},"org_id":"54b53d3aeba6db5c35000002","oauth_client_id":"","basic_auth_data":{"password":"","hmac_enabled":false,"hmac_string":""}}}}}}}},"delete":{"summary":"Delete a Basic Auth User","description":"Delete the Basic Auth user specified in the path {username}.","operationId":"deleteBasicAuthUser","tags":["Basic Authentication"],"responses":{"200":{"description":"User created successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SessionState"},"example":{"api_model":{},"key_id":"54b53d3aeba6db5c3500000test-user","data":{"last_check":0,"allowance":1000,"rate":1000,"per":60,"expires":0,"quota_max":10000,"quota_renews":1424543479,"quota_remaining":10000,"quota_renewal_rate":2520000,"access_rights":null,"bc2f8cfb7ab241504d9f3574fe407499":{"api_name":"Test","api_id":"bc2f8cfb7ab241504d9f3574fe407499","versions":["Default"]},"org_id":"54b53d3aeba6db5c35000002","oauth_client_id":"","basic_auth_data":{"password":""},"hmac_enabled":false,"hmac_string":""}}}}}}}},"/api/org/opa":{"get":{"summary":"List OPA Rules","description":"Lists OPA Rules.","operationId":"getOPA","tags":["Open Policy Agent"],"responses":{"200":{"description":"Key retrieved successfully.","content":{"application/json":{"example":{"open_policy":{"enabled":true,"rules":"default hello = false\r\n\r\nhello {\r\n m := input.message\r\n m == \"world\"\r\n}"}}}}}}}},"/api/org/permission":{"put":{"summary":"Update OPA Rules","description":"Update OPA Rule Settings","operationId":"updateOPA","tags":["Open Policy Agent"],"requestBody":{"content":{"application/json":{"schema":{"type":"object"},"example":{"enabled":false,"rules":"default hello = false\r\n\r\nhello {\r\n m := input.message\r\n m == \"world\"\r\n}"}}}},"responses":{"200":{"description":"tets","content":{"application/json":{"schema":{"type":"object"},"example":{"Status":"OK","Message":"OPA rules has been updated on org level","Meta":null}}}}}}},"/api/users":{"get":{"summary":"List Users","description":"Lists Dashboard Users","operationId":"getUsers","tags":["Users"],"responses":{"200":{"description":"Users retrieved successfully.","content":{"application/json":{"example":{"users":[{"api_model":{},"first_name":"John","last_name":"Smith","email_address":"john@jive.ly","password":"$2a$10$mRVfrAf72N66anVNhA1KVuYaOwOrXhFzxyg6bwgZemUeVo2MNOpIa","org_id":"54b53d3aeba6db5c35000002","active":true,"id":"54b53d4bf25b920f09361526","access_key":"0cf5e6c37add465a406f19807c081765","user_permissions":{"IsAdmin":"admin","ResetPassword":"admin"}},{"api_model":{},"first_name":"Test","last_name":"User","email_address":"banana@test.com","password":"","org_id":"54b53d3aeba6db5c35000002","active":true,"id":"54bd0ad9ff4329b88985aafb","access_key":"f81ee6f0c8f2467d539c132c8a422346","user_permissions":{"user_groups":"read","users":"read"}}],"pages":0}}}}}},"post":{"summary":"Add User","description":"Add a User","operationId":"addUser","tags":["Users"],"requestBody":{"content":{"application/json":{"schema":{"type":"object"},"example":{"first_name":"Jason","last_name":"Jasonson","email_address":"jason@jasonsonson.com","active":true,"password":"thisisatest","user_permissions":{"IsAdmin":"admin"}}}}},"responses":{"200":{"description":"User added succesfully","content":{"application/json":{"example":{"Status":"OK","Message":"User created","Meta":""}}}}}}},"/api/users/{USER_ID}":{"get":{"summary":"Get User","description":"Get user specified by {USER_ID} in path.","operationId":"getUser","tags":["Users"],"parameters":[{"name":"USER_ID","in":"path","description":"USER ID of the user to retrieve data for","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"User retrieved succesfully","content":{"application/json":{"example":{"api_model":{},"first_name":"Test","last_name":"User","email_address":"banana@test.com","password":"","org_id":"54b53d3aeba6db5c35000002","active":true,"id":"54bd0ad9ff4329b88985aafb","access_key":"f81ee6f0c8f2467d539c132c8a422346"}}}}}},"put":{"summary":"Update User","description":"Update User","operationId":"updateUser","parameters":[{"name":"USER_ID","in":"path","description":"USER ID of the user to retrieve data for","required":true,"schema":{"type":"string"}}],"tags":["Users"],"requestBody":{"content":{"application/json":{"schema":{"type":"object"},"example":{"first_name":"Jason","last_name":"File","email_address":"jason.file@jasonsonson.com","active":true,"user_permissions":{"IsAdmin":"admin"}}}}},"responses":{"200":{"description":"User updated","content":{"application/json":{"example":{"Status":"OK","Message":"User updated","Meta":null}}}}}}},"/api/users/{USER_ID}/actions/reset":{"parameters":[{"name":"USER_ID","in":"path","description":"User ID of the user whose password is being reset","required":true,"schema":{"type":"string"}}],"post":{"summary":"Set User Password","description":"Set a user's password","operationId":"setUserPassword","tags":["Users"],"requestBody":{"content":{"application/json":{"schema":{"type":"object"},"example":{"current_password":"12345","new_password":"test123456","user_permissions":{"IsAdmin":"admin"}}}}},"responses":{"200":{"description":"User password updated","content":{"application/json":{"example":{"Status":"OK","Message":"User password updated","Meta":""}}}}}}},"/api/users/{USER_ID}/actions/key/reset":{"parameters":[{"name":"USER_ID","in":"path","description":"User ID of the user whose current Dashboard session will be reset","required":true,"schema":{"type":"string"}}],"put":{"summary":"Reset current Dashboard session for specified user","description":"Reset specified user's current Dashboard session. User's Dashboard API credentials will also be reset.","operationId":"resetUserSession","tags":["Users"],"requestBody":{"content":{"application/json":{"schema":{"type":"object"},"example":{"userId":"{USER_ID}"}}}},"responses":{"200":{"description":"Dashboard session for specified user has been reset successfully","content":{"application/json":{"example":{"Status":"OK","Message":"User session renewed","Meta":null}}}}}},"delete":{"summary":"Delete User","description":"Delete a Dashboard user","operationId":"deleteUser","tags":["Users"],"responses":{"200":{"description":"Dashboard user deleted","content":{"application/json":{"example":{"Status":"OK","Message":"User deleted","Meta":""}}}}}}},"/api/schema":{"get":{"description":"Get OAS schema","tags":["Schema"],"operationId":"getSchema","parameters":[{"description":"The OAS version","name":"oasVersion","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"OAS schema response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OASSchemaResponse"},"example":{"status":"Success","schema":"<open api 3.0.3 schema>"}}}},"400":{"description":"response when parameter oasVersion is missing","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OASSchemaResponse"},"example":{"message":"Should provide a value for parameter oasVersion","status":"Failed"}}}},"500":{"description":"response when oasSchema fetch failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OASSchemaResponse"},"example":{"message":"Could not retrieve OAS schema: Schema not found for version 5.0.0","status":"Failed"}}}}}}}},"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer"}},"schemas":{"APIDefinition":{"properties":{"tags":{"items":{"type":"string"},"type":"array","x-go-name":"Tags"},"CORS":{"properties":{"allow_credentials":{"type":"boolean","x-go-name":"AllowCredentials"},"allowed_headers":{"items":{"type":"string"},"type":"array","x-go-name":"AllowedHeaders"},"allowed_methods":{"items":{"type":"string"},"type":"array","x-go-name":"AllowedMethods"},"allowed_origins":{"items":{"type":"string"},"type":"array","x-go-name":"AllowedOrigins"},"debug":{"type":"boolean","x-go-name":"Debug"},"enable":{"type":"boolean","x-go-name":"Enable"},"exposed_headers":{"items":{"type":"string"},"type":"array","x-go-name":"ExposedHeaders"},"max_age":{"format":"int64","type":"integer","x-go-name":"MaxAge"},"options_passthrough":{"type":"boolean","x-go-name":"OptionsPassthrough"}},"type":"object"},"active":{"type":"boolean","x-go-name":"Active"},"allowed_ips":{"items":{"type":"string"},"type":"array","x-go-name":"AllowedIPs"},"api_id":{"type":"string","x-go-name":"APIID"},"auth":{"$ref":"#/components/schemas/Auth"},"auth_provider":{"$ref":"#/components/schemas/AuthProviderMeta"},"base_identity_provided_by":{"$ref":"#/components/schemas/AuthTypeEnum"},"basic_auth":{"properties":{"body_password_regexp":{"type":"string","x-go-name":"BodyPasswordRegexp"},"body_user_regexp":{"type":"string","x-go-name":"BodyUserRegexp"},"cache_ttl":{"format":"int64","type":"integer","x-go-name":"CacheTTL"},"disable_caching":{"type":"boolean","x-go-name":"DisableCaching"},"extract_from_body":{"type":"boolean","x-go-name":"ExtractFromBody"}},"type":"object","x-go-name":"BasicAuth"},"blacklisted_ips":{"items":{"type":"string"},"type":"array","x-go-name":"BlacklistedIPs"},"cache_options":{"$ref":"#/components/schemas/CacheOptions"},"certificates":{"items":{"type":"string"},"type":"array","x-go-name":"Certificates"},"client_certificates":{"items":{"type":"string"},"type":"array","x-go-name":"ClientCertificates"},"config_data":{"additionalProperties":{"type":"object"},"type":"object","x-go-name":"ConfigData"},"custom_middleware":{"$ref":"#/components/schemas/MiddlewareSection"},"custom_middleware_bundle":{"type":"string","x-go-name":"CustomMiddlewareBundle"},"definition":{"properties":{"key":{"type":"string","x-go-name":"Key"},"location":{"type":"string","x-go-name":"Location"},"strip_path":{"type":"boolean","x-go-name":"StripPath"}},"type":"object","x-go-name":"VersionDefinition"},"disable_quota":{"type":"boolean","x-go-name":"DisableQuota"},"disable_rate_limit":{"type":"boolean","x-go-name":"DisableRateLimit"},"do_not_track":{"type":"boolean","x-go-name":"DoNotTrack"},"domain":{"type":"string","x-go-name":"Domain"},"dont_set_quota_on_create":{"type":"boolean","x-go-name":"DontSetQuotasOnCreate"},"enable_batch_request_support":{"type":"boolean","x-go-name":"EnableBatchRequestSupport"},"enable_context_vars":{"type":"boolean","x-go-name":"EnableContextVars"},"enable_coprocess_auth":{"type":"boolean","x-go-name":"EnableCoProcessAuth"},"enable_ip_blacklisting":{"type":"boolean","x-go-name":"EnableIpBlacklisting"},"enable_ip_whitelisting":{"type":"boolean","x-go-name":"EnableIpWhiteListing"},"enable_jwt":{"type":"boolean","x-go-name":"EnableJWT"},"enable_signature_checking":{"type":"boolean","x-go-name":"EnableSignatureChecking"},"event_handlers":{"$ref":"#/components/schemas/EventHandlerMetaConfig"},"expire_analytics_after":{"format":"int64","type":"integer","x-go-name":"ExpireAnalyticsAfter"},"global_rate_limit":{"$ref":"#/components/schemas/GlobalRateLimit"},"hmac_allowed_algorithms":{"items":{"type":"string"},"type":"array","x-go-name":"HmacAllowedAlgorithms"},"hmac_allowed_clock_skew":{"format":"double","type":"number","x-go-name":"HmacAllowedClockSkew"},"id":{"$ref":"#/components/schemas/ObjectId"},"internal":{"type":"boolean","x-go-name":"Internal"},"jwt_client_base_field":{"type":"string","x-go-name":"JWTClientIDBaseField"},"jwt_expires_at_validation_skew":{"format":"uint64","type":"integer","x-go-name":"JWTExpiresAtValidationSkew"},"jwt_identity_base_field":{"type":"string","x-go-name":"JWTIdentityBaseField"},"jwt_issued_at_validation_skew":{"format":"uint64","type":"integer","x-go-name":"JWTIssuedAtValidationSkew"},"jwt_not_before_validation_skew":{"format":"uint64","type":"integer","x-go-name":"JWTNotBeforeValidationSkew"},"jwt_policy_field_name":{"type":"string","x-go-name":"JWTPolicyFieldName"},"jwt_scope_claim_name":{"type":"string","x-go-name":"JWTScopeClaimName"},"jwt_scope_to_policy_mapping":{"additionalProperties":{"type":"string"},"type":"object","x-go-name":"JWTScopeToPolicyMapping"},"jwt_signing_method":{"type":"string","x-go-name":"JWTSigningMethod"},"jwt_skip_kid":{"type":"boolean","x-go-name":"JWTSkipKid"},"jwt_source":{"type":"string","x-go-name":"JWTSource"},"name":{"type":"string","x-go-name":"Name"},"notifications":{"$ref":"#/components/schemas/NotificationsManager"},"oauth_meta":{"properties":{"allowed_access_types":{"items":{"$ref":"#/components/schemas/AccessRequestType"},"type":"array","x-go-name":"AllowedAccessTypes"},"allowed_authorize_types":{"items":{"$ref":"#/components/schemas/AuthorizeRequestType"},"type":"array","x-go-name":"AllowedAuthorizeTypes"},"auth_login_redirect":{"type":"string","x-go-name":"AuthorizeLoginRedirect"}},"type":"object","x-go-name":"Oauth2Meta"},"openid_options":{"$ref":"#/components/schemas/OpenIDOptions"},"org_id":{"type":"string","x-go-name":"OrgID"},"pinned_public_keys":{"additionalProperties":{"type":"string"},"type":"object","x-go-name":"PinnedPublicKeys"},"proxy":{"properties":{"check_host_against_uptime_tests":{"type":"boolean","x-go-name":"CheckHostAgainstUptimeTests"},"disable_strip_slash":{"type":"boolean","x-go-name":"DisableStripSlash"},"enable_load_balancing":{"type":"boolean","x-go-name":"EnableLoadBalancing"},"listen_path":{"type":"string","x-go-name":"ListenPath"},"preserve_host_header":{"type":"boolean","x-go-name":"PreserveHostHeader"},"service_discovery":{"$ref":"#/components/schemas/ServiceDiscoveryConfiguration"},"strip_listen_path":{"type":"boolean","x-go-name":"StripListenPath"},"target_list":{"items":{"type":"string"},"type":"array","x-go-name":"Targets"},"target_url":{"type":"string","x-go-name":"TargetURL"},"transport":{"properties":{"proxy_url":{"type":"string","x-go-name":"ProxyURL"},"ssl_ciphers":{"items":{"type":"string"},"type":"array","x-go-name":"SSLCipherSuites"},"ssl_insecure_skip_verify":{"type":"boolean","x-go-name":"SSLInsecureSkipVerify"},"ssl_min_version":{"format":"uint16","type":"integer","x-go-name":"SSLMinVersion"}},"type":"object","x-go-name":"Transport"}},"type":"object","x-go-name":"Proxy"},"response_processors":{"items":{"$ref":"#/components/schemas/ResponseProcessor"},"type":"array","x-go-name":"ResponseProcessors"},"session_lifetime":{"format":"int64","type":"integer","x-go-name":"SessionLifetime"},"session_provider":{"$ref":"#/components/schemas/SessionProviderMeta"},"slug":{"type":"string","x-go-name":"Slug"},"strip_auth_data":{"type":"boolean","x-go-name":"StripAuthData"},"tag_headers":{"items":{"type":"string"},"type":"array","x-go-name":"TagHeaders"},"upstream_certificates":{"additionalProperties":{"type":"string"},"type":"object","x-go-name":"UpstreamCertificates"},"uptime_tests":{"properties":{"check_list":{"items":{"$ref":"#/components/schemas/HostCheckObject"},"type":"array","x-go-name":"CheckList"},"config":{"properties":{"expire_utime_after":{"format":"int64","type":"integer","x-go-name":"ExpireUptimeAnalyticsAfter"},"recheck_wait":{"format":"int64","type":"integer","x-go-name":"RecheckWait"},"service_discovery":{"$ref":"#/components/schemas/ServiceDiscoveryConfiguration"}},"type":"object","x-go-name":"Config"}},"type":"object","x-go-name":"UptimeTests"},"use_basic_auth":{"type":"boolean","x-go-name":"UseBasicAuth"},"use_keyless":{"type":"boolean","x-go-name":"UseKeylessAccess"},"use_mutual_tls_auth":{"type":"boolean","x-go-name":"UseMutualTLSAuth"},"use_oauth2":{"type":"boolean","x-go-name":"UseOauth2"},"use_openid":{"type":"boolean","x-go-name":"UseOpenID"},"use_standard_auth":{"type":"boolean","x-go-name":"UseStandardAuth"},"version_data":{"properties":{"default_version":{"type":"string","x-go-name":"DefaultVersion"},"not_versioned":{"type":"boolean","x-go-name":"NotVersioned"},"versions":{"additionalProperties":{"$ref":"#/components/schemas/VersionInfo"},"type":"object","x-go-name":"Versions"}},"type":"object","x-go-name":"VersionData"}},"title":"APIDefinition represents the configuration for a single proxied API and it's versions.","type":"object","x-go-package":"github.com/TykTechnologies/tyk/apidef"},"APILimit":{"description":"APILimit stores quota and rate limit on ACL level (per API)","properties":{"per":{"format":"double","type":"number","x-go-name":"Per"},"quota_max":{"format":"int64","type":"integer","x-go-name":"QuotaMax"},"quota_remaining":{"format":"int64","type":"integer","x-go-name":"QuotaRemaining"},"quota_renewal_rate":{"format":"int64","type":"integer","x-go-name":"QuotaRenewalRate"},"quota_renews":{"format":"int64","type":"integer","x-go-name":"QuotaRenews"},"rate":{"format":"double","type":"number","x-go-name":"Rate"},"set_by_policy":{"type":"boolean","x-go-name":"SetByPolicy"},"throttle_interval":{"format":"double","type":"number","x-go-name":"ThrottleInterval"},"throttle_retry_limit":{"format":"int64","type":"integer","x-go-name":"ThrottleRetryLimit"}},"type":"object","x-go-package":"github.com/TykTechnologies/tyk/user"},"AccessDefinition":{"description":"AccessDefinition defines which versions of an API a key has access to","properties":{"allowed_urls":{"items":{"$ref":"#/components/schemas/AccessSpec"},"type":"array","x-go-name":"AllowedURLs"},"api_id":{"type":"string","x-go-name":"APIID"},"api_name":{"type":"string","x-go-name":"APIName"},"limit":{"$ref":"#/components/schemas/APILimit"},"versions":{"items":{"type":"string"},"type":"array","x-go-name":"Versions"}},"type":"object","x-go-package":"github.com/TykTechnologies/tyk/user"},"AccessRequestType":{"description":"AccessRequestType is the type for OAuth param `grant_type`","type":"string","x-go-package":"github.com/TykTechnologies/tyk/vendor/github.com/lonelycode/osin"},"AccessSpec":{"description":"AccessSpecs define what URLS a user has access to an what methods are enabled","properties":{"methods":{"items":{"type":"string"},"type":"array","x-go-name":"Methods"},"url":{"type":"string","x-go-name":"URL"}},"type":"object","x-go-package":"github.com/TykTechnologies/tyk/user"},"Auth":{"properties":{"auth_header_name":{"type":"string","x-go-name":"AuthHeaderName"},"cookie_name":{"type":"string","x-go-name":"CookieName"},"param_name":{"type":"string","x-go-name":"ParamName"},"signature":{"$ref":"#/components/schemas/SignatureConfig"},"use_certificate":{"type":"boolean","x-go-name":"UseCertificate"},"use_cookie":{"type":"boolean","x-go-name":"UseCookie"},"use_param":{"type":"boolean","x-go-name":"UseParam"},"validate_signature":{"type":"boolean","x-go-name":"ValidateSignature"}},"type":"object","x-go-package":"github.com/TykTechnologies/tyk/apidef"},"AuthProviderCode":{"type":"string","x-go-package":"github.com/TykTechnologies/tyk/apidef"},"AuthProviderMeta":{"properties":{"meta":{"additionalProperties":{"type":"object"},"type":"object","x-go-name":"Meta"},"name":{"$ref":"#/components/schemas/AuthProviderCode"},"storage_engine":{"$ref":"#/components/schemas/StorageEngineCode"}},"type":"object","x-go-package":"github.com/TykTechnologies/tyk/apidef"},"AuthTypeEnum":{"type":"string","x-go-package":"github.com/TykTechnologies/tyk/apidef"},"AuthorizeRequestType":{"description":"AuthorizeRequestType is the type for OAuth param `response_type`","type":"string","x-go-package":"github.com/TykTechnologies/tyk/vendor/github.com/lonelycode/osin"},"CacheMeta":{"properties":{"cache_response_codes":{"items":{"format":"int64","type":"integer"},"type":"array","x-go-name":"CacheOnlyResponseCodes"},"cache_key_regex":{"type":"string","x-go-name":"CacheKeyRegex"},"method":{"type":"string","x-go-name":"Method"},"path":{"type":"string","x-go-name":"Path"}},"type":"object","x-go-package":"github.com/TykTechnologies/tyk/apidef"},"CacheOptions":{"properties":{"cache_all_safe_requests":{"type":"boolean","x-go-name":"CacheAllSafeRequests"},"cache_control_ttl_header":{"type":"string","x-go-name":"CacheControlTTLHeader"},"cache_response_codes":{"items":{"format":"int64","type":"integer"},"type":"array","x-go-name":"CacheOnlyResponseCodes"},"cache_timeout":{"format":"int64","type":"integer","x-go-name":"CacheTimeout"},"enable_cache":{"type":"boolean","x-go-name":"EnableCache"},"enable_upstream_cache_control":{"type":"boolean","x-go-name":"EnableUpstreamCacheControl"}},"type":"object","x-go-package":"github.com/TykTechnologies/tyk/apidef"},"CircuitBreakerMeta":{"properties":{"method":{"type":"string","x-go-name":"Method"},"path":{"type":"string","x-go-name":"Path"},"return_to_service_after":{"format":"int64","type":"integer","x-go-name":"ReturnToServiceAfter"},"samples":{"format":"int64","type":"integer","x-go-name":"Samples"},"threshold_percent":{"format":"double","type":"number","x-go-name":"ThresholdPercent"}},"type":"object","x-go-package":"github.com/TykTechnologies/tyk/apidef"},"EndPointMeta":{"properties":{"method_actions":{"additionalProperties":{"$ref":"#/components/schemas/EndpointMethodMeta"},"type":"object","x-go-name":"MethodActions"},"path":{"type":"string","x-go-name":"Path"}},"type":"object","x-go-package":"github.com/TykTechnologies/tyk/apidef"},"EndpointMethodAction":{"type":"string","x-go-package":"github.com/TykTechnologies/tyk/apidef"},"EndpointMethodMeta":{"properties":{"action":{"$ref":"#/components/schemas/EndpointMethodAction"},"code":{"format":"int64","type":"integer","x-go-name":"Code"},"data":{"type":"string","x-go-name":"Data"},"headers":{"additionalProperties":{"type":"string"},"type":"object","x-go-name":"Headers"}},"type":"object","x-go-package":"github.com/TykTechnologies/tyk/apidef"},"EventHandlerMetaConfig":{"properties":{"events":{"x-go-name":"Events"}},"type":"object","x-go-package":"github.com/TykTechnologies/tyk/apidef"},"ExtendedPathsSet":{"properties":{"advance_cache_config":{"items":{"$ref":"#/components/schemas/CacheMeta"},"type":"array","x-go-name":"AdvanceCacheConfig"},"black_list":{"items":{"$ref":"#/components/schemas/EndPointMeta"},"type":"array","x-go-name":"BlackList"},"cache":{"items":{"type":"string"},"type":"array","x-go-name":"Cached"},"circuit_breakers":{"items":{"$ref":"#/components/schemas/CircuitBreakerMeta"},"type":"array","x-go-name":"CircuitBreaker"},"do_not_track_endpoints":{"items":{"$ref":"#/components/schemas/TrackEndpointMeta"},"type":"array","x-go-name":"DoNotTrackEndpoints"},"hard_timeouts":{"items":{"$ref":"#/components/schemas/HardTimeoutMeta"},"type":"array","x-go-name":"HardTimeouts"},"ignored":{"items":{"$ref":"#/components/schemas/EndPointMeta"},"type":"array","x-go-name":"Ignored"},"internal":{"items":{"$ref":"#/components/schemas/InternalMeta"},"type":"array","x-go-name":"Internal"},"method_transforms":{"items":{"$ref":"#/components/schemas/MethodTransformMeta"},"type":"array","x-go-name":"MethodTransforms"},"size_limits":{"items":{"$ref":"#/components/schemas/RequestSizeMeta"},"type":"array","x-go-name":"SizeLimit"},"track_endpoints":{"items":{"$ref":"#/components/schemas/TrackEndpointMeta"},"type":"array","x-go-name":"TrackEndpoints"},"transform":{"items":{"$ref":"#/components/schemas/TemplateMeta"},"type":"array","x-go-name":"Transform"},"transform_headers":{"items":{"$ref":"#/components/schemas/HeaderInjectionMeta"},"type":"array","x-go-name":"TransformHeader"},"transform_jq":{"items":{"$ref":"#/components/schemas/TransformJQMeta"},"type":"array","x-go-name":"TransformJQ"},"transform_jq_response":{"items":{"$ref":"#/components/schemas/TransformJQMeta"},"type":"array","x-go-name":"TransformJQResponse"},"transform_response":{"items":{"$ref":"#/components/schemas/TemplateMeta"},"type":"array","x-go-name":"TransformResponse"},"transform_response_headers":{"items":{"$ref":"#/components/schemas/HeaderInjectionMeta"},"type":"array","x-go-name":"TransformResponseHeader"},"url_rewrites":{"items":{"$ref":"#/components/schemas/URLRewriteMeta"},"type":"array","x-go-name":"URLRewrite"},"validate_json":{"items":{"$ref":"#/components/schemas/ValidatePathMeta"},"type":"array","x-go-name":"ValidateJSON"},"virtual":{"items":{"$ref":"#/components/schemas/VirtualMeta"},"type":"array","x-go-name":"Virtual"},"white_list":{"items":{"$ref":"#/components/schemas/EndPointMeta"},"type":"array","x-go-name":"WhiteList"}},"type":"object","x-go-package":"github.com/TykTechnologies/tyk/apidef"},"GlobalRateLimit":{"properties":{"per":{"format":"double","type":"number","x-go-name":"Per"},"rate":{"format":"double","type":"number","x-go-name":"Rate"}},"type":"object","x-go-package":"github.com/TykTechnologies/tyk/apidef"},"GraphAccessDefinition":{"type":"object","x-go-package":"github.com/TykTechnologies/tyk/user"},"HardTimeoutMeta":{"properties":{"method":{"type":"string","x-go-name":"Method"},"path":{"type":"string","x-go-name":"Path"},"timeout":{"format":"int64","type":"integer","x-go-name":"TimeOut"}},"type":"object","x-go-package":"github.com/TykTechnologies/tyk/apidef"},"HashType":{"type":"string","x-go-package":"github.com/TykTechnologies/tyk/user"},"HeaderInjectionMeta":{"properties":{"act_on":{"type":"boolean","x-go-name":"ActOnResponse"},"add_headers":{"additionalProperties":{"type":"string"},"type":"object","x-go-name":"AddHeaders"},"delete_headers":{"items":{"type":"string"},"type":"array","x-go-name":"DeleteHeaders"},"method":{"type":"string","x-go-name":"Method"},"path":{"type":"string","x-go-name":"Path"}},"type":"object","x-go-package":"github.com/TykTechnologies/tyk/apidef"},"HostCheckObject":{"properties":{"body":{"type":"string","x-go-name":"Body"},"headers":{"additionalProperties":{"type":"string"},"type":"object","x-go-name":"Headers"},"method":{"type":"string","x-go-name":"Method"},"url":{"type":"string","x-go-name":"CheckURL"}},"type":"object","x-go-package":"github.com/TykTechnologies/tyk/apidef"},"IdExtractorSource":{"type":"string","x-go-package":"github.com/TykTechnologies/tyk/apidef"},"IdExtractorType":{"type":"string","x-go-package":"github.com/TykTechnologies/tyk/apidef"},"InternalMeta":{"properties":{"method":{"type":"string","x-go-name":"Method"},"path":{"type":"string","x-go-name":"Path"}},"type":"object","x-go-package":"github.com/TykTechnologies/tyk/apidef"},"MethodTransformMeta":{"properties":{"method":{"type":"string","x-go-name":"Method"},"path":{"type":"string","x-go-name":"Path"},"to_method":{"type":"string","x-go-name":"ToMethod"}},"type":"object","x-go-package":"github.com/TykTechnologies/tyk/apidef"},"MiddlewareDefinition":{"properties":{"name":{"type":"string","x-go-name":"Name"},"path":{"type":"string","x-go-name":"Path"},"require_session":{"type":"boolean","x-go-name":"RequireSession"}},"type":"object","x-go-package":"github.com/TykTechnologies/tyk/apidef"},"MiddlewareDriver":{"type":"string","x-go-package":"github.com/TykTechnologies/tyk/apidef"},"MiddlewareIdExtractor":{"properties":{"extract_from":{"$ref":"#/components/schemas/IdExtractorSource"},"extract_with":{"$ref":"#/components/schemas/IdExtractorType"},"extractor_config":{"additionalProperties":{"type":"object"},"type":"object","x-go-name":"ExtractorConfig"}},"type":"object","x-go-package":"github.com/TykTechnologies/tyk/apidef"},"MiddlewareSection":{"properties":{"auth_check":{"$ref":"#/components/schemas/MiddlewareDefinition"},"driver":{"$ref":"#/components/schemas/MiddlewareDriver"},"id_extractor":{"$ref":"#/components/schemas/MiddlewareIdExtractor"},"post":{"items":{"$ref":"#/components/schemas/MiddlewareDefinition"},"type":"array","x-go-name":"Post"},"post_key_auth":{"items":{"$ref":"#/components/schemas/MiddlewareDefinition"},"type":"array","x-go-name":"PostKeyAuth"},"pre":{"items":{"$ref":"#/components/schemas/MiddlewareDefinition"},"type":"array","x-go-name":"Pre"},"response":{"items":{"$ref":"#/components/schemas/MiddlewareDefinition"},"type":"array","x-go-name":"Response"}},"type":"object","x-go-package":"github.com/TykTechnologies/tyk/apidef"},"NewClientRequest":{"description":"NewClientRequest is an outward facing JSON object translated from osin OAuthClients","properties":{"api_id":{"type":"string","x-go-name":"APIID"},"client_id":{"type":"string","x-go-name":"ClientID"},"description":{"type":"string","x-go-name":"Description"},"meta_data":{"type":"object","x-go-name":"MetaData"},"policy_id":{"type":"string","x-go-name":"PolicyID"},"redirect_uri":{"type":"string","x-go-name":"ClientRedirectURI"},"secret":{"type":"string","x-go-name":"ClientSecret"}},"type":"object","x-go-package":"github.com/TykTechnologies/tyk"},"NotificationsManager":{"description":"TODO: Make this more generic","properties":{"oauth_on_keychange_url":{"type":"string","x-go-name":"OAuthKeyChangeURL"},"shared_secret":{"type":"string","x-go-name":"SharedSecret"}},"title":"NotificationsManager handles sending notifications to OAuth endpoints to notify the provider of key changes.","type":"object","x-go-package":"github.com/TykTechnologies/tyk/apidef"},"OAuthClientToken":{"properties":{"code":{"type":"string","x-go-name":"Token"},"expires":{"format":"int64","type":"integer","x-go-name":"Expires"}},"type":"object","x-go-package":"github.com/TykTechnologies/tyk"},"OIDProviderConfig":{"properties":{"client_ids":{"additionalProperties":{"type":"string"},"type":"object","x-go-name":"ClientIDs"},"issuer":{"type":"string","x-go-name":"Issuer"}},"type":"object","x-go-package":"github.com/TykTechnologies/tyk/apidef"},"ObjectId":{"description":"http://www.mongodb.org/display/DOCS/Object+IDs","title":"ObjectId is a unique ID identifying a BSON value. It must be exactly 12 bytes\nlong. MongoDB objects by default have such a property set in their \"_id\"\nproperty.","type":"string","x-go-package":"github.com/TykTechnologies/tyk/vendor/gopkg.in/mgo.v2/bson"},"OpenIDOptions":{"properties":{"providers":{"items":{"$ref":"#/components/schemas/OIDProviderConfig"},"type":"array","x-go-name":"Providers"},"segregate_by_client":{"type":"boolean","x-go-name":"SegregateByClient"}},"type":"object","x-go-package":"github.com/TykTechnologies/tyk/apidef"},"Policy":{"properties":{"_id":{"$ref":"#/components/schemas/ObjectId","type":"object","x-go-name":"ID"},"id":{"type":"string","x-go-name":"ID"},"name":{"type":"string","x-go-name":"Name"},"org_id":{"type":"string","x-go-name":"OrgID"},"rate":{"format":"double","type":"number","x-go-name":"Rate"},"per":{"format":"double","type":"number","x-go-name":"Per"},"quota_max":{"format":"int64","type":"integer","x-go-name":"QuotaMax"},"quota_renewal_rate":{"format":"int64","type":"integer","x-go-name":"QuotaRenewalRate"},"throttle_interval":{"format":"double","type":"number","x-go-name":"ThrottleInterval"},"throttle_retry_limit":{"type":"number","x-go-name":"ThrottleRetryLimit"},"max_query_depth":{"type":"number","x-go-name":"MaxQueryDepth"},"access_rights":{"$ref":"#/components/schemas/AccessDefinition","type":"object","x-go-name":"AccessRights"},"hmac_enabled":{"type":"boolean","x-go-name":"HMACEnabled"},"enable_http_signature_validation":{"type":"boolean","x-go-name":"EnableHTTPSignatureValidation"},"active":{"type":"boolean","x-go-name":"Active"},"is_inactive":{"type":"boolean","x-go-name":"IsInactive"},"tags":{"type":"array","items":{"type":"string"},"x-go-name":"Tags"},"key_expires_in":{"format":"int64","type":"number","x-go-name":"KeyExpiresIn"},"partitions":{"$ref":"#/components/schemas/PolicyPartitions","type":"object","x-go-name":"Partitions"},"last_updated":{"type":"string","x-go-name":"LastUpdates"},"meta_data":{"type":"object","x-go-name":"MetaData"},"graphql_access_rights":{"$ref":"#/components/schemas/GraphAccessDefinition"}},"type":"object","x-go-package":"github.com/TykTechnologies/tyk/user"},"PolicyPartitions":{"properties":{"quota":{"type":"boolean","x-go-name":"Quota"},"rate_limit":{"type":"boolean","x-go-name":"RateLimit"},"complexity":{"type":"boolean","x-go-name":"Complexity"},"acl":{"type":"boolean","x-go-name":"Acl"},"per_api":{"type":"boolean","x-go-name":"PerAPI"}},"type":"object","x-go-package":"github.com/TykTechnologies/tyk/user"},"Regexp":{"description":"Regexp is a wrapper around regexp.Regexp but with caching","properties":{"FromCache":{"type":"boolean"}},"type":"object","x-go-package":"github.com/TykTechnologies/tyk/regexp"},"RequestInputType":{"type":"string","x-go-package":"github.com/TykTechnologies/tyk/apidef"},"RequestSizeMeta":{"properties":{"method":{"type":"string","x-go-name":"Method"},"path":{"type":"string","x-go-name":"Path"},"size_limit":{"format":"int64","type":"integer","x-go-name":"SizeLimit"}},"type":"object","x-go-package":"github.com/TykTechnologies/tyk/apidef"},"ResponseProcessor":{"properties":{"name":{"type":"string","x-go-name":"Name"},"options":{"type":"object","x-go-name":"Options"}},"type":"object","x-go-package":"github.com/TykTechnologies/tyk/apidef"},"RoutingTrigger":{"properties":{"on":{"$ref":"#/components/schemas/RoutingTriggerOnType"},"options":{"$ref":"#/components/schemas/RoutingTriggerOptions"},"rewrite_to":{"type":"string","x-go-name":"RewriteTo"}},"type":"object","x-go-package":"github.com/TykTechnologies/tyk/apidef"},"RoutingTriggerOnType":{"type":"string","x-go-package":"github.com/TykTechnologies/tyk/apidef"},"RoutingTriggerOptions":{"properties":{"header_matches":{"additionalProperties":{"$ref":"#/components/schemas/StringRegexMap"},"type":"object","x-go-name":"HeaderMatches"},"path_part_matches":{"additionalProperties":{"$ref":"#/components/schemas/StringRegexMap"},"type":"object","x-go-name":"PathPartMatches"},"payload_matches":{"$ref":"#/components/schemas/StringRegexMap"},"query_val_matches":{"additionalProperties":{"$ref":"#/components/schemas/StringRegexMap"},"type":"object","x-go-name":"QueryValMatches"},"request_context_matches":{"additionalProperties":{"$ref":"#/components/schemas/StringRegexMap"},"type":"object","x-go-name":"RequestContextMatches"},"session_meta_matches":{"additionalProperties":{"$ref":"#/components/schemas/StringRegexMap"},"type":"object","x-go-name":"SessionMetaMatches"}},"type":"object","x-go-package":"github.com/TykTechnologies/tyk/apidef"},"ServiceDiscoveryConfiguration":{"properties":{"cache_timeout":{"format":"int64","type":"integer","x-go-name":"CacheTimeout"},"data_path":{"type":"string","x-go-name":"DataPath"},"endpoint_returns_list":{"type":"boolean","x-go-name":"EndpointReturnsList"},"parent_data_path":{"type":"string","x-go-name":"ParentDataPath"},"port_data_path":{"type":"string","x-go-name":"PortDataPath"},"query_endpoint":{"type":"string","x-go-name":"QueryEndpoint"},"target_path":{"type":"string","x-go-name":"TargetPath"},"use_discovery_service":{"type":"boolean","x-go-name":"UseDiscoveryService"},"use_nested_query":{"type":"boolean","x-go-name":"UseNestedQuery"},"use_target_list":{"type":"boolean","x-go-name":"UseTargetList"}},"type":"object","x-go-package":"github.com/TykTechnologies/tyk/apidef"},"SessionProviderCode":{"type":"string","x-go-package":"github.com/TykTechnologies/tyk/apidef"},"SessionProviderMeta":{"properties":{"meta":{"additionalProperties":{"type":"object"},"type":"object","x-go-name":"Meta"},"name":{"$ref":"#/components/schemas/SessionProviderCode"},"storage_engine":{"$ref":"#/components/schemas/StorageEngineCode"}},"type":"object","x-go-package":"github.com/TykTechnologies/tyk/apidef"},"SessionState":{"description":"There's a data structure that's based on this and it's used for Protocol Buffer support, make sure to update \"coprocess/proto/coprocess_session_state.proto\" and generate the bindings using: cd coprocess/proto && ./update_bindings.sh","properties":{"tags":{"items":{"type":"string"},"type":"array","x-go-name":"Tags"},"access_rights":{"additionalProperties":{"$ref":"#/components/schemas/AccessDefinition"},"type":"object","x-go-name":"AccessRights"},"alias":{"type":"string","x-go-name":"Alias"},"allowance":{"format":"double","type":"number","x-go-name":"Allowance"},"apply_policies":{"items":{"type":"string"},"type":"array","x-go-name":"ApplyPolicies"},"apply_policy_id":{"type":"string","x-go-name":"ApplyPolicyID"},"basic_auth_data":{"properties":{"hash_type":{"$ref":"#/components/schemas/HashType"},"password":{"type":"string","x-go-name":"Password"}},"type":"object","x-go-name":"BasicAuthData"},"certificate":{"type":"string","x-go-name":"Certificate"},"data_expires":{"format":"int64","type":"integer","x-go-name":"DataExpires"},"enable_detail_recording":{"type":"boolean","x-go-name":"EnableDetailedRecording"},"expires":{"format":"int64","type":"integer","x-go-name":"Expires"},"hmac_enabled":{"type":"boolean","x-go-name":"HMACEnabled"},"hmac_string":{"type":"string","x-go-name":"HmacSecret"},"id_extractor_deadline":{"format":"int64","type":"integer","x-go-name":"IdExtractorDeadline"},"is_inactive":{"type":"boolean","x-go-name":"IsInactive"},"jwt_data":{"properties":{"secret":{"type":"string","x-go-name":"Secret"}},"type":"object","x-go-name":"JWTData"},"last_check":{"format":"int64","type":"integer","x-go-name":"LastCheck"},"last_updated":{"type":"string","x-go-name":"LastUpdated"},"meta_data":{"additionalProperties":{"type":"object"},"type":"object","x-go-name":"MetaData"},"monitor":{"properties":{"trigger_limits":{"items":{"format":"double","type":"number"},"type":"array","x-go-name":"TriggerLimits"}},"type":"object","x-go-name":"Monitor"},"oauth_client_id":{"type":"string","x-go-name":"OauthClientID"},"oauth_keys":{"additionalProperties":{"type":"string"},"type":"object","x-go-name":"OauthKeys"},"org_id":{"type":"string","x-go-name":"OrgID"},"per":{"format":"double","type":"number","x-go-name":"Per"},"quota_max":{"format":"int64","type":"integer","x-go-name":"QuotaMax"},"quota_remaining":{"format":"int64","type":"integer","x-go-name":"QuotaRemaining"},"quota_renewal_rate":{"format":"int64","type":"integer","x-go-name":"QuotaRenewalRate"},"quota_renews":{"format":"int64","type":"integer","x-go-name":"QuotaRenews"},"rate":{"format":"double","type":"number","x-go-name":"Rate"},"session_lifetime":{"format":"int64","type":"integer","x-go-name":"SessionLifetime"},"throttle_interval":{"format":"double","type":"number","x-go-name":"ThrottleInterval"},"throttle_retry_limit":{"format":"int64","type":"integer","x-go-name":"ThrottleRetryLimit"}},"title":"SessionState objects represent a current API session, mainly used for rate limiting.","type":"object","x-go-package":"github.com/TykTechnologies/tyk/user"},"SignatureConfig":{"properties":{"algorithm":{"type":"string","x-go-name":"Algorithm"},"allowed_clock_skew":{"format":"int64","type":"integer","x-go-name":"AllowedClockSkew"},"error_code":{"format":"int64","type":"integer","x-go-name":"ErrorCode"},"error_message":{"type":"string","x-go-name":"ErrorMessage"},"header":{"type":"string","x-go-name":"Header"},"secret":{"type":"string","x-go-name":"Secret"}},"type":"object","x-go-package":"github.com/TykTechnologies/tyk/apidef"},"StorageEngineCode":{"type":"string","x-go-package":"github.com/TykTechnologies/tyk/apidef"},"StringRegexMap":{"properties":{"match_rx":{"type":"string","x-go-name":"MatchPattern"},"reverse":{"type":"boolean","x-go-name":"Reverse"}},"type":"object","x-go-package":"github.com/TykTechnologies/tyk/apidef"},"TemplateData":{"properties":{"enable_session":{"type":"boolean","x-go-name":"EnableSession"},"input_type":{"$ref":"#/components/schemas/RequestInputType"},"template_mode":{"$ref":"#/components/schemas/TemplateMode"},"template_source":{"type":"string","x-go-name":"TemplateSource"}},"type":"object","x-go-package":"github.com/TykTechnologies/tyk/apidef"},"TemplateMeta":{"properties":{"method":{"type":"string","x-go-name":"Method"},"path":{"type":"string","x-go-name":"Path"},"template_data":{"$ref":"#/components/schemas/TemplateData"}},"type":"object","x-go-package":"github.com/TykTechnologies/tyk/apidef"},"TemplateMode":{"type":"string","x-go-package":"github.com/TykTechnologies/tyk/apidef"},"TrackEndpointMeta":{"properties":{"method":{"type":"string","x-go-name":"Method"},"path":{"type":"string","x-go-name":"Path"}},"type":"object","x-go-package":"github.com/TykTechnologies/tyk/apidef"},"TransformJQMeta":{"properties":{"filter":{"type":"string","x-go-name":"Filter"},"method":{"type":"string","x-go-name":"Method"},"path":{"type":"string","x-go-name":"Path"}},"type":"object","x-go-package":"github.com/TykTechnologies/tyk/apidef"},"URLRewriteMeta":{"properties":{"MatchRegexp":{"$ref":"#/components/schemas/Regexp"},"match_pattern":{"type":"string","x-go-name":"MatchPattern"},"method":{"type":"string","x-go-name":"Method"},"path":{"type":"string","x-go-name":"Path"},"rewrite_to":{"type":"string","x-go-name":"RewriteTo"},"triggers":{"items":{"$ref":"#/components/schemas/RoutingTrigger"},"type":"array","x-go-name":"Triggers"}},"type":"object","x-go-package":"github.com/TykTechnologies/tyk/apidef"},"ValidatePathMeta":{"properties":{"error_response_code":{"description":"Allows override of default 422 Unprocessible Entity response code for validation errors.","format":"int64","type":"integer","x-go-name":"ErrorResponseCode"},"method":{"type":"string","x-go-name":"Method"},"path":{"type":"string","x-go-name":"Path"},"schema":{"additionalProperties":{"type":"object"},"type":"object","x-go-name":"Schema"},"schema_b64":{"type":"string","x-go-name":"SchemaB64"}},"type":"object","x-go-package":"github.com/TykTechnologies/tyk/apidef"},"VersionInfo":{"properties":{"paths":{"properties":{"black_list":{"items":{"type":"string"},"type":"array","x-go-name":"BlackList"},"ignored":{"items":{"type":"string"},"type":"array","x-go-name":"Ignored"},"white_list":{"items":{"type":"string"},"type":"array","x-go-name":"WhiteList"}},"type":"object","x-go-name":"Paths"},"expires":{"type":"string","x-go-name":"Expires"},"extended_paths":{"$ref":"#/components/schemas/ExtendedPathsSet"},"global_headers":{"additionalProperties":{"type":"string"},"type":"object","x-go-name":"GlobalHeaders"},"global_headers_remove":{"items":{"type":"string"},"type":"array","x-go-name":"GlobalHeadersRemove"},"global_size_limit":{"format":"int64","type":"integer","x-go-name":"GlobalSizeLimit"},"name":{"type":"string","x-go-name":"Name"},"override_target":{"type":"string","x-go-name":"OverrideTarget"},"use_extended_paths":{"type":"boolean","x-go-name":"UseExtendedPaths"}},"type":"object","x-go-package":"github.com/TykTechnologies/tyk/apidef"},"VirtualMeta":{"properties":{"function_source_type":{"type":"string","x-go-name":"FunctionSourceType"},"function_source_uri":{"type":"string","x-go-name":"FunctionSourceURI"},"method":{"type":"string","x-go-name":"Method"},"path":{"type":"string","x-go-name":"Path"},"proxy_on_error":{"type":"boolean","x-go-name":"ProxyOnError"},"response_function_name":{"type":"string","x-go-name":"ResponseFunctionName"},"use_session":{"type":"boolean","x-go-name":"UseSession"}},"type":"object","x-go-package":"github.com/TykTechnologies/tyk/apidef"},"apiAllKeys":{"description":"apiAllKeys represents a list of keys in the memory store","properties":{"keys":{"items":{"type":"string"},"type":"array","x-go-name":"APIKeys"}},"type":"object","x-go-package":"github.com/TykTechnologies/tyk"},"apiModifyKeySuccess":{"description":"apiModifyKeySuccess represents when a Key modification was successful","properties":{"action":{"type":"string","x-go-name":"Action"},"key":{"description":"in:body","type":"string","x-go-name":"Key"},"key_hash":{"type":"string","x-go-name":"KeyHash"},"status":{"type":"string","x-go-name":"Status"}},"type":"object","x-go-package":"github.com/TykTechnologies/tyk"},"apiStatusMessage":{"description":"apiStatusMessage represents an API status message","properties":{"message":{"description":"Response details","type":"string","x-go-name":"Message"},"status":{"type":"string","x-go-name":"Status"}},"type":"object","x-go-package":"github.com/TykTechnologies/tyk"},"APIAllCertificates":{"description":"APIAllCertificates represents a list of certificates","properties":{"certs":{"items":{"type":"string"},"type":"array","x-go-name":"Certs"}},"type":"object","x-go-package":"github.com/TykTechnologies/tyk"},"APIAllCertificateBasics":{"description":"APIAllCertificates represents a list of certificate basics","properties":{"certs":{"items":{"$ref":"#/components/schemas/CertificateBasics"},"type":"array","x-go-name":"Certs"}},"type":"object","x-go-package":"github.com/TykTechnologies/tyk"},"CertificateBasics":{"description":"CertificateBasics represents basic details of a certificate","properties":{"id":{"type":"string","x-go-name":"ID"},"issuer_cn":{"type":"string","x-go-name":"IssuerCN"},"subject_cn":{"type":"string","x-go-name":"SubjectCN"},"dns_names":{"type":"array","items":{"type":"string"},"x-go-name":"DNSNames"},"has_private":{"type":"string","x-go-name":"HasPrivateKey"},"not_before":{"type":"string","x-go-name":"NotBefore"},"not_after":{"type":"string","x-go-name":"NotAfter"}},"type":"object","x-go-package":"github.com/TykTechnologies/tyk"},"CertificateMeta":{"description":"CertificateBasics represents basic details of a certificate","properties":{"id":{"type":"string","x-go-name":"ID"},"fingerprint":{"type":"string","x-go-name":"Fingerprint"},"has_private":{"type":"string","x-go-name":"HasPrivateKey"},"issuer":{"$ref":"#/components/schemas/pkixName"},"subject":{"$ref":"#/components/schemas/pkixName"},"not_before":{"type":"string","x-go-name":"NotBefore"},"not_after":{"type":"string","x-go-name":"NotAfter"},"dns_names":{"type":"array","items":{"type":"string"},"x-go-name":"DNSNames"}},"type":"object","x-go-package":"github.com/TykTechnologies/tyk"},"pkixName":{"description":"Name represents an X.509 distinguished name","properties":{"Country":{"type":"array","items":{"type":"string"}},"Organization":{"type":"array","items":{"type":"string"}},"OrganizationalUnit":{"type":"array","items":{"type":"string"}},"Locality":{"type":"array","items":{"type":"string"}},"Province":{"type":"array","items":{"type":"string"}},"StreetAddress":{"type":"array","items":{"type":"string"}},"PostalCode":{"type":"array","items":{"type":"string"}},"SerialNumber":{"type":"string"},"CommonName":{"type":"string"},"Names":{"type":"array","items":{"$ref":"#/components/schemas/pkixAttributeTypeAndValue"}},"ExtraNames":{"type":"array","items":{"$ref":"#/components/schemas/pkixAttributeTypeAndValueSET"}}}},"pkixAttributeTypeAndValue":{"description":"AttributeTypeAndValue mirrors the ASN.1 structure of the same name in RFC 5280, Section 4.1.2.4.","properties":{"Type":{"type":"array","items":{"type":"integer"}},"Value":{"type":"object"}}},"pkixAttributeTypeAndValueSET":{"description":"AttributeTypeAndValueSET represents a set of ASN.1 sequences of AttributeTypeAndValue sequences from RFC 2986 (PKCS","properties":{"Type":{"type":"array","items":{"type":"integer"}},"Value":{"type":"array","items":{"type":"array","items":{"$ref":"#/components/schemas/pkixAttributeTypeAndValue"}}}}},"APICertificateStatusMessage":{"description":"Status message when certificate is added","properties":{"id":{"type":"string","x-go-name":"CertID"},"status":{"type":"string","x-go-name":"Status"},"message":{"type":"string","x-go-name":"Message"}},"type":"object","x-go-package":"github.com/TykTechnologies/tyk"},"OASSchemaResponse":{"description":"OAS schema endpoint response","type":"object","properties":{"status":{"type":"string"},"message":{"type":"string"},"schema":{"type":"string","description":"<OAS schema definition>"}}},"BooleanQueryParam":{"type":"string","enum":[true,false],"example":true},"APIVersionMeta":{"description":"API version meta","type":"object","properties":{"id":{"type":"string"},"versionName":{"type":"string"},"internal":{"type":"boolean"},"expirationDate":{"type":"string"},"isDefaultVersion":{"type":"boolean"}}}},"parameters":{"UpstreamURL":{"name":"upstreamURL","in":"query","description":"Upstream URL for the API","required":false,"schema":{"type":"string"}},"ListenPath":{"name":"listenPath","in":"query","description":"Listen path for the API","schema":{"type":"string"},"required":false},"CustomDomain":{"name":"customDomain","schema":{"type":"string"},"description":"Custom domain for the API","in":"query","required":false},"ValidateRequest":{"name":"validateRequest","in":"query","description":"Enable validateRequest middleware for all endpoints having a request body with media type application/json","required":false,"schema":{"$ref":"#/components/schemas/BooleanQueryParam"}},"AllowList":{"name":"allowList","in":"query","description":"Enable allowList middleware for all endpoints","required":false,"schema":{"$ref":"#/components/schemas/BooleanQueryParam"}},"Authentication":{"name":"authentication","in":"query","description":"Enable/disable the authentication mechanism in your Tyk Gateway for your OAS API","schema":{"$ref":"#/components/schemas/BooleanQueryParam"}},"SearchText":{"name":"searchText","schema":{"type":"string"},"description":"Search for API version name","in":"query","required":false},"AccessType":{"name":"accessType","schema":{"type":"string","enum":["internal","external"]},"description":"Filter for internal or external API versions","in":"query","required":false}}},"security":[{"bearerAuth":[]}]}
/ api / portal / policies /
/ api / portal / policies / search
/ api / portal / policies / {id}
/ api / apis
/ api / apis / search
/ api / apis / {id}
/ api / apis / oas
/ api / apis / oas / {apiID}
/ api / apis / oas / {apiID} / versions
/ api / apis / oas / import
/ api / apis / oas / {apiID} / export
/ api / apis / oas / export
/ api / activity / keys / {keyHash} / {startDay} / {startMonth} / {startYear} / {EndDay} / {EndMonth} / {EndYear}
/ api / activity / oauthid / {OAuthClientID} / {startDay} / {startMonth} / {startYear} / {EndDay} / {EndMonth} / {EndYear}
/ api / apis / {apiID} / keys
/ api / apis / {apiID} / keys / {keyID}
/ api / keys
/ api / keys / {keyID}
/ api / org / permissions
/ api / sso /
/ api / apis / keys / basic / {username}
/ api / org / opa
/ api / org / permission
/ api / users
/ api / users / {USER_ID}
/ api / users / {USER_ID} / actions / reset
/ api / users / {USER_ID} / actions / key / reset
/ api / schema
Tyk Dashboard Admin API OpenAPI	{"openapi":"3.0.0","info":{"title":"Tyk Dashboard Admin API","version":"3.2.0","description":"For Tyk On-Premises installations only, the Dashboard Admin API has two endpoints and is used to set up and provision a Tyk Dashboard instance without the command line.\n\nIn order to use the Dashboard Admin API, you'll need to get the `admin_secret` value from your Tyk Dashboard configurations.\n\nThe secret you set should then be sent along as a header with each Dashboard Admin API Request in order for it to be successful:\n\n```\nadmin-auth: <your-secret>\n```"},"servers":[{"url":"http://localhost/"},{"url":"https://localhost/"}],"tags":[{"name":"Export","description":"To make Tyk installations more portable, the Export API enables you to export key configuration objects required to back-up and re-deploy a basic Tyk Pro installation."},{"name":"Import","description":"The import API enables you to add Organisations, APIs and Policies back into a Tyk installation while retaining their base IDs so that they work together."},{"name":"Single Sign On","description":"The Dashboard SSO API allows you to implement custom authentication schemes for the Dashboard and Portal. Our Tyk Identity Broker (TIB) internally also uses this API."},{"name":"Dashboard URL Reload","description":"Since the Dashboard can have multiple URLs associated with it. It is possible to force a URL reload by calling an API endpoint of the Dashboard API."},{"name":"Organisations","description":"The organisations API gives the ability to manage your Tyk organisation(s)."},{"name":"Users","description":"The admin portion of the users API gives you the ability to manage password reset policies for your Dashboard users."}],"paths":{"/admin/system/reload":{"get":{"summary":"Reloads dashboard urls","description":"Reloads dashboard urls.","operationId":"reloadURLs","tags":["Dashboard URL Reload"],"responses":{"200":{"description":"URLs reloaded successfully.","content":{"application/json":{"schema":{"properties":{"status":{"type":"string"}}},"example":{"status":"ok"}}}},"401":{"description":"Unauthorized.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/apiStatusMessage"},"example":{"Status":"Error","Message":"Not authorised"}}}}}}},"/admin/sso/":{"post":{"summary":"Generate authentication token","description":"The Dashboard exposes the /admin/sso Dashboard API which allows you to generate a temporary authentication token, valid for 60 seconds.","operationId":"generateAuthToken","tags":["Single Sign On"],"requestBody":{"content":{"application/json":{"schema":{"properties":{"ForSection":{"type":"string","enum":["dashboard","portal"]},"OrgID":{"type":"string"},"EmailAddress":{"type":"string"},"GroupID":{"type":"string"}}},"example":{"ForSection":"dashboard","OrgID":"588b4f0bb275ff0001cc7471","EmailAddress":"name@somewhere.com","GroupID":""}}}},"responses":{"200":{"description":"Additional Permissions updated successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/apiStatusMessage"},"example":{"Status":"OK","Message":"SSO Nonce created","Meta":"YTNiOGUzZjctYWZkYi00OTNhLTYwODItZTAzMDI3MjM0OTEw"}}}},"400":{"description":"Back Request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/apiStatusMessage"},"example":{"Status":"Error","Message":"Cannot create an SSO session for an invalid payload: [Error: Org id not found ('588b4f0bb275ff0001cc7471').]"}}}},"401":{"description":"Unauthorized.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/apiStatusMessage"},"example":{"Status":"Error","Message":"Not authorised"}}}}}}},"/admin/organisations/{orgID}":{"get":{"summary":"Export Organisations","description":"The organisation object is the most fundamental object in a Tyk setup, all other ownership properties hang off the relationship between an organisation and its APIs, Policies and API Tokens.","operationId":"exportOrgs","tags":["Export"],"parameters":[{"name":"orgID","in":"path","description":"ID of organisation","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Organisation exported successfully.","content":{"application/json":{"schema":{"properties":{"apis":{"type":"array","items":{"$ref":"#/components/schemas/APIDefinition"}}}},"example":{"id":"53ac07777cbb8c2d53000002","owner_name":"Test","owner_slug":"test","cname_enabled":true,"cname":"my.domain.com","apis":[{"api_human_name":"API 2","api_id":"5fa2db834e07444f760b7ceb314209fb"},{"api_human_name":"API 1","api_id":"7a6ddeca9244448a4233866938a0d6e2"},{"api_human_name":"API 3","api_id":"109eacaa50b24b64651a1d4dce8ec385"}],"developer_quota":123,"developer_count":21,"event_options":{"key_event":{"webhook":"","email":"","redis":true},"key_request_event":{"webhook":"","email":"","redis":false}},"hybrid_enabled":false,"ui":{"languages":{},"hide_help":false,"default_lang":"","login_page":{},"nav":{},"uptime":{},"portal_section":{},"designer":{},"dont_show_admin_sockets":false,"dont_allow_license_management":false,"dont_allow_license_management_view":false}}}}},"400":{"description":"Back Request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/apiStatusMessage"},"example":{"Status":"Error","Message":"Request body malformed"}}}},"401":{"description":"Unauthorized.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/apiStatusMessage"},"example":{"Status":"Error","Message":"Not authorised"}}}},"404":{"description":"Org not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/apiStatusMessage"},"example":{"Status":"Error","Message":"Could not retrieve org detail"}}}}}}},"/admin/organisations/import":{"post":{"summary":"Import organisations","description":"The organisation object is the most fundamental object in a Tyk setup, all other ownership properties hang off the relationship between an organisation and it’s APIs, Policies and API Tokens.","operationId":"importOrgs","tags":["Import"],"requestBody":{"content":{"application/json":{"schema":{"properties":{"apis":{"type":"array","items":{"$ref":"#/components/schemas/APIDefinition"}}}},"example":{"id":"53ac07777cbb8c2d53000002","owner_name":"Test","owner_slug":"test","cname_enabled":true,"cname":"my.domain.com","apis":[{"api_human_name":"API 2","api_id":"5fa2db834e07444f760b7ceb314209fb"},{"api_human_name":"API 1","api_id":"7a6ddeca9244448a4233866938a0d6e2"},{"api_human_name":"API 3","api_id":"109eacaa50b24b64651a1d4dce8ec385"}],"developer_quota":123,"developer_count":21,"event_options":{"key_event":{"webhook":"","email":"","redis":true},"key_request_event":{"webhook":"","email":"","redis":false}},"hybrid_enabled":false,"ui":{"languages":{},"hide_help":false,"default_lang":"","login_page":{},"nav":{},"uptime":{},"portal_section":{},"designer":{},"dont_show_admin_sockets":false,"dont_allow_license_management":false,"dont_allow_license_management_view":false}}}}},"responses":{"200":{"description":"Org imported successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/apiStatusMessage"},"example":{"Status":"OK","Message":"Org imported","Meta":"53ac07777cbb8c2d53000002"}}}},"400":{"description":"Back Request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/apiStatusMessage"},"example":{"Status":"Error","Message":"Failed to save new Org object to DB"}}}},"401":{"description":"Unauthorized.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/apiStatusMessage"},"example":{"Status":"Error","Message":"Not authorised"}}}}}}},"/admin/apis/import":{"post":{"summary":"Import APIs","description":"The import APIs operates on lists of APIs.","operationId":"importAPIs","tags":["Import"],"requestBody":{"content":{"application/json":{"schema":{"properties":{"apis":{"type":"array","items":{"type":"object","properties":{"api_model":{"type":"object"},"api_definition":{"$ref":"#/components/schemas/APIDefinition"},"hook_references":{"type":"array","items":{"type":"object"}},"is_site":{"type":"boolean"},"sort_by":{"type":"integer"}}}}}},"example":{"apis":[{"api_model":{},"api_definition":{"api_human_name":"API 2","api_id":"5fa2db834e07444f760b7ceb314209fb"},"hook_references":[],"is_site":false,"sort_by":0},{"api_model":{},"api_definition":{"api_human_name":"API 1","api_id":"7a6ddeca9244448a4233866938a0d6e2"},"hook_references":[],"is_site":false,"sort_by":0}]}}}},"responses":{"200":{"description":"APIs imported successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/apiStatusMessage"},"example":{"Status":"OK","Message":"APIs imported","Meta":{"5fa2db834e07444f760b7ceb314209fb":true,"7a6ddeca9244448a4233866938a0d6e2":true}}}}},"400":{"description":"Back Request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/apiStatusMessage"},"example":{"Status":"Error","Message":"Request body malformed"}}}},"401":{"description":"Unauthorized.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/apiStatusMessage"},"example":{"Status":"Error","Message":"Not authorised"}}}}}}},"/admin/policies/import":{"post":{"summary":"Import Policies","description":"The import Policies operates on lists of Policies.","operationId":"importPolocies","tags":["Import"],"requestBody":{"content":{"application/json":{"schema":{"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Policy"}}}},"example":{"data":[{"access_rights":{"5fa2db834e07444f760b7ceb314209fb":{"allowed_urls":[],"apiid":"5fa2db834e07444f760b7ceb314209fb","apiname":"API 2","versions":["Default"]},"7a6ddeca9244448a4233866938a0d6e2":{"allowed_urls":[],"apiid":"7a6ddeca9244448a4233866938a0d6e2","apiname":"API 1","versions":["Default"]}},"active":true,"date_created":"0001-01-01T00:00:00Z","hmac_enabled":false,"is_inactive":false,"key_expires_in":0,"last_updated":"1478791603","name":"Default","org_id":"53ac07777cbb8c2d53000002","partitions":{"acl":false,"quota":false,"rate_limit":false},"per":60,"quota_max":-1,"quota_renewal_rate":3600,"rate":1000,"tags":[]}]}}}},"responses":{"200":{"description":"Policies imported successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/apiStatusMessage"},"example":{"Status":"OK","Message":"Policies imported","Meta":{"61df10078f11dd00097cb55f":true}}}}},"400":{"description":"Back Request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/apiStatusMessage"},"example":{"Status":"Error","Message":"Failed to save new Org object to DB"}}}},"401":{"description":"Unauthorized.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/apiStatusMessage"},"example":{"Status":"Error","Message":"Not authorised"}}}}}}},"/admin/users/{USER_ID}/actions/allow_reset_passwords":{"parameters":[{"name":"USER_ID","in":"path","description":"User ID of the user whose password is being reset","required":true,"schema":{"type":"string"}},{"name":"admin-auth","in":"header","description":"admin_secret value from your tyk_analtyics.conf","required":true,"schema":{"type":"string"}}],"put":{"summary":"Allow password reset for a User","description":"Allow password reset for a User.","operationId":"allowResetPassword","tags":["Users"],"responses":{"200":{"description":"Password reset for user enabled","content":{"application/json":{"example":{"Status":"OK","Message":"User updated","Meta":{"api_model":{},"first_name":"John","last_name":"Doe","email_address":"john@test.com","org_id":"60ef3a1dcb83670001bf2df9","active":true,"id":"614215edb2d47190f98b3b79","access_key":"68b225c4376748207453c235ed8e2a82","user_permissions":{"IsAdmin":"admin","ResetPassword":"admin"},"group_id":"","password_max_days":0,"password_updated":"2021-09-15T15:49:01.863Z","PWHistory":[],"last_login_date":"2021-09-15T15:49:49.754Z","created_at":"2021-09-15T15:49:01Z"}}}}}}}},"/admin/users/{USER_ID}/actions/disallow_reset_passwords":{"parameters":[{"name":"USER_ID","in":"path","description":"User ID of the user whose password reset capability is being disallowed","required":true,"schema":{"type":"string"}},{"name":"admin-auth","in":"header","description":"admin_secret value from your tyk_analtyics.conf","required":true,"schema":{"type":"string"}}],"put":{"summary":"Disallow password reset for a User","description":"Disallow password reset for a User.","operationId":"disallowResetPassword","tags":["Users"],"responses":{"200":{"description":"Password reset for user disabled","content":{"application/json":{"example":{"Status":"OK","Message":"User updated","Meta":{"api_model":{},"first_name":"John","last_name":"Doe","email_address":"john@test.com","org_id":"60ef3a1dcb83670001bf2df9","active":true,"id":"614215edb2d47190f98b3b79","access_key":"68b225c4376748207453c235ed8e2a82","user_permissions":{"IsAdmin":"admin"},"group_id":"","password_max_days":0,"password_updated":"2021-09-15T15:49:01.863Z","PWHistory":[],"last_login_date":"2021-09-15T15:49:49.754Z","created_at":"2021-09-15T15:49:01Z"}}}}}}}},"/admin/organisations/{org-id}":{"parameters":[{"name":"org-id","in":"path","description":"Organisation ID of the org to add, update, or delete.","required":true,"schema":{"type":"string"}},{"name":"admin-auth","in":"header","description":"admin_secret value from your tyk_analtyics.conf","required":true,"schema":{"type":"string"}}],"get":{"summary":"Retrieve a single organisation","description":"Retrieve a single organisation","operationId":"getOrg","tags":["Organisations"],"responses":{"200":{"description":"Organisation retrieved","content":{"application/json":{"example":{"id":"5cc03283d07e7f00019404b3","owner_name":"TestOrg5 Ltd.","owner_slug":"testorg","cname_enabled":true,"cname":"www.tyk-portal-test.com","apis":[{"api_human_name":"First API #Test","api_id":"5508bd9429434d5768c423a04db259ea"}],"developer_quota":0,"developer_count":0,"event_options":{},"hybrid_enabled":false,"ui":{"languages":{},"hide_help":false,"default_lang":"","login_page":{},"nav":{},"uptime":{},"portal_section":{},"designer":{},"dont_show_admin_sockets":false,"dont_allow_license_management":false,"dont_allow_license_management_view":false,"cloud":false},"org_options_meta":{}}}}}}},"put":{"summary":"Update organisation details","description":"Update organisation details","operationId":"updateOrg","tags":["Organisations"],"requestBody":{"content":{"application/json":{"schema":{"type":"object"},"example":{"owner_name":"Jively","cname":"jive.ly","cname_enabled":true}}}},"responses":{"200":{"description":"Organisation updated successfully","content":{"application/json":{"schema":{"type":"object"},"example":{"Status":"OK","Message":"Org updated","Meta":""}}}}}},"delete":{"summary":"Delete an organisation","description":"Delete an organisation","operationId":"deleteOrg","tags":["Organisations"],"responses":{"200":{"description":"Organisation deleted","content":{"application/json":{"schema":{"type":"object"},"example":{"Status":"OK","Message":"Org deleted","Meta":""}}}}}}},"/admin/organisations/":{"parameters":[{"name":"admin-auth","in":"header","description":"admin_secret value from your tyk_analtyics.conf","required":true,"schema":{"type":"string"}}],"get":{"summary":"List all organisations","description":"List all organisations","operationId":"getOrgs","tags":["Organisations"],"responses":{"200":{"description":"Organisations retrieved successfully","content":{"application/json":{"schema":{"type":"object"},"example":{"organisations":[{"id":"5cc03283d07e7f00019404b3","owner_name":"TestOrg5 Ltd.","owner_slug":"testorg","cname_enabled":true,"cname":"www.tyk-portal-test.com","apis":[{"api_human_name":"First API #Test","api_id":"5508bd9429434d5768c423a04db259ea"}],"developer_quota":0,"developer_count":0,"event_options":{},"hybrid_enabled":false,"ui":{"languages":{},"hide_help":false,"default_lang":"","login_page":{},"nav":{},"uptime":{},"portal_section":{},"designer":{},"dont_show_admin_sockets":false,"dont_allow_license_management":false,"dont_allow_license_management_view":false,"cloud":false},"org_options_meta":{}},{"id":"5ccae84aa402ce00018b5435","owner_name":"Jively","owner_slug":"","cname_enabled":true,"cname":"jive.ly","apis":[],"developer_quota":0,"developer_count":0,"event_options":{},"hybrid_enabled":false,"ui":{"languages":{},"hide_help":false,"default_lang":"","login_page":{},"nav":{},"uptime":{},"portal_section":{},"designer":{},"dont_show_admin_sockets":false,"dont_allow_license_management":false,"dont_allow_license_management_view":false,"cloud":false},"org_options_meta":{}}],"pages":0}}}}}},"post":{"summary":"Create an Organisation","description":"Create an Organisation","operationId":"createOrg","tags":["Organisations"],"requestBody":{"content":{"application/json":{"schema":{"type":"object"},"example":{"owner_name":"Jively","cname":"jive.ly","cname_enabled":true}}}},"responses":{"200":{"description":"Organisation created","content":{"application/json":{"schema":{"type":"object"},"example":{"Status":"OK","Message":"Org created","Meta":"54b53d3aeba6db5c35000002"}}}}}}}},"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"Admin-Auth"}},"schemas":{"apiStatusMessage":{"description":"apiStatusMessage represents an API status message","properties":{"message":{"description":"Response details","type":"string","x-go-name":"Message"},"status":{"type":"string","x-go-name":"Status"}},"type":"object","x-go-package":"github.com/TykTechnologies/tyk"},"APIDefinition":{"properties":{"tags":{"items":{"type":"string"},"type":"array","x-go-name":"Tags"},"CORS":{"properties":{"allow_credentials":{"type":"boolean","x-go-name":"AllowCredentials"},"allowed_headers":{"items":{"type":"string"},"type":"array","x-go-name":"AllowedHeaders"},"allowed_methods":{"items":{"type":"string"},"type":"array","x-go-name":"AllowedMethods"},"allowed_origins":{"items":{"type":"string"},"type":"array","x-go-name":"AllowedOrigins"},"debug":{"type":"boolean","x-go-name":"Debug"},"enable":{"type":"boolean","x-go-name":"Enable"},"exposed_headers":{"items":{"type":"string"},"type":"array","x-go-name":"ExposedHeaders"},"max_age":{"format":"int64","type":"integer","x-go-name":"MaxAge"},"options_passthrough":{"type":"boolean","x-go-name":"OptionsPassthrough"}},"type":"object"},"active":{"type":"boolean","x-go-name":"Active"},"allowed_ips":{"items":{"type":"string"},"type":"array","x-go-name":"AllowedIPs"},"api_id":{"type":"string","x-go-name":"APIID"},"auth":{"$ref":"#/components/schemas/Auth"},"auth_provider":{"$ref":"#/components/schemas/AuthProviderMeta"},"base_identity_provided_by":{"$ref":"#/components/schemas/AuthTypeEnum"},"basic_auth":{"properties":{"body_password_regexp":{"type":"string","x-go-name":"BodyPasswordRegexp"},"body_user_regexp":{"type":"string","x-go-name":"BodyUserRegexp"},"cache_ttl":{"format":"int64","type":"integer","x-go-name":"CacheTTL"},"disable_caching":{"type":"boolean","x-go-name":"DisableCaching"},"extract_from_body":{"type":"boolean","x-go-name":"ExtractFromBody"}},"type":"object","x-go-name":"BasicAuth"},"blacklisted_ips":{"items":{"type":"string"},"type":"array","x-go-name":"BlacklistedIPs"},"cache_options":{"$ref":"#/components/schemas/CacheOptions"},"certificates":{"items":{"type":"string"},"type":"array","x-go-name":"Certificates"},"client_certificates":{"items":{"type":"string"},"type":"array","x-go-name":"ClientCertificates"},"config_data":{"additionalProperties":{"type":"object"},"type":"object","x-go-name":"ConfigData"},"custom_middleware":{"$ref":"#/components/schemas/MiddlewareSection"},"custom_middleware_bundle":{"type":"string","x-go-name":"CustomMiddlewareBundle"},"definition":{"properties":{"key":{"type":"string","x-go-name":"Key"},"location":{"type":"string","x-go-name":"Location"},"strip_path":{"type":"boolean","x-go-name":"StripPath"}},"type":"object","x-go-name":"VersionDefinition"},"disable_quota":{"type":"boolean","x-go-name":"DisableQuota"},"disable_rate_limit":{"type":"boolean","x-go-name":"DisableRateLimit"},"do_not_track":{"type":"boolean","x-go-name":"DoNotTrack"},"domain":{"type":"string","x-go-name":"Domain"},"dont_set_quota_on_create":{"type":"boolean","x-go-name":"DontSetQuotasOnCreate"},"enable_batch_request_support":{"type":"boolean","x-go-name":"EnableBatchRequestSupport"},"enable_context_vars":{"type":"boolean","x-go-name":"EnableContextVars"},"enable_coprocess_auth":{"type":"boolean","x-go-name":"EnableCoProcessAuth"},"enable_ip_blacklisting":{"type":"boolean","x-go-name":"EnableIpBlacklisting"},"enable_ip_whitelisting":{"type":"boolean","x-go-name":"EnableIpWhiteListing"},"enable_jwt":{"type":"boolean","x-go-name":"EnableJWT"},"enable_signature_checking":{"type":"boolean","x-go-name":"EnableSignatureChecking"},"event_handlers":{"$ref":"#/components/schemas/EventHandlerMetaConfig"},"expire_analytics_after":{"format":"int64","type":"integer","x-go-name":"ExpireAnalyticsAfter"},"global_rate_limit":{"$ref":"#/components/schemas/GlobalRateLimit"},"hmac_allowed_algorithms":{"items":{"type":"string"},"type":"array","x-go-name":"HmacAllowedAlgorithms"},"hmac_allowed_clock_skew":{"format":"double","type":"number","x-go-name":"HmacAllowedClockSkew"},"id":{"$ref":"#/components/schemas/ObjectId"},"internal":{"type":"boolean","x-go-name":"Internal"},"jwt_client_base_field":{"type":"string","x-go-name":"JWTClientIDBaseField"},"jwt_expires_at_validation_skew":{"format":"uint64","type":"integer","x-go-name":"JWTExpiresAtValidationSkew"},"jwt_identity_base_field":{"type":"string","x-go-name":"JWTIdentityBaseField"},"jwt_issued_at_validation_skew":{"format":"uint64","type":"integer","x-go-name":"JWTIssuedAtValidationSkew"},"jwt_not_before_validation_skew":{"format":"uint64","type":"integer","x-go-name":"JWTNotBeforeValidationSkew"},"jwt_policy_field_name":{"type":"string","x-go-name":"JWTPolicyFieldName"},"jwt_scope_claim_name":{"type":"string","x-go-name":"JWTScopeClaimName"},"jwt_scope_to_policy_mapping":{"additionalProperties":{"type":"string"},"type":"object","x-go-name":"JWTScopeToPolicyMapping"},"jwt_signing_method":{"type":"string","x-go-name":"JWTSigningMethod"},"jwt_skip_kid":{"type":"boolean","x-go-name":"JWTSkipKid"},"jwt_source":{"type":"string","x-go-name":"JWTSource"},"name":{"type":"string","x-go-name":"Name"},"notifications":{"$ref":"#/components/schemas/NotificationsManager"},"oauth_meta":{"properties":{"allowed_access_types":{"items":{"$ref":"#/components/schemas/AccessRequestType"},"type":"array","x-go-name":"AllowedAccessTypes"},"allowed_authorize_types":{"items":{"$ref":"#/components/schemas/AuthorizeRequestType"},"type":"array","x-go-name":"AllowedAuthorizeTypes"},"auth_login_redirect":{"type":"string","x-go-name":"AuthorizeLoginRedirect"}},"type":"object","x-go-name":"Oauth2Meta"},"openid_options":{"$ref":"#/components/schemas/OpenIDOptions"},"org_id":{"type":"string","x-go-name":"OrgID"},"pinned_public_keys":{"additionalProperties":{"type":"string"},"type":"object","x-go-name":"PinnedPublicKeys"},"proxy":{"properties":{"check_host_against_uptime_tests":{"type":"boolean","x-go-name":"CheckHostAgainstUptimeTests"},"disable_strip_slash":{"type":"boolean","x-go-name":"DisableStripSlash"},"enable_load_balancing":{"type":"boolean","x-go-name":"EnableLoadBalancing"},"listen_path":{"type":"string","x-go-name":"ListenPath"},"preserve_host_header":{"type":"boolean","x-go-name":"PreserveHostHeader"},"service_discovery":{"$ref":"#/components/schemas/ServiceDiscoveryConfiguration"},"strip_listen_path":{"type":"boolean","x-go-name":"StripListenPath"},"target_list":{"items":{"type":"string"},"type":"array","x-go-name":"Targets"},"target_url":{"type":"string","x-go-name":"TargetURL"},"transport":{"properties":{"proxy_url":{"type":"string","x-go-name":"ProxyURL"},"ssl_ciphers":{"items":{"type":"string"},"type":"array","x-go-name":"SSLCipherSuites"},"ssl_insecure_skip_verify":{"type":"boolean","x-go-name":"SSLInsecureSkipVerify"},"ssl_min_version":{"format":"uint16","type":"integer","x-go-name":"SSLMinVersion"}},"type":"object","x-go-name":"Transport"}},"type":"object","x-go-name":"Proxy"},"response_processors":{"items":{"$ref":"#/components/schemas/ResponseProcessor"},"type":"array","x-go-name":"ResponseProcessors"},"session_lifetime":{"format":"int64","type":"integer","x-go-name":"SessionLifetime"},"session_provider":{"$ref":"#/components/schemas/SessionProviderMeta"},"slug":{"type":"string","x-go-name":"Slug"},"strip_auth_data":{"type":"boolean","x-go-name":"StripAuthData"},"tag_headers":{"items":{"type":"string"},"type":"array","x-go-name":"TagHeaders"},"upstream_certificates":{"additionalProperties":{"type":"string"},"type":"object","x-go-name":"UpstreamCertificates"},"uptime_tests":{"properties":{"check_list":{"items":{"$ref":"#/components/schemas/HostCheckObject"},"type":"array","x-go-name":"CheckList"},"config":{"properties":{"expire_utime_after":{"format":"int64","type":"integer","x-go-name":"ExpireUptimeAnalyticsAfter"},"recheck_wait":{"format":"int64","type":"integer","x-go-name":"RecheckWait"},"service_discovery":{"$ref":"#/components/schemas/ServiceDiscoveryConfiguration"}},"type":"object","x-go-name":"Config"}},"type":"object","x-go-name":"UptimeTests"},"use_basic_auth":{"type":"boolean","x-go-name":"UseBasicAuth"},"use_keyless":{"type":"boolean","x-go-name":"UseKeylessAccess"},"use_mutual_tls_auth":{"type":"boolean","x-go-name":"UseMutualTLSAuth"},"use_oauth2":{"type":"boolean","x-go-name":"UseOauth2"},"use_openid":{"type":"boolean","x-go-name":"UseOpenID"},"use_standard_auth":{"type":"boolean","x-go-name":"UseStandardAuth"},"version_data":{"properties":{"default_version":{"type":"string","x-go-name":"DefaultVersion"},"not_versioned":{"type":"boolean","x-go-name":"NotVersioned"},"versions":{"additionalProperties":{"$ref":"#/components/schemas/VersionInfo"},"type":"object","x-go-name":"Versions"}},"type":"object","x-go-name":"VersionData"}},"title":"APIDefinition represents the configuration for a single proxied API and it's versions.","type":"object","x-go-package":"github.com/TykTechnologies/tyk/apidef"},"Auth":{"properties":{"auth_header_name":{"type":"string","x-go-name":"AuthHeaderName"},"cookie_name":{"type":"string","x-go-name":"CookieName"},"param_name":{"type":"string","x-go-name":"ParamName"},"signature":{"$ref":"#/components/schemas/SignatureConfig"},"use_certificate":{"type":"boolean","x-go-name":"UseCertificate"},"use_cookie":{"type":"boolean","x-go-name":"UseCookie"},"use_param":{"type":"boolean","x-go-name":"UseParam"},"validate_signature":{"type":"boolean","x-go-name":"ValidateSignature"}},"type":"object","x-go-package":"github.com/TykTechnologies/tyk/apidef"},"SignatureConfig":{"properties":{"algorithm":{"type":"string","x-go-name":"Algorithm"},"allowed_clock_skew":{"format":"int64","type":"integer","x-go-name":"AllowedClockSkew"},"error_code":{"format":"int64","type":"integer","x-go-name":"ErrorCode"},"error_message":{"type":"string","x-go-name":"ErrorMessage"},"header":{"type":"string","x-go-name":"Header"},"secret":{"type":"string","x-go-name":"Secret"}},"type":"object","x-go-package":"github.com/TykTechnologies/tyk/apidef"},"AuthProviderMeta":{"properties":{"meta":{"additionalProperties":{"type":"object"},"type":"object","x-go-name":"Meta"},"name":{"$ref":"#/components/schemas/AuthProviderCode"},"storage_engine":{"$ref":"#/components/schemas/StorageEngineCode"}},"type":"object","x-go-package":"github.com/TykTechnologies/tyk/apidef"},"AuthProviderCode":{"type":"string","x-go-package":"github.com/TykTechnologies/tyk/apidef"},"StorageEngineCode":{"type":"string","x-go-package":"github.com/TykTechnologies/tyk/apidef"},"AuthTypeEnum":{"type":"string","x-go-package":"github.com/TykTechnologies/tyk/apidef"},"CacheOptions":{"properties":{"cache_all_safe_requests":{"type":"boolean","x-go-name":"CacheAllSafeRequests"},"cache_control_ttl_header":{"type":"string","x-go-name":"CacheControlTTLHeader"},"cache_response_codes":{"items":{"format":"int64","type":"integer"},"type":"array","x-go-name":"CacheOnlyResponseCodes"},"cache_timeout":{"format":"int64","type":"integer","x-go-name":"CacheTimeout"},"enable_cache":{"type":"boolean","x-go-name":"EnableCache"},"enable_upstream_cache_control":{"type":"boolean","x-go-name":"EnableUpstreamCacheControl"}},"type":"object","x-go-package":"github.com/TykTechnologies/tyk/apidef"},"MiddlewareSection":{"properties":{"auth_check":{"$ref":"#/components/schemas/MiddlewareDefinition"},"driver":{"$ref":"#/components/schemas/MiddlewareDriver"},"id_extractor":{"$ref":"#/components/schemas/MiddlewareIdExtractor"},"post":{"items":{"$ref":"#/components/schemas/MiddlewareDefinition"},"type":"array","x-go-name":"Post"},"post_key_auth":{"items":{"$ref":"#/components/schemas/MiddlewareDefinition"},"type":"array","x-go-name":"PostKeyAuth"},"pre":{"items":{"$ref":"#/components/schemas/MiddlewareDefinition"},"type":"array","x-go-name":"Pre"},"response":{"items":{"$ref":"#/components/schemas/MiddlewareDefinition"},"type":"array","x-go-name":"Response"}},"type":"object","x-go-package":"github.com/TykTechnologies/tyk/apidef"},"MiddlewareDefinition":{"properties":{"name":{"type":"string","x-go-name":"Name"},"path":{"type":"string","x-go-name":"Path"},"require_session":{"type":"boolean","x-go-name":"RequireSession"}},"type":"object","x-go-package":"github.com/TykTechnologies/tyk/apidef"},"MiddlewareDriver":{"type":"string","x-go-package":"github.com/TykTechnologies/tyk/apidef"},"MiddlewareIdExtractor":{"properties":{"extract_from":{"$ref":"#/components/schemas/IdExtractorSource"},"extract_with":{"$ref":"#/components/schemas/IdExtractorType"},"extractor_config":{"additionalProperties":{"type":"object"},"type":"object","x-go-name":"ExtractorConfig"}},"type":"object","x-go-package":"github.com/TykTechnologies/tyk/apidef"},"IdExtractorSource":{"type":"string","x-go-package":"github.com/TykTechnologies/tyk/apidef"},"IdExtractorType":{"type":"string","x-go-package":"github.com/TykTechnologies/tyk/apidef"},"EventHandlerMetaConfig":{"properties":{"events":{"x-go-name":"Events"}},"type":"object","x-go-package":"github.com/TykTechnologies/tyk/apidef"},"GlobalRateLimit":{"properties":{"per":{"format":"double","type":"number","x-go-name":"Per"},"rate":{"format":"double","type":"number","x-go-name":"Rate"}},"type":"object","x-go-package":"github.com/TykTechnologies/tyk/apidef"},"ObjectId":{"description":"http://www.mongodb.org/display/DOCS/Object+IDs","title":"ObjectId is a unique ID identifying a BSON value. It must be exactly 12 bytes long. MongoDB objects by default have such a property set in their \"_id\" property.","type":"string","x-go-package":"github.com/TykTechnologies/tyk/vendor/gopkg.in/mgo.v2/bson"},"NotificationsManager":{"description":"TODO: Make this more generic","properties":{"oauth_on_keychange_url":{"type":"string","x-go-name":"OAuthKeyChangeURL"},"shared_secret":{"type":"string","x-go-name":"SharedSecret"}},"title":"NotificationsManager handles sending notifications to OAuth endpoints to notify the provider of key changes.","type":"object","x-go-package":"github.com/TykTechnologies/tyk/apidef"},"AccessRequestType":{"description":"AccessRequestType is the type for OAuth param `grant_type`","type":"string","x-go-package":"github.com/TykTechnologies/tyk/vendor/github.com/lonelycode/osin"},"AuthorizeRequestType":{"description":"AuthorizeRequestType is the type for OAuth param `response_type`","type":"string","x-go-package":"github.com/TykTechnologies/tyk/vendor/github.com/lonelycode/osin"},"OpenIDOptions":{"properties":{"providers":{"items":{"$ref":"#/components/schemas/OIDProviderConfig"},"type":"array","x-go-name":"Providers"},"segregate_by_client":{"type":"boolean","x-go-name":"SegregateByClient"}},"type":"object","x-go-package":"github.com/TykTechnologies/tyk/apidef"},"OIDProviderConfig":{"properties":{"client_ids":{"additionalProperties":{"type":"string"},"type":"object","x-go-name":"ClientIDs"},"issuer":{"type":"string","x-go-name":"Issuer"}},"type":"object","x-go-package":"github.com/TykTechnologies/tyk/apidef"},"ServiceDiscoveryConfiguration":{"properties":{"cache_timeout":{"format":"int64","type":"integer","x-go-name":"CacheTimeout"},"data_path":{"type":"string","x-go-name":"DataPath"},"endpoint_returns_list":{"type":"boolean","x-go-name":"EndpointReturnsList"},"parent_data_path":{"type":"string","x-go-name":"ParentDataPath"},"port_data_path":{"type":"string","x-go-name":"PortDataPath"},"query_endpoint":{"type":"string","x-go-name":"QueryEndpoint"},"target_path":{"type":"string","x-go-name":"TargetPath"},"use_discovery_service":{"type":"boolean","x-go-name":"UseDiscoveryService"},"use_nested_query":{"type":"boolean","x-go-name":"UseNestedQuery"},"use_target_list":{"type":"boolean","x-go-name":"UseTargetList"}},"type":"object","x-go-package":"github.com/TykTechnologies/tyk/apidef"},"ResponseProcessor":{"properties":{"name":{"type":"string","x-go-name":"Name"},"options":{"type":"object","x-go-name":"Options"}},"type":"object","x-go-package":"github.com/TykTechnologies/tyk/apidef"},"SessionProviderMeta":{"properties":{"meta":{"additionalProperties":{"type":"object"},"type":"object","x-go-name":"Meta"},"name":{"$ref":"#/components/schemas/SessionProviderCode"},"storage_engine":{"$ref":"#/components/schemas/StorageEngineCode"}},"type":"object","x-go-package":"github.com/TykTechnologies/tyk/apidef"},"SessionProviderCode":{"type":"string","x-go-package":"github.com/TykTechnologies/tyk/apidef"},"VersionInfo":{"properties":{"paths":{"properties":{"black_list":{"items":{"type":"string"},"type":"array","x-go-name":"BlackList"},"ignored":{"items":{"type":"string"},"type":"array","x-go-name":"Ignored"},"white_list":{"items":{"type":"string"},"type":"array","x-go-name":"WhiteList"}},"type":"object","x-go-name":"Paths"},"expires":{"type":"string","x-go-name":"Expires"},"extended_paths":{"$ref":"#/components/schemas/ExtendedPathsSet"},"global_headers":{"additionalProperties":{"type":"string"},"type":"object","x-go-name":"GlobalHeaders"},"global_headers_remove":{"items":{"type":"string"},"type":"array","x-go-name":"GlobalHeadersRemove"},"global_size_limit":{"format":"int64","type":"integer","x-go-name":"GlobalSizeLimit"},"name":{"type":"string","x-go-name":"Name"},"override_target":{"type":"string","x-go-name":"OverrideTarget"},"use_extended_paths":{"type":"boolean","x-go-name":"UseExtendedPaths"}},"type":"object","x-go-package":"github.com/TykTechnologies/tyk/apidef"},"ExtendedPathsSet":{"properties":{"advance_cache_config":{"items":{"$ref":"#/components/schemas/CacheMeta"},"type":"array","x-go-name":"AdvanceCacheConfig"},"black_list":{"items":{"$ref":"#/components/schemas/EndPointMeta"},"type":"array","x-go-name":"BlackList"},"cache":{"items":{"type":"string"},"type":"array","x-go-name":"Cached"},"circuit_breakers":{"items":{"$ref":"#/components/schemas/CircuitBreakerMeta"},"type":"array","x-go-name":"CircuitBreaker"},"do_not_track_endpoints":{"items":{"$ref":"#/components/schemas/TrackEndpointMeta"},"type":"array","x-go-name":"DoNotTrackEndpoints"},"hard_timeouts":{"items":{"$ref":"#/components/schemas/HardTimeoutMeta"},"type":"array","x-go-name":"HardTimeouts"},"ignored":{"items":{"$ref":"#/components/schemas/EndPointMeta"},"type":"array","x-go-name":"Ignored"},"internal":{"items":{"$ref":"#/components/schemas/InternalMeta"},"type":"array","x-go-name":"Internal"},"method_transforms":{"items":{"$ref":"#/components/schemas/MethodTransformMeta"},"type":"array","x-go-name":"MethodTransforms"},"size_limits":{"items":{"$ref":"#/components/schemas/RequestSizeMeta"},"type":"array","x-go-name":"SizeLimit"},"track_endpoints":{"items":{"$ref":"#/components/schemas/TrackEndpointMeta"},"type":"array","x-go-name":"TrackEndpoints"},"transform":{"items":{"$ref":"#/components/schemas/TemplateMeta"},"type":"array","x-go-name":"Transform"},"transform_headers":{"items":{"$ref":"#/components/schemas/HeaderInjectionMeta"},"type":"array","x-go-name":"TransformHeader"},"transform_jq":{"items":{"$ref":"#/components/schemas/TransformJQMeta"},"type":"array","x-go-name":"TransformJQ"},"transform_jq_response":{"items":{"$ref":"#/components/schemas/TransformJQMeta"},"type":"array","x-go-name":"TransformJQResponse"},"transform_response":{"items":{"$ref":"#/components/schemas/TemplateMeta"},"type":"array","x-go-name":"TransformResponse"},"transform_response_headers":{"items":{"$ref":"#/components/schemas/HeaderInjectionMeta"},"type":"array","x-go-name":"TransformResponseHeader"},"url_rewrites":{"items":{"$ref":"#/components/schemas/URLRewriteMeta"},"type":"array","x-go-name":"URLRewrite"},"validate_json":{"items":{"$ref":"#/components/schemas/ValidatePathMeta"},"type":"array","x-go-name":"ValidateJSON"},"virtual":{"items":{"$ref":"#/components/schemas/VirtualMeta"},"type":"array","x-go-name":"Virtual"},"white_list":{"items":{"$ref":"#/components/schemas/EndPointMeta"},"type":"array","x-go-name":"WhiteList"}},"type":"object","x-go-package":"github.com/TykTechnologies/tyk/apidef"},"CacheMeta":{"properties":{"cache_response_codes":{"items":{"format":"int64","type":"integer"},"type":"array","x-go-name":"CacheOnlyResponseCodes"},"cache_key_regex":{"type":"string","x-go-name":"CacheKeyRegex"},"method":{"type":"string","x-go-name":"Method"},"path":{"type":"string","x-go-name":"Path"}},"type":"object","x-go-package":"github.com/TykTechnologies/tyk/apidef"},"EndPointMeta":{"properties":{"method_actions":{"additionalProperties":{"$ref":"#/components/schemas/EndpointMethodMeta"},"type":"object","x-go-name":"MethodActions"},"path":{"type":"string","x-go-name":"Path"}},"type":"object","x-go-package":"github.com/TykTechnologies/tyk/apidef"},"EndpointMethodMeta":{"properties":{"action":{"$ref":"#/components/schemas/EndpointMethodAction"},"code":{"format":"int64","type":"integer","x-go-name":"Code"},"data":{"type":"string","x-go-name":"Data"},"headers":{"additionalProperties":{"type":"string"},"type":"object","x-go-name":"Headers"}},"type":"object","x-go-package":"github.com/TykTechnologies/tyk/apidef"},"EndpointMethodAction":{"type":"string","x-go-package":"github.com/TykTechnologies/tyk/apidef"},"CircuitBreakerMeta":{"properties":{"method":{"type":"string","x-go-name":"Method"},"path":{"type":"string","x-go-name":"Path"},"return_to_service_after":{"format":"int64","type":"integer","x-go-name":"ReturnToServiceAfter"},"samples":{"format":"int64","type":"integer","x-go-name":"Samples"},"threshold_percent":{"format":"double","type":"number","x-go-name":"ThresholdPercent"}},"type":"object","x-go-package":"github.com/TykTechnologies/tyk/apidef"},"TrackEndpointMeta":{"properties":{"method":{"type":"string","x-go-name":"Method"},"path":{"type":"string","x-go-name":"Path"}},"type":"object","x-go-package":"github.com/TykTechnologies/tyk/apidef"},"HardTimeoutMeta":{"properties":{"method":{"type":"string","x-go-name":"Method"},"path":{"type":"string","x-go-name":"Path"},"timeout":{"format":"int64","type":"integer","x-go-name":"TimeOut"}},"type":"object","x-go-package":"github.com/TykTechnologies/tyk/apidef"},"InternalMeta":{"properties":{"method":{"type":"string","x-go-name":"Method"},"path":{"type":"string","x-go-name":"Path"}},"type":"object","x-go-package":"github.com/TykTechnologies/tyk/apidef"},"MethodTransformMeta":{"properties":{"method":{"type":"string","x-go-name":"Method"},"path":{"type":"string","x-go-name":"Path"},"to_method":{"type":"string","x-go-name":"ToMethod"}},"type":"object","x-go-package":"github.com/TykTechnologies/tyk/apidef"},"RequestSizeMeta":{"properties":{"method":{"type":"string","x-go-name":"Method"},"path":{"type":"string","x-go-name":"Path"},"size_limit":{"format":"int64","type":"integer","x-go-name":"SizeLimit"}},"type":"object","x-go-package":"github.com/TykTechnologies/tyk/apidef"},"TemplateMeta":{"properties":{"method":{"type":"string","x-go-name":"Method"},"path":{"type":"string","x-go-name":"Path"},"template_data":{"$ref":"#/components/schemas/TemplateData"}},"type":"object","x-go-package":"github.com/TykTechnologies/tyk/apidef"},"TemplateData":{"properties":{"enable_session":{"type":"boolean","x-go-name":"EnableSession"},"input_type":{"$ref":"#/components/schemas/RequestInputType"},"template_mode":{"$ref":"#/components/schemas/TemplateMode"},"template_source":{"type":"string","x-go-name":"TemplateSource"}},"type":"object","x-go-package":"github.com/TykTechnologies/tyk/apidef"},"RequestInputType":{"type":"string","x-go-package":"github.com/TykTechnologies/tyk/apidef"},"TemplateMode":{"type":"string","x-go-package":"github.com/TykTechnologies/tyk/apidef"},"HeaderInjectionMeta":{"properties":{"act_on":{"type":"boolean","x-go-name":"ActOnResponse"},"add_headers":{"additionalProperties":{"type":"string"},"type":"object","x-go-name":"AddHeaders"},"delete_headers":{"items":{"type":"string"},"type":"array","x-go-name":"DeleteHeaders"},"method":{"type":"string","x-go-name":"Method"},"path":{"type":"string","x-go-name":"Path"}},"type":"object","x-go-package":"github.com/TykTechnologies/tyk/apidef"},"TransformJQMeta":{"properties":{"filter":{"type":"string","x-go-name":"Filter"},"method":{"type":"string","x-go-name":"Method"},"path":{"type":"string","x-go-name":"Path"}},"type":"object","x-go-package":"github.com/TykTechnologies/tyk/apidef"},"URLRewriteMeta":{"properties":{"MatchRegexp":{"$ref":"#/components/schemas/Regexp"},"match_pattern":{"type":"string","x-go-name":"MatchPattern"},"method":{"type":"string","x-go-name":"Method"},"path":{"type":"string","x-go-name":"Path"},"rewrite_to":{"type":"string","x-go-name":"RewriteTo"},"triggers":{"items":{"$ref":"#/components/schemas/RoutingTrigger"},"type":"array","x-go-name":"Triggers"}},"type":"object","x-go-package":"github.com/TykTechnologies/tyk/apidef"},"Regexp":{"description":"Regexp is a wrapper around regexp.Regexp but with caching","properties":{"FromCache":{"type":"boolean"}},"type":"object","x-go-package":"github.com/TykTechnologies/tyk/regexp"},"RoutingTrigger":{"properties":{"on":{"$ref":"#/components/schemas/RoutingTriggerOnType"},"options":{"$ref":"#/components/schemas/RoutingTriggerOptions"},"rewrite_to":{"type":"string","x-go-name":"RewriteTo"}},"type":"object","x-go-package":"github.com/TykTechnologies/tyk/apidef"},"RoutingTriggerOnType":{"type":"string","x-go-package":"github.com/TykTechnologies/tyk/apidef"},"RoutingTriggerOptions":{"properties":{"header_matches":{"additionalProperties":{"$ref":"#/components/schemas/StringRegexMap"},"type":"object","x-go-name":"HeaderMatches"},"path_part_matches":{"additionalProperties":{"$ref":"#/components/schemas/StringRegexMap"},"type":"object","x-go-name":"PathPartMatches"},"payload_matches":{"$ref":"#/components/schemas/StringRegexMap"},"query_val_matches":{"additionalProperties":{"$ref":"#/components/schemas/StringRegexMap"},"type":"object","x-go-name":"QueryValMatches"},"request_context_matches":{"additionalProperties":{"$ref":"#/components/schemas/StringRegexMap"},"type":"object","x-go-name":"RequestContextMatches"},"session_meta_matches":{"additionalProperties":{"$ref":"#/components/schemas/StringRegexMap"},"type":"object","x-go-name":"SessionMetaMatches"}},"type":"object","x-go-package":"github.com/TykTechnologies/tyk/apidef"},"StringRegexMap":{"properties":{"match_rx":{"type":"string","x-go-name":"MatchPattern"},"reverse":{"type":"boolean","x-go-name":"Reverse"}},"type":"object","x-go-package":"github.com/TykTechnologies/tyk/apidef"},"ValidatePathMeta":{"properties":{"error_response_code":{"description":"Allows override of default 422 Unprocessible Entity response code for validation errors.","format":"int64","type":"integer","x-go-name":"ErrorResponseCode"},"method":{"type":"string","x-go-name":"Method"},"path":{"type":"string","x-go-name":"Path"},"schema":{"additionalProperties":{"type":"object"},"type":"object","x-go-name":"Schema"},"schema_b64":{"type":"string","x-go-name":"SchemaB64"}},"type":"object","x-go-package":"github.com/TykTechnologies/tyk/apidef"},"VirtualMeta":{"properties":{"function_source_type":{"type":"string","x-go-name":"FunctionSourceType"},"function_source_uri":{"type":"string","x-go-name":"FunctionSourceURI"},"method":{"type":"string","x-go-name":"Method"},"path":{"type":"string","x-go-name":"Path"},"proxy_on_error":{"type":"boolean","x-go-name":"ProxyOnError"},"response_function_name":{"type":"string","x-go-name":"ResponseFunctionName"},"use_session":{"type":"boolean","x-go-name":"UseSession"}},"type":"object","x-go-package":"github.com/TykTechnologies/tyk/apidef"},"HostCheckObject":{"properties":{"body":{"type":"string","x-go-name":"Body"},"headers":{"additionalProperties":{"type":"string"},"type":"object","x-go-name":"Headers"},"method":{"type":"string","x-go-name":"Method"},"url":{"type":"string","x-go-name":"CheckURL"}},"type":"object","x-go-package":"github.com/TykTechnologies/tyk/apidef"},"Policy":{"properties":{"_id":{"$ref":"#/components/schemas/ObjectId","type":"object","x-go-name":"ID"},"id":{"type":"string","x-go-name":"ID"},"name":{"type":"string","x-go-name":"Name"},"org_id":{"type":"string","x-go-name":"OrgID"},"rate":{"format":"double","type":"number","x-go-name":"Rate"},"per":{"format":"double","type":"number","x-go-name":"Per"},"quota_max":{"format":"int64","type":"integer","x-go-name":"QuotaMax"},"quota_renewal_rate":{"format":"int64","type":"integer","x-go-name":"QuotaRenewalRate"},"throttle_interval":{"format":"double","type":"number","x-go-name":"ThrottleInterval"},"throttle_retry_limit":{"type":"number","x-go-name":"ThrottleRetryLimit"},"max_query_depth":{"type":"number","x-go-name":"MaxQueryDepth"},"access_rights":{"$ref":"#/components/schemas/AccessDefinition","type":"object","x-go-name":"AccessRights"},"hmac_enabled":{"type":"boolean","x-go-name":"HMACEnabled"},"enable_http_signature_validation":{"type":"boolean","x-go-name":"EnableHTTPSignatureValidation"},"active":{"type":"boolean","x-go-name":"Active"},"is_inactive":{"type":"boolean","x-go-name":"IsInactive"},"tags":{"type":"array","items":{"type":"string"},"x-go-name":"Tags"},"key_expires_in":{"format":"int64","type":"number","x-go-name":"KeyExpiresIn"},"partitions":{"$ref":"#/components/schemas/PolicyPartitions","type":"object","x-go-name":"Partitions"},"last_updated":{"type":"string","x-go-name":"LastUpdates"},"meta_data":{"type":"object","x-go-name":"MetaData"},"graphql_access_rights":{"$ref":"#/components/schemas/GraphAccessDefinition"}},"type":"object","x-go-package":"github.com/TykTechnologies/tyk/user"},"AccessDefinition":{"description":"AccessDefinition defines which versions of an API a key has access to","properties":{"allowed_urls":{"items":{"$ref":"#/components/schemas/AccessSpec"},"type":"array","x-go-name":"AllowedURLs"},"api_id":{"type":"string","x-go-name":"APIID"},"api_name":{"type":"string","x-go-name":"APIName"},"limit":{"$ref":"#/components/schemas/APILimit"},"versions":{"items":{"type":"string"},"type":"array","x-go-name":"Versions"}},"type":"object","x-go-package":"github.com/TykTechnologies/tyk/user"},"AccessSpec":{"description":"AccessSpecs define what URLS a user has access to an what methods are enabled","properties":{"methods":{"items":{"type":"string"},"type":"array","x-go-name":"Methods"},"url":{"type":"string","x-go-name":"URL"}},"type":"object","x-go-package":"github.com/TykTechnologies/tyk/user"},"APILimit":{"description":"APILimit stores quota and rate limit on ACL level (per API)","properties":{"per":{"format":"double","type":"number","x-go-name":"Per"},"quota_max":{"format":"int64","type":"integer","x-go-name":"QuotaMax"},"quota_remaining":{"format":"int64","type":"integer","x-go-name":"QuotaRemaining"},"quota_renewal_rate":{"format":"int64","type":"integer","x-go-name":"QuotaRenewalRate"},"quota_renews":{"format":"int64","type":"integer","x-go-name":"QuotaRenews"},"rate":{"format":"double","type":"number","x-go-name":"Rate"},"set_by_policy":{"type":"boolean","x-go-name":"SetByPolicy"},"throttle_interval":{"format":"double","type":"number","x-go-name":"ThrottleInterval"},"throttle_retry_limit":{"format":"int64","type":"integer","x-go-name":"ThrottleRetryLimit"}},"type":"object","x-go-package":"github.com/TykTechnologies/tyk/user"},"PolicyPartitions":{"properties":{"quota":{"type":"boolean","x-go-name":"Quota"},"rate_limit":{"type":"boolean","x-go-name":"RateLimit"},"complexity":{"type":"boolean","x-go-name":"Complexity"},"acl":{"type":"boolean","x-go-name":"Acl"},"per_api":{"type":"boolean","x-go-name":"PerAPI"}},"type":"object","x-go-package":"github.com/TykTechnologies/tyk/user"},"GraphAccessDefinition":{"type":"object","x-go-package":"github.com/TykTechnologies/tyk/user"}}},"security":[{"ApiKeyAuth":[]}]}
/ admin / system / reload
/ admin / sso /
/ admin / organisations / {orgID}
/ admin / organisations / import
/ admin / apis / import
/ admin / policies / import
/ admin / users / {USER_ID} / actions / allow_reset_passwords
/ admin / users / {USER_ID} / actions / disallow_reset_passwords
/ admin / organisations / {org-id}
/ admin / organisations /
Tyk Gateway API OpenAPI	{"openapi":"3.0.0","info":{"title":"Tyk Gateway API","version":"3.2.0","description":"The Tyk Gateway API is the primary means for integrating your application with the Tyk API Gateway system. This API is very small, and has no granular permissions system. It is intended to be used purely for internal automation and integration.\n\n**Warning: Under no circumstances should outside parties be granted access to this API.**\n\nThe Tyk Gateway API is capable of:\n\n* Managing session objects (key generation)\n* Managing and listing policies\n* Managing and listing API Definitions (only when not using the Dashboard)\n* Hot reloads / reloading a cluster configuration\n* OAuth client creation (only when not using the Dashboard)\n\n\nIn order to use the Gateway API, you'll need to set the `secret` parameter in your tyk.conf file.\n\nThe shared secret you set should then be sent along as a header with each Gateway API Request in order for it to be successful:\n\n```\nx-tyk-authorization: <your-secret>\n```\n<br/>\n<b>The Tyk Gateway API is subsumed by the Tyk Dashboard API in Pro installations.</b>"},"servers":[{"url":"http://localhost/"},{"url":"https://localhost/"}],"tags":[{"name":"Keys","description":"All keys that are used to access services via Tyk correspond to a session object that informs Tyk about the context of this particular token, like access rules and rate/quota allowance."},{"name":"Policies","description":"A Tyk security policy incorporates several security options that can be applied to an API key. It acts as a template that can override individual sections of an API key (or identity) in Tyk."},{"name":"OAuth","description":"Manage OAuth clients, and manage their tokens"},{"name":"Cache Invalidation","description":"Sometimes a cache might contain stale data, or it may just need to be cleared because of an invalid configuration. This call will purge all keys associated with a cache on an API-by-API basis."},{"name":"Hot Reload","description":"Force restart of the Gateway or whole cluster"},{"name":"Health Checking","description":"Check health check of the Gateway and loaded APIs"},{"name":"Organisation Quotas","description":"It is possible to force API quota and rate limit across all keys that belong to a specific organisation ID. Rate limiting at an organisation level is useful for creating tiered access levels and trial accounts.\nThe Organisation rate limiting middleware works with both Quotas and Rate Limiters. In order to manage this functionality, a simple API has been put in place to manage these sessions.\nAlthough the Organisation session-limiter uses the same session object, all other security keys are optional as they are not used.\n\n<h3>Managing active status</h3>\nTo disallow access to an entire group of keys without rate limiting the organisation, create a session object with the \"is_inactive\" key set to true. This will block access before any other middleware is executed. It is useful when managing subscriptions for an organisation group and access needs to be blocked because of non-payment."},{"name":"Batch requests","description":"Tyk supports batch requests, so a client makes a single request to the API but gets a compound response object back.\n\nThis is especially handy if clients have complex requests that have multiple synchronous dependencies and do not wish to have the entire request / response cycle running for each event.\n\nTo enable batch request support, set the `enable_batch_request_support` value to `true`\n\nThis is especially handy if clients have complex requests that have multiple synchronous dependencies and do not wish to have the entire request / response cycle running for each event.\n\nBatch requests that come into Tyk are *run through the whole Tyk machinery* and *use a relative path to prevent spamming*. This means that a batch request to Tyk for three resources with the same API key will have three requests applied to their session quota and request limiting could become active if they are being throttled.\n\nTyk reconstructs the API request based on the data in the batch request. This is to ensure that Tyk is not being used to proxy requests to other hosts outside of the upstream API being accessed.\n\nBatch requests are created by POSTing to the `/{listen_path}/tyk/batch/` endpoint. These requests **do not require a valid key**, but their request list does.\n\n<h3>Sample Request</h3>\n\n ```{json}\n {\n \"requests\": [\n {\n \"method\": \"GET\",\n \"headers\": {\n \"x-tyk-test\": \"1\",\n \"x-tyk-version\": \"1.2\",\n \"authorization\": \"1dbc83b9c431649d7698faa9797e2900f\"\n },\n \"body\": \"\",\n \"relative_url\": \"get\"\n },\n {\n \"method\": \"GET\",\n \"headers\": {\n \"x-tyk-test\": \"2\",\n \"x-tyk-version\": \"1.2\",\n \"authorization\": \"1dbc83b9c431649d7698faa9797e2900f\"\n },\n \"body\": \"\",\n \"relative_url\": \"get\"\n }\n ],\n \"suppress_parallel_execution\": false\n }\n ```\n\nThe response will will be a structured reply that encapsulates the responses for each of the outbound requests. If `suppress_parallel_execution` is set to `true`, requests will be made synchronously. If set to `false` then they will run in parallel and the response order is not guaranteed.\n\n<h3>Sample Response</h3>\n\n```\n[\n {\n \"relative_url\": \"get\",\n \"code\": 200,\n \"headers\": {\n \"Access-Control-Allow-Credentials\": [\n \"true\"\n ],\n \"Access-Control-Allow-Origin\": [\n \"*\"\n ],\n \"Content-Length\": [\n \"497\"\n ],\n \"Content-Type\": [\n \"application/json\"\n ],\n \"Date\": [\n \"Wed, 12 Nov 2014 15:32:43 GMT\"\n ],\n \"Server\": [\n \"gunicorn/18.0\"\n ],\n \"Via\": [\n \"1.1 vegur\"\n ]\n },\n \"body\": \"{\n \"args\": {},\n \"headers\": {\n \"Accept-Encoding\": \"gzip\",\n \"Authorization\": \"1dbc83b9c431649d7698faa9797e2900f\",\n \"Connect-Time\": \"2\",\n \"Connection\": \"close\",\n \"Host\": \"httpbin.org\",\n \"Total-Route-Time\": \"0\",\n \"User-Agent\": \"Go 1.1 package http\",\n \"Via\": \"1.1 vegur\",\n \"X-Request-Id\": \"6a22499a-2776-4aa1-80c0-686581a8be4d\",\n \"X-Tyk-Test\": \"2\",\n \"X-Tyk-Version\": \"1.2\"\n },\n \"origin\": \"127.0.0.1, 62.232.114.250\",\n \"url\": \"http://httpbin.org/get\"\n}\"\n },\n {\n \"relative_url\": \"get\",\n \"code\": 200,\n \"headers\": {\n \"Access-Control-Allow-Credentials\": [\n \"true\"\n ],\n \"Access-Control-Allow-Origin\": [\n \"*\"\n ],\n \"Content-Length\": [\n \"497\"\n ],\n \"Content-Type\": [\n \"application/json\"\n ],\n \"Date\": [\n \"Wed, 12 Nov 2014 15:32:43 GMT\"\n ],\n \"Server\": [\n \"gunicorn/18.0\"\n ],\n \"Via\": [\n \"1.1 vegur\"\n ]\n },\n \"body\": \"{\n \"args\": {},\n \"headers\": {\n \"Accept-Encoding\": \"gzip\",\n \"Authorization\": \"1dbc83b9c431649d7698faa9797e2900f\",\n \"Connect-Time\": \"7\",\n \"Connection\": \"close\",\n \"Host\": \"httpbin.org\",\n \"Total-Route-Time\": \"0\",\n \"User-Agent\": \"Go 1.1 package http\",\n \"Via\": \"1.1 vegur\",\n \"X-Request-Id\": \"1ab61f50-51ff-4828-a7e2-17240385a6d2\",\n \"X-Tyk-Test\": \"1\",\n \"X-Tyk-Version\": \"1.2\"\n },\n \"origin\": \"127.0.0.1, 62.232.114.250\",\n \"url\": \"http://httpbin.org/get\"\n}\"\n }\n]\n```\nWith the body for each request string encoded in the `body` field.\n\n* `expire_analytics_after`: If you are running a busy API, you may want to ensure that your MongoDB database does not overflow with old data. Set the `expire_analytics_after` value to the number of seconds you would like the data to last for. Setting this flag to anything above `0` will set an `expireAt` field for each record that is written to the database.\n\n**Important:** Tyk will not create the expiry index for you. In order to implement data expiry for your analytics data, ensure that the index is created This is easily achieved using the [MongoDB command line interface](https://docs.mongodb.com/getting-started/shell/client/).\n\n* `dont_set_quota_on_create`: This setting defaults to `false`, but if set to `true`, when the API is used to edit, create or add keys, the quota cache in Redis will not be re-set. By default, all updates or creates to Keys that have Quotas set will re-set the quota (This has been the default behaviour since 1.0).\n\n This behaviour can be bypassed on a case-by-case basis by using the `suppress_reset` parameter when making a REST API request. This is the advised mode of operation as it allows for manual, granular control over key quotas and reset timings.\n\n* `cache_options`: This section enables you to configure the caching behaviour of Tyk and to enable or disable the caching middleware for your API.\n\n* `cache_options.enable_cache`: Set this value to `true` if the cache should be enabled for this endpoint, setting it to false will stop all caching behaviour.\n\n* `cache_options.cache_timeout`: The amount of time, in seconds, to keep cached objects, defaults to `60` seconds.\n\n* `cache_options.cache_all_safe_requests`: Set this to `true` if you want all *safe* requests (GET, HEAD, OPTIONS) to be cached. This is a blanket setting for APIs where caching is required but you don't want to set individual paths up in the definition.\n\n* `cache_options.enable_upstream_cache_control`: Set this to `true` if you want your application to control the cache options for Tyk (TTL and whether to cache or not). See [Caching](/docs/basic-config-and-security/reduce-latency/caching/) for more details.\n\n* `response_processors`: Response processors need to be specifically defined so they are loaded on API creation, otherwise the middleware will not fire. In order to have the two main response middleware components fire, the following configuration object should be supplied.\n\n```{json}\n\"response_processors\": [\n {\n \"name\": \"header_injector\",\n \"options\": {\n \"add_headers\": {\"name\": \"value\"},\n \"remove_headers\": [\"name\"]\n }\n },\n {\n \"name\": \"response_body_transform\",\n \"options\": {}\n }\n]\n```\nThe options for the `header_injector` are global, and will apply to all outbound requests."},{"name":"APIs","description":"**Note: Applies only to Tyk Gateway Community Edition**\n\nAPI Management is very simple using the Tyk REST API: each update only affects the underlying file, and this endpoint will only work with disk based installations, not Database-backed ones.\n\nAPIs that are added this way are flushed to to disk into the app_path folder using the format: `{api-id}.json`. Updating existing APIs that use a different naming convention will cause those APIs to be added, which could subsequently lead to a loading error and crash if they use the same listen_path.\n\nThese methods only work on a single API node. If updating a cluster, it is important to ensure that all nodes are updated before initiating a reload."}],"paths":{"/tyk/apis":{"get":{"description":"List APIs\n Only if used without the Tyk Dashboard","tags":["APIs"],"operationId":"listApis","responses":{"200":{"description":"List of API definitions","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/APIDefinition"}},"example":[{"name":"TestAPI","use_keyless":true,"active":true,"proxy":{"listen_path":"/test"}}]}}}}},"post":{"description":"Create API\n A single Tyk node can have its API Definitions queried, deleted and updated remotely. This functionality enables you to remotely update your Tyk definitions without having to manage the files manually.","tags":["APIs"],"operationId":"createApi","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIDefinition"},"example":{"name":"TestAPI","use_keyless":true,"active":true,"proxy":{"listen_path":"/test"}}}}},"responses":{"200":{"description":"API created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/apiModifyKeySuccess"},"example":{"status":"ok","action":"created","key":"{...API JSON definition...}"}}}},"400":{"description":"Malformed data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/apiStatusMessage"},"example":{"status":"error","message":"Malformed API data"}}}}}}},"/tyk/apis/oas":{"get":{"description":"List all OAS format APIs, when used without the Tyk Dashboard.","tags":["OASAPIs"],"operationId":"listApisOAS","parameters":[{"description":"Mode of OAS get, by default mode could be empty which means to get OAS spec including OAS Tyk extension. \nWhen mode=public, OAS spec excluding Tyk extension will be returned in the response","name":"mode","in":"query","schema":{"type":"string"},"example":"public"}],"responses":{"200":{"description":"List of API definitions in OAS format","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/OASSchemaResponse"}}}}}}},"post":{"description":"Create API with OAS format\n A single Tyk node can have its API Definitions queried, deleted and updated remotely. This functionality enables you to remotely update your Tyk definitions without having to manage the files manually.","tags":["OASAPIs"],"operationId":"createApiOAS","requestBody":{"content":{"application/json":{"schema":{"$ref":"https://raw.githubusercontent.com/OAI/OpenAPI-Specification/main/schemas/v3.0/schema.json"}}}},"responses":{"200":{"description":"API created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/apiModifyKeySuccess"},"example":{"status":"ok","action":"created","key":"{...API JSON definition...}"}}}},"400":{"description":"Malformed data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/apiStatusMessage"},"example":{"status":"error","message":"Malformed API data"}}}}}}},"/tyk/apis/{apiID}":{"parameters":[{"description":"The API ID","name":"apiID","in":"path","required":true,"schema":{"type":"string"}}],"get":{"description":"Get API definition\nOnly if used without the Tyk Dashboard","tags":["APIs"],"operationId":"getApi","responses":{"200":{"description":"API definition","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIDefinition"},"example":{"name":"TestAPI","use_keyless":true,"active":true,"proxy":{"listen_path":"/test"}}}}}}},"put":{"description":"Updating an API definition uses the same signature an object as a `POST`, however it will first ensure that the API ID that is being updated is the same as the one in the object being `PUT`.\n\n\nUpdating will completely replace the file descriptor and will not change an API Definition that has already been loaded, the hot-reload endpoint will need to be called to push the new definition to live.\n","tags":["APIs"],"operationId":"updateApi","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIDefinition"},"example":{"name":"TestAPI","use_keyless":true,"active":true,"proxy":{"listen_path":"/test"}}}}},"responses":{"200":{"description":"API updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/apiModifyKeySuccess"},"example":{"status":"ok","action":"updated","key":"{...API JSON definition...}"}}}},"400":{"description":"Malformed data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/apiStatusMessage"},"example":{"status":"error","message":"Malformed API data"}}}}}},"delete":{"description":"Deleting an API definition will remove the file from the file store, the API definition will NOT be unloaded, a separate reload request will need to be made to disable the API endpoint.","tags":["APIs"],"operationId":"deleteApi","responses":{"200":{"description":"API deleted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/apiStatusMessage"},"example":{"message":"API deleted","status":"ok"}}}},"400":{"description":"No API ID specified","content":{"application/json":{"schema":{"$ref":"#/components/schemas/apiStatusMessage"},"example":{"message":"API ID not specified","status":"error"}}}}}}},"/tyk/apis/oas/{apiID}":{"parameters":[{"description":"The API ID","name":"apiID","in":"path","required":true,"schema":{"type":"string"}}],"get":{"description":"Get API definition in OAS format\nOnly if used without the Tyk Dashboard","tags":["OASAPIs"],"parameters":[{"description":"Mode of OAS get, by default mode could be empty which means to get OAS spec including OAS Tyk extension. \nWhen mode=public, OAS spec excluding Tyk extension will be returned in the response","name":"mode","in":"query","schema":{"type":"string"},"example":"public"}],"operationId":"listApiOAS","responses":{"200":{"description":"API definition","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OASSchemaResponse"}}}}}},"put":{"description":"Updating an API definition uses the same signature an object as a `POST`, however it will first ensure that the API ID that is being updated is the same as the one in the object being `PUT`.\n\n\nUpdating will completely replace the file descriptor and will not change an API Definition that has already been loaded, the hot-reload endpoint will need to be called to push the new definition to live.\n","tags":["OASAPIs"],"operationId":"updateApiOAS","requestBody":{"content":{"application/json":{"schema":{"$ref":"https://raw.githubusercontent.com/OAI/OpenAPI-Specification/main/schemas/v3.0/schema.json"}}}},"responses":{"200":{"description":"API updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/apiModifyKeySuccess"},"example":{"status":"ok","action":"updated","key":"{...API JSON definition...}"}}}},"400":{"description":"Malformed data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/apiStatusMessage"},"example":{"status":"error","message":"Malformed API data"}}}}}},"patch":{"summary":"Patch a single OAS API by ID","description":"Update API with OAS format. You can use this endpoint to update OAS part of the tyk API definition.\nThis endpoint allows you to configure tyk OAS extension based on query params provided(similar to import)","tags":["OASAPIs"],"operationId":"patchApiOAS","parameters":[{"$ref":"#/components/parameters/UpstreamURL"},{"$ref":"#/components/parameters/ListenPath"},{"$ref":"#/components/parameters/CustomDomain"},{"$ref":"#/components/parameters/ValidateRequest"},{"$ref":"#/components/parameters/AllowList"},{"$ref":"#/components/parameters/Authentication"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"https://raw.githubusercontent.com/OAI/OpenAPI-Specification/main/schemas/v3.0/schema.json"}}}},"responses":{"200":{"description":"API patched","content":{"application/json":{"schema":{"$ref":"#/components/schemas/apiModifyKeySuccess"},"example":{"status":"ok","action":"modified","key":"{updated APIID}"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/apiStatusMessage"},"examples":{"malformedBody":{"summary":"When the request body is malformed","value":{"message":"Request malformed","status":"error"}},"missingAPIID":{"summary":"When the request is missing APIID in query Param","value":{"message":"Must specify an apiID to patch","status":"error"}},"nonExistingAPIID":{"summary":"When the client sends and APIID which doesn't exists in tyk gw","value":{"message":"No API found for APIID {APIID}","status":"error"}},"invalidUpstreamURL":{"summary":"When the client sends query param upstreamURL which isn't valid","value":{"message":"invalid upstream URL","status":"error"}}}}}},"500":{"description":"When patch request is send while using dashboard app configs","content":{"application/json":{"schema":{"$ref":"#/components/schemas/apiStatusMessage"},"example":{"summary":"dashboard app configs is used for tyk api definitions","value":{"message":"Due to enabled use_db_app_configs, please use the Dashboard API","status":"error"}}}}}}},"delete":{"description":"Deleting an API definition will remove the file from the file store, the API definition will NOT be unloaded, a separate reload request will need to be made to disable the API endpoint.","tags":["OASAPIs"],"operationId":"deleteOASApi","responses":{"200":{"description":"API deleted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/apiStatusMessage"},"example":{"message":"API deleted","status":"ok"}}}},"400":{"description":"No API ID specified","content":{"application/json":{"schema":{"$ref":"#/components/schemas/apiStatusMessage"},"example":{"message":"API ID not specified","status":"error"}}}}}}},"/tyk/apis/oas/{apiID}/export":{"parameters":[{"description":"The API ID","name":"apiID","in":"path","required":true,"schema":{"type":"string"}}],"get":{"description":"Download all OAS format APIs, when used without the Tyk Dashboard.","tags":["OASAPIs"],"operationId":"downloadApiOASPublic","parameters":[{"description":"Mode of OAS export, by default mode could be empty which means to export OAS spec including OAS Tyk extension. \nWhen mode=public, OAS spec excluding Tyk extension is exported","name":"mode","in":"query","schema":{"type":"string"},"example":"public"}],"responses":{"200":{"description":"API definition","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OASSchemaResponse"}}}}}}},"/tyk/apis/oas/export":{"get":{"description":"Download all OAS format APIs, when used without the Tyk Dashboard.","tags":["OASAPIs"],"operationId":"downloadApisOASPublic","parameters":[{"description":"The mode of OAS export. By default the mode is not set which means the OAS spec is exported including the OAS Tyk extension. \nIf the mode is set to public, the OAS spec excluding the Tyk extension is exported.","name":"mode","in":"query","schema":{"type":"string"},"example":"public"}],"responses":{"200":{"description":"API definition","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/OASSchemaResponse"}}}}}}}},"/tyk/apis/oas/import":{"post":{"description":"Create a new OAS format API, without x-tyk-gateway.\nFor use with an existing OAS API that you want to expose via your Tyk Gateway. (New)","tags":["OASAPIs"],"operationId":"importOAS","parameters":[{"$ref":"#/components/parameters/UpstreamURL"},{"$ref":"#/components/parameters/ListenPath"},{"$ref":"#/components/parameters/CustomDomain"},{"$ref":"#/components/parameters/ApiID"},{"$ref":"#/components/parameters/AllowList"},{"$ref":"#/components/parameters/ValidateRequest"},{"$ref":"#/components/parameters/Authentication"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"https://raw.githubusercontent.com/OAI/OpenAPI-Specification/main/schemas/v3.0/schema.json"}}}},"responses":{"200":{"description":"API definition created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/apiModifyKeySuccess"},"example":{"status":"ok","action":"added","key":"{created APIID}"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/apiStatusMessage"},"examples":{"malformedBody":{"summary":"When the request body is malformed","value":{"message":"Request malformed","status":"error"}},"invalidUpstreamURL":{"summary":"When the client sends a query param upstreamURL which isn't valid","value":{"message":"invalid upstream URL","status":"error"}}}}}},"500":{"description":"When an import request is sent using your Tyk Dashboard app configs","content":{"application/json":{"schema":{"$ref":"#/components/schemas/apiStatusMessage"},"example":{"summary":"Tyk Dashboard app configs are being used for Tyk API definitions","value":{"message":"Due to enabled use_db_app_configs, please use the Dashboard API","status":"error"}}}}}}}},"/tyk/cache/{apiID}":{"parameters":[{"description":"The API ID","name":"apiID","in":"path","required":true,"schema":{"type":"string"}}],"delete":{"summary":"Invalidate cache","description":"Invalidate cache for the given API","tags":["Cache Invalidation"],"operationId":"invalidateCache","responses":{"200":{"description":"Invalidate cache","content":{"application/json":{"schema":{"$ref":"#/components/schemas/apiStatusMessage"},"example":{"message":"cache invalidated","status":"ok"}}}}}}},"/tyk/reload/":{"get":{"summary":"Hot-reload a single node","description":"Tyk is capable of reloading configurations without having to stop serving requests. This means that API configurations can be added at runtime, or even modified at runtime and those rules applied immediately without any downtime.","parameters":[{"description":"Block a response until the reload is performed. This can be useful in scripting environments like CI/CD workflows.","name":"block","in":"query","required":false,"schema":{"type":"boolean","enum":[true]}}],"tags":["Hot Reload"],"operationId":"hotReload","responses":{"200":{"description":"Reload gateway","content":{"application/json":{"schema":{"$ref":"#/components/schemas/apiStatusMessage"},"example":{"status":"ok"}}}}}}},"/tyk/reload/group":{"get":{"summary":"Hot-reload a Tyk group","description":"To reload a whole group of Tyk nodes (without using the Dashboard or host manager). You can send an API request to a single node, this node will then send a notification through the pub/sub infrastructure to all other listening nodes (including the host manager if it is being used to manage NginX) which will then trigger a global reload.","tags":["Hot Reload"],"operationId":"hotReloadGroup","responses":{"200":{"description":"Reload the Tyk Gateway","content":{"application/json":{"schema":{"$ref":"#/components/schemas/apiStatusMessage"},"example":{"status":"ok"}}}}}}},"/tyk/hello":{"get":{"summary":"Check the Health of the Tyk Gateway","description":"From v2.7.5 you can now rename the `/hello` endpoint by using the `health_check_endpoint_name` option\n\nReturns 200 response in case of success\n","tags":["Health Checking"],"operationId":"hello","responses":{"200":{"description":"Success","content":{"text/html":{"schema":{"type":"string"},"example":"Hello Tiki"}}}}}},"/tyk/{listenPath}/hello":{"parameters":[{"in":"path","name":"listenPath","required":true,"description":"Listen path of loaded API","schema":{"type":"string"}}],"get":{"summary":"Check the Health of the API","description":"Should point to API domain if it has its own","tags":["Health Checking"],"operationId":"helloAPI","responses":{"200":{"description":"Success","content":{"text/html":{"schema":{"type":"string"},"example":"Hello Tiki"}}}}}},"/tyk/certs":{"get":{"parameters":[{"description":"Organisation ID to list the certificates","in":"query","name":"org_id","required":true,"schema":{"type":"string"}},{"description":"Mode to list the certificate details","name":"mode","in":"query","required":false,"schema":{"type":"string"},"example":"detailed"},{"description":"Comma separated list of certificates to list","name":"certID","in":"query","required":false,"schema":{"type":"string"},"example":"e6ce2b49-3e31-44de-95a7-12f054724283,234a37ac-28d1-4f12-b936-ffb4211b79f1"}],"summary":"List Certificates","description":"List All Certificates in the Tyk Gateway","tags":["Certs"],"operationId":"listCerts","responses":{"200":{"description":"List of all Certificates","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/APIAllCertificates"},{"$ref":"#/components/schemas/APIAllCertificateBasics"},{"type":"array","items":{"$ref":"#/components/schemas/CertificateMeta"}}]}}}}}},"post":{"summary":"Add a certificate","description":"Add a certificate to the Tyk Gateway","tags":["Certs"],"operationId":"addCert","parameters":[{"description":"Organisation ID to list the certificates","in":"query","name":"org_id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"text/plain":{"schema":{"type":"string"}}}},"responses":{"200":{"description":"New Key added","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APICertificateStatusMessage"},"example":{"id":"e6ce2b49-3e31-44de-95a7-12f054724283","message":"Certificate added","status":"ok"}}}},"403":{"description":"Malformed data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/apiStatusMessage"},"example":{"message":"Malformed cert data","status":"error"}}}}}},"delete":{"parameters":[{"description":"Certifiicate ID to be deleted","in":"query","name":"certID","required":true,"schema":{"type":"string"}},{"description":"Organisation ID to list the certificates","in":"query","name":"org_id","required":true,"schema":{"type":"string"}}],"summary":"Delete Certificate","description":"Delete certificate by id","tags":["Certs"],"operationId":"deleteCerts","responses":{"200":{"description":"Deleted certificate","content":{"application/json":{"schema":{"$ref":"#/components/schemas/apiStatusMessage"},"example":{"message":"removed","status":"ok"}}}}}}},"/tyk/keys":{"get":{"summary":"List Keys","description":"You can retrieve all the keys in your Tyk instance. Returns an array of Key IDs.","tags":["Keys"],"operationId":"listKeys","responses":{"200":{"description":"List of all API keys","content":{"application/json":{"schema":{"$ref":"#/components/schemas/apiAllKeys"}}}}}},"post":{"summary":"Create a key","description":"Tyk will generate the access token based on the OrgID specified in the API Definition and a random UUID. This ensures that keys can be \"owned\" by different API Owners should segmentation be needed at an organisational level.\n<br/><br/>\nAPI keys without access_rights data will be written to all APIs on the system (this also means that they will be created across all SessionHandlers and StorageHandlers, it is recommended to always embed access_rights data in a key to ensure that only targeted APIs and their back-ends are written to.","tags":["Keys"],"operationId":"addKey","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SessionState"},"example":{"quota_max":60,"quota_renews":1406121006,"quota_renewal_rate":60,"allowance":100,"rate":100,"per":5,"org_id":"53ac07777cbb8c2d53000002"}}}},"responses":{"200":{"description":"New Key added","content":{"application/json":{"schema":{"$ref":"#/components/schemas/apiModifyKeySuccess"},"example":{"action":"created","key":"{...KEY JSON definition...}","status":"ok"}}}},"400":{"description":"Malformed data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/apiStatusMessage"},"example":{"message":"Malformed Key data","status":"error"}}}}}}},"/tyk/keys/{keyID}":{"parameters":[{"description":"The Key ID","name":"keyID","in":"path","required":true,"schema":{"type":"string"}}],"get":{"summary":"Get a Key","description":"Get session info about the specified key. Should return up to date rate limit and quota usage numbers.","tags":["Keys"],"operationId":"getKey","responses":{"200":{"description":"Key object","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SessionState"},"example":{"quota_max":60,"quota_renews":1406121006,"quota_renewal_rate":60,"allowance":100,"rate":100,"per":5,"org_id":"53ac07777cbb8c2d53000002"}}}}}},"put":{"summary":"Update Key","description":"You can also manually add keys to Tyk using your own key-generation algorithm. It is recommended if using this approach to ensure that the OrgID being used in the API Definition and the key data is blank so that Tyk does not try to prepend or manage the key in any way.","tags":["Keys"],"operationId":"updateKey","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SessionState"},"example":{"quota_max":60,"quota_renews":1406121006,"quota_renewal_rate":60,"allowance":100,"rate":100,"per":5,"org_id":"53ac07777cbb8c2d53000002"}}}},"parameters":[{"description":"Adding the suppress_reset parameter and setting it to 1, will cause Tyk not to reset the quota limit that is in the current live quota manager. By default Tyk will reset the quota in the live quota manager (initialising it) when adding a key. Adding the `suppress_reset` flag to the URL parameters will avoid this behaviour.","name":"suppress_reset","in":"query","required":false,"schema":{"type":"string","enum":["1"]}}],"responses":{"200":{"description":"Key updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/apiModifyKeySuccess"},"example":{"action":"updated","status":"ok"}}}},"400":{"description":"No or incorrect Key ID specified","content":{"application/json":{"schema":{"$ref":"#/components/schemas/apiStatusMessage"},"example":{"message":"Key ID not specified","status":"error"}}}}}},"post":{"summary":"Create Custom Key / Import Key","description":"You can use the `POST /tyk/keys/{KEY_ID}` endpoint as defined below to import existing keys into Tyk.\n\nThis example uses standard `authorization` header authentication, and assumes that the Gateway is located at `127.0.0.1:8080` and the Tyk secret is `352d20ee67be67f6340b4c0605b044b7` - update these as necessary to match your environment.\n\nTo import a key called `mycustomkey`, save the JSON contents as `token.json` (see example below), then run the following Curl command.\n\n```\ncurl http://127.0.0.1:8080/tyk/keys/mycustomkey -H 'x-tyk-authorization: 352d20ee67be67f6340b4c0605b044b7' -H 'Content-Type: application/json' -d @token.json\n```\n\nThe following request will fail as the key doesn't exist.\n\n```\ncurl http://127.0.0.1:8080/quickstart/headers -H 'Authorization. invalid123'\n```\n\nBut this request will now work, using the imported key.\n\n```\ncurl http://127.0.0.1:8080/quickstart/headers -H 'Authorization: mycustomkey'\n```\n\n<h4>Example token.json file<h4>\n\n```\n{\n \"allowance\": 1000,\n \"rate\": 1000,\n \"per\": 60,\n \"expires\": -1,\n \"quota_max\": -1,\n \"quota_renews\": 1406121006,\n \"quota_remaining\": 0,\n \"quota_renewal_rate\": 60,\n \"access_rights\": {\n \"3\": {\n \"api_name\": \"Tyk Test API\",\n \"api_id\": \"3\"\n }\n },\n \"org_id\": \"53ac07777cbb8c2d53000002\",\n \"basic_auth_data\": {\n \"password\": \"\",\n \"hash_type\": \"\"\n },\n \"hmac_enabled\": false,\n \"hmac_string\": \"\",\n \"is_inactive\": false,\n \"apply_policy_id\": \"\",\n \"apply_policies\": [\n \"59672779fa4387000129507d\",\n \"53222349fa4387004324324e\",\n \"543534s9fa4387004324324d\"\n ],\n \"monitor\": {\n \"trigger_limits\": []\n }\n}\n```","tags":["Keys"],"operationId":"createCustomKey","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SessionState"},"example":{"quota_max":60,"quota_renews":1406121006,"quota_renewal_rate":60,"allowance":100,"rate":100,"per":5,"org_id":"53ac07777cbb8c2d53000002"}}}},"parameters":[{"description":"Adding the suppress_reset parameter and setting it to 1, will cause Tyk not to reset the quota limit that is in the current live quota manager. By default Tyk will reset the quota in the live quota manager (initialising it) when adding a key. Adding the `suppress_reset` flag to the URL parameters will avoid this behaviour.","name":"suppress_reset","in":"query","required":false,"schema":{"type":"string","enum":["1"]}}],"responses":{"200":{"description":"Key updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/apiModifyKeySuccess"},"example":{"action":"updated","status":"ok"}}}},"400":{"description":"No or incorrect Key ID specified","content":{"application/json":{"schema":{"$ref":"#/components/schemas/apiStatusMessage"},"example":{"message":"Key ID not specified","status":"error"}}}}}},"delete":{"summary":"Delete Key","description":"Deleting a key will remove it permanently from the system, however analytics relating to that key will still be available.","tags":["Keys"],"operationId":"deleteKey","responses":{"200":{"description":"Key deleted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/apiStatusMessage"},"example":{"action":"Key deleted","status":"ok"}}}}}}},"/tyk/policies":{"get":{"summary":"List Policies","description":"You can retrieve all the policies in your Tyk instance. Returns an array policies.","tags":["Policies"],"operationId":"listPolicies","responses":{"200":{"description":"List of all policies","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Policy"}}}}}}},"post":{"summary":"Create a Policy","description":"You can create a Policy in your Tyk Instance","tags":["Policies"],"operationId":"addPolicy","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Policy"},"example":{"name":"new policy","quota_max":60,"quota_renewal_rate":60,"allowance":100,"rate":100,"per":5,"org_id":"53ac07777cbb8c2d53000002"}}}},"responses":{"200":{"description":"Policy created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/apiModifyKeySuccess"},"example":{"action":"created","status":"ok"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/apiStatusMessage"},"example":{"message":"Request malformed","status":"error"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/apiStatusMessage"},"example":{"message":"Failed to create file!","status":"error"}}}}}}},"/tyk/policies/{polID}":{"parameters":[{"description":"The policy ID","name":"polID","in":"path","required":true,"schema":{"type":"string"}}],"get":{"summary":"Get a Policy","description":"You can retrieve details of a single policy by ID in your Tyk instance. Returns an array policies.","tags":["Policies"],"operationId":"getPolicy","responses":{"200":{"description":"Get details of a single Policy","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Policy"}}}},"404":{"description":"Policy not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/apiStatusMessage"},"example":{"message":"Policy not found","status":"error"}}}}}},"put":{"summary":"Update a Policy","description":"You can update a Policy in your Tyk Instance by ID","tags":["Policies"],"operationId":"updatePolicy","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Policy"},"example":{"name":"new policy","quota_max":60,"quota_renewal_rate":60,"allowance":100,"rate":100,"per":5,"org_id":"53ac07777cbb8c2d53000002"}}}},"responses":{"200":{"description":"Policy updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/apiModifyKeySuccess"},"example":{"action":"updated","status":"ok"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/apiStatusMessage"},"example":{"message":"PUT operation on different IDs","status":"error"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/apiStatusMessage"},"example":{"message":"Failed to create file!","status":"error"}}}}}},"delete":{"summary":"Delete a Policy","description":"Delete a policy by ID in your Tyk instance.","tags":["Policies"],"operationId":"deletePolicy","responses":{"200":{"description":"Delete policy by ID","content":{"application/json":{"schema":{"$ref":"#/components/schemas/apiModifyKeySuccess"},"example":{"action":"deleted","status":"ok"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/apiStatusMessage"},"example":{"message":"Delete failed","status":"error"}}}}}}},"/tyk/oauth/clients/create":{"post":{"summary":"Create new OAuth client","description":"Any OAuth keys must be generated with the help of a client ID. These need to be pre-registered with Tyk before they can be used (in a similar vein to how you would register your app with Twitter before attempting to ask user permissions using their API). <br/><br/> <h3>Creating OAuth clients with Access to Multiple APIs</h3> New from Tyk Gateway 2.6.0 is the ability to create OAuth clients with access to more than one API. If you provide the api_id it works the same as in previous releases. If you don't provide the api_id the request uses policy access rights and enumerates APIs from their setting in the newly created OAuth-client.","tags":["OAuth"],"operationId":"createOAuthClient","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NewClientRequest"},"example":{"client_id":"test","api_id":"id","policy_id":"policy"}}}},"responses":{"200":{"description":"Client created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NewClientRequest"},"example":{"client_id":"test","api_id":"id","policy_id":"policy"}}}}}}},"/tyk/oauth/clients/{apiID}":{"put":{"summary":"Update OAuth metadata and Policy ID","description":"Allows you to update the metadata and Policy ID for an OAuth client.","tags":["OAuth"],"operationId":"updateoAuthClient","parameters":[{"description":"The API ID","name":"apiID","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OAuth client metadata updated","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/NewClientRequest"}}}}}}},"get":{"summary":"List oAuth clients","description":"OAuth Clients are organised by API ID, and therefore are queried as such.","tags":["OAuth"],"operationId":"listOAuthClients","parameters":[{"description":"The API ID","name":"apiID","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Get OAuth client details or a list of OAuth clients","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/NewClientRequest"}}}}}}}},"/tyk/oauth/clients/{apiID}/{keyName}":{"get":{"summary":"Get OAuth client","tags":["OAuth"],"operationId":"getOAuthClient","parameters":[{"description":"The API ID","name":"apiID","in":"path","required":true,"schema":{"type":"string","minimum":1}},{"description":"The Client ID","name":"keyName","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Get OAuth client details or a list of OAuth clients","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NewClientRequest"},"example":{"client_id":"test","api_id":"id","policy_id":"policy"}}}}}},"delete":{"summary":"Delete OAuth client","description":"Please note that tokens issued with the client ID will still be valid until they expire.","tags":["OAuth"],"operationId":"deleteOAuthClient","parameters":[{"description":"The API ID","name":"apiID","in":"path","required":true,"schema":{"type":"string","minimum":1}},{"description":"The Client ID","name":"keyName","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OAuth client deleted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/apiModifyKeySuccess"},"example":{"action":"deleted","status":"ok"}}}}}}},"/tyk/oauth/clients/{apiID}/{keyName}/tokens":{"get":{"summary":"List tokens","description":"This endpoint allows you to retrieve a list of all current tokens and their expiry date for a provided API ID and OAuth-client ID in the following format. This endpoint will work only for newly created tokens. <br/> <br/> You can control how long you want to store expired tokens in this list using `oauth_token_expired_retain_period` gateway option, which specifies retain period for expired tokens stored in Redis. By default expired token not get removed. See <a href=\"https://tyk.io/docs/configure/tyk-gateway-configuration-options/#a-name-oauth-token-expired-retain-period-a-oauth-token-expired-retain-period\" target=\"_blank\">here</a> for more details.","tags":["OAuth"],"operationId":"getOAuthClientTokens","parameters":[{"description":"The API ID","name":"apiID","in":"path","required":true,"schema":{"type":"string","minimum":1}},{"description":"The Client ID","name":"keyName","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Get a list of tokens","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}},"example":["tok1","tok2"]}}}}}},"/tyk/oauth/revoke":{"post":{"description":"revoke a single token","summary":"revoke token","requestBody":{"required":true,"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"token":{"description":"token to be revoked","type":"string"},"client_id":{"description":"id of oauth client","type":"string"},"token_type_hint":{"description":"type of token to be revoked, if sent then the accepted values are access_token and refresh_token. String value and optional, of not provided then it will attempt to remove access and refresh tokens that matchs","type":"string"}}},"example":{"token":"eyJvcmciOiI1ZTIwOTFjNGQ0YWVmY2U2MGMwNGZiOTIiLCJpZCI6ImJlMjlhYjVkODc1OTRhZDJhYTBhNjAwNzFlNzE1ZmQxIiwiaCI6Im11cm11cjY0In0=","client_id":"411f0800957c4a3e81fe181141dbc22a"}}}},"tags":["OAuth"],"operationId":"revokeSingleToken","responses":{"200":{"description":"Succesful response"}}}},"/tyk/oauth/revoke_all":{"post":{"description":"revoke all the tokens for a given oauth client","summary":"revoke all client's tokens","requestBody":{"required":true,"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"client_id":{"description":"id of oauth client","type":"string"},"client_secret":{"description":"OAuth client secret to ensure that its a valid operation","type":"string"}}},"example":{"client_id":"411f0800957c4a3e81fe181141dbc22a","client_secret":"N2Y0YjgzMjctMTEwNi00YWExLWJjM2MtYjg1NWZhM2M1NmNj"}}}},"tags":["OAuth"],"operationId":"revokeAllTokens","responses":{"200":{"description":"Succesful response"},"400":{"description":"Bad request, form malformed or client secret and client id doesn't match"},"404":{"description":"oauth client doesn't have any api related"}}}},"/tyk/oauth/refresh/{keyName}":{"delete":{"summary":"Invalidate OAuth refresh token","description":"It is possible to invalidate refresh tokens in order to manage OAuth client access more robustly.","tags":["OAuth"],"operationId":"invalidateOAuthRefresh","parameters":[{"description":"The API id","name":"api_id","in":"query","required":true,"schema":{"type":"string"}},{"description":"Refresh token","name":"keyName","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Deleted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/apiModifyKeySuccess"}}}}}}},"/tyk/oauth/authorize-client/":{"post":{"description":"With the OAuth flow you will need to create authorisation or access tokens for your clients, in order to do this, Tyk provides a private API endpoint for your application to generate these codes and redirect the end-user back to the API Client.","summary":"Authorize client","requestBody":{"required":true,"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"response_type":{"description":"Should be provided by requesting client as part of authorisation request, this should be either `code` or `token` depending on the methods you have specified for the API.","type":"string"},"client_id":{"description":"Should be provided by requesting client as part of authorisation request. The Client ID that is making the request.","type":"string"},"redirect_uri":{"description":"Should be provided by requesting client as part of authorisation request. Must match with the record stored with Tyk.","type":"string"},"key_rules":{"description":"A string representation of a Session Object (form-encoded). This should be provided by your application in order to apply any quotas or rules to the key.","type":"string"}}},"example":{"response_type":"code","client_id":"21e2baf424674f6461faca6d45285bbb","redirect_uri":"http%3A%2F%2Foauth.com%2Fredirect","key_rules":"%7B+++++%22allowance%22%3A+999%2C+++++%22rate%22%3A+1000%2C+++++%22per%22%3A+60%2C+++++%22expires%22%3A+0%2C+++++%22quota_max%22%3A+-1%2C+++++%22quota_renews%22%3A+1406121006%2C+++++%22quota_remaining%22%3A+0%2C+++++%22quota_renewal_rate%22%3A+60%2C+++++%22access_rights%22%3A+%7B+++++++++%22528a67c1ac9940964f9a41ae79235fcc%22%3A+%7B+++++++++++++%22api_name%22%3A+%22OAuth+Test+API%22%2C+++++++++++++%22api_id%22%3A+%22528a67c1ac9940964f9a41ae79235fcc%22%2C+++++++++++++%22versions%22%3A+%5B+++++++++++++++++%22Default%22+++++++++++++%5D+++++++++%7D+++++%7D%2C+++++%22org_id%22%3A+%2253ac07777cbb8c2d53000002%22+%7D"}}}},"tags":["OAuth"],"operationId":"authorizeClient","responses":{"200":{"description":"Succesful response","content":{"application/json":{"schema":{"type":"object"},"example":{"code":"MWY0ZDRkMzktOTYwNi00NDRiLTk2YmQtOWQxOGQ3Mjc5Yzdk","redirect_to":"http://client-app.com/oauth-redirect/?code=MWY0ZDRkMzktOTYwNi00NDRiLTk2YmQtOWQxOGQ3Mjc5Yzdk"}}}}}}},"/tyk/org/keys":{"get":{"summary":"List Organisation Keys","description":"You can now set rate limits at the organisation level by using the following fields - allowance and rate. These are the number of allowed requests for the specified per value, and need to be set to the same value. If you don't want to have organisation level rate limiting, set 'rate' or 'per' to zero, or don't add them to your request.","tags":["Organisation Quotas"],"operationId":"listOrgKeys","responses":{"200":{"description":"List of all API keys","content":{"application/json":{"schema":{"type":"object","properties":{"keys":{"type":"array","items":{"type":"string"}}}},"example":{"keys":["key1","key2"]}}}}}}},"/tyk/org/keys/{keyID}":{"parameters":[{"description":"The Key ID","name":"keyID","in":"path","required":true,"schema":{"type":"string"}}],"get":{"summary":"Get an Organisation Key","description":"Get session info about specified orgnanisation key. Should return up to date rate limit and quota usage numbers.","tags":["Organisation Quotas"],"operationId":"getOrgKey","responses":{"200":{"description":"Key object","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SessionState"}}}}}},"post":{"summary":"Create an organisation key","description":"This work similar to Keys API except that Key ID is always equals Organisation ID","tags":["Organisation Quotas"],"operationId":"addOrgKey","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SessionState"},"example":{"quota_max":60,"quota_renews":1406121006,"quota_renewal_rate":60,"allowance":100,"rate":100,"per":5,"org_id":"53ac07777cbb8c2d53000002"}}}},"responses":{"200":{"description":"New Key added","content":{"application/json":{"schema":{"$ref":"#/components/schemas/apiModifyKeySuccess"},"example":{"action":"created","key":"{...KEY JSON definition...}","status":"ok"}}}}}},"put":{"summary":"Update Organisation Key","description":"This work similar to Keys API except that Key ID is always equals Organisation ID\n\nFor Gateway v2.6.0 onwards, you can now set rate limits at the organisation level by using the following fields - allowance and rate. These are the number of allowed requests for the specified per value, and need to be set to the same value. If you don't want to have organisation level rate limiting, set `rate` or `per` to zero, or don't add them to your request.","tags":["Organisation Quotas"],"operationId":"updateOrgKey","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SessionState"},"example":{"quota_max":60,"quota_renews":1406121006,"quota_renewal_rate":60,"allowance":100,"rate":100,"per":5,"org_id":"53ac07777cbb8c2d53000002"}}}},"parameters":[{"description":"Adding the `reset_quota` parameter and setting it to 1, will cause Tyk reset the organisations quota in the live quota manager, it is recommended to use this mechanism to reset organisation-level access if a monthly subscription is in place.","name":"reset_quota","in":"query","required":false,"schema":{"type":"string","enum":["1"]}}],"responses":{"200":{"description":"Key updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/apiModifyKeySuccess"},"example":{"action":"updated","status":"ok"}}}}}},"delete":{"summary":"Delete Organisation Key","description":"Deleting a key will remove all limits from organisation. It does not affects regualar keys created within organisation.","tags":["Organisation Quotas"],"operationId":"deleteOrgKey","responses":{"200":{"description":"Key deleted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/apiStatusMessage"},"example":{"action":"Key deleted","status":"ok"}}}}}}},"/{listen_path}/tyk/batch":{"parameters":[{"name":"listen_path","in":"path","required":true,"description":"API listen path","schema":{"type":"string"}}],"post":{"summary":"Run batch request","tags":["Batch requests"],"operationId":"batch","responses":{"200":{"$ref":"#/components/schemas/apiStatusMessage"}}}},"/tyk/schema":{"get":{"description":"Get OAS schema","tags":["Schema"],"operationId":"getSchema","parameters":[{"description":"The OAS version","name":"oasVersion","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"OAS schema response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OASSchemaResponse"},"example":{"status":"Success","schema":"<open api 3.0.3 schema>"}}}},"400":{"description":"The response when the parameter oasVersion is missing","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OASSchemaResponse"},"example":{"message":"Should provide a value for parameter oasVersion","status":"Failed"}}}},"404":{"description":"The response when the requested OAS schema is not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OASSchemaResponse"},"example":{"message":"Schema not found for version 5.0.0","status":"Failed"}}}}}}}},"components":{"responses":{"parameterBodies":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OAuthClientToken"}}},"description":"parameterBodies"}},"schemas":{"APIDefinition":{"properties":{"tags":{"items":{"type":"string"},"type":"array","x-go-name":"Tags"},"CORS":{"properties":{"allow_credentials":{"type":"boolean","x-go-name":"AllowCredentials"},"allowed_headers":{"items":{"type":"string"},"type":"array","x-go-name":"AllowedHeaders"},"allowed_methods":{"items":{"type":"string"},"type":"array","x-go-name":"AllowedMethods"},"allowed_origins":{"items":{"type":"string"},"type":"array","x-go-name":"AllowedOrigins"},"debug":{"type":"boolean","x-go-name":"Debug"},"enable":{"type":"boolean","x-go-name":"Enable"},"exposed_headers":{"items":{"type":"string"},"type":"array","x-go-name":"ExposedHeaders"},"max_age":{"format":"int64","type":"integer","x-go-name":"MaxAge"},"options_passthrough":{"type":"boolean","x-go-name":"OptionsPassthrough"}},"type":"object"},"active":{"type":"boolean","x-go-name":"Active"},"allowed_ips":{"items":{"type":"string"},"type":"array","x-go-name":"AllowedIPs"},"api_id":{"type":"string","x-go-name":"APIID"},"auth":{"$ref":"#/components/schemas/Auth"},"auth_provider":{"$ref":"#/components/schemas/AuthProviderMeta"},"base_identity_provided_by":{"$ref":"#/components/schemas/AuthTypeEnum"},"basic_auth":{"properties":{"body_password_regexp":{"type":"string","x-go-name":"BodyPasswordRegexp"},"body_user_regexp":{"type":"string","x-go-name":"BodyUserRegexp"},"cache_ttl":{"format":"int64","type":"integer","x-go-name":"CacheTTL"},"disable_caching":{"type":"boolean","x-go-name":"DisableCaching"},"extract_from_body":{"type":"boolean","x-go-name":"ExtractFromBody"}},"type":"object","x-go-name":"BasicAuth"},"blacklisted_ips":{"items":{"type":"string"},"type":"array","x-go-name":"BlacklistedIPs"},"cache_options":{"$ref":"#/components/schemas/CacheOptions"},"certificates":{"items":{"type":"string"},"type":"array","x-go-name":"Certificates"},"client_certificates":{"items":{"type":"string"},"type":"array","x-go-name":"ClientCertificates"},"config_data":{"additionalProperties":{"type":"object"},"type":"object","x-go-name":"ConfigData"},"custom_middleware":{"$ref":"#/components/schemas/MiddlewareSection"},"custom_middleware_bundle":{"type":"string","x-go-name":"CustomMiddlewareBundle"},"definition":{"properties":{"key":{"type":"string","x-go-name":"Key"},"location":{"type":"string","x-go-name":"Location"},"strip_path":{"type":"boolean","x-go-name":"StripPath"}},"type":"object","x-go-name":"VersionDefinition"},"disable_quota":{"type":"boolean","x-go-name":"DisableQuota"},"disable_rate_limit":{"type":"boolean","x-go-name":"DisableRateLimit"},"do_not_track":{"type":"boolean","x-go-name":"DoNotTrack"},"domain":{"type":"string","x-go-name":"Domain"},"dont_set_quota_on_create":{"type":"boolean","x-go-name":"DontSetQuotasOnCreate"},"enable_batch_request_support":{"type":"boolean","x-go-name":"EnableBatchRequestSupport"},"enable_context_vars":{"type":"boolean","x-go-name":"EnableContextVars"},"enable_coprocess_auth":{"type":"boolean","x-go-name":"EnableCoProcessAuth"},"enable_ip_blacklisting":{"type":"boolean","x-go-name":"EnableIpBlacklisting"},"enable_ip_whitelisting":{"type":"boolean","x-go-name":"EnableIpWhiteListing"},"enable_jwt":{"type":"boolean","x-go-name":"EnableJWT"},"enable_signature_checking":{"type":"boolean","x-go-name":"EnableSignatureChecking"},"event_handlers":{"$ref":"#/components/schemas/EventHandlerMetaConfig"},"expire_analytics_after":{"format":"int64","type":"integer","x-go-name":"ExpireAnalyticsAfter"},"global_rate_limit":{"$ref":"#/components/schemas/GlobalRateLimit"},"hmac_allowed_algorithms":{"items":{"type":"string"},"type":"array","x-go-name":"HmacAllowedAlgorithms"},"hmac_allowed_clock_skew":{"format":"double","type":"number","x-go-name":"HmacAllowedClockSkew"},"id":{"$ref":"#/components/schemas/ObjectId"},"internal":{"type":"boolean","x-go-name":"Internal"},"jwt_client_base_field":{"type":"string","x-go-name":"JWTClientIDBaseField"},"jwt_expires_at_validation_skew":{"format":"uint64","type":"integer","x-go-name":"JWTExpiresAtValidationSkew"},"jwt_identity_base_field":{"type":"string","x-go-name":"JWTIdentityBaseField"},"jwt_issued_at_validation_skew":{"format":"uint64","type":"integer","x-go-name":"JWTIssuedAtValidationSkew"},"jwt_not_before_validation_skew":{"format":"uint64","type":"integer","x-go-name":"JWTNotBeforeValidationSkew"},"jwt_policy_field_name":{"type":"string","x-go-name":"JWTPolicyFieldName"},"jwt_scope_claim_name":{"type":"string","x-go-name":"JWTScopeClaimName"},"jwt_scope_to_policy_mapping":{"additionalProperties":{"type":"string"},"type":"object","x-go-name":"JWTScopeToPolicyMapping"},"jwt_signing_method":{"type":"string","x-go-name":"JWTSigningMethod"},"jwt_skip_kid":{"type":"boolean","x-go-name":"JWTSkipKid"},"jwt_source":{"type":"string","x-go-name":"JWTSource"},"name":{"type":"string","x-go-name":"Name"},"notifications":{"$ref":"#/components/schemas/NotificationsManager"},"oauth_meta":{"properties":{"allowed_access_types":{"items":{"$ref":"#/components/schemas/AccessRequestType"},"type":"array","x-go-name":"AllowedAccessTypes"},"allowed_authorize_types":{"items":{"$ref":"#/components/schemas/AuthorizeRequestType"},"type":"array","x-go-name":"AllowedAuthorizeTypes"},"auth_login_redirect":{"type":"string","x-go-name":"AuthorizeLoginRedirect"}},"type":"object","x-go-name":"Oauth2Meta"},"openid_options":{"$ref":"#/components/schemas/OpenIDOptions"},"org_id":{"type":"string","x-go-name":"OrgID"},"pinned_public_keys":{"additionalProperties":{"type":"string"},"type":"object","x-go-name":"PinnedPublicKeys"},"proxy":{"properties":{"check_host_against_uptime_tests":{"type":"boolean","x-go-name":"CheckHostAgainstUptimeTests"},"disable_strip_slash":{"type":"boolean","x-go-name":"DisableStripSlash"},"enable_load_balancing":{"type":"boolean","x-go-name":"EnableLoadBalancing"},"listen_path":{"type":"string","x-go-name":"ListenPath"},"preserve_host_header":{"type":"boolean","x-go-name":"PreserveHostHeader"},"service_discovery":{"$ref":"#/components/schemas/ServiceDiscoveryConfiguration"},"strip_listen_path":{"type":"boolean","x-go-name":"StripListenPath"},"target_list":{"items":{"type":"string"},"type":"array","x-go-name":"Targets"},"target_url":{"type":"string","x-go-name":"TargetURL"},"transport":{"properties":{"proxy_url":{"type":"string","x-go-name":"ProxyURL"},"ssl_ciphers":{"items":{"type":"string"},"type":"array","x-go-name":"SSLCipherSuites"},"ssl_insecure_skip_verify":{"type":"boolean","x-go-name":"SSLInsecureSkipVerify"},"ssl_min_version":{"format":"uint16","type":"integer","x-go-name":"SSLMinVersion"}},"type":"object","x-go-name":"Transport"}},"type":"object","x-go-name":"Proxy"},"response_processors":{"items":{"$ref":"#/components/schemas/ResponseProcessor"},"type":"array","x-go-name":"ResponseProcessors"},"session_lifetime":{"format":"int64","type":"integer","x-go-name":"SessionLifetime"},"session_provider":{"$ref":"#/components/schemas/SessionProviderMeta"},"slug":{"type":"string","x-go-name":"Slug"},"strip_auth_data":{"type":"boolean","x-go-name":"StripAuthData"},"tag_headers":{"items":{"type":"string"},"type":"array","x-go-name":"TagHeaders"},"upstream_certificates":{"additionalProperties":{"type":"string"},"type":"object","x-go-name":"UpstreamCertificates"},"uptime_tests":{"properties":{"check_list":{"items":{"$ref":"#/components/schemas/HostCheckObject"},"type":"array","x-go-name":"CheckList"},"config":{"properties":{"expire_utime_after":{"format":"int64","type":"integer","x-go-name":"ExpireUptimeAnalyticsAfter"},"recheck_wait":{"format":"int64","type":"integer","x-go-name":"RecheckWait"},"service_discovery":{"$ref":"#/components/schemas/ServiceDiscoveryConfiguration"}},"type":"object","x-go-name":"Config"}},"type":"object","x-go-name":"UptimeTests"},"use_basic_auth":{"type":"boolean","x-go-name":"UseBasicAuth"},"use_keyless":{"type":"boolean","x-go-name":"UseKeylessAccess"},"use_mutual_tls_auth":{"type":"boolean","x-go-name":"UseMutualTLSAuth"},"use_oauth2":{"type":"boolean","x-go-name":"UseOauth2"},"use_openid":{"type":"boolean","x-go-name":"UseOpenID"},"use_standard_auth":{"type":"boolean","x-go-name":"UseStandardAuth"},"version_data":{"properties":{"default_version":{"type":"string","x-go-name":"DefaultVersion"},"not_versioned":{"type":"boolean","x-go-name":"NotVersioned"},"versions":{"additionalProperties":{"$ref":"#/components/schemas/VersionInfo"},"type":"object","x-go-name":"Versions"}},"type":"object","x-go-name":"VersionData"}},"title":"APIDefinition represents the configuration for a single proxied API and it's versions.","type":"object","x-go-package":"github.com/TykTechnologies/tyk/apidef"},"APILimit":{"description":"APILimit stores quota and rate limit on ACL level (per API)","properties":{"per":{"format":"double","type":"number","x-go-name":"Per"},"quota_max":{"format":"int64","type":"integer","x-go-name":"QuotaMax"},"quota_remaining":{"format":"int64","type":"integer","x-go-name":"QuotaRemaining"},"quota_renewal_rate":{"format":"int64","type":"integer","x-go-name":"QuotaRenewalRate"},"quota_renews":{"format":"int64","type":"integer","x-go-name":"QuotaRenews"},"rate":{"format":"double","type":"number","x-go-name":"Rate"},"set_by_policy":{"type":"boolean","x-go-name":"SetByPolicy"},"throttle_interval":{"format":"double","type":"number","x-go-name":"ThrottleInterval"},"throttle_retry_limit":{"format":"int64","type":"integer","x-go-name":"ThrottleRetryLimit"}},"type":"object","x-go-package":"github.com/TykTechnologies/tyk/user"},"AccessDefinition":{"description":"AccessDefinition defines which versions of an API a key has access to","properties":{"allowed_urls":{"items":{"$ref":"#/components/schemas/AccessSpec"},"type":"array","x-go-name":"AllowedURLs"},"api_id":{"type":"string","x-go-name":"APIID"},"api_name":{"type":"string","x-go-name":"APIName"},"limit":{"$ref":"#/components/schemas/APILimit"},"versions":{"items":{"type":"string"},"type":"array","x-go-name":"Versions"}},"type":"object","x-go-package":"github.com/TykTechnologies/tyk/user"},"AccessRequestType":{"description":"AccessRequestType is the type for OAuth param `grant_type`","type":"string","x-go-package":"github.com/TykTechnologies/tyk/vendor/github.com/lonelycode/osin"},"AccessSpec":{"description":"AccessSpecs define what URLS a user has access to an what methods are enabled","properties":{"methods":{"items":{"type":"string"},"type":"array","x-go-name":"Methods"},"url":{"type":"string","x-go-name":"URL"}},"type":"object","x-go-package":"github.com/TykTechnologies/tyk/user"},"Auth":{"properties":{"auth_header_name":{"type":"string","x-go-name":"AuthHeaderName"},"cookie_name":{"type":"string","x-go-name":"CookieName"},"param_name":{"type":"string","x-go-name":"ParamName"},"signature":{"$ref":"#/components/schemas/SignatureConfig"},"use_certificate":{"type":"boolean","x-go-name":"UseCertificate"},"use_cookie":{"type":"boolean","x-go-name":"UseCookie"},"use_param":{"type":"boolean","x-go-name":"UseParam"},"validate_signature":{"type":"boolean","x-go-name":"ValidateSignature"}},"type":"object","x-go-package":"github.com/TykTechnologies/tyk/apidef"},"AuthProviderCode":{"type":"string","x-go-package":"github.com/TykTechnologies/tyk/apidef"},"AuthProviderMeta":{"properties":{"meta":{"additionalProperties":{"type":"object"},"type":"object","x-go-name":"Meta"},"name":{"$ref":"#/components/schemas/AuthProviderCode"},"storage_engine":{"$ref":"#/components/schemas/StorageEngineCode"}},"type":"object","x-go-package":"github.com/TykTechnologies/tyk/apidef"},"AuthTypeEnum":{"type":"string","x-go-package":"github.com/TykTechnologies/tyk/apidef"},"AuthorizeRequestType":{"description":"AuthorizeRequestType is the type for OAuth param `response_type`","type":"string","x-go-package":"github.com/TykTechnologies/tyk/vendor/github.com/lonelycode/osin"},"CacheMeta":{"properties":{"cache_response_codes":{"items":{"format":"int64","type":"integer"},"type":"array","x-go-name":"CacheOnlyResponseCodes"},"cache_key_regex":{"type":"string","x-go-name":"CacheKeyRegex"},"method":{"type":"string","x-go-name":"Method"},"path":{"type":"string","x-go-name":"Path"}},"type":"object","x-go-package":"github.com/TykTechnologies/tyk/apidef"},"CacheOptions":{"properties":{"cache_all_safe_requests":{"type":"boolean","x-go-name":"CacheAllSafeRequests"},"cache_control_ttl_header":{"type":"string","x-go-name":"CacheControlTTLHeader"},"cache_response_codes":{"items":{"format":"int64","type":"integer"},"type":"array","x-go-name":"CacheOnlyResponseCodes"},"cache_timeout":{"format":"int64","type":"integer","x-go-name":"CacheTimeout"},"enable_cache":{"type":"boolean","x-go-name":"EnableCache"},"enable_upstream_cache_control":{"type":"boolean","x-go-name":"EnableUpstreamCacheControl"}},"type":"object","x-go-package":"github.com/TykTechnologies/tyk/apidef"},"CircuitBreakerMeta":{"properties":{"method":{"type":"string","x-go-name":"Method"},"path":{"type":"string","x-go-name":"Path"},"return_to_service_after":{"format":"int64","type":"integer","x-go-name":"ReturnToServiceAfter"},"samples":{"format":"int64","type":"integer","x-go-name":"Samples"},"threshold_percent":{"format":"double","type":"number","x-go-name":"ThresholdPercent"}},"type":"object","x-go-package":"github.com/TykTechnologies/tyk/apidef"},"EndPointMeta":{"properties":{"method_actions":{"additionalProperties":{"$ref":"#/components/schemas/EndpointMethodMeta"},"type":"object","x-go-name":"MethodActions"},"path":{"type":"string","x-go-name":"Path"}},"type":"object","x-go-package":"github.com/TykTechnologies/tyk/apidef"},"EndpointMethodAction":{"type":"string","x-go-package":"github.com/TykTechnologies/tyk/apidef"},"EndpointMethodMeta":{"properties":{"action":{"$ref":"#/components/schemas/EndpointMethodAction"},"code":{"format":"int64","type":"integer","x-go-name":"Code"},"data":{"type":"string","x-go-name":"Data"},"headers":{"additionalProperties":{"type":"string"},"type":"object","x-go-name":"Headers"}},"type":"object","x-go-package":"github.com/TykTechnologies/tyk/apidef"},"EventHandlerMetaConfig":{"properties":{"events":{"x-go-name":"Events"}},"type":"object","x-go-package":"github.com/TykTechnologies/tyk/apidef"},"ExtendedPathsSet":{"properties":{"advance_cache_config":{"items":{"$ref":"#/components/schemas/CacheMeta"},"type":"array","x-go-name":"AdvanceCacheConfig"},"black_list":{"items":{"$ref":"#/components/schemas/EndPointMeta"},"type":"array","x-go-name":"BlackList"},"cache":{"items":{"type":"string"},"type":"array","x-go-name":"Cached"},"circuit_breakers":{"items":{"$ref":"#/components/schemas/CircuitBreakerMeta"},"type":"array","x-go-name":"CircuitBreaker"},"do_not_track_endpoints":{"items":{"$ref":"#/components/schemas/TrackEndpointMeta"},"type":"array","x-go-name":"DoNotTrackEndpoints"},"hard_timeouts":{"items":{"$ref":"#/components/schemas/HardTimeoutMeta"},"type":"array","x-go-name":"HardTimeouts"},"ignored":{"items":{"$ref":"#/components/schemas/EndPointMeta"},"type":"array","x-go-name":"Ignored"},"internal":{"items":{"$ref":"#/components/schemas/InternalMeta"},"type":"array","x-go-name":"Internal"},"method_transforms":{"items":{"$ref":"#/components/schemas/MethodTransformMeta"},"type":"array","x-go-name":"MethodTransforms"},"size_limits":{"items":{"$ref":"#/components/schemas/RequestSizeMeta"},"type":"array","x-go-name":"SizeLimit"},"track_endpoints":{"items":{"$ref":"#/components/schemas/TrackEndpointMeta"},"type":"array","x-go-name":"TrackEndpoints"},"transform":{"items":{"$ref":"#/components/schemas/TemplateMeta"},"type":"array","x-go-name":"Transform"},"transform_headers":{"items":{"$ref":"#/components/schemas/HeaderInjectionMeta"},"type":"array","x-go-name":"TransformHeader"},"transform_jq":{"items":{"$ref":"#/components/schemas/TransformJQMeta"},"type":"array","x-go-name":"TransformJQ"},"transform_jq_response":{"items":{"$ref":"#/components/schemas/TransformJQMeta"},"type":"array","x-go-name":"TransformJQResponse"},"transform_response":{"items":{"$ref":"#/components/schemas/TemplateMeta"},"type":"array","x-go-name":"TransformResponse"},"transform_response_headers":{"items":{"$ref":"#/components/schemas/HeaderInjectionMeta"},"type":"array","x-go-name":"TransformResponseHeader"},"url_rewrites":{"items":{"$ref":"#/components/schemas/URLRewriteMeta"},"type":"array","x-go-name":"URLRewrite"},"validate_json":{"items":{"$ref":"#/components/schemas/ValidatePathMeta"},"type":"array","x-go-name":"ValidateJSON"},"virtual":{"items":{"$ref":"#/components/schemas/VirtualMeta"},"type":"array","x-go-name":"Virtual"},"white_list":{"items":{"$ref":"#/components/schemas/EndPointMeta"},"type":"array","x-go-name":"WhiteList"}},"type":"object","x-go-package":"github.com/TykTechnologies/tyk/apidef"},"GlobalRateLimit":{"properties":{"per":{"format":"double","type":"number","x-go-name":"Per"},"rate":{"format":"double","type":"number","x-go-name":"Rate"}},"type":"object","x-go-package":"github.com/TykTechnologies/tyk/apidef"},"GraphAccessDefinition":{"type":"object","x-go-package":"github.com/TykTechnologies/tyk/user"},"HardTimeoutMeta":{"properties":{"method":{"type":"string","x-go-name":"Method"},"path":{"type":"string","x-go-name":"Path"},"timeout":{"format":"int64","type":"integer","x-go-name":"TimeOut"}},"type":"object","x-go-package":"github.com/TykTechnologies/tyk/apidef"},"HashType":{"type":"string","x-go-package":"github.com/TykTechnologies/tyk/user"},"HeaderInjectionMeta":{"properties":{"act_on":{"type":"boolean","x-go-name":"ActOnResponse"},"add_headers":{"additionalProperties":{"type":"string"},"type":"object","x-go-name":"AddHeaders"},"delete_headers":{"items":{"type":"string"},"type":"array","x-go-name":"DeleteHeaders"},"method":{"type":"string","x-go-name":"Method"},"path":{"type":"string","x-go-name":"Path"}},"type":"object","x-go-package":"github.com/TykTechnologies/tyk/apidef"},"HostCheckObject":{"properties":{"body":{"type":"string","x-go-name":"Body"},"headers":{"additionalProperties":{"type":"string"},"type":"object","x-go-name":"Headers"},"method":{"type":"string","x-go-name":"Method"},"url":{"type":"string","x-go-name":"CheckURL"}},"type":"object","x-go-package":"github.com/TykTechnologies/tyk/apidef"},"IdExtractorSource":{"type":"string","x-go-package":"github.com/TykTechnologies/tyk/apidef"},"IdExtractorType":{"type":"string","x-go-package":"github.com/TykTechnologies/tyk/apidef"},"InternalMeta":{"properties":{"method":{"type":"string","x-go-name":"Method"},"path":{"type":"string","x-go-name":"Path"}},"type":"object","x-go-package":"github.com/TykTechnologies/tyk/apidef"},"MethodTransformMeta":{"properties":{"method":{"type":"string","x-go-name":"Method"},"path":{"type":"string","x-go-name":"Path"},"to_method":{"type":"string","x-go-name":"ToMethod"}},"type":"object","x-go-package":"github.com/TykTechnologies/tyk/apidef"},"MiddlewareDefinition":{"properties":{"name":{"type":"string","x-go-name":"Name"},"path":{"type":"string","x-go-name":"Path"},"require_session":{"type":"boolean","x-go-name":"RequireSession"}},"type":"object","x-go-package":"github.com/TykTechnologies/tyk/apidef"},"MiddlewareDriver":{"type":"string","x-go-package":"github.com/TykTechnologies/tyk/apidef"},"MiddlewareIdExtractor":{"properties":{"extract_from":{"$ref":"#/components/schemas/IdExtractorSource"},"extract_with":{"$ref":"#/components/schemas/IdExtractorType"},"extractor_config":{"additionalProperties":{"type":"object"},"type":"object","x-go-name":"ExtractorConfig"}},"type":"object","x-go-package":"github.com/TykTechnologies/tyk/apidef"},"MiddlewareSection":{"properties":{"auth_check":{"$ref":"#/components/schemas/MiddlewareDefinition"},"driver":{"$ref":"#/components/schemas/MiddlewareDriver"},"id_extractor":{"$ref":"#/components/schemas/MiddlewareIdExtractor"},"post":{"items":{"$ref":"#/components/schemas/MiddlewareDefinition"},"type":"array","x-go-name":"Post"},"post_key_auth":{"items":{"$ref":"#/components/schemas/MiddlewareDefinition"},"type":"array","x-go-name":"PostKeyAuth"},"pre":{"items":{"$ref":"#/components/schemas/MiddlewareDefinition"},"type":"array","x-go-name":"Pre"},"response":{"items":{"$ref":"#/components/schemas/MiddlewareDefinition"},"type":"array","x-go-name":"Response"}},"type":"object","x-go-package":"github.com/TykTechnologies/tyk/apidef"},"NewClientRequest":{"description":"NewClientRequest is an outward facing JSON object translated from osin OAuthClients","properties":{"api_id":{"type":"string","x-go-name":"APIID"},"client_id":{"type":"string","x-go-name":"ClientID"},"description":{"type":"string","x-go-name":"Description"},"meta_data":{"type":"object","x-go-name":"MetaData"},"policy_id":{"type":"string","x-go-name":"PolicyID"},"redirect_uri":{"type":"string","x-go-name":"ClientRedirectURI"},"secret":{"type":"string","x-go-name":"ClientSecret"}},"type":"object","x-go-package":"github.com/TykTechnologies/tyk"},"NotificationsManager":{"description":"TODO: Make this more generic","properties":{"oauth_on_keychange_url":{"type":"string","x-go-name":"OAuthKeyChangeURL"},"shared_secret":{"type":"string","x-go-name":"SharedSecret"}},"title":"NotificationsManager handles sending notifications to OAuth endpoints to notify the provider of key changes.","type":"object","x-go-package":"github.com/TykTechnologies/tyk/apidef"},"OAuthClientToken":{"properties":{"code":{"type":"string","x-go-name":"Token"},"expires":{"format":"int64","type":"integer","x-go-name":"Expires"}},"type":"object","x-go-package":"github.com/TykTechnologies/tyk"},"OIDProviderConfig":{"properties":{"client_ids":{"additionalProperties":{"type":"string"},"type":"object","x-go-name":"ClientIDs"},"issuer":{"type":"string","x-go-name":"Issuer"}},"type":"object","x-go-package":"github.com/TykTechnologies/tyk/apidef"},"ObjectId":{"description":"http://www.mongodb.org/display/DOCS/Object+IDs","title":"ObjectId is a unique ID identifying a BSON value. It must be exactly 12 bytes\nlong. MongoDB objects by default have such a property set in their \"_id\"\nproperty.","type":"string","x-go-package":"github.com/TykTechnologies/tyk/vendor/gopkg.in/mgo.v2/bson"},"OpenIDOptions":{"properties":{"providers":{"items":{"$ref":"#/components/schemas/OIDProviderConfig"},"type":"array","x-go-name":"Providers"},"segregate_by_client":{"type":"boolean","x-go-name":"SegregateByClient"}},"type":"object","x-go-package":"github.com/TykTechnologies/tyk/apidef"},"Policy":{"properties":{"_id":{"$ref":"#/components/schemas/ObjectId","type":"object","x-go-name":"ID"},"id":{"type":"string","x-go-name":"ID"},"name":{"type":"string","x-go-name":"Name"},"org_id":{"type":"string","x-go-name":"OrgID"},"rate":{"format":"double","type":"number","x-go-name":"Rate"},"per":{"format":"double","type":"number","x-go-name":"Per"},"quota_max":{"format":"int64","type":"integer","x-go-name":"QuotaMax"},"quota_renewal_rate":{"format":"int64","type":"integer","x-go-name":"QuotaRenewalRate"},"throttle_interval":{"format":"double","type":"number","x-go-name":"ThrottleInterval"},"throttle_retry_limit":{"type":"number","x-go-name":"ThrottleRetryLimit"},"max_query_depth":{"type":"number","x-go-name":"MaxQueryDepth"},"access_rights":{"$ref":"#/components/schemas/AccessDefinition","type":"object","x-go-name":"AccessRights"},"hmac_enabled":{"type":"boolean","x-go-name":"HMACEnabled"},"enable_http_signature_validation":{"type":"boolean","x-go-name":"EnableHTTPSignatureValidation"},"active":{"type":"boolean","x-go-name":"Active"},"is_inactive":{"type":"boolean","x-go-name":"IsInactive"},"tags":{"type":"array","items":{"type":"string"},"x-go-name":"Tags"},"key_expires_in":{"format":"int64","type":"number","x-go-name":"KeyExpiresIn"},"partitions":{"$ref":"#/components/schemas/PolicyPartitions","type":"object","x-go-name":"Partitions"},"last_updated":{"type":"string","x-go-name":"LastUpdates"},"meta_data":{"type":"object","x-go-name":"MetaData"},"graphql_access_rights":{"$ref":"#/components/schemas/GraphAccessDefinition"}},"type":"object","x-go-package":"github.com/TykTechnologies/tyk/user"},"PolicyPartitions":{"properties":{"quota":{"type":"boolean","x-go-name":"Quota"},"rate_limit":{"type":"boolean","x-go-name":"RateLimit"},"complexity":{"type":"boolean","x-go-name":"Complexity"},"acl":{"type":"boolean","x-go-name":"Acl"},"per_api":{"type":"boolean","x-go-name":"PerAPI"}},"type":"object","x-go-package":"github.com/TykTechnologies/tyk/user"},"Regexp":{"description":"Regexp is a wrapper around regexp.Regexp but with caching","properties":{"FromCache":{"type":"boolean"}},"type":"object","x-go-package":"github.com/TykTechnologies/tyk/regexp"},"RequestInputType":{"type":"string","x-go-package":"github.com/TykTechnologies/tyk/apidef"},"RequestSizeMeta":{"properties":{"method":{"type":"string","x-go-name":"Method"},"path":{"type":"string","x-go-name":"Path"},"size_limit":{"format":"int64","type":"integer","x-go-name":"SizeLimit"}},"type":"object","x-go-package":"github.com/TykTechnologies/tyk/apidef"},"ResponseProcessor":{"properties":{"name":{"type":"string","x-go-name":"Name"},"options":{"type":"object","x-go-name":"Options"}},"type":"object","x-go-package":"github.com/TykTechnologies/tyk/apidef"},"RoutingTrigger":{"properties":{"on":{"$ref":"#/components/schemas/RoutingTriggerOnType"},"options":{"$ref":"#/components/schemas/RoutingTriggerOptions"},"rewrite_to":{"type":"string","x-go-name":"RewriteTo"}},"type":"object","x-go-package":"github.com/TykTechnologies/tyk/apidef"},"RoutingTriggerOnType":{"type":"string","x-go-package":"github.com/TykTechnologies/tyk/apidef"},"RoutingTriggerOptions":{"properties":{"header_matches":{"additionalProperties":{"$ref":"#/components/schemas/StringRegexMap"},"type":"object","x-go-name":"HeaderMatches"},"path_part_matches":{"additionalProperties":{"$ref":"#/components/schemas/StringRegexMap"},"type":"object","x-go-name":"PathPartMatches"},"payload_matches":{"$ref":"#/components/schemas/StringRegexMap"},"query_val_matches":{"additionalProperties":{"$ref":"#/components/schemas/StringRegexMap"},"type":"object","x-go-name":"QueryValMatches"},"request_context_matches":{"additionalProperties":{"$ref":"#/components/schemas/StringRegexMap"},"type":"object","x-go-name":"RequestContextMatches"},"session_meta_matches":{"additionalProperties":{"$ref":"#/components/schemas/StringRegexMap"},"type":"object","x-go-name":"SessionMetaMatches"}},"type":"object","x-go-package":"github.com/TykTechnologies/tyk/apidef"},"ServiceDiscoveryConfiguration":{"properties":{"cache_timeout":{"format":"int64","type":"integer","x-go-name":"CacheTimeout"},"data_path":{"type":"string","x-go-name":"DataPath"},"endpoint_returns_list":{"type":"boolean","x-go-name":"EndpointReturnsList"},"parent_data_path":{"type":"string","x-go-name":"ParentDataPath"},"port_data_path":{"type":"string","x-go-name":"PortDataPath"},"query_endpoint":{"type":"string","x-go-name":"QueryEndpoint"},"target_path":{"type":"string","x-go-name":"TargetPath"},"use_discovery_service":{"type":"boolean","x-go-name":"UseDiscoveryService"},"use_nested_query":{"type":"boolean","x-go-name":"UseNestedQuery"},"use_target_list":{"type":"boolean","x-go-name":"UseTargetList"}},"type":"object","x-go-package":"github.com/TykTechnologies/tyk/apidef"},"SessionProviderCode":{"type":"string","x-go-package":"github.com/TykTechnologies/tyk/apidef"},"SessionProviderMeta":{"properties":{"meta":{"additionalProperties":{"type":"object"},"type":"object","x-go-name":"Meta"},"name":{"$ref":"#/components/schemas/SessionProviderCode"},"storage_engine":{"$ref":"#/components/schemas/StorageEngineCode"}},"type":"object","x-go-package":"github.com/TykTechnologies/tyk/apidef"},"SessionState":{"description":"There's a data structure that's based on this and it's used for Protocol Buffer support, make sure to update \"coprocess/proto/coprocess_session_state.proto\" and generate the bindings using: cd coprocess/proto && ./update_bindings.sh","properties":{"tags":{"items":{"type":"string"},"type":"array","x-go-name":"Tags"},"access_rights":{"additionalProperties":{"$ref":"#/components/schemas/AccessDefinition"},"type":"object","x-go-name":"AccessRights"},"alias":{"type":"string","x-go-name":"Alias"},"allowance":{"format":"double","type":"number","x-go-name":"Allowance"},"apply_policies":{"items":{"type":"string"},"type":"array","x-go-name":"ApplyPolicies"},"apply_policy_id":{"type":"string","x-go-name":"ApplyPolicyID"},"basic_auth_data":{"properties":{"hash_type":{"$ref":"#/components/schemas/HashType"},"password":{"type":"string","x-go-name":"Password"}},"type":"object","x-go-name":"BasicAuthData"},"certificate":{"type":"string","x-go-name":"Certificate"},"data_expires":{"format":"int64","type":"integer","x-go-name":"DataExpires"},"enable_detail_recording":{"type":"boolean","x-go-name":"EnableDetailedRecording"},"expires":{"format":"int64","type":"integer","x-go-name":"Expires"},"hmac_enabled":{"type":"boolean","x-go-name":"HMACEnabled"},"hmac_string":{"type":"string","x-go-name":"HmacSecret"},"id_extractor_deadline":{"format":"int64","type":"integer","x-go-name":"IdExtractorDeadline"},"is_inactive":{"type":"boolean","x-go-name":"IsInactive"},"jwt_data":{"properties":{"secret":{"type":"string","x-go-name":"Secret"}},"type":"object","x-go-name":"JWTData"},"last_check":{"format":"int64","type":"integer","x-go-name":"LastCheck"},"last_updated":{"type":"string","x-go-name":"LastUpdated"},"meta_data":{"additionalProperties":{"type":"object"},"type":"object","x-go-name":"MetaData"},"monitor":{"properties":{"trigger_limits":{"items":{"format":"double","type":"number"},"type":"array","x-go-name":"TriggerLimits"}},"type":"object","x-go-name":"Monitor"},"oauth_client_id":{"type":"string","x-go-name":"OauthClientID"},"oauth_keys":{"additionalProperties":{"type":"string"},"type":"object","x-go-name":"OauthKeys"},"org_id":{"type":"string","x-go-name":"OrgID"},"per":{"format":"double","type":"number","x-go-name":"Per"},"quota_max":{"format":"int64","type":"integer","x-go-name":"QuotaMax"},"quota_remaining":{"format":"int64","type":"integer","x-go-name":"QuotaRemaining"},"quota_renewal_rate":{"format":"int64","type":"integer","x-go-name":"QuotaRenewalRate"},"quota_renews":{"format":"int64","type":"integer","x-go-name":"QuotaRenews"},"rate":{"format":"double","type":"number","x-go-name":"Rate"},"session_lifetime":{"format":"int64","type":"integer","x-go-name":"SessionLifetime"},"throttle_interval":{"format":"double","type":"number","x-go-name":"ThrottleInterval"},"throttle_retry_limit":{"format":"int64","type":"integer","x-go-name":"ThrottleRetryLimit"}},"title":"SessionState objects represent a current API session, mainly used for rate limiting.","type":"object","x-go-package":"github.com/TykTechnologies/tyk/user"},"SignatureConfig":{"properties":{"algorithm":{"type":"string","x-go-name":"Algorithm"},"allowed_clock_skew":{"format":"int64","type":"integer","x-go-name":"AllowedClockSkew"},"error_code":{"format":"int64","type":"integer","x-go-name":"ErrorCode"},"error_message":{"type":"string","x-go-name":"ErrorMessage"},"header":{"type":"string","x-go-name":"Header"},"secret":{"type":"string","x-go-name":"Secret"}},"type":"object","x-go-package":"github.com/TykTechnologies/tyk/apidef"},"StorageEngineCode":{"type":"string","x-go-package":"github.com/TykTechnologies/tyk/apidef"},"StringRegexMap":{"properties":{"match_rx":{"type":"string","x-go-name":"MatchPattern"},"reverse":{"type":"boolean","x-go-name":"Reverse"}},"type":"object","x-go-package":"github.com/TykTechnologies/tyk/apidef"},"TemplateData":{"properties":{"enable_session":{"type":"boolean","x-go-name":"EnableSession"},"input_type":{"$ref":"#/components/schemas/RequestInputType"},"template_mode":{"$ref":"#/components/schemas/TemplateMode"},"template_source":{"type":"string","x-go-name":"TemplateSource"}},"type":"object","x-go-package":"github.com/TykTechnologies/tyk/apidef"},"TemplateMeta":{"properties":{"method":{"type":"string","x-go-name":"Method"},"path":{"type":"string","x-go-name":"Path"},"template_data":{"$ref":"#/components/schemas/TemplateData"}},"type":"object","x-go-package":"github.com/TykTechnologies/tyk/apidef"},"TemplateMode":{"type":"string","x-go-package":"github.com/TykTechnologies/tyk/apidef"},"TrackEndpointMeta":{"properties":{"method":{"type":"string","x-go-name":"Method"},"path":{"type":"string","x-go-name":"Path"}},"type":"object","x-go-package":"github.com/TykTechnologies/tyk/apidef"},"TransformJQMeta":{"properties":{"filter":{"type":"string","x-go-name":"Filter"},"method":{"type":"string","x-go-name":"Method"},"path":{"type":"string","x-go-name":"Path"}},"type":"object","x-go-package":"github.com/TykTechnologies/tyk/apidef"},"URLRewriteMeta":{"properties":{"MatchRegexp":{"$ref":"#/components/schemas/Regexp"},"match_pattern":{"type":"string","x-go-name":"MatchPattern"},"method":{"type":"string","x-go-name":"Method"},"path":{"type":"string","x-go-name":"Path"},"rewrite_to":{"type":"string","x-go-name":"RewriteTo"},"triggers":{"items":{"$ref":"#/components/schemas/RoutingTrigger"},"type":"array","x-go-name":"Triggers"}},"type":"object","x-go-package":"github.com/TykTechnologies/tyk/apidef"},"ValidatePathMeta":{"properties":{"error_response_code":{"description":"Allows override of default 422 Unprocessible Entity response code for validation errors.","format":"int64","type":"integer","x-go-name":"ErrorResponseCode"},"method":{"type":"string","x-go-name":"Method"},"path":{"type":"string","x-go-name":"Path"},"schema":{"additionalProperties":{"type":"object"},"type":"object","x-go-name":"Schema"},"schema_b64":{"type":"string","x-go-name":"SchemaB64"}},"type":"object","x-go-package":"github.com/TykTechnologies/tyk/apidef"},"VersionInfo":{"properties":{"paths":{"properties":{"black_list":{"items":{"type":"string"},"type":"array","x-go-name":"BlackList"},"ignored":{"items":{"type":"string"},"type":"array","x-go-name":"Ignored"},"white_list":{"items":{"type":"string"},"type":"array","x-go-name":"WhiteList"}},"type":"object","x-go-name":"Paths"},"expires":{"type":"string","x-go-name":"Expires"},"extended_paths":{"$ref":"#/components/schemas/ExtendedPathsSet"},"global_headers":{"additionalProperties":{"type":"string"},"type":"object","x-go-name":"GlobalHeaders"},"global_headers_remove":{"items":{"type":"string"},"type":"array","x-go-name":"GlobalHeadersRemove"},"global_size_limit":{"format":"int64","type":"integer","x-go-name":"GlobalSizeLimit"},"name":{"type":"string","x-go-name":"Name"},"override_target":{"type":"string","x-go-name":"OverrideTarget"},"use_extended_paths":{"type":"boolean","x-go-name":"UseExtendedPaths"}},"type":"object","x-go-package":"github.com/TykTechnologies/tyk/apidef"},"VirtualMeta":{"properties":{"function_source_type":{"type":"string","x-go-name":"FunctionSourceType"},"function_source_uri":{"type":"string","x-go-name":"FunctionSourceURI"},"method":{"type":"string","x-go-name":"Method"},"path":{"type":"string","x-go-name":"Path"},"proxy_on_error":{"type":"boolean","x-go-name":"ProxyOnError"},"response_function_name":{"type":"string","x-go-name":"ResponseFunctionName"},"use_session":{"type":"boolean","x-go-name":"UseSession"}},"type":"object","x-go-package":"github.com/TykTechnologies/tyk/apidef"},"apiAllKeys":{"description":"apiAllKeys represents a list of keys in the memory store","properties":{"keys":{"items":{"type":"string"},"type":"array","x-go-name":"APIKeys"}},"type":"object","x-go-package":"github.com/TykTechnologies/tyk"},"apiModifyKeySuccess":{"description":"apiModifyKeySuccess represents when a Key modification was successful","properties":{"action":{"type":"string","x-go-name":"Action"},"key":{"description":"in:body","type":"string","x-go-name":"Key"},"key_hash":{"type":"string","x-go-name":"KeyHash"},"status":{"type":"string","x-go-name":"Status"}},"type":"object","x-go-package":"github.com/TykTechnologies/tyk"},"apiStatusMessage":{"description":"apiStatusMessage represents an API status message","properties":{"message":{"description":"Response details","type":"string","x-go-name":"Message"},"status":{"type":"string","x-go-name":"Status"}},"type":"object","x-go-package":"github.com/TykTechnologies/tyk"},"APIAllCertificates":{"description":"APIAllCertificates represents a list of certificates","properties":{"certs":{"items":{"type":"string"},"type":"array","x-go-name":"Certs"}},"type":"object","x-go-package":"github.com/TykTechnologies/tyk"},"APIAllCertificateBasics":{"description":"APIAllCertificates represents a list of certificate basics","properties":{"certs":{"items":{"$ref":"#/components/schemas/CertificateBasics"},"type":"array","x-go-name":"Certs"}},"type":"object","x-go-package":"github.com/TykTechnologies/tyk"},"CertificateBasics":{"description":"CertificateBasics represents basic details of a certificate","properties":{"id":{"type":"string","x-go-name":"ID"},"issuer_cn":{"type":"string","x-go-name":"IssuerCN"},"subject_cn":{"type":"string","x-go-name":"SubjectCN"},"dns_names":{"type":"array","items":{"type":"string"},"x-go-name":"DNSNames"},"has_private":{"type":"string","x-go-name":"HasPrivateKey"},"not_before":{"type":"string","x-go-name":"NotBefore"},"not_after":{"type":"string","x-go-name":"NotAfter"}},"type":"object","x-go-package":"github.com/TykTechnologies/tyk"},"CertificateMeta":{"description":"CertificateBasics represents basic details of a certificate","properties":{"id":{"type":"string","x-go-name":"ID"},"fingerprint":{"type":"string","x-go-name":"Fingerprint"},"has_private":{"type":"string","x-go-name":"HasPrivateKey"},"issuer":{"$ref":"#/components/schemas/pkixName"},"subject":{"$ref":"#/components/schemas/pkixName"},"not_before":{"type":"string","x-go-name":"NotBefore"},"not_after":{"type":"string","x-go-name":"NotAfter"},"dns_names":{"type":"array","items":{"type":"string"},"x-go-name":"DNSNames"}},"type":"object","x-go-package":"github.com/TykTechnologies/tyk"},"pkixName":{"description":"Name represents an X.509 distinguished name","properties":{"Country":{"type":"array","items":{"type":"string"}},"Organization":{"type":"array","items":{"type":"string"}},"OrganizationalUnit":{"type":"array","items":{"type":"string"}},"Locality":{"type":"array","items":{"type":"string"}},"Province":{"type":"array","items":{"type":"string"}},"StreetAddress":{"type":"array","items":{"type":"string"}},"PostalCode":{"type":"array","items":{"type":"string"}},"SerialNumber":{"type":"string"},"CommonName":{"type":"string"},"Names":{"type":"array","items":{"$ref":"#/components/schemas/pkixAttributeTypeAndValue"}},"ExtraNames":{"type":"array","items":{"$ref":"#/components/schemas/pkixAttributeTypeAndValueSET"}}}},"pkixAttributeTypeAndValue":{"description":"AttributeTypeAndValue mirrors the ASN.1 structure of the same name in RFC 5280, Section 4.1.2.4.","properties":{"Type":{"type":"array","items":{"type":"integer"}},"Value":{"type":"object"}}},"pkixAttributeTypeAndValueSET":{"description":"AttributeTypeAndValueSET represents a set of ASN.1 sequences of AttributeTypeAndValue sequences from RFC 2986 (PKCS","properties":{"Type":{"type":"array","items":{"type":"integer"}},"Value":{"type":"array","items":{"type":"array","items":{"$ref":"#/components/schemas/pkixAttributeTypeAndValue"}}}}},"APICertificateStatusMessage":{"description":"Status message when certificate is added","properties":{"id":{"type":"string","x-go-name":"CertID"},"status":{"type":"string","x-go-name":"Status"},"message":{"type":"string","x-go-name":"Message"}},"type":"object","x-go-package":"github.com/TykTechnologies/tyk"},"OASSchemaResponse":{"description":"OAS schema endpoint response","type":"object","properties":{"status":{"type":"string","x-go-name":"Status"},"message":{"type":"string","x-go-name":"Message"},"schema":{"type":"string","description":"<OAS schema definition>"}}},"BooleanQueryParam":{"type":"string","enum":[true,false],"example":true}},"parameters":{"UpstreamURL":{"name":"upstreamURL","in":"query","description":"Upstream URL for the API","required":false,"schema":{"type":"string"}},"ListenPath":{"name":"listenPath","in":"query","description":"Listen path for the API","schema":{"type":"string"},"required":false},"CustomDomain":{"name":"customDomain","schema":{"type":"string"},"description":"Custom domain for the API","in":"query","required":false},"ApiID":{"name":"apiID","schema":{"type":"string"},"description":"ID of the API","in":"query","required":false},"ValidateRequest":{"name":"validateRequest","in":"query","description":"Enable validateRequest middleware for all endpoints having a request body with media type application/json","required":false,"schema":{"$ref":"#/components/schemas/BooleanQueryParam"}},"AllowList":{"name":"allowList","in":"query","description":"Enable allowList middleware for all endpoints","required":false,"schema":{"$ref":"#/components/schemas/BooleanQueryParam"}},"Authentication":{"name":"authentication","in":"query","description":"Enable or disable authentication in your Tyk Gateway as per your OAS document.","schema":{"$ref":"#/components/schemas/BooleanQueryParam"}}},"securitySchemes":{"api_key":{"in":"header","name":"X-Tyk-Authorization","type":"apiKey"}}},"security":[{"api_key":[]}]}
/ tyk / apis
/ tyk / apis / oas
/ tyk / apis / {apiID}
/ tyk / apis / oas / {apiID}
/ tyk / apis / oas / {apiID} / export
/ tyk / apis / oas / export
/ tyk / apis / oas / import
/ tyk / cache / {apiID}
/ tyk / reload /
/ tyk / reload / group
/ tyk / hello
/ tyk / {listenPath} / hello
/ tyk / certs
/ tyk / keys
/ tyk / keys / {keyID}
/ tyk / policies
/ tyk / policies / {polID}
/ tyk / oauth / clients / create
/ tyk / oauth / clients / {apiID}
/ tyk / oauth / clients / {apiID} / {keyName}
/ tyk / oauth / clients / {apiID} / {keyName} / tokens
/ tyk / oauth / revoke
/ tyk / oauth / revoke_all
/ tyk / oauth / refresh / {keyName}
/ tyk / oauth / authorize-client /
/ tyk / org / keys
/ tyk / org / keys / {keyID}
/ {listen_path} / tyk / batch
/ tyk / schema
No API Resources

(Product) (Docs)

---